Correct TeensyHID bootloader descriptors to use the correct revision code for the...

[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 390ebbc..5cd3aaf 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -28,26 +28,27 @@
   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
+/** \ingroup Group_USBClassCDC\r
+ *  @defgroup Group_USBClassCDCDevice CDC 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/CDC.c\r
  *\r
  *  \section Module Description\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
+ *  Device Mode USB Class driver framework interface, for the CDC USB Class driver.\r

  *\r
  *  @{\r
  */\r
  \r
  *\r
  *  @{\r
  */\r
  \r

-#ifndef _CDC_CLASS_H_\r
-#define _CDC_CLASS_H_\r
+#ifndef _CDC_CLASS_DEVICE_H_\r
+#define _CDC_CLASS_DEVICE_H_\r

 \r
        /* Includes: */\r
                #include "../../USB.h"\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r

+               #include "../Common/CDC.h"\r

 \r
 \r

+               #include <stdio.h>\r

                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r


@@ -55,231 +56,203 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

-       /* Macros: */\r
-               /** CDC Class specific request to get the current virtual serial port configuration settings. */\r
-               #define REQ_GetLineEncoding              0x21\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Type Defines: */\r
+                       /** Class state structure. An instance of this structure should be made for each CDC interface\r
+                        *  within the user application, and passed to each of the CDC class driver functions as the\r
+                        *  CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               const struct\r
+                               {\r
+                                       uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r

 \r
 \r

-               /** CDC Class specific request to set the current virtual serial port configuration settings. */\r
-               #define REQ_SetLineEncoding              0x20\r
+                                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */\r
+                                       uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */\r
+                                       bool     DataINEndpointDoubleBank; /** Indicates if the CDC interface's IN data endpoint should use double banking */\r

 \r
 \r

-               /** CDC Class specific request to set the current virtual serial port handshake line states. */\r
-               #define REQ_SetControlLineState          0x22\r
-               \r
-               /** Notification type constant for a change in the virtual serial port handshake line states, for\r
-                *  use with a USB_Notification_Header_t notification structure when sent to the host via the CDC \r
-                *  notification endpoint.\r
-                */\r
-               #define NOTIF_SerialState                0x20\r
+                                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */\r
+                                       uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */\r
+                                       bool     DataOUTEndpointDoubleBank; /** Indicates if the CDC interface's OUT data endpoint should use double banking */\r

 \r
 \r

-               /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class specific request\r
-                *  from the host, to indicate that the DTR line state should be high.\r
-                */\r
-               #define CDC_CONTROL_LINE_OUT_DTR         (1 << 0)\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
+                                       bool     NotificationEndpointDoubleBank; /** Indicates if the CDC interface's notification endpoint should use double banking */\r
+                               } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+                                          *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+                                          */\r
+                               struct\r
+                               {\r
+                                       struct\r
+                                       {\r
+                                               uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*\r
+                                                                                          *   masks.\r
+                                                                                          */\r
+                                               uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*\r
+                                                                                          *   masks.\r
+                                                                                          */\r
+                                       } ControlLineStates;\r

 \r
 \r

-               /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class specific request\r
-                *  from the host, to indicate that theRTS line state should be high.\r
-                */\r
-               #define CDC_CONTROL_LINE_OUT_RTS         (1 << 1)\r
+                                       struct\r
+                                       {\r
+                                               uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */\r
+                                               uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the\r
+                                                                                         *   CDCDevice_CDC_LineCodingFormats_t enum\r
+                                                                                         */\r
+                                               uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the\r
+                                                                                         *   CDCDevice_LineCodingParity_t enum\r
+                                                                                         */\r
+                                               uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */\r
+                                       } LineEncoding;                 \r
+                               } State; /**< State data for the USB class interface within the device. All elements in this section\r
+                                         *   are reset to their defaults when the interface is enumerated.\r
+                                         */\r
+                       } USB_ClassInfo_CDC_Device_t;\r

                \r
                \r

