Documentation: Fix Doxygen grouping.

[pub/lufa.git] / LUFA / Drivers / USB / Class / Common / CDCClassCommon.h

diff --git a/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h b/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h
index 45e0c58..cf32611 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h
+++ b/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2019.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2019  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -40,7 +40,7 @@
 /** \ingroup Group_USBClassCDC
  *  \defgroup Group_USBClassCDCCommon  Common Class Definitions
  *
 /** \ingroup Group_USBClassCDC
  *  \defgroup Group_USBClassCDCCommon  Common Class Definitions
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_USBClassCDCCommon_ModDescription Module Description

  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  CDC Class.
  *
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  CDC Class.
  *


@@ -65,7 +65,7 @@
 
        /* Macros: */
                /** \name Virtual Control Line Masks */
 
        /* Macros: */
                /** \name Virtual Control Line Masks */

-               //@{
+               /**@{*/

                /** Mask for the DTR handshake line for use with the \ref CDC_REQ_SetControlLineState class-specific request
                 *  from the host, to indicate that the DTR line state should be high.
                 */
                /** Mask for the DTR handshake line for use with the \ref CDC_REQ_SetControlLineState class-specific request
                 *  from the host, to indicate that the DTR line state should be high.
                 */


@@ -110,22 +110,7 @@
                 *  to indicate that a data overrun error has occurred on the virtual serial port.
                 */
                #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6)
                 *  to indicate that a data overrun error has occurred on the virtual serial port.
                 */
                #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6)

-               //@}
-               
-               /** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a
-                *  uniform structure but variable sized data payloads, thus cannot be represented accurately by
-                *  a single typedef struct. A macro is used instead so that functional descriptors can be created
-                *  easily by specifying the size of the payload. This allows \c sizeof() to work correctly.
-                *
-                *  \param[in] DataSize  Size in bytes of the CDC functional descriptor's data payload.
-                */
-               #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \
-                    struct                                        \
-                    {                                             \
-                         USB_Descriptor_Header_t Header;          \
-                             uint8_t                 SubType;         \
-                         uint8_t                 Data[DataSize];  \
-                    }
+               /**@}*/

 
        /* Enums: */
                /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the CDC
 
        /* Enums: */
                /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the CDC


@@ -161,7 +146,7 @@
                                                                 *   belongs to no specific protocol of the CDC data class.
                                                                 */
                };
                                                                 *   belongs to no specific protocol of the CDC data class.
                                                                 */
                };

-               
+

                /** Enum for the CDC class specific control requests that can be issued by the USB bus host. */
                enum CDC_ClassRequests_t
                {
                /** Enum for the CDC class specific control requests that can be issued by the USB bus host. */
                enum CDC_ClassRequests_t
                {


@@ -176,33 +161,40 @@
                /** Enum for the CDC class specific notification requests that can be issued by a CDC device to a host. */
                enum CDC_ClassNotifications_t
                {
                /** Enum for the CDC class specific notification requests that can be issued by a CDC device to a host. */
                enum CDC_ClassNotifications_t
                {

-                       CDC_NOTIF_SerialState               = 0x20, /**< Notification type constant for a change in the virtual serial port
-                                                                    *   handshake line states, for use with a \ref USB_Request_Header_t
-                                                                    *   notification structure when sent to the host via the CDC notification
-                                                                    *   endpoint.
-                                                                    */
+                       CDC_NOTIF_SerialState = 0x20, /**< Notification type constant for a change in the virtual serial port
+                                                      *   handshake line states, for use with a \ref USB_Request_Header_t
+                                                      *   notification structure when sent to the host via the CDC notification
+                                                      *   endpoint.
+                                                      */
+               };
+
+               /** Enum for the CDC class specific descriptor types. */
+               enum CDC_DescriptorTypes_t
+               {
+                       CDC_DTYPE_CSInterface                     = 0x24, /**< CDC class specific Interface functional descriptor. */
+                       CDC_DTYPE_CSEndpoint                      = 0x25, /**< CDC class specific Endpoint functional descriptor. */

                };
 
                /** Enum for the CDC class specific interface descriptor subtypes. */
                enum CDC_DescriptorSubtypes_t
                {
                };
 
                /** Enum for the CDC class specific interface descriptor subtypes. */
                enum CDC_DescriptorSubtypes_t
                {

-                       CDC_DSUBTYPE_CSInterface_Header           = 0x00, /**< CDC class-specific Header functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_CallManagement   = 0x01, /**< CDC class-specific Call Management functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_ACM              = 0x02, /**< CDC class-specific Abstract Control Model functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_DirectLine       = 0x03, /**< CDC class-specific Direct Line functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_TelephoneRinger  = 0x04, /**< CDC class-specific Telephone Ringer functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_TelephoneCall    = 0x05, /**< CDC class-specific Telephone Call functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_Union            = 0x06, /**< CDC class-specific Union functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_CountrySelection = 0x07, /**< CDC class-specific Country Selection functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_TelephoneOpModes = 0x08, /**< CDC class-specific Telephone Operation Modes functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_USBTerminal      = 0x09, /**< CDC class-specific USB Terminal functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_NetworkChannel   = 0x0A, /**< CDC class-specific Network Channel functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_ProtocolUnit     = 0x0B, /**< CDC class-specific Protocol Unit functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_ExtensionUnit    = 0x0C, /**< CDC class-specific Extension Unit functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_MultiChannel     = 0x0D, /**< CDC class-specific Multi-Channel Management functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_CAPI             = 0x0E, /**< CDC class-specific Common ISDN API functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_Ethernet         = 0x0F, /**< CDC class-specific Ethernet functional descriptor. */
-                       CDC_DSUBTYPE_CSInterface_ATM              = 0x10, /**< CDC class-specific Asynchronous Transfer Mode functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_Header           = 0x00, /**< CDC class specific Header functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_CallManagement   = 0x01, /**< CDC class specific Call Management functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_ACM              = 0x02, /**< CDC class specific Abstract Control Model functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_DirectLine       = 0x03, /**< CDC class specific Direct Line functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_TelephoneRinger  = 0x04, /**< CDC class specific Telephone Ringer functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_TelephoneCall    = 0x05, /**< CDC class specific Telephone Call functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_Union            = 0x06, /**< CDC class specific Union functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_CountrySelection = 0x07, /**< CDC class specific Country Selection functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_TelephoneOpModes = 0x08, /**< CDC class specific Telephone Operation Modes functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_USBTerminal      = 0x09, /**< CDC class specific USB Terminal functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_NetworkChannel   = 0x0A, /**< CDC class specific Network Channel functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_ProtocolUnit     = 0x0B, /**< CDC class specific Protocol Unit functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_ExtensionUnit    = 0x0C, /**< CDC class specific Extension Unit functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_MultiChannel     = 0x0D, /**< CDC class specific Multi-Channel Management functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_CAPI             = 0x0E, /**< CDC class specific Common ISDN API functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_Ethernet         = 0x0F, /**< CDC class specific Ethernet functional descriptor. */
+                       CDC_DSUBTYPE_CSInterface_ATM              = 0x10, /**< CDC class specific Asynchronous Transfer Mode functional descriptor. */

                };
 
                /** Enum for the possible line encoding formats of a virtual serial port. */
                };
 
                /** Enum for the possible line encoding formats of a virtual serial port. */


@@ -242,6 +234,8 @@
                                                          */
                        uint16_t                CDCSpecification; /**< Version number of the CDC specification implemented by the device,
                                                                   *   encoded in BCD format.
                                                          */
                        uint16_t                CDCSpecification; /**< Version number of the CDC specification implemented by the device,
                                                                   *   encoded in BCD format.

+                                                                  *
+                                                                  *   \see \ref VERSION_BCD() utility macro.

                                                                   */
                } ATTR_PACKED USB_CDC_Descriptor_FunctionalHeader_t;
 
                                                                   */
                } ATTR_PACKED USB_CDC_Descriptor_FunctionalHeader_t;
 


