Audio.h 41.4 KB
Newer Older
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
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
21
22
23
24
25
26
27
28
29
30
31
  software without specific, written prior permission.

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

/** \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
37
 *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
 *        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
51
52
53
 *
 *  @{
 */

#ifndef _AUDIO_CLASS_COMMON_H_
#define _AUDIO_CLASS_COMMON_H_

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

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

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

	/* Macros: */
67
68
		/** \name Audio Channel Masks */
		//@{
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
107
		/** \name Audio Feature Masks */
		//@{
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
140
		/** \name Audio Terminal Types */
		//@{
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
199
		 *
		 *  \param[in] freq  Required audio sampling frequency in HZ
		 */
200
		#define AUDIO_SAMPLE_FREQ(freq)           {.Byte1 = ((uint32_t)freq & 0x0000FF), .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
204
		 *  accepts only filled endpoint packets of audio samples.
		 */
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
209
		 *  will accept partially filled endpoint packets of audio samples.
		 */
210
		#define AUDIO_EP_ACCEPTS_SMALL_PACKETS    (0 << 7)
211
		
212
	/* Enums: */
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
		/** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio
		 *  device class.
		 */
		enum Audio_Descriptor_ClassSubclassProtocol_t
		{
			AUDIO_CSCP_AudioClass                     = 0x01, /**< Descriptor Class value indicating that the device or
			                                                   *   interface belongs to the USB Audio 1.0 class.
			                                                   */
			AUDIO_CSCP_ControlSubclass                = 0x01, /**< Descriptor Subclass value indicating that the device or
			                                                   *   interface belongs to the Audio Control subclass.
			                                                   */
			AUDIO_CSCP_ControlProtocol                = 0x00, /**< Descriptor Protocol value indicating that the device or
			                                                   *   interface belongs to the Audio Control protocol.
			                                                   */
			AUDIO_CSCP_AudioStreamingSubclass         = 0x02, /**< Descriptor Subclass value indicating that the device or
			                                                   *   interface belongs to the MIDI Streaming subclass.
			                                                   */
			AUDIO_CSCP_MIDIStreamingSubclass          = 0x03, /**< Descriptor Subclass value indicating that the device or
			                                                   *   interface belongs to the Audio streaming subclass.
			                                                   */
			AUDIO_CSCP_StreamingProtocol              = 0x00, /**< Descriptor Protocol value indicating that the device or
			                                                   *   interface belongs to the Streaming Audio protocol.
			                                                   */
		};
	
238
239
		/** Audio class specific interface description subtypes, for the Audio Control interface. */
		enum Audio_CSInterface_AC_SubTypes_t
240
		{
241
242
243
244
245
246
247
248
249
250
251
252
			AUDIO_DSUBTYPE_CSInterface_Header         = 0x01, /**< Audio class specific control interface header. */
			AUDIO_DSUBTYPE_CSInterface_InputTerminal  = 0x02, /**< Audio class specific control interface Input Terminal. */
			AUDIO_DSUBTYPE_CSInterface_OutputTerminal = 0x03, /**< Audio class specific control interface Output Terminal. */
			AUDIO_DSUBTYPE_CSInterface_Mixer          = 0x04, /**< Audio class specific control interface Mixer Unit. */
			AUDIO_DSUBTYPE_CSInterface_Selector       = 0x05, /**< Audio class specific control interface Selector Unit. */
			AUDIO_DSUBTYPE_CSInterface_Feature        = 0x06, /**< Audio class specific control interface Feature Unit. */
			AUDIO_DSUBTYPE_CSInterface_Processing     = 0x07, /**< Audio class specific control interface Processing Unit. */
			AUDIO_DSUBTYPE_CSInterface_Extension      = 0x08, /**< Audio class specific control interface Extension Unit. */
		};

		/** Audio class specific interface description subtypes, for the Audio Streaming interface. */
		enum Audio_CSInterface_AS_SubTypes_t
253
		{
254
255
256
257
			AUDIO_DSUBTYPE_CSInterface_General        = 0x01, /**< Audio class specific streaming interface general descriptor. */
			AUDIO_DSUBTYPE_CSInterface_FormatType     = 0x02, /**< Audio class specific streaming interface format type descriptor. */
			AUDIO_DSUBTYPE_CSInterface_FormatSpecific = 0x03, /**< Audio class specific streaming interface format information descriptor. */
		};
