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