-               /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification\r
-                *  from the device to the host, to indicate that the DCD line state is currently high.\r
-                */\r
-               #define CDC_CONTROL_LINE_IN_DCD          (1 << 0)\r
-\r
-               /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification\r
-                *  from the device to the host, to indicate that the DSR line state is currently high.\r
-                */\r
-               #define CDC_CONTROL_LINE_IN_DSR          (1 << 1)\r
+               /* Function Prototypes: */              \r
+                       /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library\r
+                        *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing\r
+                        *  the given CDC interface is selected.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *\r
+                        *  \return Boolean true if the endpoints were successfully configured, false otherwise\r
+                        */\r
+                       bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-               /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification\r
-                *  from the device to the host, to indicate that the BREAK line state is currently high.\r
-                */\r
-               #define CDC_CONTROL_LINE_IN_BREAK        (1 << 2)\r
+                       /** Processes incoming 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_Device_UnhandledControlRequest() event.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        */\r
+                       void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-               /** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification\r
-                *  from the device to the host, to indicate that the RING line state is currently high.\r
-                */\r
-               #define CDC_CONTROL_LINE_IN_RING         (1 << 3)\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[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        */\r
+                       void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-               /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
-                *  to indicate that a framing error has occurred on the virtual serial port.\r
-                */\r
-               #define CDC_CONTROL_LINE_IN_FRAMEERROR   (1 << 4)\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[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        */\r
+                       void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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 ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as\r
+                        *  a mask of CDC_CONTROL_LINE_OUT_* masks.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        */\r
+                       void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-               /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
-                *  to indicate that a parity error has occurred on the virtual serial port.\r
-                */\r
-               #define CDC_CONTROL_LINE_IN_PARITYERROR  (1 << 5)\r
+                       /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
+                        *  string is discarded.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in] Data  Pointer to the string to send to the host\r
+                        *  \param[in] Length  Size in bytes of the string to send to the host\r
+                        *\r
+                        *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const Data, const uint16_t Length)\r
+                                                     ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+                       \r
+                       /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the\r
+                        *  byte is discarded.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in] Data  Byte of data to send to the host\r
+                        *\r
+                        *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *\r
+                        *  \return Total number of buffered bytes received from the host\r
+                        */\r
+                       uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function\r
+                        *  returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data\r
+                        *  underflow occurs.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *\r
+                        *  \return Next received byte from the host, or 0 if no data received\r
+                        */\r
+                       uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *\r
+                        *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial\r
+                        *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist\r
+                        *  until they are cleared via a second notification. This should be called each time the CDC class driver's \r
+                        *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        */\r
+                       void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-               /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
-                *  to indicate that a data overrun error has occurred on the virtual serial port.\r
-                */\r
-               #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6)\r
-               \r
-               /** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a\r
-                *  uniform structure but variable sized data payloads, thus cannot be represented accurately by\r
-                *  a single typedef struct. A macro is used instead so that functional descriptors can be created\r
-                *  easily by specifying the size of the payload. This allows sizeof() to work correctly.\r
-                *\r
-                *  \param DataSize  Size in bytes of the CDC functional descriptor's data payload\r
-                */\r
-               #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \\r
-                    struct                                        \\r
-                    {                                             \\r
-                         USB_Descriptor_Header_t Header;          \\r
-                             uint8_t                 SubType;         \\r
-                         uint8_t                 Data[DataSize];  \\r
-                    }\r
-\r
-       /* Enums: */\r
-               /** Enum for the possible line encoding formats of a virtual serial port. */\r
-               enum CDCDevice_CDC_LineCodingFormats_t\r
-               {\r
-                       CDC_LINEENCODING_OneStopBit          = 0, /**< Each frame contains one stop bit */\r
-                       CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */\r
-                       CDC_LINEENCODING_TwoStopBits         = 2, /**< Each frame contains two stop bits */\r
-               };\r
-               \r
-               /** Enum for the possible line encoding parity settings of a virtual serial port. */\r
-               enum CDCDevice_LineCodingParity_t\r
-               {\r
-                       CDC_PARITY_None    = 0, /**< No parity bit mode on each frame */\r
-                       CDC_PARITY_Odd     = 1, /**< Odd parity bit mode on each frame */\r
-                       CDC_PARITY_Even    = 2, /**< Even parity bit mode on each frame */\r
-                       CDC_PARITY_Mark    = 3, /**< Mark parity bit mode on each frame */\r
-                       CDC_PARITY_Space   = 4, /**< Space parity bit mode on each frame */\r
-               };\r
+                       /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular\r
+                        *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created\r
+                        *  stream is bidirectional and can be used for both input and output functions.\r
+                        *\r
+                        *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single\r
+                        *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may\r
+                        *  be used when the read data is processed byte-per-bye (via getc()) or when the user application will implement its own\r
+                        *  line buffering.\r
+                        *\r
+                        *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions\r
+                        *        to the given CDC interface.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed\r
+                        */\r
+                       void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);\r

 \r
 \r