258

259
260
		/** Audio class specific endpoint description subtypes, for the Audio Streaming interface. */
		enum Audio_CSEndpoint_SubTypes_t
261
		{
262
263
			AUDIO_DSUBTYPE_CSEndpoint_General         = 0x01, /**< Audio class specific endpoint general descriptor. */
		};
264

265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
		/** Enum for the Audio class specific control requests that can be issued by the USB bus host. */
		enum Audio_ClassRequests_t
		{
			AUDIO_REQ_SetCurrent    = 0x01, /**< Audio class-specific request to set the current value of a parameter within the device. */
			AUDIO_REQ_SetMinimum    = 0x02, /**< Audio class-specific request to set the minimum value of a parameter within the device. */
			AUDIO_REQ_SetMaximum    = 0x03, /**< Audio class-specific request to set the maximum value of a parameter within the device. */
			AUDIO_REQ_SetResolution = 0x04, /**< Audio class-specific request to set the resolution value of a parameter within the device. */
			AUDIO_REQ_SetMemory     = 0x05, /**< Audio class-specific request to set the memory value of a parameter within the device. */
			AUDIO_REQ_GetCurrent    = 0x81, /**< Audio class-specific request to get the current value of a parameter within the device. */
			AUDIO_REQ_GetMinimum    = 0x82, /**< Audio class-specific request to get the minimum value of a parameter within the device. */
			AUDIO_REQ_GetMaximum    = 0x83, /**< Audio class-specific request to get the maximum value of a parameter within the device. */
			AUDIO_REQ_GetResolution = 0x84, /**< Audio class-specific request to get the resolution value of a parameter within the device. */
			AUDIO_REQ_GetMemory     = 0x85, /**< Audio class-specific request to get the memory value of a parameter within the device. */
			AUDIO_REQ_GetStatus     = 0xFF, /**< Audio class-specific request to get the device status. */
		};

281
	/* Type Defines: */
282
		/** \brief Audio class-specific Input Terminal Descriptor (LUFA naming conventions).
283
		 *
284
		 *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
285
286
		 *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
		 *  a USB endpoint). See the USB Audio specification for more details.
287
288
		 *
		 *  \see \ref USB_Audio_StdDescriptor_InputTerminal_t for the version of this type with standard element names.
289
290
291
		 */
		typedef struct
		{
292
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
293
294
295
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
			                                  */
296

297
			uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
298
			uint16_t                TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
299
			uint8_t                 AssociatedOutputTerminal; /**< ID of associated output terminal, for physically grouped terminals
Dean Camera's avatar
Dean Camera committed
300
301
			                                                   *   such as the speaker and microphone of a phone handset.
			                                                   */
302
			uint8_t                 TotalChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
303
			uint16_t                ChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
304

305
306
			uint8_t                 ChannelStrIndex; /**< Index of a string descriptor describing this channel within the device. */
			uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
307
		} ATTR_PACKED USB_Audio_Descriptor_InputTerminal_t;
308

309
310
311
312
313
314
315
316
317
318
319
320
321
		/** \brief Audio class-specific Input Terminal Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific input terminal descriptor. This indicates to the host that the device
		 *  contains an input audio source, either from a physical terminal on the device, or a logical terminal (for example,
		 *  a USB endpoint). See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_InputTerminal_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
Dean Camera's avatar
Dean Camera committed
322
323
			                           *   given by the specific class.
			                           */
324

325
326
327
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   must be \ref AUDIO_DSUBTYPE_CSInterface_InputTerminal.
			                              */
328
			uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
329
			uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
330
331
332
333
			uint8_t  bAssocTerminal; /**< ID of associated output terminal, for physically grouped terminals
			                          *   such as the speaker and microphone of a phone handset.
			                          */
			uint8_t  bNrChannels; /**< Total number of separate audio channels within this interface (right, left, etc.) */
334
			uint16_t wChannelConfig; /**< \c CHANNEL_* masks indicating what channel layout is supported by this terminal. */
335

336
337
			uint8_t  iChannelNames; /**< Index of a string descriptor describing this channel within the device. */
			uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
338
		} ATTR_PACKED USB_Audio_StdDescriptor_InputTerminal_t;
