[GitHub/mt8127/android_kernel_alcatel_ttab.git] / sound / usb / usbaudio.h

#ifndef __USBAUDIO_H
#define __USBAUDIO_H
/*
 *   (Tentative) USB Audio Driver for ALSA
 *
 *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */


/*
 */

#define USB_SUBCLASS_AUDIO_CONTROL	0x01
#define USB_SUBCLASS_AUDIO_STREAMING	0x02
#define USB_SUBCLASS_MIDI_STREAMING	0x03
#define USB_SUBCLASS_VENDOR_SPEC	0xff

#define CS_AUDIO_UNDEFINED		0x20
#define CS_AUDIO_DEVICE			0x21
#define CS_AUDIO_CONFIGURATION		0x22
#define CS_AUDIO_STRING			0x23
#define CS_AUDIO_INTERFACE		0x24
#define CS_AUDIO_ENDPOINT		0x25

#define HEADER				0x01
#define INPUT_TERMINAL			0x02
#define OUTPUT_TERMINAL			0x03
#define MIXER_UNIT			0x04
#define SELECTOR_UNIT			0x05
#define FEATURE_UNIT			0x06
#define PROCESSING_UNIT			0x07
#define EXTENSION_UNIT			0x08

#define AS_GENERAL			0x01
#define FORMAT_TYPE			0x02
#define FORMAT_SPECIFIC			0x03

#define EP_GENERAL			0x01

#define MS_GENERAL			0x01
#define MIDI_IN_JACK			0x02
#define MIDI_OUT_JACK			0x03

/* endpoint attributes */
#define EP_ATTR_MASK			0x0c
#define EP_ATTR_ASYNC			0x04
#define EP_ATTR_ADAPTIVE		0x08
#define EP_ATTR_SYNC			0x0c

/* cs endpoint attributes */
#define EP_CS_ATTR_SAMPLE_RATE		0x01
#define EP_CS_ATTR_PITCH_CONTROL	0x02
#define EP_CS_ATTR_FILL_MAX		0x80

/* Audio Class specific Request Codes */

#define SET_CUR    0x01
#define GET_CUR    0x81
#define SET_MIN    0x02
#define GET_MIN    0x82
#define SET_MAX    0x03
#define GET_MAX    0x83
#define SET_RES    0x04
#define GET_RES    0x84
#define SET_MEM    0x05
#define GET_MEM    0x85
#define GET_STAT   0xff

/* Terminal Control Selectors */

#define COPY_PROTECT_CONTROL       0x01

/* Endpoint Control Selectors */

#define SAMPLING_FREQ_CONTROL      0x01
#define PITCH_CONTROL              0x02

/* Format Types */
#define USB_FORMAT_TYPE_I	0x01
#define USB_FORMAT_TYPE_II	0x02
#define USB_FORMAT_TYPE_III	0x03

/* type I */
#define USB_AUDIO_FORMAT_PCM	0x01
#define USB_AUDIO_FORMAT_PCM8	0x02
#define USB_AUDIO_FORMAT_IEEE_FLOAT	0x03
#define USB_AUDIO_FORMAT_ALAW	0x04
#define USB_AUDIO_FORMAT_MU_LAW	0x05

/* type II */
#define USB_AUDIO_FORMAT_MPEG	0x1001
#define USB_AUDIO_FORMAT_AC3	0x1002

/* type III */
#define USB_AUDIO_FORMAT_IEC1937_AC3	0x2001
#define USB_AUDIO_FORMAT_IEC1937_MPEG1_LAYER1	0x2002
#define USB_AUDIO_FORMAT_IEC1937_MPEG2_NOEXT	0x2003
#define USB_AUDIO_FORMAT_IEC1937_MPEG2_EXT	0x2004
#define USB_AUDIO_FORMAT_IEC1937_MPEG2_LAYER1_LS	0x2005
#define USB_AUDIO_FORMAT_IEC1937_MPEG2_LAYER23_LS	0x2006


