Fixes to unfinished SideShow demo to re-enable correct building after previous commit.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / CDC.h

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index 3c24617..90ea3ab 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -31,6 +31,10 @@
 /** \ingroup Group_USBClassCDC\r
  *  @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver\r
  *\r
 /** \ingroup Group_USBClassCDC\r
  *  @defgroup Group_USBClassCDCHost CDC Class Host 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/Host/CDC.c\r
+ *\r

  *  \section Module Description\r
  *  Host Mode USB Class driver framework interface, for the CDC USB Class driver.\r
  *\r
  *  \section Module Description\r
  *  Host Mode USB Class driver framework interface, for the CDC USB Class driver.\r
  *\r


@@ -50,71 +54,60 @@
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r

-               /* Type Defines: */             \r
-                       /** Configuration information structure for \ref USB_ClassInfo_CDC_Host_t CDC host interface structures. */\r
-                       typedef struct\r
-                       {\r
-                               uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */\r
-                               uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */\r
-                               uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */                   \r
-                       } USB_ClassInfo_CDC_Host_Config_t;\r
-               \r
-                       /** Current State information structure for \ref USB_ClassInfo_CDC_Host_t CDC host interface structures. */\r
-                       typedef struct\r
-                       {\r
-                               uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r
-\r
-                               uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r
-                               uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r
-                               uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\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
-                               struct\r
-                               {\r
-                                       bool Active; /**< Indicates if the interface is currently active, i.e. attached to the connected device */\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_Host_State_t;\r
-\r
+               /* Type Defines: */\r

                        /** Class state structure. An instance of this structure should be made within the user application,\r
                         *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This\r
                         *  stores each CDC interface's configuration and state information.\r
                         */\r
                        typedef struct\r
                        {\r
                        /** Class state structure. An instance of this structure should be made within the user application,\r
                         *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This\r
                         *  stores each CDC interface's configuration and state information.\r
                         */\r
                        typedef struct\r
                        {\r

-                               const USB_ClassInfo_CDC_Host_Config_t Config; /**< Config data for the USB class interface within\r
-                                                                              *   the device. All elements in this section\r
-                                                                              *   <b>must</b> be set or the interface will fail\r
-                                                                              *   to enumerate and operate correctly.\r
-                                                                              */\r
-\r
-                               USB_ClassInfo_CDC_Host_State_t State; /**< State data for the USB class interface within\r
-                                                                      *   the device. All elements in this section\r
-                                                                      *   <b>may</b> be set to initial values, but may\r
-                                                                      *   also be ignored to default to sane values when\r
-                                                                      *   the interface is enumerated.\r
-                                                                      */\r
+                               const struct\r
+                               {\r
+                                       uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */\r
+                                       uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */\r
+                                       uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */                   \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
+                                       uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\r
+\r
+                                       uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r
+                                       uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r
+                                       uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\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
+                                       struct\r
+                                       {\r
+                                               bool Active; /**< Indicates if the interface is currently active, i.e. attached to the connected device */\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
+                                                 *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
+                                                 *   the interface is enumerated.\r
+                                                 */\r

                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r
                        } USB_ClassInfo_CDC_Host_t;\r
                        \r
                /* Enums: */\r

-                       typedef enum\r
+                       enum\r

                        {\r
                                CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                                CDC_ENUMERROR_ControlError               = 1, /**< A control request to the device failed to complete successfully */\r
                        {\r
                                CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                                CDC_ENUMERROR_ControlError               = 1, /**< A control request to the device failed to complete successfully */\r