[mirror_ubuntu-artful-kernel.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
 */

/* 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;
	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
	int num_interfaces;
	int num_suspended_intf;

	/* for audio class v2 */
	int clock_id;

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

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

	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_FASTLANE,
	QUIRK_MIDI_EMAGIC,
	QUIRK_MIDI_CME,
	QUIRK_MIDI_US122L,
	QUIRK_AUDIO_STANDARD_INTERFACE,
	QUIRK_AUDIO_FIXED_ENDPOINT,
	QUIRK_AUDIO_EDIROL_UAXX,
	QUIRK_AUDIO_ALIGN_TRANSFER,

	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;
};

/*
 */

/*E-mu USB samplerate control quirk*/
enum {
	EMU_QUIRK_SR_44100HZ = 0,
	EMU_QUIRK_SR_48000HZ,
	EMU_QUIRK_SR_88200HZ,
	EMU_QUIRK_SR_96000HZ,
	EMU_QUIRK_SR_176400HZ,
	EMU_QUIRK_SR_192000HZ
};

#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);

/*
 * 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
27d10f56 CL	24	/* handling of USB vendor/product ID pairs as 32-bit numbers */
	25	#define USB_ID(vendor, product) (((vendor) << 16) \| (product))
	26	#define USB_ID_VENDOR(id) ((id) >> 16)
	27	#define USB_ID_PRODUCT(id) ((u16)(id))
	28
1da177e4 LT	29	/*
	30	*/
	31
1da177e4 LT	32	struct snd_usb_audio {
	33	int index;
	34	struct usb_device *dev;
86e07d34	35	struct snd_card *card;
27d10f56	36	u32 usb_id;
1da177e4	37	int shutdown;
98e89f60	38	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
1da177e4	39	int num_interfaces;
f85bf29c	40	int num_suspended_intf;
1da177e4	41
53ee98fe DM	42	/* for audio class v2 */
	43	int clock_id;
	44
1da177e4 LT	45	struct list_head pcm_list; /* list of pcm streams */
	46	int pcm_devs;
	47
	48	struct list_head midi_list; /* list of midi interfaces */
1da177e4	49
84957a8a	50	struct list_head mixer_list; /* list of mixer interfaces */
1da177e4 LT	51	};
	52
	53	/*
	54	* Information about devices with broken descriptors
	55	*/
	56
	57	/* special values for .ifnum */
	58	#define QUIRK_NO_INTERFACE -2
	59	#define QUIRK_ANY_INTERFACE -1
	60
854af957 CL	61	enum quirk_type {
	62	QUIRK_IGNORE_INTERFACE,
	63	QUIRK_COMPOSITE,
	64	QUIRK_MIDI_STANDARD_INTERFACE,
	65	QUIRK_MIDI_FIXED_ENDPOINT,
	66	QUIRK_MIDI_YAMAHA,
	67	QUIRK_MIDI_MIDIMAN,
	68	QUIRK_MIDI_NOVATION,
55de5ef9	69	QUIRK_MIDI_FASTLANE,
854af957	70	QUIRK_MIDI_EMAGIC,
cc7a59bd	71	QUIRK_MIDI_CME,
030a07e4	72	QUIRK_MIDI_US122L,
854af957 CL	73	QUIRK_AUDIO_STANDARD_INTERFACE,
854af957 CL	74	QUIRK_AUDIO_FIXED_ENDPOINT,
310e0dc0	75	QUIRK_AUDIO_EDIROL_UAXX,
52a7a583	76	QUIRK_AUDIO_ALIGN_TRANSFER,
854af957 CL	77
	78	QUIRK_TYPE_COUNT
	79	};
1da177e4	80
1da177e4 LT	81	struct snd_usb_audio_quirk {
	82	const char *vendor_name;
	83	const char *product_name;
	84	int16_t ifnum;
854af957	85	uint16_t type;
1da177e4 LT	86	const void *data;
	87	};
	88
1da177e4 LT	89	/*
	90	*/
	91
7d2b451e SK	92	/E-mu USB samplerate control quirk/
	93	enum {
	94	EMU_QUIRK_SR_44100HZ = 0,
	95	EMU_QUIRK_SR_48000HZ,
	96	EMU_QUIRK_SR_88200HZ,
	97	EMU_QUIRK_SR_96000HZ,
	98	EMU_QUIRK_SR_176400HZ,
	99	EMU_QUIRK_SR_192000HZ
	100	};
	101
f4950882	102	#define combine_word(s) ((*(s)) \| ((unsigned int)(s)[1] << 8))
1da177e4 LT	103	#define combine_triple(s) (combine_word(s) \| ((unsigned int)(s)[2] << 16))
	104	#define combine_quad(s) (combine_triple(s) \| ((unsigned int)(s)[3] << 24))
	105
	106	unsigned int snd_usb_combine_bytes(unsigned char *bytes, int size);
	107
	108	void snd_usb_find_desc(void descstart, int desclen, void *after, u8 dtype);
	109	void snd_usb_find_csint_desc(void descstart, int desclen, void *after, u8 dsubtype);
	110
86e07d34 TI	111	int snd_usb_ctl_msg(struct usb_device *dev, unsigned int pipe,
	112	__u8 request, __u8 requesttype, __u16 value, __u16 index,
	113	void *data, __u16 size, int timeout);
1da177e4	114
1da177e4 LT	115	/*
	116	* retrieve usb_interface descriptor from the host interface
	117	* (conditional for compatibility with the older API)
	118	*/
	119	#ifndef get_iface_desc
	120	#define get_iface_desc(iface) (&(iface)->desc)
	121	#define get_endpoint(alt,ep) (&(alt)->endpoint[ep].desc)
	122	#define get_ep_desc(ep) (&(ep)->desc)
	123	#define get_cfg_desc(cfg) (&(cfg)->desc)
	124	#endif
	125
1da177e4 LT	126	#ifndef snd_usb_get_speed
	127	#define snd_usb_get_speed(dev) ((dev)->speed)
	128	#endif
	129
	130	#endif /* __USBAUDIO_H */