xref: /linux/sound/usb/quirks.c (revision bf4afc53b77aeaa48b5409da5c8da6bb4eff7f43)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  */
4 
5 #include <linux/init.h>
6 #include <linux/slab.h>
7 #include <linux/usb.h>
8 #include <linux/usb/audio.h>
9 #include <linux/usb/midi.h>
10 #include <linux/bits.h>
11 
12 #include <sound/control.h>
13 #include <sound/core.h>
14 #include <sound/info.h>
15 #include <sound/pcm.h>
16 
17 #include "usbaudio.h"
18 #include "card.h"
19 #include "mixer.h"
20 #include "mixer_quirks.h"
21 #include "midi.h"
22 #include "midi2.h"
23 #include "quirks.h"
24 #include "helper.h"
25 #include "endpoint.h"
26 #include "pcm.h"
27 #include "clock.h"
28 #include "stream.h"
29 
30 /*
31  * handle the quirks for the contained interfaces
32  */
create_composite_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk_comp)33 static int create_composite_quirk(struct snd_usb_audio *chip,
34 				  struct usb_interface *iface,
35 				  struct usb_driver *driver,
36 				  const struct snd_usb_audio_quirk *quirk_comp)
37 {
38 	int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
39 	const struct snd_usb_audio_quirk *quirk;
40 	int err;
41 
42 	for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
43 		iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
44 		if (!iface)
45 			continue;
46 		if (quirk->ifnum != probed_ifnum &&
47 		    usb_interface_claimed(iface))
48 			continue;
49 		err = snd_usb_create_quirk(chip, iface, driver, quirk);
50 		if (err < 0)
51 			return err;
52 	}
53 
54 	for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
55 		iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
56 		if (!iface)
57 			continue;
58 		if (quirk->ifnum != probed_ifnum &&
59 		    !usb_interface_claimed(iface)) {
60 			err = usb_driver_claim_interface(driver, iface,
61 							 USB_AUDIO_IFACE_UNUSED);
62 			if (err < 0)
63 				return err;
64 		}
65 	}
66 
67 	return 0;
68 }
69 
ignore_interface_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)70 static int ignore_interface_quirk(struct snd_usb_audio *chip,
71 				  struct usb_interface *iface,
72 				  struct usb_driver *driver,
73 				  const struct snd_usb_audio_quirk *quirk)
74 {
75 	return 0;
76 }
77 
78 
create_any_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * intf,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)79 static int create_any_midi_quirk(struct snd_usb_audio *chip,
80 				 struct usb_interface *intf,
81 				 struct usb_driver *driver,
82 				 const struct snd_usb_audio_quirk *quirk)
83 {
84 	return snd_usb_midi_v2_create(chip, intf, quirk, 0);
85 }
86 
87 /*
88  * create a stream for an interface with proper descriptors
89  */
create_standard_audio_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)90 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
91 				       struct usb_interface *iface,
92 				       struct usb_driver *driver,
93 				       const struct snd_usb_audio_quirk *quirk)
94 {
95 	struct usb_host_interface *alts;
96 	struct usb_interface_descriptor *altsd;
97 	int err;
98 
99 	alts = &iface->altsetting[0];
100 	altsd = get_iface_desc(alts);
101 	err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
102 	if (err < 0) {
103 		usb_audio_err(chip, "cannot setup if %d: error %d\n",
104 			   altsd->bInterfaceNumber, err);
105 		return err;
106 	}
107 	/* reset the current interface */
108 	usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
109 	return 0;
110 }
111 
112 /* create the audio stream and the corresponding endpoints from the fixed
113  * audioformat object; this is used for quirks with the fixed EPs
114  */
add_audio_stream_from_fixed_fmt(struct snd_usb_audio * chip,struct audioformat * fp)115 static int add_audio_stream_from_fixed_fmt(struct snd_usb_audio *chip,
116 					   struct audioformat *fp)
117 {
118 	int stream, err;
119 
120 	stream = (fp->endpoint & USB_DIR_IN) ?
121 		SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
122 
123 	snd_usb_audioformat_set_sync_ep(chip, fp);
124 
125 	err = snd_usb_add_audio_stream(chip, stream, fp);
126 	if (err < 0)
127 		return err;
128 
129 	err = snd_usb_add_endpoint(chip, fp->endpoint,
130 				   SND_USB_ENDPOINT_TYPE_DATA);
131 	if (err < 0)
132 		return err;
133 
134 	if (fp->sync_ep) {
135 		err = snd_usb_add_endpoint(chip, fp->sync_ep,
136 					   fp->implicit_fb ?
137 					   SND_USB_ENDPOINT_TYPE_DATA :
138 					   SND_USB_ENDPOINT_TYPE_SYNC);
139 		if (err < 0)
140 			return err;
141 	}
142 
143 	return 0;
144 }
145 
146 /*
147  * create a stream for an endpoint/altsetting without proper descriptors
148  */
create_fixed_stream_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)149 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
150 				     struct usb_interface *iface,
151 				     struct usb_driver *driver,
152 				     const struct snd_usb_audio_quirk *quirk)
153 {
154 	struct audioformat *fp;
155 	struct usb_host_interface *alts;
156 	struct usb_interface_descriptor *altsd;
157 	unsigned *rate_table = NULL;
158 	int err;
159 
160 	fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
161 	if (!fp)
162 		return -ENOMEM;
163 
164 	INIT_LIST_HEAD(&fp->list);
165 	if (fp->nr_rates > MAX_NR_RATES) {
166 		kfree(fp);
167 		return -EINVAL;
168 	}
169 	if (fp->nr_rates > 0) {
170 		rate_table = kmemdup_array(fp->rate_table, fp->nr_rates, sizeof(int),
171 					   GFP_KERNEL);
172 		if (!rate_table) {
173 			kfree(fp);
174 			return -ENOMEM;
175 		}
176 		fp->rate_table = rate_table;
177 	}
178 
179 	if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
180 	    fp->altset_idx >= iface->num_altsetting) {
181 		err = -EINVAL;
182 		goto error;
183 	}
184 	alts = &iface->altsetting[fp->altset_idx];
185 	altsd = get_iface_desc(alts);
186 	if (altsd->bNumEndpoints <= fp->ep_idx) {
187 		err = -EINVAL;
188 		goto error;
189 	}
190 
191 	fp->protocol = altsd->bInterfaceProtocol;
192 
193 	if (fp->datainterval == 0)
194 		fp->datainterval = snd_usb_parse_datainterval(chip, alts);
195 	if (fp->maxpacksize == 0)
196 		fp->maxpacksize = le16_to_cpu(get_endpoint(alts, fp->ep_idx)->wMaxPacketSize);
197 	if (!fp->fmt_type)
198 		fp->fmt_type = UAC_FORMAT_TYPE_I;
199 
200 	err = add_audio_stream_from_fixed_fmt(chip, fp);
201 	if (err < 0)
202 		goto error;
203 
204 	usb_set_interface(chip->dev, fp->iface, 0);
205 	snd_usb_init_pitch(chip, fp);
206 	snd_usb_init_sample_rate(chip, fp, fp->rate_max);
207 	return 0;
208 
209  error:
210 	list_del(&fp->list); /* unlink for avoiding double-free */
211 	kfree(fp);
212 	kfree(rate_table);
213 	return err;
214 }
215 
create_auto_pcm_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver)216 static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
217 				 struct usb_interface *iface,
218 				 struct usb_driver *driver)
219 {
220 	struct usb_host_interface *alts;
221 	struct usb_interface_descriptor *altsd;
222 	struct usb_endpoint_descriptor *epd;
223 	struct uac1_as_header_descriptor *ashd;
224 	struct uac_format_type_i_discrete_descriptor *fmtd;
225 
226 	/*
227 	 * Most Roland/Yamaha audio streaming interfaces have more or less
228 	 * standard descriptors, but older devices might lack descriptors, and
229 	 * future ones might change, so ensure that we fail silently if the
230 	 * interface doesn't look exactly right.
231 	 */
232 
233 	/* must have a non-zero altsetting for streaming */
234 	if (iface->num_altsetting < 2)
235 		return -ENODEV;
236 	alts = &iface->altsetting[1];
237 	altsd = get_iface_desc(alts);
238 
239 	/* must have an isochronous endpoint for streaming */
240 	if (altsd->bNumEndpoints < 1)
241 		return -ENODEV;
242 	epd = get_endpoint(alts, 0);
243 	if (!usb_endpoint_xfer_isoc(epd))
244 		return -ENODEV;
245 
246 	/* must have format descriptors */
247 	ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
248 				       UAC_AS_GENERAL);
249 	fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
250 				       UAC_FORMAT_TYPE);
251 	if (!ashd || ashd->bLength < 7 ||
252 	    !fmtd || fmtd->bLength < 8)
253 		return -ENODEV;
254 
255 	return create_standard_audio_quirk(chip, iface, driver, NULL);
256 }
257 
create_yamaha_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,struct usb_host_interface * alts)258 static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
259 				    struct usb_interface *iface,
260 				    struct usb_driver *driver,
261 				    struct usb_host_interface *alts)
262 {
263 	static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
264 		.type = QUIRK_MIDI_YAMAHA
265 	};
266 	struct usb_midi_in_jack_descriptor *injd;
267 	struct usb_midi_out_jack_descriptor *outjd;
268 
269 	/* must have some valid jack descriptors */
270 	injd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
271 				       NULL, USB_MS_MIDI_IN_JACK);
272 	outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
273 					NULL, USB_MS_MIDI_OUT_JACK);
274 	if (!injd && !outjd)
275 		return -ENODEV;
276 	if ((injd && !snd_usb_validate_midi_desc(injd)) ||
277 	    (outjd && !snd_usb_validate_midi_desc(outjd)))
278 		return -ENODEV;
279 	if (injd && (injd->bLength < 5 ||
280 		     (injd->bJackType != USB_MS_EMBEDDED &&
281 		      injd->bJackType != USB_MS_EXTERNAL)))
282 		return -ENODEV;
283 	if (outjd && (outjd->bLength < 6 ||
284 		      (outjd->bJackType != USB_MS_EMBEDDED &&
285 		       outjd->bJackType != USB_MS_EXTERNAL)))
286 		return -ENODEV;
287 	return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
288 }
289 
create_roland_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,struct usb_host_interface * alts)290 static int create_roland_midi_quirk(struct snd_usb_audio *chip,
291 				    struct usb_interface *iface,
292 				    struct usb_driver *driver,
293 				    struct usb_host_interface *alts)
294 {
295 	static const struct snd_usb_audio_quirk roland_midi_quirk = {
296 		.type = QUIRK_MIDI_ROLAND
297 	};
298 	u8 *roland_desc = NULL;
299 
300 	/* might have a vendor-specific descriptor <06 24 F1 02 ...> */
301 	for (;;) {
302 		roland_desc = snd_usb_find_csint_desc(alts->extra,
303 						      alts->extralen,
304 						      roland_desc, 0xf1);
305 		if (!roland_desc)
306 			return -ENODEV;
307 		if (roland_desc[0] < 6 || roland_desc[3] != 2)
308 			continue;
309 		return create_any_midi_quirk(chip, iface, driver,
310 					     &roland_midi_quirk);
311 	}
312 }
313 
create_std_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,struct usb_host_interface * alts)314 static int create_std_midi_quirk(struct snd_usb_audio *chip,
315 				 struct usb_interface *iface,
316 				 struct usb_driver *driver,
317 				 struct usb_host_interface *alts)
318 {
319 	struct usb_ms_header_descriptor *mshd;
320 	struct usb_ms_endpoint_descriptor *msepd;
321 
322 	/* must have the MIDIStreaming interface header descriptor*/
323 	mshd = (struct usb_ms_header_descriptor *)alts->extra;
324 	if (alts->extralen < 7 ||
325 	    mshd->bLength < 7 ||
326 	    mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
327 	    mshd->bDescriptorSubtype != USB_MS_HEADER)
328 		return -ENODEV;
329 	/* must have the MIDIStreaming endpoint descriptor*/
330 	msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra;
331 	if (alts->endpoint[0].extralen < 4 ||
332 	    msepd->bLength < 4 ||
333 	    msepd->bDescriptorType != USB_DT_CS_ENDPOINT ||
334 	    msepd->bDescriptorSubtype != UAC_MS_GENERAL ||
335 	    msepd->bNumEmbMIDIJack < 1 ||
336 	    msepd->bNumEmbMIDIJack > 16)
337 		return -ENODEV;
338 
339 	return create_any_midi_quirk(chip, iface, driver, NULL);
340 }
341 
create_auto_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver)342 static int create_auto_midi_quirk(struct snd_usb_audio *chip,
343 				  struct usb_interface *iface,
344 				  struct usb_driver *driver)
345 {
346 	struct usb_host_interface *alts;
347 	struct usb_interface_descriptor *altsd;
348 	struct usb_endpoint_descriptor *epd;
349 	int err;
350 
351 	alts = &iface->altsetting[0];
352 	altsd = get_iface_desc(alts);
353 
354 	/* must have at least one bulk/interrupt endpoint for streaming */
355 	if (altsd->bNumEndpoints < 1)
356 		return -ENODEV;
357 	epd = get_endpoint(alts, 0);
358 	if (!usb_endpoint_xfer_bulk(epd) &&
359 	    !usb_endpoint_xfer_int(epd))
360 		return -ENODEV;
361 
362 	switch (USB_ID_VENDOR(chip->usb_id)) {
363 	case 0x0499: /* Yamaha */
364 		err = create_yamaha_midi_quirk(chip, iface, driver, alts);
365 		if (err != -ENODEV)
366 			return err;
367 		break;
368 	case 0x0582: /* Roland */
369 		err = create_roland_midi_quirk(chip, iface, driver, alts);
370 		if (err != -ENODEV)
371 			return err;
372 		break;
373 	}
374 
375 	return create_std_midi_quirk(chip, iface, driver, alts);
376 }
377 
create_autodetect_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)378 static int create_autodetect_quirk(struct snd_usb_audio *chip,
379 				   struct usb_interface *iface,
380 				   struct usb_driver *driver,
381 				   const struct snd_usb_audio_quirk *quirk)
382 {
383 	int err;
384 
385 	err = create_auto_pcm_quirk(chip, iface, driver);
386 	if (err == -ENODEV)
387 		err = create_auto_midi_quirk(chip, iface, driver);
388 	return err;
389 }
390 
391 /*
392  * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
393  * The only way to detect the sample rate is by looking at wMaxPacketSize.
394  */
create_uaxx_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)395 static int create_uaxx_quirk(struct snd_usb_audio *chip,
396 			     struct usb_interface *iface,
397 			     struct usb_driver *driver,
398 			     const struct snd_usb_audio_quirk *quirk)
399 {
400 	static const struct audioformat ua_format = {
401 		.formats = SNDRV_PCM_FMTBIT_S24_3LE,
402 		.channels = 2,
403 		.fmt_type = UAC_FORMAT_TYPE_I,
404 		.altsetting = 1,
405 		.altset_idx = 1,
406 		.rates = SNDRV_PCM_RATE_CONTINUOUS,
407 	};
408 	struct usb_host_interface *alts;
409 	struct usb_interface_descriptor *altsd;
410 	struct audioformat *fp;
411 	int err;
412 
413 	/* both PCM and MIDI interfaces have 2 or more altsettings */
414 	if (iface->num_altsetting < 2)
415 		return -ENXIO;
416 	alts = &iface->altsetting[1];
417 	altsd = get_iface_desc(alts);
418 
419 	if (altsd->bNumEndpoints == 2) {
420 		static const struct snd_usb_midi_endpoint_info ua700_ep = {
421 			.out_cables = 0x0003,
422 			.in_cables  = 0x0003
423 		};
424 		static const struct snd_usb_audio_quirk ua700_quirk = {
425 			.type = QUIRK_MIDI_FIXED_ENDPOINT,
426 			.data = &ua700_ep
427 		};
428 		static const struct snd_usb_midi_endpoint_info uaxx_ep = {
429 			.out_cables = 0x0001,
430 			.in_cables  = 0x0001
431 		};
432 		static const struct snd_usb_audio_quirk uaxx_quirk = {
433 			.type = QUIRK_MIDI_FIXED_ENDPOINT,
434 			.data = &uaxx_ep
435 		};
436 		const struct snd_usb_audio_quirk *quirk =
437 			chip->usb_id == USB_ID(0x0582, 0x002b)
438 			? &ua700_quirk : &uaxx_quirk;
439 		return __snd_usbmidi_create(chip->card, iface,
440 					    &chip->midi_list, quirk,
441 					    chip->usb_id,
442 					    &chip->num_rawmidis);
443 	}
444 
445 	if (altsd->bNumEndpoints != 1)
446 		return -ENXIO;
447 
448 	fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
449 	if (!fp)
450 		return -ENOMEM;
451 
452 	fp->iface = altsd->bInterfaceNumber;
453 	fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
454 	fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
455 	fp->datainterval = 0;
456 	fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
457 	INIT_LIST_HEAD(&fp->list);
458 
459 	switch (fp->maxpacksize) {
460 	case 0x120:
461 		fp->rate_max = fp->rate_min = 44100;
462 		break;
463 	case 0x138:
464 	case 0x140:
465 		fp->rate_max = fp->rate_min = 48000;
466 		break;
467 	case 0x258:
468 	case 0x260:
469 		fp->rate_max = fp->rate_min = 96000;
470 		break;
471 	default:
472 		usb_audio_err(chip, "unknown sample rate\n");
473 		kfree(fp);
474 		return -ENXIO;
475 	}
476 
477 	err = add_audio_stream_from_fixed_fmt(chip, fp);
478 	if (err < 0) {
479 		list_del(&fp->list); /* unlink for avoiding double-free */
480 		kfree(fp);
481 		return err;
482 	}
483 	usb_set_interface(chip->dev, fp->iface, 0);
484 	return 0;
485 }
486 
487 /*
488  * Create a standard mixer for the specified interface.
489  */
create_standard_mixer_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)490 static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
491 				       struct usb_interface *iface,
492 				       struct usb_driver *driver,
493 				       const struct snd_usb_audio_quirk *quirk)
494 {
495 	if (quirk->ifnum < 0)
496 		return 0;
497 
498 	return snd_usb_create_mixer(chip, quirk->ifnum);
499 }
500 
501 /*
502  * audio-interface quirks
503  *
504  * returns zero if no standard audio/MIDI parsing is needed.
505  * returns a positive value if standard audio/midi interfaces are parsed
506  * after this.
507  * returns a negative value at error.
508  */
snd_usb_create_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)509 int snd_usb_create_quirk(struct snd_usb_audio *chip,
510 			 struct usb_interface *iface,
511 			 struct usb_driver *driver,
512 			 const struct snd_usb_audio_quirk *quirk)
513 {
514 	typedef int (*quirk_func_t)(struct snd_usb_audio *,
515 				    struct usb_interface *,
516 				    struct usb_driver *,
517 				    const struct snd_usb_audio_quirk *);
518 	static const quirk_func_t quirk_funcs[] = {
519 		[QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
520 		[QUIRK_COMPOSITE] = create_composite_quirk,
521 		[QUIRK_AUTODETECT] = create_autodetect_quirk,
522 		[QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
523 		[QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
524 		[QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
525 		[QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
526 		[QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
527 		[QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
528 		[QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
529 		[QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
530 		[QUIRK_MIDI_CME] = create_any_midi_quirk,
531 		[QUIRK_MIDI_AKAI] = create_any_midi_quirk,
532 		[QUIRK_MIDI_FTDI] = create_any_midi_quirk,
533 		[QUIRK_MIDI_CH345] = create_any_midi_quirk,
534 		[QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
535 		[QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
536 		[QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
537 		[QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
538 	};
539 
540 	if (quirk->type < QUIRK_TYPE_COUNT) {
541 		return quirk_funcs[quirk->type](chip, iface, driver, quirk);
542 	} else {
543 		usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
544 		return -ENXIO;
545 	}
546 }
547 
548 /*
549  * boot quirks
550  */
551 
552 #define EXTIGY_FIRMWARE_SIZE_OLD 794
553 #define EXTIGY_FIRMWARE_SIZE_NEW 483
554 
snd_usb_extigy_boot_quirk(struct usb_device * dev,struct usb_interface * intf)555 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
556 {
557 	struct usb_host_config *config = dev->actconfig;
558 	int err;
559 
560 	if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
561 	    le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
562 		dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
563 		/* Send message to force it to reconnect with full interface. */
564 		err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
565 				      0x10, 0x43, 0x0001, 0x000a, NULL, 0);
566 		if (err < 0)
567 			dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
568 		struct usb_device_descriptor *new_device_descriptor __free(kfree) =
569 			kmalloc_obj(*new_device_descriptor);
570 		if (!new_device_descriptor)
571 			return -ENOMEM;
572 		err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
573 				new_device_descriptor, sizeof(*new_device_descriptor));
574 		if (err < 0)
575 			dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
576 		if (new_device_descriptor->bNumConfigurations > dev->descriptor.bNumConfigurations)
577 			dev_dbg(&dev->dev, "error too large bNumConfigurations: %d\n",
578 				new_device_descriptor->bNumConfigurations);
579 		else
580 			memcpy(&dev->descriptor, new_device_descriptor, sizeof(dev->descriptor));
581 		err = usb_reset_configuration(dev);
582 		if (err < 0)
583 			dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
584 		dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
585 			    le16_to_cpu(get_cfg_desc(config)->wTotalLength));
586 		return -ENODEV; /* quit this anyway */
587 	}
588 	return 0;
589 }
590 
snd_usb_audigy2nx_boot_quirk(struct usb_device * dev)591 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
592 {
593 	u8 buf = 1;
594 
595 	snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
596 			USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
597 			0, 0, &buf, 1);
598 	if (buf == 0) {
599 		snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
600 				USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
601 				1, 2000, NULL, 0);
602 		return -ENODEV;
603 	}
604 	return 0;
605 }
606 
snd_usb_fasttrackpro_boot_quirk(struct usb_device * dev)607 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
608 {
609 	int err;
610 
611 	if (dev->actconfig->desc.bConfigurationValue == 1) {
612 		dev_info(&dev->dev,
613 			   "Fast Track Pro switching to config #2\n");
614 		/* This function has to be available by the usb core module.
615 		 * if it is not avialable the boot quirk has to be left out
616 		 * and the configuration has to be set by udev or hotplug
617 		 * rules
618 		 */
619 		err = usb_driver_set_configuration(dev, 2);
620 		if (err < 0)
621 			dev_dbg(&dev->dev,
622 				"error usb_driver_set_configuration: %d\n",
623 				err);
624 		/* Always return an error, so that we stop creating a device
625 		   that will just be destroyed and recreated with a new
626 		   configuration */
627 		return -ENODEV;
628 	} else
629 		dev_info(&dev->dev, "Fast Track Pro config OK\n");
630 
631 	return 0;
632 }
633 
634 /*
635  * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
636  * documented in the device's data sheet.
637  */
snd_usb_cm106_write_int_reg(struct usb_device * dev,int reg,u16 value)638 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
639 {
640 	u8 buf[4];
641 	buf[0] = 0x20;
642 	buf[1] = value & 0xff;
643 	buf[2] = (value >> 8) & 0xff;
644 	buf[3] = reg;
645 	return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
646 			       USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
647 			       0, 0, &buf, 4);
648 }
649 
snd_usb_cm106_boot_quirk(struct usb_device * dev)650 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
651 {
652 	/*
653 	 * Enable line-out driver mode, set headphone source to front
654 	 * channels, enable stereo mic.
655 	 */
656 	return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
657 }
658 
659 /*
660  * CM6206 registers from the CM6206 datasheet rev 2.1
661  */
662 #define CM6206_REG0_DMA_MASTER BIT(15)
663 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
664 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
665 /* Bit 4 thru 11 is the S/PDIF category code */
666 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
667 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
668 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
669 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
670 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
671 
672 #define CM6206_REG1_TEST_SEL_CLK BIT(14)
673 #define CM6206_REG1_PLLBIN_EN BIT(13)
674 #define CM6206_REG1_SOFT_MUTE_EN BIT(12)
675 #define CM6206_REG1_GPIO4_OUT BIT(11)
676 #define CM6206_REG1_GPIO4_OE BIT(10)
677 #define CM6206_REG1_GPIO3_OUT BIT(9)
678 #define CM6206_REG1_GPIO3_OE BIT(8)
679 #define CM6206_REG1_GPIO2_OUT BIT(7)
680 #define CM6206_REG1_GPIO2_OE BIT(6)
681 #define CM6206_REG1_GPIO1_OUT BIT(5)
682 #define CM6206_REG1_GPIO1_OE BIT(4)
683 #define CM6206_REG1_SPDIFO_INVALID BIT(3)
684 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
685 #define CM6206_REG1_SPDIFO_DIS BIT(1)
686 #define CM6206_REG1_SPDIFI_MIX BIT(0)
687 
688 #define CM6206_REG2_DRIVER_ON BIT(15)
689 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
690 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
691 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
692 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
693 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
694 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
695 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
696 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
697 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
698 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
699 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
700 #define CM6206_REG2_MUTE_CENTER BIT(5)
701 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
702 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
703 #define CM6206_REG2_EN_BTL BIT(2)
704 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
705 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
706 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
707 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
708 
709 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
710 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
711 #define CM6206_REG3_VRAP25EN BIT(10)
712 #define CM6206_REG3_MSEL1 BIT(9)
713 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
714 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
715 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
716 #define CM6206_REG3_PINSEL BIT(6)
717 #define CM6206_REG3_FOE BIT(5)
718 #define CM6206_REG3_ROE BIT(4)
719 #define CM6206_REG3_CBOE BIT(3)
720 #define CM6206_REG3_LOSE BIT(2)
721 #define CM6206_REG3_HPOE BIT(1)
722 #define CM6206_REG3_SPDIFI_CANREC BIT(0)
723 
724 #define CM6206_REG5_DA_RSTN BIT(13)
725 #define CM6206_REG5_AD_RSTN BIT(12)
726 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
727 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
728 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
729 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
730 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
731 #define CM6206_REG5_CODECM BIT(8)
732 #define CM6206_REG5_EN_HPF BIT(7)
733 #define CM6206_REG5_T_SEL_DSDA4 BIT(6)
734 #define CM6206_REG5_T_SEL_DSDA3 BIT(5)
735 #define CM6206_REG5_T_SEL_DSDA2 BIT(4)
736 #define CM6206_REG5_T_SEL_DSDA1 BIT(3)
737 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
738 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4
739 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
740 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
741 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
742 
snd_usb_cm6206_boot_quirk(struct usb_device * dev)743 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
744 {
745 	int err  = 0, reg;
746 	int val[] = {
747 		/*
748 		 * Values here are chosen based on sniffing USB traffic
749 		 * under Windows.
750 		 *
751 		 * REG0: DAC is master, sample rate 48kHz, no copyright
752 		 */
753 		CM6206_REG0_SPDIFO_RATE_48K |
754 		CM6206_REG0_SPDIFO_COPYRIGHT_NA,
755 		/*
756 		 * REG1: PLL binary search enable, soft mute enable.
757 		 */
758 		CM6206_REG1_PLLBIN_EN |
759 		CM6206_REG1_SOFT_MUTE_EN,
760 		/*
761 		 * REG2: enable output drivers,
762 		 * select front channels to the headphone output,
763 		 * then mute the headphone channels, run the MCU
764 		 * at 1.5 MHz.
765 		 */
766 		CM6206_REG2_DRIVER_ON |
767 		CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
768 		CM6206_REG2_MUTE_HEADPHONE_RIGHT |
769 		CM6206_REG2_MUTE_HEADPHONE_LEFT,
770 		/*
771 		 * REG3: default flyspeed, set 2.5V mic bias
772 		 * enable all line out ports and enable SPDIF
773 		 */
774 		CM6206_REG3_FLYSPEED_DEFAULT |
775 		CM6206_REG3_VRAP25EN |
776 		CM6206_REG3_FOE |
777 		CM6206_REG3_ROE |
778 		CM6206_REG3_CBOE |
779 		CM6206_REG3_LOSE |
780 		CM6206_REG3_HPOE |
781 		CM6206_REG3_SPDIFI_CANREC,
782 		/* REG4 is just a bunch of GPIO lines */
783 		0x0000,
784 		/* REG5: de-assert AD/DA reset signals */
785 		CM6206_REG5_DA_RSTN |
786 		CM6206_REG5_AD_RSTN };
787 
788 	for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
789 		err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
790 		if (err < 0)
791 			return err;
792 	}
793 
794 	return err;
795 }
796 
797 /* quirk for Plantronics GameCom 780 with CM6302 chip */
snd_usb_gamecon780_boot_quirk(struct usb_device * dev)798 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
799 {
800 	/* set the initial volume and don't change; other values are either
801 	 * too loud or silent due to firmware bug (bko#65251)
802 	 */
803 	u8 buf[2] = { 0x74, 0xe3 };
804 	return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
805 			USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
806 			UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
807 }
808 
809 /*
810  * Novation Twitch DJ controller
811  * Focusrite Novation Saffire 6 USB audio card
812  */
snd_usb_novation_boot_quirk(struct usb_device * dev)813 static int snd_usb_novation_boot_quirk(struct usb_device *dev)
814 {
815 	/* preemptively set up the device because otherwise the
816 	 * raw MIDI endpoints are not active */
817 	usb_set_interface(dev, 0, 1);
818 	return 0;
819 }
820 
821 /*
822  * This call will put the synth in "USB send" mode, i.e it will send MIDI
823  * messages through USB (this is disabled at startup). The synth will
824  * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
825  * sign on its LCD. Values here are chosen based on sniffing USB traffic
826  * under Windows.
827  */
snd_usb_accessmusic_boot_quirk(struct usb_device * dev)828 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
829 {
830 	int err, actual_length;
831 	/* "midi send" enable */
832 	static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
833 	void *buf;
834 
835 	if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
836 		return -EINVAL;
837 	buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
838 	if (!buf)
839 		return -ENOMEM;
840 	err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
841 			ARRAY_SIZE(seq), &actual_length, 1000);
842 	kfree(buf);
843 	if (err < 0)
844 		return err;
845 
846 	return 0;
847 }
848 
849 /*
850  * Some sound cards from Native Instruments are in fact compliant to the USB
851  * audio standard of version 2 and other approved USB standards, even though
852  * they come up as vendor-specific device when first connected.
853  *
854  * However, they can be told to come up with a new set of descriptors
855  * upon their next enumeration, and the interfaces announced by the new
856  * descriptors will then be handled by the kernel's class drivers. As the
857  * product ID will also change, no further checks are required.
858  */
859 
snd_usb_nativeinstruments_boot_quirk(struct usb_device * dev)860 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
861 {
862 	int ret;
863 
864 	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
865 				  0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
866 				  1, 0, NULL, 0, 1000);
867 
868 	if (ret < 0)
869 		return ret;
870 
871 	usb_reset_device(dev);
872 
873 	/* return -EAGAIN, so the creation of an audio interface for this
874 	 * temporary device is aborted. The device will reconnect with a
875 	 * new product ID */
876 	return -EAGAIN;
877 }
878 
mbox2_setup_48_24_magic(struct usb_device * dev)879 static void mbox2_setup_48_24_magic(struct usb_device *dev)
880 {
881 	u8 srate[3];
882 	u8 temp[12];
883 
884 	/* Choose 48000Hz permanently */
885 	srate[0] = 0x80;
886 	srate[1] = 0xbb;
887 	srate[2] = 0x00;
888 
889 	/* Send the magic! */
890 	snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
891 		0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
892 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
893 		0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
894 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
895 		0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
896 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
897 		0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
898 	return;
899 }
900 
901 /* Digidesign Mbox 2 needs to load firmware onboard
902  * and driver must wait a few seconds for initialisation.
903  */
904 
905 #define MBOX2_FIRMWARE_SIZE    646
906 #define MBOX2_BOOT_LOADING     0x01 /* Hard coded into the device */
907 #define MBOX2_BOOT_READY       0x02 /* Hard coded into the device */
908 
snd_usb_mbox2_boot_quirk(struct usb_device * dev)909 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
910 {
911 	struct usb_host_config *config = dev->actconfig;
912 	int err;
913 	u8 bootresponse[0x12];
914 	int fwsize;
915 	int count;
916 
917 	fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
918 
919 	if (fwsize != MBOX2_FIRMWARE_SIZE) {
920 		dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
921 		return -ENODEV;
922 	}
923 
924 	dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
925 
926 	count = 0;
927 	bootresponse[0] = MBOX2_BOOT_LOADING;
928 	while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
929 		msleep(500); /* 0.5 second delay */
930 		snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
931 			/* Control magic - load onboard firmware */
932 			0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
933 		if (bootresponse[0] == MBOX2_BOOT_READY)
934 			break;
935 		dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
936 		count++;
937 	}
938 
939 	if (bootresponse[0] != MBOX2_BOOT_READY) {
940 		dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
941 		return -ENODEV;
942 	}
943 
944 	dev_dbg(&dev->dev, "device initialised!\n");
945 
946 	struct usb_device_descriptor *new_device_descriptor __free(kfree) =
947 		kmalloc_obj(*new_device_descriptor);
948 	if (!new_device_descriptor)
949 		return -ENOMEM;
950 
951 	err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
952 		new_device_descriptor, sizeof(*new_device_descriptor));
953 	if (err < 0)
954 		dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
955 	if (new_device_descriptor->bNumConfigurations > dev->descriptor.bNumConfigurations)
956 		dev_dbg(&dev->dev, "error too large bNumConfigurations: %d\n",
957 			new_device_descriptor->bNumConfigurations);
958 	else
959 		memcpy(&dev->descriptor, new_device_descriptor, sizeof(dev->descriptor));
960 
961 	err = usb_reset_configuration(dev);
962 	if (err < 0)
963 		dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
964 	dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
965 		le16_to_cpu(get_cfg_desc(config)->wTotalLength));
966 
967 	mbox2_setup_48_24_magic(dev);
968 
969 	dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
970 
971 	return 0; /* Successful boot */
972 }
973 
snd_usb_axefx3_boot_quirk(struct usb_device * dev)974 static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
975 {
976 	int err;
977 
978 	dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
979 
980 	/* If the Axe-Fx III has not fully booted, it will timeout when trying
981 	 * to enable the audio streaming interface. A more generous timeout is
982 	 * used here to detect when the Axe-Fx III has finished booting as the
983 	 * set interface message will be acked once it has
984 	 */
985 	err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
986 				USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
987 				1, 1, NULL, 0, 120000);
988 	if (err < 0) {
989 		dev_err(&dev->dev,
990 			"failed waiting for Axe-Fx III to boot: %d\n", err);
991 		return err;
992 	}
993 
994 	dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
995 
996 	err = usb_set_interface(dev, 1, 0);
997 	if (err < 0)
998 		dev_dbg(&dev->dev,
999 			"error stopping Axe-Fx III interface: %d\n", err);
1000 
1001 	return 0;
1002 }
1003 
mbox3_setup_defaults(struct usb_device * dev)1004 static void mbox3_setup_defaults(struct usb_device *dev)
1005 {
1006 	/* The Mbox 3 is "little endian" */
1007 	/* max volume is: 0x0000. */
1008 	/* min volume is: 0x0080 (shown in little endian form) */
1009 
1010 	u8 com_buff[2];
1011 
1012 	/* Deactivate Tuner */
1013 	/* on  = 0x01*/
1014 	/* off = 0x00*/
1015 	com_buff[0] = 0x00;
1016 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1017 		0x01, 0x21, 0x0003, 0x2001, &com_buff, 1);
1018 
1019 	/* Set clock source to Internal (as opposed to S/PDIF) */
1020 	/* Internal  = 0x01*/
1021 	/* S/PDIF    = 0x02*/
1022 	com_buff[0] = 0x01;
1023 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1024 			1, 0x21, 0x0100, 0x8001, &com_buff, 1);
1025 
1026 	/* Mute the hardware loopbacks to start the device in a known state. */
1027 	com_buff[0] = 0x00;
1028 	com_buff[1] = 0x80;
1029 	/* Analogue input 1 left channel: */
1030 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1031 			1, 0x21, 0x0110, 0x4001, &com_buff, 2);
1032 	/* Analogue input 1 right channel: */
1033 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1034 			1, 0x21, 0x0111, 0x4001, &com_buff, 2);
1035 	/* Analogue input 2 left channel: */
1036 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1037 			1, 0x21, 0x0114, 0x4001, &com_buff, 2);
1038 	/* Analogue input 2 right channel: */
1039 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1040 			1, 0x21, 0x0115, 0x4001, &com_buff, 2);
1041 	/* Analogue input 3 left channel: */
1042 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1043 			1, 0x21, 0x0118, 0x4001, &com_buff, 2);
1044 	/* Analogue input 3 right channel: */
1045 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1046 			1, 0x21, 0x0119, 0x4001, &com_buff, 2);
1047 	/* Analogue input 4 left channel: */
1048 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1049 			1, 0x21, 0x011c, 0x4001, &com_buff, 2);
1050 	/* Analogue input 4 right channel: */
1051 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1052 			1, 0x21, 0x011d, 0x4001, &com_buff, 2);
1053 
1054 	/* Set software sends to output */
1055 	com_buff[0] = 0x00;
1056 	com_buff[1] = 0x00;
1057 	/* Analogue software return 1 left channel: */
1058 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1059 			1, 0x21, 0x0100, 0x4001, &com_buff, 2);
1060 	com_buff[0] = 0x00;
1061 	com_buff[1] = 0x80;
1062 	/* Analogue software return 1 right channel: */
1063 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1064 			1, 0x21, 0x0101, 0x4001, &com_buff, 2);
1065 	com_buff[0] = 0x00;
1066 	com_buff[1] = 0x80;
1067 	/* Analogue software return 2 left channel: */
1068 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1069 			1, 0x21, 0x0104, 0x4001, &com_buff, 2);
1070 	com_buff[0] = 0x00;
1071 	com_buff[1] = 0x00;
1072 	/* Analogue software return 2 right channel: */
1073 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1074 			1, 0x21, 0x0105, 0x4001, &com_buff, 2);
1075 
1076 	com_buff[0] = 0x00;
1077 	com_buff[1] = 0x80;
1078 	/* Analogue software return 3 left channel: */
1079 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1080 			1, 0x21, 0x0108, 0x4001, &com_buff, 2);
1081 	/* Analogue software return 3 right channel: */
1082 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1083 			1, 0x21, 0x0109, 0x4001, &com_buff, 2);
1084 	/* Analogue software return 4 left channel: */
1085 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1086 			1, 0x21, 0x010c, 0x4001, &com_buff, 2);
1087 	/* Analogue software return 4 right channel: */
1088 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1089 			1, 0x21, 0x010d, 0x4001, &com_buff, 2);
1090 
1091 	/* Return to muting sends */
1092 	com_buff[0] = 0x00;
1093 	com_buff[1] = 0x80;
1094 	/* Analogue fx return left channel: */
1095 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1096 			1, 0x21, 0x0120, 0x4001, &com_buff, 2);
1097 	/* Analogue fx return right channel: */
1098 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1099 			1, 0x21, 0x0121, 0x4001, &com_buff, 2);
1100 
1101 	/* Analogue software input 1 fx send: */
1102 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1103 			1, 0x21, 0x0100, 0x4201, &com_buff, 2);
1104 	/* Analogue software input 2 fx send: */
1105 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1106 			1, 0x21, 0x0101, 0x4201, &com_buff, 2);
1107 	/* Analogue software input 3 fx send: */
1108 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1109 			1, 0x21, 0x0102, 0x4201, &com_buff, 2);
1110 	/* Analogue software input 4 fx send: */
1111 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1112 			1, 0x21, 0x0103, 0x4201, &com_buff, 2);
1113 	/* Analogue input 1 fx send: */
1114 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1115 			1, 0x21, 0x0104, 0x4201, &com_buff, 2);
1116 	/* Analogue input 2 fx send: */
1117 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1118 			1, 0x21, 0x0105, 0x4201, &com_buff, 2);
1119 	/* Analogue input 3 fx send: */
1120 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1121 			1, 0x21, 0x0106, 0x4201, &com_buff, 2);
1122 	/* Analogue input 4 fx send: */
1123 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1124 			1, 0x21, 0x0107, 0x4201, &com_buff, 2);
1125 
1126 	/* Toggle allowing host control */
1127 	/* Not needed
1128 	com_buff[0] = 0x02;
1129 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1130 			3, 0x21, 0x0000, 0x2001, &com_buff, 1);
1131 	 */
1132 
1133 	/* Do not dim fx returns */
1134 	com_buff[0] = 0x00;
1135 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1136 			3, 0x21, 0x0002, 0x2001, &com_buff, 1);
1137 
1138 	/* Do not set fx returns to mono */
1139 	com_buff[0] = 0x00;
1140 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1141 			3, 0x21, 0x0001, 0x2001, &com_buff, 1);
1142 
1143 	/* Mute the S/PDIF hardware loopback
1144 	 * same odd volume logic here as above
1145 	 */
1146 	com_buff[0] = 0x00;
1147 	com_buff[1] = 0x80;
1148 	/* S/PDIF hardware input 1 left channel */
1149 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1150 			1, 0x21, 0x0112, 0x4001, &com_buff, 2);
1151 	/* S/PDIF hardware input 1 right channel */
1152 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1153 			1, 0x21, 0x0113, 0x4001, &com_buff, 2);
1154 	/* S/PDIF hardware input 2 left channel */
1155 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1156 			1, 0x21, 0x0116, 0x4001, &com_buff, 2);
1157 	/* S/PDIF hardware input 2 right channel */
1158 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1159 			1, 0x21, 0x0117, 0x4001, &com_buff, 2);
1160 	/* S/PDIF hardware input 3 left channel */
1161 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1162 			1, 0x21, 0x011a, 0x4001, &com_buff, 2);
1163 	/* S/PDIF hardware input 3 right channel */
1164 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1165 			1, 0x21, 0x011b, 0x4001, &com_buff, 2);
1166 	/* S/PDIF hardware input 4 left channel */
1167 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1168 			1, 0x21, 0x011e, 0x4001, &com_buff, 2);
1169 	/* S/PDIF hardware input 4 right channel */
1170 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1171 			1, 0x21, 0x011f, 0x4001, &com_buff, 2);
1172 	/* S/PDIF software return 1 left channel */
1173 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1174 			1, 0x21, 0x0102, 0x4001, &com_buff, 2);
1175 	/* S/PDIF software return 1 right channel */
1176 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1177 			1, 0x21, 0x0103, 0x4001, &com_buff, 2);
1178 	/* S/PDIF software return 2 left channel */
1179 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1180 			1, 0x21, 0x0106, 0x4001, &com_buff, 2);
1181 	/* S/PDIF software return 2 right channel */
1182 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1183 			1, 0x21, 0x0107, 0x4001, &com_buff, 2);
1184 
1185 	com_buff[0] = 0x00;
1186 	com_buff[1] = 0x00;
1187 	/* S/PDIF software return 3 left channel */
1188 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1189 			1, 0x21, 0x010a, 0x4001, &com_buff, 2);
1190 
1191 	com_buff[0] = 0x00;
1192 	com_buff[1] = 0x80;
1193 	/* S/PDIF software return 3 right channel */
1194 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1195 			1, 0x21, 0x010b, 0x4001, &com_buff, 2);
1196 	/* S/PDIF software return 4 left channel */
1197 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1198 			1, 0x21, 0x010e, 0x4001, &com_buff, 2);
1199 
1200 	com_buff[0] = 0x00;
1201 	com_buff[1] = 0x00;
1202 	/* S/PDIF software return 4 right channel */
1203 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1204 			1, 0x21, 0x010f, 0x4001, &com_buff, 2);
1205 
1206 	com_buff[0] = 0x00;
1207 	com_buff[1] = 0x80;
1208 	/* S/PDIF fx returns left channel */
1209 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1210 			1, 0x21, 0x0122, 0x4001, &com_buff, 2);
1211 	/* S/PDIF fx returns right channel */
1212 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1213 			1, 0x21, 0x0123, 0x4001, &com_buff, 2);
1214 
1215 	/* Set the dropdown "Effect" to the first option */
1216 	/* Room1  = 0x00 */
1217 	/* Room2  = 0x01 */
1218 	/* Room3  = 0x02 */
1219 	/* Hall 1 = 0x03 */
1220 	/* Hall 2 = 0x04 */
1221 	/* Plate  = 0x05 */
1222 	/* Delay  = 0x06 */
1223 	/* Echo   = 0x07 */
1224 	com_buff[0] = 0x00;
1225 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1226 			1, 0x21, 0x0200, 0x4301, &com_buff, 1);	/* max is 0xff */
1227 	/* min is 0x00 */
1228 
1229 
1230 	/* Set the effect duration to 0 */
1231 	/* max is 0xffff */
1232 	/* min is 0x0000 */
1233 	com_buff[0] = 0x00;
1234 	com_buff[1] = 0x00;
1235 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1236 			1, 0x21, 0x0400, 0x4301, &com_buff, 2);
1237 
1238 	/* Set the effect volume and feedback to 0 */
1239 	/* max is 0xff */
1240 	/* min is 0x00 */
1241 	com_buff[0] = 0x00;
1242 	/* feedback: */
1243 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1244 			1, 0x21, 0x0500, 0x4301, &com_buff, 1);
1245 	/* volume: */
1246 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1247 			1, 0x21, 0x0300, 0x4301, &com_buff, 1);
1248 
1249 	/* Set soft button hold duration */
1250 	/* 0x03 = 250ms */
1251 	/* 0x05 = 500ms DEFAULT */
1252 	/* 0x08 = 750ms */
1253 	/* 0x0a = 1sec */
1254 	com_buff[0] = 0x05;
1255 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1256 			3, 0x21, 0x0005, 0x2001, &com_buff, 1);
1257 
1258 	/* Use dim LEDs for button of state */
1259 	com_buff[0] = 0x00;
1260 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1261 			3, 0x21, 0x0004, 0x2001, &com_buff, 1);
1262 }
1263 
1264 #define MBOX3_DESCRIPTOR_SIZE	464
1265 
snd_usb_mbox3_boot_quirk(struct usb_device * dev)1266 static int snd_usb_mbox3_boot_quirk(struct usb_device *dev)
1267 {
1268 	struct usb_host_config *config = dev->actconfig;
1269 	int err;
1270 	int descriptor_size;
1271 
1272 	descriptor_size = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
1273 
1274 	if (descriptor_size != MBOX3_DESCRIPTOR_SIZE) {
1275 		dev_err(&dev->dev, "MBOX3: Invalid descriptor size=%d.\n", descriptor_size);
1276 		return -ENODEV;
1277 	}
1278 
1279 	dev_dbg(&dev->dev, "MBOX3: device initialised!\n");
1280 
1281 	struct usb_device_descriptor *new_device_descriptor __free(kfree) =
1282 		kmalloc_obj(*new_device_descriptor);
1283 	if (!new_device_descriptor)
1284 		return -ENOMEM;
1285 
1286 	err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
1287 		new_device_descriptor, sizeof(*new_device_descriptor));
1288 	if (err < 0)
1289 		dev_dbg(&dev->dev, "MBOX3: error usb_get_descriptor: %d\n", err);
1290 	if (new_device_descriptor->bNumConfigurations > dev->descriptor.bNumConfigurations)
1291 		dev_dbg(&dev->dev, "MBOX3: error too large bNumConfigurations: %d\n",
1292 			new_device_descriptor->bNumConfigurations);
1293 	else
1294 		memcpy(&dev->descriptor, new_device_descriptor, sizeof(dev->descriptor));
1295 
1296 	err = usb_reset_configuration(dev);
1297 	if (err < 0)
1298 		dev_dbg(&dev->dev, "MBOX3: error usb_reset_configuration: %d\n", err);
1299 
1300 	dev_dbg(&dev->dev, "MBOX3: new boot length = %d\n",
1301 		le16_to_cpu(get_cfg_desc(config)->wTotalLength));
1302 
1303 	mbox3_setup_defaults(dev);
1304 	dev_info(&dev->dev, "MBOX3: Initialized.");
1305 
1306 	return 0; /* Successful boot */
1307 }
1308 
1309 #define MICROBOOK_BUF_SIZE 128
1310 
snd_usb_motu_microbookii_communicate(struct usb_device * dev,u8 * buf,int buf_size,int * length)1311 static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1312 						int buf_size, int *length)
1313 {
1314 	int err, actual_length;
1315 
1316 	if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
1317 		return -EINVAL;
1318 	err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1319 				&actual_length, 1000);
1320 	if (err < 0)
1321 		return err;
1322 
1323 	print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1324 		       buf, actual_length, false);
1325 
1326 	memset(buf, 0, buf_size);
1327 
1328 	if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
1329 		return -EINVAL;
1330 	err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1331 				&actual_length, 1000);
1332 	if (err < 0)
1333 		return err;
1334 
1335 	print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1336 		       buf, actual_length, false);
1337 
1338 	*length = actual_length;
1339 	return 0;
1340 }
1341 
snd_usb_motu_microbookii_boot_quirk(struct usb_device * dev)1342 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1343 {
1344 	int err, actual_length, poll_attempts = 0;
1345 	static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1346 						 0x00, 0x00, 0x0b, 0x14,
1347 						 0x00, 0x00, 0x00, 0x01 };
1348 	static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1349 					     0x00, 0x00, 0x0b, 0x18 };
1350 	u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1351 
1352 	if (!buf)
1353 		return -ENOMEM;
1354 
1355 	dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1356 
1357 	/* First we tell the device which sample rate to use. */
1358 	memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1359 	actual_length = sizeof(set_samplerate_seq);
1360 	err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1361 						   &actual_length);
1362 
1363 	if (err < 0) {
1364 		dev_err(&dev->dev,
1365 			"failed setting the sample rate for Motu MicroBook II: %d\n",
1366 			err);
1367 		goto free_buf;
1368 	}
1369 
1370 	/* Then we poll every 100 ms until the device informs of its readiness. */
1371 	while (true) {
1372 		if (++poll_attempts > 100) {
1373 			dev_err(&dev->dev,
1374 				"failed booting Motu MicroBook II: timeout\n");
1375 			err = -ENODEV;
1376 			goto free_buf;
1377 		}
1378 
1379 		memset(buf, 0, MICROBOOK_BUF_SIZE);
1380 		memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1381 
1382 		actual_length = sizeof(poll_ready_seq);
1383 		err = snd_usb_motu_microbookii_communicate(
1384 			dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1385 		if (err < 0) {
1386 			dev_err(&dev->dev,
1387 				"failed booting Motu MicroBook II: communication error %d\n",
1388 				err);
1389 			goto free_buf;
1390 		}
1391 
1392 		/* the device signals its readiness through a message of the
1393 		 * form
1394 		 *           XX 06 00 00 00 00 0b 18  00 00 00 01
1395 		 * If the device is not yet ready to accept audio data, the
1396 		 * last byte of that sequence is 00.
1397 		 */
1398 		if (actual_length == 12 && buf[actual_length - 1] == 1)
1399 			break;
1400 
1401 		msleep(100);
1402 	}
1403 
1404 	dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1405 
1406 free_buf:
1407 	kfree(buf);
1408 	return err;
1409 }
1410 
snd_usb_motu_m_series_boot_quirk(struct usb_device * dev)1411 static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1412 {
1413 	msleep(4000);
1414 
1415 	return 0;
1416 }
1417 
snd_usb_rme_digiface_boot_quirk(struct usb_device * dev)1418 static int snd_usb_rme_digiface_boot_quirk(struct usb_device *dev)
1419 {
1420 	/* Disable mixer, internal clock, all outputs ADAT, 48kHz, TMS off */
1421 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1422 			16, 0x40, 0x2410, 0x7fff, NULL, 0);
1423 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1424 			18, 0x40, 0x0104, 0xffff, NULL, 0);
1425 
1426 	/* Disable loopback for all inputs */
1427 	for (int ch = 0; ch < 32; ch++)
1428 		snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1429 				22, 0x40, 0x400, ch, NULL, 0);
1430 
1431 	/* Unity gain for all outputs */
1432 	for (int ch = 0; ch < 34; ch++)
1433 		snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1434 				21, 0x40, 0x9000, 0x100 + ch, NULL, 0);
1435 
1436 	return 0;
1437 }
1438 
1439 /*
1440  * Setup quirks
1441  */
1442 #define MAUDIO_SET		0x01 /* parse device_setup */
1443 #define MAUDIO_SET_COMPATIBLE	0x80 /* use only "win-compatible" interfaces */
1444 #define MAUDIO_SET_DTS		0x02 /* enable DTS Digital Output */
1445 #define MAUDIO_SET_96K		0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
1446 #define MAUDIO_SET_24B		0x08 /* 24bits sample if set, 16bits otherwise */
1447 #define MAUDIO_SET_DI		0x10 /* enable Digital Input */
1448 #define MAUDIO_SET_MASK		0x1f /* bit mask for setup value */
1449 #define MAUDIO_SET_24B_48K_DI	 0x19 /* 24bits+48kHz+Digital Input */
1450 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48kHz+No Digital Input */
1451 #define MAUDIO_SET_16B_48K_DI	 0x11 /* 16bits+48kHz+Digital Input */
1452 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48kHz+No Digital Input */
1453 
quattro_skip_setting_quirk(struct snd_usb_audio * chip,int iface,int altno)1454 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1455 				      int iface, int altno)
1456 {
1457 	/* Reset ALL ifaces to 0 altsetting.
1458 	 * Call it for every possible altsetting of every interface.
1459 	 */
1460 	usb_set_interface(chip->dev, iface, 0);
1461 	if (chip->setup & MAUDIO_SET) {
1462 		if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1463 			if (iface != 1 && iface != 2)
1464 				return 1; /* skip all interfaces but 1 and 2 */
1465 		} else {
1466 			unsigned int mask;
1467 			if (iface == 1 || iface == 2)
1468 				return 1; /* skip interfaces 1 and 2 */
1469 			if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1470 				return 1; /* skip this altsetting */
1471 			mask = chip->setup & MAUDIO_SET_MASK;
1472 			if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1473 				return 1; /* skip this altsetting */
1474 			if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1475 				return 1; /* skip this altsetting */
1476 			if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1477 				return 1; /* skip this altsetting */
1478 		}
1479 	}
1480 	usb_audio_dbg(chip,
1481 		    "using altsetting %d for interface %d config %d\n",
1482 		    altno, iface, chip->setup);
1483 	return 0; /* keep this altsetting */
1484 }
1485 
audiophile_skip_setting_quirk(struct snd_usb_audio * chip,int iface,int altno)1486 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1487 					 int iface,
1488 					 int altno)
1489 {
1490 	/* Reset ALL ifaces to 0 altsetting.
1491 	 * Call it for every possible altsetting of every interface.
1492 	 */
1493 	usb_set_interface(chip->dev, iface, 0);
1494 
1495 	if (chip->setup & MAUDIO_SET) {
1496 		unsigned int mask;
1497 		if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1498 			return 1; /* skip this altsetting */
1499 		if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1500 			return 1; /* skip this altsetting */
1501 		mask = chip->setup & MAUDIO_SET_MASK;
1502 		if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1503 			return 1; /* skip this altsetting */
1504 		if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1505 			return 1; /* skip this altsetting */
1506 		if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1507 			return 1; /* skip this altsetting */
1508 		if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1509 			return 1; /* skip this altsetting */
1510 	}
1511 
1512 	return 0; /* keep this altsetting */
1513 }
1514 
fasttrackpro_skip_setting_quirk(struct snd_usb_audio * chip,int iface,int altno)1515 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1516 					   int iface, int altno)
1517 {
1518 	/* Reset ALL ifaces to 0 altsetting.
1519 	 * Call it for every possible altsetting of every interface.
1520 	 */
1521 	usb_set_interface(chip->dev, iface, 0);
1522 
1523 	/* possible configuration where both inputs and only one output is
1524 	 *used is not supported by the current setup
1525 	 */
1526 	if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1527 		if (chip->setup & MAUDIO_SET_96K) {
1528 			if (altno != 3 && altno != 6)
1529 				return 1;
1530 		} else if (chip->setup & MAUDIO_SET_DI) {
1531 			if (iface == 4)
1532 				return 1; /* no analog input */
1533 			if (altno != 2 && altno != 5)
1534 				return 1; /* enable only altsets 2 and 5 */
1535 		} else {
1536 			if (iface == 5)
1537 				return 1; /* disable digialt input */
1538 			if (altno != 2 && altno != 5)
1539 				return 1; /* enalbe only altsets 2 and 5 */
1540 		}
1541 	} else {
1542 		/* keep only 16-Bit mode */
1543 		if (altno != 1)
1544 			return 1;
1545 	}
1546 
1547 	usb_audio_dbg(chip,
1548 		    "using altsetting %d for interface %d config %d\n",
1549 		    altno, iface, chip->setup);
1550 	return 0; /* keep this altsetting */
1551 }
1552 
s1810c_skip_setting_quirk(struct snd_usb_audio * chip,int iface,int altno)1553 static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1554 					   int iface, int altno)
1555 {
1556 	/*
1557 	 * Altno settings:
1558 	 *
1559 	 * Playback (Interface 1):
1560 	 * 1: 6 Analog + 2 S/PDIF
1561 	 * 2: 6 Analog + 2 S/PDIF
1562 	 * 3: 6 Analog
1563 	 *
1564 	 * Capture (Interface 2):
1565 	 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1566 	 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1567 	 * 3: 8 Analog
1568 	 */
1569 
1570 	/*
1571 	 * I'll leave 2 as the default one and
1572 	 * use device_setup to switch to the
1573 	 * other two.
1574 	 */
1575 	if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1576 		return 1;
1577 	else if (chip->setup == 1 && altno != 1)
1578 		return 1;
1579 	else if (chip->setup == 2 && altno != 3)
1580 		return 1;
1581 
1582 	return 0;
1583 }
1584 
snd_usb_apply_interface_quirk(struct snd_usb_audio * chip,int iface,int altno)1585 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1586 				  int iface,
1587 				  int altno)
1588 {
1589 	/* audiophile usb: skip altsets incompatible with device_setup */
1590 	if (chip->usb_id == USB_ID(0x0763, 0x2003))
1591 		return audiophile_skip_setting_quirk(chip, iface, altno);
1592 	/* quattro usb: skip altsets incompatible with device_setup */
1593 	if (chip->usb_id == USB_ID(0x0763, 0x2001))
1594 		return quattro_skip_setting_quirk(chip, iface, altno);
1595 	/* fasttrackpro usb: skip altsets incompatible with device_setup */
1596 	if (chip->usb_id == USB_ID(0x0763, 0x2012))
1597 		return fasttrackpro_skip_setting_quirk(chip, iface, altno);
1598 	/* presonus studio 1810c: skip altsets incompatible with device_setup */
1599 	if (chip->usb_id == USB_ID(0x194f, 0x010c))
1600 		return s1810c_skip_setting_quirk(chip, iface, altno);
1601 
1602 	return 0;
1603 }
1604 
snd_usb_apply_boot_quirk(struct usb_device * dev,struct usb_interface * intf,const struct snd_usb_audio_quirk * quirk,unsigned int id)1605 int snd_usb_apply_boot_quirk(struct usb_device *dev,
1606 			     struct usb_interface *intf,
1607 			     const struct snd_usb_audio_quirk *quirk,
1608 			     unsigned int id)
1609 {
1610 	switch (id) {
1611 	case USB_ID(0x041e, 0x3000):
1612 		/* SB Extigy needs special boot-up sequence */
1613 		/* if more models come, this will go to the quirk list. */
1614 		return snd_usb_extigy_boot_quirk(dev, intf);
1615 
1616 	case USB_ID(0x041e, 0x3020):
1617 		/* SB Audigy 2 NX needs its own boot-up magic, too */
1618 		return snd_usb_audigy2nx_boot_quirk(dev);
1619 
1620 	case USB_ID(0x10f5, 0x0200):
1621 		/* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1622 		return snd_usb_cm106_boot_quirk(dev);
1623 
1624 	case USB_ID(0x0d8c, 0x0102):
1625 		/* C-Media CM6206 / CM106-Like Sound Device */
1626 	case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1627 		return snd_usb_cm6206_boot_quirk(dev);
1628 
1629 	case USB_ID(0x0dba, 0x3000):
1630 		/* Digidesign Mbox 2 */
1631 		return snd_usb_mbox2_boot_quirk(dev);
1632 	case USB_ID(0x0dba, 0x5000):
1633 		/* Digidesign Mbox 3 */
1634 		return snd_usb_mbox3_boot_quirk(dev);
1635 
1636 
1637 	case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1638 	case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1639 		return snd_usb_novation_boot_quirk(dev);
1640 
1641 	case USB_ID(0x133e, 0x0815):
1642 		/* Access Music VirusTI Desktop */
1643 		return snd_usb_accessmusic_boot_quirk(dev);
1644 
1645 	case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1646 	case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1647 	case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1648 		return snd_usb_nativeinstruments_boot_quirk(dev);
1649 	case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1650 		return snd_usb_fasttrackpro_boot_quirk(dev);
1651 	case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1652 		return snd_usb_gamecon780_boot_quirk(dev);
1653 	case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1654 		return snd_usb_axefx3_boot_quirk(dev);
1655 	case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1656 		/*
1657 		 * For some reason interface 3 with vendor-spec class is
1658 		 * detected on MicroBook IIc.
1659 		 */
1660 		if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1661 		    USB_CLASS_VENDOR_SPEC &&
1662 		    get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1663 			return snd_usb_motu_microbookii_boot_quirk(dev);
1664 		break;
1665 	case USB_ID(0x2a39, 0x3f8c): /* RME Digiface USB */
1666 	case USB_ID(0x2a39, 0x3fa0): /* RME Digiface USB (alternate) */
1667 		return snd_usb_rme_digiface_boot_quirk(dev);
1668 	}
1669 
1670 	return 0;
1671 }
1672 
snd_usb_apply_boot_quirk_once(struct usb_device * dev,struct usb_interface * intf,const struct snd_usb_audio_quirk * quirk,unsigned int id)1673 int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1674 				  struct usb_interface *intf,
1675 				  const struct snd_usb_audio_quirk *quirk,
1676 				  unsigned int id)
1677 {
1678 	switch (id) {
1679 	case USB_ID(0x07fd, 0x0008): /* MOTU M Series, 1st hardware version */
1680 		return snd_usb_motu_m_series_boot_quirk(dev);
1681 	}
1682 
1683 	return 0;
1684 }
1685 
1686 /*
1687  * check if the device uses big-endian samples
1688  */
snd_usb_is_big_endian_format(struct snd_usb_audio * chip,const struct audioformat * fp)1689 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip,
1690 				 const struct audioformat *fp)
1691 {
1692 	/* it depends on altsetting whether the device is big-endian or not */
1693 	switch (chip->usb_id) {
1694 	case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1695 		if (fp->altsetting == 2 || fp->altsetting == 3 ||
1696 			fp->altsetting == 5 || fp->altsetting == 6)
1697 			return 1;
1698 		break;
1699 	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1700 		if (chip->setup == 0x00 ||
1701 			fp->altsetting == 1 || fp->altsetting == 2 ||
1702 			fp->altsetting == 3)
1703 			return 1;
1704 		break;
1705 	case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1706 		if (fp->altsetting == 2 || fp->altsetting == 3 ||
1707 			fp->altsetting == 5 || fp->altsetting == 6)
1708 			return 1;
1709 		break;
1710 	}
1711 	return 0;
1712 }
1713 
1714 /*
1715  * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1716  * not for interface.
1717  */
1718 
1719 enum {
1720 	EMU_QUIRK_SR_44100HZ = 0,
1721 	EMU_QUIRK_SR_48000HZ,
1722 	EMU_QUIRK_SR_88200HZ,
1723 	EMU_QUIRK_SR_96000HZ,
1724 	EMU_QUIRK_SR_176400HZ,
1725 	EMU_QUIRK_SR_192000HZ
1726 };
1727 
set_format_emu_quirk(struct snd_usb_substream * subs,const struct audioformat * fmt)1728 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1729 				 const struct audioformat *fmt)
1730 {
1731 	unsigned char emu_samplerate_id = 0;
1732 
1733 	/* When capture is active
1734 	 * sample rate shouldn't be changed
1735 	 * by playback substream
1736 	 */
1737 	if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1738 		if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].cur_audiofmt)
1739 			return;
1740 	}
1741 
1742 	switch (fmt->rate_min) {
1743 	case 48000:
1744 		emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1745 		break;
1746 	case 88200:
1747 		emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1748 		break;
1749 	case 96000:
1750 		emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1751 		break;
1752 	case 176400:
1753 		emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1754 		break;
1755 	case 192000:
1756 		emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1757 		break;
1758 	default:
1759 		emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1760 		break;
1761 	}
1762 	snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1763 	subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1764 }
1765 
pioneer_djm_set_format_quirk(struct snd_usb_substream * subs,u16 windex)1766 static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs,
1767 					u16 windex)
1768 {
1769 	unsigned int cur_rate = subs->data_endpoint->cur_rate;
1770 	u8 sr[3];
1771 	// Convert to little endian
1772 	sr[0] = cur_rate & 0xff;
1773 	sr[1] = (cur_rate >> 8) & 0xff;
1774 	sr[2] = (cur_rate >> 16) & 0xff;
1775 	usb_set_interface(subs->dev, 0, 1);
1776 	// we should derive windex from fmt-sync_ep but it's not set
1777 	snd_usb_ctl_msg(subs->stream->chip->dev,
1778 		usb_sndctrlpipe(subs->stream->chip->dev, 0),
1779 		0x01, 0x22, 0x0100, windex, &sr, 0x0003);
1780 	return 0;
1781 }
1782 
mbox3_set_format_quirk(struct snd_usb_substream * subs,const struct audioformat * fmt)1783 static void mbox3_set_format_quirk(struct snd_usb_substream *subs,
1784 				const struct audioformat *fmt)
1785 {
1786 	__le32 buff4 = 0;
1787 	u8 buff1 = 0x01;
1788 	u32 new_rate = subs->data_endpoint->cur_rate;
1789 	u32 current_rate;
1790 
1791 	// Get current rate from card and check if changing it is needed
1792 	snd_usb_ctl_msg(subs->dev, usb_rcvctrlpipe(subs->dev, 0),
1793 					0x01, 0x21 | USB_DIR_IN, 0x0100, 0x8101, &buff4, 4);
1794 	current_rate = le32_to_cpu(buff4);
1795 	dev_dbg(&subs->dev->dev,
1796 			 "MBOX3: Current configured sample rate: %d", current_rate);
1797 	if (current_rate == new_rate) {
1798 		dev_dbg(&subs->dev->dev,
1799 			"MBOX3: No change needed (current rate:%d == new rate:%d)",
1800 			current_rate, new_rate);
1801 		return;
1802 	}
1803 
1804 	// Set new rate
1805 	dev_info(&subs->dev->dev,
1806 			 "MBOX3: Changing sample rate to: %d", new_rate);
1807 	buff4 = cpu_to_le32(new_rate);
1808 	snd_usb_ctl_msg(subs->dev, usb_sndctrlpipe(subs->dev, 0),
1809 					0x01, 0x21, 0x0100, 0x8101, &buff4, 4);
1810 
1811 	// Set clock source to Internal
1812 	snd_usb_ctl_msg(subs->dev, usb_sndctrlpipe(subs->dev, 0),
1813 					0x01, 0x21, 0x0100, 0x8001, &buff1, 1);
1814 
1815 	// Check whether the change was successful
1816 	buff4 = 0;
1817 	snd_usb_ctl_msg(subs->dev, usb_rcvctrlpipe(subs->dev, 0),
1818 					0x01, 0x21 | USB_DIR_IN, 0x0100, 0x8101, &buff4, 4);
1819 	if (new_rate != le32_to_cpu(buff4))
1820 		dev_warn(&subs->dev->dev, "MBOX3: Couldn't set the sample rate");
1821 }
1822 
1823 static const int rme_digiface_rate_table[] = {
1824 	32000, 44100, 48000, 0,
1825 	64000, 88200, 96000, 0,
1826 	128000, 176400, 192000, 0,
1827 };
1828 
rme_digiface_set_format_quirk(struct snd_usb_substream * subs)1829 static int rme_digiface_set_format_quirk(struct snd_usb_substream *subs)
1830 {
1831 	unsigned int cur_rate = subs->data_endpoint->cur_rate;
1832 	u16 val;
1833 	int speed_mode;
1834 	int id;
1835 
1836 	for (id = 0; id < ARRAY_SIZE(rme_digiface_rate_table); id++) {
1837 		if (rme_digiface_rate_table[id] == cur_rate)
1838 			break;
1839 	}
1840 
1841 	if (id >= ARRAY_SIZE(rme_digiface_rate_table))
1842 		return -EINVAL;
1843 
1844 	/* 2, 3, 4 for 1x, 2x, 4x */
1845 	speed_mode = (id >> 2) + 2;
1846 	val = (id << 3) | (speed_mode << 12);
1847 
1848 	/* Set the sample rate */
1849 	snd_usb_ctl_msg(subs->stream->chip->dev,
1850 		usb_sndctrlpipe(subs->stream->chip->dev, 0),
1851 		16, 0x40, val, 0x7078, NULL, 0);
1852 	return 0;
1853 }
1854 
snd_usb_set_format_quirk(struct snd_usb_substream * subs,const struct audioformat * fmt)1855 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1856 			      const struct audioformat *fmt)
1857 {
1858 	switch (subs->stream->chip->usb_id) {
1859 	case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1860 	case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1861 	case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1862 	case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1863 		set_format_emu_quirk(subs, fmt);
1864 		break;
1865 	case USB_ID(0x534d, 0x0021): /* MacroSilicon MS2100/MS2106 */
1866 	case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1867 		subs->stream_offset_adj = 2;
1868 		break;
1869 	case USB_ID(0x2b73, 0x000a): /* Pioneer DJM-900NXS2 */
1870 	case USB_ID(0x2b73, 0x0013): /* Pioneer DJM-450 */
1871 	case USB_ID(0x2b73, 0x0034): /* Pioneer DJM-V10 */
1872 		pioneer_djm_set_format_quirk(subs, 0x0082);
1873 		break;
1874 	case USB_ID(0x08e4, 0x017f): /* Pioneer DJM-750 */
1875 	case USB_ID(0x08e4, 0x0163): /* Pioneer DJM-850 */
1876 		pioneer_djm_set_format_quirk(subs, 0x0086);
1877 		break;
1878 	case USB_ID(0x0dba, 0x5000):
1879 		mbox3_set_format_quirk(subs, fmt); /* Digidesign Mbox 3 */
1880 		break;
1881 	case USB_ID(0x2a39, 0x3f8c): /* RME Digiface USB */
1882 	case USB_ID(0x2a39, 0x3fa0): /* RME Digiface USB (alternate) */
1883 		rme_digiface_set_format_quirk(subs);
1884 		break;
1885 	}
1886 }
1887 
snd_usb_select_mode_quirk(struct snd_usb_audio * chip,const struct audioformat * fmt)1888 int snd_usb_select_mode_quirk(struct snd_usb_audio *chip,
1889 			      const struct audioformat *fmt)
1890 {
1891 	struct usb_device *dev = chip->dev;
1892 	int err;
1893 
1894 	if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
1895 		/* First switch to alt set 0, otherwise the mode switch cmd
1896 		 * will not be accepted by the DAC
1897 		 */
1898 		err = usb_set_interface(dev, fmt->iface, 0);
1899 		if (err < 0)
1900 			return err;
1901 
1902 		msleep(20); /* Delay needed after setting the interface */
1903 
1904 		/* Vendor mode switch cmd is required. */
1905 		if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1906 			/* DSD mode (DSD_U32) requested */
1907 			err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1908 					      USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1909 					      1, 1, NULL, 0);
1910 			if (err < 0)
1911 				return err;
1912 
1913 		} else {
1914 			/* PCM or DOP mode (S32) requested */
1915 			/* PCM mode (S16) requested */
1916 			err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1917 					      USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1918 					      0, 1, NULL, 0);
1919 			if (err < 0)
1920 				return err;
1921 
1922 		}
1923 		msleep(20);
1924 	}
1925 	return 0;
1926 }
1927 
snd_usb_endpoint_start_quirk(struct snd_usb_endpoint * ep)1928 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1929 {
1930 	/*
1931 	 * "Playback Design" products send bogus feedback data at the start
1932 	 * of the stream. Ignore them.
1933 	 */
1934 	if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1935 	    ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1936 		ep->skip_packets = 4;
1937 
1938 	/*
1939 	 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1940 	 * world latency varies by approx. +/- 50 frames (at 96kHz) each time
1941 	 * the stream is (re)started. When skipping packets 16 at endpoint
1942 	 * start up, the real world latency is stable within +/- 1 frame (also
1943 	 * across power cycles).
1944 	 */
1945 	if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1946 	     ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1947 	    ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1948 		ep->skip_packets = 16;
1949 
1950 	/* Work around devices that report unreasonable feedback data */
1951 	if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) ||  /* TEAC UD-H01 */
1952 	     ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1953 	    ep->syncmaxsize == 4)
1954 		ep->tenor_fb_quirk = 1;
1955 }
1956 
1957 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
snd_usb_ctl_msg_quirk(struct usb_device * dev,unsigned int pipe,__u8 request,__u8 requesttype,__u16 value,__u16 index,void * data,__u16 size)1958 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1959 			   __u8 request, __u8 requesttype, __u16 value,
1960 			   __u16 index, void *data, __u16 size)
1961 {
1962 	struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1963 
1964 	if (!chip || (requesttype & USB_TYPE_MASK) != USB_TYPE_CLASS)
1965 		return;
1966 
1967 	if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY)
1968 		msleep(20);
1969 	else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_1M)
1970 		usleep_range(1000, 2000);
1971 	else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_5M)
1972 		usleep_range(5000, 6000);
1973 }
1974 
1975 /*
1976  * snd_usb_interface_dsd_format_quirks() is called from format.c to
1977  * augment the PCM format bit-field for DSD types. The UAC standards
1978  * don't have a designated bit field to denote DSD-capable interfaces,
1979  * hence all hardware that is known to support this format has to be
1980  * listed here.
1981  */
snd_usb_interface_dsd_format_quirks(struct snd_usb_audio * chip,struct audioformat * fp,unsigned int sample_bytes)1982 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1983 					struct audioformat *fp,
1984 					unsigned int sample_bytes)
1985 {
1986 	struct usb_interface *iface;
1987 
1988 	/* Playback Designs */
1989 	if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1990 	    USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
1991 		switch (fp->altsetting) {
1992 		case 1:
1993 			fp->dsd_dop = true;
1994 			return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1995 		case 2:
1996 			fp->dsd_bitrev = true;
1997 			return SNDRV_PCM_FMTBIT_DSD_U8;
1998 		case 3:
1999 			fp->dsd_bitrev = true;
2000 			return SNDRV_PCM_FMTBIT_DSD_U16_LE;
2001 		}
2002 	}
2003 
2004 	/* XMOS based USB DACs */
2005 	switch (chip->usb_id) {
2006 	case USB_ID(0x139f, 0x5504): /* Nagra DAC */
2007 	case USB_ID(0x20b1, 0x3089): /* Mola-Mola DAC */
2008 	case USB_ID(0x2522, 0x0007): /* LH Labs Geek Out 1V5 */
2009 	case USB_ID(0x2522, 0x0009): /* LH Labs Geek Pulse X Inifinity 2V0 */
2010 	case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
2011 	case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
2012 		if (fp->altsetting == 2)
2013 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2014 		break;
2015 
2016 	case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
2017 	case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
2018 	case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
2019 	case USB_ID(0x16d0, 0x06b4): /* NuPrime Audio HD-AVP/AVA */
2020 	case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
2021 	case USB_ID(0x16d0, 0x09d8): /* NuPrime IDA-8 */
2022 	case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
2023 	case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
2024 	case USB_ID(0x16d0, 0x0ab1): /* PureAudio APA DAC */
2025 	case USB_ID(0x16d0, 0xeca1): /* PureAudio Lotus DAC5, DAC5 SE, DAC5 Pro */
2026 	case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
2027 	case USB_ID(0x20a0, 0x4143): /* WaveIO USB Audio 2.0 */
2028 	case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
2029 	case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
2030 	case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
2031 	case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
2032 	case USB_ID(0x2622, 0x0061): /* LEAK Stereo 230 */
2033 	case USB_ID(0x278b, 0x5100): /* Rotel RC-1590 */
2034 	case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
2035 	case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
2036 	case USB_ID(0x6b42, 0x0042): /* MSB Technology */
2037 		if (fp->altsetting == 3)
2038 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2039 		break;
2040 
2041 	/* Amanero Combo384 USB based DACs with native DSD support */
2042 	case USB_ID(0x16d0, 0x071a):  /* Amanero - Combo384 */
2043 		if (fp->altsetting == 2) {
2044 			switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
2045 			case 0x199:
2046 				return SNDRV_PCM_FMTBIT_DSD_U32_LE;
2047 			case 0x19b:
2048 			case 0x203:
2049 				return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2050 			default:
2051 				break;
2052 			}
2053 		}
2054 		break;
2055 	case USB_ID(0x16d0, 0x0a23):
2056 		if (fp->altsetting == 2)
2057 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2058 		break;
2059 
2060 	default:
2061 		break;
2062 	}
2063 
2064 	/* ITF-USB DSD based DACs */
2065 	if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
2066 		iface = usb_ifnum_to_if(chip->dev, fp->iface);
2067 
2068 		/* Altsetting 2 support native DSD if the num of altsets is
2069 		 * three (0-2),
2070 		 * Altsetting 3 support native DSD if the num of altsets is
2071 		 * four (0-3).
2072 		 */
2073 		if (fp->altsetting == iface->num_altsetting - 1)
2074 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2075 	}
2076 
2077 	/* Mostly generic method to detect many DSD-capable implementations */
2078 	if ((chip->quirk_flags & QUIRK_FLAG_DSD_RAW) && fp->dsd_raw)
2079 		return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2080 
2081 	return 0;
2082 }
2083 
snd_usb_audioformat_attributes_quirk(struct snd_usb_audio * chip,struct audioformat * fp,int stream)2084 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
2085 					  struct audioformat *fp,
2086 					  int stream)
2087 {
2088 	switch (chip->usb_id) {
2089 	case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2090 		/* Optoplay sets the sample rate attribute although
2091 		 * it seems not supporting it in fact.
2092 		 */
2093 		fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
2094 		break;
2095 	case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2096 	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2097 		/* doesn't set the sample rate attribute, but supports it */
2098 		fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
2099 		break;
2100 	case USB_ID(0x0763, 0x2001):  /* M-Audio Quattro USB */
2101 	case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
2102 	case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2103 	case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2104 					an older model 77d:223) */
2105 	/*
2106 	 * plantronics headset and Griffin iMic have set adaptive-in
2107 	 * although it's really not...
2108 	 */
2109 		fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
2110 		if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2111 			fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
2112 		else
2113 			fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
2114 		break;
2115 	case USB_ID(0x07fd, 0x0004):  /* MOTU MicroBook IIc */
2116 		/*
2117 		 * MaxPacketsOnly attribute is erroneously set in endpoint
2118 		 * descriptors. As a result this card produces noise with
2119 		 * all sample rates other than 96 kHz.
2120 		 */
2121 		fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
2122 		break;
2123 	case USB_ID(0x1224, 0x2a25):  /* Jieli Technology USB PHY 2.0 */
2124 		/* mic works only when ep packet size is set to wMaxPacketSize */
2125 		fp->attributes |= UAC_EP_CS_ATTR_FILL_MAX;
2126 		break;
2127 	case USB_ID(0x3511, 0x2b1e): /* Opencomm2 UC USB Bluetooth dongle */
2128 		/* mic works only when ep pitch control is not set */
2129 		if (stream == SNDRV_PCM_STREAM_CAPTURE)
2130 			fp->attributes &= ~UAC_EP_CS_ATTR_PITCH_CONTROL;
2131 		break;
2132 	}
2133 }
2134 
2135 /*
2136  * driver behavior quirk flags
2137  */
2138 struct usb_audio_quirk_flags_table {
2139 	u32 id;
2140 	u32 flags;
2141 };
2142 
2143 #define DEVICE_FLG(vid, pid, _flags) \
2144 	{ .id = USB_ID(vid, pid), .flags = (_flags) }
2145 #define VENDOR_FLG(vid, _flags) DEVICE_FLG(vid, 0, _flags)
2146 
2147 static const struct usb_audio_quirk_flags_table quirk_flags_table[] = {
2148 	/* Device matches */
2149 	DEVICE_FLG(0x001f, 0x0b21, /* AB13X USB Audio */
2150 		   QUIRK_FLAG_FORCE_IFACE_RESET | QUIRK_FLAG_IFACE_DELAY),
2151 	DEVICE_FLG(0x0020, 0x0b21, /* GHW-123P */
2152 		   QUIRK_FLAG_FORCE_IFACE_RESET | QUIRK_FLAG_IFACE_DELAY),
2153 	DEVICE_FLG(0x03f0, 0x654a, /* HP 320 FHD Webcam */
2154 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_MIC_RES_16),
2155 	DEVICE_FLG(0x041e, 0x3000, /* Creative SB Extigy */
2156 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2157 	DEVICE_FLG(0x041e, 0x4080, /* Creative Live Cam VF0610 */
2158 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2159 	DEVICE_FLG(0x045e, 0x083c, /* MS USB Link headset */
2160 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY |
2161 		   QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2162 	DEVICE_FLG(0x045e, 0x070f, /* MS LifeChat LX-3000 Headset */
2163 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2164 	DEVICE_FLG(0x046d, 0x0807, /* Logitech Webcam C500 */
2165 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2166 	DEVICE_FLG(0x046d, 0x0808, /* Logitech Webcam C600 */
2167 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2168 	DEVICE_FLG(0x046d, 0x0809,
2169 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2170 	DEVICE_FLG(0x046d, 0x0819, /* Logitech Webcam C210 */
2171 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2172 	DEVICE_FLG(0x046d, 0x081b, /* HD Webcam c310 */
2173 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2174 	DEVICE_FLG(0x046d, 0x081d, /* HD Webcam c510 */
2175 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2176 	DEVICE_FLG(0x046d, 0x0825, /* HD Webcam c270 */
2177 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2178 	DEVICE_FLG(0x046d, 0x0826, /* HD Webcam c525 */
2179 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2180 	DEVICE_FLG(0x046d, 0x084c, /* Logitech ConferenceCam Connect */
2181 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2182 	DEVICE_FLG(0x046d, 0x08ca, /* Logitech Quickcam Fusion */
2183 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2184 	DEVICE_FLG(0x046d, 0x0991, /* Logitech QuickCam Pro */
2185 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR |
2186 		   QUIRK_FLAG_MIC_RES_384),
2187 	DEVICE_FLG(0x046d, 0x09a2, /* QuickCam Communicate Deluxe/S7500 */
2188 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2189 	DEVICE_FLG(0x046d, 0x09a4, /* Logitech QuickCam E 3500 */
2190 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR),
2191 	DEVICE_FLG(0x046d, 0x0a8f, /* Logitech H390 headset */
2192 		   QUIRK_FLAG_CTL_MSG_DELAY_1M |
2193 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2194 	DEVICE_FLG(0x0499, 0x1506, /* Yamaha THR5 */
2195 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2196 	DEVICE_FLG(0x0499, 0x1509, /* Steinberg UR22 */
2197 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2198 	DEVICE_FLG(0x0499, 0x3108, /* Yamaha YIT-W12TX */
2199 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2200 	DEVICE_FLG(0x04d8, 0xfeea, /* Benchmark DAC1 Pre */
2201 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2202 	DEVICE_FLG(0x04e8, 0xa051, /* Samsung USBC Headset (AKG) */
2203 		   QUIRK_FLAG_SKIP_CLOCK_SELECTOR | QUIRK_FLAG_CTL_MSG_DELAY_5M),
2204 	DEVICE_FLG(0x0525, 0xa4ad, /* Hamedal C20 usb camero */
2205 		   QUIRK_FLAG_IFACE_SKIP_CLOSE),
2206 	DEVICE_FLG(0x054c, 0x0b8c, /* Sony WALKMAN NW-A45 DAC */
2207 		   QUIRK_FLAG_SET_IFACE_FIRST),
2208 	DEVICE_FLG(0x0556, 0x0014, /* Phoenix Audio TMX320VC */
2209 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2210 	DEVICE_FLG(0x0572, 0x1b08, /* Conexant Systems (Rockwell), Inc. */
2211 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2212 	DEVICE_FLG(0x0572, 0x1b09, /* Conexant Systems (Rockwell), Inc. */
2213 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2214 	DEVICE_FLG(0x05a3, 0x9420, /* ELP HD USB Camera */
2215 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2216 	DEVICE_FLG(0x05a7, 0x1020, /* Bose Companion 5 */
2217 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2218 	DEVICE_FLG(0x05e1, 0x0408, /* Syntek STK1160 */
2219 		   QUIRK_FLAG_ALIGN_TRANSFER),
2220 	DEVICE_FLG(0x05e1, 0x0480, /* Hauppauge Woodbury */
2221 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2222 	DEVICE_FLG(0x0644, 0x8043, /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
2223 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2224 		   QUIRK_FLAG_IFACE_DELAY),
2225 	DEVICE_FLG(0x0644, 0x8044, /* Esoteric D-05X */
2226 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2227 		   QUIRK_FLAG_IFACE_DELAY | QUIRK_FLAG_FORCE_IFACE_RESET),
2228 	DEVICE_FLG(0x0644, 0x804a, /* TEAC UD-301 */
2229 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2230 		   QUIRK_FLAG_IFACE_DELAY),
2231 	DEVICE_FLG(0x0644, 0x805f, /* TEAC Model 12 */
2232 		   QUIRK_FLAG_FORCE_IFACE_RESET),
2233 	DEVICE_FLG(0x0644, 0x806b, /* TEAC UD-701 */
2234 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2235 		   QUIRK_FLAG_IFACE_DELAY | QUIRK_FLAG_FORCE_IFACE_RESET),
2236 	DEVICE_FLG(0x0644, 0x807d, /* TEAC UD-507 */
2237 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2238 		   QUIRK_FLAG_IFACE_DELAY | QUIRK_FLAG_FORCE_IFACE_RESET),
2239 	DEVICE_FLG(0x0644, 0x806c, /* Esoteric XD */
2240 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2241 		   QUIRK_FLAG_IFACE_DELAY | QUIRK_FLAG_FORCE_IFACE_RESET),
2242 	DEVICE_FLG(0x0661, 0x0883, /* iBasso DC04 Ultra */
2243 		   QUIRK_FLAG_DSD_RAW),
2244 	DEVICE_FLG(0x06f8, 0xb000, /* Hercules DJ Console (Windows Edition) */
2245 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2246 	DEVICE_FLG(0x06f8, 0xd002, /* Hercules DJ Console (Macintosh Edition) */
2247 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2248 	DEVICE_FLG(0x0711, 0x5800, /* MCT Trigger 5 USB-to-HDMI */
2249 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2250 	DEVICE_FLG(0x074d, 0x3553, /* Outlaw RR2150 (Micronas UAC3553B) */
2251 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2252 	DEVICE_FLG(0x0763, 0x2030, /* M-Audio Fast Track C400 */
2253 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2254 	DEVICE_FLG(0x0763, 0x2031, /* M-Audio Fast Track C600 */
2255 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2256 	DEVICE_FLG(0x07fd, 0x000b, /* MOTU M Series 2nd hardware revision */
2257 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2258 	DEVICE_FLG(0x08bb, 0x2702, /* LineX FM Transmitter */
2259 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2260 	DEVICE_FLG(0x0951, 0x16ad, /* Kingston HyperX */
2261 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2262 	DEVICE_FLG(0x0b05, 0x18a6, /* ASUSTek Computer, Inc. */
2263 		   QUIRK_FLAG_MIXER_CAPTURE_MIN_MUTE),
2264 	DEVICE_FLG(0x0b0e, 0x0349, /* Jabra 550a */
2265 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2266 	DEVICE_FLG(0x0bda, 0x498a, /* Realtek Semiconductor Corp. */
2267 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE | QUIRK_FLAG_MIXER_CAPTURE_MIN_MUTE),
2268 	DEVICE_FLG(0x0c45, 0x6340, /* Sonix HD USB Camera */
2269 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2270 	DEVICE_FLG(0x0c45, 0x636b, /* Microdia JP001 USB Camera */
2271 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2272 	DEVICE_FLG(0x0d8c, 0x000c, /* C-Media */
2273 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2274 	DEVICE_FLG(0x0d8c, 0x0012, /* C-Media */
2275 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2276 	DEVICE_FLG(0x0d8c, 0x0014, /* C-Media */
2277 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2278 	DEVICE_FLG(0x0ecb, 0x205c, /* JBL Quantum610 Wireless */
2279 		   QUIRK_FLAG_FIXED_RATE),
2280 	DEVICE_FLG(0x0ecb, 0x2069, /* JBL Quantum810 Wireless */
2281 		   QUIRK_FLAG_FIXED_RATE),
2282 	DEVICE_FLG(0x0fd9, 0x0008, /* Hauppauge HVR-950Q */
2283 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2284 	DEVICE_FLG(0x1038, 0x1294, /* SteelSeries Arctis Pro Wireless */
2285 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2286 	DEVICE_FLG(0x1101, 0x0003, /* Audioengine D1 */
2287 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2288 	DEVICE_FLG(0x12d1, 0x3a07, /* Huawei Technologies Co., Ltd. */
2289 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE | QUIRK_FLAG_MIXER_CAPTURE_MIN_MUTE),
2290 	DEVICE_FLG(0x1224, 0x2a25, /* Jieli Technology USB PHY 2.0 */
2291 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_MIC_RES_16),
2292 	DEVICE_FLG(0x1395, 0x740a, /* Sennheiser DECT */
2293 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2294 	DEVICE_FLG(0x1397, 0x0507, /* Behringer UMC202HD */
2295 		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2296 	DEVICE_FLG(0x1397, 0x0508, /* Behringer UMC204HD */
2297 		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2298 	DEVICE_FLG(0x1397, 0x0509, /* Behringer UMC404HD */
2299 		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2300 	DEVICE_FLG(0x13e5, 0x0001, /* Serato Phono */
2301 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2302 	DEVICE_FLG(0x154e, 0x1002, /* Denon DCD-1500RE */
2303 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2304 	DEVICE_FLG(0x154e, 0x1003, /* Denon DA-300USB */
2305 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2306 	DEVICE_FLG(0x154e, 0x3005, /* Marantz HD-DAC1 */
2307 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2308 	DEVICE_FLG(0x154e, 0x3006, /* Marantz SA-14S1 */
2309 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2310 	DEVICE_FLG(0x154e, 0x300b, /* Marantz SA-KI RUBY / SA-12 */
2311 		   QUIRK_FLAG_DSD_RAW),
2312 	DEVICE_FLG(0x154e, 0x500e, /* Denon DN-X1600 */
2313 		   QUIRK_FLAG_IGNORE_CLOCK_SOURCE),
2314 	DEVICE_FLG(0x1686, 0x00dd, /* Zoom R16/24 */
2315 		   QUIRK_FLAG_TX_LENGTH | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2316 	DEVICE_FLG(0x16d0, 0x0ab1, /* PureAudio APA DAC */
2317 		   QUIRK_FLAG_DSD_RAW),
2318 	DEVICE_FLG(0x16d0, 0xeca1, /* PureAudio Lotus DAC5, DAC5 SE and DAC5 Pro */
2319 		   QUIRK_FLAG_DSD_RAW),
2320 	DEVICE_FLG(0x17aa, 0x1046, /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
2321 		   QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2322 	DEVICE_FLG(0x17aa, 0x104d, /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
2323 		   QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2324 	DEVICE_FLG(0x17ef, 0x3083, /* Lenovo TBT3 dock */
2325 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2326 	DEVICE_FLG(0x1852, 0x5062, /* Luxman D-08u */
2327 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2328 	DEVICE_FLG(0x1852, 0x5065, /* Luxman DA-06 */
2329 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2330 	DEVICE_FLG(0x1901, 0x0191, /* GE B850V3 CP2114 audio interface */
2331 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2332 	DEVICE_FLG(0x19f7, 0x0003, /* RODE NT-USB */
2333 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2334 	DEVICE_FLG(0x19f7, 0x0035, /* RODE NT-USB+ */
2335 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2336 	DEVICE_FLG(0x1bcf, 0x2281, /* HD Webcam */
2337 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_MIC_RES_16),
2338 	DEVICE_FLG(0x1bcf, 0x2283, /* NexiGo N930AF FHD Webcam */
2339 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_MIC_RES_16),
2340 	DEVICE_FLG(0x2040, 0x7200, /* Hauppauge HVR-950Q */
2341 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2342 	DEVICE_FLG(0x2040, 0x7201, /* Hauppauge HVR-950Q-MXL */
2343 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2344 	DEVICE_FLG(0x2040, 0x7210, /* Hauppauge HVR-950Q */
2345 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2346 	DEVICE_FLG(0x2040, 0x7211, /* Hauppauge HVR-950Q-MXL */
2347 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2348 	DEVICE_FLG(0x2040, 0x7213, /* Hauppauge HVR-950Q */
2349 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2350 	DEVICE_FLG(0x2040, 0x7217, /* Hauppauge HVR-950Q */
2351 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2352 	DEVICE_FLG(0x2040, 0x721b, /* Hauppauge HVR-950Q */
2353 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2354 	DEVICE_FLG(0x2040, 0x721e, /* Hauppauge HVR-950Q */
2355 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2356 	DEVICE_FLG(0x2040, 0x721f, /* Hauppauge HVR-950Q */
2357 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2358 	DEVICE_FLG(0x2040, 0x7240, /* Hauppauge HVR-850 */
2359 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2360 	DEVICE_FLG(0x2040, 0x7260, /* Hauppauge HVR-950Q */
2361 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2362 	DEVICE_FLG(0x2040, 0x7270, /* Hauppauge HVR-950Q */
2363 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2364 	DEVICE_FLG(0x2040, 0x7280, /* Hauppauge HVR-950Q */
2365 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2366 	DEVICE_FLG(0x2040, 0x7281, /* Hauppauge HVR-950Q-MXL */
2367 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2368 	DEVICE_FLG(0x2040, 0x8200, /* Hauppauge Woodbury */
2369 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2370 	DEVICE_FLG(0x21b4, 0x0081, /* AudioQuest DragonFly */
2371 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2372 	DEVICE_FLG(0x21b4, 0x0230, /* Ayre QB-9 Twenty */
2373 		   QUIRK_FLAG_DSD_RAW),
2374 	DEVICE_FLG(0x21b4, 0x0232, /* Ayre QX-5 Twenty */
2375 		   QUIRK_FLAG_DSD_RAW),
2376 	DEVICE_FLG(0x2522, 0x0007, /* LH Labs Geek Out HD Audio 1V5 */
2377 		   QUIRK_FLAG_SET_IFACE_FIRST),
2378 	DEVICE_FLG(0x262a, 0x9302, /* ddHiFi TC44C */
2379 		   QUIRK_FLAG_DSD_RAW),
2380 	DEVICE_FLG(0x2708, 0x0002, /* Audient iD14 */
2381 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2382 	DEVICE_FLG(0x2912, 0x30c8, /* Audioengine D1 */
2383 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2384 	DEVICE_FLG(0x2a70, 0x1881, /* OnePlus Technology (Shenzhen) Co., Ltd. BE02T */
2385 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE | QUIRK_FLAG_MIXER_CAPTURE_MIN_MUTE),
2386 	DEVICE_FLG(0x2b53, 0x0023, /* Fiero SC-01 (firmware v1.0.0 @ 48 kHz) */
2387 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2388 	DEVICE_FLG(0x2b53, 0x0024, /* Fiero SC-01 (firmware v1.0.0 @ 96 kHz) */
2389 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2390 	DEVICE_FLG(0x2b53, 0x0031, /* Fiero SC-01 (firmware v1.1.0) */
2391 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2392 	DEVICE_FLG(0x2d95, 0x8011, /* VIVO USB-C HEADSET */
2393 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2394 	DEVICE_FLG(0x2d95, 0x8021, /* VIVO USB-C-XE710 HEADSET */
2395 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2396 	DEVICE_FLG(0x2d99, 0x0026, /* HECATE G2 GAMING HEADSET */
2397 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2398 	DEVICE_FLG(0x2fc6, 0xf06b, /* MOONDROP Moonriver2 Ti */
2399 		   QUIRK_FLAG_CTL_MSG_DELAY),
2400 	DEVICE_FLG(0x2fc6, 0xf0b7, /* iBasso DC07 Pro */
2401 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2402 	DEVICE_FLG(0x30be, 0x0101, /* Schiit Hel */
2403 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2404 	DEVICE_FLG(0x3255, 0x0000, /* Luxman D-10X */
2405 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2406 	DEVICE_FLG(0x339b, 0x3a07, /* Synaptics HONOR USB-C HEADSET */
2407 		   QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2408 	DEVICE_FLG(0x413c, 0xa506, /* Dell AE515 sound bar */
2409 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2410 	DEVICE_FLG(0x534d, 0x0021, /* MacroSilicon MS2100/MS2106 */
2411 		   QUIRK_FLAG_ALIGN_TRANSFER),
2412 	DEVICE_FLG(0x534d, 0x2109, /* MacroSilicon MS2109 */
2413 		   QUIRK_FLAG_ALIGN_TRANSFER),
2414 
2415 	/* Vendor matches */
2416 	VENDOR_FLG(0x045e, /* MS Lifecam */
2417 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2418 	VENDOR_FLG(0x046d, /* Logitech */
2419 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2420 	VENDOR_FLG(0x047f, /* Plantronics */
2421 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY),
2422 	VENDOR_FLG(0x0644, /* TEAC Corp. */
2423 		   QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY),
2424 	VENDOR_FLG(0x07fd, /* MOTU */
2425 		   QUIRK_FLAG_VALIDATE_RATES),
2426 	VENDOR_FLG(0x1235, /* Focusrite Novation */
2427 		   QUIRK_FLAG_VALIDATE_RATES),
2428 	VENDOR_FLG(0x1511, /* AURALiC */
2429 		   QUIRK_FLAG_DSD_RAW),
2430 	VENDOR_FLG(0x152a, /* Thesycon devices */
2431 		   QUIRK_FLAG_DSD_RAW),
2432 	VENDOR_FLG(0x18d1, /* iBasso devices */
2433 		   QUIRK_FLAG_DSD_RAW),
2434 	VENDOR_FLG(0x1de7, /* Phoenix Audio */
2435 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2436 	VENDOR_FLG(0x20b1, /* XMOS based devices */
2437 		   QUIRK_FLAG_DSD_RAW),
2438 	VENDOR_FLG(0x21ed, /* Accuphase Laboratory */
2439 		   QUIRK_FLAG_DSD_RAW),
2440 	VENDOR_FLG(0x22d9, /* Oppo */
2441 		   QUIRK_FLAG_DSD_RAW),
2442 	VENDOR_FLG(0x23ba, /* Playback Design */
2443 		   QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY |
2444 		   QUIRK_FLAG_DSD_RAW),
2445 	VENDOR_FLG(0x25ce, /* Mytek devices */
2446 		   QUIRK_FLAG_DSD_RAW),
2447 	VENDOR_FLG(0x2622, /* IAG Limited devices */
2448 		   QUIRK_FLAG_DSD_RAW),
2449 	VENDOR_FLG(0x2772, /* Musical Fidelity devices */
2450 		   QUIRK_FLAG_DSD_RAW),
2451 	VENDOR_FLG(0x278b, /* Rotel? */
2452 		   QUIRK_FLAG_DSD_RAW),
2453 	VENDOR_FLG(0x292b, /* Gustard/Ess based devices */
2454 		   QUIRK_FLAG_DSD_RAW),
2455 	VENDOR_FLG(0x2972, /* FiiO devices */
2456 		   QUIRK_FLAG_DSD_RAW),
2457 	VENDOR_FLG(0x2ab6, /* T+A devices */
2458 		   QUIRK_FLAG_DSD_RAW),
2459 	VENDOR_FLG(0x2afd, /* McIntosh Laboratory, Inc. */
2460 		   QUIRK_FLAG_DSD_RAW),
2461 	VENDOR_FLG(0x2d87, /* Cayin device */
2462 		   QUIRK_FLAG_DSD_RAW),
2463 	VENDOR_FLG(0x2fc6, /* Comture-inc devices */
2464 		   QUIRK_FLAG_DSD_RAW),
2465 	VENDOR_FLG(0x3336, /* HEM devices */
2466 		   QUIRK_FLAG_DSD_RAW),
2467 	VENDOR_FLG(0x3353, /* Khadas devices */
2468 		   QUIRK_FLAG_DSD_RAW),
2469 	VENDOR_FLG(0x35f4, /* MSB Technology */
2470 		   QUIRK_FLAG_DSD_RAW),
2471 	VENDOR_FLG(0x3842, /* EVGA */
2472 		   QUIRK_FLAG_DSD_RAW),
2473 	VENDOR_FLG(0xc502, /* HiBy devices */
2474 		   QUIRK_FLAG_DSD_RAW),
2475 
2476 	{} /* terminator */
2477 };
2478 
2479 #define QUIRK_STRING_ENTRY(x) \
2480 	[QUIRK_TYPE_ ## x] = __stringify(x)
2481 
2482 static const char *const snd_usb_audio_quirk_flag_names[] = {
2483 	QUIRK_STRING_ENTRY(GET_SAMPLE_RATE),
2484 	QUIRK_STRING_ENTRY(SHARE_MEDIA_DEVICE),
2485 	QUIRK_STRING_ENTRY(ALIGN_TRANSFER),
2486 	QUIRK_STRING_ENTRY(TX_LENGTH),
2487 	QUIRK_STRING_ENTRY(PLAYBACK_FIRST),
2488 	QUIRK_STRING_ENTRY(SKIP_CLOCK_SELECTOR),
2489 	QUIRK_STRING_ENTRY(IGNORE_CLOCK_SOURCE),
2490 	QUIRK_STRING_ENTRY(ITF_USB_DSD_DAC),
2491 	QUIRK_STRING_ENTRY(CTL_MSG_DELAY),
2492 	QUIRK_STRING_ENTRY(CTL_MSG_DELAY_1M),
2493 	QUIRK_STRING_ENTRY(CTL_MSG_DELAY_5M),
2494 	QUIRK_STRING_ENTRY(IFACE_DELAY),
2495 	QUIRK_STRING_ENTRY(VALIDATE_RATES),
2496 	QUIRK_STRING_ENTRY(DISABLE_AUTOSUSPEND),
2497 	QUIRK_STRING_ENTRY(IGNORE_CTL_ERROR),
2498 	QUIRK_STRING_ENTRY(DSD_RAW),
2499 	QUIRK_STRING_ENTRY(SET_IFACE_FIRST),
2500 	QUIRK_STRING_ENTRY(GENERIC_IMPLICIT_FB),
2501 	QUIRK_STRING_ENTRY(SKIP_IMPLICIT_FB),
2502 	QUIRK_STRING_ENTRY(IFACE_SKIP_CLOSE),
2503 	QUIRK_STRING_ENTRY(FORCE_IFACE_RESET),
2504 	QUIRK_STRING_ENTRY(FIXED_RATE),
2505 	QUIRK_STRING_ENTRY(MIC_RES_16),
2506 	QUIRK_STRING_ENTRY(MIC_RES_384),
2507 	QUIRK_STRING_ENTRY(MIXER_PLAYBACK_MIN_MUTE),
2508 	QUIRK_STRING_ENTRY(MIXER_CAPTURE_MIN_MUTE),
2509 	NULL
2510 };
2511 
snd_usb_quirk_flag_find_name(unsigned long index)2512 const char *snd_usb_quirk_flag_find_name(unsigned long index)
2513 {
2514 	if (index >= ARRAY_SIZE(snd_usb_audio_quirk_flag_names))
2515 		return NULL;
2516 
2517 	return snd_usb_audio_quirk_flag_names[index];
2518 }
2519 
snd_usb_quirk_flags_from_name(const char * name)2520 u32 snd_usb_quirk_flags_from_name(const char *name)
2521 {
2522 	int i;
2523 
2524 	if (!name || !*name)
2525 		return 0;
2526 
2527 	for (i = 0; snd_usb_audio_quirk_flag_names[i]; i++) {
2528 		if (strcasecmp(name, snd_usb_audio_quirk_flag_names[i]) == 0)
2529 			return BIT_U32(i);
2530 	}
2531 
2532 	return 0;
2533 }
2534 
snd_usb_apply_flag_dbg(const char * reason,struct snd_usb_audio * chip,unsigned long flag)2535 void snd_usb_apply_flag_dbg(const char *reason,
2536 			    struct snd_usb_audio *chip,
2537 			    unsigned long flag)
2538 {
2539 	unsigned long bit;
2540 
2541 	for_each_set_bit(bit, &flag, BYTES_TO_BITS(sizeof(flag))) {
2542 		const char *name = snd_usb_audio_quirk_flag_names[bit];
2543 
2544 		if (name)
2545 			usb_audio_dbg(chip,
2546 				      "From %s apply quirk flag %s for device %04x:%04x\n",
2547 				      reason, name, USB_ID_VENDOR(chip->usb_id),
2548 				      USB_ID_PRODUCT(chip->usb_id));
2549 		else
2550 			usb_audio_warn(chip,
2551 				       "From %s apply unknown quirk flag 0x%lx for device %04x:%04x\n",
2552 				       reason, bit, USB_ID_VENDOR(chip->usb_id),
2553 				       USB_ID_PRODUCT(chip->usb_id));
2554 	}
2555 }
2556 
snd_usb_init_quirk_flags_table(struct snd_usb_audio * chip)2557 void snd_usb_init_quirk_flags_table(struct snd_usb_audio *chip)
2558 {
2559 	const struct usb_audio_quirk_flags_table *p;
2560 
2561 	for (p = quirk_flags_table; p->id; p++) {
2562 		if (chip->usb_id == p->id ||
2563 		    (!USB_ID_PRODUCT(p->id) &&
2564 		     USB_ID_VENDOR(chip->usb_id) == USB_ID_VENDOR(p->id))) {
2565 			snd_usb_apply_flag_dbg("builtin table", chip, p->flags);
2566 			chip->quirk_flags |= p->flags;
2567 			return;
2568 		}
2569 	}
2570 }
2571 
snd_usb_init_quirk_flags_parse_string(struct snd_usb_audio * chip,const char * str)2572 void snd_usb_init_quirk_flags_parse_string(struct snd_usb_audio *chip,
2573 					   const char *str)
2574 {
2575 	u16 chip_vid = USB_ID_VENDOR(chip->usb_id);
2576 	u16 chip_pid = USB_ID_PRODUCT(chip->usb_id);
2577 	u32 mask_flags, unmask_flags, bit;
2578 	char *p, *field, *flag;
2579 	bool is_unmask;
2580 	u16 vid, pid;
2581 
2582 	char *val __free(kfree) = kstrdup(str, GFP_KERNEL);
2583 
2584 	if (!val)
2585 		return;
2586 
2587 	for (p = val; p && *p;) {
2588 		/* Each entry consists of VID:PID:flags */
2589 		field = strsep(&p, ":");
2590 		if (!field)
2591 			break;
2592 
2593 		if (strcmp(field, "*") == 0)
2594 			vid = 0;
2595 		else if (kstrtou16(field, 16, &vid))
2596 			break;
2597 
2598 		field = strsep(&p, ":");
2599 		if (!field)
2600 			break;
2601 
2602 		if (strcmp(field, "*") == 0)
2603 			pid = 0;
2604 		else if (kstrtou16(field, 16, &pid))
2605 			break;
2606 
2607 		field = strsep(&p, ";");
2608 		if (!field || !*field)
2609 			break;
2610 
2611 		if ((vid != 0 && vid != chip_vid) ||
2612 		    (pid != 0 && pid != chip_pid))
2613 			continue;
2614 
2615 		/* Collect the flags */
2616 		mask_flags = 0;
2617 		unmask_flags = 0;
2618 		while (field && *field) {
2619 			flag = strsep(&field, "|");
2620 
2621 			if (!flag)
2622 				break;
2623 
2624 			if (*flag == '!') {
2625 				is_unmask = true;
2626 				flag++;
2627 			} else {
2628 				is_unmask = false;
2629 			}
2630 
2631 			if (!kstrtou32(flag, 16, &bit)) {
2632 				if (is_unmask)
2633 					unmask_flags |= bit;
2634 				else
2635 					mask_flags |= bit;
2636 
2637 				break;
2638 			}
2639 
2640 			bit = snd_usb_quirk_flags_from_name(flag);
2641 
2642 			if (bit) {
2643 				if (is_unmask)
2644 					unmask_flags |= bit;
2645 				else
2646 					mask_flags |= bit;
2647 			} else {
2648 				pr_warn("snd_usb_audio: unknown flag %s while parsing param quirk_flags\n",
2649 					flag);
2650 			}
2651 		}
2652 
2653 		chip->quirk_flags &= ~unmask_flags;
2654 		chip->quirk_flags |= mask_flags;
2655 		snd_usb_apply_flag_dbg("module param", chip,
2656 				       chip->quirk_flags);
2657 	}
2658 }
2659