xref: /openbmc/linux/sound/usb/quirks.c (revision d6e0cbb1)
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 "quirks.h"
23 #include "helper.h"
24 #include "endpoint.h"
25 #include "pcm.h"
26 #include "clock.h"
27 #include "stream.h"
28 
29 /*
30  * handle the quirks for the contained interfaces
31  */
32 static int create_composite_quirk(struct snd_usb_audio *chip,
33 				  struct usb_interface *iface,
34 				  struct usb_driver *driver,
35 				  const struct snd_usb_audio_quirk *quirk_comp)
36 {
37 	int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
38 	const struct snd_usb_audio_quirk *quirk;
39 	int err;
40 
41 	for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
42 		iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
43 		if (!iface)
44 			continue;
45 		if (quirk->ifnum != probed_ifnum &&
46 		    usb_interface_claimed(iface))
47 			continue;
48 		err = snd_usb_create_quirk(chip, iface, driver, quirk);
49 		if (err < 0)
50 			return err;
51 	}
52 
53 	for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
54 		iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
55 		if (!iface)
56 			continue;
57 		if (quirk->ifnum != probed_ifnum &&
58 		    !usb_interface_claimed(iface))
59 			usb_driver_claim_interface(driver, iface, (void *)-1L);
60 	}
61 
62 	return 0;
63 }
64 
65 static int ignore_interface_quirk(struct snd_usb_audio *chip,
66 				  struct usb_interface *iface,
67 				  struct usb_driver *driver,
68 				  const struct snd_usb_audio_quirk *quirk)
69 {
70 	return 0;
71 }
72 
73 
74 /*
75  * Allow alignment on audio sub-slot (channel samples) rather than
76  * on audio slots (audio frames)
77  */
78 static int create_align_transfer_quirk(struct snd_usb_audio *chip,
79 				       struct usb_interface *iface,
80 				       struct usb_driver *driver,
81 				       const struct snd_usb_audio_quirk *quirk)
82 {
83 	chip->txfr_quirk = 1;
84 	return 1;	/* Continue with creating streams and mixer */
85 }
86 
87 static int create_any_midi_quirk(struct snd_usb_audio *chip,
88 				 struct usb_interface *intf,
89 				 struct usb_driver *driver,
90 				 const struct snd_usb_audio_quirk *quirk)
91 {
92 	return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
93 }
94 
95 /*
96  * create a stream for an interface with proper descriptors
97  */
98 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
99 				       struct usb_interface *iface,
100 				       struct usb_driver *driver,
101 				       const struct snd_usb_audio_quirk *quirk)
102 {
103 	struct usb_host_interface *alts;
104 	struct usb_interface_descriptor *altsd;
105 	int err;
106 
107 	if (chip->usb_id == USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
108 		chip->tx_length_quirk = 1;
109 
110 	alts = &iface->altsetting[0];
111 	altsd = get_iface_desc(alts);
112 	err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
113 	if (err < 0) {
114 		usb_audio_err(chip, "cannot setup if %d: error %d\n",
115 			   altsd->bInterfaceNumber, err);
116 		return err;
117 	}
118 	/* reset the current interface */
119 	usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
120 	return 0;
121 }
122 
123 /*
124  * create a stream for an endpoint/altsetting without proper descriptors
125  */
126 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
127 				     struct usb_interface *iface,
128 				     struct usb_driver *driver,
129 				     const struct snd_usb_audio_quirk *quirk)
130 {
131 	struct audioformat *fp;
132 	struct usb_host_interface *alts;
133 	struct usb_interface_descriptor *altsd;
134 	int stream, err;
135 	unsigned *rate_table = NULL;
136 
137 	fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
138 	if (!fp)
139 		return -ENOMEM;
140 
141 	INIT_LIST_HEAD(&fp->list);
142 	if (fp->nr_rates > MAX_NR_RATES) {
143 		kfree(fp);
144 		return -EINVAL;
145 	}
146 	if (fp->nr_rates > 0) {
147 		rate_table = kmemdup(fp->rate_table,
148 				     sizeof(int) * fp->nr_rates, GFP_KERNEL);
149 		if (!rate_table) {
150 			kfree(fp);
151 			return -ENOMEM;
152 		}
153 		fp->rate_table = rate_table;
154 	}
155 
156 	stream = (fp->endpoint & USB_DIR_IN)
157 		? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
158 	err = snd_usb_add_audio_stream(chip, stream, fp);
159 	if (err < 0)
160 		goto error;
161 	if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
162 	    fp->altset_idx >= iface->num_altsetting) {
163 		err = -EINVAL;
164 		goto error;
165 	}
166 	alts = &iface->altsetting[fp->altset_idx];
167 	altsd = get_iface_desc(alts);
168 	if (altsd->bNumEndpoints < 1) {
169 		err = -EINVAL;
170 		goto error;
171 	}
172 
173 	fp->protocol = altsd->bInterfaceProtocol;
174 
175 	if (fp->datainterval == 0)
176 		fp->datainterval = snd_usb_parse_datainterval(chip, alts);
177 	if (fp->maxpacksize == 0)
178 		fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
179 	usb_set_interface(chip->dev, fp->iface, 0);
180 	snd_usb_init_pitch(chip, fp->iface, alts, fp);
181 	snd_usb_init_sample_rate(chip, fp->iface, alts, fp, fp->rate_max);
182 	return 0;
183 
184  error:
185 	list_del(&fp->list); /* unlink for avoiding double-free */
186 	kfree(fp);
187 	kfree(rate_table);
188 	return err;
189 }
190 
191 static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
192 				 struct usb_interface *iface,
193 				 struct usb_driver *driver)
194 {
195 	struct usb_host_interface *alts;
196 	struct usb_interface_descriptor *altsd;
197 	struct usb_endpoint_descriptor *epd;
198 	struct uac1_as_header_descriptor *ashd;
199 	struct uac_format_type_i_discrete_descriptor *fmtd;
200 
201 	/*
202 	 * Most Roland/Yamaha audio streaming interfaces have more or less
203 	 * standard descriptors, but older devices might lack descriptors, and
204 	 * future ones might change, so ensure that we fail silently if the
205 	 * interface doesn't look exactly right.
206 	 */
207 
208 	/* must have a non-zero altsetting for streaming */
209 	if (iface->num_altsetting < 2)
210 		return -ENODEV;
211 	alts = &iface->altsetting[1];
212 	altsd = get_iface_desc(alts);
213 
214 	/* must have an isochronous endpoint for streaming */
215 	if (altsd->bNumEndpoints < 1)
216 		return -ENODEV;
217 	epd = get_endpoint(alts, 0);
218 	if (!usb_endpoint_xfer_isoc(epd))
219 		return -ENODEV;
220 
221 	/* must have format descriptors */
222 	ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
223 				       UAC_AS_GENERAL);
224 	fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
225 				       UAC_FORMAT_TYPE);
226 	if (!ashd || ashd->bLength < 7 ||
227 	    !fmtd || fmtd->bLength < 8)
228 		return -ENODEV;
229 
230 	return create_standard_audio_quirk(chip, iface, driver, NULL);
231 }
232 
233 static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
234 				    struct usb_interface *iface,
235 				    struct usb_driver *driver,
236 				    struct usb_host_interface *alts)
237 {
238 	static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
239 		.type = QUIRK_MIDI_YAMAHA
240 	};
241 	struct usb_midi_in_jack_descriptor *injd;
242 	struct usb_midi_out_jack_descriptor *outjd;
243 
244 	/* must have some valid jack descriptors */
245 	injd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
246 				       NULL, USB_MS_MIDI_IN_JACK);
247 	outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
248 					NULL, USB_MS_MIDI_OUT_JACK);
249 	if (!injd && !outjd)
250 		return -ENODEV;
251 	if (injd && (injd->bLength < 5 ||
252 		     (injd->bJackType != USB_MS_EMBEDDED &&
253 		      injd->bJackType != USB_MS_EXTERNAL)))
254 		return -ENODEV;
255 	if (outjd && (outjd->bLength < 6 ||
256 		      (outjd->bJackType != USB_MS_EMBEDDED &&
257 		       outjd->bJackType != USB_MS_EXTERNAL)))
258 		return -ENODEV;
259 	return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
260 }
261 
262 static int create_roland_midi_quirk(struct snd_usb_audio *chip,
263 				    struct usb_interface *iface,
264 				    struct usb_driver *driver,
265 				    struct usb_host_interface *alts)
266 {
267 	static const struct snd_usb_audio_quirk roland_midi_quirk = {
268 		.type = QUIRK_MIDI_ROLAND
269 	};
270 	u8 *roland_desc = NULL;
271 
272 	/* might have a vendor-specific descriptor <06 24 F1 02 ...> */
273 	for (;;) {
274 		roland_desc = snd_usb_find_csint_desc(alts->extra,
275 						      alts->extralen,
276 						      roland_desc, 0xf1);
277 		if (!roland_desc)
278 			return -ENODEV;
279 		if (roland_desc[0] < 6 || roland_desc[3] != 2)
280 			continue;
281 		return create_any_midi_quirk(chip, iface, driver,
282 					     &roland_midi_quirk);
283 	}
284 }
285 
286 static int create_std_midi_quirk(struct snd_usb_audio *chip,
287 				 struct usb_interface *iface,
288 				 struct usb_driver *driver,
289 				 struct usb_host_interface *alts)
290 {
291 	struct usb_ms_header_descriptor *mshd;
292 	struct usb_ms_endpoint_descriptor *msepd;
293 
294 	/* must have the MIDIStreaming interface header descriptor*/
295 	mshd = (struct usb_ms_header_descriptor *)alts->extra;
296 	if (alts->extralen < 7 ||
297 	    mshd->bLength < 7 ||
298 	    mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
299 	    mshd->bDescriptorSubtype != USB_MS_HEADER)
300 		return -ENODEV;
301 	/* must have the MIDIStreaming endpoint descriptor*/
302 	msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra;
303 	if (alts->endpoint[0].extralen < 4 ||
304 	    msepd->bLength < 4 ||
305 	    msepd->bDescriptorType != USB_DT_CS_ENDPOINT ||
306 	    msepd->bDescriptorSubtype != UAC_MS_GENERAL ||
307 	    msepd->bNumEmbMIDIJack < 1 ||
308 	    msepd->bNumEmbMIDIJack > 16)
309 		return -ENODEV;
310 
311 	return create_any_midi_quirk(chip, iface, driver, NULL);
312 }
313 
314 static int create_auto_midi_quirk(struct snd_usb_audio *chip,
315 				  struct usb_interface *iface,
316 				  struct usb_driver *driver)
317 {
318 	struct usb_host_interface *alts;
319 	struct usb_interface_descriptor *altsd;
320 	struct usb_endpoint_descriptor *epd;
321 	int err;
322 
323 	alts = &iface->altsetting[0];
324 	altsd = get_iface_desc(alts);
325 
326 	/* must have at least one bulk/interrupt endpoint for streaming */
327 	if (altsd->bNumEndpoints < 1)
328 		return -ENODEV;
329 	epd = get_endpoint(alts, 0);
330 	if (!usb_endpoint_xfer_bulk(epd) &&
331 	    !usb_endpoint_xfer_int(epd))
332 		return -ENODEV;
333 
334 	switch (USB_ID_VENDOR(chip->usb_id)) {
335 	case 0x0499: /* Yamaha */
336 		err = create_yamaha_midi_quirk(chip, iface, driver, alts);
337 		if (err != -ENODEV)
338 			return err;
339 		break;
340 	case 0x0582: /* Roland */
341 		err = create_roland_midi_quirk(chip, iface, driver, alts);
342 		if (err != -ENODEV)
343 			return err;
344 		break;
345 	}
346 
347 	return create_std_midi_quirk(chip, iface, driver, alts);
348 }
349 
350 static int create_autodetect_quirk(struct snd_usb_audio *chip,
351 				   struct usb_interface *iface,
352 				   struct usb_driver *driver)
353 {
354 	int err;
355 
356 	err = create_auto_pcm_quirk(chip, iface, driver);
357 	if (err == -ENODEV)
358 		err = create_auto_midi_quirk(chip, iface, driver);
359 	return err;
360 }
361 
362 static int create_autodetect_quirks(struct snd_usb_audio *chip,
363 				    struct usb_interface *iface,
364 				    struct usb_driver *driver,
365 				    const struct snd_usb_audio_quirk *quirk)
366 {
367 	int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
368 	int ifcount, ifnum, err;
369 
370 	err = create_autodetect_quirk(chip, iface, driver);
371 	if (err < 0)
372 		return err;
373 
374 	/*
375 	 * ALSA PCM playback/capture devices cannot be registered in two steps,
376 	 * so we have to claim the other corresponding interface here.
377 	 */
378 	ifcount = chip->dev->actconfig->desc.bNumInterfaces;
379 	for (ifnum = 0; ifnum < ifcount; ifnum++) {
380 		if (ifnum == probed_ifnum || quirk->ifnum >= 0)
381 			continue;
382 		iface = usb_ifnum_to_if(chip->dev, ifnum);
383 		if (!iface ||
384 		    usb_interface_claimed(iface) ||
385 		    get_iface_desc(iface->altsetting)->bInterfaceClass !=
386 							USB_CLASS_VENDOR_SPEC)
387 			continue;
388 
389 		err = create_autodetect_quirk(chip, iface, driver);
390 		if (err >= 0)
391 			usb_driver_claim_interface(driver, iface, (void *)-1L);
392 	}
393 
394 	return 0;
395 }
396 
397 /*
398  * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
399  * The only way to detect the sample rate is by looking at wMaxPacketSize.
400  */
401 static int create_uaxx_quirk(struct snd_usb_audio *chip,
402 			     struct usb_interface *iface,
403 			     struct usb_driver *driver,
404 			     const struct snd_usb_audio_quirk *quirk)
405 {
406 	static const struct audioformat ua_format = {
407 		.formats = SNDRV_PCM_FMTBIT_S24_3LE,
408 		.channels = 2,
409 		.fmt_type = UAC_FORMAT_TYPE_I,
410 		.altsetting = 1,
411 		.altset_idx = 1,
412 		.rates = SNDRV_PCM_RATE_CONTINUOUS,
413 	};
414 	struct usb_host_interface *alts;
415 	struct usb_interface_descriptor *altsd;
416 	struct audioformat *fp;
417 	int stream, err;
418 
419 	/* both PCM and MIDI interfaces have 2 or more altsettings */
420 	if (iface->num_altsetting < 2)
421 		return -ENXIO;
422 	alts = &iface->altsetting[1];
423 	altsd = get_iface_desc(alts);
424 
425 	if (altsd->bNumEndpoints == 2) {
426 		static const struct snd_usb_midi_endpoint_info ua700_ep = {
427 			.out_cables = 0x0003,
428 			.in_cables  = 0x0003
429 		};
430 		static const struct snd_usb_audio_quirk ua700_quirk = {
431 			.type = QUIRK_MIDI_FIXED_ENDPOINT,
432 			.data = &ua700_ep
433 		};
434 		static const struct snd_usb_midi_endpoint_info uaxx_ep = {
435 			.out_cables = 0x0001,
436 			.in_cables  = 0x0001
437 		};
438 		static const struct snd_usb_audio_quirk uaxx_quirk = {
439 			.type = QUIRK_MIDI_FIXED_ENDPOINT,
440 			.data = &uaxx_ep
441 		};
442 		const struct snd_usb_audio_quirk *quirk =
443 			chip->usb_id == USB_ID(0x0582, 0x002b)
444 			? &ua700_quirk : &uaxx_quirk;
445 		return __snd_usbmidi_create(chip->card, iface,
446 					  &chip->midi_list, quirk,
447 					  chip->usb_id);
448 	}
449 
450 	if (altsd->bNumEndpoints != 1)
451 		return -ENXIO;
452 
453 	fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
454 	if (!fp)
455 		return -ENOMEM;
456 
457 	fp->iface = altsd->bInterfaceNumber;
458 	fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
459 	fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
460 	fp->datainterval = 0;
461 	fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
462 	INIT_LIST_HEAD(&fp->list);
463 
464 	switch (fp->maxpacksize) {
465 	case 0x120:
466 		fp->rate_max = fp->rate_min = 44100;
467 		break;
468 	case 0x138:
469 	case 0x140:
470 		fp->rate_max = fp->rate_min = 48000;
471 		break;
472 	case 0x258:
473 	case 0x260:
474 		fp->rate_max = fp->rate_min = 96000;
475 		break;
476 	default:
477 		usb_audio_err(chip, "unknown sample rate\n");
478 		kfree(fp);
479 		return -ENXIO;
480 	}
481 
482 	stream = (fp->endpoint & USB_DIR_IN)
483 		? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
484 	err = snd_usb_add_audio_stream(chip, stream, fp);
485 	if (err < 0) {
486 		list_del(&fp->list); /* unlink for avoiding double-free */
487 		kfree(fp);
488 		return err;
489 	}
490 	usb_set_interface(chip->dev, fp->iface, 0);
491 	return 0;
492 }
493 
494 /*
495  * Create a standard mixer for the specified interface.
496  */
497 static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
498 				       struct usb_interface *iface,
499 				       struct usb_driver *driver,
500 				       const struct snd_usb_audio_quirk *quirk)
501 {
502 	if (quirk->ifnum < 0)
503 		return 0;
504 
505 	return snd_usb_create_mixer(chip, quirk->ifnum, 0);
506 }
507 
508 /*
509  * audio-interface quirks
510  *
511  * returns zero if no standard audio/MIDI parsing is needed.
512  * returns a positive value if standard audio/midi interfaces are parsed
513  * after this.
514  * returns a negative value at error.
515  */
516 int snd_usb_create_quirk(struct snd_usb_audio *chip,
517 			 struct usb_interface *iface,
518 			 struct usb_driver *driver,
519 			 const struct snd_usb_audio_quirk *quirk)
520 {
521 	typedef int (*quirk_func_t)(struct snd_usb_audio *,
522 				    struct usb_interface *,
523 				    struct usb_driver *,
524 				    const struct snd_usb_audio_quirk *);
525 	static const quirk_func_t quirk_funcs[] = {
526 		[QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
527 		[QUIRK_COMPOSITE] = create_composite_quirk,
528 		[QUIRK_AUTODETECT] = create_autodetect_quirks,
529 		[QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
530 		[QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
531 		[QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
532 		[QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
533 		[QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
534 		[QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
535 		[QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
536 		[QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
537 		[QUIRK_MIDI_CME] = create_any_midi_quirk,
538 		[QUIRK_MIDI_AKAI] = create_any_midi_quirk,
539 		[QUIRK_MIDI_FTDI] = create_any_midi_quirk,
540 		[QUIRK_MIDI_CH345] = create_any_midi_quirk,
541 		[QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
542 		[QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
543 		[QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
544 		[QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
545 		[QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
546 	};
547 
548 	if (quirk->type < QUIRK_TYPE_COUNT) {
549 		return quirk_funcs[quirk->type](chip, iface, driver, quirk);
550 	} else {
551 		usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
552 		return -ENXIO;
553 	}
554 }
555 
556 /*
557  * boot quirks
558  */
559 
560 #define EXTIGY_FIRMWARE_SIZE_OLD 794
561 #define EXTIGY_FIRMWARE_SIZE_NEW 483
562 
563 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
564 {
565 	struct usb_host_config *config = dev->actconfig;
566 	int err;
567 
568 	if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
569 	    le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
570 		dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
571 		/* Send message to force it to reconnect with full interface. */
572 		err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
573 				      0x10, 0x43, 0x0001, 0x000a, NULL, 0);
574 		if (err < 0)
575 			dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
576 		err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
577 				&dev->descriptor, sizeof(dev->descriptor));
578 		config = dev->actconfig;
579 		if (err < 0)
580 			dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
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 
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 
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  */
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 
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 
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 */
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  */
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  */
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 (snd_usb_pipe_sanity_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 
860 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
861 {
862 	int ret;
863 
864 	if (snd_usb_pipe_sanity_check(dev, usb_sndctrlpipe(dev, 0)))
865 		return -EINVAL;
866 	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
867 				  0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
868 				  1, 0, NULL, 0, 1000);
869 
870 	if (ret < 0)
871 		return ret;
872 
873 	usb_reset_device(dev);
874 
875 	/* return -EAGAIN, so the creation of an audio interface for this
876 	 * temporary device is aborted. The device will reconnect with a
877 	 * new product ID */
878 	return -EAGAIN;
879 }
880 
881 static void mbox2_setup_48_24_magic(struct usb_device *dev)
882 {
883 	u8 srate[3];
884 	u8 temp[12];
885 
886 	/* Choose 48000Hz permanently */
887 	srate[0] = 0x80;
888 	srate[1] = 0xbb;
889 	srate[2] = 0x00;
890 
891 	/* Send the magic! */
892 	snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
893 		0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
894 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
895 		0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
896 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
897 		0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
898 	snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
899 		0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
900 	return;
901 }
902 
903 /* Digidesign Mbox 2 needs to load firmware onboard
904  * and driver must wait a few seconds for initialisation.
905  */
906 
907 #define MBOX2_FIRMWARE_SIZE    646
908 #define MBOX2_BOOT_LOADING     0x01 /* Hard coded into the device */
909 #define MBOX2_BOOT_READY       0x02 /* Hard coded into the device */
910 
911 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
912 {
913 	struct usb_host_config *config = dev->actconfig;
914 	int err;
915 	u8 bootresponse[0x12];
916 	int fwsize;
917 	int count;
918 
919 	fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
920 
921 	if (fwsize != MBOX2_FIRMWARE_SIZE) {
922 		dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
923 		return -ENODEV;
924 	}
925 
926 	dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
927 
928 	count = 0;
929 	bootresponse[0] = MBOX2_BOOT_LOADING;
930 	while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
931 		msleep(500); /* 0.5 second delay */
932 		snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
933 			/* Control magic - load onboard firmware */
934 			0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
935 		if (bootresponse[0] == MBOX2_BOOT_READY)
936 			break;
937 		dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
938 		count++;
939 	}
940 
941 	if (bootresponse[0] != MBOX2_BOOT_READY) {
942 		dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
943 		return -ENODEV;
944 	}
945 
946 	dev_dbg(&dev->dev, "device initialised!\n");
947 
948 	err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
949 		&dev->descriptor, sizeof(dev->descriptor));
950 	config = dev->actconfig;
951 	if (err < 0)
952 		dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
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 (snd_usb_pipe_sanity_check(dev, usb_sndctrlpipe(dev, 0)))
974 		return -EINVAL;
975 	/* If the Axe-Fx III has not fully booted, it will timeout when trying
976 	 * to enable the audio streaming interface. A more generous timeout is
977 	 * used here to detect when the Axe-Fx III has finished booting as the
978 	 * set interface message will be acked once it has
979 	 */
980 	err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
981 				USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
982 				1, 1, NULL, 0, 120000);
983 	if (err < 0) {
984 		dev_err(&dev->dev,
985 			"failed waiting for Axe-Fx III to boot: %d\n", err);
986 		return err;
987 	}
988 
989 	dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
990 
991 	err = usb_set_interface(dev, 1, 0);
992 	if (err < 0)
993 		dev_dbg(&dev->dev,
994 			"error stopping Axe-Fx III interface: %d\n", err);
995 
996 	return 0;
997 }
998 
999 
1000 #define MICROBOOK_BUF_SIZE 128
1001 
1002 static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1003 						int buf_size, int *length)
1004 {
1005 	int err, actual_length;
1006 
1007 	if (snd_usb_pipe_sanity_check(dev, usb_sndintpipe(dev, 0x01)))
1008 		return -EINVAL;
1009 	err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1010 				&actual_length, 1000);
1011 	if (err < 0)
1012 		return err;
1013 
1014 	print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1015 		       buf, actual_length, false);
1016 
1017 	memset(buf, 0, buf_size);
1018 
1019 	if (snd_usb_pipe_sanity_check(dev, usb_rcvintpipe(dev, 0x82)))
1020 		return -EINVAL;
1021 	err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1022 				&actual_length, 1000);
1023 	if (err < 0)
1024 		return err;
1025 
1026 	print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1027 		       buf, actual_length, false);
1028 
1029 	*length = actual_length;
1030 	return 0;
1031 }
1032 
1033 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1034 {
1035 	int err, actual_length, poll_attempts = 0;
1036 	static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1037 						 0x00, 0x00, 0x0b, 0x14,
1038 						 0x00, 0x00, 0x00, 0x01 };
1039 	static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1040 					     0x00, 0x00, 0x0b, 0x18 };
1041 	u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1042 
1043 	if (!buf)
1044 		return -ENOMEM;
1045 
1046 	dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1047 
1048 	/* First we tell the device which sample rate to use. */
1049 	memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1050 	actual_length = sizeof(set_samplerate_seq);
1051 	err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1052 						   &actual_length);
1053 
1054 	if (err < 0) {
1055 		dev_err(&dev->dev,
1056 			"failed setting the sample rate for Motu MicroBook II: %d\n",
1057 			err);
1058 		goto free_buf;
1059 	}
1060 
1061 	/* Then we poll every 100 ms until the device informs of its readiness. */
1062 	while (true) {
1063 		if (++poll_attempts > 100) {
1064 			dev_err(&dev->dev,
1065 				"failed booting Motu MicroBook II: timeout\n");
1066 			err = -ENODEV;
1067 			goto free_buf;
1068 		}
1069 
1070 		memset(buf, 0, MICROBOOK_BUF_SIZE);
1071 		memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1072 
1073 		actual_length = sizeof(poll_ready_seq);
1074 		err = snd_usb_motu_microbookii_communicate(
1075 			dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1076 		if (err < 0) {
1077 			dev_err(&dev->dev,
1078 				"failed booting Motu MicroBook II: communication error %d\n",
1079 				err);
1080 			goto free_buf;
1081 		}
1082 
1083 		/* the device signals its readiness through a message of the
1084 		 * form
1085 		 *           XX 06 00 00 00 00 0b 18  00 00 00 01
1086 		 * If the device is not yet ready to accept audio data, the
1087 		 * last byte of that sequence is 00.
1088 		 */
1089 		if (actual_length == 12 && buf[actual_length - 1] == 1)
1090 			break;
1091 
1092 		msleep(100);
1093 	}
1094 
1095 	dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1096 
1097 free_buf:
1098 	kfree(buf);
1099 	return err;
1100 }
1101 
1102 /*
1103  * Setup quirks
1104  */
1105 #define MAUDIO_SET		0x01 /* parse device_setup */
1106 #define MAUDIO_SET_COMPATIBLE	0x80 /* use only "win-compatible" interfaces */
1107 #define MAUDIO_SET_DTS		0x02 /* enable DTS Digital Output */
1108 #define MAUDIO_SET_96K		0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
1109 #define MAUDIO_SET_24B		0x08 /* 24bits sample if set, 16bits otherwise */
1110 #define MAUDIO_SET_DI		0x10 /* enable Digital Input */
1111 #define MAUDIO_SET_MASK		0x1f /* bit mask for setup value */
1112 #define MAUDIO_SET_24B_48K_DI	 0x19 /* 24bits+48KHz+Digital Input */
1113 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
1114 #define MAUDIO_SET_16B_48K_DI	 0x11 /* 16bits+48KHz+Digital Input */
1115 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
1116 
1117 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1118 				      int iface, int altno)
1119 {
1120 	/* Reset ALL ifaces to 0 altsetting.
1121 	 * Call it for every possible altsetting of every interface.
1122 	 */
1123 	usb_set_interface(chip->dev, iface, 0);
1124 	if (chip->setup & MAUDIO_SET) {
1125 		if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1126 			if (iface != 1 && iface != 2)
1127 				return 1; /* skip all interfaces but 1 and 2 */
1128 		} else {
1129 			unsigned int mask;
1130 			if (iface == 1 || iface == 2)
1131 				return 1; /* skip interfaces 1 and 2 */
1132 			if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1133 				return 1; /* skip this altsetting */
1134 			mask = chip->setup & MAUDIO_SET_MASK;
1135 			if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1136 				return 1; /* skip this altsetting */
1137 			if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1138 				return 1; /* skip this altsetting */
1139 			if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1140 				return 1; /* skip this altsetting */
1141 		}
1142 	}
1143 	usb_audio_dbg(chip,
1144 		    "using altsetting %d for interface %d config %d\n",
1145 		    altno, iface, chip->setup);
1146 	return 0; /* keep this altsetting */
1147 }
1148 
1149 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1150 					 int iface,
1151 					 int altno)
1152 {
1153 	/* Reset ALL ifaces to 0 altsetting.
1154 	 * Call it for every possible altsetting of every interface.
1155 	 */
1156 	usb_set_interface(chip->dev, iface, 0);
1157 
1158 	if (chip->setup & MAUDIO_SET) {
1159 		unsigned int mask;
1160 		if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1161 			return 1; /* skip this altsetting */
1162 		if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1163 			return 1; /* skip this altsetting */
1164 		mask = chip->setup & MAUDIO_SET_MASK;
1165 		if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1166 			return 1; /* skip this altsetting */
1167 		if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1168 			return 1; /* skip this altsetting */
1169 		if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1170 			return 1; /* skip this altsetting */
1171 		if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1172 			return 1; /* skip this altsetting */
1173 	}
1174 
1175 	return 0; /* keep this altsetting */
1176 }
1177 
1178 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1179 					   int iface, int altno)
1180 {
1181 	/* Reset ALL ifaces to 0 altsetting.
1182 	 * Call it for every possible altsetting of every interface.
1183 	 */
1184 	usb_set_interface(chip->dev, iface, 0);
1185 
1186 	/* possible configuration where both inputs and only one output is
1187 	 *used is not supported by the current setup
1188 	 */
1189 	if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1190 		if (chip->setup & MAUDIO_SET_96K) {
1191 			if (altno != 3 && altno != 6)
1192 				return 1;
1193 		} else if (chip->setup & MAUDIO_SET_DI) {
1194 			if (iface == 4)
1195 				return 1; /* no analog input */
1196 			if (altno != 2 && altno != 5)
1197 				return 1; /* enable only altsets 2 and 5 */
1198 		} else {
1199 			if (iface == 5)
1200 				return 1; /* disable digialt input */
1201 			if (altno != 2 && altno != 5)
1202 				return 1; /* enalbe only altsets 2 and 5 */
1203 		}
1204 	} else {
1205 		/* keep only 16-Bit mode */
1206 		if (altno != 1)
1207 			return 1;
1208 	}
1209 
1210 	usb_audio_dbg(chip,
1211 		    "using altsetting %d for interface %d config %d\n",
1212 		    altno, iface, chip->setup);
1213 	return 0; /* keep this altsetting */
1214 }
1215 
1216 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1217 				  int iface,
1218 				  int altno)
1219 {
1220 	/* audiophile usb: skip altsets incompatible with device_setup */
1221 	if (chip->usb_id == USB_ID(0x0763, 0x2003))
1222 		return audiophile_skip_setting_quirk(chip, iface, altno);
1223 	/* quattro usb: skip altsets incompatible with device_setup */
1224 	if (chip->usb_id == USB_ID(0x0763, 0x2001))
1225 		return quattro_skip_setting_quirk(chip, iface, altno);
1226 	/* fasttrackpro usb: skip altsets incompatible with device_setup */
1227 	if (chip->usb_id == USB_ID(0x0763, 0x2012))
1228 		return fasttrackpro_skip_setting_quirk(chip, iface, altno);
1229 
1230 	return 0;
1231 }
1232 
1233 int snd_usb_apply_boot_quirk(struct usb_device *dev,
1234 			     struct usb_interface *intf,
1235 			     const struct snd_usb_audio_quirk *quirk,
1236 			     unsigned int id)
1237 {
1238 	switch (id) {
1239 	case USB_ID(0x041e, 0x3000):
1240 		/* SB Extigy needs special boot-up sequence */
1241 		/* if more models come, this will go to the quirk list. */
1242 		return snd_usb_extigy_boot_quirk(dev, intf);
1243 
1244 	case USB_ID(0x041e, 0x3020):
1245 		/* SB Audigy 2 NX needs its own boot-up magic, too */
1246 		return snd_usb_audigy2nx_boot_quirk(dev);
1247 
1248 	case USB_ID(0x10f5, 0x0200):
1249 		/* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1250 		return snd_usb_cm106_boot_quirk(dev);
1251 
1252 	case USB_ID(0x0d8c, 0x0102):
1253 		/* C-Media CM6206 / CM106-Like Sound Device */
1254 	case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1255 		return snd_usb_cm6206_boot_quirk(dev);
1256 
1257 	case USB_ID(0x0dba, 0x3000):
1258 		/* Digidesign Mbox 2 */
1259 		return snd_usb_mbox2_boot_quirk(dev);
1260 
1261 	case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1262 	case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1263 		return snd_usb_novation_boot_quirk(dev);
1264 
1265 	case USB_ID(0x133e, 0x0815):
1266 		/* Access Music VirusTI Desktop */
1267 		return snd_usb_accessmusic_boot_quirk(dev);
1268 
1269 	case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1270 	case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1271 	case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1272 		return snd_usb_nativeinstruments_boot_quirk(dev);
1273 	case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1274 		return snd_usb_fasttrackpro_boot_quirk(dev);
1275 	case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1276 		return snd_usb_gamecon780_boot_quirk(dev);
1277 	case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1278 		return snd_usb_axefx3_boot_quirk(dev);
1279 	case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1280 		return snd_usb_motu_microbookii_boot_quirk(dev);
1281 	}
1282 
1283 	return 0;
1284 }
1285 
1286 /*
1287  * check if the device uses big-endian samples
1288  */
1289 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
1290 {
1291 	/* it depends on altsetting whether the device is big-endian or not */
1292 	switch (chip->usb_id) {
1293 	case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1294 		if (fp->altsetting == 2 || fp->altsetting == 3 ||
1295 			fp->altsetting == 5 || fp->altsetting == 6)
1296 			return 1;
1297 		break;
1298 	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1299 		if (chip->setup == 0x00 ||
1300 			fp->altsetting == 1 || fp->altsetting == 2 ||
1301 			fp->altsetting == 3)
1302 			return 1;
1303 		break;
1304 	case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1305 		if (fp->altsetting == 2 || fp->altsetting == 3 ||
1306 			fp->altsetting == 5 || fp->altsetting == 6)
1307 			return 1;
1308 		break;
1309 	}
1310 	return 0;
1311 }
1312 
1313 /*
1314  * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1315  * not for interface.
1316  */
1317 
1318 enum {
1319 	EMU_QUIRK_SR_44100HZ = 0,
1320 	EMU_QUIRK_SR_48000HZ,
1321 	EMU_QUIRK_SR_88200HZ,
1322 	EMU_QUIRK_SR_96000HZ,
1323 	EMU_QUIRK_SR_176400HZ,
1324 	EMU_QUIRK_SR_192000HZ
1325 };
1326 
1327 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1328 				 struct audioformat *fmt)
1329 {
1330 	unsigned char emu_samplerate_id = 0;
1331 
1332 	/* When capture is active
1333 	 * sample rate shouldn't be changed
1334 	 * by playback substream
1335 	 */
1336 	if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1337 		if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
1338 			return;
1339 	}
1340 
1341 	switch (fmt->rate_min) {
1342 	case 48000:
1343 		emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1344 		break;
1345 	case 88200:
1346 		emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1347 		break;
1348 	case 96000:
1349 		emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1350 		break;
1351 	case 176400:
1352 		emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1353 		break;
1354 	case 192000:
1355 		emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1356 		break;
1357 	default:
1358 		emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1359 		break;
1360 	}
1361 	snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1362 	subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1363 }
1364 
1365 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1366 			      struct audioformat *fmt)
1367 {
1368 	switch (subs->stream->chip->usb_id) {
1369 	case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1370 	case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1371 	case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1372 	case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1373 		set_format_emu_quirk(subs, fmt);
1374 		break;
1375 	}
1376 }
1377 
1378 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1379 {
1380 	/* devices which do not support reading the sample rate. */
1381 	switch (chip->usb_id) {
1382 	case USB_ID(0x041E, 0x4080): /* Creative Live Cam VF0610 */
1383 	case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */
1384 	case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
1385 	case USB_ID(0x05A3, 0x9420): /* ELP HD USB Camera */
1386 	case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1387 	case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
1388 	case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
1389 	case USB_ID(0x21B4, 0x0081): /* AudioQuest DragonFly */
1390 		return true;
1391 	}
1392 
1393 	/* devices of these vendors don't support reading rate, either */
1394 	switch (USB_ID_VENDOR(chip->usb_id)) {
1395 	case 0x045E: /* MS Lifecam */
1396 	case 0x047F: /* Plantronics */
1397 	case 0x1de7: /* Phoenix Audio */
1398 		return true;
1399 	}
1400 
1401 	return false;
1402 }
1403 
1404 /* ITF-USB DSD based DACs need a vendor cmd to switch
1405  * between PCM and native DSD mode
1406  */
1407 static bool is_itf_usb_dsd_dac(unsigned int id)
1408 {
1409 	switch (id) {
1410 	case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1411 	case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1412 	case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1413 	case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
1414 	case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
1415 	case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
1416 	case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
1417 		return true;
1418 	}
1419 	return false;
1420 }
1421 
1422 int snd_usb_select_mode_quirk(struct snd_usb_substream *subs,
1423 			      struct audioformat *fmt)
1424 {
1425 	struct usb_device *dev = subs->dev;
1426 	int err;
1427 
1428 	if (is_itf_usb_dsd_dac(subs->stream->chip->usb_id)) {
1429 		/* First switch to alt set 0, otherwise the mode switch cmd
1430 		 * will not be accepted by the DAC
1431 		 */
1432 		err = usb_set_interface(dev, fmt->iface, 0);
1433 		if (err < 0)
1434 			return err;
1435 
1436 		msleep(20); /* Delay needed after setting the interface */
1437 
1438 		/* Vendor mode switch cmd is required. */
1439 		if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1440 			/* DSD mode (DSD_U32) requested */
1441 			err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1442 					      USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1443 					      1, 1, NULL, 0);
1444 			if (err < 0)
1445 				return err;
1446 
1447 		} else {
1448 			/* PCM or DOP mode (S32) requested */
1449 			/* PCM mode (S16) requested */
1450 			err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1451 					      USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1452 					      0, 1, NULL, 0);
1453 			if (err < 0)
1454 				return err;
1455 
1456 		}
1457 		msleep(20);
1458 	}
1459 	return 0;
1460 }
1461 
1462 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1463 {
1464 	/*
1465 	 * "Playback Design" products send bogus feedback data at the start
1466 	 * of the stream. Ignore them.
1467 	 */
1468 	if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1469 	    ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1470 		ep->skip_packets = 4;
1471 
1472 	/*
1473 	 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1474 	 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1475 	 * the stream is (re)started. When skipping packets 16 at endpoint
1476 	 * start up, the real world latency is stable within +/- 1 frame (also
1477 	 * across power cycles).
1478 	 */
1479 	if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1480 	     ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1481 	    ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1482 		ep->skip_packets = 16;
1483 
1484 	/* Work around devices that report unreasonable feedback data */
1485 	if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) ||  /* TEAC UD-H01 */
1486 	     ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1487 	    ep->syncmaxsize == 4)
1488 		ep->tenor_fb_quirk = 1;
1489 }
1490 
1491 void snd_usb_set_interface_quirk(struct usb_device *dev)
1492 {
1493 	struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1494 
1495 	if (!chip)
1496 		return;
1497 	/*
1498 	 * "Playback Design" products need a 50ms delay after setting the
1499 	 * USB interface.
1500 	 */
1501 	switch (USB_ID_VENDOR(chip->usb_id)) {
1502 	case 0x23ba: /* Playback Design */
1503 	case 0x0644: /* TEAC Corp. */
1504 		msleep(50);
1505 		break;
1506 	}
1507 }
1508 
1509 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1510 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1511 			   __u8 request, __u8 requesttype, __u16 value,
1512 			   __u16 index, void *data, __u16 size)
1513 {
1514 	struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1515 
1516 	if (!chip)
1517 		return;
1518 	/*
1519 	 * "Playback Design" products need a 20ms delay after each
1520 	 * class compliant request
1521 	 */
1522 	if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1523 	    (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1524 		msleep(20);
1525 
1526 	/*
1527 	 * "TEAC Corp." products need a 20ms delay after each
1528 	 * class compliant request
1529 	 */
1530 	if (USB_ID_VENDOR(chip->usb_id) == 0x0644 &&
1531 	    (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1532 		msleep(20);
1533 
1534 	/* ITF-USB DSD based DACs functionality need a delay
1535 	 * after each class compliant request
1536 	 */
1537 	if (is_itf_usb_dsd_dac(chip->usb_id)
1538 	    && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1539 		msleep(20);
1540 
1541 	/* Zoom R16/24, Logitech H650e, Jabra 550a needs a tiny delay here,
1542 	 * otherwise requests like get/set frequency return as failed despite
1543 	 * actually succeeding.
1544 	 */
1545 	if ((chip->usb_id == USB_ID(0x1686, 0x00dd) ||
1546 	     chip->usb_id == USB_ID(0x046d, 0x0a46) ||
1547 	     chip->usb_id == USB_ID(0x0b0e, 0x0349)) &&
1548 	    (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1549 		usleep_range(1000, 2000);
1550 }
1551 
1552 /*
1553  * snd_usb_interface_dsd_format_quirks() is called from format.c to
1554  * augment the PCM format bit-field for DSD types. The UAC standards
1555  * don't have a designated bit field to denote DSD-capable interfaces,
1556  * hence all hardware that is known to support this format has to be
1557  * listed here.
1558  */
1559 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1560 					struct audioformat *fp,
1561 					unsigned int sample_bytes)
1562 {
1563 	struct usb_interface *iface;
1564 
1565 	/* Playback Designs */
1566 	if (USB_ID_VENDOR(chip->usb_id) == 0x23ba) {
1567 		switch (fp->altsetting) {
1568 		case 1:
1569 			fp->dsd_dop = true;
1570 			return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1571 		case 2:
1572 			fp->dsd_bitrev = true;
1573 			return SNDRV_PCM_FMTBIT_DSD_U8;
1574 		case 3:
1575 			fp->dsd_bitrev = true;
1576 			return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1577 		}
1578 	}
1579 
1580 	/* XMOS based USB DACs */
1581 	switch (chip->usb_id) {
1582 	case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
1583 	case USB_ID(0x22d9, 0x0416): /* OPPO HA-1 */
1584 	case USB_ID(0x22d9, 0x0436): /* OPPO Sonica */
1585 	case USB_ID(0x22d9, 0x0461): /* OPPO UDP-205 */
1586 	case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1587 	case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1588 		if (fp->altsetting == 2)
1589 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1590 		break;
1591 
1592 	case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1593 	case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1594 	case USB_ID(0x16b0, 0x06b2): /* NuPrime DAC-10 */
1595 	case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1596 	case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1597 	case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1598 	case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
1599 	case USB_ID(0x22d9, 0x0426): /* OPPO HA-2 */
1600 	case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1601 	case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1602 	case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1603 	case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1604 	case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1605 	case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1606 	case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1607 		if (fp->altsetting == 3)
1608 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1609 		break;
1610 
1611 	/* Amanero Combo384 USB based DACs with native DSD support */
1612 	case USB_ID(0x16d0, 0x071a):  /* Amanero - Combo384 */
1613 	case USB_ID(0x2ab6, 0x0004):  /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1614 	case USB_ID(0x2ab6, 0x0005):  /* T+A USB HD Audio 1 */
1615 	case USB_ID(0x2ab6, 0x0006):  /* T+A USB HD Audio 2 */
1616 		if (fp->altsetting == 2) {
1617 			switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
1618 			case 0x199:
1619 				return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1620 			case 0x19b:
1621 			case 0x203:
1622 				return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1623 			default:
1624 				break;
1625 			}
1626 		}
1627 		break;
1628 	case USB_ID(0x16d0, 0x0a23):
1629 		if (fp->altsetting == 2)
1630 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1631 		break;
1632 
1633 	default:
1634 		break;
1635 	}
1636 
1637 	/* ITF-USB DSD based DACs */
1638 	if (is_itf_usb_dsd_dac(chip->usb_id)) {
1639 		iface = usb_ifnum_to_if(chip->dev, fp->iface);
1640 
1641 		/* Altsetting 2 support native DSD if the num of altsets is
1642 		 * three (0-2),
1643 		 * Altsetting 3 support native DSD if the num of altsets is
1644 		 * four (0-3).
1645 		 */
1646 		if (fp->altsetting == iface->num_altsetting - 1)
1647 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1648 	}
1649 
1650 	/* Mostly generic method to detect many DSD-capable implementations -
1651 	 * from XMOS/Thesycon
1652 	 */
1653 	switch (USB_ID_VENDOR(chip->usb_id)) {
1654 	case 0x20b1:  /* XMOS based devices */
1655 	case 0x152a:  /* Thesycon devices */
1656 	case 0x25ce:  /* Mytek devices */
1657 	case 0x2ab6:  /* T+A devices */
1658 		if (fp->dsd_raw)
1659 			return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1660 		break;
1661 	default:
1662 		break;
1663 
1664 	}
1665 
1666 	return 0;
1667 }
1668 
1669 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1670 					  struct audioformat *fp,
1671 					  int stream)
1672 {
1673 	switch (chip->usb_id) {
1674 	case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1675 		/* Optoplay sets the sample rate attribute although
1676 		 * it seems not supporting it in fact.
1677 		 */
1678 		fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
1679 		break;
1680 	case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1681 	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1682 		/* doesn't set the sample rate attribute, but supports it */
1683 		fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
1684 		break;
1685 	case USB_ID(0x0763, 0x2001):  /* M-Audio Quattro USB */
1686 	case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1687 	case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1688 	case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1689 					an older model 77d:223) */
1690 	/*
1691 	 * plantronics headset and Griffin iMic have set adaptive-in
1692 	 * although it's really not...
1693 	 */
1694 		fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
1695 		if (stream == SNDRV_PCM_STREAM_PLAYBACK)
1696 			fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
1697 		else
1698 			fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
1699 		break;
1700 	}
1701 }
1702