Reduce struct name pollution - group typedef struct names by class driver name where...
[pub/lufa.git] / LUFA / Drivers / USB / Class / Device / CDC.h
index bcf8ff7..157b350 100644 (file)
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
-                       /** Configuration information structure for \ref USB_ClassInfo_CDC_Device_t CDC device interface structures. */\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
-                               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
+                               const struct\r
+                               {\r
+                                       uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */\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
+                                       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  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
-                       } USB_ClassInfo_CDC_Device_Config_t;\r
-                       \r
-                       /** Current State information structure for \ref USB_ClassInfo_CDC_Device_t CDC device interface structures. */\r
-                       typedef 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
+                                       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
+                               } 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
-                                       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_Device_State_t;\r
-               \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 USB_ClassInfo_CDC_Device_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_Device_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
+                                       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
+                                               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_Device_t;\r
                \r
                /* Function Prototypes: */              \r