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

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