Merge branch 'drm-intel-next' of git://git.kernel.org/pub/scm/linux/kernel/git/anholt...
[pandora-kernel.git] / include / linux / usb / audio-v2.h
1 /*
2  * Copyright (c) 2010 Daniel Mack <daniel@caiaq.de>
3  *
4  * This software is distributed under the terms of the GNU General Public
5  * License ("GPL") version 2, as published by the Free Software Foundation.
6  *
7  * This file holds USB constants and structures defined
8  * by the USB Device Class Definition for Audio Devices in version 2.0.
9  * Comments below reference relevant sections of the documents contained
10  * in http://www.usb.org/developers/devclass_docs/Audio2.0_final.zip
11  */
12
13 #ifndef __LINUX_USB_AUDIO_V2_H
14 #define __LINUX_USB_AUDIO_V2_H
15
16 #include <linux/types.h>
17
18 /* v1.0 and v2.0 of this standard have many things in common. For the rest
19  * of the definitions, please refer to audio.h */
20
21 /* 4.7.2.1 Clock Source Descriptor */
22
23 struct uac_clock_source_descriptor {
24         __u8 bLength;
25         __u8 bDescriptorType;
26         __u8 bDescriptorSubtype;
27         __u8 bClockID;
28         __u8 bmAttributes;
29         __u8 bmControls;
30         __u8 bAssocTerminal;
31         __u8 iClockSource;
32 } __attribute__((packed));
33
34 /* 4.7.2.2 Clock Source Descriptor */
35
36 struct uac_clock_selector_descriptor {
37         __u8 bLength;
38         __u8 bDescriptorType;
39         __u8 bDescriptorSubtype;
40         __u8 bClockID;
41         __u8 bNrInPins;
42         __u8 bmControls;
43         __u8 baCSourceID[];
44 } __attribute__((packed));
45
46 /* 4.7.2.4 Input terminal descriptor */
47
48 struct uac2_input_terminal_descriptor {
49         __u8 bLength;
50         __u8 bDescriptorType;
51         __u8 bDescriptorSubtype;
52         __u8 bTerminalID;
53         __u16 wTerminalType;
54         __u8 bAssocTerminal;
55         __u8 bCSourceID;
56         __u8 bNrChannels;
57         __u32 bmChannelConfig;
58         __u8 iChannelNames;
59         __u16 bmControls;
60         __u8 iTerminal;
61 } __attribute__((packed));
62
63 /* 4.7.2.5 Output terminal descriptor */
64
65 struct uac2_output_terminal_descriptor {
66         __u8 bLength;
67         __u8 bDescriptorType;
68         __u8 bDescriptorSubtype;
69         __u8 bTerminalID;
70         __u16 wTerminalType;
71         __u8 bAssocTerminal;
72         __u8 bSourceID;
73         __u8 bCSourceID;
74         __u16 bmControls;
75         __u8 iTerminal;
76 } __attribute__((packed));
77
78
79
80 /* 4.7.2.8 Feature Unit Descriptor */
81
82 struct uac2_feature_unit_descriptor {
83         __u8 bLength;
84         __u8 bDescriptorType;
85         __u8 bDescriptorSubtype;
86         __u8 bUnitID;
87         __u8 bSourceID;
88         /* bmaControls is actually u32,
89          * but u8 is needed for the hybrid parser */
90         __u8 bmaControls[0]; /* variable length */
91 } __attribute__((packed));
92
93 /* 4.9.2 Class-Specific AS Interface Descriptor */
94
95 struct uac_as_header_descriptor_v2 {
96         __u8 bLength;
97         __u8 bDescriptorType;
98         __u8 bDescriptorSubtype;
99         __u8 bTerminalLink;
100         __u8 bmControls;
101         __u8 bFormatType;
102         __u32 bmFormats;
103         __u8 bNrChannels;
104         __u32 bmChannelConfig;
105         __u8 iChannelNames;
106 } __attribute__((packed));
107
108 /* 4.10.1.2 Class-Specific AS Isochronous Audio Data Endpoint Descriptor */
109
110 struct uac2_iso_endpoint_descriptor {
111         __u8  bLength;                  /* in bytes: 8 */
112         __u8  bDescriptorType;          /* USB_DT_CS_ENDPOINT */
113         __u8  bDescriptorSubtype;       /* EP_GENERAL */
114         __u8  bmAttributes;
115         __u8  bmControls;
116         __u8  bLockDelayUnits;
117         __le16 wLockDelay;
118 } __attribute__((packed));
119
120 #define UAC2_CONTROL_PITCH              (3 << 0)
121 #define UAC2_CONTROL_DATA_OVERRUN       (3 << 2)
122 #define UAC2_CONTROL_DATA_UNDERRUN      (3 << 4)
123
124 /* 6.1 Interrupt Data Message */
125
126 #define UAC2_INTERRUPT_DATA_MSG_VENDOR  (1 << 0)
127 #define UAC2_INTERRUPT_DATA_MSG_EP      (1 << 1)
128
129 struct uac2_interrupt_data_msg {
130         __u8 bInfo;
131         __u8 bAttribute;
132         __le16 wValue;
133         __le16 wIndex;
134 } __attribute__((packed));
135
136 /* A.7 Audio Function Category Codes */
137 #define UAC2_FUNCTION_SUBCLASS_UNDEFINED        0x00
138 #define UAC2_FUNCTION_DESKTOP_SPEAKER           0x01
139 #define UAC2_FUNCTION_HOME_THEATER              0x02
140 #define UAC2_FUNCTION_MICROPHONE                0x03
141 #define UAC2_FUNCTION_HEADSET                   0x04
142 #define UAC2_FUNCTION_TELEPHONE                 0x05
143 #define UAC2_FUNCTION_CONVERTER                 0x06
144 #define UAC2_FUNCTION_SOUND_RECORDER            0x07
145 #define UAC2_FUNCTION_IO_BOX                    0x08
146 #define UAC2_FUNCTION_MUSICAL_INSTRUMENT        0x09
147 #define UAC2_FUNCTION_PRO_AUDIO                 0x0a
148 #define UAC2_FUNCTION_AUDIO_VIDEO               0x0b
149 #define UAC2_FUNCTION_CONTROL_PANEL             0x0c
150 #define UAC2_FUNCTION_OTHER                     0xff
151
152 /* A.9 Audio Class-Specific AC Interface Descriptor Subtypes */
153 /* see audio.h for the rest, which is identical to v1 */
154 #define UAC2_EFFECT_UNIT                        0x07
155 #define UAC2_PROCESSING_UNIT_V2         0x08
156 #define UAC2_EXTENSION_UNIT_V2          0x09
157 #define UAC2_CLOCK_SOURCE               0x0a
158 #define UAC2_CLOCK_SELECTOR             0x0b
159 #define UAC2_CLOCK_MULTIPLIER           0x0c
160 #define UAC2_SAMPLE_RATE_CONVERTER      0x0d
161
162 /* A.10 Audio Class-Specific AS Interface Descriptor Subtypes */
163 /* see audio.h for the rest, which is identical to v1 */
164 #define UAC2_ENCODER                    0x03
165 #define UAC2_DECODER                    0x04
166
167 /* A.11 Effect Unit Effect Types */
168 #define UAC2_EFFECT_UNDEFINED           0x00
169 #define UAC2_EFFECT_PARAM_EQ            0x01
170 #define UAC2_EFFECT_REVERB              0x02
171 #define UAC2_EFFECT_MOD_DELAY           0x03
172 #define UAC2_EFFECT_DYN_RANGE_COMP      0x04
173
174 /* A.12 Processing Unit Process Types */
175 #define UAC2_PROCESS_UNDEFINED          0x00
176 #define UAC2_PROCESS_UP_DOWNMIX         0x01
177 #define UAC2_PROCESS_DOLBY_PROLOCIC     0x02
178 #define UAC2_PROCESS_STEREO_EXTENDER    0x03
179
180 /* A.14 Audio Class-Specific Request Codes */
181 #define UAC2_CS_CUR                     0x01
182 #define UAC2_CS_RANGE                   0x02
183 #define UAC2_CS_MEM                     0x03
184
185 /* A.15 Encoder Type Codes */
186 #define UAC2_ENCODER_UNDEFINED          0x00
187 #define UAC2_ENCODER_OTHER              0x01
188 #define UAC2_ENCODER_MPEG               0x02
189 #define UAC2_ENCODER_AC3                0x03
190 #define UAC2_ENCODER_WMA                0x04
191 #define UAC2_ENCODER_DTS                0x05
192
193 /* A.16 Decoder Type Codes */
194 #define UAC2_DECODER_UNDEFINED          0x00
195 #define UAC2_DECODER_OTHER              0x01
196 #define UAC2_DECODER_MPEG               0x02
197 #define UAC2_DECODER_AC3                0x03
198 #define UAC2_DECODER_WMA                0x04
199 #define UAC2_DECODER_DTS                0x05
200
201 /* A.17.1 Clock Source Control Selectors */
202 #define UAC2_CS_UNDEFINED               0x00
203 #define UAC2_CS_CONTROL_SAM_FREQ        0x01
204 #define UAC2_CS_CONTROL_CLOCK_VALID     0x02
205
206 /* A.17.2 Clock Selector Control Selectors */
207 #define UAC2_CX_UNDEFINED               0x00
208 #define UAC2_CX_CLOCK_SELECTOR          0x01
209
210 /* A.17.3 Clock Multiplier Control Selectors */
211 #define UAC2_CM_UNDEFINED               0x00
212 #define UAC2_CM_NUMERATOR               0x01
213 #define UAC2_CM_DENOMINTATOR            0x02
214
215 /* A.17.4 Terminal Control Selectors */
216 #define UAC2_TE_UNDEFINED               0x00
217 #define UAC2_TE_COPY_PROTECT            0x01
218 #define UAC2_TE_CONNECTOR               0x02
219 #define UAC2_TE_OVERLOAD                0x03
220 #define UAC2_TE_CLUSTER                 0x04
221 #define UAC2_TE_UNDERFLOW               0x05
222 #define UAC2_TE_OVERFLOW                0x06
223 #define UAC2_TE_LATENCY                 0x07
224
225 /* A.17.5 Mixer Control Selectors */
226 #define UAC2_MU_UNDEFINED               0x00
227 #define UAC2_MU_MIXER                   0x01
228 #define UAC2_MU_CLUSTER                 0x02
229 #define UAC2_MU_UNDERFLOW               0x03
230 #define UAC2_MU_OVERFLOW                0x04
231 #define UAC2_MU_LATENCY                 0x05
232
233 /* A.17.6 Selector Control Selectors */
234 #define UAC2_SU_UNDEFINED               0x00
235 #define UAC2_SU_SELECTOR                0x01
236 #define UAC2_SU_LATENCY                 0x02
237
238 /* A.17.7 Feature Unit Control Selectors */
239 /* see audio.h for the rest, which is identical to v1 */
240 #define UAC2_FU_INPUT_GAIN              0x0b
241 #define UAC2_FU_INPUT_GAIN_PAD          0x0c
242 #define UAC2_FU_PHASE_INVERTER          0x0d
243 #define UAC2_FU_UNDERFLOW               0x0e
244 #define UAC2_FU_OVERFLOW                0x0f
245 #define UAC2_FU_LATENCY                 0x10
246
247 /* A.17.8.1 Parametric Equalizer Section Effect Unit Control Selectors */
248 #define UAC2_PE_UNDEFINED               0x00
249 #define UAC2_PE_ENABLE                  0x01
250 #define UAC2_PE_CENTERFREQ              0x02
251 #define UAC2_PE_QFACTOR                 0x03
252 #define UAC2_PE_GAIN                    0x04
253 #define UAC2_PE_UNDERFLOW               0x05
254 #define UAC2_PE_OVERFLOW                0x06
255 #define UAC2_PE_LATENCY                 0x07
256
257 /* A.17.8.2 Reverberation Effect Unit Control Selectors */
258 #define UAC2_RV_UNDEFINED               0x00
259 #define UAC2_RV_ENABLE                  0x01
260 #define UAC2_RV_TYPE                    0x02
261 #define UAC2_RV_LEVEL                   0x03
262 #define UAC2_RV_TIME                    0x04
263 #define UAC2_RV_FEEDBACK                0x05
264 #define UAC2_RV_PREDELAY                0x06
265 #define UAC2_RV_DENSITY                 0x07
266 #define UAC2_RV_HIFREQ_ROLLOFF          0x08
267 #define UAC2_RV_UNDERFLOW               0x09
268 #define UAC2_RV_OVERFLOW                0x0a
269 #define UAC2_RV_LATENCY                 0x0b
270
271 /* A.17.8.3 Modulation Delay Effect Control Selectors */
272 #define UAC2_MD_UNDEFINED               0x00
273 #define UAC2_MD_ENABLE                  0x01
274 #define UAC2_MD_BALANCE                 0x02
275 #define UAC2_MD_RATE                    0x03
276 #define UAC2_MD_DEPTH                   0x04
277 #define UAC2_MD_TIME                    0x05
278 #define UAC2_MD_FEEDBACK                0x06
279 #define UAC2_MD_UNDERFLOW               0x07
280 #define UAC2_MD_OVERFLOW                0x08
281 #define UAC2_MD_LATENCY                 0x09
282
283 /* A.17.8.4 Dynamic Range Compressor Effect Unit Control Selectors */
284 #define UAC2_DR_UNDEFINED               0x00
285 #define UAC2_DR_ENABLE                  0x01
286 #define UAC2_DR_COMPRESSION_RATE        0x02
287 #define UAC2_DR_MAXAMPL                 0x03
288 #define UAC2_DR_THRESHOLD               0x04
289 #define UAC2_DR_ATTACK_TIME             0x05
290 #define UAC2_DR_RELEASE_TIME            0x06
291 #define UAC2_DR_UNDEFLOW                0x07
292 #define UAC2_DR_OVERFLOW                0x08
293 #define UAC2_DR_LATENCY                 0x09
294
295 /* A.17.9.1 Up/Down-mix Processing Unit Control Selectors */
296 #define UAC2_UD_UNDEFINED               0x00
297 #define UAC2_UD_ENABLE                  0x01
298 #define UAC2_UD_MODE_SELECT             0x02
299 #define UAC2_UD_CLUSTER                 0x03
300 #define UAC2_UD_UNDERFLOW               0x04
301 #define UAC2_UD_OVERFLOW                0x05
302 #define UAC2_UD_LATENCY                 0x06
303
304 /* A.17.9.2 Dolby Prologic[tm] Processing Unit Control Selectors */
305 #define UAC2_DP_UNDEFINED               0x00
306 #define UAC2_DP_ENABLE                  0x01
307 #define UAC2_DP_MODE_SELECT             0x02
308 #define UAC2_DP_CLUSTER                 0x03
309 #define UAC2_DP_UNDERFFLOW              0x04
310 #define UAC2_DP_OVERFLOW                0x05
311 #define UAC2_DP_LATENCY                 0x06
312
313 /* A.17.9.3 Stereo Expander Processing Unit Control Selectors */
314 #define UAC2_ST_EXT_UNDEFINED           0x00
315 #define UAC2_ST_EXT_ENABLE              0x01
316 #define UAC2_ST_EXT_WIDTH               0x02
317 #define UAC2_ST_EXT_UNDEFLOW            0x03
318 #define UAC2_ST_EXT_OVERFLOW            0x04
319 #define UAC2_ST_EXT_LATENCY             0x05
320
321 /* A.17.10 Extension Unit Control Selectors */
322 #define UAC2_XU_UNDEFINED               0x00
323 #define UAC2_XU_ENABLE                  0x01
324 #define UAC2_XU_CLUSTER                 0x02
325 #define UAC2_XU_UNDERFLOW               0x03
326 #define UAC2_XU_OVERFLOW                0x04
327 #define UAC2_XU_LATENCY                 0x05
328
329 /* A.17.11 AudioStreaming Interface Control Selectors */
330 #define UAC2_AS_UNDEFINED               0x00
331 #define UAC2_AS_ACT_ALT_SETTING         0x01
332 #define UAC2_AS_VAL_ALT_SETTINGS        0x02
333 #define UAC2_AS_AUDIO_DATA_FORMAT       0x03
334
335 /* A.17.12 Encoder Control Selectors */
336 #define UAC2_EN_UNDEFINED               0x00
337 #define UAC2_EN_BIT_RATE                0x01
338 #define UAC2_EN_QUALITY                 0x02
339 #define UAC2_EN_VBR                     0x03
340 #define UAC2_EN_TYPE                    0x04
341 #define UAC2_EN_UNDERFLOW               0x05
342 #define UAC2_EN_OVERFLOW                0x06
343 #define UAC2_EN_ENCODER_ERROR           0x07
344 #define UAC2_EN_PARAM1                  0x08
345 #define UAC2_EN_PARAM2                  0x09
346 #define UAC2_EN_PARAM3                  0x0a
347 #define UAC2_EN_PARAM4                  0x0b
348 #define UAC2_EN_PARAM5                  0x0c
349 #define UAC2_EN_PARAM6                  0x0d
350 #define UAC2_EN_PARAM7                  0x0e
351 #define UAC2_EN_PARAM8                  0x0f
352
353 /* A.17.13.1 MPEG Decoder Control Selectors */
354 #define UAC2_MPEG_UNDEFINED             0x00
355 #define UAC2_MPEG_DUAL_CHANNEL          0x01
356 #define UAC2_MPEG_SECOND_STEREO         0x02
357 #define UAC2_MPEG_MULTILINGUAL          0x03
358 #define UAC2_MPEG_DYN_RANGE             0x04
359 #define UAC2_MPEG_SCALING               0x05
360 #define UAC2_MPEG_HILO_SCALING          0x06
361 #define UAC2_MPEG_UNDERFLOW             0x07
362 #define UAC2_MPEG_OVERFLOW              0x08
363 #define UAC2_MPEG_DECODER_ERROR         0x09
364
365 /* A17.13.2 AC3 Decoder Control Selectors */
366 #define UAC2_AC3_UNDEFINED              0x00
367 #define UAC2_AC3_MODE                   0x01
368 #define UAC2_AC3_DYN_RANGE              0x02
369 #define UAC2_AC3_SCALING                0x03
370 #define UAC2_AC3_HILO_SCALING           0x04
371 #define UAC2_AC3_UNDERFLOW              0x05
372 #define UAC2_AC3_OVERFLOW               0x06
373 #define UAC2_AC3_DECODER_ERROR          0x07
374
375 /* A17.13.3 WMA Decoder Control Selectors */
376 #define UAC2_WMA_UNDEFINED              0x00
377 #define UAC2_WMA_UNDERFLOW              0x01
378 #define UAC2_WMA_OVERFLOW               0x02
379 #define UAC2_WMA_DECODER_ERROR          0x03
380
381 /* A17.13.4 DTS Decoder Control Selectors */
382 #define UAC2_DTS_UNDEFINED              0x00
383 #define UAC2_DTS_UNDERFLOW              0x01
384 #define UAC2_DTS_OVERFLOW               0x02
385 #define UAC2_DTS_DECODER_ERROR          0x03
386
387 /* A17.14 Endpoint Control Selectors */
388 #define UAC2_EP_CS_UNDEFINED            0x00
389 #define UAC2_EP_CS_PITCH                0x01
390 #define UAC2_EP_CS_DATA_OVERRUN         0x02
391 #define UAC2_EP_CS_DATA_UNDERRUN        0x03
392
393 #endif /* __LINUX_USB_AUDIO_V2_H */
394