339
340

		/** \brief Audio class-specific Output Terminal Descriptor (LUFA naming conventions).
341
		 *
342
		 *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
343
344
		 *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
		 *  a USB endpoint). See the USB Audio specification for more details.
345
346
		 *
		 *  \see \ref USB_Audio_StdDescriptor_OutputTerminal_t for the version of this type with standard element names.
347
348
349
		 */
		typedef struct
		{
350
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
351
352
353
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
			                                  */
354

355
			uint8_t                 TerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
356
			uint16_t                TerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
357
			uint8_t                 AssociatedInputTerminal; /**< ID of associated input terminal, for physically grouped terminals
358
			                                                    *   such as the speaker and microphone of a phone handset.
359
			                                                    */
360
			uint8_t                 SourceID; /**< ID value of the unit this terminal's audio is sourced from. */
361

362
			uint8_t                 TerminalStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
363
		} ATTR_PACKED USB_Audio_Descriptor_OutputTerminal_t;
364
365
366
367
368
369
370
371
372
373
374
375
376

		/** \brief Audio class-specific Output Terminal Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific output terminal descriptor. This indicates to the host that the device
		 *  contains an output audio sink, either to a physical terminal on the device, or a logical terminal (for example,
		 *  a USB endpoint). See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_OutputTerminal_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
377
378
			uint8_t  bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                           *   must be \ref AUDIO_DSUBTYPE_CSInterface_OutputTerminal.
Dean Camera's avatar
Dean Camera committed
379
			                           */
380

381
382
383
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   a value from the \ref Audio_CSInterface_AC_SubTypes_t enum.
			                              */
384
			uint8_t  bTerminalID; /**< ID value of this terminal unit - must be a unique value within the device. */
385
			uint16_t wTerminalType; /**< Type of terminal, a \c TERMINAL_* mask. */
386
387
388
389
			uint8_t  bAssocTerminal; /**< ID of associated input terminal, for physically grouped terminals
			                          *   such as the speaker and microphone of a phone handset.
			                          */
			uint8_t  bSourceID; /**< ID value of the unit this terminal's audio is sourced from. */
390

391
			uint8_t  iTerminal; /**< Index of a string descriptor describing this descriptor within the device. */
392
		} ATTR_PACKED USB_Audio_StdDescriptor_OutputTerminal_t;
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410

		/** \brief Audio class-specific Interface Descriptor (LUFA naming conventions).
		 *
		 *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
		 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
		 *  details.
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Interface_AC_t for the version of this type with standard element names.
		 */
		typedef struct
		{
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                                  */

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

412
413
			uint8_t                 InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
			uint8_t                 InterfaceNumber; /**< Interface number of the associated Audio Streaming interface. */
414
		} ATTR_PACKED USB_Audio_Descriptor_Interface_AC_t;
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437

		/** \brief Audio class-specific Interface Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific interface descriptor. This follows a regular interface descriptor to
		 *  supply extra information about the audio device's layout to the host. See the USB Audio specification for more
		 *  details.
		 *
		 *  \see \ref USB_Audio_Descriptor_Interface_AC_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
			                           *   given by the specific class.
			                           */

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

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

439
440
			uint8_t  bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
			uint8_t  bInterfaceNumbers; /**< Interface number of the associated Audio Streaming interface. */
441
		} ATTR_PACKED USB_Audio_StdDescriptor_Interface_AC_t;
442

443
444
445
446
447
448
449
450
451
452
453
454
455
456
		/** \brief Audio class-specific Feature Unit Descriptor (LUFA naming conventions).
		 *
		 *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
		 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
		 *  specification for more details.
		 *
		 *  \see \ref USB_Audio_StdDescriptor_FeatureUnit_t for the version of this type with standard element names.
		 */
		typedef struct
		{
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_Feature.
			                                  */
457

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

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

464
			uint8_t                 FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
465
		} ATTR_PACKED USB_Audio_Descriptor_FeatureUnit_t;
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485

		/** \brief Audio class-specific Feature Unit Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific Feature Unit descriptor. This indicates to the host what features
		 *  are present in the device's audio stream for basic control, such as per-channel volume. See the USB Audio
		 *  specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_FeatureUnit_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t bLength; /**< Size of the descriptor, in bytes. */
			uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
			                          *   given by the specific class.
			                          */

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

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

490
			uint8_t bControlSize; /**< Size of each element in the \c ChanelControlls array. */
