Added standard stream example to the ClassDriver CDC device demo.

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

diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h
index 21fb094..8855aac 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h
@@ -31,6 +31,10 @@
 /** \ingroup Group_USBClassRNDIS\r
  *  @defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver\r
  *\r
 /** \ingroup Group_USBClassRNDIS\r
  *  @defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver\r
  *\r

+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/Class/Device/RNDIS.c\r
+ *\r

  *  \section Module Description\r
  *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.\r
  *\r
  *  \section Module Description\r
  *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.\r
  *\r


@@ -93,8 +97,7 @@
                                                                                                         *   user application\r
                                                                                                         */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                                                                                         *   user application\r
                                                                                                         */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r

-                                         *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
-                                         *   the interface is enumerated.\r
+                                         *   are reset to their defaults when the interface is enumerated.\r

                                          */\r
                        } USB_ClassInfo_RNDIS_Device_t;\r
        \r
                                          */\r
                        } USB_ClassInfo_RNDIS_Device_t;\r
        \r


@@ -103,36 +106,36 @@
                         *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
                         *  containing the given HID interface is selected.\r
                         *\r
                         *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
                         *  containing the given HID interface is selected.\r
                         *\r

-                        *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r

                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r

-                       bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r
+                       bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo);\r

 \r
                        /** Processes incomming control requests from the host, that are directed to the given RNDIS class interface. This should be\r
                         *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
                         *\r
 \r
                        /** Processes incomming control requests from the host, that are directed to the given RNDIS class interface. This should be\r
                         *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
                         *\r

-                        *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r

                         */             \r
                         */             \r

-                       void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r
+                       void RNDIS_Device_ProcessControlPacket(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo);\r

                        \r
                        /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
                         *\r
                        \r
                        /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
                         *\r

-                        *  \param RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r
+                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.\r

                         */\r
                         */\r

-                       void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r
+                       void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo);\r

                \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r
                #if defined(INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)\r
                \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r
                #if defined(INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)\r

-                       static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);\r
-                       static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo, \r
-                                                                 uint32_t OId, void* QueryData, uint16_t QuerySize,\r
-                                                                                             void* ResponseData, uint16_t* ResponseSize);\r
-                       static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo, uint32_t OId,\r
-                                                               void* SetData, uint16_t SetSize);       \r
+                       static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo);\r
+                       static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, \r
+                                                                 const uint32_t OId, void* const QueryData, const uint16_t QuerySize,\r
+                                                                                             void* ResponseData, uint16_t* const ResponseSize);\r
+                       static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, const uint32_t OId,\r
+                                                               void* SetData, const uint16_t SetSize); \r

                #endif\r
                \r
        #endif\r
                #endif\r
                \r
        #endif\r