/* maximum number of endpoints per interface */
#define MIDI_MAX_ENDPOINTS 2

/* handling of USB vendor/product ID pairs as 32-bit numbers */
#define USB_ID(vendor, product) (((vendor) << 16) | (product))
#define USB_ID_VENDOR(id) ((id) >> 16)
#define USB_ID_PRODUCT(id) ((u16)(id))

/*
 */

struct snd_usb_audio {
	int index;
	struct usb_device *dev;
	struct snd_card *card;
	u32 usb_id;
	int shutdown;
	int num_interfaces;

	struct list_head pcm_list;	/* list of pcm streams */
	int pcm_devs;

	struct list_head midi_list;	/* list of midi interfaces */
	int next_midi_device;

	struct list_head mixer_list;	/* list of mixer interfaces */
};

/*
 * Information about devices with broken descriptors
 */

/* special values for .ifnum */
#define QUIRK_NO_INTERFACE		-2
#define QUIRK_ANY_INTERFACE		-1

enum quirk_type {
	QUIRK_IGNORE_INTERFACE,
	QUIRK_COMPOSITE,
	QUIRK_MIDI_STANDARD_INTERFACE,
	QUIRK_MIDI_FIXED_ENDPOINT,
	QUIRK_MIDI_YAMAHA,
	QUIRK_MIDI_MIDIMAN,
	QUIRK_MIDI_NOVATION,
	QUIRK_MIDI_RAW,
	QUIRK_MIDI_EMAGIC,
	QUIRK_MIDI_MIDITECH,
	QUIRK_AUDIO_STANDARD_INTERFACE,
	QUIRK_AUDIO_FIXED_ENDPOINT,
	QUIRK_AUDIO_EDIROL_UA700_UA25,
	QUIRK_AUDIO_EDIROL_UA1000,

	QUIRK_TYPE_COUNT
};

struct snd_usb_audio_quirk {
	const char *vendor_name;
	const char *product_name;
	int16_t ifnum;
	uint16_t type;
	const void *data;
};

/* data for QUIRK_MIDI_FIXED_ENDPOINT */
struct snd_usb_midi_endpoint_info {
	int8_t   out_ep;	/* ep number, 0 autodetect */
	uint8_t  out_interval;	/* interval for interrupt endpoints */
	int8_t   in_ep;	
	uint8_t  in_interval;
	uint16_t out_cables;	/* bitmask */
	uint16_t in_cables;	/* bitmask */
};

/* for QUIRK_MIDI_YAMAHA, data is NULL */

/* for QUIRK_MIDI_MIDIMAN, data points to a snd_usb_midi_endpoint_info
 * structure (out_cables and in_cables only) */

/* for QUIRK_COMPOSITE, data points to an array of snd_usb_audio_quirk
 * structures, terminated with .ifnum = -1 */

/* for QUIRK_AUDIO_FIXED_ENDPOINT, data points to an audioformat structure */

/* for QUIRK_AUDIO/MIDI_STANDARD_INTERFACE, data is NULL */

/* for QUIRK_AUDIO_EDIROL_UA700_UA25/UA1000, data is NULL */

/* for QUIRK_IGNORE_INTERFACE, data is NULL */

/* for QUIRK_MIDI_NOVATION and _RAW, data is NULL */

/* for QUIRK_MIDI_EMAGIC, data points to a snd_usb_midi_endpoint_info
 * structure (out_cables and in_cables only) */

/* for QUIRK_MIDI_MIDITECH, data is NULL */

/*
 */

#define combine_word(s)    ((*s) | ((unsigned int)(s)[1] << 8))
#define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
#define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))

unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size);

void *snd_usb_find_desc(void *descstart, int desclen, void *after, u8 dtype);
void *snd_usb_find_csint_desc(void *descstart, int desclen, void *after, u8 dsubtype);

int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe,
		    __u8 request, __u8 requesttype, __u16 value, __u16 index,
		    void *data, __u16 size, int timeout);

int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif);
void snd_usb_mixer_disconnect(struct list_head *p);

