xref: /openbmc/linux/sound/usb/usbaudio.h (revision ff49d1df)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef __USBAUDIO_H
3 #define __USBAUDIO_H
4 /*
5  *   (Tentative) USB Audio Driver for ALSA
6  *
7  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8  */
9 
10 /* handling of USB vendor/product ID pairs as 32-bit numbers */
11 #define USB_ID(vendor, product) (((unsigned int)(vendor) << 16) | (product))
12 #define USB_ID_VENDOR(id) ((id) >> 16)
13 #define USB_ID_PRODUCT(id) ((u16)(id))
14 
15 /*
16  *
17  */
18 
19 struct media_device;
20 struct media_intf_devnode;
21 
22 #define MAX_CARD_INTERFACES	16
23 
24 struct snd_usb_audio {
25 	int index;
26 	struct usb_device *dev;
27 	struct snd_card *card;
28 	struct usb_interface *intf[MAX_CARD_INTERFACES];
29 	u32 usb_id;
30 	uint16_t quirk_type;
31 	struct mutex mutex;
32 	unsigned int system_suspend;
33 	atomic_t active;
34 	atomic_t shutdown;
35 	atomic_t usage_count;
36 	wait_queue_head_t shutdown_wait;
37 	unsigned int quirk_flags;
38 	unsigned int need_delayed_register:1; /* warn for delayed registration */
39 	int num_interfaces;
40 	int last_iface;
41 	int num_suspended_intf;
42 	int sample_rate_read_error;
43 
44 	int badd_profile;		/* UAC3 BADD profile */
45 
46 	struct list_head pcm_list;	/* list of pcm streams */
47 	struct list_head ep_list;	/* list of audio-related endpoints */
48 	struct list_head iface_ref_list; /* list of interface refcounts */
49 	struct list_head clock_ref_list; /* list of clock refcounts */
50 	int pcm_devs;
51 
52 	unsigned int num_rawmidis;	/* number of created rawmidi devices */
53 	struct list_head midi_list;	/* list of midi interfaces */
54 	struct list_head midi_v2_list;	/* list of MIDI 2 interfaces */
55 
56 	struct list_head mixer_list;	/* list of mixer interfaces */
57 
58 	int setup;			/* from the 'device_setup' module param */
59 	bool generic_implicit_fb;	/* from the 'implicit_fb' module param */
60 	bool autoclock;			/* from the 'autoclock' module param */
61 
62 	bool lowlatency;		/* from the 'lowlatency' module param */
63 	struct usb_host_interface *ctrl_intf;	/* the audio control interface */
64 	struct media_device *media_dev;
65 	struct media_intf_devnode *ctl_intf_media_devnode;
66 };
67 
68 #define USB_AUDIO_IFACE_UNUSED	((void *)-1L)
69 
70 #define usb_audio_err(chip, fmt, args...) \
71 	dev_err(&(chip)->dev->dev, fmt, ##args)
72 #define usb_audio_err_ratelimited(chip, fmt, args...) \
73 	dev_err_ratelimited(&(chip)->dev->dev, fmt, ##args)
74 #define usb_audio_warn(chip, fmt, args...) \
75 	dev_warn(&(chip)->dev->dev, fmt, ##args)
76 #define usb_audio_info(chip, fmt, args...) \
77 	dev_info(&(chip)->dev->dev, fmt, ##args)
78 #define usb_audio_dbg(chip, fmt, args...) \
79 	dev_dbg(&(chip)->dev->dev, fmt, ##args)
80 
81 /*
82  * Information about devices with broken descriptors
83  */
84 
85 /* special values for .ifnum */
86 #define QUIRK_NODEV_INTERFACE		-3	/* return -ENODEV */
87 #define QUIRK_NO_INTERFACE		-2
88 #define QUIRK_ANY_INTERFACE		-1
89 
90 enum quirk_type {
91 	QUIRK_IGNORE_INTERFACE,
92 	QUIRK_COMPOSITE,
93 	QUIRK_AUTODETECT,
94 	QUIRK_MIDI_STANDARD_INTERFACE,
95 	QUIRK_MIDI_FIXED_ENDPOINT,
96 	QUIRK_MIDI_YAMAHA,
97 	QUIRK_MIDI_ROLAND,
98 	QUIRK_MIDI_MIDIMAN,
99 	QUIRK_MIDI_NOVATION,
100 	QUIRK_MIDI_RAW_BYTES,
101 	QUIRK_MIDI_EMAGIC,
102 	QUIRK_MIDI_CME,
103 	QUIRK_MIDI_AKAI,
104 	QUIRK_MIDI_US122L,
105 	QUIRK_MIDI_FTDI,
106 	QUIRK_MIDI_CH345,
107 	QUIRK_AUDIO_STANDARD_INTERFACE,
108 	QUIRK_AUDIO_FIXED_ENDPOINT,
109 	QUIRK_AUDIO_EDIROL_UAXX,
110 	QUIRK_AUDIO_STANDARD_MIXER,
111 
112 	QUIRK_TYPE_COUNT
113 };
114 
115 struct snd_usb_audio_quirk {
116 	const char *vendor_name;
117 	const char *product_name;
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 extern bool snd_usb_skip_validation;
132 
133 /*
134  * Driver behavior quirk flags, stored in chip->quirk_flags
135  *
136  * QUIRK_FLAG_GET_SAMPLE_RATE:
137  *  Skip reading sample rate for devices, as some devices behave inconsistently
138  *  or return error
139  * QUIRK_FLAG_SHARE_MEDIA_DEVICE:
140  *  Create Media Controller API entries
141  * QUIRK_FLAG_ALIGN_TRANSFER:
142  *  Allow alignment on audio sub-slot (channel samples) rather than on audio
143  *  slots (audio frames)
144  * QUIRK_TX_LENGTH:
145  *  Add length specifier to transfers
146  * QUIRK_FLAG_PLAYBACK_FIRST:
147  *  Start playback stream at first even in implement feedback mode
148  * QUIRK_FLAG_SKIP_CLOCK_SELECTOR:
149  *  Skip clock selector setup; the device may reset to invalid state
150  * QUIRK_FLAG_IGNORE_CLOCK_SOURCE:
151  *  Ignore errors from clock source search; i.e. hardcoded clock
152  * QUIRK_FLAG_ITF_USB_DSD_DAC:
153  *  Indicates the device is for ITF-USB DSD based DACs that need a vendor cmd
154  *  to switch between PCM and native DSD mode
155  * QUIRK_FLAG_CTL_MSG_DELAY:
156  *  Add a delay of 20ms at each control message handling
157  * QUIRK_FLAG_CTL_MSG_DELAY_1M:
158  *  Add a delay of 1-2ms at each control message handling
159  * QUIRK_FLAG_CTL_MSG_DELAY_5M:
160  *  Add a delay of 5-6ms at each control message handling
161  * QUIRK_FLAG_IFACE_DELAY:
162  *  Add a delay of 50ms at each interface setup
163  * QUIRK_FLAG_VALIDATE_RATES:
164  *  Perform sample rate validations at probe
165  * QUIRK_FLAG_DISABLE_AUTOSUSPEND:
166  *  Disable runtime PM autosuspend
167  * QUIRK_FLAG_IGNORE_CTL_ERROR:
168  *  Ignore errors for mixer access
169  * QUIRK_FLAG_DSD_RAW:
170  *  Support generic DSD raw U32_BE format
171  * QUIRK_FLAG_SET_IFACE_FIRST:
172  *  Set up the interface at first like UAC1
173  * QUIRK_FLAG_GENERIC_IMPLICIT_FB
174  *  Apply the generic implicit feedback sync mode (same as implicit_fb=1 option)
175  * QUIRK_FLAG_SKIP_IMPLICIT_FB
176  *  Don't apply implicit feedback sync mode
177  * QUIRK_FLAG_IFACE_SKIP_CLOSE
178  *  Don't closed interface during setting sample rate
179  * QUIRK_FLAG_FORCE_IFACE_RESET
180  *  Force an interface reset whenever stopping & restarting a stream
181  *  (e.g. after xrun)
182  * QUIRK_FLAG_FIXED_RATE
183  *  Do not set PCM rate (frequency) when only one rate is available
184  *  for the given endpoint.
185  */
186 
187 #define QUIRK_FLAG_GET_SAMPLE_RATE	(1U << 0)
188 #define QUIRK_FLAG_SHARE_MEDIA_DEVICE	(1U << 1)
189 #define QUIRK_FLAG_ALIGN_TRANSFER	(1U << 2)
190 #define QUIRK_FLAG_TX_LENGTH		(1U << 3)
191 #define QUIRK_FLAG_PLAYBACK_FIRST	(1U << 4)
192 #define QUIRK_FLAG_SKIP_CLOCK_SELECTOR	(1U << 5)
193 #define QUIRK_FLAG_IGNORE_CLOCK_SOURCE	(1U << 6)
194 #define QUIRK_FLAG_ITF_USB_DSD_DAC	(1U << 7)
195 #define QUIRK_FLAG_CTL_MSG_DELAY	(1U << 8)
196 #define QUIRK_FLAG_CTL_MSG_DELAY_1M	(1U << 9)
197 #define QUIRK_FLAG_CTL_MSG_DELAY_5M	(1U << 10)
198 #define QUIRK_FLAG_IFACE_DELAY		(1U << 11)
199 #define QUIRK_FLAG_VALIDATE_RATES	(1U << 12)
200 #define QUIRK_FLAG_DISABLE_AUTOSUSPEND	(1U << 13)
201 #define QUIRK_FLAG_IGNORE_CTL_ERROR	(1U << 14)
202 #define QUIRK_FLAG_DSD_RAW		(1U << 15)
203 #define QUIRK_FLAG_SET_IFACE_FIRST	(1U << 16)
204 #define QUIRK_FLAG_GENERIC_IMPLICIT_FB	(1U << 17)
205 #define QUIRK_FLAG_SKIP_IMPLICIT_FB	(1U << 18)
206 #define QUIRK_FLAG_IFACE_SKIP_CLOSE	(1U << 19)
207 #define QUIRK_FLAG_FORCE_IFACE_RESET	(1U << 20)
208 #define QUIRK_FLAG_FIXED_RATE		(1U << 21)
209 
210 #endif /* __USBAUDIO_H */
211