-       /* Type Defines: */\r
-               /** Class state structure. An instance of this structure should be made for each CDC interface\r
-                *  within the user application, and passed to each of the CDC class driver functions as the\r
-                *  CDCInterfaceInfo parameter. The contents of this structure should be set to their correct\r
-                *  values when used, or ommitted to force the library to use default values.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r
+                       /** Identical to CDC_Device_CreateStream(), except that reads are blocking until the calling stream function terminates\r
+                        *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed\r
+                        */\r
+                       void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);\r

 \r
 \r

-                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */\r
-                       uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */\r
+       /* Private Interface - For use in library only: */\r
+       #if !defined(__DOXYGEN__)\r
+               /* Function Prototypes: */\r
+                       #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r
+                               static int CDC_Device_putchar(char c, FILE* Stream);\r
+                               static int CDC_Device_getchar(FILE* Stream);\r
+                               static int CDC_Device_getchar_Blocking(FILE* Stream);\r
+                               \r
+                               void CDC_Device_Event_Stub(void);\r
+                               void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r
+                                                                                                                 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r
+                               void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r
+                                                                                                                        ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r
+                       #endif\r

 \r
 \r

-                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */\r
-                       uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */\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 states, as set by the host */\r
-\r
-                       struct\r
-                       {\r
-                               uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */\r
-                               uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the\r
-                                                                         *   CDCDevice_CDC_LineCodingFormats_t enum\r
-                                                                         */\r
-                               uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the\r
-                                                                         *   CDCDevice_LineCodingParity_t enum\r
-                                                                         */\r
-                               uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */\r
-                       } LineEncoding;\r
-               } USB_ClassInfo_CDC_t;\r
-               \r
-       /* Function Prototypes: */\r
-               #if defined(INCLUDE_FROM_CDC_CLASS_C)\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(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
-                                                                 ATTR_WEAK ATTR_ALIAS(USB_CDC_Event_Stub);\r
-               #endif\r
+       #endif\r

        \r
        \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
-               /** 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
-               /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
-                *  string is discarded.\r
-                *\r
-                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
-                *  \param Data  Pointer to the string to send to the host\r
-                *  \param Length  Size in bytes of the string to send to the host\r
-                */\r
-               void     USB_CDC_SendString(USB_ClassInfo_CDC_t* CDCInterfaceInfo, char* Data, uint16_t Length);\r
-               \r
-               /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the\r
-                *  byte is discarded.\r
-                *\r
-                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
-                *  \param Data  Byte of data to send to the host\r
-                */\r
-               void     USB_CDC_SendByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo, uint8_t Data);\r
-               \r
-               /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.\r
-                *\r
-                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
-                *\r
-                *  \return Total number of buffered bytes received from the host\r
-                */\r
-               uint16_t USB_CDC_BytesReceived(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
-               \r
-               /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function\r
-                *  returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data\r
-                *  underflow occurs.\r
-                *\r
-                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
-                *\r
-                *  \return Next received byte from the host, or 0 if no data received\r
-                */\r
-               uint8_t  USB_CDC_ReceiveByte(USB_ClassInfo_CDC_t* CDCInterfaceInfo);\r
-               \r
-               /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial control\r
-                *  lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist until they are\r
-                *  cleared via a second notification.\r
-                *\r
-                *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
-                *  \param LineStateMask  Mask of CDC_CONTROL_LINE_IN_* masks giving the current control line states\r
-                */\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
                        }\r