Add FatFS library to the Webserver project, extend the HTTP server so that it now...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / CDC.h
index 12f8b83..f684497 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
 */\r
 \r
 /** \ingroup Group_USBClassCDC\r
 */\r
 \r
 /** \ingroup Group_USBClassCDC\r
+ *  @defgroup Group_USBClassCDCCommon  Common Class Definitions\r
+ *\r
+ *  \section Module Description\r
+ *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB\r
+ *  CDC Class.\r
+ *\r
  *  @{\r
  */\r
  \r
  *  @{\r
  */\r
  \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
                 *  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
+                *  \param[in] DataSize  Size in bytes of the CDC functional descriptor's data payload\r
                 */\r
                #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \\r
                     struct                                        \\r
                 */\r
                #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \\r
                     struct                                        \\r
 \r
        /* Enums: */\r
                /** Enum for the possible line encoding formats of a virtual serial port. */\r
 \r
        /* Enums: */\r
                /** Enum for the possible line encoding formats of a virtual serial port. */\r
-               enum CDCDevice_CDC_LineCodingFormats_t\r
+               enum 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
                {\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
                };\r
                \r
                /** Enum for the possible line encoding parity settings of a virtual serial port. */\r
                };\r
                \r
                /** Enum for the possible line encoding parity settings of a virtual serial port. */\r
-               enum CDCDevice_LineCodingParity_t\r
+               enum CDC_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
                {\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_Space   = 4, /**< Space parity bit mode on each frame */\r
                };\r
 \r
                        CDC_PARITY_Space   = 4, /**< Space parity bit mode on each frame */\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
-\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
-\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
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r