xref: /openbmc/linux/sound/usb/quirks.c (revision e5242c5f)
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  */
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 
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 
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  */
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  */
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  */
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(fp->rate_table,
171 				     sizeof(int) * fp->nr_rates, 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 
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 
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 
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 
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 
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 
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  */
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  */
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  */
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 
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 	struct usb_device_descriptor new_device_descriptor;
559 	int err;
560 
561 	if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
562 	    le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
563 		dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
564 		/* Send message to force it to reconnect with full interface. */
565 		err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
566 				      0x10, 0x43, 0x0001, 0x000a, NULL, 0);
567 		if (err < 0)
568 			dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
569 		err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
570 				&new_device_descriptor, sizeof(new_device_descriptor));
571 		if (err < 0)
572 			dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
573 		if (new_device_descriptor.bNumConfigurations > dev->descriptor.bNumConfigurations)
574 			dev_dbg(&dev->dev, "error too large bNumConfigurations: %d\n",
575 				new_device_descriptor.bNumConfigurations);
576 		else
577 			memcpy(&dev->descriptor, &new_device_descriptor, sizeof(dev->descriptor));
578 		err = usb_reset_configuration(dev);
579 		if (err < 0)
580 			dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
581 		dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
582 			    le16_to_cpu(get_cfg_desc(config)->wTotalLength));
583 		return -ENODEV; /* quit this anyway */
584 	}
585 	return 0;
586 }
587 
588 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
589 {
590 	u8 buf = 1;
591 
592 	snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
593 			USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
594 			0, 0, &buf, 1);
595 	if (buf == 0) {
596 		snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
597 				USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
598 				1, 2000, NULL, 0);
599 		return -ENODEV;
600 	}
601 	return 0;
602 }
603 
604 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
605 {
606 	int err;
607 
608 	if (dev->actconfig->desc.bConfigurationValue == 1) {
609 		dev_info(&dev->dev,
610 			   "Fast Track Pro switching to config #2\n");
611 		/* This function has to be available by the usb core module.
612 		 * if it is not avialable the boot quirk has to be left out
613 		 * and the configuration has to be set by udev or hotplug
614 		 * rules
615 		 */
616 		err = usb_driver_set_configuration(dev, 2);
617 		if (err < 0)
618 			dev_dbg(&dev->dev,
619 				"error usb_driver_set_configuration: %d\n",
620 				err);
621 		/* Always return an error, so that we stop creating a device
622 		   that will just be destroyed and recreated with a new
623 		   configuration */
624 		return -ENODEV;
625 	} else
626 		dev_info(&dev->dev, "Fast Track Pro config OK\n");
627 
628 	return 0;
629 }
630 
631 /*
632  * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
633  * documented in the device's data sheet.
634  */
635 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
636 {
637 	u8 buf[4];
638 	buf[0] = 0x20;
639 	buf[1] = value & 0xff;
640 	buf[2] = (value >> 8) & 0xff;
641 	buf[3] = reg;
642 	return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
643 			       USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
644 			       0, 0, &buf, 4);
645 }
646 
647 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
648 {
649 	/*
650 	 * Enable line-out driver mode, set headphone source to front
651 	 * channels, enable stereo mic.
652 	 */
653 	return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
654 }
655 
656 /*
657  * CM6206 registers from the CM6206 datasheet rev 2.1
658  */
659 #define CM6206_REG0_DMA_MASTER BIT(15)
660 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
661 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
662 /* Bit 4 thru 11 is the S/PDIF category code */
663 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
664 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
665 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
666 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
667 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
668 
669 #define CM6206_REG1_TEST_SEL_CLK BIT(14)
670 #define CM6206_REG1_PLLBIN_EN BIT(13)
671 #define CM6206_REG1_SOFT_MUTE_EN BIT(12)
672 #define CM6206_REG1_GPIO4_OUT BIT(11)
673 #define CM6206_REG1_GPIO4_OE BIT(10)
674 #define CM6206_REG1_GPIO3_OUT BIT(9)
675 #define CM6206_REG1_GPIO3_OE BIT(8)
676 #define CM6206_REG1_GPIO2_OUT BIT(7)
677 #define CM6206_REG1_GPIO2_OE BIT(6)
678 #define CM6206_REG1_GPIO1_OUT BIT(5)
679 #define CM6206_REG1_GPIO1_OE BIT(4)
680 #define CM6206_REG1_SPDIFO_INVALID BIT(3)
681 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
682 #define CM6206_REG1_SPDIFO_DIS BIT(1)
683 #define CM6206_REG1_SPDIFI_MIX BIT(0)
684 
685 #define CM6206_REG2_DRIVER_ON BIT(15)
686 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
687 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
688 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
689 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
690 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
691 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
692 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
693 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
694 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
695 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
696 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
697 #define CM6206_REG2_MUTE_CENTER BIT(5)
698 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
699 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
700 #define CM6206_REG2_EN_BTL BIT(2)
701 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
702 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
703 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
704 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
705 
706 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
707 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
708 #define CM6206_REG3_VRAP25EN BIT(10)
709 #define CM6206_REG3_MSEL1 BIT(9)
710 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
711 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
712 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
713 #define CM6206_REG3_PINSEL BIT(6)
714 #define CM6206_REG3_FOE BIT(5)
715 #define CM6206_REG3_ROE BIT(4)
716 #define CM6206_REG3_CBOE BIT(3)
717 #define CM6206_REG3_LOSE BIT(2)
718 #define CM6206_REG3_HPOE BIT(1)
719 #define CM6206_REG3_SPDIFI_CANREC BIT(0)
720 
721 #define CM6206_REG5_DA_RSTN BIT(13)
722 #define CM6206_REG5_AD_RSTN BIT(12)
723 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
724 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
725 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
726 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
727 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
728 #define CM6206_REG5_CODECM BIT(8)
729 #define CM6206_REG5_EN_HPF BIT(7)
730 #define CM6206_REG5_T_SEL_DSDA4 BIT(6)
731 #define CM6206_REG5_T_SEL_DSDA3 BIT(5)
732 #define CM6206_REG5_T_SEL_DSDA2 BIT(4)
733 #define CM6206_REG5_T_SEL_DSDA1 BIT(3)
734 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
735 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4
736 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
737 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
738 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
739 
740 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
741 {
742 	int err  = 0, reg;
743 	int val[] = {
744 		/*
745 		 * Values here are chosen based on sniffing USB traffic
746 		 * under Windows.
747 		 *
748 		 * REG0: DAC is master, sample rate 48kHz, no copyright
749 		 */
750 		CM6206_REG0_SPDIFO_RATE_48K |
751 		CM6206_REG0_SPDIFO_COPYRIGHT_NA,
752 		/*
753 		 * REG1: PLL binary search enable, soft mute enable.
754 		 */
755 		CM6206_REG1_PLLBIN_EN |
756 		CM6206_REG1_SOFT_MUTE_EN,
757 		/*
758 		 * REG2: enable output drivers,
759 		 * select front channels to the headphone output,
760 		 * then mute the headphone channels, run the MCU
761 		 * at 1.5 MHz.
762 		 */
763 		CM6206_REG2_DRIVER_ON |
764 		CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
765 		CM6206_REG2_MUTE_HEADPHONE_RIGHT |
766 		CM6206_REG2_MUTE_HEADPHONE_LEFT,
767 		/*
768 		 * REG3: default flyspeed, set 2.5V mic bias
769 		 * enable all line out ports and enable SPDIF
770 		 */
771 		CM6206_REG3_FLYSPEED_DEFAULT |
772 		CM6206_REG3_VRAP25EN |
773 		CM6206_REG3_FOE |
774 		CM6206_REG3_ROE |
775 		CM6206_REG3_CBOE |
776 		CM6206_REG3_LOSE |
777 		CM6206_REG3_HPOE |
778 		CM6206_REG3_SPDIFI_CANREC,
779 		/* REG4 is just a bunch of GPIO lines */
780 		0x0000,
781 		/* REG5: de-assert AD/DA reset signals */
782 		CM6206_REG5_DA_RSTN |
783 		CM6206_REG5_AD_RSTN };
784 
785 	for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
786 		err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
787 		if (err < 0)
788 			return err;
789 	}
790 
791 	return err;
792 }
793 
794 /* quirk for Plantronics GameCom 780 with CM6302 chip */
795 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
796 {
797 	/* set the initial volume and don't change; other values are either
798 	 * too loud or silent due to firmware bug (bko#65251)
799 	 */
800 	u8 buf[2] = { 0x74, 0xe3 };
801 	return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
802 			USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
803 			UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
804 }
805 
806 /*
807  * Novation Twitch DJ controller
808  * Focusrite Novation Saffire 6 USB audio card
809  */
810 static int snd_usb_novation_boot_quirk(struct usb_device *dev)
811 {
812 	/* preemptively set up the device because otherwise the
813 	 * raw MIDI endpoints are not active */
814 	usb_set_interface(dev, 0, 1);
815 	return 0;
816 }
817 
818 /*
819  * This call will put the synth in "USB send" mode, i.e it will send MIDI
820  * messages through USB (this is disabled at startup). The synth will
821  * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
822  * sign on its LCD. Values here are chosen based on sniffing USB traffic
823  * under Windows.
824  */
825 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
826 {
827 	int err, actual_length;
828 	/* "midi send" enable */
829 	static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
830 	void *buf;
831 
832 	if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
833 		return -EINVAL;
834 	buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
835 	if (!buf)
836 		return -ENOMEM;
837 	err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
838 			ARRAY_SIZE(seq), &actual_length, 1000);
839 	kfree(buf);
840 	if (err < 0)
841 		return err;
842 
843 	return 0;
844 }
845 
846 /*
847  * Some sound cards from Native Instruments are in fact compliant to the USB
848  * audio standard of version 2 and other approved USB standards, even though
849  * they come up as vendor-specific device when first connected.
850  *
851  * However, they can be told to come up with a new set of descriptors
852  * upon their next enumeration, and the interfaces announced by the new
853  * descriptors will then be handled by the kernel's class drivers. As the
854  * product ID will also change, no further checks are required.
855  */
856 
857 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
858 {
859 	int ret;
860 
861 	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
862 				  0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
863 				  1, 0, NULL, 0, 1000);
864 
865 	if (ret < 0)
866 		return ret;
867 
868 	usb_reset_device(dev);
869 
870 	/* return -EAGAIN, so the creation of an audio interface for this
871 	 * temporary device is aborted. The device will reconnect with a
872 	 * new product ID */
873 	return -EAGAIN;
874 }
875 
876 static void mbox2_setup_48_24_magic(struct usb_device *dev)
877 {
878 	u8 srate[3];
879 	u8 temp[12];
880 
881 	/* Choose 48000Hz permanently */
882 	srate[0] = 0x80;
883 	srate[1] = 0xbb;
884 	srate[2] = 0x00;
885 
886 	/* Send the magic! */
887 	snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
888 		0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
889 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
890 		0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
891 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
892 		0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
893 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
894 		0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
895 	return;
896 }
897 
898 /* Digidesign Mbox 2 needs to load firmware onboard
899  * and driver must wait a few seconds for initialisation.
900  */
901 
902 #define MBOX2_FIRMWARE_SIZE    646
903 #define MBOX2_BOOT_LOADING     0x01 /* Hard coded into the device */
904 #define MBOX2_BOOT_READY       0x02 /* Hard coded into the device */
905 
906 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
907 {
908 	struct usb_host_config *config = dev->actconfig;
909 	struct usb_device_descriptor new_device_descriptor;
910 	int err;
911 	u8 bootresponse[0x12];
912 	int fwsize;
913 	int count;
914 
915 	fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
916 
917 	if (fwsize != MBOX2_FIRMWARE_SIZE) {
918 		dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
919 		return -ENODEV;
920 	}
921 
922 	dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
923 
924 	count = 0;
925 	bootresponse[0] = MBOX2_BOOT_LOADING;
926 	while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
927 		msleep(500); /* 0.5 second delay */
928 		snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
929 			/* Control magic - load onboard firmware */
930 			0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
931 		if (bootresponse[0] == MBOX2_BOOT_READY)
932 			break;
933 		dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
934 		count++;
935 	}
936 
937 	if (bootresponse[0] != MBOX2_BOOT_READY) {
938 		dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
939 		return -ENODEV;
940 	}
941 
942 	dev_dbg(&dev->dev, "device initialised!\n");
943 
944 	err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
945 		&new_device_descriptor, sizeof(new_device_descriptor));
946 	if (err < 0)
947 		dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
948 	if (new_device_descriptor.bNumConfigurations > dev->descriptor.bNumConfigurations)
949 		dev_dbg(&dev->dev, "error too large bNumConfigurations: %d\n",
950 			new_device_descriptor.bNumConfigurations);
951 	else
952 		memcpy(&dev->descriptor, &new_device_descriptor, sizeof(dev->descriptor));
953 
954 	err = usb_reset_configuration(dev);
955 	if (err < 0)
956 		dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
957 	dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
958 		le16_to_cpu(get_cfg_desc(config)->wTotalLength));
959 
960 	mbox2_setup_48_24_magic(dev);
961 
962 	dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
963 
964 	return 0; /* Successful boot */
965 }
966 
967 static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
968 {
969 	int err;
970 
971 	dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
972 
973 	/* If the Axe-Fx III has not fully booted, it will timeout when trying
974 	 * to enable the audio streaming interface. A more generous timeout is
975 	 * used here to detect when the Axe-Fx III has finished booting as the
976 	 * set interface message will be acked once it has
977 	 */
978 	err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
979 				USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
980 				1, 1, NULL, 0, 120000);
981 	if (err < 0) {
982 		dev_err(&dev->dev,
983 			"failed waiting for Axe-Fx III to boot: %d\n", err);
984 		return err;
985 	}
986 
987 	dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
988 
989 	err = usb_set_interface(dev, 1, 0);
990 	if (err < 0)
991 		dev_dbg(&dev->dev,
992 			"error stopping Axe-Fx III interface: %d\n", err);
993 
994 	return 0;
995 }
996 
997 static void mbox3_setup_48_24_magic(struct usb_device *dev)
998 {
999 	/* The Mbox 3 is "little endian" */
1000 	/* max volume is: 0x0000. */
1001 	/* min volume is: 0x0080 (shown in little endian form) */
1002 
1003 
1004 	/* Load 48000Hz rate into buffer */
1005 	u8 com_buff[4] = {0x80, 0xbb, 0x00, 0x00};
1006 
1007 	/* Set 48000Hz sample rate */
1008 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1009 			0x01, 0x21, 0x0100, 0x0001, &com_buff, 4);  //Is this really needed?
1010 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1011 			0x01, 0x21, 0x0100, 0x8101, &com_buff, 4);
1012 
1013 	/* Deactivate Tuner */
1014 	/* on  = 0x01*/
1015 	/* off = 0x00*/
1016 	com_buff[0] = 0x00;
1017 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1018 		0x01, 0x21, 0x0003, 0x2001, &com_buff, 1);
1019 
1020 	/* Set clock source to Internal (as opposed to S/PDIF) */
1021 	com_buff[0] = 0x01;
1022 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1023 			1, 0x21, 0x0100, 0x8001, &com_buff, 1);
1024 
1025 	/* Mute the hardware loopbacks to start the device in a known state. */
1026 	com_buff[0] = 0x00;
1027 	com_buff[1] = 0x80;
1028 	/* Analogue input 1 left channel: */
1029 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1030 			1, 0x21, 0x0110, 0x4001, &com_buff, 2);
1031 	/* Analogue input 1 right channel: */
1032 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1033 			1, 0x21, 0x0111, 0x4001, &com_buff, 2);
1034 	/* Analogue input 2 left channel: */
1035 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1036 			1, 0x21, 0x0114, 0x4001, &com_buff, 2);
1037 	/* Analogue input 2 right channel: */
1038 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1039 			1, 0x21, 0x0115, 0x4001, &com_buff, 2);
1040 	/* Analogue input 3 left channel: */
1041 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1042 			1, 0x21, 0x0118, 0x4001, &com_buff, 2);
1043 	/* Analogue input 3 right channel: */
1044 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1045 			1, 0x21, 0x0119, 0x4001, &com_buff, 2);
1046 	/* Analogue input 4 left channel: */
1047 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1048 			1, 0x21, 0x011c, 0x4001, &com_buff, 2);
1049 	/* Analogue input 4 right channel: */
1050 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1051 			1, 0x21, 0x011d, 0x4001, &com_buff, 2);
1052 
1053 	/* Set software sends to output */
1054 	com_buff[0] = 0x00;
1055 	com_buff[1] = 0x00;
1056 	/* Analogue software return 1 left channel: */
1057 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1058 			1, 0x21, 0x0100, 0x4001, &com_buff, 2);
1059 	com_buff[0] = 0x00;
1060 	com_buff[1] = 0x80;
1061 	/* Analogue software return 1 right channel: */
1062 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1063 			1, 0x21, 0x0101, 0x4001, &com_buff, 2);
1064 	com_buff[0] = 0x00;
1065 	com_buff[1] = 0x80;
1066 	/* Analogue software return 2 left channel: */
1067 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1068 			1, 0x21, 0x0104, 0x4001, &com_buff, 2);
1069 	com_buff[0] = 0x00;
1070 	com_buff[1] = 0x00;
1071 	/* Analogue software return 2 right channel: */
1072 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1073 			1, 0x21, 0x0105, 0x4001, &com_buff, 2);
1074 
1075 	com_buff[0] = 0x00;
1076 	com_buff[1] = 0x80;
1077 	/* Analogue software return 3 left channel: */
1078 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1079 			1, 0x21, 0x0108, 0x4001, &com_buff, 2);
1080 	/* Analogue software return 3 right channel: */
1081 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1082 			1, 0x21, 0x0109, 0x4001, &com_buff, 2);
1083 	/* Analogue software return 4 left channel: */
1084 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1085 			1, 0x21, 0x010c, 0x4001, &com_buff, 2);
1086 	/* Analogue software return 4 right channel: */
1087 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1088 			1, 0x21, 0x010d, 0x4001, &com_buff, 2);
1089 
1090 	/* Return to muting sends */
1091 	com_buff[0] = 0x00;
1092 	com_buff[1] = 0x80;
1093 	/* Analogue fx return left channel: */
1094 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1095 			1, 0x21, 0x0120, 0x4001, &com_buff, 2);
1096 	/* Analogue fx return right channel: */
1097 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1098 			1, 0x21, 0x0121, 0x4001, &com_buff, 2);
1099 
1100 	/* Analogue software input 1 fx send: */
1101 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1102 			1, 0x21, 0x0100, 0x4201, &com_buff, 2);
1103 	/* Analogue software input 2 fx send: */
1104 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1105 			1, 0x21, 0x0101, 0x4201, &com_buff, 2);
1106 	/* Analogue software input 3 fx send: */
1107 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1108 			1, 0x21, 0x0102, 0x4201, &com_buff, 2);
1109 	/* Analogue software input 4 fx send: */
1110 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1111 			1, 0x21, 0x0103, 0x4201, &com_buff, 2);
1112 	/* Analogue input 1 fx send: */
1113 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1114 			1, 0x21, 0x0104, 0x4201, &com_buff, 2);
1115 	/* Analogue input 2 fx send: */
1116 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1117 			1, 0x21, 0x0105, 0x4201, &com_buff, 2);
1118 	/* Analogue input 3 fx send: */
1119 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1120 			1, 0x21, 0x0106, 0x4201, &com_buff, 2);
1121 	/* Analogue input 4 fx send: */
1122 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1123 			1, 0x21, 0x0107, 0x4201, &com_buff, 2);
1124 
1125 	/* Toggle allowing host control */
1126 	com_buff[0] = 0x02;
1127 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1128 			3, 0x21, 0x0000, 0x2001, &com_buff, 1);
1129 
1130 	/* Do not dim fx returns */
1131 	com_buff[0] = 0x00;
1132 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1133 			3, 0x21, 0x0002, 0x2001, &com_buff, 1);
1134 
1135 	/* Do not set fx returns to mono */
1136 	com_buff[0] = 0x00;
1137 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1138 			3, 0x21, 0x0001, 0x2001, &com_buff, 1);
1139 
1140 	/* Mute the S/PDIF hardware loopback
1141 	 * same odd volume logic here as above
1142 	 */
1143 	com_buff[0] = 0x00;
1144 	com_buff[1] = 0x80;
1145 	/* S/PDIF hardware input 1 left channel */
1146 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1147 			1, 0x21, 0x0112, 0x4001, &com_buff, 2);
1148 	/* S/PDIF hardware input 1 right channel */
1149 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1150 			1, 0x21, 0x0113, 0x4001, &com_buff, 2);
1151 	/* S/PDIF hardware input 2 left channel */
1152 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1153 			1, 0x21, 0x0116, 0x4001, &com_buff, 2);
1154 	/* S/PDIF hardware input 2 right channel */
1155 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1156 			1, 0x21, 0x0117, 0x4001, &com_buff, 2);
1157 	/* S/PDIF hardware input 3 left channel */
1158 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1159 			1, 0x21, 0x011a, 0x4001, &com_buff, 2);
1160 	/* S/PDIF hardware input 3 right channel */
1161 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1162 			1, 0x21, 0x011b, 0x4001, &com_buff, 2);
1163 	/* S/PDIF hardware input 4 left channel */
1164 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1165 			1, 0x21, 0x011e, 0x4001, &com_buff, 2);
1166 	/* S/PDIF hardware input 4 right channel */
1167 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1168 			1, 0x21, 0x011f, 0x4001, &com_buff, 2);
1169 	/* S/PDIF software return 1 left channel */
1170 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1171 			1, 0x21, 0x0102, 0x4001, &com_buff, 2);
1172 	/* S/PDIF software return 1 right channel */
1173 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1174 			1, 0x21, 0x0103, 0x4001, &com_buff, 2);
1175 	/* S/PDIF software return 2 left channel */
1176 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1177 			1, 0x21, 0x0106, 0x4001, &com_buff, 2);
1178 	/* S/PDIF software return 2 right channel */
1179 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1180 			1, 0x21, 0x0107, 0x4001, &com_buff, 2);
1181 
1182 	com_buff[0] = 0x00;
1183 	com_buff[1] = 0x00;
1184 	/* S/PDIF software return 3 left channel */
1185 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1186 			1, 0x21, 0x010a, 0x4001, &com_buff, 2);
1187 
1188 	com_buff[0] = 0x00;
1189 	com_buff[1] = 0x80;
1190 	/* S/PDIF software return 3 right channel */
1191 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1192 			1, 0x21, 0x010b, 0x4001, &com_buff, 2);
1193 	/* S/PDIF software return 4 left channel */
1194 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1195 			1, 0x21, 0x010e, 0x4001, &com_buff, 2);
1196 
1197 	com_buff[0] = 0x00;
1198 	com_buff[1] = 0x00;
1199 	/* S/PDIF software return 4 right channel */
1200 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1201 			1, 0x21, 0x010f, 0x4001, &com_buff, 2);
1202 
1203 	com_buff[0] = 0x00;
1204 	com_buff[1] = 0x80;
1205 	/* S/PDIF fx returns left channel */
1206 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1207 			1, 0x21, 0x0122, 0x4001, &com_buff, 2);
1208 	/* S/PDIF fx returns right channel */
1209 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1210 			1, 0x21, 0x0123, 0x4001, &com_buff, 2);
1211 
1212 	/* Set the dropdown "Effect" to the first option */
1213 	/* Room1  = 0x00 */
1214 	/* Room2  = 0x01 */
1215 	/* Room3  = 0x02 */
1216 	/* Hall 1 = 0x03 */
1217 	/* Hall 2 = 0x04 */
1218 	/* Plate  = 0x05 */
1219 	/* Delay  = 0x06 */
1220 	/* Echo   = 0x07 */
1221 	com_buff[0] = 0x00;
1222 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1223 			1, 0x21, 0x0200, 0x4301, &com_buff, 1);	/* max is 0xff */
1224 	/* min is 0x00 */
1225 
1226 
1227 	/* Set the effect duration to 0 */
1228 	/* max is 0xffff */
1229 	/* min is 0x0000 */
1230 	com_buff[0] = 0x00;
1231 	com_buff[1] = 0x00;
1232 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1233 			1, 0x21, 0x0400, 0x4301, &com_buff, 2);
1234 
1235 	/* Set the effect volume and feedback to 0 */
1236 	/* max is 0xff */
1237 	/* min is 0x00 */
1238 	com_buff[0] = 0x00;
1239 	/* feedback: */
1240 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1241 			1, 0x21, 0x0500, 0x4301, &com_buff, 1);
1242 	/* volume: */
1243 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1244 			1, 0x21, 0x0300, 0x4301, &com_buff, 1);
1245 
1246 	/* Set soft button hold duration */
1247 	/* 0x03 = 250ms */
1248 	/* 0x05 = 500ms DEFAULT */
1249 	/* 0x08 = 750ms */
1250 	/* 0x0a = 1sec */
1251 	com_buff[0] = 0x05;
1252 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1253 			3, 0x21, 0x0005, 0x2001, &com_buff, 1);
1254 
1255 	/* Use dim LEDs for button of state */
1256 	com_buff[0] = 0x00;
1257 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1258 			3, 0x21, 0x0004, 0x2001, &com_buff, 1);
1259 }
1260 
1261 #define MBOX3_DESCRIPTOR_SIZE	464
1262 
1263 static int snd_usb_mbox3_boot_quirk(struct usb_device *dev)
1264 {
1265 	struct usb_host_config *config = dev->actconfig;
1266 	struct usb_device_descriptor new_device_descriptor;
1267 	int err;
1268 	int descriptor_size;
1269 
1270 	descriptor_size = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
1271 
1272 	if (descriptor_size != MBOX3_DESCRIPTOR_SIZE) {
1273 		dev_err(&dev->dev, "Invalid descriptor size=%d.\n", descriptor_size);
1274 		return -ENODEV;
1275 	}
1276 
1277 	dev_dbg(&dev->dev, "device initialised!\n");
1278 
1279 	err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
1280 		&new_device_descriptor, sizeof(new_device_descriptor));
1281 	if (err < 0)
1282 		dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
1283 	if (new_device_descriptor.bNumConfigurations > dev->descriptor.bNumConfigurations)
1284 		dev_dbg(&dev->dev, "error too large bNumConfigurations: %d\n",
1285 			new_device_descriptor.bNumConfigurations);
1286 	else
1287 		memcpy(&dev->descriptor, &new_device_descriptor, sizeof(dev->descriptor));
1288 
1289 	err = usb_reset_configuration(dev);
1290 	if (err < 0)
1291 		dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
1292 	dev_dbg(&dev->dev, "mbox3_boot: new boot length = %d\n",
1293 		le16_to_cpu(get_cfg_desc(config)->wTotalLength));
1294 
1295 	mbox3_setup_48_24_magic(dev);
1296 	dev_info(&dev->dev, "Digidesign Mbox 3: 24bit 48kHz");
1297 
1298 	return 0; /* Successful boot */
1299 }
1300 
1301 #define MICROBOOK_BUF_SIZE 128
1302 
1303 static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1304 						int buf_size, int *length)
1305 {
1306 	int err, actual_length;
1307 
1308 	if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
1309 		return -EINVAL;
1310 	err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1311 				&actual_length, 1000);
1312 	if (err < 0)
1313 		return err;
1314 
1315 	print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1316 		       buf, actual_length, false);
1317 
1318 	memset(buf, 0, buf_size);
1319 
1320 	if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
1321 		return -EINVAL;
1322 	err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1323 				&actual_length, 1000);
1324 	if (err < 0)
1325 		return err;
1326 
1327 	print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1328 		       buf, actual_length, false);
1329 
1330 	*length = actual_length;
1331 	return 0;
1332 }
1333 
1334 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1335 {
1336 	int err, actual_length, poll_attempts = 0;
1337 	static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1338 						 0x00, 0x00, 0x0b, 0x14,
1339 						 0x00, 0x00, 0x00, 0x01 };
1340 	static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1341 					     0x00, 0x00, 0x0b, 0x18 };
1342 	u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1343 
1344 	if (!buf)
1345 		return -ENOMEM;
1346 
1347 	dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1348 
1349 	/* First we tell the device which sample rate to use. */
1350 	memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1351 	actual_length = sizeof(set_samplerate_seq);
1352 	err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1353 						   &actual_length);
1354 
1355 	if (err < 0) {
1356 		dev_err(&dev->dev,
1357 			"failed setting the sample rate for Motu MicroBook II: %d\n",
1358 			err);
1359 		goto free_buf;
1360 	}
1361 
1362 	/* Then we poll every 100 ms until the device informs of its readiness. */
1363 	while (true) {
1364 		if (++poll_attempts > 100) {
1365 			dev_err(&dev->dev,
1366 				"failed booting Motu MicroBook II: timeout\n");
1367 			err = -ENODEV;
1368 			goto free_buf;
1369 		}
1370 
1371 		memset(buf, 0, MICROBOOK_BUF_SIZE);
1372 		memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1373 
1374 		actual_length = sizeof(poll_ready_seq);
1375 		err = snd_usb_motu_microbookii_communicate(
1376 			dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1377 		if (err < 0) {
1378 			dev_err(&dev->dev,
1379 				"failed booting Motu MicroBook II: communication error %d\n",
1380 				err);
1381 			goto free_buf;
1382 		}
1383 
1384 		/* the device signals its readiness through a message of the
1385 		 * form
1386 		 *           XX 06 00 00 00 00 0b 18  00 00 00 01
1387 		 * If the device is not yet ready to accept audio data, the
1388 		 * last byte of that sequence is 00.
1389 		 */
1390 		if (actual_length == 12 && buf[actual_length - 1] == 1)
1391 			break;
1392 
1393 		msleep(100);
1394 	}
1395 
1396 	dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1397 
1398 free_buf:
1399 	kfree(buf);
1400 	return err;
1401 }
1402 
1403 static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1404 {
1405 	msleep(4000);
1406 
1407 	return 0;
1408 }
1409 
1410 /*
1411  * Setup quirks
1412  */
1413 #define MAUDIO_SET		0x01 /* parse device_setup */
1414 #define MAUDIO_SET_COMPATIBLE	0x80 /* use only "win-compatible" interfaces */
1415 #define MAUDIO_SET_DTS		0x02 /* enable DTS Digital Output */
1416 #define MAUDIO_SET_96K		0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
1417 #define MAUDIO_SET_24B		0x08 /* 24bits sample if set, 16bits otherwise */
1418 #define MAUDIO_SET_DI		0x10 /* enable Digital Input */
1419 #define MAUDIO_SET_MASK		0x1f /* bit mask for setup value */
1420 #define MAUDIO_SET_24B_48K_DI	 0x19 /* 24bits+48kHz+Digital Input */
1421 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48kHz+No Digital Input */
1422 #define MAUDIO_SET_16B_48K_DI	 0x11 /* 16bits+48kHz+Digital Input */
1423 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48kHz+No Digital Input */
1424 
1425 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1426 				      int iface, int altno)
1427 {
1428 	/* Reset ALL ifaces to 0 altsetting.
1429 	 * Call it for every possible altsetting of every interface.
1430 	 */
1431 	usb_set_interface(chip->dev, iface, 0);
1432 	if (chip->setup & MAUDIO_SET) {
1433 		if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1434 			if (iface != 1 && iface != 2)
1435 				return 1; /* skip all interfaces but 1 and 2 */
1436 		} else {
1437 			unsigned int mask;
1438 			if (iface == 1 || iface == 2)
1439 				return 1; /* skip interfaces 1 and 2 */
1440 			if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1441 				return 1; /* skip this altsetting */
1442 			mask = chip->setup & MAUDIO_SET_MASK;
1443 			if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1444 				return 1; /* skip this altsetting */
1445 			if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1446 				return 1; /* skip this altsetting */
1447 			if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1448 				return 1; /* skip this altsetting */
1449 		}
1450 	}
1451 	usb_audio_dbg(chip,
1452 		    "using altsetting %d for interface %d config %d\n",
1453 		    altno, iface, chip->setup);
1454 	return 0; /* keep this altsetting */
1455 }
1456 
1457 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1458 					 int iface,
1459 					 int altno)
1460 {
1461 	/* Reset ALL ifaces to 0 altsetting.
1462 	 * Call it for every possible altsetting of every interface.
1463 	 */
1464 	usb_set_interface(chip->dev, iface, 0);
1465 
1466 	if (chip->setup & MAUDIO_SET) {
1467 		unsigned int mask;
1468 		if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1469 			return 1; /* skip this altsetting */
1470 		if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1471 			return 1; /* skip this altsetting */
1472 		mask = chip->setup & MAUDIO_SET_MASK;
1473 		if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1474 			return 1; /* skip this altsetting */
1475 		if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1476 			return 1; /* skip this altsetting */
1477 		if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1478 			return 1; /* skip this altsetting */
1479 		if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1480 			return 1; /* skip this altsetting */
1481 	}
1482 
1483 	return 0; /* keep this altsetting */
1484 }
1485 
1486 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1487 					   int iface, int altno)
1488 {
1489 	/* Reset ALL ifaces to 0 altsetting.
1490 	 * Call it for every possible altsetting of every interface.
1491 	 */
1492 	usb_set_interface(chip->dev, iface, 0);
1493 
1494 	/* possible configuration where both inputs and only one output is
1495 	 *used is not supported by the current setup
1496 	 */
1497 	if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1498 		if (chip->setup & MAUDIO_SET_96K) {
1499 			if (altno != 3 && altno != 6)
1500 				return 1;
1501 		} else if (chip->setup & MAUDIO_SET_DI) {
1502 			if (iface == 4)
1503 				return 1; /* no analog input */
1504 			if (altno != 2 && altno != 5)
1505 				return 1; /* enable only altsets 2 and 5 */
1506 		} else {
1507 			if (iface == 5)
1508 				return 1; /* disable digialt input */
1509 			if (altno != 2 && altno != 5)
1510 				return 1; /* enalbe only altsets 2 and 5 */
1511 		}
1512 	} else {
1513 		/* keep only 16-Bit mode */
1514 		if (altno != 1)
1515 			return 1;
1516 	}
1517 
1518 	usb_audio_dbg(chip,
1519 		    "using altsetting %d for interface %d config %d\n",
1520 		    altno, iface, chip->setup);
1521 	return 0; /* keep this altsetting */
1522 }
1523 
1524 static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1525 					   int iface, int altno)
1526 {
1527 	/*
1528 	 * Altno settings:
1529 	 *
1530 	 * Playback (Interface 1):
1531 	 * 1: 6 Analog + 2 S/PDIF
1532 	 * 2: 6 Analog + 2 S/PDIF
1533 	 * 3: 6 Analog
1534 	 *
1535 	 * Capture (Interface 2):
1536 	 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1537 	 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1538 	 * 3: 8 Analog
1539 	 */
1540 
1541 	/*
1542 	 * I'll leave 2 as the default one and
1543 	 * use device_setup to switch to the
1544 	 * other two.
1545 	 */
1546 	if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1547 		return 1;
1548 	else if (chip->setup == 1 && altno != 1)
1549 		return 1;
1550 	else if (chip->setup == 2 && altno != 3)
1551 		return 1;
1552 
1553 	return 0;
1554 }
1555 
1556 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1557 				  int iface,
1558 				  int altno)
1559 {
1560 	/* audiophile usb: skip altsets incompatible with device_setup */
1561 	if (chip->usb_id == USB_ID(0x0763, 0x2003))
1562 		return audiophile_skip_setting_quirk(chip, iface, altno);
1563 	/* quattro usb: skip altsets incompatible with device_setup */
1564 	if (chip->usb_id == USB_ID(0x0763, 0x2001))
1565 		return quattro_skip_setting_quirk(chip, iface, altno);
1566 	/* fasttrackpro usb: skip altsets incompatible with device_setup */
1567 	if (chip->usb_id == USB_ID(0x0763, 0x2012))
1568 		return fasttrackpro_skip_setting_quirk(chip, iface, altno);
1569 	/* presonus studio 1810c: skip altsets incompatible with device_setup */
1570 	if (chip->usb_id == USB_ID(0x194f, 0x010c))
1571 		return s1810c_skip_setting_quirk(chip, iface, altno);
1572 
1573 
1574 	return 0;
1575 }
1576 
1577 int snd_usb_apply_boot_quirk(struct usb_device *dev,
1578 			     struct usb_interface *intf,
1579 			     const struct snd_usb_audio_quirk *quirk,
1580 			     unsigned int id)
1581 {
1582 	switch (id) {
1583 	case USB_ID(0x041e, 0x3000):
1584 		/* SB Extigy needs special boot-up sequence */
1585 		/* if more models come, this will go to the quirk list. */
1586 		return snd_usb_extigy_boot_quirk(dev, intf);
1587 
1588 	case USB_ID(0x041e, 0x3020):
1589 		/* SB Audigy 2 NX needs its own boot-up magic, too */
1590 		return snd_usb_audigy2nx_boot_quirk(dev);
1591 
1592 	case USB_ID(0x10f5, 0x0200):
1593 		/* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1594 		return snd_usb_cm106_boot_quirk(dev);
1595 
1596 	case USB_ID(0x0d8c, 0x0102):
1597 		/* C-Media CM6206 / CM106-Like Sound Device */
1598 	case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1599 		return snd_usb_cm6206_boot_quirk(dev);
1600 
1601 	case USB_ID(0x0dba, 0x3000):
1602 		/* Digidesign Mbox 2 */
1603 		return snd_usb_mbox2_boot_quirk(dev);
1604 	case USB_ID(0x0dba, 0x5000):
1605 		/* Digidesign Mbox 3 */
1606 		return snd_usb_mbox3_boot_quirk(dev);
1607 
1608 
1609 	case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1610 	case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1611 		return snd_usb_novation_boot_quirk(dev);
1612 
1613 	case USB_ID(0x133e, 0x0815):
1614 		/* Access Music VirusTI Desktop */
1615 		return snd_usb_accessmusic_boot_quirk(dev);
1616 
1617 	case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1618 	case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1619 	case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1620 		return snd_usb_nativeinstruments_boot_quirk(dev);
1621 	case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1622 		return snd_usb_fasttrackpro_boot_quirk(dev);
1623 	case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1624 		return snd_usb_gamecon780_boot_quirk(dev);
1625 	case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1626 		return snd_usb_axefx3_boot_quirk(dev);
1627 	case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1628 		/*
1629 		 * For some reason interface 3 with vendor-spec class is
1630 		 * detected on MicroBook IIc.
1631 		 */
1632 		if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1633 		    USB_CLASS_VENDOR_SPEC &&
1634 		    get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1635 			return snd_usb_motu_microbookii_boot_quirk(dev);
1636 		break;
1637 	}
1638 
1639 	return 0;
1640 }
1641 
1642 int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1643 				  struct usb_interface *intf,
1644 				  const struct snd_usb_audio_quirk *quirk,
1645 				  unsigned int id)
1646 {
1647 	switch (id) {
1648 	case USB_ID(0x07fd, 0x0008): /* MOTU M Series, 1st hardware version */
1649 		return snd_usb_motu_m_series_boot_quirk(dev);
1650 	}
1651 
1652 	return 0;
1653 }
1654 
1655 /*
1656  * check if the device uses big-endian samples
1657  */
1658 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip,
1659 				 const struct audioformat *fp)
1660 {
1661 	/* it depends on altsetting whether the device is big-endian or not */
1662 	switch (chip->usb_id) {
1663 	case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1664 		if (fp->altsetting == 2 || fp->altsetting == 3 ||
1665 			fp->altsetting == 5 || fp->altsetting == 6)
1666 			return 1;
1667 		break;
1668 	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1669 		if (chip->setup == 0x00 ||
1670 			fp->altsetting == 1 || fp->altsetting == 2 ||
1671 			fp->altsetting == 3)
1672 			return 1;
1673 		break;
1674 	case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1675 		if (fp->altsetting == 2 || fp->altsetting == 3 ||
1676 			fp->altsetting == 5 || fp->altsetting == 6)
1677 			return 1;
1678 		break;
1679 	}
1680 	return 0;
1681 }
1682 
1683 /*
1684  * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1685  * not for interface.
1686  */
1687 
1688 enum {
1689 	EMU_QUIRK_SR_44100HZ = 0,
1690 	EMU_QUIRK_SR_48000HZ,
1691 	EMU_QUIRK_SR_88200HZ,
1692 	EMU_QUIRK_SR_96000HZ,
1693 	EMU_QUIRK_SR_176400HZ,
1694 	EMU_QUIRK_SR_192000HZ
1695 };
1696 
1697 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1698 				 const struct audioformat *fmt)
1699 {
1700 	unsigned char emu_samplerate_id = 0;
1701 
1702 	/* When capture is active
1703 	 * sample rate shouldn't be changed
1704 	 * by playback substream
1705 	 */
1706 	if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1707 		if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].cur_audiofmt)
1708 			return;
1709 	}
1710 
1711 	switch (fmt->rate_min) {
1712 	case 48000:
1713 		emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1714 		break;
1715 	case 88200:
1716 		emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1717 		break;
1718 	case 96000:
1719 		emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1720 		break;
1721 	case 176400:
1722 		emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1723 		break;
1724 	case 192000:
1725 		emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1726 		break;
1727 	default:
1728 		emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1729 		break;
1730 	}
1731 	snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1732 	subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1733 }
1734 
1735 static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs,
1736 					u16 windex)
1737 {
1738 	unsigned int cur_rate = subs->data_endpoint->cur_rate;
1739 	u8 sr[3];
1740 	// Convert to little endian
1741 	sr[0] = cur_rate & 0xff;
1742 	sr[1] = (cur_rate >> 8) & 0xff;
1743 	sr[2] = (cur_rate >> 16) & 0xff;
1744 	usb_set_interface(subs->dev, 0, 1);
1745 	// we should derive windex from fmt-sync_ep but it's not set
1746 	snd_usb_ctl_msg(subs->stream->chip->dev,
1747 		usb_sndctrlpipe(subs->stream->chip->dev, 0),
1748 		0x01, 0x22, 0x0100, windex, &sr, 0x0003);
1749 	return 0;
1750 }
1751 
1752 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1753 			      const struct audioformat *fmt)
1754 {
1755 	switch (subs->stream->chip->usb_id) {
1756 	case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1757 	case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1758 	case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1759 	case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1760 		set_format_emu_quirk(subs, fmt);
1761 		break;
1762 	case USB_ID(0x534d, 0x0021): /* MacroSilicon MS2100/MS2106 */
1763 	case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1764 		subs->stream_offset_adj = 2;
1765 		break;
1766 	case USB_ID(0x2b73, 0x0013): /* Pioneer DJM-450 */
1767 		pioneer_djm_set_format_quirk(subs, 0x0082);
1768 		break;
1769 	case USB_ID(0x08e4, 0x017f): /* Pioneer DJM-750 */
1770 	case USB_ID(0x08e4, 0x0163): /* Pioneer DJM-850 */
1771 		pioneer_djm_set_format_quirk(subs, 0x0086);
1772 		break;
1773 	}
1774 }
1775 
1776 int snd_usb_select_mode_quirk(struct snd_usb_audio *chip,
1777 			      const struct audioformat *fmt)
1778 {
1779 	struct usb_device *dev = chip->dev;
1780 	int err;
1781 
1782 	if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
1783 		/* First switch to alt set 0, otherwise the mode switch cmd
1784 		 * will not be accepted by the DAC
1785 		 */
1786 		err = usb_set_interface(dev, fmt->iface, 0);
1787 		if (err < 0)
1788 			return err;
1789 
1790 		msleep(20); /* Delay needed after setting the interface */
1791 
1792 		/* Vendor mode switch cmd is required. */
1793 		if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1794 			/* DSD mode (DSD_U32) requested */
1795 			err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1796 					      USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1797 					      1, 1, NULL, 0);
1798 			if (err < 0)
1799 				return err;
1800 
1801 		} else {
1802 			/* PCM or DOP mode (S32) requested */
1803 			/* PCM mode (S16) requested */
1804 			err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1805 					      USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1806 					      0, 1, NULL, 0);
1807 			if (err < 0)
1808 				return err;
1809 
1810 		}
1811 		msleep(20);
1812 	}
1813 	return 0;
1814 }
1815 
1816 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1817 {
1818 	/*
1819 	 * "Playback Design" products send bogus feedback data at the start
1820 	 * of the stream. Ignore them.
1821 	 */
1822 	if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1823 	    ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1824 		ep->skip_packets = 4;
1825 
1826 	/*
1827 	 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1828 	 * world latency varies by approx. +/- 50 frames (at 96kHz) each time
1829 	 * the stream is (re)started. When skipping packets 16 at endpoint
1830 	 * start up, the real world latency is stable within +/- 1 frame (also
1831 	 * across power cycles).
1832 	 */
1833 	if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1834 	     ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1835 	    ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1836 		ep->skip_packets = 16;
1837 
1838 	/* Work around devices that report unreasonable feedback data */
1839 	if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) ||  /* TEAC UD-H01 */
1840 	     ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1841 	    ep->syncmaxsize == 4)
1842 		ep->tenor_fb_quirk = 1;
1843 }
1844 
1845 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1846 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1847 			   __u8 request, __u8 requesttype, __u16 value,
1848 			   __u16 index, void *data, __u16 size)
1849 {
1850 	struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1851 
1852 	if (!chip || (requesttype & USB_TYPE_MASK) != USB_TYPE_CLASS)
1853 		return;
1854 
1855 	if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY)
1856 		msleep(20);
1857 	else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_1M)
1858 		usleep_range(1000, 2000);
1859 	else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_5M)
1860 		usleep_range(5000, 6000);
1861 }
1862 
1863 /*
1864  * snd_usb_interface_dsd_format_quirks() is called from format.c to
1865  * augment the PCM format bit-field for DSD types. The UAC standards
1866  * don't have a designated bit field to denote DSD-capable interfaces,
1867  * hence all hardware that is known to support this format has to be
1868  * listed here.
1869  */
1870 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1871 					struct audioformat *fp,
1872 					unsigned int sample_bytes)
1873 {
1874 	struct usb_interface *iface;
1875 
1876 	/* Playback Designs */
1877 	if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1878 	    USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
1879 		switch (fp->altsetting) {
1880 		case 1:
1881 			fp->dsd_dop = true;
1882 			return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1883 		case 2:
1884 			fp->dsd_bitrev = true;
1885 			return SNDRV_PCM_FMTBIT_DSD_U8;
1886 		case 3:
1887 			fp->dsd_bitrev = true;
1888 			return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1889 		}
1890 	}
1891 
1892 	/* XMOS based USB DACs */
1893 	switch (chip->usb_id) {
1894 	case USB_ID(0x139f, 0x5504): /* Nagra DAC */
1895 	case USB_ID(0x20b1, 0x3089): /* Mola-Mola DAC */
1896 	case USB_ID(0x2522, 0x0007): /* LH Labs Geek Out 1V5 */
1897 	case USB_ID(0x2522, 0x0009): /* LH Labs Geek Pulse X Inifinity 2V0 */
1898 	case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1899 	case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1900 		if (fp->altsetting == 2)
1901 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1902 		break;
1903 
1904 	case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1905 	case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1906 	case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
1907 	case USB_ID(0x16d0, 0x06b4): /* NuPrime Audio HD-AVP/AVA */
1908 	case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1909 	case USB_ID(0x16d0, 0x09d8): /* NuPrime IDA-8 */
1910 	case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1911 	case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1912 	case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
1913 	case USB_ID(0x20a0, 0x4143): /* WaveIO USB Audio 2.0 */
1914 	case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1915 	case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1916 	case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1917 	case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1918 	case USB_ID(0x278b, 0x5100): /* Rotel RC-1590 */
1919 	case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1920 	case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1921 	case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1922 		if (fp->altsetting == 3)
1923 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1924 		break;
1925 
1926 	/* Amanero Combo384 USB based DACs with native DSD support */
1927 	case USB_ID(0x16d0, 0x071a):  /* Amanero - Combo384 */
1928 		if (fp->altsetting == 2) {
1929 			switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
1930 			case 0x199:
1931 				return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1932 			case 0x19b:
1933 			case 0x203:
1934 				return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1935 			default:
1936 				break;
1937 			}
1938 		}
1939 		break;
1940 	case USB_ID(0x16d0, 0x0a23):
1941 		if (fp->altsetting == 2)
1942 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1943 		break;
1944 
1945 	default:
1946 		break;
1947 	}
1948 
1949 	/* ITF-USB DSD based DACs */
1950 	if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
1951 		iface = usb_ifnum_to_if(chip->dev, fp->iface);
1952 
1953 		/* Altsetting 2 support native DSD if the num of altsets is
1954 		 * three (0-2),
1955 		 * Altsetting 3 support native DSD if the num of altsets is
1956 		 * four (0-3).
1957 		 */
1958 		if (fp->altsetting == iface->num_altsetting - 1)
1959 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1960 	}
1961 
1962 	/* Mostly generic method to detect many DSD-capable implementations */
1963 	if ((chip->quirk_flags & QUIRK_FLAG_DSD_RAW) && fp->dsd_raw)
1964 		return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1965 
1966 	return 0;
1967 }
1968 
1969 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1970 					  struct audioformat *fp,
1971 					  int stream)
1972 {
1973 	switch (chip->usb_id) {
1974 	case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1975 		/* Optoplay sets the sample rate attribute although
1976 		 * it seems not supporting it in fact.
1977 		 */
1978 		fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
1979 		break;
1980 	case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1981 	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1982 		/* doesn't set the sample rate attribute, but supports it */
1983 		fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
1984 		break;
1985 	case USB_ID(0x0763, 0x2001):  /* M-Audio Quattro USB */
1986 	case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1987 	case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1988 	case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1989 					an older model 77d:223) */
1990 	/*
1991 	 * plantronics headset and Griffin iMic have set adaptive-in
1992 	 * although it's really not...
1993 	 */
1994 		fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
1995 		if (stream == SNDRV_PCM_STREAM_PLAYBACK)
1996 			fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
1997 		else
1998 			fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
1999 		break;
2000 	case USB_ID(0x07fd, 0x0004):  /* MOTU MicroBook IIc */
2001 		/*
2002 		 * MaxPacketsOnly attribute is erroneously set in endpoint
2003 		 * descriptors. As a result this card produces noise with
2004 		 * all sample rates other than 96 kHz.
2005 		 */
2006 		fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
2007 		break;
2008 	case USB_ID(0x1224, 0x2a25):  /* Jieli Technology USB PHY 2.0 */
2009 		/* mic works only when ep packet size is set to wMaxPacketSize */
2010 		fp->attributes |= UAC_EP_CS_ATTR_FILL_MAX;
2011 		break;
2012 	case USB_ID(0x3511, 0x2b1e): /* Opencomm2 UC USB Bluetooth dongle */
2013 		/* mic works only when ep pitch control is not set */
2014 		if (stream == SNDRV_PCM_STREAM_CAPTURE)
2015 			fp->attributes &= ~UAC_EP_CS_ATTR_PITCH_CONTROL;
2016 		break;
2017 	}
2018 }
2019 
2020 /*
2021  * driver behavior quirk flags
2022  */
2023 struct usb_audio_quirk_flags_table {
2024 	u32 id;
2025 	u32 flags;
2026 };
2027 
2028 #define DEVICE_FLG(vid, pid, _flags) \
2029 	{ .id = USB_ID(vid, pid), .flags = (_flags) }
2030 #define VENDOR_FLG(vid, _flags) DEVICE_FLG(vid, 0, _flags)
2031 
2032 static const struct usb_audio_quirk_flags_table quirk_flags_table[] = {
2033 	/* Device matches */
2034 	DEVICE_FLG(0x03f0, 0x654a, /* HP 320 FHD Webcam */
2035 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2036 	DEVICE_FLG(0x041e, 0x3000, /* Creative SB Extigy */
2037 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2038 	DEVICE_FLG(0x041e, 0x4080, /* Creative Live Cam VF0610 */
2039 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2040 	DEVICE_FLG(0x045e, 0x083c, /* MS USB Link headset */
2041 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY |
2042 		   QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2043 	DEVICE_FLG(0x046d, 0x084c, /* Logitech ConferenceCam Connect */
2044 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2045 	DEVICE_FLG(0x046d, 0x0991, /* Logitech QuickCam Pro */
2046 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR),
2047 	DEVICE_FLG(0x046d, 0x09a4, /* Logitech QuickCam E 3500 */
2048 		   QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR),
2049 	DEVICE_FLG(0x0499, 0x1509, /* Steinberg UR22 */
2050 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2051 	DEVICE_FLG(0x0499, 0x3108, /* Yamaha YIT-W12TX */
2052 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2053 	DEVICE_FLG(0x04d8, 0xfeea, /* Benchmark DAC1 Pre */
2054 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2055 	DEVICE_FLG(0x04e8, 0xa051, /* Samsung USBC Headset (AKG) */
2056 		   QUIRK_FLAG_SKIP_CLOCK_SELECTOR | QUIRK_FLAG_CTL_MSG_DELAY_5M),
2057 	DEVICE_FLG(0x0525, 0xa4ad, /* Hamedal C20 usb camero */
2058 		   QUIRK_FLAG_IFACE_SKIP_CLOSE),
2059 	DEVICE_FLG(0x054c, 0x0b8c, /* Sony WALKMAN NW-A45 DAC */
2060 		   QUIRK_FLAG_SET_IFACE_FIRST),
2061 	DEVICE_FLG(0x0556, 0x0014, /* Phoenix Audio TMX320VC */
2062 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2063 	DEVICE_FLG(0x05a3, 0x9420, /* ELP HD USB Camera */
2064 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2065 	DEVICE_FLG(0x05a7, 0x1020, /* Bose Companion 5 */
2066 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2067 	DEVICE_FLG(0x05e1, 0x0408, /* Syntek STK1160 */
2068 		   QUIRK_FLAG_ALIGN_TRANSFER),
2069 	DEVICE_FLG(0x05e1, 0x0480, /* Hauppauge Woodbury */
2070 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2071 	DEVICE_FLG(0x0644, 0x8043, /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
2072 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2073 		   QUIRK_FLAG_IFACE_DELAY),
2074 	DEVICE_FLG(0x0644, 0x8044, /* Esoteric D-05X */
2075 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2076 		   QUIRK_FLAG_IFACE_DELAY),
2077 	DEVICE_FLG(0x0644, 0x804a, /* TEAC UD-301 */
2078 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2079 		   QUIRK_FLAG_IFACE_DELAY),
2080 	DEVICE_FLG(0x0644, 0x805f, /* TEAC Model 12 */
2081 		   QUIRK_FLAG_FORCE_IFACE_RESET),
2082 	DEVICE_FLG(0x0644, 0x806b, /* TEAC UD-701 */
2083 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2084 		   QUIRK_FLAG_IFACE_DELAY),
2085 	DEVICE_FLG(0x06f8, 0xb000, /* Hercules DJ Console (Windows Edition) */
2086 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2087 	DEVICE_FLG(0x06f8, 0xd002, /* Hercules DJ Console (Macintosh Edition) */
2088 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2089 	DEVICE_FLG(0x0711, 0x5800, /* MCT Trigger 5 USB-to-HDMI */
2090 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2091 	DEVICE_FLG(0x074d, 0x3553, /* Outlaw RR2150 (Micronas UAC3553B) */
2092 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2093 	DEVICE_FLG(0x0763, 0x2030, /* M-Audio Fast Track C400 */
2094 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2095 	DEVICE_FLG(0x0763, 0x2031, /* M-Audio Fast Track C600 */
2096 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2097 	DEVICE_FLG(0x07fd, 0x000b, /* MOTU M Series 2nd hardware revision */
2098 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2099 	DEVICE_FLG(0x08bb, 0x2702, /* LineX FM Transmitter */
2100 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2101 	DEVICE_FLG(0x0951, 0x16ad, /* Kingston HyperX */
2102 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2103 	DEVICE_FLG(0x0b0e, 0x0349, /* Jabra 550a */
2104 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2105 	DEVICE_FLG(0x0c45, 0x6340, /* Sonix HD USB Camera */
2106 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2107 	DEVICE_FLG(0x0ecb, 0x205c, /* JBL Quantum610 Wireless */
2108 		   QUIRK_FLAG_FIXED_RATE),
2109 	DEVICE_FLG(0x0ecb, 0x2069, /* JBL Quantum810 Wireless */
2110 		   QUIRK_FLAG_FIXED_RATE),
2111 	DEVICE_FLG(0x0fd9, 0x0008, /* Hauppauge HVR-950Q */
2112 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2113 	DEVICE_FLG(0x1224, 0x2a25, /* Jieli Technology USB PHY 2.0 */
2114 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2115 	DEVICE_FLG(0x1395, 0x740a, /* Sennheiser DECT */
2116 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2117 	DEVICE_FLG(0x1397, 0x0507, /* Behringer UMC202HD */
2118 		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2119 	DEVICE_FLG(0x1397, 0x0508, /* Behringer UMC204HD */
2120 		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2121 	DEVICE_FLG(0x1397, 0x0509, /* Behringer UMC404HD */
2122 		   QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2123 	DEVICE_FLG(0x13e5, 0x0001, /* Serato Phono */
2124 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2125 	DEVICE_FLG(0x154e, 0x1002, /* Denon DCD-1500RE */
2126 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2127 	DEVICE_FLG(0x154e, 0x1003, /* Denon DA-300USB */
2128 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2129 	DEVICE_FLG(0x154e, 0x3005, /* Marantz HD-DAC1 */
2130 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2131 	DEVICE_FLG(0x154e, 0x3006, /* Marantz SA-14S1 */
2132 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2133 	DEVICE_FLG(0x154e, 0x300b, /* Marantz SA-KI RUBY / SA-12 */
2134 		   QUIRK_FLAG_DSD_RAW),
2135 	DEVICE_FLG(0x154e, 0x500e, /* Denon DN-X1600 */
2136 		   QUIRK_FLAG_IGNORE_CLOCK_SOURCE),
2137 	DEVICE_FLG(0x1686, 0x00dd, /* Zoom R16/24 */
2138 		   QUIRK_FLAG_TX_LENGTH | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2139 	DEVICE_FLG(0x17aa, 0x1046, /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
2140 		   QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2141 	DEVICE_FLG(0x17aa, 0x104d, /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
2142 		   QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2143 	DEVICE_FLG(0x1852, 0x5062, /* Luxman D-08u */
2144 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2145 	DEVICE_FLG(0x1852, 0x5065, /* Luxman DA-06 */
2146 		   QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2147 	DEVICE_FLG(0x1901, 0x0191, /* GE B850V3 CP2114 audio interface */
2148 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2149 	DEVICE_FLG(0x19f7, 0x0035, /* RODE NT-USB+ */
2150 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2151 	DEVICE_FLG(0x1bcf, 0x2281, /* HD Webcam */
2152 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2153 	DEVICE_FLG(0x1bcf, 0x2283, /* NexiGo N930AF FHD Webcam */
2154 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2155 	DEVICE_FLG(0x2040, 0x7200, /* Hauppauge HVR-950Q */
2156 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2157 	DEVICE_FLG(0x2040, 0x7201, /* Hauppauge HVR-950Q-MXL */
2158 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2159 	DEVICE_FLG(0x2040, 0x7210, /* Hauppauge HVR-950Q */
2160 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2161 	DEVICE_FLG(0x2040, 0x7211, /* Hauppauge HVR-950Q-MXL */
2162 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2163 	DEVICE_FLG(0x2040, 0x7213, /* Hauppauge HVR-950Q */
2164 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2165 	DEVICE_FLG(0x2040, 0x7217, /* Hauppauge HVR-950Q */
2166 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2167 	DEVICE_FLG(0x2040, 0x721b, /* Hauppauge HVR-950Q */
2168 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2169 	DEVICE_FLG(0x2040, 0x721e, /* Hauppauge HVR-950Q */
2170 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2171 	DEVICE_FLG(0x2040, 0x721f, /* Hauppauge HVR-950Q */
2172 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2173 	DEVICE_FLG(0x2040, 0x7240, /* Hauppauge HVR-850 */
2174 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2175 	DEVICE_FLG(0x2040, 0x7260, /* Hauppauge HVR-950Q */
2176 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2177 	DEVICE_FLG(0x2040, 0x7270, /* Hauppauge HVR-950Q */
2178 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2179 	DEVICE_FLG(0x2040, 0x7280, /* Hauppauge HVR-950Q */
2180 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2181 	DEVICE_FLG(0x2040, 0x7281, /* Hauppauge HVR-950Q-MXL */
2182 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2183 	DEVICE_FLG(0x2040, 0x8200, /* Hauppauge Woodbury */
2184 		   QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2185 	DEVICE_FLG(0x21b4, 0x0081, /* AudioQuest DragonFly */
2186 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2187 	DEVICE_FLG(0x21b4, 0x0230, /* Ayre QB-9 Twenty */
2188 		   QUIRK_FLAG_DSD_RAW),
2189 	DEVICE_FLG(0x21b4, 0x0232, /* Ayre QX-5 Twenty */
2190 		   QUIRK_FLAG_DSD_RAW),
2191 	DEVICE_FLG(0x2522, 0x0007, /* LH Labs Geek Out HD Audio 1V5 */
2192 		   QUIRK_FLAG_SET_IFACE_FIRST),
2193 	DEVICE_FLG(0x2708, 0x0002, /* Audient iD14 */
2194 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2195 	DEVICE_FLG(0x2912, 0x30c8, /* Audioengine D1 */
2196 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2197 	DEVICE_FLG(0x2b53, 0x0023, /* Fiero SC-01 (firmware v1.0.0 @ 48 kHz) */
2198 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2199 	DEVICE_FLG(0x2b53, 0x0024, /* Fiero SC-01 (firmware v1.0.0 @ 96 kHz) */
2200 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2201 	DEVICE_FLG(0x2b53, 0x0031, /* Fiero SC-01 (firmware v1.1.0) */
2202 		   QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2203 	DEVICE_FLG(0x2d95, 0x8011, /* VIVO USB-C HEADSET */
2204 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2205 	DEVICE_FLG(0x2d95, 0x8021, /* VIVO USB-C-XE710 HEADSET */
2206 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2207 	DEVICE_FLG(0x30be, 0x0101, /* Schiit Hel */
2208 		   QUIRK_FLAG_IGNORE_CTL_ERROR),
2209 	DEVICE_FLG(0x413c, 0xa506, /* Dell AE515 sound bar */
2210 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2211 	DEVICE_FLG(0x534d, 0x0021, /* MacroSilicon MS2100/MS2106 */
2212 		   QUIRK_FLAG_ALIGN_TRANSFER),
2213 	DEVICE_FLG(0x534d, 0x2109, /* MacroSilicon MS2109 */
2214 		   QUIRK_FLAG_ALIGN_TRANSFER),
2215 
2216 	/* Vendor matches */
2217 	VENDOR_FLG(0x045e, /* MS Lifecam */
2218 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2219 	VENDOR_FLG(0x046d, /* Logitech */
2220 		   QUIRK_FLAG_CTL_MSG_DELAY_1M),
2221 	VENDOR_FLG(0x047f, /* Plantronics */
2222 		   QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY),
2223 	VENDOR_FLG(0x0644, /* TEAC Corp. */
2224 		   QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY),
2225 	VENDOR_FLG(0x07fd, /* MOTU */
2226 		   QUIRK_FLAG_VALIDATE_RATES),
2227 	VENDOR_FLG(0x1235, /* Focusrite Novation */
2228 		   QUIRK_FLAG_VALIDATE_RATES),
2229 	VENDOR_FLG(0x1511, /* AURALiC */
2230 		   QUIRK_FLAG_DSD_RAW),
2231 	VENDOR_FLG(0x152a, /* Thesycon devices */
2232 		   QUIRK_FLAG_DSD_RAW),
2233 	VENDOR_FLG(0x18d1, /* iBasso devices */
2234 		   QUIRK_FLAG_DSD_RAW),
2235 	VENDOR_FLG(0x1de7, /* Phoenix Audio */
2236 		   QUIRK_FLAG_GET_SAMPLE_RATE),
2237 	VENDOR_FLG(0x20b1, /* XMOS based devices */
2238 		   QUIRK_FLAG_DSD_RAW),
2239 	VENDOR_FLG(0x21ed, /* Accuphase Laboratory */
2240 		   QUIRK_FLAG_DSD_RAW),
2241 	VENDOR_FLG(0x22d9, /* Oppo */
2242 		   QUIRK_FLAG_DSD_RAW),
2243 	VENDOR_FLG(0x23ba, /* Playback Design */
2244 		   QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY |
2245 		   QUIRK_FLAG_DSD_RAW),
2246 	VENDOR_FLG(0x25ce, /* Mytek devices */
2247 		   QUIRK_FLAG_DSD_RAW),
2248 	VENDOR_FLG(0x278b, /* Rotel? */
2249 		   QUIRK_FLAG_DSD_RAW),
2250 	VENDOR_FLG(0x292b, /* Gustard/Ess based devices */
2251 		   QUIRK_FLAG_DSD_RAW),
2252 	VENDOR_FLG(0x2972, /* FiiO devices */
2253 		   QUIRK_FLAG_DSD_RAW),
2254 	VENDOR_FLG(0x2ab6, /* T+A devices */
2255 		   QUIRK_FLAG_DSD_RAW),
2256 	VENDOR_FLG(0x2afd, /* McIntosh Laboratory, Inc. */
2257 		   QUIRK_FLAG_DSD_RAW),
2258 	VENDOR_FLG(0x2d87, /* Cayin device */
2259 		   QUIRK_FLAG_DSD_RAW),
2260 	VENDOR_FLG(0x3336, /* HEM devices */
2261 		   QUIRK_FLAG_DSD_RAW),
2262 	VENDOR_FLG(0x3353, /* Khadas devices */
2263 		   QUIRK_FLAG_DSD_RAW),
2264 	VENDOR_FLG(0x35f4, /* MSB Technology */
2265 		   QUIRK_FLAG_DSD_RAW),
2266 	VENDOR_FLG(0x3842, /* EVGA */
2267 		   QUIRK_FLAG_DSD_RAW),
2268 	VENDOR_FLG(0xc502, /* HiBy devices */
2269 		   QUIRK_FLAG_DSD_RAW),
2270 
2271 	{} /* terminator */
2272 };
2273 
2274 void snd_usb_init_quirk_flags(struct snd_usb_audio *chip)
2275 {
2276 	const struct usb_audio_quirk_flags_table *p;
2277 
2278 	for (p = quirk_flags_table; p->id; p++) {
2279 		if (chip->usb_id == p->id ||
2280 		    (!USB_ID_PRODUCT(p->id) &&
2281 		     USB_ID_VENDOR(chip->usb_id) == USB_ID_VENDOR(p->id))) {
2282 			usb_audio_dbg(chip,
2283 				      "Set quirk_flags 0x%x for device %04x:%04x\n",
2284 				      p->flags, USB_ID_VENDOR(chip->usb_id),
2285 				      USB_ID_PRODUCT(chip->usb_id));
2286 			chip->quirk_flags |= p->flags;
2287 			return;
2288 		}
2289 	}
2290 }
2291