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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2018.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2018  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 disclaims 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_USBClassAudioCommon_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 & 0xFF), .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                 /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
 213                  *  allows for sampling frequency adjustments to be made via control requests directed at the endpoint.
 214                  */
 215                 #define AUDIO_EP_SAMPLE_FREQ_CONTROL      (1 << 0)
 216
 217                 /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
 218                  *  allows for pitch adjustments to be made via control requests directed at the endpoint.
 219                  */
 220                 #define AUDIO_EP_PITCH_CONTROL            (1 << 1)
 221
 222         /* Enums: */
 223                 /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio
 224                  *  device class.
 225                  */
 226                 enum Audio_Descriptor_ClassSubclassProtocol_t
 227                 {
 228                         AUDIO_CSCP_AudioClass                     = 0x01, /**< Descriptor Class value indicating that the device or
 229                                                                            *   interface belongs to the USB Audio 1.0 class.
 230                                                                            */
 231                         AUDIO_CSCP_ControlSubclass                = 0x01, /**< Descriptor Subclass value indicating that the device or
 232                                                                            *   interface belongs to the Audio Control subclass.
 233                                                                            */
 234                         AUDIO_CSCP_ControlProtocol                = 0x00, /**< Descriptor Protocol value indicating that the device or
 235                                                                            *   interface belongs to the Audio Control protocol.
 236                                                                            */
 237                         AUDIO_CSCP_AudioStreamingSubclass         = 0x02, /**< Descriptor Subclass value indicating that the device or
 238                                                                            *   interface belongs to the MIDI Streaming subclass.
 239                                                                            */
 240                         AUDIO_CSCP_MIDIStreamingSubclass          = 0x03, /**< Descriptor Subclass value indicating that the device or
 241                                                                            *   interface belongs to the Audio streaming subclass.
 242                                                                            */
 243                         AUDIO_CSCP_StreamingProtocol              = 0x00, /**< Descriptor Protocol value indicating that the device or
 244                                                                            *   interface belongs to the Streaming Audio protocol.
 245                                                                            */
 246                 };
 247
 248                 /** Enum for the Audio class specific descriptor types. */
 249                 enum AUDIO_DescriptorTypes_t
 250                 {
 251                         AUDIO_DTYPE_CSInterface                     = 0x24, /**< Audio class specific Interface functional descriptor. */
 252                         AUDIO_DTYPE_CSEndpoint                      = 0x25, /**< Audio class specific Endpoint functional descriptor. */
 253                 };
 254
 255                 /** Audio class specific interface description subtypes, for the Audio Control interface. */
 256                 enum Audio_CSInterface_AC_SubTypes_t
 257                 {
 258                         AUDIO_DSUBTYPE_CSInterface_Header         = 0x01, /**< Audio class specific control interface header. */
 259                         AUDIO_DSUBTYPE_CSInterface_InputTerminal  = 0x02, /**< Audio class specific control interface Input Terminal. */
 260                         AUDIO_DSUBTYPE_CSInterface_OutputTerminal = 0x03, /**< Audio class specific control interface Output Terminal. */
 261                         AUDIO_DSUBTYPE_CSInterface_Mixer          = 0x04, /**< Audio class specific control interface Mixer Unit. */
 262                         AUDIO_DSUBTYPE_CSInterface_Selector       = 0x05, /**< Audio class specific control interface Selector Unit. */
 263                         AUDIO_DSUBTYPE_CSInterface_Feature        = 0x06, /**< Audio class specific control interface Feature Unit. */
 264                         AUDIO_DSUBTYPE_CSInterface_Processing     = 0x07, /**< Audio class specific control interface Processing Unit. */
 265                         AUDIO_DSUBTYPE_CSInterface_Extension      = 0x08, /**< Audio class specific control interface Extension Unit. */
 266                 };
 267
 268                 /** Audio class specific interface description subtypes, for the Audio Streaming interface. */
 269                 enum Audio_CSInterface_AS_SubTypes_t
 270                 {
 271                         AUDIO_DSUBTYPE_CSInterface_General        = 0x01, /**< Audio class specific streaming interface general descriptor. */
 272                         AUDIO_DSUBTYPE_CSInterface_FormatType     = 0x02, /**< Audio class specific streaming interface format type descriptor. */
 273                         AUDIO_DSUBTYPE_CSInterface_FormatSpecific = 0x03, /**< Audio class specific streaming interface format information descriptor. */
 274                 };
 275
 276                 /** Audio class specific endpoint description subtypes, for the Audio Streaming interface. */
 277                 enum Audio_CSEndpoint_SubTypes_t
 278                 {
 279                         AUDIO_DSUBTYPE_CSEndpoint_General         = 0x01, /**< Audio class specific endpoint general descriptor. */
 280                 };
 281
 282                 /** Enum for the Audio class specific control requests that can be issued by the USB bus host. */
 283                 enum Audio_ClassRequests_t
 284                 {
 285                         AUDIO_REQ_SetCurrent    = 0x01, /**< Audio class-specific request to set the current value of a parameter within the device. */
 286                         AUDIO_REQ_SetMinimum    = 0x02, /**< Audio class-specific request to set the minimum value of a parameter within the device. */
 287                         AUDIO_REQ_SetMaximum    = 0x03, /**< Audio class-specific request to set the maximum value of a parameter within the device. */
 288                         AUDIO_REQ_SetResolution = 0x04, /**< Audio class-specific request to set the resolution value of a parameter within the device. */
 289                         AUDIO_REQ_SetMemory     = 0x05, /**< Audio class-specific request to set the memory value of a parameter within the device. */
 290                         AUDIO_REQ_GetCurrent    = 0x81, /**< Audio class-specific request to get the current value of a parameter within the device. */
 291                         AUDIO_REQ_GetMinimum    = 0x82, /**< Audio class-specific request to get the minimum value of a parameter within the device. */
 292                         AUDIO_REQ_GetMaximum    = 0x83, /**< Audio class-specific request to get the maximum value of a parameter within the device. */
 293                         AUDIO_REQ_GetResolution = 0x84, /**< Audio class-specific request to get the resolution value of a parameter within the device. */
 294                         AUDIO_REQ_GetMemory     = 0x85, /**< Audio class-specific request to get the memory value of a parameter within the device. */
 295                         AUDIO_REQ_GetStatus     = 0xFF, /**< Audio class-specific request to get the device status. */
 296                 };
 297
 298                 /** Enum for Audio class specific Endpoint control modifiers which can be set and retrieved by a USB host, if the corresponding
 299                  *  endpoint control is indicated to be supported in the Endpoint's Audio-class specific endpoint descriptor.
 300                  */
 301                 enum Audio_EndpointControls_t
 302                 {
 303                         AUDIO_EPCONTROL_SamplingFreq = 0x01, /**< Sampling frequency adjustment of the endpoint. */
 304                         AUDIO_EPCONTROL_Pitch        = 0x02, /**< Pitch adjustment of the endpoint. */
 305                 };
 306
 307         /* Type Defines: */
 308                 /** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
 309                  *
 310                  *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
 311                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 312                  *  a USB endpoint). See the USB Audio specification for more details.
 313                  *
 314                  *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
 315                  *
 316                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 317                  */
 318                 typedef struct
 319                 {
 320                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 321                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 322                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
 323                                                           */
 324
 325                         uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 326                         uint16_t                TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
 327                         uint8_t                 AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
 328                                                                            *   such as the speaker and microphone of a phone handset.
 329                                                                            */
 330                         uint8_t                 TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 331                         uint16_t                ChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
 332
 333                         uint8_t                 ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
 334                         uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 335                 } ATTR_PACKED USB_Audio_Descriptor_InputTerminal_t;
 336
 337                 /** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions).
 338                  *
 339                  *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
 340                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 341                  *  a USB endpoint). See the USB Audio specification for more details.
 342                  *
 343                  *  \see \ref USB_Audio_Descriptor_InputTerminal_t for the version of this type with non-standard LUFA specific
 344                  *       element names.
 345                  *
 346                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 347                  */
 348                 typedef struct
 349                 {
 350                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 351                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 352                                                    *   given by the specific class.
 353                                                    */
 354
 355                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 356                                                       *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
 357                                                       */
 358                         uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 359                         uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
 360                         uint8_t  bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals
 361                                                   *   such as the speaker and microphone of a phone handset.
 362                                                   */
 363                         uint8_t  bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 364                         uint16_t wChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
 365
 366                         uint8_t  iChannelNames; /**< Index of a string descriptor describing this channel within the device. */
 367                         uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
 368                 } ATTR_PACKED USB_Audio_StdDescriptor_InputTerminal_t;
 369
 370                 /** \brief Audio class-specific Output Terminal Descriptor (LUFA naming conventions).
 371                  *
 372                  *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
 373                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 374                  *  a USB endpoint). See the USB Audio specification for more details.
 375                  *
 376                  *  \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
 377                  *
 378                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 379                  */
 380                 typedef struct
 381                 {
 382                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 383                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 384                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
 385                                                           */
 386
 387                         uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 388                         uint16_t                TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
 389                         uint8_t                 AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
 390                                                                             *   such as the speaker and microphone of a phone handset.
 391                                                                             */
 392                         uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
 393
 394                         uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 395                 } ATTR_PACKED USB_Audio_Descriptor_OutputTerminal_t;
 396
 397                 /** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions).
 398                  *
 399                  *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
 400                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 401                  *  a USB endpoint). See the USB Audio specification for more details.
 402                  *
 403                  *  \see \ref USB_Audio_Descriptor_OutputTerminal_t for the version of this type with non-standard LUFA specific
 404                  *       element names.
 405                  *
 406                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 407                  */
 408                 typedef struct
 409                 {
 410                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 411                         uint8_t  bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
 412                                                    *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
 413                                                    */
 414
 415                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 416                                                       *   a value from the \ref Audio_CSInterface_AC_SubTypes_t enum.
 417                                                       */
 418                         uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 419                         uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
 420                         uint8_t  bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals
 421                                                   *   such as the speaker and microphone of a phone handset.
 422                                                   */
 423                         uint8_t  bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */
 424
 425                         uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
 426                 } ATTR_PACKED USB_Audio_StdDescriptor_OutputTerminal_t;
 427
 428                 /** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
 429                  *
 430                  *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
 431                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 432                  *  details.
 433                  *
 434                  *  \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
 435                  *
 436                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 437                  */
 438                 typedef struct
 439                 {
 440                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 441                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 442                                                           *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 443                                                           */
 444
 445                         uint16_t                ACSpecification; /**< Binary Coded Decimal value, indicating the supported Audio Class specification version.
 446                                                                   *
 447                                                                   *   \see \ref VERSION_BCD() utility macro.
 448                                                                   */
 449                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 450
 451                         uint8_t                 InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
 452                         uint8_t                 InterfaceNumber; /**< Interface number of the associated Audio Streaming interface. */
 453                 } ATTR_PACKED USB_Audio_Descriptor_Interface_AC_t;
 454
 455                 /** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions).
 456                  *
 457                  *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
 458                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 459                  *  details.
 460                  *
 461                  *  \see \ref USB_Audio_Descriptor_Interface_AC_t for the version of this type with non-standard LUFA specific
 462                  *       element names.
 463                  *
 464                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 465                  */
 466                 typedef struct
 467                 {
 468                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 469                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 470                                                    *   given by the specific class.
 471                                                    */
 472
 473                         uint8_t  bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
 474                                                      *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 475                                                      */
 476
 477                         uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version.
 478                                           *
 479                                           *   \see \ref VERSION_BCD() utility macro.
 480                                           */
 481                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 482
 483                         uint8_t  bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
 484                         uint8_t  bInterfaceNumbers; /**< Interface number of the associated Audio Streaming interface. */
 485                 } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AC_t;
 486
 487                 /** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
 488                  *
 489                  *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
 490                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 491                  *  specification for more details.
 492                  *
 493                  *  \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
 494                  *
 495                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 496                  */
 497                 typedef struct
 498                 {
 499                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 500                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 501                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
 502                                                           */
 503
 504                         uint8_t                 UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
 505                         uint8_t                 SourceID; /**< Source ID value of the audio source input into this feature unit. */
 506
 507                         uint8_t                 ControlSize; /**< Size of each element in the \c ChannelControls array. */
 508                         uint8_t                 ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
 509
 510                         uint8_t                 FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 511                 } ATTR_PACKED USB_Audio_Descriptor_FeatureUnit_t;
 512
 513                 /** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions).
 514                  *
 515                  *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
 516                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 517                  *  specification for more details.
 518                  *
 519                  *  \see \ref USB_Audio_Descriptor_FeatureUnit_t for the version of this type with non-standard LUFA specific
 520                  *       element names.
 521                  *
 522                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 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                                                      *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
 533                                                      */
 534
 535                         uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
 536                         uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
 537
 538                         uint8_t bControlSize; /**< Size of each element in the \c ChannelControls array. */
 539                         uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
 540
 541                         uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
 542                 } ATTR_PACKED USB_Audio_StdDescriptor_FeatureUnit_t;
 543
 544                 /** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
 545                  *
 546                  *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
 547                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 548                  *
 549                  *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
 550                  *
 551                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 552                  */
 553                 typedef struct
 554                 {
 555                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 556                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 557                                                           *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 558                                                           */
 559
 560                         uint8_t                 TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
 561
 562                         uint8_t                 FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
 563                         uint16_t                AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
 564                 } ATTR_PACKED USB_Audio_Descriptor_Interface_AS_t;
 565
 566                 /** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions).
 567                  *
 568                  *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
 569                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 570                  *
 571                  *  \see \ref USB_Audio_Descriptor_Interface_AS_t for the version of this type with non-standard LUFA specific
 572                  *       element names.
 573                  *
 574                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 575                  */
 576                 typedef struct
 577                 {
 578                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 579                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 580                                                    *   given by the specific class.
 581                                                    */
 582
 583                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 584                                                       *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 585                                                       */
 586
 587                         uint8_t  bTerminalLink; /**< ID value of the output terminal this descriptor is describing. */
 588
 589                         uint8_t  bDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
 590                         uint16_t wFormatTag; /**< Format of the audio stream, see Audio Device Formats specification. */
 591                 } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AS_t;
 592
 593                 /** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
 594                  *
 595                  *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
 596                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 597                  *  in the device's audio streams. See the USB Audio specification for more details.
 598                  *
 599                  *  \attention This descriptor <b>must</b> be followed by one or more \ref USB_Audio_SampleFreq_t elements containing
 600                  *             the continuous or discrete sample frequencies.
 601                  *
 602                  *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
 603                  *
 604                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 605                  */
 606                 typedef struct
 607                 {
 608                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 609                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 610                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
 611                                                           */
 612
 613                         uint8_t                 FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
 614                         uint8_t                 Channels; /**< Total number of discrete channels in the stream. */
 615
 616                         uint8_t                 SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
 617                         uint8_t                 BitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 618
 619                         uint8_t                 TotalDiscreteSampleRates; /**< Total number of discrete sample frequencies supported by the device. When
 620                                                                            *   zero, this must be followed by the lower and upper continuous sampling
 621                                                                            *   frequencies supported by the device; otherwise, this must be followed
 622                                                                            *   by the given number of discrete sampling frequencies supported.
 623                                                                            */
 624                 } ATTR_PACKED USB_Audio_Descriptor_Format_t;
 625
 626                 /** \brief 24-Bit Audio Frequency Structure.
 627                  *
 628                  *  Type define for a 24-bit audio sample frequency structure. As GCC does not contain a built in 24-bit datatype,
 629                  *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
 630                  *
 631                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 632                  */
 633                 typedef struct
 634                 {
 635                         uint8_t Byte1; /**< Lowest 8 bits of the 24-bit value. */
 636                         uint8_t Byte2; /**< Middle 8 bits of the 24-bit value. */
 637                         uint8_t Byte3; /**< Upper 8 bits of the 24-bit value. */
 638                 } ATTR_PACKED USB_Audio_SampleFreq_t;
 639
 640                 /** \brief Audio class-specific Format Descriptor (USB-IF naming conventions).
 641                  *
 642                  *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
 643                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 644                  *  in the device's audio streams. See the USB Audio specification for more details.
 645                  *
 646                  *  \attention This descriptor <b>must</b> be followed by one or more 24-bit integer elements containing the continuous
 647                  *             or discrete sample frequencies.
 648                  *
 649                  *  \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
 650                  *       element names.
 651                  *
 652                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 653                  */
 654                 typedef struct
 655                 {
 656                         uint8_t bLength; /**< Size of the descriptor, in bytes. */
 657                         uint8_t bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
 658                                                   *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
 659                                                   */
 660
 661                         uint8_t bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
 662                                                     *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 663                                                     */
 664
 665                         uint8_t bFormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
 666                         uint8_t bNrChannels; /**< Total number of discrete channels in the stream. */
 667
 668                         uint8_t bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
 669                         uint8_t bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 670
 671                         uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. When
 672                                                        *   zero, this must be followed by the lower and upper continuous sampling
 673                                                        *   frequencies supported by the device; otherwise, this must be followed
 674                                                        *   by the given number of discrete sampling frequencies supported.
 675                                                        */
 676                 } ATTR_PACKED USB_Audio_StdDescriptor_Format_t;
 677
 678                 /** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
 679                  *
 680                  *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
 681                  *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
 682                  *
 683                  *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
 684                  *
 685                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 686                  */
 687                 typedef struct
 688                 {
 689                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
 690
 691                         uint8_t                   Refresh; /**< Always set to zero for Audio class devices. */
 692                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
 693                 } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Std_t;
 694
 695                 /** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
 696                  *
 697                  *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
 698                  *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
 699                  *
 700                  *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Std_t for the version of this type with non-standard LUFA specific
 701                  *       element names.
 702                  *
 703                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 704                  */
 705                 typedef struct
 706                 {
 707                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 708                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
 709                                                    *   value given by the specific class.
 710                                                    */
 711                         uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
 712                                                     *   configuration, including direction mask.
 713                                                     */
 714                         uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (\c EP_TYPE_*)
 715                                                 *   and attributes (\c ENDPOINT_ATTR_*) masks.
 716                                                 */
 717                         uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
 718                                                   *   that the endpoint can receive at a time.
 719                                                   */
 720                         uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
 721                                              *   ISOCHRONOUS type.
 722                                              */
 723
 724                         uint8_t  bRefresh; /**< Always set to zero for Audio class devices. */
 725                         uint8_t  bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
 726                 } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Std_t;
 727
 728                 /** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
 729                  *
 730                  *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
 731                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 732                  *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
 733                  *
 734                  *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
 735                  *
 736                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 737                  */
 738                 typedef struct
 739                 {
 740                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 741                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 742                                                           *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
 743                                                           */
 744
 745                         uint8_t                 Attributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
 746
 747                         uint8_t                 LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
 748                         uint16_t                LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
 749                 } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Spc_t;
 750
 751                 /** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions).
 752                  *
 753                  *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
 754                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 755                  *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
 756                  *
 757                  *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Spc_t for the version of this type with non-standard LUFA specific
 758                  *       element names.
 759                  *
 760                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 761                  */
 762                 typedef struct
 763                 {
 764                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 765                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 766                                                    *   given by the specific class.
 767                                                    */
 768
 769                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 770                                                       *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
 771                                                       */
 772
 773                         uint8_t  bmAttributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
 774
 775                         uint8_t  bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
 776                         uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
 777                 } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Spc_t;
 778
 779         /* Disable C linkage for C++ Compilers: */
 780                 #if defined(__cplusplus)
 781                         }
 782                 #endif
 783
 784 #endif
 785
 786 /** @} */
 787