int snd_usb_create_midi_interface(struct snd_usb_audio *chip, struct usb_interface *iface,
				  const struct snd_usb_audio_quirk *quirk);
void snd_usbmidi_input_stop(struct list_head* p);
void snd_usbmidi_input_start(struct list_head* p);
void snd_usbmidi_disconnect(struct list_head *p);

/*
 * retrieve usb_interface descriptor from the host interface
 * (conditional for compatibility with the older API)
 */
#ifndef get_iface_desc
#define get_iface_desc(iface)	(&(iface)->desc)
#define get_endpoint(alt,ep)	(&(alt)->endpoint[ep].desc)
#define get_ep_desc(ep)		(&(ep)->desc)
#define get_cfg_desc(cfg)	(&(cfg)->desc)
#endif

#ifndef snd_usb_get_speed
#define snd_usb_get_speed(dev) ((dev)->speed)
#endif

#endif /* __USBAUDIO_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __USBAUDIO_H
	2	#define __USBAUDIO_H
	3	/*
	4	* (Tentative) USB Audio Driver for ALSA
	5	*
	6	* Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
	7	*
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*/
	23
	24
	25	/*
	26	*/
	27
	28	#define USB_SUBCLASS_AUDIO_CONTROL 0x01
	29	#define USB_SUBCLASS_AUDIO_STREAMING 0x02
	30	#define USB_SUBCLASS_MIDI_STREAMING 0x03
	31	#define USB_SUBCLASS_VENDOR_SPEC 0xff
	32
	33	#define CS_AUDIO_UNDEFINED 0x20
	34	#define CS_AUDIO_DEVICE 0x21
	35	#define CS_AUDIO_CONFIGURATION 0x22
	36	#define CS_AUDIO_STRING 0x23
	37	#define CS_AUDIO_INTERFACE 0x24
	38	#define CS_AUDIO_ENDPOINT 0x25
	39
	40	#define HEADER 0x01
	41	#define INPUT_TERMINAL 0x02
	42	#define OUTPUT_TERMINAL 0x03
	43	#define MIXER_UNIT 0x04
	44	#define SELECTOR_UNIT 0x05
	45	#define FEATURE_UNIT 0x06
	46	#define PROCESSING_UNIT 0x07
	47	#define EXTENSION_UNIT 0x08
	48
	49	#define AS_GENERAL 0x01
	50	#define FORMAT_TYPE 0x02
	51	#define FORMAT_SPECIFIC 0x03
	52
	53	#define EP_GENERAL 0x01
	54
	55	#define MS_GENERAL 0x01
	56	#define MIDI_IN_JACK 0x02
	57	#define MIDI_OUT_JACK 0x03
	58
	59	/* endpoint attributes */
	60	#define EP_ATTR_MASK 0x0c
	61	#define EP_ATTR_ASYNC 0x04
	62	#define EP_ATTR_ADAPTIVE 0x08
	63	#define EP_ATTR_SYNC 0x0c
	64
