[deliverable/linux.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;
	struct mutex shutdown_mutex;
	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
	int num_interfaces;
	int num_suspended_intf;

	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 */

	int setup;			/* from the 'device_setup' module param */
	int nrpacks;			/* from the 'nrpacks' module param */
	int async_unlink;		/* from the 'async_unlink' module param */

	struct usb_host_interface *ctrl_intf;	/* the audio control interface */
};

/*
 * 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_BYTES,
	QUIRK_MIDI_EMAGIC,
	QUIRK_MIDI_CME,
	QUIRK_MIDI_AKAI,
	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;
};

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

#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	29	/*
e5779998	30	*
1da177e4 LT	31	*/
1da177e4 LT	32
1da177e4 LT	33	struct snd_usb_audio {
	34	int index;
	35	struct usb_device *dev;
86e07d34	36	struct snd_card *card;
27d10f56	37	u32 usb_id;
1da177e4	38	int shutdown;
382225e6	39	struct mutex shutdown_mutex;
98e89f60	40	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
1da177e4	41	int num_interfaces;
f85bf29c	42	int num_suspended_intf;
1da177e4 LT	43
	44	struct list_head pcm_list; /* list of pcm streams */
	45	int pcm_devs;
	46
	47	struct list_head midi_list; /* list of midi interfaces */
1da177e4	48
84957a8a	49	struct list_head mixer_list; /* list of mixer interfaces */
e5779998 DM	50
	51	int setup; /* from the 'device_setup' module param */
	52	int nrpacks; /* from the 'nrpacks' module param */
	53	int async_unlink; /* from the 'async_unlink' module param */
79f920fb DM	54
79f920fb DM	55	struct usb_host_interface ctrl_intf; / the audio control interface */
1da177e4 LT	56	};
	57
	58	/*
	59	* Information about devices with broken descriptors
	60	*/
	61
	62	/* special values for .ifnum */
	63	#define QUIRK_NO_INTERFACE -2
	64	#define QUIRK_ANY_INTERFACE -1
	65
854af957 CL	66	enum quirk_type {
	67	QUIRK_IGNORE_INTERFACE,
	68	QUIRK_COMPOSITE,
	69	QUIRK_MIDI_STANDARD_INTERFACE,
	70	QUIRK_MIDI_FIXED_ENDPOINT,
	71	QUIRK_MIDI_YAMAHA,
	72	QUIRK_MIDI_MIDIMAN,
	73	QUIRK_MIDI_NOVATION,
c7f57216	74	QUIRK_MIDI_RAW_BYTES,
854af957	75	QUIRK_MIDI_EMAGIC,
cc7a59bd	76	QUIRK_MIDI_CME,
4434ade8	77	QUIRK_MIDI_AKAI,
030a07e4	78	QUIRK_MIDI_US122L,
854af957 CL	79	QUIRK_AUDIO_STANDARD_INTERFACE,
854af957 CL	80	QUIRK_AUDIO_FIXED_ENDPOINT,
310e0dc0	81	QUIRK_AUDIO_EDIROL_UAXX,
52a7a583	82	QUIRK_AUDIO_ALIGN_TRANSFER,
854af957 CL	83
	84	QUIRK_TYPE_COUNT
	85	};
1da177e4	86
1da177e4 LT	87	struct snd_usb_audio_quirk {
	88	const char *vendor_name;
	89	const char *product_name;
	90	int16_t ifnum;
854af957	91	uint16_t type;
1da177e4 LT	92	const void *data;
	93	};
	94
f4950882	95	#define combine_word(s) ((*(s)) \| ((unsigned int)(s)[1] << 8))
1da177e4 LT	96	#define combine_triple(s) (combine_word(s) \| ((unsigned int)(s)[2] << 16))
	97	#define combine_quad(s) (combine_triple(s) \| ((unsigned int)(s)[3] << 24))
	98
1da177e4	99	#endif /* __USBAUDIO_H */