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/* 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
29/*
30 *
31 */
32
33struct snd_usb_audio {
34	int index;
35	struct usb_device *dev;
36	struct snd_card *card;
37	struct usb_interface *pm_intf;
38	u32 usb_id;
39	struct mutex mutex;
40	unsigned int autosuspended:1;
41	atomic_t active;
42	atomic_t shutdown;
43	atomic_t usage_count;
44	wait_queue_head_t shutdown_wait;
45	unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
46	unsigned int tx_length_quirk:1; /* Put length specifier in transfers */
47
48	int num_interfaces;
49	int num_suspended_intf;
50
51	struct list_head pcm_list;	/* list of pcm streams */
52	struct list_head ep_list;	/* list of audio-related endpoints */
53	int pcm_devs;
54
55	struct list_head midi_list;	/* list of midi interfaces */
56
57	struct list_head mixer_list;	/* list of mixer interfaces */
58
59	int setup;			/* from the 'device_setup' module param */
60	bool autoclock;			/* from the 'autoclock' module param */
61
62	struct usb_host_interface *ctrl_intf;	/* the audio control interface */
63};
64
65#define usb_audio_err(chip, fmt, args...) \
66	dev_err(&(chip)->dev->dev, fmt, ##args)
67#define usb_audio_warn(chip, fmt, args...) \
68	dev_warn(&(chip)->dev->dev, fmt, ##args)
69#define usb_audio_info(chip, fmt, args...) \
70	dev_info(&(chip)->dev->dev, fmt, ##args)
71#define usb_audio_dbg(chip, fmt, args...) \
72	dev_dbg(&(chip)->dev->dev, fmt, ##args)
73
74/*
75 * Information about devices with broken descriptors
76 */
77
78/* special values for .ifnum */
79#define QUIRK_NO_INTERFACE		-2
80#define QUIRK_ANY_INTERFACE		-1
81
82enum quirk_type {
83	QUIRK_IGNORE_INTERFACE,
84	QUIRK_COMPOSITE,
85	QUIRK_AUTODETECT,
86	QUIRK_MIDI_STANDARD_INTERFACE,
87	QUIRK_MIDI_FIXED_ENDPOINT,
88	QUIRK_MIDI_YAMAHA,
89	QUIRK_MIDI_ROLAND,
90	QUIRK_MIDI_MIDIMAN,
91	QUIRK_MIDI_NOVATION,
92	QUIRK_MIDI_RAW_BYTES,
93	QUIRK_MIDI_EMAGIC,
94	QUIRK_MIDI_CME,
95	QUIRK_MIDI_AKAI,
96	QUIRK_MIDI_US122L,
97	QUIRK_MIDI_FTDI,
98	QUIRK_MIDI_CH345,
99	QUIRK_AUDIO_STANDARD_INTERFACE,
100	QUIRK_AUDIO_FIXED_ENDPOINT,
101	QUIRK_AUDIO_EDIROL_UAXX,
102	QUIRK_AUDIO_ALIGN_TRANSFER,
103	QUIRK_AUDIO_STANDARD_MIXER,
104
105	QUIRK_TYPE_COUNT
106};
107
108struct snd_usb_audio_quirk {
109	const char *vendor_name;
110	const char *product_name;
111	int16_t ifnum;
112	uint16_t type;
113	const void *data;
114};
115
116#define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
117#define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
118#define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
119
120int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
121void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
122
123#endif /* __USBAUDIO_H */
124