491
			uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
492

493
			uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
494
		} ATTR_PACKED USB_Audio_StdDescriptor_FeatureUnit_t;
495

496
		/** \brief Audio class-specific Streaming Audio Interface Descriptor (LUFA naming conventions).
497
		 *
498
		 *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
499
		 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
500
501
		 *
		 *  \see \ref USB_Audio_StdDescriptor_Interface_AS_t for the version of this type with standard element names.
502
503
504
		 */
		typedef struct
		{
505
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
506
507
508
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                                  */
509

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

512
513
			uint8_t                 FrameDelay; /**< Delay in frames resulting from the complete sample processing from input to output. */
			uint16_t                AudioFormat; /**< Format of the audio stream, see Audio Device Formats specification. */
514
		} ATTR_PACKED USB_Audio_Descriptor_Interface_AS_t;
515
516
517
518
519
520
521
522
523
524
525
526
527

		/** \brief Audio class-specific Streaming Audio Interface Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific streaming interface descriptor. This indicates to the host
		 *  how audio streams within the device are formatted. See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_Interface_AS_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
Dean Camera's avatar
Dean Camera committed
528
529
			                           *   given by the specific class.
			                           */
530

531
532
533
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                              */
534

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

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

541
542
543
		/** \brief 24-Bit Audio Frequency Structure.
		 *
		 *  Type define for a 24bit audio sample frequency structure. GCC does not contain a built in 24bit datatype,
544
		 *  this this structure is used to build up the value instead. Fill this structure with the \ref AUDIO_SAMPLE_FREQ() macro.
545
546
547
		 */
		typedef struct
		{
548
549
550
			uint8_t Byte1; /**< Lowest 8 bits of the 24-bit value. */
			uint8_t Byte2; /**< Middle 8 bits of the 24-bit value. */
			uint8_t Byte3; /**< Upper 8 bits of the 24-bit value. */
551
		} ATTR_PACKED USB_Audio_SampleFreq_t;
552

553
		/** \brief Audio class-specific Format Descriptor (LUFA naming conventions).
554
		 *
555
		 *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
556
557
		 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
		 *  in the device's audio streams. See the USB Audio specification for more details.
558
		 *
559
560
561
		 *  \note This descriptor <b>must</b> be followed by one or more \ref USB_Audio_SampleFreq_t elements containing
		 *        the continuous or discrete sample frequencies.
		 *
562
		 *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
563
564
565
		 */
		typedef struct
		{
566
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
567
568
569
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
			                                  */
570

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

574
575
576
			uint8_t                 SubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
			uint8_t                 BitResolution; /**< Bits of resolution of each channel's samples in the stream. */

577
578
579
580
581
			uint8_t                 TotalDiscreteSampleRates; /**< Total number of discrete sample frequencies supported by the device. When
			                                                   *   zero, this must be followed by the lower and upper continuous sampling
			                                                   *   frequencies supported by the device; otherwise, this must be followed
			                                                   *   by the given number of discrete sampling frequencies supported.
			                                                   */
582
		} ATTR_PACKED USB_Audio_Descriptor_Format_t;
583
584
585
586
587
588
589

		/** \brief Audio class-specific Format Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific audio format descriptor. This is used to give the host full details
		 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
		 *  in the device's audio streams. See the USB Audio specification for more details.
		 *
590
591
592
		 *  \note This descriptor <b>must</b> be followed by one or more 24-bit integer elements containing the continuous
		 *        or discrete sample frequencies.
		 *
593
594
595
596
597
		 *  \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
598
599
600
601
			uint8_t bLength; /**< Size of the descriptor, in bytes. */
			uint8_t bDescriptorType; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                          *   must be \ref AUDIO_DSUBTYPE_CSInterface_FormatType.
			                          */
602

603
604
605
			uint8_t bDescriptorSubtype;/**< Sub type value used to distinguish between audio class-specific descriptors,
			                            *   a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
			                            */
606

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

610
611
			uint8_t bSubFrameSize; /**< Size in bytes of each channel's sample data in the stream. */
			uint8_t bBitResolution; /**< Bits of resolution of each channel's samples in the stream. */
612

