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