Document the Bluetooth ACL layer. Remove unneeded parameters from the signalling...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / RNDIS.h

diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h
index fc9b4b3..f64710d 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief Host mode driver for the library USB RNDIS Class driver.\r
+ *\r
+ *  Host mode driver for the library USB RNDIS Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h.\r
+ */\r
+\r
 /** \ingroup Group_USBClassRNDIS\r
  *  @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver\r
  *\r
@@ -57,9 +66,16 @@
                        extern "C" {\r
                #endif\r
 \r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead.\r
+               #endif\r
+\r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
-                       /** Class state structure. An instance of this structure should be made within the user application,\r
+                       /** \brief RNDIS Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r
                         *  and passed to each of the RNDIS class driver functions as the RNDISInterfaceInfo parameter. This\r
                         *  stores each RNDIS interface's configuration and state information.\r
                         */\r
@@ -90,12 +106,8 @@
                                \r
                                        uint16_t DataINPipeSize; /**< Size in bytes of the RNDIS interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the RNDIS interface's OUT data pipe */\r
-                                       uint16_t NotificationPipeSize;  /**< Size in bytes of the RNDIS interface's IN notification pipe, if used */\r
-                                       \r
-                                       bool BidirectionalDataEndpoints; /**< Indicates if the attached RNDIS interface uses bidirectional data endpoints,\r
-                                                                         *   and this has only the IN pipe configured (with \ref Pipe_SetPipeToken()\r
-                                                                         *   used to switch the pipe's direction)\r
-                                                                         */\r
+                                       uint16_t NotificationPipeSize;  /**< Size in bytes of the RNDIS interface's IN notification pipe, if used */                                    \r
+\r
                                        uint32_t DeviceMaxPacketSize; /**< Maximum size of a packet which can be buffered by the attached RNDIS device */\r
                                        \r
                                        uint32_t RequestID; /**< Request ID counter to give a unique ID for each command/response pair */\r
@@ -249,7 +261,7 @@
                        #define RNDIS_FOUND_NOTIFICATION_IN       (1 << 2)\r
 \r
                /* Function Prototypes: */\r
-                       #if defined(INCLUDE_FROM_RNDIS_CLASS_HOST_C)\r
+                       #if defined(__INCLUDE_FROM_RNDIS_CLASS_HOST_C)\r
                                static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, \r
                                                                             void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
                                static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,\r