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