Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Class / Common / Audio.h @ 978b99e5

History | View | Annotate | Download (44.7 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
  permission notice and warranty disclaimer appear in supporting
17
  documentation, and that the name of the author not be used in
18
  advertising or publicity pertaining to distribution of the
19
  software without specific, written prior permission.
20

21
  The author disclaim all warranties with regard to this
22
  software, including all implied warranties of merchantability
23
  and fitness.  In no event shall the author be liable for any
24
  special, indirect or consequential damages or any damages
25
  whatsoever resulting from loss of use, data or profits, whether
26
  in an action of contract, negligence or other tortious action,
27
  arising out of or in connection with the use or performance of
28
  this software.
29
*/
30

    
31
/** \file
32
 *  \brief Common definitions and declarations for the library USB Audio 1.0 Class driver.
33
 *
34
 *  Common definitions and declarations for the library USB Audio 1.0 Class driver.
35
 *
36
 *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
37
 *        dispatch header located in LUFA/Drivers/USB.h.
38
 */
39

    
40
/** \ingroup Group_USBClassAudio
41
 *  \defgroup Group_USBClassAudioCommon  Common Class Definitions
42
 *
43
 *  \section Sec_ModDescription Module Description
44
 *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
45
 *  Audio 1.0 Class.
46
 *
47
 *  @{
48
 */
49

    
50
#ifndef _AUDIO_CLASS_COMMON_H_
51
#define _AUDIO_CLASS_COMMON_H_
52

    
53
        /* Includes: */
54
                #include "../../Core/StdDescriptors.h"
55

    
56
        /* Enable C linkage for C++ Compilers: */
57
                #if defined(__cplusplus)
58
                        extern "C" {
59
                #endif
60

    
61
        /* Preprocessor Checks: */
62
                #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
63
                        #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
64
                #endif
65

    
66
        /* Macros: */
67
                /** \name Audio Channel Masks */
68
                //@{
69
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
70
                #define AUDIO_CHANNEL_LEFT_FRONT           (1 << 0)
71

    
72
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
73
                #define AUDIO_CHANNEL_RIGHT_FRONT          (1 << 1)
74

    
75
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
76
                #define AUDIO_CHANNEL_CENTER_FRONT         (1 << 2)
77

    
78
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
79
                #define AUDIO_CHANNEL_LOW_FREQ_ENHANCE     (1 << 3)
80

    
81
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
82
                #define AUDIO_CHANNEL_LEFT_SURROUND        (1 << 4)
83

    
84
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
85
                #define AUDIO_CHANNEL_RIGHT_SURROUND       (1 << 5)
86

    
87
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
88
                #define AUDIO_CHANNEL_LEFT_OF_CENTER       (1 << 6)
89

    
90
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
91
                #define AUDIO_CHANNEL_RIGHT_OF_CENTER      (1 << 7)
92

    
93
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
94
                #define AUDIO_CHANNEL_SURROUND             (1 << 8)
95

    
96
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
97
                #define AUDIO_CHANNEL_SIDE_LEFT            (1 << 9)
98

    
99
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
100
                #define AUDIO_CHANNEL_SIDE_RIGHT           (1 << 10)
101

    
102
                /** Supported channel mask for an Audio class terminal descriptor. See the Audio class specification for more details. */
103
                #define AUDIO_CHANNEL_TOP                  (1 << 11)
104
                //@}
105

    
106
                /** \name Audio Feature Masks */
107
                //@{
108
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
109
                #define AUDIO_FEATURE_MUTE                 (1 << 0)
110

    
111
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
112
                #define AUDIO_FEATURE_VOLUME               (1 << 1)
113

    
114
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
115
                #define AUDIO_FEATURE_BASS                 (1 << 2)
116

    
117
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
118
                #define AUDIO_FEATURE_MID                  (1 << 3)
119

    
120
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
121
                #define AUDIO_FEATURE_TREBLE               (1 << 4)
122

    
123
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
124
                #define AUDIO_FEATURE_GRAPHIC_EQUALIZER    (1 << 5)
125

    
126
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
127
                #define AUDIO_FEATURE_AUTOMATIC_GAIN       (1 << 6)
128

    
129
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
130
                #define AUDIO_FEATURE_DELAY                (1 << 7)
131

    
132
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
133
                #define AUDIO_FEATURE_BASS_BOOST           (1 << 8)
134

    
135
                /** Supported feature mask for an Audio class feature unit descriptor. See the Audio class specification for more details. */
136
                #define AUDIO_FEATURE_BASS_LOUDNESS        (1 << 9)
137
                //@}
138

    
139
                /** \name Audio Terminal Types */
140
                //@{
141
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
142
                #define AUDIO_TERMINAL_UNDEFINED           0x0100
143

    
144
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
145
                #define AUDIO_TERMINAL_STREAMING           0x0101
146

    
147
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
148
                #define AUDIO_TERMINAL_VENDOR              0x01FF
149

    
150
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
151
                #define AUDIO_TERMINAL_IN_UNDEFINED        0x0200
152

    
153
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
154
                #define AUDIO_TERMINAL_IN_MIC              0x0201
155

    
156
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
157
                #define AUDIO_TERMINAL_IN_DESKTOP_MIC      0x0202
158

    
159
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
160
                #define AUDIO_TERMINAL_IN_PERSONAL_MIC     0x0203
161

    
162
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
163
                #define AUDIO_TERMINAL_IN_OMNIDIR_MIC      0x0204
164

    
165
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
166
                #define AUDIO_TERMINAL_IN_MIC_ARRAY        0x0205
167

    
168
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
169
                #define AUDIO_TERMINAL_IN_PROCESSING_MIC   0x0206
170

    
171
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
172
                #define AUDIO_TERMINAL_IN_OUT_UNDEFINED    0x0300
173

    
174
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
175
                #define AUDIO_TERMINAL_OUT_SPEAKER         0x0301
176

    
177
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
178
                #define AUDIO_TERMINAL_OUT_HEADPHONES      0x0302
179

    
180
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
181
                #define AUDIO_TERMINAL_OUT_HEAD_MOUNTED    0x0303
182

    
183
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
184
                #define AUDIO_TERMINAL_OUT_DESKTOP         0x0304
185

    
186
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
187
                #define AUDIO_TERMINAL_OUT_ROOM            0x0305
188

    
189
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
190
                #define AUDIO_TERMINAL_OUT_COMMUNICATION   0x0306
191

    
192
                /** Terminal type constant for an Audio class terminal descriptor. See the Audio class specification for more details. */
193
                #define AUDIO_TERMINAL_OUT_LOWFREQ         0x0307
194
                //@}
195

    
196
                /** Convenience macro to fill a 24-bit \ref USB_Audio_SampleFreq_t structure with the given sample rate as a 24-bit number.
197
                 *
198
                 *  \param[in] freq  Required audio sampling frequency in HZ
199
                 */
200
                #define AUDIO_SAMPLE_FREQ(freq)           {.Byte1 = ((uint32_t)freq & 0xFF), .Byte2 = (((uint32_t)freq >> 8) & 0xFF), .Byte3 = (((uint32_t)freq >> 16) & 0xFF)}
201

    
202
                /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
203
                 *  accepts only filled endpoint packets of audio samples.
204
                 */
205
                #define AUDIO_EP_FULL_PACKETS_ONLY        (1 << 7)
206

    
207
                /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
208
                 *  will accept partially filled endpoint packets of audio samples.
209
                 */
210
                #define AUDIO_EP_ACCEPTS_SMALL_PACKETS    (0 << 7)
211

    
212
                /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
213
                 *  allows for sampling frequency adjustments to be made via control requests directed at the endpoint.
214
                 */
215
                #define AUDIO_EP_SAMPLE_FREQ_CONTROL      (1 << 0)
216

    
217
                /** Mask for the attributes parameter of an Audio class-specific Endpoint descriptor, indicating that the endpoint
218
                 *  allows for pitch adjustments to be made via control requests directed at the endpoint.
219
                 */
220
                #define AUDIO_EP_PITCH_CONTROL            (1 << 1)
221
                
222
        /* Enums: */
223
                /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio
224
                 *  device class.
225
                 */
226
                enum Audio_Descriptor_ClassSubclassProtocol_t
227
                {
228
                        AUDIO_CSCP_AudioClass                     = 0x01, /**< Descriptor Class value indicating that the device or
229
                                                                           *   interface belongs to the USB Audio 1.0 class.
230
                                                                           */
231
                        AUDIO_CSCP_ControlSubclass                = 0x01, /**< Descriptor Subclass value indicating that the device or
232
                                                                           *   interface belongs to the Audio Control subclass.
233
                                                                           */
234
                        AUDIO_CSCP_ControlProtocol                = 0x00, /**< Descriptor Protocol value indicating that the device or
235
                                                                           *   interface belongs to the Audio Control protocol.
236
                                                                           */
237
                        AUDIO_CSCP_AudioStreamingSubclass         = 0x02, /**< Descriptor Subclass value indicating that the device or
238
                                                                           *   interface belongs to the MIDI Streaming subclass.
239
                                                                           */
240
                        AUDIO_CSCP_MIDIStreamingSubclass          = 0x03, /**< Descriptor Subclass value indicating that the device or
241
                                                                           *   interface belongs to the Audio streaming subclass.
242
                                                                           */
243
                        AUDIO_CSCP_StreamingProtocol              = 0x00, /**< Descriptor Protocol value indicating that the device or
244
                                                                           *   interface belongs to the Streaming Audio protocol.
245
                                                                           */
246
                };
247
        
248
                /** Audio class specific interface description subtypes, for the Audio Control interface. */
249
                enum Audio_CSInterface_AC_SubTypes_t
250
                {
251
                        AUDIO_DSUBTYPE_CSInterface_Header         = 0x01, /**< Audio class specific control interface header. */
252
                        AUDIO_DSUBTYPE_CSInterface_InputTerminal  = 0x02, /**< Audio class specific control interface Input Terminal. */
253
                        AUDIO_DSUBTYPE_CSInterface_OutputTerminal = 0x03, /**< Audio class specific control interface Output Terminal. */
254
                        AUDIO_DSUBTYPE_CSInterface_Mixer          = 0x04, /**< Audio class specific control interface Mixer Unit. */
255
                        AUDIO_DSUBTYPE_CSInterface_Selector       = 0x05, /**< Audio class specific control interface Selector Unit. */
256
                        AUDIO_DSUBTYPE_CSInterface_Feature        = 0x06, /**< Audio class specific control interface Feature Unit. */
257
                        AUDIO_DSUBTYPE_CSInterface_Processing     = 0x07, /**< Audio class specific control interface Processing Unit. */
258
                        AUDIO_DSUBTYPE_CSInterface_Extension      = 0x08, /**< Audio class specific control interface Extension Unit. */
259
                };
260

    
261
                /** Audio class specific interface description subtypes, for the Audio Streaming interface. */
262
                enum Audio_CSInterface_AS_SubTypes_t
263
                {
264
                        AUDIO_DSUBTYPE_CSInterface_General        = 0x01, /**< Audio class specific streaming interface general descriptor. */
265
                        AUDIO_DSUBTYPE_CSInterface_FormatType     = 0x02, /**< Audio class specific streaming interface format type descriptor. */
266
                        AUDIO_DSUBTYPE_CSInterface_FormatSpecific = 0x03, /**< Audio class specific streaming interface format information descriptor. */
267
                };
268

    
269
                /** Audio class specific endpoint description subtypes, for the Audio Streaming interface. */
270
                enum Audio_CSEndpoint_SubTypes_t
271
                {
272
                        AUDIO_DSUBTYPE_CSEndpoint_General         = 0x01, /**< Audio class specific endpoint general descriptor. */
273
                };
274

    
275
                /** Enum for the Audio class specific control requests that can be issued by the USB bus host. */
276
                enum Audio_ClassRequests_t
277
                {
278
                        AUDIO_REQ_SetCurrent    = 0x01, /**< Audio class-specific request to set the current value of a parameter within the device. */
279
                        AUDIO_REQ_SetMinimum    = 0x02, /**< Audio class-specific request to set the minimum value of a parameter within the device. */
280
                        AUDIO_REQ_SetMaximum    = 0x03, /**< Audio class-specific request to set the maximum value of a parameter within the device. */
281
                        AUDIO_REQ_SetResolution = 0x04, /**< Audio class-specific request to set the resolution value of a parameter within the device. */
282
                        AUDIO_REQ_SetMemory     = 0x05, /**< Audio class-specific request to set the memory value of a parameter within the device. */
283
                        AUDIO_REQ_GetCurrent    = 0x81, /**< Audio class-specific request to get the current value of a parameter within the device. */
284
                        AUDIO_REQ_GetMinimum    = 0x82, /**< Audio class-specific request to get the minimum value of a parameter within the device. */
285
                        AUDIO_REQ_GetMaximum    = 0x83, /**< Audio class-specific request to get the maximum value of a parameter within the device. */
286
                        AUDIO_REQ_GetResolution = 0x84, /**< Audio class-specific request to get the resolution value of a parameter within the device. */
287
                        AUDIO_REQ_GetMemory     = 0x85, /**< Audio class-specific request to get the memory value of a parameter within the device. */
288
                        AUDIO_REQ_GetStatus     = 0xFF, /**< Audio class-specific request to get the device status. */
289
                };
290
                
291
                /** Enum for Audio class specific Endpoint control modifiers which can be set and retrieved by a USB host, if the corresponding
292
                 *  endpoint control is indicated to be supported in the Endpoint's Audio-class specific endpoint descriptor.
293
                 */
294
                enum Audio_EndpointControls_t
295
                {
296
                        AUDIO_EPCONTROL_SamplingFreq = 0x01, /**< Sampling frequency adjustment of the endpoint. */
297
                        AUDIO_EPCONTROL_Pitch        = 0x02, /**< Pitch adjustment of the endpoint. */
298
                };
299

    
300
        /* Type Defines: */
301
                /** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
302
                 *
303
                 *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
304
                 *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
305
                 *  a USB endpoint). See the USB Audio specification for more details.
306
                 *
307
                 *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
308
                 *
309
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
310
                 */
311
                typedef struct
312
                {
313
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
314
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
315
                                                          *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
316
                                                          */
317

    
318
                        uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
319
                        uint16_t                TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
320
                        uint8_t                 AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
321
                                                                           *   such as the speaker and microphone of a phone handset.
322
                                                                           */
323
                        uint8_t                 TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
324
                        uint16_t                ChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
325

    
326
                        uint8_t                 ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
327
                        uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
328
                } ATTR_PACKED USB_Audio_Descriptor_InputTerminal_t;
329

    
330
                /** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions).
331
                 *
332
                 *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
333
                 *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
334
                 *  a USB endpoint). See the USB Audio specification for more details.
335
                 *
336
                 *  \see \ref USB_Audio_Descriptor_InputTerminal_t for the version of this type with non-standard LUFA specific
337
                 *       element names.
338
                 *
339
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
340
                 */
341
                typedef struct
342
                {
343
                        uint8_t  bLength; /**< Size of the descriptor, in bytes. */
344
                        uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
345
                                                   *   given by the specific class.
346
                                                   */
347

    
348
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
349
                                                      *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
350
                                                      */
351
                        uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
352
                        uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
353
                        uint8_t  bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals
354
                                                  *   such as the speaker and microphone of a phone handset.
355
                                                  */
356
                        uint8_t  bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
357
                        uint16_t wChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
358

    
359
                        uint8_t  iChannelNames; /**< Index of a string descriptor describing this channel within the device. */
360
                        uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
361
                } ATTR_PACKED USB_Audio_StdDescriptor_InputTerminal_t;
362

    
363
                /** \brief Audio class-specific Output Terminal Descriptor (LUFA naming conventions).
364
                 *
365
                 *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
366
                 *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
367
                 *  a USB endpoint). See the USB Audio specification for more details.
368
                 *
369
                 *  \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
370
                 *
371
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
372
                 */
373
                typedef struct
374
                {
375
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
376
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
377
                                                          *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
378
                                                          */
379

    
380
                        uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
381
                        uint16_t                TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
382
                        uint8_t                 AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
383
                                                                            *   such as the speaker and microphone of a phone handset.
384
                                                                            */
385
                        uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
386

    
387
                        uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
388
                } ATTR_PACKED USB_Audio_Descriptor_OutputTerminal_t;
389

    
390
                /** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions).
391
                 *
392
                 *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
393
                 *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
394
                 *  a USB endpoint). See the USB Audio specification for more details.
395
                 *
396
                 *  \see \ref USB_Audio_Descriptor_OutputTerminal_t for the version of this type with non-standard LUFA specific
397
                 *       element names.
398
                 *
399
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
400
                 */
401
                typedef struct
402
                {
403
                        uint8_t  bLength; /**< Size of the descriptor, in bytes. */
404
                        uint8_t  bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
405
                                                   *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
406
                                                   */
407

    
408
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
409
                                                      *   a value from the \ref Audio_CSInterface_AC_SubTypes_t enum.
410
                                                      */
411
                        uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
412
                        uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
413
                        uint8_t  bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals
414
                                                  *   such as the speaker and microphone of a phone handset.
415
                                                  */
416
                        uint8_t  bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */
417

    
418
                        uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
419
                } ATTR_PACKED USB_Audio_StdDescriptor_OutputTerminal_t;
420

    
421
                /** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
422
                 *
423
                 *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
424
                 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
425
                 *  details.
426
                 *
427
                 *  \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
428
                 *
429
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
430
                 */
431
                typedef struct
432
                {
433
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
434
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
435
                                                          *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
436
                                                          */
437

    
438
                        uint16_t                ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
439
                        uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
440

    
441
                        uint8_t                 InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
442
                        uint8_t                 InterfaceNumber; /**< Interface number of the associated Audio Streaming interface. */
443
                } ATTR_PACKED USB_Audio_Descriptor_Interface_AC_t;
444

    
445
                /** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions).
446
                 *
447
                 *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
448
                 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
449
                 *  details.
450
                 *
451
                 *  \see \ref USB_Audio_Descriptor_Interface_AC_t for the version of this type with non-standard LUFA specific
452
                 *       element names.
453
                 *
454
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
455
                 */
456
                typedef struct
457
                {
458
                        uint8_t  bLength; /**< Size of the descriptor, in bytes. */
459
                        uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
460
                                                   *   given by the specific class.
461
                                                   */
462

    
463
                        uint8_t  bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
464
                                                     *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
465
                                                     */
466

    
467
                        uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
468
                        uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
469

    
470
                        uint8_t  bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
471
                        uint8_t  bInterfaceNumbers; /**< Interface number of the associated Audio Streaming interface. */
472
                } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AC_t;
473

    
474
                /** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
475
                 *
476
                 *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
477
                 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
478
                 *  specification for more details.
479
                 *
480
                 *  \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
481
                 *
482
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
483
                 */
484
                typedef struct
485
                {
486
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
487
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
488
                                                          *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
489
                                                          */
490

    
491
                        uint8_t                 UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
492
                        uint8_t                 SourceID; /**< Source ID value of the audio source input into this feature unit. */
493

    
494
                        uint8_t                 ControlSize; /**< Size of each element in the \c ChannelControls array. */
495
                        uint8_t                 ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
496

    
497
                        uint8_t                 FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
498
                } ATTR_PACKED USB_Audio_Descriptor_FeatureUnit_t;
499

    
500
                /** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions).
501
                 *
502
                 *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
503
                 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
504
                 *  specification for more details.
505
                 *
506
                 *  \see \ref USB_Audio_Descriptor_FeatureUnit_t for the version of this type with non-standard LUFA specific
507
                 *       element names.
508
                 *
509
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
510
                 */
511
                typedef struct
512
                {
513
                        uint8_t bLength; /**< Size of the descriptor, in bytes. */
514
                        uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
515
                                                  *   given by the specific class.
516
                                                  */
517

    
518
                        uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
519
                                                     *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
520
                                                     */
521

    
522
                        uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
523
                        uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
524

    
525
                        uint8_t bControlSize; /**< Size of each element in the \c ChannelControls array. */
526
                        uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
527

    
528
                        uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
529
                } ATTR_PACKED USB_Audio_StdDescriptor_FeatureUnit_t;
530

    
531
                /** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
532
                 *
533
                 *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
534
                 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
535
                 *
536
                 *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
537
                 *
538
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
539
                 */
540
                typedef struct
541
                {
542
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
543
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
544
                                                          *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
545
                                                          */
546

    
547
                        uint8_t                 TerminalLink; /**< ID value of the output terminal this descriptor is describing. */
548

    
549
                        uint8_t                 FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
550
                        uint16_t                AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
551
                } ATTR_PACKED USB_Audio_Descriptor_Interface_AS_t;
552

    
553
                /** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions).
554
                 *
555
                 *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
556
                 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
557
                 *
558
                 *  \see \ref USB_Audio_Descriptor_Interface_AS_t for the version of this type with non-standard LUFA specific
559
                 *       element names.
560
                 *
561
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
562
                 */
563
                typedef struct
564
                {
565
                        uint8_t  bLength; /**< Size of the descriptor, in bytes. */
566
                        uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
567
                                                   *   given by the specific class.
568
                                                   */
569

    
570
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
571
                                                      *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
572
                                                      */
573

    
574
                        uint8_t  bTerminalLink; /**< ID value of the output terminal this descriptor is describing. */
575

    
576
                        uint8_t  bDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
577
                        uint16_t wFormatTag; /**< Format of the audio stream, see Audio Device Formats specification. */
578
                } ATTR_PACKED USB_Audio_StdDescriptor_Interface_AS_t;
579

    
580
                /** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
581
                 *
582
                 *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
583
                 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
584
                 *  in the device's audio streams. See the USB Audio specification for more details.
585
                 *
586
                 *  \note This descriptor <b>must</b> be followed by one or more \ref USB_Audio_SampleFreq_t elements containing
587
                 *        the continuous or discrete sample frequencies.
588
                 *
589
                 *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
590
                 *
591
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
592
                 */
593
                typedef struct
594
                {
595
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
596
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
597
                                                          *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
598
                                                          */
599

    
600
                        uint8_t                 FormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
601
                        uint8_t                 Channels; /**< Total number of discrete channels in the stream. */
602

    
603
                        uint8_t                 SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
604
                        uint8_t                 BitResolution; /**< Bits of resolution of each channel's samples in the stream. */
605

    
606
                        uint8_t                 TotalDiscreteSampleRates; /**< Total number of discrete sample frequencies supported by the device. When
607
                                                                           *   zero, this must be followed by the lower and upper continuous sampling
608
                                                                           *   frequencies supported by the device; otherwise, this must be followed
609
                                                                           *   by the given number of discrete sampling frequencies supported.
610
                                                                           */
611
                } ATTR_PACKED USB_Audio_Descriptor_Format_t;
612

    
613
                /** \brief 24-Bit Audio Frequency Structure.
614
                 *
615
                 *  Type define for a 24bit audio sample frequency structure. As GCC does not contain a built in 24-bit datatype,
616
                 *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
617
                 *
618
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
619
                 */
620
                typedef struct
621
                {
622
                        uint8_t Byte1; /**< Lowest 8 bits of the 24-bit value. */
623
                        uint8_t Byte2; /**< Middle 8 bits of the 24-bit value. */
624
                        uint8_t Byte3; /**< Upper 8 bits of the 24-bit value. */
625
                } ATTR_PACKED USB_Audio_SampleFreq_t;
626

    
627
                /** \brief Audio class-specific Format Descriptor (USB-IF naming conventions).
628
                 *
629
                 *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
630
                 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
631
                 *  in the device's audio streams. See the USB Audio specification for more details.
632
                 *
633
                 *  \note This descriptor <b>must</b> be followed by one or more 24-bit integer elements containing the continuous
634
                 *        or discrete sample frequencies.
635
                 *
636
                 *  \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
637
                 *       element names.
638
                 *
639
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
640
                 */
641
                typedef struct
642
                {
643
                        uint8_t bLength; /**< Size of the descriptor, in bytes. */
644
                        uint8_t bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
645
                                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
646
                                                  */
647

    
648
                        uint8_t bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
649
                                                    *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
650
                                                    */
651

    
652
                        uint8_t bFormatType; /**< Format of the audio stream, see Audio Device Formats specification. */
653
                        uint8_t bNrChannels; /**< Total number of discrete channels in the stream. */
654

    
655
                        uint8_t bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
656
                        uint8_t bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */
657

    
658
                        uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. When
659
                                                       *   zero, this must be followed by the lower and upper continuous sampling
660
                                                       *   frequencies supported by the device; otherwise, this must be followed
661
                                                       *   by the given number of discrete sampling frequencies supported.
662
                                                       */
663
                } ATTR_PACKED USB_Audio_StdDescriptor_Format_t;
664

    
665
                /** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
666
                 *
667
                 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
668
                 *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
669
                 *
670
                 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
671
                 *
672
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
673
                 */
674
                typedef struct
675
                {
676
                        USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
677

    
678
                        uint8_t                   Refresh; /**< Always set to zero for Audio class devices. */
679
                        uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
680
                } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Std_t;
681

    
682
                /** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
683
                 *
684
                 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
685
                 *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
686
                 *
687
                 *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Std_t for the version of this type with non-standard LUFA specific
688
                 *       element names.
689
                 *
690
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
691
                 */
692
                typedef struct
693
                {
694
                        uint8_t  bLength; /**< Size of the descriptor, in bytes. */
695
                        uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
696
                                                   *   value given by the specific class.
697
                                                   */
698
                        uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
699
                                                    *   configuration, including direction mask.
700
                                                    */
701
                        uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (\c EP_TYPE_*)
702
                                                *   and attributes (\c ENDPOINT_ATTR_*) masks.
703
                                                */
704
                        uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
705
                                                  *   that the endpoint can receive at a time.
706
                                                  */
707
                        uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
708
                                             *   ISOCHRONOUS type.
709
                                             */
710

    
711
                        uint8_t  bRefresh; /**< Always set to zero for Audio class devices. */
712
                        uint8_t  bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
713
                } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Std_t;
714

    
715
                /** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
716
                 *
717
                 *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
718
                 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
719
                 *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
720
                 *
721
                 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
722
                 *
723
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
724
                 */
725
                typedef struct
726
                {
727
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
728
                        uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
729
                                                          *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
730
                                                          */
731

    
732
                        uint8_t                 Attributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
733

    
734
                        uint8_t                 LockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
735
                        uint16_t                LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
736
                } ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Spc_t;
737

    
738
                /** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions).
739
                 *
740
                 *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
741
                 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
742
                 *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
743
                 *
744
                 *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Spc_t for the version of this type with non-standard LUFA specific
745
                 *       element names.
746
                 *
747
                 *  \note Regardless of CPU architecture, these values should be stored as little endian.
748
                 */
749
                typedef struct
750
                {
751
                        uint8_t  bLength; /**< Size of the descriptor, in bytes. */
752
                        uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
753
                                                   *   given by the specific class.
754
                                                   */
755

    
756
                        uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
757
                                                      *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
758
                                                      */
759

    
760
                        uint8_t  bmAttributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
761

    
762
                        uint8_t  bLockDelayUnits; /**< Units used for the LockDelay field, see Audio class specification. */
763
                        uint16_t wLockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry. */
764
                } ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Spc_t;
765

    
766
        /* Disable C linkage for C++ Compilers: */
767
                #if defined(__cplusplus)
768
                        }
769
                #endif
770

    
771
#endif
772

    
773
/** @} */
774