Conversion of old incomplete SideShow demo to new APIs.

[pub/USBasp.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 b1d7c6d..ee9e376 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -28,6 +28,20 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \ingroup Group_USBDeviceClassDrivers\r
+ *  @defgroup Group_USBClassCDCDevice CDC Device Class Driver - LUFA/Drivers/Class/Device/CDC.h\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/CDC.c\r
+ *\r
+ *  \section Module Description\r
+ *  Functions, macros, variables, enums and types related to the management of USB CDC Class interfaces\r
+ *  within a USB device, for the implementation of CDC-ACM virtual serial ports.\r
+ *\r
+ *  @{\r
+ */\r
+ \r

 #ifndef _CDC_CLASS_H_\r
 #define _CDC_CLASS_H_\r
 \r
 #ifndef _CDC_CLASS_H_\r
 #define _CDC_CLASS_H_\r
 \r


@@ -153,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  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 states, as set by the host */\r

 \r
                        struct\r
                        {\r
 \r
                        struct\r
                        {\r


@@ -173,21 +187,58 @@
                        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 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
                #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 a 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 a 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 a CDC Class configuration and state.\r
+                */\r
+               void USB_CDC_USBTask(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r

 \r
 \r

-               void     EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
-               void     EVENT_USB_CDC_ControLineStateChanged(void);\r
+               /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a\r
+                *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the\r
+                *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding\r
+                *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
+                */\r
+               void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
+               \r
+               /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a\r
+                *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the\r
+                *  user program by declaring a handler function with the same name and parameters listed here. The new control line states\r
+                *  are available in the ControlLineState value inside the CDC interface structure passed as a parameter, set as a mask of\r
+                *  CDC_CONTROL_LINE_OUT_* masks.\r
+                *\r
+                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
+                */             \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
                uint16_t USB_CDC_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
                uint8_t  USB_CDC_ReceiveByte(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
                uint16_t USB_CDC_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
                uint8_t  USB_CDC_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r

-               void USB_CDC_SendSerialLineStateChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);\r
+               void     USB_CDC_SendSerialLineStateChange(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint16_t LineStateMask);\r

 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r


@@ -195,3 +246,5 @@
                #endif\r
                \r
 #endif\r
                #endif\r
                \r
 #endif\r

+\r
+/** @} */\r