xref: /openbmc/linux/sound/usb/usbaudio.h (revision be709d48)
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 
33 struct 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 	int sample_rate_read_error;
51 
52 	int badd_profile;		/* UAC3 BADD profile */
53 
54 	struct list_head pcm_list;	/* list of pcm streams */
55 	struct list_head ep_list;	/* list of audio-related endpoints */
56 	int pcm_devs;
57 
58 	struct list_head midi_list;	/* list of midi interfaces */
59 
60 	struct list_head mixer_list;	/* list of mixer interfaces */
61 
62 	int setup;			/* from the 'device_setup' module param */
63 	bool autoclock;			/* from the 'autoclock' module param */
64 	bool keep_iface;		/* keep interface/altset after closing
65 					 * or parameter change
66 					 */
67 
68 	struct usb_host_interface *ctrl_intf;	/* the audio control interface */
69 };
70 
71 #define usb_audio_err(chip, fmt, args...) \
72 	dev_err(&(chip)->dev->dev, fmt, ##args)
73 #define usb_audio_warn(chip, fmt, args...) \
74 	dev_warn(&(chip)->dev->dev, fmt, ##args)
75 #define usb_audio_info(chip, fmt, args...) \
76 	dev_info(&(chip)->dev->dev, fmt, ##args)
77 #define usb_audio_dbg(chip, fmt, args...) \
78 	dev_dbg(&(chip)->dev->dev, fmt, ##args)
79 
80 /*
81  * Information about devices with broken descriptors
82  */
83 
84 /* special values for .ifnum */
85 #define QUIRK_NO_INTERFACE		-2
86 #define QUIRK_ANY_INTERFACE		-1
87 
88 enum quirk_type {
89 	QUIRK_IGNORE_INTERFACE,
90 	QUIRK_COMPOSITE,
91 	QUIRK_AUTODETECT,
92 	QUIRK_MIDI_STANDARD_INTERFACE,
93 	QUIRK_MIDI_FIXED_ENDPOINT,
94 	QUIRK_MIDI_YAMAHA,
95 	QUIRK_MIDI_ROLAND,
96 	QUIRK_MIDI_MIDIMAN,
97 	QUIRK_MIDI_NOVATION,
98 	QUIRK_MIDI_RAW_BYTES,
99 	QUIRK_MIDI_EMAGIC,
100 	QUIRK_MIDI_CME,
101 	QUIRK_MIDI_AKAI,
102 	QUIRK_MIDI_US122L,
103 	QUIRK_MIDI_FTDI,
104 	QUIRK_MIDI_CH345,
105 	QUIRK_AUDIO_STANDARD_INTERFACE,
106 	QUIRK_AUDIO_FIXED_ENDPOINT,
107 	QUIRK_AUDIO_EDIROL_UAXX,
108 	QUIRK_AUDIO_ALIGN_TRANSFER,
109 	QUIRK_AUDIO_STANDARD_MIXER,
110 
111 	QUIRK_TYPE_COUNT
112 };
113 
114 struct snd_usb_audio_quirk {
115 	const char *vendor_name;
116 	const char *product_name;
117 	const char *profile_name;	/* override the card->longname */
118 	int16_t ifnum;
119 	uint16_t type;
120 	const void *data;
121 };
122 
123 #define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
124 #define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
125 #define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
126 
127 int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
128 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
129 
130 extern bool snd_usb_use_vmalloc;
131 
132 #endif /* __USBAUDIO_H */
133