diff options
Diffstat (limited to 'include/linux/usb/audio-v2.h')
-rw-r--r-- | include/linux/usb/audio-v2.h | 378 |
1 files changed, 378 insertions, 0 deletions
diff --git a/include/linux/usb/audio-v2.h b/include/linux/usb/audio-v2.h new file mode 100644 index 000000000000..2389f93a28b5 --- /dev/null +++ b/include/linux/usb/audio-v2.h | |||
@@ -0,0 +1,378 @@ | |||
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 | /* 6.1 Interrupt Data Message */ | ||
109 | |||
110 | #define UAC2_INTERRUPT_DATA_MSG_VENDOR (1 << 0) | ||
111 | #define UAC2_INTERRUPT_DATA_MSG_EP (1 << 1) | ||
112 | |||
113 | struct uac2_interrupt_data_msg { | ||
114 | __u8 bInfo; | ||
115 | __u8 bAttribute; | ||
116 | __le16 wValue; | ||
117 | __le16 wIndex; | ||
118 | } __attribute__((packed)); | ||
119 | |||
120 | /* A.7 Audio Function Category Codes */ | ||
121 | #define UAC2_FUNCTION_SUBCLASS_UNDEFINED 0x00 | ||
122 | #define UAC2_FUNCTION_DESKTOP_SPEAKER 0x01 | ||
123 | #define UAC2_FUNCTION_HOME_THEATER 0x02 | ||
124 | #define UAC2_FUNCTION_MICROPHONE 0x03 | ||
125 | #define UAC2_FUNCTION_HEADSET 0x04 | ||
126 | #define UAC2_FUNCTION_TELEPHONE 0x05 | ||
127 | #define UAC2_FUNCTION_CONVERTER 0x06 | ||
128 | #define UAC2_FUNCTION_SOUND_RECORDER 0x07 | ||
129 | #define UAC2_FUNCTION_IO_BOX 0x08 | ||
130 | #define UAC2_FUNCTION_MUSICAL_INSTRUMENT 0x09 | ||
131 | #define UAC2_FUNCTION_PRO_AUDIO 0x0a | ||
132 | #define UAC2_FUNCTION_AUDIO_VIDEO 0x0b | ||
133 | #define UAC2_FUNCTION_CONTROL_PANEL 0x0c | ||
134 | #define UAC2_FUNCTION_OTHER 0xff | ||
135 | |||
136 | /* A.9 Audio Class-Specific AC Interface Descriptor Subtypes */ | ||
137 | /* see audio.h for the rest, which is identical to v1 */ | ||
138 | #define UAC2_EFFECT_UNIT 0x07 | ||
139 | #define UAC2_PROCESSING_UNIT_V2 0x08 | ||
140 | #define UAC2_EXTENSION_UNIT_V2 0x09 | ||
141 | #define UAC2_CLOCK_SOURCE 0x0a | ||
142 | #define UAC2_CLOCK_SELECTOR 0x0b | ||
143 | #define UAC2_CLOCK_MULTIPLIER 0x0c | ||
144 | #define UAC2_SAMPLE_RATE_CONVERTER 0x0d | ||
145 | |||
146 | /* A.10 Audio Class-Specific AS Interface Descriptor Subtypes */ | ||
147 | /* see audio.h for the rest, which is identical to v1 */ | ||
148 | #define UAC2_ENCODER 0x03 | ||
149 | #define UAC2_DECODER 0x04 | ||
150 | |||
151 | /* A.11 Effect Unit Effect Types */ | ||
152 | #define UAC2_EFFECT_UNDEFINED 0x00 | ||
153 | #define UAC2_EFFECT_PARAM_EQ 0x01 | ||
154 | #define UAC2_EFFECT_REVERB 0x02 | ||
155 | #define UAC2_EFFECT_MOD_DELAY 0x03 | ||
156 | #define UAC2_EFFECT_DYN_RANGE_COMP 0x04 | ||
157 | |||
158 | /* A.12 Processing Unit Process Types */ | ||
159 | #define UAC2_PROCESS_UNDEFINED 0x00 | ||
160 | #define UAC2_PROCESS_UP_DOWNMIX 0x01 | ||
161 | #define UAC2_PROCESS_DOLBY_PROLOCIC 0x02 | ||
162 | #define UAC2_PROCESS_STEREO_EXTENDER 0x03 | ||
163 | |||
164 | /* A.14 Audio Class-Specific Request Codes */ | ||
165 | #define UAC2_CS_CUR 0x01 | ||
166 | #define UAC2_CS_RANGE 0x02 | ||
167 | #define UAC2_CS_MEM 0x03 | ||
168 | |||
169 | /* A.15 Encoder Type Codes */ | ||
170 | #define UAC2_ENCODER_UNDEFINED 0x00 | ||
171 | #define UAC2_ENCODER_OTHER 0x01 | ||
172 | #define UAC2_ENCODER_MPEG 0x02 | ||
173 | #define UAC2_ENCODER_AC3 0x03 | ||
174 | #define UAC2_ENCODER_WMA 0x04 | ||
175 | #define UAC2_ENCODER_DTS 0x05 | ||
176 | |||
177 | /* A.16 Decoder Type Codes */ | ||
178 | #define UAC2_DECODER_UNDEFINED 0x00 | ||
179 | #define UAC2_DECODER_OTHER 0x01 | ||
180 | #define UAC2_DECODER_MPEG 0x02 | ||
181 | #define UAC2_DECODER_AC3 0x03 | ||
182 | #define UAC2_DECODER_WMA 0x04 | ||
183 | #define UAC2_DECODER_DTS 0x05 | ||
184 | |||
185 | /* A.17.1 Clock Source Control Selectors */ | ||
186 | #define UAC2_CS_UNDEFINED 0x00 | ||
187 | #define UAC2_CS_CONTROL_SAM_FREQ 0x01 | ||
188 | #define UAC2_CS_CONTROL_CLOCK_VALID 0x02 | ||
189 | |||
190 | /* A.17.2 Clock Selector Control Selectors */ | ||
191 | #define UAC2_CX_UNDEFINED 0x00 | ||
192 | #define UAC2_CX_CLOCK_SELECTOR 0x01 | ||
193 | |||
194 | /* A.17.3 Clock Multiplier Control Selectors */ | ||
195 | #define UAC2_CM_UNDEFINED 0x00 | ||
196 | #define UAC2_CM_NUMERATOR 0x01 | ||
197 | #define UAC2_CM_DENOMINTATOR 0x02 | ||
198 | |||
199 | /* A.17.4 Terminal Control Selectors */ | ||
200 | #define UAC2_TE_UNDEFINED 0x00 | ||
201 | #define UAC2_TE_COPY_PROTECT 0x01 | ||
202 | #define UAC2_TE_CONNECTOR 0x02 | ||
203 | #define UAC2_TE_OVERLOAD 0x03 | ||
204 | #define UAC2_TE_CLUSTER 0x04 | ||
205 | #define UAC2_TE_UNDERFLOW 0x05 | ||
206 | #define UAC2_TE_OVERFLOW 0x06 | ||
207 | #define UAC2_TE_LATENCY 0x07 | ||
208 | |||
209 | /* A.17.5 Mixer Control Selectors */ | ||
210 | #define UAC2_MU_UNDEFINED 0x00 | ||
211 | #define UAC2_MU_MIXER 0x01 | ||
212 | #define UAC2_MU_CLUSTER 0x02 | ||
213 | #define UAC2_MU_UNDERFLOW 0x03 | ||
214 | #define UAC2_MU_OVERFLOW 0x04 | ||
215 | #define UAC2_MU_LATENCY 0x05 | ||
216 | |||
217 | /* A.17.6 Selector Control Selectors */ | ||
218 | #define UAC2_SU_UNDEFINED 0x00 | ||
219 | #define UAC2_SU_SELECTOR 0x01 | ||
220 | #define UAC2_SU_LATENCY 0x02 | ||
221 | |||
222 | /* A.17.7 Feature Unit Control Selectors */ | ||
223 | /* see audio.h for the rest, which is identical to v1 */ | ||
224 | #define UAC2_FU_INPUT_GAIN 0x0b | ||
225 | #define UAC2_FU_INPUT_GAIN_PAD 0x0c | ||
226 | #define UAC2_FU_PHASE_INVERTER 0x0d | ||
227 | #define UAC2_FU_UNDERFLOW 0x0e | ||
228 | #define UAC2_FU_OVERFLOW 0x0f | ||
229 | #define UAC2_FU_LATENCY 0x10 | ||
230 | |||
231 | /* A.17.8.1 Parametric Equalizer Section Effect Unit Control Selectors */ | ||
232 | #define UAC2_PE_UNDEFINED 0x00 | ||
233 | #define UAC2_PE_ENABLE 0x01 | ||
234 | #define UAC2_PE_CENTERFREQ 0x02 | ||
235 | #define UAC2_PE_QFACTOR 0x03 | ||
236 | #define UAC2_PE_GAIN 0x04 | ||
237 | #define UAC2_PE_UNDERFLOW 0x05 | ||
238 | #define UAC2_PE_OVERFLOW 0x06 | ||
239 | #define UAC2_PE_LATENCY 0x07 | ||
240 | |||
241 | /* A.17.8.2 Reverberation Effect Unit Control Selectors */ | ||
242 | #define UAC2_RV_UNDEFINED 0x00 | ||
243 | #define UAC2_RV_ENABLE 0x01 | ||
244 | #define UAC2_RV_TYPE 0x02 | ||
245 | #define UAC2_RV_LEVEL 0x03 | ||
246 | #define UAC2_RV_TIME 0x04 | ||
247 | #define UAC2_RV_FEEDBACK 0x05 | ||
248 | #define UAC2_RV_PREDELAY 0x06 | ||
249 | #define UAC2_RV_DENSITY 0x07 | ||
250 | #define UAC2_RV_HIFREQ_ROLLOFF 0x08 | ||
251 | #define UAC2_RV_UNDERFLOW 0x09 | ||
252 | #define UAC2_RV_OVERFLOW 0x0a | ||
253 | #define UAC2_RV_LATENCY 0x0b | ||
254 | |||
255 | /* A.17.8.3 Modulation Delay Effect Control Selectors */ | ||
256 | #define UAC2_MD_UNDEFINED 0x00 | ||
257 | #define UAC2_MD_ENABLE 0x01 | ||
258 | #define UAC2_MD_BALANCE 0x02 | ||
259 | #define UAC2_MD_RATE 0x03 | ||
260 | #define UAC2_MD_DEPTH 0x04 | ||
261 | #define UAC2_MD_TIME 0x05 | ||
262 | #define UAC2_MD_FEEDBACK 0x06 | ||
263 | #define UAC2_MD_UNDERFLOW 0x07 | ||
264 | #define UAC2_MD_OVERFLOW 0x08 | ||
265 | #define UAC2_MD_LATENCY 0x09 | ||
266 | |||
267 | /* A.17.8.4 Dynamic Range Compressor Effect Unit Control Selectors */ | ||
268 | #define UAC2_DR_UNDEFINED 0x00 | ||
269 | #define UAC2_DR_ENABLE 0x01 | ||
270 | #define UAC2_DR_COMPRESSION_RATE 0x02 | ||
271 | #define UAC2_DR_MAXAMPL 0x03 | ||
272 | #define UAC2_DR_THRESHOLD 0x04 | ||
273 | #define UAC2_DR_ATTACK_TIME 0x05 | ||
274 | #define UAC2_DR_RELEASE_TIME 0x06 | ||
275 | #define UAC2_DR_UNDEFLOW 0x07 | ||
276 | #define UAC2_DR_OVERFLOW 0x08 | ||
277 | #define UAC2_DR_LATENCY 0x09 | ||
278 | |||
279 | /* A.17.9.1 Up/Down-mix Processing Unit Control Selectors */ | ||
280 | #define UAC2_UD_UNDEFINED 0x00 | ||
281 | #define UAC2_UD_ENABLE 0x01 | ||
282 | #define UAC2_UD_MODE_SELECT 0x02 | ||
283 | #define UAC2_UD_CLUSTER 0x03 | ||
284 | #define UAC2_UD_UNDERFLOW 0x04 | ||
285 | #define UAC2_UD_OVERFLOW 0x05 | ||
286 | #define UAC2_UD_LATENCY 0x06 | ||
287 | |||
288 | /* A.17.9.2 Dolby Prologic[tm] Processing Unit Control Selectors */ | ||
289 | #define UAC2_DP_UNDEFINED 0x00 | ||
290 | #define UAC2_DP_ENABLE 0x01 | ||
291 | #define UAC2_DP_MODE_SELECT 0x02 | ||
292 | #define UAC2_DP_CLUSTER 0x03 | ||
293 | #define UAC2_DP_UNDERFFLOW 0x04 | ||
294 | #define UAC2_DP_OVERFLOW 0x05 | ||
295 | #define UAC2_DP_LATENCY 0x06 | ||
296 | |||
297 | /* A.17.9.3 Stereo Expander Processing Unit Control Selectors */ | ||
298 | #define UAC2_ST_EXT_UNDEFINED 0x00 | ||
299 | #define UAC2_ST_EXT_ENABLE 0x01 | ||
300 | #define UAC2_ST_EXT_WIDTH 0x02 | ||
301 | #define UAC2_ST_EXT_UNDEFLOW 0x03 | ||
302 | #define UAC2_ST_EXT_OVERFLOW 0x04 | ||
303 | #define UAC2_ST_EXT_LATENCY 0x05 | ||
304 | |||
305 | /* A.17.10 Extension Unit Control Selectors */ | ||
306 | #define UAC2_XU_UNDEFINED 0x00 | ||
307 | #define UAC2_XU_ENABLE 0x01 | ||
308 | #define UAC2_XU_CLUSTER 0x02 | ||
309 | #define UAC2_XU_UNDERFLOW 0x03 | ||
310 | #define UAC2_XU_OVERFLOW 0x04 | ||
311 | #define UAC2_XU_LATENCY 0x05 | ||
312 | |||
313 | /* A.17.11 AudioStreaming Interface Control Selectors */ | ||
314 | #define UAC2_AS_UNDEFINED 0x00 | ||
315 | #define UAC2_AS_ACT_ALT_SETTING 0x01 | ||
316 | #define UAC2_AS_VAL_ALT_SETTINGS 0x02 | ||
317 | #define UAC2_AS_AUDIO_DATA_FORMAT 0x03 | ||
318 | |||
319 | /* A.17.12 Encoder Control Selectors */ | ||
320 | #define UAC2_EN_UNDEFINED 0x00 | ||
321 | #define UAC2_EN_BIT_RATE 0x01 | ||
322 | #define UAC2_EN_QUALITY 0x02 | ||
323 | #define UAC2_EN_VBR 0x03 | ||
324 | #define UAC2_EN_TYPE 0x04 | ||
325 | #define UAC2_EN_UNDERFLOW 0x05 | ||
326 | #define UAC2_EN_OVERFLOW 0x06 | ||
327 | #define UAC2_EN_ENCODER_ERROR 0x07 | ||
328 | #define UAC2_EN_PARAM1 0x08 | ||
329 | #define UAC2_EN_PARAM2 0x09 | ||
330 | #define UAC2_EN_PARAM3 0x0a | ||
331 | #define UAC2_EN_PARAM4 0x0b | ||
332 | #define UAC2_EN_PARAM5 0x0c | ||
333 | #define UAC2_EN_PARAM6 0x0d | ||
334 | #define UAC2_EN_PARAM7 0x0e | ||
335 | #define UAC2_EN_PARAM8 0x0f | ||
336 | |||
337 | /* A.17.13.1 MPEG Decoder Control Selectors */ | ||
338 | #define UAC2_MPEG_UNDEFINED 0x00 | ||
339 | #define UAC2_MPEG_DUAL_CHANNEL 0x01 | ||
340 | #define UAC2_MPEG_SECOND_STEREO 0x02 | ||
341 | #define UAC2_MPEG_MULTILINGUAL 0x03 | ||
342 | #define UAC2_MPEG_DYN_RANGE 0x04 | ||
343 | #define UAC2_MPEG_SCALING 0x05 | ||
344 | #define UAC2_MPEG_HILO_SCALING 0x06 | ||
345 | #define UAC2_MPEG_UNDERFLOW 0x07 | ||
346 | #define UAC2_MPEG_OVERFLOW 0x08 | ||
347 | #define UAC2_MPEG_DECODER_ERROR 0x09 | ||
348 | |||
349 | /* A17.13.2 AC3 Decoder Control Selectors */ | ||
350 | #define UAC2_AC3_UNDEFINED 0x00 | ||
351 | #define UAC2_AC3_MODE 0x01 | ||
352 | #define UAC2_AC3_DYN_RANGE 0x02 | ||
353 | #define UAC2_AC3_SCALING 0x03 | ||
354 | #define UAC2_AC3_HILO_SCALING 0x04 | ||
355 | #define UAC2_AC3_UNDERFLOW 0x05 | ||
356 | #define UAC2_AC3_OVERFLOW 0x06 | ||
357 | #define UAC2_AC3_DECODER_ERROR 0x07 | ||
358 | |||
359 | /* A17.13.3 WMA Decoder Control Selectors */ | ||
360 | #define UAC2_WMA_UNDEFINED 0x00 | ||
361 | #define UAC2_WMA_UNDERFLOW 0x01 | ||
362 | #define UAC2_WMA_OVERFLOW 0x02 | ||
363 | #define UAC2_WMA_DECODER_ERROR 0x03 | ||
364 | |||
365 | /* A17.13.4 DTS Decoder Control Selectors */ | ||
366 | #define UAC2_DTS_UNDEFINED 0x00 | ||
367 | #define UAC2_DTS_UNDERFLOW 0x01 | ||
368 | #define UAC2_DTS_OVERFLOW 0x02 | ||
369 | #define UAC2_DTS_DECODER_ERROR 0x03 | ||
370 | |||
371 | /* A17.14 Endpoint Control Selectors */ | ||
372 | #define UAC2_EP_CS_UNDEFINED 0x00 | ||
373 | #define UAC2_EP_CS_PITCH 0x01 | ||
374 | #define UAC2_EP_CS_DATA_OVERRUN 0x02 | ||
375 | #define UAC2_EP_CS_DATA_UNDERRUN 0x03 | ||
376 | |||
377 | #endif /* __LINUX_USB_AUDIO_V2_H */ | ||
378 | |||