[mirror_ubuntu-bionic-kernel.git] / include / linux / usb / audio-v2.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2010 Daniel Mack <daniel@caiaq.de>
 *
 * This software is distributed under the terms of the GNU General Public
 * License ("GPL") version 2, as published by the Free Software Foundation.
 *
 * 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 uac2_control_is_readable(u32 bmControls, u8 control)
{
	return (bmControls >> (control * 2)) & 0x1;
}

static inline bool uac2_control_is_writeable(u32 bmControls, u8 control)
{
	return (bmControls >> (control * 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 Source Descriptor */

struct uac_clock_selector_descriptor {
	__u8 bLength;
	__u8 bDescriptorType;
	__u8 bDescriptorSubtype;
	__u8 bClockID;
	__u8 bNrInPins;
	__u8 baCSourceID[];
	/* bmControls, bAssocTerminal and iClockSource 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[0]; /* 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)

/* 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 */
Commit	Line	Data
5fd54ace	1	// SPDX-License-Identifier: GPL-2.0
7e847894 DM	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
157a57b6 DM	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
dcbe7bcf DM	37	static inline bool uac2_control_is_readable(u32 bmControls, u8 control)
	38	{
	39	return (bmControls >> (control * 2)) & 0x1;
	40	}
	41
	42	static inline bool uac2_control_is_writeable(u32 bmControls, u8 control)
	43	{
	44	return (bmControls >> (control * 2)) & 0x2;
	45	}
	46
0d4e1b2a JB	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
7e847894 DM	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
5dd360eb DM	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
7e847894 DM	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;
7e847894	96	__u8 baCSourceID[];
5dd360eb DM	97	/* bmControls, bAssocTerminal 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;
7e847894 DM	110	} __attribute__((packed));
7e847894 DM	111
23caaf19 DM	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;
8bd226f9	119	__le16 wTerminalType;
23caaf19 DM	120	__u8 bAssocTerminal;
	121	__u8 bCSourceID;
	122	__u8 bNrChannels;
8bd226f9	123	__le32 bmChannelConfig;
23caaf19	124	__u8 iChannelNames;
8bd226f9	125	__le16 bmControls;
23caaf19 DM	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;
8bd226f9	136	__le16 wTerminalType;
23caaf19 DM	137	__u8 bAssocTerminal;
	138	__u8 bSourceID;
	139	__u8 bCSourceID;
8bd226f9	140	__le16 bmControls;
23caaf19 DM	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
7e847894 DM	159	/* 4.9.2 Class-Specific AS Interface Descriptor */
7e847894 DM	160
69da9bcb	161	struct uac2_as_header_descriptor {
7e847894 DM	162	__u8 bLength;
	163	__u8 bDescriptorType;
	164	__u8 bDescriptorSubtype;
	165	__u8 bTerminalLink;
	166	__u8 bmControls;
	167	__u8 bFormatType;
8bd226f9	168	__le32 bmFormats;
7e847894	169	__u8 bNrChannels;
8bd226f9	170	__le32 bmChannelConfig;
7e847894 DM	171	__u8 iChannelNames;
	172	} __attribute__((packed));
	173
717bfb5f DM	174	#define UAC2_FORMAT_TYPE_I_RAW_DATA (1 << 31)
717bfb5f DM	175
43b8e3bc DM	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
e213e9cf DM	192	/* 6.1 Interrupt Data Message */
	193
	194	#define UAC2_INTERRUPT_DATA_MSG_VENDOR (1 << 0)
	195	#define UAC2_INTERRUPT_DATA_MSG_EP (1 << 1)
	196
	197	struct uac2_interrupt_data_msg {
	198	__u8 bInfo;
	199	__u8 bAttribute;
	200	__le16 wValue;
	201	__le16 wIndex;
	202	} __attribute__((packed));
7e847894 DM	203
	204	/* A.7 Audio Function Category Codes */
	205	#define UAC2_FUNCTION_SUBCLASS_UNDEFINED 0x00
	206	#define UAC2_FUNCTION_DESKTOP_SPEAKER 0x01
	207	#define UAC2_FUNCTION_HOME_THEATER 0x02
	208	#define UAC2_FUNCTION_MICROPHONE 0x03
	209	#define UAC2_FUNCTION_HEADSET 0x04
	210	#define UAC2_FUNCTION_TELEPHONE 0x05
	211	#define UAC2_FUNCTION_CONVERTER 0x06
	212	#define UAC2_FUNCTION_SOUND_RECORDER 0x07
	213	#define UAC2_FUNCTION_IO_BOX 0x08
	214	#define UAC2_FUNCTION_MUSICAL_INSTRUMENT 0x09
	215	#define UAC2_FUNCTION_PRO_AUDIO 0x0a
	216	#define UAC2_FUNCTION_AUDIO_VIDEO 0x0b
	217	#define UAC2_FUNCTION_CONTROL_PANEL 0x0c
	218	#define UAC2_FUNCTION_OTHER 0xff
	219
	220	/* A.9 Audio Class-Specific AC Interface Descriptor Subtypes */
	221	/* see audio.h for the rest, which is identical to v1 */
	222	#define UAC2_EFFECT_UNIT 0x07
	223	#define UAC2_PROCESSING_UNIT_V2 0x08
	224	#define UAC2_EXTENSION_UNIT_V2 0x09
	225	#define UAC2_CLOCK_SOURCE 0x0a
	226	#define UAC2_CLOCK_SELECTOR 0x0b
	227	#define UAC2_CLOCK_MULTIPLIER 0x0c
	228	#define UAC2_SAMPLE_RATE_CONVERTER 0x0d
	229
	230	/* A.10 Audio Class-Specific AS Interface Descriptor Subtypes */
	231	/* see audio.h for the rest, which is identical to v1 */
	232	#define UAC2_ENCODER 0x03
	233	#define UAC2_DECODER 0x04
	234
	235	/* A.11 Effect Unit Effect Types */
	236	#define UAC2_EFFECT_UNDEFINED 0x00
	237	#define UAC2_EFFECT_PARAM_EQ 0x01
	238	#define UAC2_EFFECT_REVERB 0x02
	239	#define UAC2_EFFECT_MOD_DELAY 0x03
	240	#define UAC2_EFFECT_DYN_RANGE_COMP 0x04
	241
	242	/* A.12 Processing Unit Process Types */
	243	#define UAC2_PROCESS_UNDEFINED 0x00
	244	#define UAC2_PROCESS_UP_DOWNMIX 0x01
	245	#define UAC2_PROCESS_DOLBY_PROLOCIC 0x02
	246	#define UAC2_PROCESS_STEREO_EXTENDER 0x03
	247
	248	/* A.14 Audio Class-Specific Request Codes */
	249	#define UAC2_CS_CUR 0x01
	250	#define UAC2_CS_RANGE 0x02
e213e9cf	251	#define UAC2_CS_MEM 0x03
7e847894 DM	252
	253	/* A.15 Encoder Type Codes */
	254	#define UAC2_ENCODER_UNDEFINED 0x00
	255	#define UAC2_ENCODER_OTHER 0x01
	256	#define UAC2_ENCODER_MPEG 0x02
	257	#define UAC2_ENCODER_AC3 0x03
	258	#define UAC2_ENCODER_WMA 0x04
	259	#define UAC2_ENCODER_DTS 0x05
	260
	261	/* A.16 Decoder Type Codes */
	262	#define UAC2_DECODER_UNDEFINED 0x00
	263	#define UAC2_DECODER_OTHER 0x01
	264	#define UAC2_DECODER_MPEG 0x02
	265	#define UAC2_DECODER_AC3 0x03
	266	#define UAC2_DECODER_WMA 0x04
	267	#define UAC2_DECODER_DTS 0x05
	268
	269	/* A.17.1 Clock Source Control Selectors */
	270	#define UAC2_CS_UNDEFINED 0x00
	271	#define UAC2_CS_CONTROL_SAM_FREQ 0x01
	272	#define UAC2_CS_CONTROL_CLOCK_VALID 0x02
	273
	274	/* A.17.2 Clock Selector Control Selectors */
	275	#define UAC2_CX_UNDEFINED 0x00
	276	#define UAC2_CX_CLOCK_SELECTOR 0x01
	277
	278	/* A.17.3 Clock Multiplier Control Selectors */
	279	#define UAC2_CM_UNDEFINED 0x00
	280	#define UAC2_CM_NUMERATOR 0x01
	281	#define UAC2_CM_DENOMINTATOR 0x02
	282
	283	/* A.17.4 Terminal Control Selectors */
	284	#define UAC2_TE_UNDEFINED 0x00
	285	#define UAC2_TE_COPY_PROTECT 0x01
	286	#define UAC2_TE_CONNECTOR 0x02
	287	#define UAC2_TE_OVERLOAD 0x03
	288	#define UAC2_TE_CLUSTER 0x04
	289	#define UAC2_TE_UNDERFLOW 0x05
	290	#define UAC2_TE_OVERFLOW 0x06
	291	#define UAC2_TE_LATENCY 0x07
	292
	293	/* A.17.5 Mixer Control Selectors */
	294	#define UAC2_MU_UNDEFINED 0x00
	295	#define UAC2_MU_MIXER 0x01
	296	#define UAC2_MU_CLUSTER 0x02
	297	#define UAC2_MU_UNDERFLOW 0x03
	298	#define UAC2_MU_OVERFLOW 0x04
	299	#define UAC2_MU_LATENCY 0x05
	300
	301	/* A.17.6 Selector Control Selectors */
	302	#define UAC2_SU_UNDEFINED 0x00
	303	#define UAC2_SU_SELECTOR 0x01
	304	#define UAC2_SU_LATENCY 0x02
	305
	306	/* A.17.7 Feature Unit Control Selectors */
	307	/* see audio.h for the rest, which is identical to v1 */
	308	#define UAC2_FU_INPUT_GAIN 0x0b
	309	#define UAC2_FU_INPUT_GAIN_PAD 0x0c
	310	#define UAC2_FU_PHASE_INVERTER 0x0d
	311	#define UAC2_FU_UNDERFLOW 0x0e
	312	#define UAC2_FU_OVERFLOW 0x0f
	313	#define UAC2_FU_LATENCY 0x10
	314
	315	/* A.17.8.1 Parametric Equalizer Section Effect Unit Control Selectors */
316	#define UAC2_PE_UNDEFINED 0x00
317	#define UAC2_PE_ENABLE 0x01
318	#define UAC2_PE_CENTERFREQ 0x02
319	#define UAC2_PE_QFACTOR 0x03
320	#define UAC2_PE_GAIN 0x04
321	#define UAC2_PE_UNDERFLOW 0x05
322	#define UAC2_PE_OVERFLOW 0x06
323	#define UAC2_PE_LATENCY 0x07
324
325	/* A.17.8.2 Reverberation Effect Unit Control Selectors */
326	#define UAC2_RV_UNDEFINED 0x00
327	#define UAC2_RV_ENABLE 0x01
328	#define UAC2_RV_TYPE 0x02
329	#define UAC2_RV_LEVEL 0x03
330	#define UAC2_RV_TIME 0x04
331	#define UAC2_RV_FEEDBACK 0x05
332	#define UAC2_RV_PREDELAY 0x06
333	#define UAC2_RV_DENSITY 0x07
334	#define UAC2_RV_HIFREQ_ROLLOFF 0x08
335	#define UAC2_RV_UNDERFLOW 0x09
336	#define UAC2_RV_OVERFLOW 0x0a
337	#define UAC2_RV_LATENCY 0x0b
338
339	/* A.17.8.3 Modulation Delay Effect Control Selectors */
340	#define UAC2_MD_UNDEFINED 0x00
341	#define UAC2_MD_ENABLE 0x01
342	#define UAC2_MD_BALANCE 0x02
343	#define UAC2_MD_RATE 0x03
344	#define UAC2_MD_DEPTH 0x04
345	#define UAC2_MD_TIME 0x05
346	#define UAC2_MD_FEEDBACK 0x06
347	#define UAC2_MD_UNDERFLOW 0x07
348	#define UAC2_MD_OVERFLOW 0x08
349	#define UAC2_MD_LATENCY 0x09
350
351	/* A.17.8.4 Dynamic Range Compressor Effect Unit Control Selectors */
352	#define UAC2_DR_UNDEFINED 0x00
353	#define UAC2_DR_ENABLE 0x01
354	#define UAC2_DR_COMPRESSION_RATE 0x02
355	#define UAC2_DR_MAXAMPL 0x03
356	#define UAC2_DR_THRESHOLD 0x04
357	#define UAC2_DR_ATTACK_TIME 0x05
358	#define UAC2_DR_RELEASE_TIME 0x06
359	#define UAC2_DR_UNDEFLOW 0x07
360	#define UAC2_DR_OVERFLOW 0x08
361	#define UAC2_DR_LATENCY 0x09
362
363	/* A.17.9.1 Up/Down-mix Processing Unit Control Selectors */
364	#define UAC2_UD_UNDEFINED 0x00
365	#define UAC2_UD_ENABLE 0x01
366	#define UAC2_UD_MODE_SELECT 0x02
367	#define UAC2_UD_CLUSTER 0x03
368	#define UAC2_UD_UNDERFLOW 0x04
369	#define UAC2_UD_OVERFLOW 0x05
370	#define UAC2_UD_LATENCY 0x06
371
372	/* A.17.9.2 Dolby Prologic[tm] Processing Unit Control Selectors */
373	#define UAC2_DP_UNDEFINED 0x00
374	#define UAC2_DP_ENABLE 0x01
375	#define UAC2_DP_MODE_SELECT 0x02
376	#define UAC2_DP_CLUSTER 0x03
377	#define UAC2_DP_UNDERFFLOW 0x04
378	#define UAC2_DP_OVERFLOW 0x05
379	#define UAC2_DP_LATENCY 0x06
380
381	/* A.17.9.3 Stereo Expander Processing Unit Control Selectors */
382	#define UAC2_ST_EXT_UNDEFINED 0x00
383	#define UAC2_ST_EXT_ENABLE 0x01
384	#define UAC2_ST_EXT_WIDTH 0x02
385	#define UAC2_ST_EXT_UNDEFLOW 0x03
386	#define UAC2_ST_EXT_OVERFLOW 0x04
387	#define UAC2_ST_EXT_LATENCY 0x05
388
389	/* A.17.10 Extension Unit Control Selectors */
390	#define UAC2_XU_UNDEFINED 0x00
391	#define UAC2_XU_ENABLE 0x01
392	#define UAC2_XU_CLUSTER 0x02
393	#define UAC2_XU_UNDERFLOW 0x03
394	#define UAC2_XU_OVERFLOW 0x04
395	#define UAC2_XU_LATENCY 0x05
396
397	/* A.17.11 AudioStreaming Interface Control Selectors */
398	#define UAC2_AS_UNDEFINED 0x00
399	#define UAC2_AS_ACT_ALT_SETTING 0x01
400	#define UAC2_AS_VAL_ALT_SETTINGS 0x02
401	#define UAC2_AS_AUDIO_DATA_FORMAT 0x03
402
403	/* A.17.12 Encoder Control Selectors */
404	#define UAC2_EN_UNDEFINED 0x00
405	#define UAC2_EN_BIT_RATE 0x01
406	#define UAC2_EN_QUALITY 0x02
407	#define UAC2_EN_VBR 0x03
408	#define UAC2_EN_TYPE 0x04
409	#define UAC2_EN_UNDERFLOW 0x05
410	#define UAC2_EN_OVERFLOW 0x06
411	#define UAC2_EN_ENCODER_ERROR 0x07
412	#define UAC2_EN_PARAM1 0x08
413	#define UAC2_EN_PARAM2 0x09
414	#define UAC2_EN_PARAM3 0x0a
415	#define UAC2_EN_PARAM4 0x0b
416	#define UAC2_EN_PARAM5 0x0c
417	#define UAC2_EN_PARAM6 0x0d
418	#define UAC2_EN_PARAM7 0x0e
419	#define UAC2_EN_PARAM8 0x0f
420
421	/* A.17.13.1 MPEG Decoder Control Selectors */
422	#define UAC2_MPEG_UNDEFINED 0x00
423	#define UAC2_MPEG_DUAL_CHANNEL 0x01
424	#define UAC2_MPEG_SECOND_STEREO 0x02
425	#define UAC2_MPEG_MULTILINGUAL 0x03
426	#define UAC2_MPEG_DYN_RANGE 0x04
427	#define UAC2_MPEG_SCALING 0x05
428	#define UAC2_MPEG_HILO_SCALING 0x06
429	#define UAC2_MPEG_UNDERFLOW 0x07
430	#define UAC2_MPEG_OVERFLOW 0x08
431	#define UAC2_MPEG_DECODER_ERROR 0x09
432
433	/* A17.13.2 AC3 Decoder Control Selectors */
434	#define UAC2_AC3_UNDEFINED 0x00
435	#define UAC2_AC3_MODE 0x01
436	#define UAC2_AC3_DYN_RANGE 0x02
437	#define UAC2_AC3_SCALING 0x03
438	#define UAC2_AC3_HILO_SCALING 0x04
439	#define UAC2_AC3_UNDERFLOW 0x05
440	#define UAC2_AC3_OVERFLOW 0x06
441	#define UAC2_AC3_DECODER_ERROR 0x07
442
443	/* A17.13.3 WMA Decoder Control Selectors */
444	#define UAC2_WMA_UNDEFINED 0x00
445	#define UAC2_WMA_UNDERFLOW 0x01
446	#define UAC2_WMA_OVERFLOW 0x02
447	#define UAC2_WMA_DECODER_ERROR 0x03
448
449	/* A17.13.4 DTS Decoder Control Selectors */
450	#define UAC2_DTS_UNDEFINED 0x00
451	#define UAC2_DTS_UNDERFLOW 0x01
452	#define UAC2_DTS_OVERFLOW 0x02
453	#define UAC2_DTS_DECODER_ERROR 0x03
454
455	/* A17.14 Endpoint Control Selectors */
456	#define UAC2_EP_CS_UNDEFINED 0x00
457	#define UAC2_EP_CS_PITCH 0x01
458	#define UAC2_EP_CS_DATA_OVERRUN 0x02
459	#define UAC2_EP_CS_DATA_UNDERRUN 0x03
460
461	#endif /* __LINUX_USB_AUDIO_V2_H */
462