613
614
615
616
617
			uint8_t bSampleFrequencyType; /**< Total number of sample frequencies supported by the device. When
			                               *   zero, this must be followed by the lower and upper continuous sampling
			                               *   frequencies supported by the device; otherwise, this must be followed
			                               *   by the given number of discrete sampling frequencies supported.
			                               */
618
		} ATTR_PACKED USB_Audio_StdDescriptor_Format_t;
619

620
		/** \brief Audio class-specific Streaming Endpoint Descriptor (LUFA naming conventions).
621
		 *
622
		 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
623
		 *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
624
625
		 *
		 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Std_t for the version of this type with standard element names.
626
627
628
		 */
		typedef struct
		{
629
			USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint. */
630

631
632
			uint8_t                   Refresh; /**< Always set to zero for Audio class devices. */
			uint8_t                   SyncEndpointNumber; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
633
		} ATTR_PACKED USB_Audio_Descriptor_StreamEndpoint_Std_t;
634
635
636

		/** \brief Audio class-specific Streaming Endpoint Descriptor (USB-IF naming conventions).
		 *
637
		 *  Type define for an Audio class-specific endpoint descriptor. This contains a regular endpoint
638
639
640
641
642
643
644
645
646
		 *  descriptor with a few Audio-class-specific extensions. See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Std_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a
Dean Camera's avatar
Dean Camera committed
647
648
			                           *   value given by the specific class.
			                           */
649
			uint8_t  bEndpointAddress; /**< Logical address of the endpoint within the device for the current
Dean Camera's avatar
Dean Camera committed
650
651
			                            *   configuration, including direction mask.
			                            */
652
653
			uint8_t  bmAttributes; /**< Endpoint attributes, comprised of a mask of the endpoint type (\c EP_TYPE_*)
			                        *   and attributes (\c ENDPOINT_ATTR_*) masks.
Dean Camera's avatar
Dean Camera committed
654
			                        */
655
			uint16_t wMaxPacketSize; /**< Size of the endpoint bank, in bytes. This indicates the maximum packet size
Dean Camera's avatar
Dean Camera committed
656
657
			                          *   that the endpoint can receive at a time.
			                          */
658
			uint8_t  bInterval; /**< Polling interval in milliseconds for the endpoint if it is an INTERRUPT or
Dean Camera's avatar
Dean Camera committed
659
660
			                     *   ISOCHRONOUS type.
			                     */
661

662
663
			uint8_t  bRefresh; /**< Always set to zero for Audio class devices. */
			uint8_t  bSynchAddress; /**< Endpoint address to send synchronization information to, if needed (zero otherwise). */
664
		} ATTR_PACKED USB_Audio_StdDescriptor_StreamEndpoint_Std_t;
Dean Camera's avatar
Dean Camera committed
665

666
		/** \brief Audio class-specific Extended Endpoint Descriptor (LUFA naming conventions).
667
		 *
668
		 *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
669
		 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
670
		 *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
671
672
		 *
		 *  \see \ref USB_Audio_StdDescriptor_StreamEndpoint_Spc_t for the version of this type with standard element names.
673
674
675
		 */
		typedef struct
		{
676
677
678
679
			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                                  *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
			                                  */
680

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

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

687
688
689
690
691
692
693
694
695
696
697
698
699
		/** \brief Audio class-specific Extended Endpoint Descriptor (USB-IF naming conventions).
		 *
		 *  Type define for an Audio class-specific extended endpoint descriptor. This contains extra information
		 *  on the usage of endpoints used to stream audio in and out of the USB Audio device, and follows an Audio
		 *  class-specific extended endpoint descriptor. See the USB Audio specification for more details.
		 *
		 *  \see \ref USB_Audio_Descriptor_StreamEndpoint_Spc_t for the version of this type with non-standard LUFA specific
		 *       element names.
		 */
		typedef struct
		{
			uint8_t  bLength; /**< Size of the descriptor, in bytes. */
			uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
Dean Camera's avatar
Dean Camera committed
700
701
			                           *   given by the specific class.
			                           */
702

703
704
705
			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors,
			                              *   a value from the \ref Audio_CSEndpoint_SubTypes_t enum.
			                              */
706

707
			uint8_t  bmAttributes; /**< Audio class-specific endpoint attributes, such as \ref AUDIO_EP_FULL_PACKETS_ONLY. */
708
709
710

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

713
714
715
716
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
717

718
719
720
#endif

/** @} */
721