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                 /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio
 214                  *  device class.
 215                  */
 216                 enum Audio_Descriptor_ClassSubclassProtocol_t
 217                 {
 218                         AUDIO_CSCP_AudioClass                     = 0x01, /**< Descriptor Class value indicating that the device or
 219                                                                            *   interface belongs to the USB Audio 1.0 class.
 220                                                                            */
 221                         AUDIO_CSCP_ControlSubclass                = 0x01, /**< Descriptor Subclass value indicating that the device or
 222                                                                            *   interface belongs to the Audio Control subclass.
 223                                                                            */
 224                         AUDIO_CSCP_ControlProtocol                = 0x00, /**< Descriptor Protocol value indicating that the device or
 225                                                                            *   interface belongs to the Audio Control protocol.
 226                                                                            */
 227                         AUDIO_CSCP_AudioStreamingSubclass         = 0x02, /**< Descriptor Subclass value indicating that the device or
 228                                                                            *   interface belongs to the MIDI Streaming subclass.
 229                                                                            */
 230                         AUDIO_CSCP_MIDIStreamingSubclass          = 0x03, /**< Descriptor Subclass value indicating that the device or
 231                                                                            *   interface belongs to the Audio streaming subclass.
 232                                                                            */
 233                         AUDIO_CSCP_StreamingProtocol              = 0x00, /**< Descriptor Protocol value indicating that the device or
 234                                                                            *   interface belongs to the Streaming Audio protocol.
 235                                                                            */
 236                 };
 237
 238                 /** Audio class specific interface description subtypes, for the Audio Control interface. */
 239                 enum Audio_CSInterface_AC_SubTypes_t
 240                 {
 241                         AUDIO_DSUBTYPE_CSInterface_Header         = 0x01, /**< Audio class specific control interface header. */
 242                         AUDIO_DSUBTYPE_CSInterface_InputTerminal  = 0x02, /**< Audio class specific control interface Input Terminal. */
 243                         AUDIO_DSUBTYPE_CSInterface_OutputTerminal = 0x03, /**< Audio class specific control interface Output Terminal. */
 244                         AUDIO_DSUBTYPE_CSInterface_Mixer          = 0x04, /**< Audio class specific control interface Mixer Unit. */
 245                         AUDIO_DSUBTYPE_CSInterface_Selector       = 0x05, /**< Audio class specific control interface Selector Unit. */
 246                         AUDIO_DSUBTYPE_CSInterface_Feature        = 0x06, /**< Audio class specific control interface Feature Unit. */
 247                         AUDIO_DSUBTYPE_CSInterface_Processing     = 0x07, /**< Audio class specific control interface Processing Unit. */
 248                         AUDIO_DSUBTYPE_CSInterface_Extension      = 0x08, /**< Audio class specific control interface Extension Unit. */
 249                 };
 250
 251                 /** Audio class specific interface description subtypes, for the Audio Streaming interface. */
 252                 enum Audio_CSInterface_AS_SubTypes_t
 253                 {
 254                         AUDIO_DSUBTYPE_CSInterface_General        = 0x01, /**< Audio class specific streaming interface general descriptor. */
 255                         AUDIO_DSUBTYPE_CSInterface_FormatType     = 0x02, /**< Audio class specific streaming interface format type descriptor. */
 256                         AUDIO_DSUBTYPE_CSInterface_FormatSpecific = 0x03, /**< Audio class specific streaming interface format information descriptor. */
 257                 };
 258
 259                 /** Audio class specific endpoint description subtypes, for the Audio Streaming interface. */
 260                 enum Audio_CSEndpoint_SubTypes_t
 261                 {
 262                         AUDIO_DSUBTYPE_CSEndpoint_General         = 0x01, /**< Audio class specific endpoint general descriptor. */
 263                 };
 264
 265         /* Type Defines: */
 266                 /** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
 267                  *
 268                  *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
 269                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 270                  *  a USB endpoint). See the USB Audio specification for more details.
 271                  *
 272                  *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
 273                  */
 274                 typedef struct
 275                 {
 276                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 277                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 278                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
 279                                                           */
 280
 281                         uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 282                         uint16_t                TerminalType; /**< Type of terminal, a TERMINAL_* mask. */
 283                         uint8_t                 AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
 284                                                                            *   such as the speaker and microphone of a phone handset.
 285                                                                            */
 286                         uint8_t                 TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 287                         uint16_t                ChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */
 288
 289                         uint8_t                 ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
 290                         uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 291                 } USB_Audio_Descriptor_InputTerminal_t;
 292
 293                 /** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions).
 294                  *
 295                  *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
 296                  *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
 297                  *  a USB endpoint). See the USB Audio specification for more details.
 298                  *
 299                  *  \see \ref USB_Audio_Descriptor_InputTerminal_t for the version of this type with non-standard LUFA specific
 300                  *       element names.
 301                  */
 302                 typedef struct
 303                 {
 304                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 305                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 306                                                    *   given by the specific class.
 307                                                    */
 308
 309                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 310                                                       *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
 311                                                       */
 312                         uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 313                         uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */
 314                         uint8_t  bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals
 315                                                   *   such as the speaker and microphone of a phone handset.
 316                                                   */
 317                         uint8_t  bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
 318                         uint16_t wChannelConfig; /**< CHANNEL_* masks indicating what channel layout is supported by this terminal. */
 319
 320                         uint8_t  iChannelNames; /**< Index of a string descriptor describing this channel within the device. */
 321                         uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
 322                 } USB_Audio_StdDescriptor_InputTerminal_t;
 323
 324                 /** \brief Audio class-specific Output Terminal Descriptor (LUFA 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_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
 331                  */
 332                 typedef struct
 333                 {
 334                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 335                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 336                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
 337                                                           */
 338
 339                         uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 340                         uint16_t                TerminalType; /**< Type of terminal, a TERMINAL_* mask. */
 341                         uint8_t                 AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
 342                                                                             *   such as the speaker and microphone of a phone handset.
 343                                                                             */
 344                         uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
 345
 346                         uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 347                 } USB_Audio_Descriptor_OutputTerminal_t;
 348
 349                 /** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions).
 350                  *
 351                  *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
 352                  *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
 353                  *  a USB endpoint). See the USB Audio specification for more details.
 354                  *
 355                  *  \see \ref USB_Audio_Descriptor_OutputTerminal_t for the version of this type with non-standard LUFA specific
 356                  *       element names.
 357                  */
 358                 typedef struct
 359                 {
 360                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 361                         uint8_t  bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
 362                                                    *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
 363                                                    */
 364
 365                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 366                                                       *   a value from the \ref Audio_CSInterface_AC_SubTypes_t enum.
 367                                                       */
 368                         uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
 369                         uint16_t wTerminalType; /**< Type of terminal, a TERMINAL_* mask. */
 370                         uint8_t  bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals
 371                                                   *   such as the speaker and microphone of a phone handset.
 372                                                   */
 373                         uint8_t  bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */
 374
 375                         uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
 376                 } USB_Audio_StdDescriptor_OutputTerminal_t;
 377
 378                 /** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
 379                  *
 380                  *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
 381                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 382                  *  details.
 383                  *
 384                  *  \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
 385                  */
 386                 typedef struct
 387                 {
 388                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 389                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 390                                                           *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 391                                                           */
 392
 393                         uint16_t                ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
 394                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 395
 396                         uint8_t                 InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
 397                         uint8_t                 InterfaceNumber; /**< Interface number of the associated Audio Streaming interface. */
 398                 } USB_Audio_Descriptor_Interface_AC_t;
 399
 400                 /** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions).
 401                  *
 402                  *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
 403                  *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
 404                  *  details.
 405                  *
 406                  *  \see \ref USB_Audio_Descriptor_Interface_AC_t for the version of this type with non-standard LUFA specific
 407                  *       element names.
 408                  */
 409                 typedef struct
 410                 {
 411                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 412                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 413                                                    *   given by the specific class.
 414                                                    */
 415
 416                         uint8_t  bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
 417                                                      *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 418                                                      */
 419
 420                         uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
 421                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 422
 423                         uint8_t  bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
 424                         uint8_t  bInterfaceNumbers; /**< Interface number of the associated Audio Streaming interface. */
 425                 } USB_Audio_StdDescriptor_Interface_AC_t;
 426
 427                 /** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
 428                  *
 429                  *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
 430                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 431                  *  specification for more details.
 432                  *
 433                  *  \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
 434                  */
 435                 typedef struct
 436                 {
 437                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 438                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 439                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
 440                                                           */
 441
 442                         uint8_t                 UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
 443                         uint8_t                 SourceID; /**< Source ID value of the audio source input into this feature unit. */
 444
 445                         uint8_t                 ControlSize; /**< Size of each element in the ChanelControlls array. */
 446                         uint8_t                 ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
 447
 448                         uint8_t                 FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 449                 } USB_Audio_Descriptor_FeatureUnit_t;
 450
 451                 /** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions).
 452                  *
 453                  *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
 454                  *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
 455                  *  specification for more details.
 456                  *
 457                  *  \see \ref USB_Audio_Descriptor_FeatureUnit_t for the version of this type with non-standard LUFA specific
 458                  *       element names.
 459                  */
 460                 typedef struct
 461                 {
 462                         uint8_t bLength; /**< Size of the descriptor, in bytes. */
 463                         uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 464                                                   *   given by the specific class.
 465                                                   */
 466
 467                         uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 468                                                      *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
 469                                                      */
 470
 471                         uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
 472                         uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
 473
 474                         uint8_t bControlSize; /**< Size of each element in the ChanelControlls array. */
 475                         uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
 476
 477                         uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
 478                 } USB_Audio_StdDescriptor_FeatureUnit_t;
 479
 480                 /** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
 481                  *
 482                  *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
 483                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 484                  *
 485                  *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
 486                  */
 487                 typedef struct
 488                 {
 489                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 490                         uint8_t                 Subtype; /**< 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                 TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
 495
 496                         uint8_t                 FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
 497                         uint16_t                AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
 498                 } USB_Audio_Descriptor_Interface_AS_t;
 499
 500                 /** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions).
 501                  *
 502                  *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
 503                  *  how audio streams within the device are formatted. See the USB Audio specification for more details.
 504                  *
 505                  *  \see \ref USB_Audio_Descriptor_Interface_AS_t for the version of this type with non-standard LUFA specific
 506                  *       element names.
 507                  */
 508                 typedef struct
 509                 {
 510                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 511                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 512                                                    *   given by the specific class.
 513                                                    */
 514
 515                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 516                                                       *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 517                                                       */
 518
 519                         uint8_t  bTerminalLink; /**< ID value of the output terminal this descriptor is describing. */
 520
 521                         uint8_t  bDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
 522                         uint16_t wFormatTag; /**< Format of the audio stream, see Audio Device Formats specification. */
 523                 } USB_Audio_StdDescriptor_Interface_AS_t;
 524
 525                 /** \brief 24-Bit Audio Frequency Structure.
 526                  *
 527                  *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
 528                  *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
 529                  */
 530                 typedef struct
 531                 {
 532                         uint16_t LowWord; /**< Low 16 bits of the 24-bit value. */
 533                         uint8_t  HighByte; /**< Upper 8 bits of the 24-bit value. */
 534                 } USB_Audio_SampleFreq_t;
 535
 536                 /** \brief Audio class-specific Format Descriptor (LUFA 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_StdDescriptor_Format_t for the version of this type with standard element names.
 543                  */
 544                 typedef struct
 545                 {
 546                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 547                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 548                                                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
 549                                                           */
 550
 551                         uint8_t                 FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
 552                         uint8_t                 Channels; /**< Total number of discrete channels in the stream. */
 553
 554                         uint8_t                 SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
 555                         uint8_t                 BitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 556
 557                         uint8_t                 SampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
 558                         USB_Audio_SampleFreq_t  SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES]; /**< Sample frequencies supported by the device (must be 24-bit). */
 559                 } USB_Audio_Descriptor_Format_t;
 560
 561                 /** \brief Audio class-specific Format Descriptor (USB-IF naming conventions).
 562                  *
 563                  *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
 564                  *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
 565                  *  in the device's audio streams. See the USB Audio specification for more details.
 566                  *
 567                  *  \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
 568                  *       element names.
 569                  */
 570                 typedef struct
 571                 {
 572                         uint8_t bLength; /**< Size of the descriptor, in bytes. */
 573                         uint8_t bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
 574                                                   *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
 575                                                   */
 576
 577                         uint8_t bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
 578                                                     *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
 579                                                     */
 580
 581                         uint8_t bFormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
 582                         uint8_t bNrChannels; /**< Total number of discrete channels in the stream. */
 583
 584                         uint8_t bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
 585                         uint8_t bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */
 586
 587                         uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. */
 588                         uint8_t SampleFrequencies[AUDIO_TOTAL_SAMPLE_RATES * 3]; /**< Sample frequencies supported by the device (must be 24-bit). */
 589                 } USB_Audio_StdDescriptor_Format_t;
 590
 591                 /** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
 592                  *
 593                  *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
 594                  *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
 595                  *
 596                  *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
 597                  */
 598                 typedef struct
 599                 {
 600                         USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
 601
 602                         uint8_t                   Refresh; /**< Always set to zero for Audio class devices. */
 603                         uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
 604                 } USB_Audio_Descriptor_StreamEndpoint_Std_t;
 605
 606                 /** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
 607                  *
 608                  *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
 609                  *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
 610                  *
 611                  *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Std_t for the version of this type with non-standard LUFA specific
 612                  *       element names.
 613                  */
 614                 typedef struct
 615                 {
 616                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 617                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
 618                                                    *   value given by the specific class.
 619                                                    */
 620                         uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
 621                                                     *   configuration, including direction mask.
 622                                                     */
 623                         uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (EP_TYPE_*)
 624                                                 *   and attributes (ENDPOINT_ATTR_*) masks.
 625                                                 */
 626                         uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
 627                                                   *   that the endpoint can receive at a time.
 628                                                   */
 629                         uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
 630                                              *   ISOCHRONOUS type.
 631                                              */
 632
 633                         uint8_t  bRefresh; /**< Always set to zero for Audio class devices. */
 634                         uint8_t  bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
 635                 } USB_Audio_StdDescriptor_StreamEndpoint_Std_t;
 636
 637                 /** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
 638                  *
 639                  *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
 640                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 641                  *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
 642                  *
 643                  *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
 644                  */
 645                 typedef struct
 646                 {
 647                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 648                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 649                                                           *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
 650                                                           */
 651
 652                         uint8_t                 Attributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */
 653
 654                         uint8_t                 LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
 655                         uint16_t                LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
 656                 } USB_Audio_Descriptor_StreamEndpoint_Spc_t;
 657
 658                 /** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions).
 659                  *
 660                  *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
 661                  *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
 662                  *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
 663                  *
 664                  *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Spc_t for the version of this type with non-standard LUFA specific
 665                  *       element names.
 666                  */
 667                 typedef struct
 668                 {
 669                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 670                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 671                                                    *   given by the specific class.
 672                                                    */
 673
 674                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
 675                                                       *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
 676                                                       */
 677
 678                         uint8_t  bmAttributes; /**< Audio class-specific endpoint attributes, such as ACCEPTS_SMALL_PACKETS. */
 679
 680                         uint8_t  bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
 681                         uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
 682                 } USB_Audio_StdDescriptor_StreamEndpoint_Spc_t;
 683
 684         /* Disable C linkage for C++ Compilers: */
 685                 #if defined(__cplusplus)
 686                         }
 687                 #endif
 688
 689 #endif
 690
 691 /** @} */
 692