65	/* cs endpoint attributes */
66	#define EP_CS_ATTR_SAMPLE_RATE 0x01
67	#define EP_CS_ATTR_PITCH_CONTROL 0x02
68	#define EP_CS_ATTR_FILL_MAX 0x80
69
70	/* Audio Class specific Request Codes */
71
72	#define SET_CUR 0x01
73	#define GET_CUR 0x81
74	#define SET_MIN 0x02
75	#define GET_MIN 0x82
76	#define SET_MAX 0x03
77	#define GET_MAX 0x83
78	#define SET_RES 0x04
79	#define GET_RES 0x84
80	#define SET_MEM 0x05
81	#define GET_MEM 0x85
82	#define GET_STAT 0xff
83
84	/* Terminal Control Selectors */
85
86	#define COPY_PROTECT_CONTROL 0x01
87
88	/* Endpoint Control Selectors */
89
90	#define SAMPLING_FREQ_CONTROL 0x01
91	#define PITCH_CONTROL 0x02
92
93	/* Format Types */
94	#define USB_FORMAT_TYPE_I 0x01
95	#define USB_FORMAT_TYPE_II 0x02
96	#define USB_FORMAT_TYPE_III 0x03
97
98	/* type I */
99	#define USB_AUDIO_FORMAT_PCM 0x01
100	#define USB_AUDIO_FORMAT_PCM8 0x02
101	#define USB_AUDIO_FORMAT_IEEE_FLOAT 0x03
102	#define USB_AUDIO_FORMAT_ALAW 0x04
103	#define USB_AUDIO_FORMAT_MU_LAW 0x05
104
105	/* type II */
106	#define USB_AUDIO_FORMAT_MPEG 0x1001
107	#define USB_AUDIO_FORMAT_AC3 0x1002
108
109	/* type III */
110	#define USB_AUDIO_FORMAT_IEC1937_AC3 0x2001
111	#define USB_AUDIO_FORMAT_IEC1937_MPEG1_LAYER1 0x2002
112	#define USB_AUDIO_FORMAT_IEC1937_MPEG2_NOEXT 0x2003
113	#define USB_AUDIO_FORMAT_IEC1937_MPEG2_EXT 0x2004
114	#define USB_AUDIO_FORMAT_IEC1937_MPEG2_LAYER1_LS 0x2005
115	#define USB_AUDIO_FORMAT_IEC1937_MPEG2_LAYER23_LS 0x2006
116
117
118	/* maximum number of endpoints per interface */
119	#define MIDI_MAX_ENDPOINTS 2
120
27d10f56 CL	121	/* handling of USB vendor/product ID pairs as 32-bit numbers */
	122	#define USB_ID(vendor, product) (((vendor) << 16) \| (product))
	123	#define USB_ID_VENDOR(id) ((id) >> 16)
	124	#define USB_ID_PRODUCT(id) ((u16)(id))
	125
1da177e4 LT	126	/*
	127	*/
	128
1da177e4 LT	129	struct snd_usb_audio {
	130	int index;
	131	struct usb_device *dev;
86e07d34	132	struct snd_card *card;
27d10f56	133	u32 usb_id;
1da177e4 LT	134	int shutdown;
	135	int num_interfaces;
	136
	137	struct list_head pcm_list; /* list of pcm streams */
	138	int pcm_devs;
	139
	140	struct list_head midi_list; /* list of midi interfaces */
	141	int next_midi_device;
	142
84957a8a	143	struct list_head mixer_list; /* list of mixer interfaces */
1da177e4 LT	144	};
	145
	146	/*
	147	* Information about devices with broken descriptors
	148	*/
	149
	150	/* special values for .ifnum */
	151	#define QUIRK_NO_INTERFACE -2
	152	#define QUIRK_ANY_INTERFACE -1
	153
854af957 CL	154	enum quirk_type {
	155	QUIRK_IGNORE_INTERFACE,
	156	QUIRK_COMPOSITE,
	157	QUIRK_MIDI_STANDARD_INTERFACE,
	158	QUIRK_MIDI_FIXED_ENDPOINT,
	159	QUIRK_MIDI_YAMAHA,
	160	QUIRK_MIDI_MIDIMAN,
	161	QUIRK_MIDI_NOVATION,
	162	QUIRK_MIDI_RAW,
	163	QUIRK_MIDI_EMAGIC,
	164	QUIRK_MIDI_MIDITECH,
	165	QUIRK_AUDIO_STANDARD_INTERFACE,
	166	QUIRK_AUDIO_FIXED_ENDPOINT,
	167	QUIRK_AUDIO_EDIROL_UA700_UA25,
	168	QUIRK_AUDIO_EDIROL_UA1000,
	169
	170	QUIRK_TYPE_COUNT
	171	};
