LUFA/Drivers/USB/Class/Common/Audio.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Common definitions and declarations for the library USB Audio 1.0 Class driver.
  33  *
  34  *  Common definitions and declarations for the library USB Audio 1.0 Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassAudio
  41  *  \defgroup Group_USBClassAudioCommon  Common Class Definitions
  42  *
  43  *  \section Sec_ModDescription Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  Audio 1.0 Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _AUDIO_CLASS_COMMON_H_
  51 #define _AUDIO_CLASS_COMMON_H_
  52
  53         /* Includes: */
  54                 #include "../../Core/StdDescriptors.h"
  55
  56         /* Enable C linkage for C++ Compilers: */
  57                 #if defined(__cplusplus)
  58                         extern "C" {
  59                 #endif
  60
  61         /* Preprocessor Checks: */
  62                 #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
  63                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  64                 #endif
  65
  66         /* Macros: */
  67                 /** \name Audio Channel Masks */
  68                 //@{
  69                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  70                 #define AUDIO_CHANNEL_LEFT_FRONT           (1 << 0)
  71
  72                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  73                 #define AUDIO_CHANNEL_RIGHT_FRONT          (1 << 1)
  74
  75                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  76                 #define AUDIO_CHANNEL_CENTER_FRONT         (1 << 2)
  77
  78                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  79                 #define AUDIO_CHANNEL_LOW_FREQ_ENHANCE     (1 << 3)
  80
  81                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  82                 #define AUDIO_CHANNEL_LEFT_SURROUND        (1 << 4)
  83
  84                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  85                 #define AUDIO_CHANNEL_RIGHT_SURROUND       (1 << 5)
  86
  87                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  88                 #define AUDIO_CHANNEL_LEFT_OF_CENTER       (1 << 6)
  89
  90                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  91                 #define AUDIO_CHANNEL_RIGHT_OF_CENTER      (1 << 7)
  92
  93                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  94                 #define AUDIO_CHANNEL_SURROUND             (1 << 8)
  95
  96                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
  97                 #define AUDIO_CHANNEL_SIDE_LEFT            (1 << 9)
  98
  99                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 100                 #define AUDIO_CHANNEL_SIDE_RIGHT           (1 << 10)
 101
 102                 /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
 103                 #define AUDIO_CHANNEL_TOP                  (1 << 11)
 104                 //@}
 105
 106                 /** \name Audio Feature Masks */
 107                 //@{
 108                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 109                 #define AUDIO_FEATURE_MUTE                 (1 << 0)
 110
 111                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 112                 #define AUDIO_FEATURE_VOLUME               (1 << 1)
 113
 114                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 115                 #define AUDIO_FEATURE_BASS                 (1 << 2)
 116
 117                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 118                 #define AUDIO_FEATURE_MID                  (1 << 3)
 119
 120                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 121                 #define AUDIO_FEATURE_TREBLE               (1 << 4)
 122
 123                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 124                 #define AUDIO_FEATURE_GRAPHIC_EQUALIZER    (1 << 5)
 125
 126                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 127                 #define AUDIO_FEATURE_AUTOMATIC_GAIN       (1 << 6)
 128
 129                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 130                 #define AUDIO_FEATURE_DELAY                (1 << 7)
 131
 132                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 133                 #define AUDIO_FEATURE_BASS_BOOST           (1 << 8)
 134
 135                 /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
 136                 #define AUDIO_FEATURE_BASS_LOUDNESS        (1 << 9)
 137                 //@}
 138
 139                 /** \name Audio Terminal Types */
 140                 //@{
 141                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 142                 #define AUDIO_TERMINAL_UNDEFINED           0x0100
 143
 144                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 145                 #define AUDIO_TERMINAL_STREAMING           0x0101
 146
 147                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 148                 #define AUDIO_TERMINAL_VENDOR              0x01FF
 149
 150                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 151                 #define AUDIO_TERMINAL_IN_UNDEFINED        0x0200
 152
 153                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 154                 #define AUDIO_TERMINAL_IN_MIC              0x0201
 155
 156                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 157                 #define AUDIO_TERMINAL_IN_DESKTOP_MIC      0x0202
 158
 159                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 160                 #define AUDIO_TERMINAL_IN_PERSONAL_MIC     0x0203
 161
 162                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 163                 #define AUDIO_TERMINAL_IN_OMNIDIR_MIC      0x0204
 164
 165                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 166                 #define AUDIO_TERMINAL_IN_MIC_ARRAY        0x0205
 167
 168                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 169                 #define AUDIO_TERMINAL_IN_PROCESSING_MIC   0x0206
 170
 171                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 172                 #define AUDIO_TERMINAL_IN_OUT_UNDEFINED    0x0300
 173
 174                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 175                 #define AUDIO_TERMINAL_OUT_SPEAKER         0x0301
 176
 177                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 178                 #define AUDIO_TERMINAL_OUT_HEADPHONES      0x0302
 179
 180                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 181                 #define AUDIO_TERMINAL_OUT_HEAD_MOUNTED    0x0303
 182
 183                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 184                 #define AUDIO_TERMINAL_OUT_DESKTOP         0x0304
 185
 186                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 187                 #define AUDIO_TERMINAL_OUT_ROOM            0x0305
 188
 189                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 190                 #define AUDIO_TERMINAL_OUT_COMMUNICATION   0x0306
 191
 192                 /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
 193                 #define AUDIO_TERMINAL_OUT_LOWFREQ         0x0307
 194                 //@}
 195
 196                 /** Convenience macro to fill a 24-bit \ref USB_Audio_SampleFreq_t structure with the given sample rate as a 24-bit number.
 197                  *
 198                  *  \param[in] freq  Required audio sampling frequency in HZ
 199                  */
 200                 #define AUDIO_SAMPLE_FREQ(freq)           {.Byte1 = ((uint32_t)freq & 0x0000FF), .Byte2 = (((uint32_t)freq >> 8) & 0xFF), .Byte3 = (((uint32_t)freq >> 16) & 0xFF)}
 201
 202                 /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
 203                  *  accepts only filled endpoint packets of audio samples.
 204                  */
 205                 #define AUDIO_EP_FULL_PACKETS_ONLY        (1 << 7)
 206
 207                 /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
 208                  *  will accept partially filled endpoint packets of audio samples.
 209                  */
 210                 #define AUDIO_EP_ACCEPTS_SMALL_PACKETS    (0 << 7)
 211
 212         /* Enums: */
 213                 /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio
 214                  *  device class.
 215                  */
 216                 enum Audio_Descriptor_ClassSubclassProtocol_t
 217                 {
 218                         AUDIO_CSCP_AudioClass                     = 0x01, /**< Descriptor Class value indicating that the device or
 219                                                                            *   interface belongs to the USB Audio 1.0 class.
 220                                                                            */
 221                         AUDIO_CSCP_ControlSubclass                = 0x01, /**< Descriptor Subclass value indicating that the device or
 222                                                                            *   interface belongs to the Audio Control subclass.
 223                                                                            */
 224                         AUDIO_CSCP_ControlProtocol                = 0x00, /**< Descriptor Protocol value indicating that the device or
 225                                                                            *   interface belongs to the Audio Control protocol.
 226                                                                            */
 227                         AUDIO_CSCP_AudioStreamingSubclass         = 0x02, /**< Descriptor Subclass value indicating that the device or
 228                                                                            *   interface belongs to the MIDI Streaming subclass.
 229                                                                            */
 230                         AUDIO_CSCP_MIDIStreamingSubclass          = 0x03, /**< Descriptor Subclass value indicating that the device or
 231                                                                            *   interface belongs to the Audio streaming subclass.
 232                                                                            */
 233                         AUDIO_CSCP_StreamingProtocol              = 0x00, /**< Descriptor Protocol value indicating that the device or
 234                                                                            *   interface belongs to the Streaming Audio protocol.
 235                                                                            */
 236                 };
 237
 238                 /** Audio class specific interface description subtypes, for the Audio Control interface. */
 239                 enum Audio_CSInterface_AC_SubTypes_t
 240                 {
 241                         AUDIO_DSUBTYPE_CSInterface_Header         = 0x01, /**< Audio class specific control interface header. */
 242                         AUDIO_DSUBTYPE_CSInterface_InputTerminal  = 0x02, /**< Audio class specific control interface Input Terminal. */
 243                         AUDIO_DSUBTYPE_CSInterface_OutputTerminal = 0x03, /**< Audio class specific control interface Output Terminal. */
 244                         AUDIO_DSUBTYPE_CSInterface_Mixer          = 0x04, /**< Audio class specific control interface Mixer Unit. */
 245                         AUDIO_DSUBTYPE_CSInterface_Selector       = 0x05, /**< Audio class specific control interface Selector Unit. */
 246                         AUDIO_DSUBTYPE_CSInterface_Feature        = 0x06, /**< Audio class specific control interface Feature Unit. */
 247                         AUDIO_DSUBTYPE_CSInterface_Processing     = 0x07, /**< Audio class specific control interface Processing Unit. */
 248                         AUDIO_DSUBTYPE_CSInterface_Extension      = 0x08, /**< Audio class specific control interface Extension Unit. */
 249                 };
 250
 251                 /** Audio class specific interface description subtypes, for the Audio Streaming interface. */
 252                 enum Audio_CSInterface_AS_SubTypes_t
 253                 {
 254                         AUDIO_DSUBTYPE_CSInterface_General        = 0x01, /**< Audio class specific streaming interface general descriptor. */
 255                         AUDIO_DSUBTYPE_CSInterface_FormatType     = 0x02, /**< Audio class specific streaming interface format type descriptor. */
 256                         AUDIO_DSUBTYPE_CSInterface_FormatSpecific = 0x03, /**< Audio class specific streaming interface format information descriptor. */
 257                 };
 258
 259                 /** Audio class specific endpoint description subtypes, for the Audio Streaming interface. */
 260                 enum Audio_CSEndpoint_SubTypes_t
 261                 {
 262                         AUDIO_DSUBTYPE_CSEndpoint_General         = 0x01, /**< Audio class specific endpoint general descriptor. */
 263                 };
 264
 265                 /** Enum for the Audio class specific control requests that can be issued by the USB bus host. */
 266                 enum Audio_ClassRequests_t
 267                 {
 268                         AUDIO_REQ_SetCurrent    = 0x01, /**< Audio class-specific request to set the current value of a parameter within the device. */
 269                         AUDIO_REQ_SetMinimum    = 0x02, /**< Audio class-specific request to set the minimum value of a parameter within the device. */
 270                         AUDIO_REQ_SetMaximum    = 0x03, /**< Audio class-specific request to set the maximum value of a parameter within the device. */
 271                         AUDIO_REQ_SetResolution = 0x04, /**< Audio class-specific request to set the resolution value of a parameter within the device. */
 272                         AUDIO_REQ_SetMemory     = 0x05, /**< Audio class-specific request to set the memory value of a parameter within the device. */
 273                         AUDIO_REQ_GetCurrent    = 0x81, /**< Audio class-specific request to get the current value of a parameter within the device. */
 274                         AUDIO_REQ_GetMinimum    = 0x82, /**< Audio class-specific request to get the minimum value of a parameter within the device. */
 275                         AUDIO_REQ_GetMaximum    = 0x83, /**< Audio class-specific request to get the maximum value of a parameter within the device. */
 276                         AUDIO_REQ_GetResolution = 0x84, /**< Audio class-specific request to get the resolution value of a parameter within the device. */
 277                         AUDIO_REQ_GetMemory     = 0x85, /**< Audio class-specific request to get the memory value of a parameter within the device. */
 278                         AUDIO_REQ_GetStatus     = 0xFF, /**< Audio class-specific request to get the device status. */
 279                 };
 280
 281         /* Type Defines: */
 282                 /** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
 283                  *
 284                  *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
 285                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 286                  *  a USB endpoint). See the USB Audio specification for more details.
 287                  *
 288                  *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
 289                  */
 290                 typedef struct
 291                 {
 292                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 293                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 294                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
 295                                                           */
 296
 297                         uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 298                         uint16_t                TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
 299                         uint8_t                 AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
 300                                                                            *   such as the speaker and microphone of a phone handset.
 301                                                                            */
 302                         uint8_t                 TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 303                         uint16_t                ChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
 304
 305                         uint8_t                 ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
 306                         uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 307                 } ATTR_PACKED USB_Audio_Descriptor_InputTerminal_t;
 308
 309                 /** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions).
 310                  *
 311                  *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
 312                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 313                  *  a USB endpoint). See the USB Audio specification for more details.
 314                  *
 315                  *  \see \ref USB_Audio_Descriptor_InputTerminal_t for the version of this type with non-standard LUFA specific
 316                  *       element names.
 317                  */
 318                 typedef struct
 319                 {
 320                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 321                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 322                                                    *   given by the specific class.
 323                                                    */
 324
 325                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 326                                                       *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
 327                                                       */
 328                         uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 329                         uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
 330                         uint8_t  bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals
 331                                                   *   such as the speaker and microphone of a phone handset.
 332                                                   */
 333                         uint8_t  bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 334                         uint16_t wChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
 335
 336                         uint8_t  iChannelNames; /**< Index of a string descriptor describing this channel within the device. */
 337                         uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
 338                 } ATTR_PACKED USB_Audio_StdDescriptor_InputTerminal_t;
 339
 340                 /** \brief Audio class-specific Output Terminal Descriptor (LUFA naming conventions).
 341                  *
 342                  *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
 343                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 344                  *  a USB endpoint). See the USB Audio specification for more details.
 345                  *
 346                  *  \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
 347                  */
 348                 typedef struct
 349                 {
 350                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 351                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 352                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
 353                                                           */
 354
 355                         uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 356                         uint16_t                TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
 357                         uint8_t                 AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
 358                                                                             *   such as the speaker and microphone of a phone handset.
 359                                                                             */
 360                         uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
 361
 362                         uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 363                 } ATTR_PACKED USB_Audio_Descriptor_OutputTerminal_t;
 364
 365                 /** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions).
 366                  *
 367                  *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
 368                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 369                  *  a USB endpoint). See the USB Audio specification for more details.
 370                  *
 371                  *  \see \ref USB_Audio_Descriptor_OutputTerminal_t for the version of this type with non-standard LUFA specific
 372                  *       element names.
 373                  */
 374                 typedef struct
 375                 {
 376                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 377                         uint8_t  bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
 378                                                    *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
 379                                                    */
 380
 381                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 382                                                       *   a value from the \ref Audio_CSInterface_AC_SubTypes_t enum.
 383                                                       */
 384                         uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 385                         uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
 386                         uint8_t  bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals
 387                                                   *   such as the speaker and microphone of a phone handset.
 388                                                   */
 389                         uint8_t  bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */
 390
 391                         uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
 392                 } ATTR_PACKED USB_Audio_StdDescriptor_OutputTerminal_t;
 393
 394                 /** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
 395                  *
 396                  *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
 397                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 398                  *  details.
 399                  *
 400                  *  \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
 401                  */
 402                 typedef struct
 403                 {
 404                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 405                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 406                                                           *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 407                                                           */
 408
 409                         uint16_t                ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
 410                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 411
 412                         uint8_t                 InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
 413                         uint8_t                 InterfaceNumber; /**< Interface number of the associated Audio Streaming interface. */
 414                 } ATTR_PACKED USB_Audio_Descriptor_Interface_AC_t;
 415
 416                 /** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions).
 417                  *
 418                  *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
 419                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 420                  *  details.
 421                  *
 422                  *  \see \ref USB_Audio_Descriptor_Interface_AC_t for the version of this type with non-standard LUFA specific
 423                  *       element names.
 424                  */
 425                 typedef struct
 426                 {
 427                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 428                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 429                                                    *   given by the specific class.
 430                                                    */
 431
 432                         uint8_t  bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
 433                                                      *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 434                                                      */
 435
 436                         uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
 437                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 438
 439                         uint8_t  bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
 440                         uint8_t  bInterfaceNumbers; /**< Interface number of the associated Audio Streaming interface. */
 441                 } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AC_t;
 442
 443                 /** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
 444                  *
 445                  *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
 446                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 447                  *  specification for more details.
 448                  *
 449                  *  \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
 450                  */
 451                 typedef struct
 452                 {
 453                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 454                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 455                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
 456                                                           */
 457
 458                         uint8_t                 UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
 459                         uint8_t                 SourceID; /**< Source ID value of the audio source input into this feature unit. */
 460
 461                         uint8_t                 ControlSize; /**< Size of each element in the \c ChanelControlls array. */
 462                         uint8_t                 ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
 463
 464                         uint8_t                 FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 465                 } ATTR_PACKED USB_Audio_Descriptor_FeatureUnit_t;
 466
 467                 /** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions).
 468                  *
 469                  *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
 470                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 471                  *  specification for more details.
 472                  *
 473                  *  \see \ref USB_Audio_Descriptor_FeatureUnit_t for the version of this type with non-standard LUFA specific
 474                  *       element names.
 475                  */
 476                 typedef struct
 477                 {
 478                         uint8_t bLength; /**< Size of the descriptor, in bytes. */
 479                         uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 480                                                   *   given by the specific class.
 481                                                   */
 482
 483                         uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 484                                                      *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
 485                                                      */
 486
 487                         uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
 488                         uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
 489
 490                         uint8_t bControlSize; /**< Size of each element in the \c ChanelControlls array. */
 491                         uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
 492
 493                         uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
 494                 } ATTR_PACKED USB_Audio_StdDescriptor_FeatureUnit_t;
 495
 496                 /** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
 497                  *
 498                  *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
 499                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 500                  *
 501                  *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
 502                  */
 503                 typedef struct
 504                 {
 505                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 506                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 507                                                           *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 508                                                           */
 509
 510                         uint8_t                 TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
 511
 512                         uint8_t                 FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
 513                         uint16_t                AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
 514                 } ATTR_PACKED USB_Audio_Descriptor_Interface_AS_t;
 515
 516                 /** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions).
 517                  *
 518                  *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
 519                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 520                  *
 521                  *  \see \ref USB_Audio_Descriptor_Interface_AS_t for the version of this type with non-standard LUFA specific
 522                  *       element names.
 523                  */
 524                 typedef struct
 525                 {
 526                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 527                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 528                                                    *   given by the specific class.
 529                                                    */
 530
 531                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 532                                                       *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 533                                                       */
 534
 535                         uint8_t  bTerminalLink; /**< ID value of the output terminal this descriptor is describing. */
 536
 537                         uint8_t  bDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
 538                         uint16_t wFormatTag; /**< Format of the audio stream, see Audio Device Formats specification. */
 539                 } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AS_t;
 540
 541                 /** \brief 24-Bit Audio Frequency Structure.
 542                  *
 543                  *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
 544                  *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
 545                  */
 546                 typedef struct
 547                 {
 548                         uint8_t Byte1; /**< Lowest 8 bits of the 24-bit value. */
 549                         uint8_t Byte2; /**< Middle 8 bits of the 24-bit value. */
 550                         uint8_t Byte3; /**< Upper 8 bits of the 24-bit value. */
 551                 } ATTR_PACKED USB_Audio_SampleFreq_t;
 552
 553                 /** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
 554                  *
 555                  *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
 556                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 557                  *  in the device's audio streams. See the USB Audio specification for more details.
 558                  *
 559                  *  \note This descriptor <b>must</b> be followed by one or more \ref USB_Audio_SampleFreq_t elements containing
 560                  *        the continuous or discrete sample frequencies.
 561                  *
 562                  *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
 563                  */
 564                 typedef struct
 565                 {
 566                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 567                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 568                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
 569                                                           */
 570
 571                         uint8_t                 FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
 572                         uint8_t                 Channels; /**< Total number of discrete channels in the stream. */
 573
 574                         uint8_t                 SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
 575                         uint8_t                 BitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 576
 577                         uint8_t                 TotalDiscreteSampleRates; /**< Total number of discrete sample frequencies supported by the device. When
 578                                                                            *   zero, this must be followed by the lower and upper continuous sampling
 579                                                                            *   frequencies supported by the device; otherwise, this must be followed
 580                                                                            *   by the given number of discrete sampling frequencies supported.
 581                                                                            */
 582                 } ATTR_PACKED USB_Audio_Descriptor_Format_t;
 583
 584                 /** \brief Audio class-specific Format Descriptor (USB-IF naming conventions).
 585                  *
 586                  *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
 587                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 588                  *  in the device's audio streams. See the USB Audio specification for more details.
 589                  *
 590                  *  \note This descriptor <b>must</b> be followed by one or more 24-bit integer elements containing the continuous
 591                  *        or discrete sample frequencies.
 592                  *
 593                  *  \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
 594                  *       element names.
 595                  */
 596                 typedef struct
 597                 {
 598                         uint8_t bLength; /**< Size of the descriptor, in bytes. */
 599                         uint8_t bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
 600                                                   *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
 601                                                   */
 602
 603                         uint8_t bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
 604                                                     *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 605                                                     */
 606
 607                         uint8_t bFormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
 608                         uint8_t bNrChannels; /**< Total number of discrete channels in the stream. */
 609
 610                         uint8_t bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
 611                         uint8_t bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 612
 613                         uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. When
 614                                                        *   zero, this must be followed by the lower and upper continuous sampling
 615                                                        *   frequencies supported by the device; otherwise, this must be followed
 616                                                        *   by the given number of discrete sampling frequencies supported.
 617                                                        */
 618                 } ATTR_PACKED USB_Audio_StdDescriptor_Format_t;
 619
 620                 /** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
 621                  *
 622                  *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
 623                  *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
 624                  *
 625                  *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
 626                  */
 627                 typedef struct
 628                 {
 629                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
 630
 631                         uint8_t                   Refresh; /**< Always set to zero for Audio class devices. */
 632                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
 633                 } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Std_t;
 634
 635                 /** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
 636                  *
 637                  *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
 638                  *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
 639                  *
 640                  *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Std_t for the version of this type with non-standard LUFA specific
 641                  *       element names.
 642                  */
 643                 typedef struct
 644                 {
 645                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 646                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
 647                                                    *   value given by the specific class.
 648                                                    */
 649                         uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
 650                                                     *   configuration, including direction mask.
 651                                                     */
 652                         uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (\c EP_TYPE_*)
 653                                                 *   and attributes (\c ENDPOINT_ATTR_*) masks.
 654                                                 */
 655                         uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
 656                                                   *   that the endpoint can receive at a time.
 657                                                   */
 658                         uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
 659                                              *   ISOCHRONOUS type.
 660                                              */
 661
 662                         uint8_t  bRefresh; /**< Always set to zero for Audio class devices. */
 663                         uint8_t  bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
 664                 } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Std_t;
 665
 666                 /** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
 667                  *
 668                  *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
 669                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 670                  *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
 671                  *
 672                  *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
 673                  */
 674                 typedef struct
 675                 {
 676                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 677                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 678                                                           *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
 679                                                           */
 680
 681                         uint8_t                 Attributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
 682
 683                         uint8_t                 LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
 684                         uint16_t                LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
 685                 } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Spc_t;
 686
 687                 /** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions).
 688                  *
 689                  *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
 690                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 691                  *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
 692                  *
 693                  *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Spc_t for the version of this type with non-standard LUFA specific
 694                  *       element names.
 695                  */
 696                 typedef struct
 697                 {
 698                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 699                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 700                                                    *   given by the specific class.
 701                                                    */
 702
 703                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 704                                                       *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
 705                                                       */
 706
 707                         uint8_t  bmAttributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
 708
 709                         uint8_t  bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
 710                         uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
 711                 } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Spc_t;
 712
 713         /* Disable C linkage for C++ Compilers: */
 714                 #if defined(__cplusplus)
 715                         }
 716                 #endif
 717
 718 #endif
 719
 720 /** @} */
 721