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