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) (((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 num_suspended_intf;
41 	int sample_rate_read_error;
42 
43 	int badd_profile;		/* UAC3 BADD profile */
44 
45 	struct list_head pcm_list;	/* list of pcm streams */
46 	struct list_head ep_list;	/* list of audio-related endpoints */
47 	struct list_head iface_ref_list; /* list of interface refcounts */
48 	int pcm_devs;
49 
50 	struct list_head midi_list;	/* list of midi interfaces */
51 
52 	struct list_head mixer_list;	/* list of mixer interfaces */
53 
54 	int setup;			/* from the 'device_setup' module param */
55 	bool generic_implicit_fb;	/* from the 'implicit_fb' module param */
56 	bool autoclock;			/* from the 'autoclock' module param */
57 
58 	bool lowlatency;		/* from the 'lowlatency' module param */
59 	struct usb_host_interface *ctrl_intf;	/* the audio control interface */
60 	struct media_device *media_dev;
61 	struct media_intf_devnode *ctl_intf_media_devnode;
62 };
63 
64 #define USB_AUDIO_IFACE_UNUSED	((void *)-1L)
65 
66 #define usb_audio_err(chip, fmt, args...) \
67 	dev_err(&(chip)->dev->dev, fmt, ##args)
68 #define usb_audio_warn(chip, fmt, args...) \
69 	dev_warn(&(chip)->dev->dev, fmt, ##args)
70 #define usb_audio_info(chip, fmt, args...) \
71 	dev_info(&(chip)->dev->dev, fmt, ##args)
72 #define usb_audio_dbg(chip, fmt, args...) \
73 	dev_dbg(&(chip)->dev->dev, fmt, ##args)
74 
75 /*
76  * Information about devices with broken descriptors
77  */
78 
79 /* special values for .ifnum */
80 #define QUIRK_NODEV_INTERFACE		-3	/* return -ENODEV */
81 #define QUIRK_NO_INTERFACE		-2
82 #define QUIRK_ANY_INTERFACE		-1
83 
84 enum quirk_type {
85 	QUIRK_IGNORE_INTERFACE,
86 	QUIRK_COMPOSITE,
87 	QUIRK_AUTODETECT,
88 	QUIRK_MIDI_STANDARD_INTERFACE,
89 	QUIRK_MIDI_FIXED_ENDPOINT,
90 	QUIRK_MIDI_YAMAHA,
91 	QUIRK_MIDI_ROLAND,
92 	QUIRK_MIDI_MIDIMAN,
93 	QUIRK_MIDI_NOVATION,
94 	QUIRK_MIDI_RAW_BYTES,
95 	QUIRK_MIDI_EMAGIC,
96 	QUIRK_MIDI_CME,
97 	QUIRK_MIDI_AKAI,
98 	QUIRK_MIDI_US122L,
99 	QUIRK_MIDI_FTDI,
100 	QUIRK_MIDI_CH345,
101 	QUIRK_AUDIO_STANDARD_INTERFACE,
102 	QUIRK_AUDIO_FIXED_ENDPOINT,
103 	QUIRK_AUDIO_EDIROL_UAXX,
104 	QUIRK_AUDIO_STANDARD_MIXER,
105 
106 	QUIRK_TYPE_COUNT
107 };
108 
109 struct snd_usb_audio_quirk {
110 	const char *vendor_name;
111 	const char *product_name;
112 	int16_t ifnum;
113 	uint16_t type;
114 	const void *data;
115 };
116 
117 #define combine_word(s)    ((*(s)) | ((unsigned int)(s)[1] << 8))
118 #define combine_triple(s)  (combine_word(s) | ((unsigned int)(s)[2] << 16))
119 #define combine_quad(s)    (combine_triple(s) | ((unsigned int)(s)[3] << 24))
120 
121 int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
122 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
123 
124 extern bool snd_usb_use_vmalloc;
125 extern bool snd_usb_skip_validation;
126 
127 /*
128  * Driver behavior quirk flags, stored in chip->quirk_flags
129  *
130  * QUIRK_FLAG_GET_SAMPLE_RATE:
131  *  Skip reading sample rate for devices, as some devices behave inconsistently
132  *  or return error
133  * QUIRK_FLAG_SHARE_MEDIA_DEVICE:
134  *  Create Media Controller API entries
135  * QUIRK_FLAG_ALIGN_TRANSFER:
136  *  Allow alignment on audio sub-slot (channel samples) rather than on audio
137  *  slots (audio frames)
138  * QUIRK_TX_LENGTH:
139  *  Add length specifier to transfers
140  * QUIRK_FLAG_PLAYBACK_FIRST:
141  *  Start playback stream at first even in implement feedback mode
142  * QUIRK_FLAG_SKIP_CLOCK_SELECTOR:
143  *  Skip clock selector setup; the device may reset to invalid state
144  * QUIRK_FLAG_IGNORE_CLOCK_SOURCE:
145  *  Ignore errors from clock source search; i.e. hardcoded clock
146  * QUIRK_FLAG_ITF_USB_DSD_DAC:
147  *  Indicates the device is for ITF-USB DSD based DACs that need a vendor cmd
148  *  to switch between PCM and native DSD mode
149  * QUIRK_FLAG_CTL_MSG_DELAY:
150  *  Add a delay of 20ms at each control message handling
151  * QUIRK_FLAG_CTL_MSG_DELAY_1M:
152  *  Add a delay of 1-2ms at each control message handling
153  * QUIRK_FLAG_CTL_MSG_DELAY_5M:
154  *  Add a delay of 5-6ms at each control message handling
155  * QUIRK_FLAG_IFACE_DELAY:
156  *  Add a delay of 50ms at each interface setup
157  * QUIRK_FLAG_VALIDATE_RATES:
158  *  Perform sample rate validations at probe
159  * QUIRK_FLAG_DISABLE_AUTOSUSPEND:
160  *  Disable runtime PM autosuspend
161  * QUIRK_FLAG_IGNORE_CTL_ERROR:
162  *  Ignore errors for mixer access
163  * QUIRK_FLAG_DSD_RAW:
164  *  Support generic DSD raw U32_BE format
165  * QUIRK_FLAG_SET_IFACE_FIRST:
166  *  Set up the interface at first like UAC1
167  */
168 
169 #define QUIRK_FLAG_GET_SAMPLE_RATE	(1U << 0)
170 #define QUIRK_FLAG_SHARE_MEDIA_DEVICE	(1U << 1)
171 #define QUIRK_FLAG_ALIGN_TRANSFER	(1U << 2)
172 #define QUIRK_FLAG_TX_LENGTH		(1U << 3)
173 #define QUIRK_FLAG_PLAYBACK_FIRST	(1U << 4)
174 #define QUIRK_FLAG_SKIP_CLOCK_SELECTOR	(1U << 5)
175 #define QUIRK_FLAG_IGNORE_CLOCK_SOURCE	(1U << 6)
176 #define QUIRK_FLAG_ITF_USB_DSD_DAC	(1U << 7)
177 #define QUIRK_FLAG_CTL_MSG_DELAY	(1U << 8)
178 #define QUIRK_FLAG_CTL_MSG_DELAY_1M	(1U << 9)
179 #define QUIRK_FLAG_CTL_MSG_DELAY_5M	(1U << 10)
180 #define QUIRK_FLAG_IFACE_DELAY		(1U << 11)
181 #define QUIRK_FLAG_VALIDATE_RATES	(1U << 12)
182 #define QUIRK_FLAG_DISABLE_AUTOSUSPEND	(1U << 13)
183 #define QUIRK_FLAG_IGNORE_CTL_ERROR	(1U << 14)
184 #define QUIRK_FLAG_DSD_RAW		(1U << 15)
185 #define QUIRK_FLAG_SET_IFACE_FIRST	(1U << 16)
186 
187 #endif /* __USBAUDIO_H */
188