[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;
	struct usb_interface *pm_intf;
	u32 usb_id;
	struct mutex mutex;
	struct rw_semaphore shutdown_rwsem;
	unsigned int shutdown:1;
	unsigned int probing:1;
	unsigned int autosuspended:1;	
	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 */
	struct list_head ep_list;	/* list of audio-related endpoints */
	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 */
	bool autoclock;			/* from the 'autoclock' module param */

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

#define usb_audio_err(chip, fmt, args...) \
	dev_err(&(chip)->dev->dev, fmt, ##args)
#define usb_audio_warn(chip, fmt, args...) \
	dev_warn(&(chip)->dev->dev, fmt, ##args)
#define usb_audio_info(chip, fmt, args...) \
	dev_info(&(chip)->dev->dev, fmt, ##args)
#define usb_audio_dbg(chip, fmt, args...) \
	dev_dbg(&(chip)->dev->dev, fmt, ##args)

/*
 * 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_AUTODETECT,
	QUIRK_MIDI_STANDARD_INTERFACE,
	QUIRK_MIDI_FIXED_ENDPOINT,
	QUIRK_MIDI_YAMAHA,
	QUIRK_MIDI_ROLAND,
	QUIRK_MIDI_MIDIMAN,
	QUIRK_MIDI_NOVATION,
	QUIRK_MIDI_RAW_BYTES,
	QUIRK_MIDI_EMAGIC,
	QUIRK_MIDI_CME,
	QUIRK_MIDI_AKAI,
	QUIRK_MIDI_US122L,
	QUIRK_MIDI_FTDI,
	QUIRK_AUDIO_STANDARD_INTERFACE,
	QUIRK_AUDIO_FIXED_ENDPOINT,
	QUIRK_AUDIO_EDIROL_UAXX,
	QUIRK_AUDIO_ALIGN_TRANSFER,
	QUIRK_AUDIO_STANDARD_MIXER,

	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;
88a8516a	37	struct usb_interface *pm_intf;
27d10f56	38	u32 usb_id;
596580d0	39	struct mutex mutex;
34f3c89f	40	struct rw_semaphore shutdown_rwsem;
88a8516a ON	41	unsigned int shutdown:1;
	42	unsigned int probing:1;
	43	unsigned int autosuspended:1;
98e89f60	44	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
88a8516a	45
1da177e4	46	int num_interfaces;
f85bf29c	47	int num_suspended_intf;
1da177e4 LT	48
1da177e4 LT	49	struct list_head pcm_list; /* list of pcm streams */
8fdff6a3	50	struct list_head ep_list; /* list of audio-related endpoints */
1da177e4 LT	51	int pcm_devs;
	52
	53	struct list_head midi_list; /* list of midi interfaces */
1da177e4	54
84957a8a	55	struct list_head mixer_list; /* list of mixer interfaces */
e5779998 DM	56
e5779998 DM	57	int setup; /* from the 'device_setup' module param */
ef02e29b	58	bool autoclock; /* from the 'autoclock' module param */
79f920fb DM	59
79f920fb DM	60	struct usb_host_interface ctrl_intf; / the audio control interface */
1da177e4 LT	61	};
1da177e4 LT	62
0ba41d91 TI	63	#define usb_audio_err(chip, fmt, args...) \
	64	dev_err(&(chip)->dev->dev, fmt, ##args)
	65	#define usb_audio_warn(chip, fmt, args...) \
	66	dev_warn(&(chip)->dev->dev, fmt, ##args)
	67	#define usb_audio_info(chip, fmt, args...) \
	68	dev_info(&(chip)->dev->dev, fmt, ##args)
	69	#define usb_audio_dbg(chip, fmt, args...) \
	70	dev_dbg(&(chip)->dev->dev, fmt, ##args)
	71
1da177e4 LT	72	/*
	73	* Information about devices with broken descriptors
	74	*/
	75
	76	/* special values for .ifnum */
	77	#define QUIRK_NO_INTERFACE -2
	78	#define QUIRK_ANY_INTERFACE -1
	79
854af957 CL	80	enum quirk_type {
	81	QUIRK_IGNORE_INTERFACE,
	82	QUIRK_COMPOSITE,
aafe77cc	83	QUIRK_AUTODETECT,
854af957 CL	84	QUIRK_MIDI_STANDARD_INTERFACE,
	85	QUIRK_MIDI_FIXED_ENDPOINT,
	86	QUIRK_MIDI_YAMAHA,
aafe77cc	87	QUIRK_MIDI_ROLAND,
854af957 CL	88	QUIRK_MIDI_MIDIMAN,
854af957 CL	89	QUIRK_MIDI_NOVATION,
c7f57216	90	QUIRK_MIDI_RAW_BYTES,
854af957	91	QUIRK_MIDI_EMAGIC,
cc7a59bd	92	QUIRK_MIDI_CME,
4434ade8	93	QUIRK_MIDI_AKAI,
030a07e4	94	QUIRK_MIDI_US122L,
1ef0e0a0	95	QUIRK_MIDI_FTDI,
854af957 CL	96	QUIRK_AUDIO_STANDARD_INTERFACE,
854af957 CL	97	QUIRK_AUDIO_FIXED_ENDPOINT,
310e0dc0	98	QUIRK_AUDIO_EDIROL_UAXX,
52a7a583	99	QUIRK_AUDIO_ALIGN_TRANSFER,
014950b0	100	QUIRK_AUDIO_STANDARD_MIXER,
854af957 CL	101
	102	QUIRK_TYPE_COUNT
	103	};
1da177e4	104
1da177e4 LT	105	struct snd_usb_audio_quirk {
	106	const char *vendor_name;
	107	const char *product_name;
	108	int16_t ifnum;
854af957	109	uint16_t type;
1da177e4 LT	110	const void *data;
	111	};
	112
f4950882	113	#define combine_word(s) ((*(s)) \| ((unsigned int)(s)[1] << 8))
1da177e4 LT	114	#define combine_triple(s) (combine_word(s) \| ((unsigned int)(s)[2] << 16))
	115	#define combine_quad(s) (combine_triple(s) \| ((unsigned int)(s)[3] << 24))
	116
1da177e4	117	#endif /* __USBAUDIO_H */