Fixed EVENT_USB_CDC_ControLineStateChanged() event not taking the CDC interface struc...

[pub/lufa.git] / LUFA / Drivers / USB / Class / Device / CDC.h

diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index ae069fa..3e67b1b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -167,7 +167,7 @@
                        uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */\r
                        uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r
 \r
-                       uint8_t  ControlLineState;\r
+                       uint8_t  ControlLineState; /**< Current control line state, as set by the host */\r
 \r
                        struct\r
                        {\r
@@ -187,15 +187,36 @@
                        void USB_CDC_Event_Stub(void);\r
                        void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
                                                                                                   ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);\r
-                       void EVENT_USB_CDC_ControLineStateChanged(void) ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);; \r
+                       void EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
+                                                                 ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);\r
                #endif\r
        \r
-               bool     USB_CDC_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
-               void     USB_CDC_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
-               void     USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+               /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library\r
+                *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
+                *  given CDC interface is selected.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing an CDC Class configuration and state.\r
+                *\r
+                *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+                */\r
+               bool USB_CDC_ConfigureEndpoints(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+\r
+               /** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be\r
+                *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing an CDC Class configuration and state.\r
+                */\r
+               void USB_CDC_ProcessControlPacket(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+\r
+               /** General management task for a given CDC 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 CDCInterfaceInfo  Pointer to a structure containing an CDC Class configuration and state.\r
+                */\r
+               void USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
 \r
                void     EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
-               void     EVENT_USB_CDC_ControLineStateChanged(void);\r
+               void     EVENT_USB_CDC_ControLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
 \r
                void     USB_CDC_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);\r
                void     USB_CDC_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);\r