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