Something went wrong. Try again.
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493// SPDX-License-Identifier: GPL-2.0/* * Copyright (c) 2010 Daniel Mack <daniel@caiaq.de> * * This file holds USB constants and structures defined * by the USB Device Class Definition for Audio Devices in version 2.0. * Comments below reference relevant sections of the documents contained * in http://www.usb.org/developers/devclass_docs/Audio2.0_final.zip */
#ifndef __LINUX_USB_AUDIO_V2_H#define __LINUX_USB_AUDIO_V2_H
#include <linux/types.h>
/* v1.0 and v2.0 of this standard have many things in common. For the rest * of the definitions, please refer to audio.h */
/* * bmControl field decoders * * From the USB Audio spec v2.0: * * bmaControls() is a (ch+1)-element array of 4-byte bitmaps, * each containing a set of bit pairs. If a Control is present, * it must be Host readable. If a certain Control is not * present then the bit pair must be set to 0b00. * If a Control is present but read-only, the bit pair must be * set to 0b01. If a Control is also Host programmable, the bit * pair must be set to 0b11. The value 0b10 is not allowed. * */
static inline bool uac_v2v3_control_is_readable(u32 bmControls, u8 control){ return (bmControls >> ((control - 1) * 2)) & 0x1;}
static inline bool uac_v2v3_control_is_writeable(u32 bmControls, u8 control){ return (bmControls >> ((control - 1) * 2)) & 0x2;}
/* 4.7.2 Class-Specific AC Interface Descriptor */struct uac2_ac_header_descriptor { __u8 bLength; /* 9 */ __u8 bDescriptorType; /* USB_DT_CS_INTERFACE */ __u8 bDescriptorSubtype; /* UAC_MS_HEADER */ __le16 bcdADC; /* 0x0200 */ __u8 bCategory; __le16 wTotalLength; /* includes Unit and Terminal desc. */ __u8 bmControls;} __packed;
/* 2.3.1.6 Type I Format Type Descriptor (Frmts20 final.pdf)*/struct uac2_format_type_i_descriptor { __u8 bLength; /* in bytes: 6 */ __u8 bDescriptorType; /* USB_DT_CS_INTERFACE */ __u8 bDescriptorSubtype; /* FORMAT_TYPE */ __u8 bFormatType; /* FORMAT_TYPE_1 */ __u8 bSubslotSize; /* {1,2,3,4} */ __u8 bBitResolution;} __packed;
/* 4.7.2.1 Clock Source Descriptor */
struct uac_clock_source_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bDescriptorSubtype; __u8 bClockID; __u8 bmAttributes; __u8 bmControls; __u8 bAssocTerminal; __u8 iClockSource;} __attribute__((packed));
/* bmAttribute fields */#define UAC_CLOCK_SOURCE_TYPE_EXT 0x0#define UAC_CLOCK_SOURCE_TYPE_INT_FIXED 0x1#define UAC_CLOCK_SOURCE_TYPE_INT_VAR 0x2#define UAC_CLOCK_SOURCE_TYPE_INT_PROG 0x3#define UAC_CLOCK_SOURCE_SYNCED_TO_SOF (1 << 2)
/* 4.7.2.2 Clock Selector Descriptor */
struct uac_clock_selector_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bDescriptorSubtype; __u8 bClockID; __u8 bNrInPins; __u8 baCSourceID[]; /* bmControls and iClockSelector omitted */} __attribute__((packed));
/* 4.7.2.3 Clock Multiplier Descriptor */
struct uac_clock_multiplier_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bDescriptorSubtype; __u8 bClockID; __u8 bCSourceID; __u8 bmControls; __u8 iClockMultiplier;} __attribute__((packed));
/* 4.7.2.4 Input terminal descriptor */
struct uac2_input_terminal_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bDescriptorSubtype; __u8 bTerminalID; __le16 wTerminalType; __u8 bAssocTerminal; __u8 bCSourceID; __u8 bNrChannels; __le32 bmChannelConfig; __u8 iChannelNames; __le16 bmControls; __u8 iTerminal;} __attribute__((packed));
/* 4.7.2.5 Output terminal descriptor */
struct uac2_output_terminal_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bDescriptorSubtype; __u8 bTerminalID; __le16 wTerminalType; __u8 bAssocTerminal; __u8 bSourceID; __u8 bCSourceID; __le16 bmControls; __u8 iTerminal;} __attribute__((packed));
/* 4.7.2.8 Feature Unit Descriptor */
struct uac2_feature_unit_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bDescriptorSubtype; __u8 bUnitID; __u8 bSourceID; /* bmaControls is actually u32, * but u8 is needed for the hybrid parser */ __u8 bmaControls[]; /* variable length */} __attribute__((packed));
#define UAC2_DT_FEATURE_UNIT_SIZE(ch) (6 + ((ch) + 1) * 4)
/* As above, but more useful for defining your own descriptors: */#define DECLARE_UAC2_FEATURE_UNIT_DESCRIPTOR(ch) \struct uac2_feature_unit_descriptor_##ch { \ __u8 bLength; \ __u8 bDescriptorType; \ __u8 bDescriptorSubtype; \ __u8 bUnitID; \ __u8 bSourceID; \ __le32 bmaControls[ch + 1]; \ __u8 iFeature; \} __packed
/* 4.7.2.10 Effect Unit Descriptor */
struct uac2_effect_unit_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bDescriptorSubtype; __u8 bUnitID; __le16 wEffectType; __u8 bSourceID; __u8 bmaControls[]; /* variable length */} __attribute__((packed));
/* 4.9.2 Class-Specific AS Interface Descriptor */
struct uac2_as_header_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bDescriptorSubtype; __u8 bTerminalLink; __u8 bmControls; __u8 bFormatType; __le32 bmFormats; __u8 bNrChannels; __le32 bmChannelConfig; __u8 iChannelNames;} __attribute__((packed));
#define UAC2_FORMAT_TYPE_I_RAW_DATA (1 << 31)
/* 4.10.1.2 Class-Specific AS Isochronous Audio Data Endpoint Descriptor */
struct uac2_iso_endpoint_descriptor { __u8 bLength; /* in bytes: 8 */ __u8 bDescriptorType; /* USB_DT_CS_ENDPOINT */ __u8 bDescriptorSubtype; /* EP_GENERAL */ __u8 bmAttributes; __u8 bmControls; __u8 bLockDelayUnits; __le16 wLockDelay;} __attribute__((packed));
#define UAC2_CONTROL_PITCH (3 << 0)#define UAC2_CONTROL_DATA_OVERRUN (3 << 2)#define UAC2_CONTROL_DATA_UNDERRUN (3 << 4)
/* 5.2.5.4.2 Connector Control Parameter Block */struct uac2_connectors_ctl_blk { __u8 bNrChannels; __le32 bmChannelConfig; __u8 iChannelNames;} __attribute__((packed));
/* 6.1 Interrupt Data Message */
#define UAC2_INTERRUPT_DATA_MSG_VENDOR (1 << 0)#define UAC2_INTERRUPT_DATA_MSG_EP (1 << 1)
struct uac2_interrupt_data_msg { __u8 bInfo; __u8 bAttribute; __le16 wValue; __le16 wIndex;} __attribute__((packed));
/* A.7 Audio Function Category Codes */#define UAC2_FUNCTION_SUBCLASS_UNDEFINED 0x00#define UAC2_FUNCTION_DESKTOP_SPEAKER 0x01#define UAC2_FUNCTION_HOME_THEATER 0x02#define UAC2_FUNCTION_MICROPHONE 0x03#define UAC2_FUNCTION_HEADSET 0x04#define UAC2_FUNCTION_TELEPHONE 0x05#define UAC2_FUNCTION_CONVERTER 0x06#define UAC2_FUNCTION_SOUND_RECORDER 0x07#define UAC2_FUNCTION_IO_BOX 0x08#define UAC2_FUNCTION_MUSICAL_INSTRUMENT 0x09#define UAC2_FUNCTION_PRO_AUDIO 0x0a#define UAC2_FUNCTION_AUDIO_VIDEO 0x0b#define UAC2_FUNCTION_CONTROL_PANEL 0x0c#define UAC2_FUNCTION_OTHER 0xff
/* A.9 Audio Class-Specific AC Interface Descriptor Subtypes *//* see audio.h for the rest, which is identical to v1 */#define UAC2_EFFECT_UNIT 0x07#define UAC2_PROCESSING_UNIT_V2 0x08#define UAC2_EXTENSION_UNIT_V2 0x09#define UAC2_CLOCK_SOURCE 0x0a#define UAC2_CLOCK_SELECTOR 0x0b#define UAC2_CLOCK_MULTIPLIER 0x0c#define UAC2_SAMPLE_RATE_CONVERTER 0x0d
/* A.10 Audio Class-Specific AS Interface Descriptor Subtypes *//* see audio.h for the rest, which is identical to v1 */#define UAC2_ENCODER 0x03#define UAC2_DECODER 0x04
/* A.11 Effect Unit Effect Types */#define UAC2_EFFECT_UNDEFINED 0x00#define UAC2_EFFECT_PARAM_EQ 0x01#define UAC2_EFFECT_REVERB 0x02#define UAC2_EFFECT_MOD_DELAY 0x03#define UAC2_EFFECT_DYN_RANGE_COMP 0x04
/* A.12 Processing Unit Process Types */#define UAC2_PROCESS_UNDEFINED 0x00#define UAC2_PROCESS_UP_DOWNMIX 0x01#define UAC2_PROCESS_DOLBY_PROLOCIC 0x02#define UAC2_PROCESS_STEREO_EXTENDER 0x03
/* A.14 Audio Class-Specific Request Codes */#define UAC2_CS_CUR 0x01#define UAC2_CS_RANGE 0x02#define UAC2_CS_MEM 0x03
/* A.15 Encoder Type Codes */#define UAC2_ENCODER_UNDEFINED 0x00#define UAC2_ENCODER_OTHER 0x01#define UAC2_ENCODER_MPEG 0x02#define UAC2_ENCODER_AC3 0x03#define UAC2_ENCODER_WMA 0x04#define UAC2_ENCODER_DTS 0x05
/* A.16 Decoder Type Codes */#define UAC2_DECODER_UNDEFINED 0x00#define UAC2_DECODER_OTHER 0x01#define UAC2_DECODER_MPEG 0x02#define UAC2_DECODER_AC3 0x03#define UAC2_DECODER_WMA 0x04#define UAC2_DECODER_DTS 0x05
/* A.17.1 Clock Source Control Selectors */#define UAC2_CS_UNDEFINED 0x00#define UAC2_CS_CONTROL_SAM_FREQ 0x01#define UAC2_CS_CONTROL_CLOCK_VALID 0x02
/* A.17.2 Clock Selector Control Selectors */#define UAC2_CX_UNDEFINED 0x00#define UAC2_CX_CLOCK_SELECTOR 0x01
/* A.17.3 Clock Multiplier Control Selectors */#define UAC2_CM_UNDEFINED 0x00#define UAC2_CM_NUMERATOR 0x01#define UAC2_CM_DENOMINTATOR 0x02
/* A.17.4 Terminal Control Selectors */#define UAC2_TE_UNDEFINED 0x00#define UAC2_TE_COPY_PROTECT 0x01#define UAC2_TE_CONNECTOR 0x02#define UAC2_TE_OVERLOAD 0x03#define UAC2_TE_CLUSTER 0x04#define UAC2_TE_UNDERFLOW 0x05#define UAC2_TE_OVERFLOW 0x06#define UAC2_TE_LATENCY 0x07
/* A.17.5 Mixer Control Selectors */#define UAC2_MU_UNDEFINED 0x00#define UAC2_MU_MIXER 0x01#define UAC2_MU_CLUSTER 0x02#define UAC2_MU_UNDERFLOW 0x03#define UAC2_MU_OVERFLOW 0x04#define UAC2_MU_LATENCY 0x05
/* A.17.6 Selector Control Selectors */#define UAC2_SU_UNDEFINED 0x00#define UAC2_SU_SELECTOR 0x01#define UAC2_SU_LATENCY 0x02
/* A.17.7 Feature Unit Control Selectors *//* see audio.h for the rest, which is identical to v1 */#define UAC2_FU_INPUT_GAIN 0x0b#define UAC2_FU_INPUT_GAIN_PAD 0x0c#define UAC2_FU_PHASE_INVERTER 0x0d#define UAC2_FU_UNDERFLOW 0x0e#define UAC2_FU_OVERFLOW 0x0f#define UAC2_FU_LATENCY 0x10
/* A.17.8.1 Parametric Equalizer Section Effect Unit Control Selectors */#define UAC2_PE_UNDEFINED 0x00#define UAC2_PE_ENABLE 0x01#define UAC2_PE_CENTERFREQ 0x02#define UAC2_PE_QFACTOR 0x03#define UAC2_PE_GAIN 0x04#define UAC2_PE_UNDERFLOW 0x05#define UAC2_PE_OVERFLOW 0x06#define UAC2_PE_LATENCY 0x07
/* A.17.8.2 Reverberation Effect Unit Control Selectors */#define UAC2_RV_UNDEFINED 0x00#define UAC2_RV_ENABLE 0x01#define UAC2_RV_TYPE 0x02#define UAC2_RV_LEVEL 0x03#define UAC2_RV_TIME 0x04#define UAC2_RV_FEEDBACK 0x05#define UAC2_RV_PREDELAY 0x06#define UAC2_RV_DENSITY 0x07#define UAC2_RV_HIFREQ_ROLLOFF 0x08#define UAC2_RV_UNDERFLOW 0x09#define UAC2_RV_OVERFLOW 0x0a#define UAC2_RV_LATENCY 0x0b
/* A.17.8.3 Modulation Delay Effect Control Selectors */#define UAC2_MD_UNDEFINED 0x00#define UAC2_MD_ENABLE 0x01#define UAC2_MD_BALANCE 0x02#define UAC2_MD_RATE 0x03#define UAC2_MD_DEPTH 0x04#define UAC2_MD_TIME 0x05#define UAC2_MD_FEEDBACK 0x06#define UAC2_MD_UNDERFLOW 0x07#define UAC2_MD_OVERFLOW 0x08#define UAC2_MD_LATENCY 0x09
/* A.17.8.4 Dynamic Range Compressor Effect Unit Control Selectors */#define UAC2_DR_UNDEFINED 0x00#define UAC2_DR_ENABLE 0x01#define UAC2_DR_COMPRESSION_RATE 0x02#define UAC2_DR_MAXAMPL 0x03#define UAC2_DR_THRESHOLD 0x04#define UAC2_DR_ATTACK_TIME 0x05#define UAC2_DR_RELEASE_TIME 0x06#define UAC2_DR_UNDEFLOW 0x07#define UAC2_DR_OVERFLOW 0x08#define UAC2_DR_LATENCY 0x09
/* A.17.9.1 Up/Down-mix Processing Unit Control Selectors */#define UAC2_UD_UNDEFINED 0x00#define UAC2_UD_ENABLE 0x01#define UAC2_UD_MODE_SELECT 0x02#define UAC2_UD_CLUSTER 0x03#define UAC2_UD_UNDERFLOW 0x04#define UAC2_UD_OVERFLOW 0x05#define UAC2_UD_LATENCY 0x06
/* A.17.9.2 Dolby Prologic[tm] Processing Unit Control Selectors */#define UAC2_DP_UNDEFINED 0x00#define UAC2_DP_ENABLE 0x01#define UAC2_DP_MODE_SELECT 0x02#define UAC2_DP_CLUSTER 0x03#define UAC2_DP_UNDERFFLOW 0x04#define UAC2_DP_OVERFLOW 0x05#define UAC2_DP_LATENCY 0x06
/* A.17.9.3 Stereo Expander Processing Unit Control Selectors */#define UAC2_ST_EXT_UNDEFINED 0x00#define UAC2_ST_EXT_ENABLE 0x01#define UAC2_ST_EXT_WIDTH 0x02#define UAC2_ST_EXT_UNDEFLOW 0x03#define UAC2_ST_EXT_OVERFLOW 0x04#define UAC2_ST_EXT_LATENCY 0x05
/* A.17.10 Extension Unit Control Selectors */#define UAC2_XU_UNDEFINED 0x00#define UAC2_XU_ENABLE 0x01#define UAC2_XU_CLUSTER 0x02#define UAC2_XU_UNDERFLOW 0x03#define UAC2_XU_OVERFLOW 0x04#define UAC2_XU_LATENCY 0x05
/* A.17.11 AudioStreaming Interface Control Selectors */#define UAC2_AS_UNDEFINED 0x00#define UAC2_AS_ACT_ALT_SETTING 0x01#define UAC2_AS_VAL_ALT_SETTINGS 0x02#define UAC2_AS_AUDIO_DATA_FORMAT 0x03
/* A.17.12 Encoder Control Selectors */#define UAC2_EN_UNDEFINED 0x00#define UAC2_EN_BIT_RATE 0x01#define UAC2_EN_QUALITY 0x02#define UAC2_EN_VBR 0x03#define UAC2_EN_TYPE 0x04#define UAC2_EN_UNDERFLOW 0x05#define UAC2_EN_OVERFLOW 0x06#define UAC2_EN_ENCODER_ERROR 0x07#define UAC2_EN_PARAM1 0x08#define UAC2_EN_PARAM2 0x09#define UAC2_EN_PARAM3 0x0a#define UAC2_EN_PARAM4 0x0b#define UAC2_EN_PARAM5 0x0c#define UAC2_EN_PARAM6 0x0d#define UAC2_EN_PARAM7 0x0e#define UAC2_EN_PARAM8 0x0f
/* A.17.13.1 MPEG Decoder Control Selectors */#define UAC2_MPEG_UNDEFINED 0x00#define UAC2_MPEG_DUAL_CHANNEL 0x01#define UAC2_MPEG_SECOND_STEREO 0x02#define UAC2_MPEG_MULTILINGUAL 0x03#define UAC2_MPEG_DYN_RANGE 0x04#define UAC2_MPEG_SCALING 0x05#define UAC2_MPEG_HILO_SCALING 0x06#define UAC2_MPEG_UNDERFLOW 0x07#define UAC2_MPEG_OVERFLOW 0x08#define UAC2_MPEG_DECODER_ERROR 0x09
/* A17.13.2 AC3 Decoder Control Selectors */#define UAC2_AC3_UNDEFINED 0x00#define UAC2_AC3_MODE 0x01#define UAC2_AC3_DYN_RANGE 0x02#define UAC2_AC3_SCALING 0x03#define UAC2_AC3_HILO_SCALING 0x04#define UAC2_AC3_UNDERFLOW 0x05#define UAC2_AC3_OVERFLOW 0x06#define UAC2_AC3_DECODER_ERROR 0x07
/* A17.13.3 WMA Decoder Control Selectors */#define UAC2_WMA_UNDEFINED 0x00#define UAC2_WMA_UNDERFLOW 0x01#define UAC2_WMA_OVERFLOW 0x02#define UAC2_WMA_DECODER_ERROR 0x03
/* A17.13.4 DTS Decoder Control Selectors */#define UAC2_DTS_UNDEFINED 0x00#define UAC2_DTS_UNDERFLOW 0x01#define UAC2_DTS_OVERFLOW 0x02#define UAC2_DTS_DECODER_ERROR 0x03
/* A17.14 Endpoint Control Selectors */#define UAC2_EP_CS_UNDEFINED 0x00#define UAC2_EP_CS_PITCH 0x01#define UAC2_EP_CS_DATA_OVERRUN 0x02#define UAC2_EP_CS_DATA_UNDERRUN 0x03
#endif /* __LINUX_USB_AUDIO_V2_H */