1da177e4	172
1da177e4 LT	173	struct snd_usb_audio_quirk {
	174	const char *vendor_name;
	175	const char *product_name;
	176	int16_t ifnum;
854af957	177	uint16_t type;
1da177e4 LT	178	const void *data;
	179	};
	180
	181	/* data for QUIRK_MIDI_FIXED_ENDPOINT */
	182	struct snd_usb_midi_endpoint_info {
	183	int8_t out_ep; /* ep number, 0 autodetect */
	184	uint8_t out_interval; /* interval for interrupt endpoints */
	185	int8_t in_ep;
	186	uint8_t in_interval;
	187	uint16_t out_cables; /* bitmask */
	188	uint16_t in_cables; /* bitmask */
	189	};
	190
	191	/* for QUIRK_MIDI_YAMAHA, data is NULL */
	192
	193	/* for QUIRK_MIDI_MIDIMAN, data points to a snd_usb_midi_endpoint_info
	194	* structure (out_cables and in_cables only) */
	195
	196	/* for QUIRK_COMPOSITE, data points to an array of snd_usb_audio_quirk
	197	* structures, terminated with .ifnum = -1 */
	198
	199	/* for QUIRK_AUDIO_FIXED_ENDPOINT, data points to an audioformat structure */
	200
	201	/* for QUIRK_AUDIO/MIDI_STANDARD_INTERFACE, data is NULL */
	202
	203	/* for QUIRK_AUDIO_EDIROL_UA700_UA25/UA1000, data is NULL */
	204
	205	/* for QUIRK_IGNORE_INTERFACE, data is NULL */
	206
6155aff8	207	/* for QUIRK_MIDI_NOVATION and _RAW, data is NULL */
1da177e4 LT	208
	209	/* for QUIRK_MIDI_EMAGIC, data points to a snd_usb_midi_endpoint_info
	210	* structure (out_cables and in_cables only) */
	211
f38275fe CL	212	/* for QUIRK_MIDI_MIDITECH, data is NULL */
f38275fe CL	213
1da177e4 LT	214	/*
	215	*/
	216
	217	#define combine_word(s) ((*s) \| ((unsigned int)(s)[1] << 8))
	218	#define combine_triple(s) (combine_word(s) \| ((unsigned int)(s)[2] << 16))
	219	#define combine_quad(s) (combine_triple(s) \| ((unsigned int)(s)[3] << 24))
	220
	221	unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size);
	222
	223	void snd_usb_find_desc(void descstart, int desclen, void *after, u8 dtype);
	224	void snd_usb_find_csint_desc(void descstart, int desclen, void *after, u8 dsubtype);
	225
86e07d34 TI	226	int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe,
	227	__u8 request, __u8 requesttype, __u16 value, __u16 index,
	228	void *data, __u16 size, int timeout);
1da177e4	229
86e07d34	230	int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif);
84957a8a	231	void snd_usb_mixer_disconnect(struct list_head *p);
1da177e4	232
86e07d34 TI	233	int snd_usb_create_midi_interface(struct snd_usb_audio chip, struct usb_interface iface,
86e07d34 TI	234	const struct snd_usb_audio_quirk *quirk);
1da177e4 LT	235	void snd_usbmidi_input_stop(struct list_head* p);
1da177e4 LT	236	void snd_usbmidi_input_start(struct list_head* p);
ee733397	237	void snd_usbmidi_disconnect(struct list_head *p);
1da177e4 LT	238
	239	/*
	240	* retrieve usb_interface descriptor from the host interface
	241	* (conditional for compatibility with the older API)
	242	*/
	243	#ifndef get_iface_desc
	244	#define get_iface_desc(iface) (&(iface)->desc)
	245	#define get_endpoint(alt,ep) (&(alt)->endpoint[ep].desc)
	246	#define get_ep_desc(ep) (&(ep)->desc)
	247	#define get_cfg_desc(cfg) (&(cfg)->desc)
	248	#endif
	249
1da177e4 LT	250	#ifndef snd_usb_get_speed
	251	#define snd_usb_get_speed(dev) ((dev)->speed)
	252	#endif
	253
	254	#endif /* __USBAUDIO_H */