Added CDC functional descriptor structs to the Low Level CDC demos and CDC class...
[pub/USBasp.git] / Bootloaders / CDC / Descriptors.h
index 307b323..4610888 100644 (file)
                        #error The selected AVR part is not currently supported by this bootloader.
                #endif
 
-               /** Structure for a CDC class Functional descriptor, with a given data size. This is used instead of a
-                *  type define so that the same macro can be used for functional descriptors of varying data lengths,
-                *  while allowing the sizeof() operator to return correct results.
-                *
-                *  \param[in] DataSize  Size of the functional descriptor's data payload, in bytes
-                */
-               #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \
-                    struct                                        \
-                    {                                             \
-                         USB_Descriptor_Header_t Header;          \
-                             uint8_t                 SubType;         \
-                         uint8_t                 Data[DataSize];  \
-                    }
-
                /** Endpoint number for the CDC control interface event notification endpoint. */
                #define CDC_NOTIFICATION_EPNUM         3
 
                #define CDC_TXRX_EPSIZE                16
 
        /* Type Defines: */
+               /** Type define for a CDC class-specific functional header descriptor. This indicates to the host that the device
+                *  contains one or more CDC functional data descriptors, which give the CDC interface's capabilities and configuration.
+                *  See the CDC class specification for more details.
+                */
+               typedef struct
+               {
+                       USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
+                       uint16_t                CDCSpecification; /**< Version number of the CDC specification implemented by the device,
+                                                                  *   encoded in BCD format.
+                                                                  */
+               } USB_Descriptor_CDC_FunctionalHeader_t;
+
+               /** Type define for a CDC class-specific functional ACM descriptor. This indicates to the host that the CDC interface
+                *  supports the CDC ACM subclass of the CDC specification. See the CDC class specification for more details.
+                */
+               typedef struct
+               {
+                       USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
+                       uint8_t                 Capabilities; /**< Capabilities of the ACM interface, given as a bit mask. */
+               } USB_Descriptor_CDC_FunctionalACM_t;
+               
+               /** Type define for a CDC class-specific functional Union descriptor. This indicates to the host that specific
+                *  CDC control and data interfaces are related. See the CDC class specification for more details.
+                */
+               typedef struct
+               {
+                       USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
+                       uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
+                       uint8_t                 MasterInterfaceNumber; /**< Interface number of the CDC Control interface. */
+                       uint8_t                 SlaveInterfaceNumber; /**< Interface number of the CDC Data interface. */
+               } USB_Descriptor_CDC_FunctionalUnion_t;
+
                /** Type define for the device configuration descriptor structure. This must be defined in the
                 *  application code, as the configuration descriptor contains several sub-descriptors which
                 *  vary between devices, and which describe the device's usage to the host.
                {
                        USB_Descriptor_Configuration_Header_t    Config;
                        USB_Descriptor_Interface_t               CDC_CCI_Interface;
-                       CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC_Functional_IntHeader;
-                       CDC_FUNCTIONAL_DESCRIPTOR(1)             CDC_Functional_AbstractControlManagement;
-                       CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC_Functional_Union;
+                       USB_Descriptor_CDC_FunctionalHeader_t    CDC_Functional_Header;
+                       USB_Descriptor_CDC_FunctionalACM_t       CDC_Functional_ACM;
+                       USB_Descriptor_CDC_FunctionalUnion_t     CDC_Functional_Union;
                        USB_Descriptor_Endpoint_t                CDC_NotificationEndpoint;
                        USB_Descriptor_Interface_t               CDC_DCI_Interface;
                        USB_Descriptor_Endpoint_t                CDC_DataOutEndpoint;