Added multiple Report ID support to the HID class driver. Removed OUT endpoint suppor...

[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 3e67b1b..ee9e376 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  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; /**< Current control line state, as set by the host */\r
+                       uint8_t  ControlLineState; /**< Current control line states, as set by the host */\r

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


@@ -195,7 +195,7 @@
                 *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
                 *  given CDC interface is selected.\r
                 *\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
+                *  \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
                 *\r
                 *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                 */\r


@@ -204,25 +204,41 @@
                /** 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
                /** 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
+                *  \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
                 */\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
+                *  \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 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(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\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