@@ -265,7 +259,10 @@
                        uint8_t  bDescriptorSubType; /**< Sub type value used to distinguish between CDC class-specific descriptors,
                                                      *   must be \ref CDC_DSUBTYPE_CSInterface_Header.
                                                      */
                        uint8_t  bDescriptorSubType; /**< Sub type value used to distinguish between CDC class-specific descriptors,
                                                      *   must be \ref CDC_DSUBTYPE_CSInterface_Header.
                                                      */

-                       uint16_t bcdCDC; /**< Version number of the CDC specification implemented by the device, encoded in BCD format. */
+                       uint16_t bcdCDC; /**< Version number of the CDC specification implemented by the device, encoded in BCD format.
+                                         *
+                                         *   \see \ref VERSION_BCD() utility macro.
+                                         */

                } ATTR_PACKED USB_CDC_StdDescriptor_FunctionalHeader_t;
 
                /** \brief CDC class-specific Functional ACM Descriptor (LUFA naming conventions).
                } ATTR_PACKED USB_CDC_StdDescriptor_FunctionalHeader_t;
 
                /** \brief CDC class-specific Functional ACM Descriptor (LUFA naming conventions).


@@ -284,7 +281,7 @@
                                                          *   must be \ref CDC_DSUBTYPE_CSInterface_ACM.
                                                          */
                        uint8_t                 Capabilities; /**< Capabilities of the ACM interface, given as a bit mask. For most devices,
                                                          *   must be \ref CDC_DSUBTYPE_CSInterface_ACM.
                                                          */
                        uint8_t                 Capabilities; /**< Capabilities of the ACM interface, given as a bit mask. For most devices,

-                                                              *   this should be set to a fixed value of 0x06 - for other capabilities, refer
+                                                              *   this should be set to a fixed value of \c 0x06 - for other capabilities, refer

                                                               *   to the CDC ACM specification.
                                                               */
                } ATTR_PACKED USB_CDC_Descriptor_FunctionalACM_t;
                                                               *   to the CDC ACM specification.
                                                               */
                } ATTR_PACKED USB_CDC_Descriptor_FunctionalACM_t;


@@ -355,7 +352,7 @@
                        uint8_t bMasterInterface; /**< Interface number of the CDC Control interface. */
                        uint8_t bSlaveInterface0; /**< Interface number of the CDC Data interface. */
                } ATTR_PACKED USB_CDC_StdDescriptor_FunctionalUnion_t;
                        uint8_t bMasterInterface; /**< Interface number of the CDC Control interface. */
                        uint8_t bSlaveInterface0; /**< Interface number of the CDC Data interface. */
                } ATTR_PACKED USB_CDC_StdDescriptor_FunctionalUnion_t;

-               
+

                /** \brief CDC Virtual Serial Port Line Encoding Settings Structure.
                 *
                 *  Type define for a CDC Line Encoding structure, used to hold the various encoding parameters for a virtual
                /** \brief CDC Virtual Serial Port Line Encoding Settings Structure.
                 *
                 *  Type define for a CDC Line Encoding structure, used to hold the various encoding parameters for a virtual