blob: e4a690bb4c996b7670186e078ec8063e26af799e [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Daniel Macke5779992010-03-04 19:46:13 +01002/*
Daniel Macke5779992010-03-04 19:46:13 +01003 */
4
5#include <linux/init.h>
Stephen Rothwell36db0452010-03-29 16:02:50 +11006#include <linux/slab.h>
Daniel Macke5779992010-03-04 19:46:13 +01007#include <linux/usb.h>
8#include <linux/usb/audio.h>
Clemens Ladischaafe77c2013-03-31 23:43:12 +02009#include <linux/usb/midi.h>
Linus Walleijad43d5282018-11-02 22:11:33 +010010#include <linux/bits.h>
Daniel Macke5779992010-03-04 19:46:13 +010011
Daniel Mack9e386582011-05-25 09:09:01 +020012#include <sound/control.h>
Daniel Macke5779992010-03-04 19:46:13 +010013#include <sound/core.h>
14#include <sound/info.h>
15#include <sound/pcm.h>
16
17#include "usbaudio.h"
18#include "card.h"
Daniel Mackf0b5e632010-03-11 21:13:23 +010019#include "mixer.h"
Daniel Mack7b1eda22010-03-11 21:13:22 +010020#include "mixer_quirks.h"
Daniel Macke5779992010-03-04 19:46:13 +010021#include "midi.h"
22#include "quirks.h"
23#include "helper.h"
24#include "endpoint.h"
25#include "pcm.h"
Daniel Mack3d8d4dc2010-06-16 17:57:31 +020026#include "clock.h"
Daniel Macke8e8bab2011-09-12 18:54:12 +020027#include "stream.h"
Daniel Macke5779992010-03-04 19:46:13 +010028
29/*
30 * handle the quirks for the contained interfaces
31 */
32static int create_composite_quirk(struct snd_usb_audio *chip,
33 struct usb_interface *iface,
34 struct usb_driver *driver,
Takashi Iwai85a81812014-11-10 07:41:59 +010035 const struct snd_usb_audio_quirk *quirk_comp)
Daniel Macke5779992010-03-04 19:46:13 +010036{
37 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
Takashi Iwai85a81812014-11-10 07:41:59 +010038 const struct snd_usb_audio_quirk *quirk;
Daniel Macke5779992010-03-04 19:46:13 +010039 int err;
40
Takashi Iwai85a81812014-11-10 07:41:59 +010041 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
Daniel Macke5779992010-03-04 19:46:13 +010042 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
43 if (!iface)
44 continue;
45 if (quirk->ifnum != probed_ifnum &&
46 usb_interface_claimed(iface))
47 continue;
48 err = snd_usb_create_quirk(chip, iface, driver, quirk);
49 if (err < 0)
50 return err;
Takashi Iwaid4b8fc62014-11-09 18:21:23 +010051 }
52
Takashi Iwai85a81812014-11-10 07:41:59 +010053 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
Takashi Iwaid4b8fc62014-11-09 18:21:23 +010054 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
55 if (!iface)
56 continue;
57 if (quirk->ifnum != probed_ifnum &&
58 !usb_interface_claimed(iface))
Daniel Macke5779992010-03-04 19:46:13 +010059 usb_driver_claim_interface(driver, iface, (void *)-1L);
60 }
Takashi Iwaid4b8fc62014-11-09 18:21:23 +010061
Daniel Macke5779992010-03-04 19:46:13 +010062 return 0;
63}
64
65static int ignore_interface_quirk(struct snd_usb_audio *chip,
66 struct usb_interface *iface,
67 struct usb_driver *driver,
68 const struct snd_usb_audio_quirk *quirk)
69{
70 return 0;
71}
72
73
74/*
75 * Allow alignment on audio sub-slot (channel samples) rather than
76 * on audio slots (audio frames)
77 */
78static int create_align_transfer_quirk(struct snd_usb_audio *chip,
79 struct usb_interface *iface,
80 struct usb_driver *driver,
81 const struct snd_usb_audio_quirk *quirk)
82{
83 chip->txfr_quirk = 1;
84 return 1; /* Continue with creating streams and mixer */
85}
86
87static int create_any_midi_quirk(struct snd_usb_audio *chip,
88 struct usb_interface *intf,
89 struct usb_driver *driver,
90 const struct snd_usb_audio_quirk *quirk)
91{
92 return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
93}
94
95/*
96 * create a stream for an interface with proper descriptors
97 */
98static int create_standard_audio_quirk(struct snd_usb_audio *chip,
99 struct usb_interface *iface,
100 struct usb_driver *driver,
101 const struct snd_usb_audio_quirk *quirk)
102{
103 struct usb_host_interface *alts;
104 struct usb_interface_descriptor *altsd;
105 int err;
106
Ricard Wanderlofe0570442015-10-19 08:52:53 +0200107 if (chip->usb_id == USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
108 chip->tx_length_quirk = 1;
109
Daniel Macke5779992010-03-04 19:46:13 +0100110 alts = &iface->altsetting[0];
111 altsd = get_iface_desc(alts);
Daniel Macke8e8bab2011-09-12 18:54:12 +0200112 err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
Daniel Macke5779992010-03-04 19:46:13 +0100113 if (err < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100114 usb_audio_err(chip, "cannot setup if %d: error %d\n",
Daniel Macke5779992010-03-04 19:46:13 +0100115 altsd->bInterfaceNumber, err);
116 return err;
117 }
118 /* reset the current interface */
119 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
120 return 0;
121}
122
123/*
124 * create a stream for an endpoint/altsetting without proper descriptors
125 */
126static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
127 struct usb_interface *iface,
128 struct usb_driver *driver,
129 const struct snd_usb_audio_quirk *quirk)
130{
131 struct audioformat *fp;
132 struct usb_host_interface *alts;
Eldad Zack42d4ab82013-07-09 20:36:15 +0200133 struct usb_interface_descriptor *altsd;
Daniel Macke5779992010-03-04 19:46:13 +0100134 int stream, err;
135 unsigned *rate_table = NULL;
136
137 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
Markus Elfring9ecb2402017-08-11 18:38:25 +0200138 if (!fp)
Daniel Macke5779992010-03-04 19:46:13 +0100139 return -ENOMEM;
Markus Elfring9ecb2402017-08-11 18:38:25 +0200140
Vladis Dronov836b34a2016-03-31 12:05:43 -0400141 INIT_LIST_HEAD(&fp->list);
Xi Wang8866f402012-02-14 05:18:48 -0500142 if (fp->nr_rates > MAX_NR_RATES) {
143 kfree(fp);
144 return -EINVAL;
145 }
Daniel Macke5779992010-03-04 19:46:13 +0100146 if (fp->nr_rates > 0) {
Thomas Meyer43df2a52011-11-10 19:38:43 +0100147 rate_table = kmemdup(fp->rate_table,
148 sizeof(int) * fp->nr_rates, GFP_KERNEL);
Daniel Macke5779992010-03-04 19:46:13 +0100149 if (!rate_table) {
150 kfree(fp);
151 return -ENOMEM;
152 }
Daniel Macke5779992010-03-04 19:46:13 +0100153 fp->rate_table = rate_table;
154 }
155
156 stream = (fp->endpoint & USB_DIR_IN)
157 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
Daniel Macke8e8bab2011-09-12 18:54:12 +0200158 err = snd_usb_add_audio_stream(chip, stream, fp);
Takashi Iwai902eb7f2016-03-15 12:14:49 +0100159 if (err < 0)
160 goto error;
Daniel Macke5779992010-03-04 19:46:13 +0100161 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
162 fp->altset_idx >= iface->num_altsetting) {
Takashi Iwai902eb7f2016-03-15 12:14:49 +0100163 err = -EINVAL;
164 goto error;
Daniel Macke5779992010-03-04 19:46:13 +0100165 }
166 alts = &iface->altsetting[fp->altset_idx];
Eldad Zack42d4ab82013-07-09 20:36:15 +0200167 altsd = get_iface_desc(alts);
Takashi Iwai0f886ca2016-03-15 12:09:10 +0100168 if (altsd->bNumEndpoints < 1) {
Takashi Iwai902eb7f2016-03-15 12:14:49 +0100169 err = -EINVAL;
170 goto error;
Takashi Iwai0f886ca2016-03-15 12:09:10 +0100171 }
172
Eldad Zack42d4ab82013-07-09 20:36:15 +0200173 fp->protocol = altsd->bInterfaceProtocol;
174
Mark Hills59ea5862013-03-17 11:07:54 +0000175 if (fp->datainterval == 0)
176 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
177 if (fp->maxpacksize == 0)
178 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
Daniel Macke5779992010-03-04 19:46:13 +0100179 usb_set_interface(chip->dev, fp->iface, 0);
Takashi Iwai73037c82020-11-23 09:53:26 +0100180 snd_usb_init_pitch(chip, fp);
Takashi Iwai953a4462020-11-23 09:53:25 +0100181 snd_usb_init_sample_rate(chip, fp, fp->rate_max);
Daniel Macke5779992010-03-04 19:46:13 +0100182 return 0;
Takashi Iwai902eb7f2016-03-15 12:14:49 +0100183
184 error:
Vladis Dronov836b34a2016-03-31 12:05:43 -0400185 list_del(&fp->list); /* unlink for avoiding double-free */
Takashi Iwai902eb7f2016-03-15 12:14:49 +0100186 kfree(fp);
187 kfree(rate_table);
188 return err;
Daniel Macke5779992010-03-04 19:46:13 +0100189}
190
Clemens Ladischaafe77c2013-03-31 23:43:12 +0200191static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
192 struct usb_interface *iface,
193 struct usb_driver *driver)
194{
195 struct usb_host_interface *alts;
196 struct usb_interface_descriptor *altsd;
197 struct usb_endpoint_descriptor *epd;
198 struct uac1_as_header_descriptor *ashd;
199 struct uac_format_type_i_discrete_descriptor *fmtd;
200
201 /*
202 * Most Roland/Yamaha audio streaming interfaces have more or less
203 * standard descriptors, but older devices might lack descriptors, and
204 * future ones might change, so ensure that we fail silently if the
205 * interface doesn't look exactly right.
206 */
207
208 /* must have a non-zero altsetting for streaming */
209 if (iface->num_altsetting < 2)
210 return -ENODEV;
211 alts = &iface->altsetting[1];
212 altsd = get_iface_desc(alts);
213
214 /* must have an isochronous endpoint for streaming */
215 if (altsd->bNumEndpoints < 1)
216 return -ENODEV;
217 epd = get_endpoint(alts, 0);
218 if (!usb_endpoint_xfer_isoc(epd))
219 return -ENODEV;
220
221 /* must have format descriptors */
222 ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
223 UAC_AS_GENERAL);
224 fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
225 UAC_FORMAT_TYPE);
226 if (!ashd || ashd->bLength < 7 ||
227 !fmtd || fmtd->bLength < 8)
228 return -ENODEV;
229
230 return create_standard_audio_quirk(chip, iface, driver, NULL);
231}
232
233static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
234 struct usb_interface *iface,
235 struct usb_driver *driver,
236 struct usb_host_interface *alts)
237{
238 static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
239 .type = QUIRK_MIDI_YAMAHA
240 };
241 struct usb_midi_in_jack_descriptor *injd;
242 struct usb_midi_out_jack_descriptor *outjd;
243
244 /* must have some valid jack descriptors */
245 injd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
246 NULL, USB_MS_MIDI_IN_JACK);
247 outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
248 NULL, USB_MS_MIDI_OUT_JACK);
249 if (!injd && !outjd)
250 return -ENODEV;
Takashi Iwaicc9dbfa2019-11-13 12:12:59 +0100251 if ((injd && !snd_usb_validate_midi_desc(injd)) ||
252 (outjd && !snd_usb_validate_midi_desc(outjd)))
Takashi Iwai57f87702019-08-20 17:17:09 +0200253 return -ENODEV;
Clemens Ladischaafe77c2013-03-31 23:43:12 +0200254 if (injd && (injd->bLength < 5 ||
255 (injd->bJackType != USB_MS_EMBEDDED &&
256 injd->bJackType != USB_MS_EXTERNAL)))
257 return -ENODEV;
258 if (outjd && (outjd->bLength < 6 ||
259 (outjd->bJackType != USB_MS_EMBEDDED &&
260 outjd->bJackType != USB_MS_EXTERNAL)))
261 return -ENODEV;
262 return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
263}
264
265static int create_roland_midi_quirk(struct snd_usb_audio *chip,
266 struct usb_interface *iface,
267 struct usb_driver *driver,
268 struct usb_host_interface *alts)
269{
270 static const struct snd_usb_audio_quirk roland_midi_quirk = {
271 .type = QUIRK_MIDI_ROLAND
272 };
273 u8 *roland_desc = NULL;
274
275 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
276 for (;;) {
277 roland_desc = snd_usb_find_csint_desc(alts->extra,
278 alts->extralen,
279 roland_desc, 0xf1);
280 if (!roland_desc)
281 return -ENODEV;
282 if (roland_desc[0] < 6 || roland_desc[3] != 2)
283 continue;
284 return create_any_midi_quirk(chip, iface, driver,
285 &roland_midi_quirk);
286 }
287}
288
289static int create_std_midi_quirk(struct snd_usb_audio *chip,
290 struct usb_interface *iface,
291 struct usb_driver *driver,
292 struct usb_host_interface *alts)
293{
294 struct usb_ms_header_descriptor *mshd;
295 struct usb_ms_endpoint_descriptor *msepd;
296
297 /* must have the MIDIStreaming interface header descriptor*/
298 mshd = (struct usb_ms_header_descriptor *)alts->extra;
299 if (alts->extralen < 7 ||
300 mshd->bLength < 7 ||
301 mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
302 mshd->bDescriptorSubtype != USB_MS_HEADER)
303 return -ENODEV;
304 /* must have the MIDIStreaming endpoint descriptor*/
305 msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra;
306 if (alts->endpoint[0].extralen < 4 ||
307 msepd->bLength < 4 ||
308 msepd->bDescriptorType != USB_DT_CS_ENDPOINT ||
309 msepd->bDescriptorSubtype != UAC_MS_GENERAL ||
310 msepd->bNumEmbMIDIJack < 1 ||
311 msepd->bNumEmbMIDIJack > 16)
312 return -ENODEV;
313
314 return create_any_midi_quirk(chip, iface, driver, NULL);
315}
316
317static int create_auto_midi_quirk(struct snd_usb_audio *chip,
318 struct usb_interface *iface,
319 struct usb_driver *driver)
320{
321 struct usb_host_interface *alts;
322 struct usb_interface_descriptor *altsd;
323 struct usb_endpoint_descriptor *epd;
324 int err;
325
326 alts = &iface->altsetting[0];
327 altsd = get_iface_desc(alts);
328
329 /* must have at least one bulk/interrupt endpoint for streaming */
330 if (altsd->bNumEndpoints < 1)
331 return -ENODEV;
332 epd = get_endpoint(alts, 0);
Clemens Ladischaa773bf2013-08-11 14:13:13 +0200333 if (!usb_endpoint_xfer_bulk(epd) &&
Clemens Ladischaafe77c2013-03-31 23:43:12 +0200334 !usb_endpoint_xfer_int(epd))
335 return -ENODEV;
336
337 switch (USB_ID_VENDOR(chip->usb_id)) {
338 case 0x0499: /* Yamaha */
339 err = create_yamaha_midi_quirk(chip, iface, driver, alts);
Clemens Ladischaa773bf2013-08-11 14:13:13 +0200340 if (err != -ENODEV)
Clemens Ladischaafe77c2013-03-31 23:43:12 +0200341 return err;
342 break;
343 case 0x0582: /* Roland */
344 err = create_roland_midi_quirk(chip, iface, driver, alts);
Clemens Ladischaa773bf2013-08-11 14:13:13 +0200345 if (err != -ENODEV)
Clemens Ladischaafe77c2013-03-31 23:43:12 +0200346 return err;
347 break;
348 }
349
350 return create_std_midi_quirk(chip, iface, driver, alts);
351}
352
353static int create_autodetect_quirk(struct snd_usb_audio *chip,
354 struct usb_interface *iface,
Clemens Ladischb1ce7ba2013-04-04 21:43:57 +0200355 struct usb_driver *driver)
Clemens Ladischaafe77c2013-03-31 23:43:12 +0200356{
357 int err;
358
359 err = create_auto_pcm_quirk(chip, iface, driver);
360 if (err == -ENODEV)
361 err = create_auto_midi_quirk(chip, iface, driver);
362 return err;
363}
364
Clemens Ladischb1ce7ba2013-04-04 21:43:57 +0200365static int create_autodetect_quirks(struct snd_usb_audio *chip,
366 struct usb_interface *iface,
367 struct usb_driver *driver,
368 const struct snd_usb_audio_quirk *quirk)
369{
370 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
371 int ifcount, ifnum, err;
372
373 err = create_autodetect_quirk(chip, iface, driver);
374 if (err < 0)
375 return err;
376
377 /*
378 * ALSA PCM playback/capture devices cannot be registered in two steps,
379 * so we have to claim the other corresponding interface here.
380 */
381 ifcount = chip->dev->actconfig->desc.bNumInterfaces;
382 for (ifnum = 0; ifnum < ifcount; ifnum++) {
383 if (ifnum == probed_ifnum || quirk->ifnum >= 0)
384 continue;
385 iface = usb_ifnum_to_if(chip->dev, ifnum);
386 if (!iface ||
387 usb_interface_claimed(iface) ||
388 get_iface_desc(iface->altsetting)->bInterfaceClass !=
389 USB_CLASS_VENDOR_SPEC)
390 continue;
391
392 err = create_autodetect_quirk(chip, iface, driver);
393 if (err >= 0)
394 usb_driver_claim_interface(driver, iface, (void *)-1L);
395 }
396
397 return 0;
398}
399
Daniel Macke5779992010-03-04 19:46:13 +0100400/*
401 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
402 * The only way to detect the sample rate is by looking at wMaxPacketSize.
403 */
404static int create_uaxx_quirk(struct snd_usb_audio *chip,
405 struct usb_interface *iface,
406 struct usb_driver *driver,
407 const struct snd_usb_audio_quirk *quirk)
408{
409 static const struct audioformat ua_format = {
Clemens Ladisch015eb0b2010-03-04 19:46:15 +0100410 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
Daniel Macke5779992010-03-04 19:46:13 +0100411 .channels = 2,
412 .fmt_type = UAC_FORMAT_TYPE_I,
413 .altsetting = 1,
414 .altset_idx = 1,
415 .rates = SNDRV_PCM_RATE_CONTINUOUS,
416 };
417 struct usb_host_interface *alts;
418 struct usb_interface_descriptor *altsd;
419 struct audioformat *fp;
420 int stream, err;
421
422 /* both PCM and MIDI interfaces have 2 or more altsettings */
423 if (iface->num_altsetting < 2)
424 return -ENXIO;
425 alts = &iface->altsetting[1];
426 altsd = get_iface_desc(alts);
427
428 if (altsd->bNumEndpoints == 2) {
429 static const struct snd_usb_midi_endpoint_info ua700_ep = {
430 .out_cables = 0x0003,
431 .in_cables = 0x0003
432 };
433 static const struct snd_usb_audio_quirk ua700_quirk = {
434 .type = QUIRK_MIDI_FIXED_ENDPOINT,
435 .data = &ua700_ep
436 };
437 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
438 .out_cables = 0x0001,
439 .in_cables = 0x0001
440 };
441 static const struct snd_usb_audio_quirk uaxx_quirk = {
442 .type = QUIRK_MIDI_FIXED_ENDPOINT,
443 .data = &uaxx_ep
444 };
445 const struct snd_usb_audio_quirk *quirk =
446 chip->usb_id == USB_ID(0x0582, 0x002b)
447 ? &ua700_quirk : &uaxx_quirk;
Takashi Iwai79289e22016-01-11 11:33:34 +0100448 return __snd_usbmidi_create(chip->card, iface,
449 &chip->midi_list, quirk,
450 chip->usb_id);
Daniel Macke5779992010-03-04 19:46:13 +0100451 }
452
453 if (altsd->bNumEndpoints != 1)
454 return -ENXIO;
455
Thomas Meyer43df2a52011-11-10 19:38:43 +0100456 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
Daniel Macke5779992010-03-04 19:46:13 +0100457 if (!fp)
458 return -ENOMEM;
Daniel Macke5779992010-03-04 19:46:13 +0100459
460 fp->iface = altsd->bInterfaceNumber;
461 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
462 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
463 fp->datainterval = 0;
464 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
Vladis Dronov836b34a2016-03-31 12:05:43 -0400465 INIT_LIST_HEAD(&fp->list);
Daniel Macke5779992010-03-04 19:46:13 +0100466
467 switch (fp->maxpacksize) {
468 case 0x120:
469 fp->rate_max = fp->rate_min = 44100;
470 break;
471 case 0x138:
472 case 0x140:
473 fp->rate_max = fp->rate_min = 48000;
474 break;
475 case 0x258:
476 case 0x260:
477 fp->rate_max = fp->rate_min = 96000;
478 break;
479 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100480 usb_audio_err(chip, "unknown sample rate\n");
Daniel Macke5779992010-03-04 19:46:13 +0100481 kfree(fp);
482 return -ENXIO;
483 }
484
485 stream = (fp->endpoint & USB_DIR_IN)
486 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
Daniel Macke8e8bab2011-09-12 18:54:12 +0200487 err = snd_usb_add_audio_stream(chip, stream, fp);
Daniel Macke5779992010-03-04 19:46:13 +0100488 if (err < 0) {
Vladis Dronov836b34a2016-03-31 12:05:43 -0400489 list_del(&fp->list); /* unlink for avoiding double-free */
Daniel Macke5779992010-03-04 19:46:13 +0100490 kfree(fp);
491 return err;
492 }
493 usb_set_interface(chip->dev, fp->iface, 0);
494 return 0;
495}
496
497/*
Daniel Mack014950b2011-05-25 09:09:02 +0200498 * Create a standard mixer for the specified interface.
499 */
500static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
501 struct usb_interface *iface,
502 struct usb_driver *driver,
503 const struct snd_usb_audio_quirk *quirk)
504{
505 if (quirk->ifnum < 0)
506 return 0;
507
508 return snd_usb_create_mixer(chip, quirk->ifnum, 0);
509}
510
Kai-Heng Feng1965c432020-08-23 18:58:50 +0800511static int setup_disable_autosuspend(struct snd_usb_audio *chip,
512 struct usb_interface *iface,
513 struct usb_driver *driver,
514 const struct snd_usb_audio_quirk *quirk)
515{
516 driver->supports_autosuspend = 0;
517 return 1; /* Continue with creating streams and mixer */
518}
519
Daniel Mack014950b2011-05-25 09:09:02 +0200520/*
Daniel Macke5779992010-03-04 19:46:13 +0100521 * audio-interface quirks
522 *
523 * returns zero if no standard audio/MIDI parsing is needed.
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300524 * returns a positive value if standard audio/midi interfaces are parsed
Daniel Macke5779992010-03-04 19:46:13 +0100525 * after this.
526 * returns a negative value at error.
527 */
528int snd_usb_create_quirk(struct snd_usb_audio *chip,
529 struct usb_interface *iface,
530 struct usb_driver *driver,
531 const struct snd_usb_audio_quirk *quirk)
532{
533 typedef int (*quirk_func_t)(struct snd_usb_audio *,
534 struct usb_interface *,
535 struct usb_driver *,
536 const struct snd_usb_audio_quirk *);
537 static const quirk_func_t quirk_funcs[] = {
538 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
539 [QUIRK_COMPOSITE] = create_composite_quirk,
Clemens Ladischb1ce7ba2013-04-04 21:43:57 +0200540 [QUIRK_AUTODETECT] = create_autodetect_quirks,
Daniel Macke5779992010-03-04 19:46:13 +0100541 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
542 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
543 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
Clemens Ladischaafe77c2013-03-31 23:43:12 +0200544 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
Daniel Macke5779992010-03-04 19:46:13 +0100545 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
546 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
Clemens Ladischc7f57212010-10-22 18:20:48 +0200547 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
Daniel Macke5779992010-03-04 19:46:13 +0100548 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
549 [QUIRK_MIDI_CME] = create_any_midi_quirk,
Krzysztof Foltman4434ade2010-05-20 20:31:10 +0100550 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
Kristian Amlie1ef0e0a2011-08-26 13:19:49 +0200551 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
Clemens Ladisch1ca8b202015-11-15 22:38:29 +0100552 [QUIRK_MIDI_CH345] = create_any_midi_quirk,
Daniel Macke5779992010-03-04 19:46:13 +0100553 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
554 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
555 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
Daniel Mack014950b2011-05-25 09:09:02 +0200556 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
557 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
Kai-Heng Feng1965c432020-08-23 18:58:50 +0800558 [QUIRK_SETUP_DISABLE_AUTOSUSPEND] = setup_disable_autosuspend,
Daniel Macke5779992010-03-04 19:46:13 +0100559 };
560
561 if (quirk->type < QUIRK_TYPE_COUNT) {
562 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
563 } else {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100564 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
Daniel Macke5779992010-03-04 19:46:13 +0100565 return -ENXIO;
566 }
567}
568
569/*
570 * boot quirks
571 */
572
573#define EXTIGY_FIRMWARE_SIZE_OLD 794
574#define EXTIGY_FIRMWARE_SIZE_NEW 483
575
576static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
577{
578 struct usb_host_config *config = dev->actconfig;
579 int err;
580
581 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
582 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100583 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
Daniel Macke5779992010-03-04 19:46:13 +0100584 /* Send message to force it to reconnect with full interface. */
585 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200586 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100587 if (err < 0)
588 dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
Daniel Macke5779992010-03-04 19:46:13 +0100589 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
590 &dev->descriptor, sizeof(dev->descriptor));
591 config = dev->actconfig;
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100592 if (err < 0)
593 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
Daniel Macke5779992010-03-04 19:46:13 +0100594 err = usb_reset_configuration(dev);
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100595 if (err < 0)
596 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
597 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
Daniel Macke5779992010-03-04 19:46:13 +0100598 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
599 return -ENODEV; /* quit this anyway */
600 }
601 return 0;
602}
603
604static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
605{
606 u8 buf = 1;
607
608 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
609 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200610 0, 0, &buf, 1);
Daniel Macke5779992010-03-04 19:46:13 +0100611 if (buf == 0) {
612 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
613 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200614 1, 2000, NULL, 0);
Daniel Macke5779992010-03-04 19:46:13 +0100615 return -ENODEV;
616 }
617 return 0;
618}
619
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200620static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
621{
622 int err;
623
624 if (dev->actconfig->desc.bConfigurationValue == 1) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100625 dev_info(&dev->dev,
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200626 "Fast Track Pro switching to config #2\n");
627 /* This function has to be available by the usb core module.
628 * if it is not avialable the boot quirk has to be left out
629 * and the configuration has to be set by udev or hotplug
630 * rules
631 */
632 err = usb_driver_set_configuration(dev, 2);
David Henningssonb98ae272013-01-04 17:02:18 +0100633 if (err < 0)
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100634 dev_dbg(&dev->dev,
635 "error usb_driver_set_configuration: %d\n",
636 err);
David Henningssonb98ae272013-01-04 17:02:18 +0100637 /* Always return an error, so that we stop creating a device
638 that will just be destroyed and recreated with a new
639 configuration */
640 return -ENODEV;
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200641 } else
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100642 dev_info(&dev->dev, "Fast Track Pro config OK\n");
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +0200643
644 return 0;
645}
646
Daniel Macke5779992010-03-04 19:46:13 +0100647/*
648 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
649 * documented in the device's data sheet.
650 */
651static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
652{
653 u8 buf[4];
654 buf[0] = 0x20;
655 buf[1] = value & 0xff;
656 buf[2] = (value >> 8) & 0xff;
657 buf[3] = reg;
658 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
659 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200660 0, 0, &buf, 4);
Daniel Macke5779992010-03-04 19:46:13 +0100661}
662
663static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
664{
665 /*
666 * Enable line-out driver mode, set headphone source to front
667 * channels, enable stereo mic.
668 */
669 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
670}
671
672/*
Linus Walleijad43d5282018-11-02 22:11:33 +0100673 * CM6206 registers from the CM6206 datasheet rev 2.1
Daniel Macke5779992010-03-04 19:46:13 +0100674 */
Linus Walleijad43d5282018-11-02 22:11:33 +0100675#define CM6206_REG0_DMA_MASTER BIT(15)
676#define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
677#define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
678/* Bit 4 thru 11 is the S/PDIF category code */
679#define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
680#define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
681#define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
682#define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
683#define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
684
685#define CM6206_REG1_TEST_SEL_CLK BIT(14)
686#define CM6206_REG1_PLLBIN_EN BIT(13)
687#define CM6206_REG1_SOFT_MUTE_EN BIT(12)
688#define CM6206_REG1_GPIO4_OUT BIT(11)
689#define CM6206_REG1_GPIO4_OE BIT(10)
690#define CM6206_REG1_GPIO3_OUT BIT(9)
691#define CM6206_REG1_GPIO3_OE BIT(8)
692#define CM6206_REG1_GPIO2_OUT BIT(7)
693#define CM6206_REG1_GPIO2_OE BIT(6)
694#define CM6206_REG1_GPIO1_OUT BIT(5)
695#define CM6206_REG1_GPIO1_OE BIT(4)
696#define CM6206_REG1_SPDIFO_INVALID BIT(3)
697#define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
698#define CM6206_REG1_SPDIFO_DIS BIT(1)
699#define CM6206_REG1_SPDIFI_MIX BIT(0)
700
701#define CM6206_REG2_DRIVER_ON BIT(15)
702#define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
703#define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
704#define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
705#define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
706#define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
707#define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
708#define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
709#define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
710#define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
711#define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
712#define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
713#define CM6206_REG2_MUTE_CENTER BIT(5)
714#define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
715#define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
716#define CM6206_REG2_EN_BTL BIT(2)
717#define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
718#define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
719#define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
720#define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
721
722/* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
723#define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
724#define CM6206_REG3_VRAP25EN BIT(10)
725#define CM6206_REG3_MSEL1 BIT(9)
726#define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
727#define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
728#define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
729#define CM6206_REG3_PINSEL BIT(6)
730#define CM6206_REG3_FOE BIT(5)
731#define CM6206_REG3_ROE BIT(4)
732#define CM6206_REG3_CBOE BIT(3)
733#define CM6206_REG3_LOSE BIT(2)
734#define CM6206_REG3_HPOE BIT(1)
735#define CM6206_REG3_SPDIFI_CANREC BIT(0)
736
737#define CM6206_REG5_DA_RSTN BIT(13)
738#define CM6206_REG5_AD_RSTN BIT(12)
739#define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
740#define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
741#define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
742#define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
743#define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
744#define CM6206_REG5_CODECM BIT(8)
745#define CM6206_REG5_EN_HPF BIT(7)
746#define CM6206_REG5_T_SEL_DSDA4 BIT(6)
747#define CM6206_REG5_T_SEL_DSDA3 BIT(5)
748#define CM6206_REG5_T_SEL_DSDA2 BIT(4)
749#define CM6206_REG5_T_SEL_DSDA1 BIT(3)
750#define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
751#define CM6206_REG5_T_SEL_DSDAD_FRONT 4
752#define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
753#define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
754#define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
755
Daniel Macke5779992010-03-04 19:46:13 +0100756static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
757{
Daniel Mackdac8f842011-08-06 00:23:18 +0200758 int err = 0, reg;
Linus Walleijad43d5282018-11-02 22:11:33 +0100759 int val[] = {
760 /*
761 * Values here are chosen based on sniffing USB traffic
762 * under Windows.
763 *
764 * REG0: DAC is master, sample rate 48kHz, no copyright
765 */
766 CM6206_REG0_SPDIFO_RATE_48K |
767 CM6206_REG0_SPDIFO_COPYRIGHT_NA,
768 /*
769 * REG1: PLL binary search enable, soft mute enable.
770 */
771 CM6206_REG1_PLLBIN_EN |
Amadeusz Sławińskif5c95712019-01-08 21:03:11 +0100772 CM6206_REG1_SOFT_MUTE_EN,
Linus Walleijad43d5282018-11-02 22:11:33 +0100773 /*
774 * REG2: enable output drivers,
775 * select front channels to the headphone output,
776 * then mute the headphone channels, run the MCU
777 * at 1.5 MHz.
778 */
779 CM6206_REG2_DRIVER_ON |
780 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
781 CM6206_REG2_MUTE_HEADPHONE_RIGHT |
782 CM6206_REG2_MUTE_HEADPHONE_LEFT,
783 /*
784 * REG3: default flyspeed, set 2.5V mic bias
785 * enable all line out ports and enable SPDIF
786 */
787 CM6206_REG3_FLYSPEED_DEFAULT |
788 CM6206_REG3_VRAP25EN |
789 CM6206_REG3_FOE |
790 CM6206_REG3_ROE |
791 CM6206_REG3_CBOE |
792 CM6206_REG3_LOSE |
793 CM6206_REG3_HPOE |
794 CM6206_REG3_SPDIFI_CANREC,
795 /* REG4 is just a bunch of GPIO lines */
796 0x0000,
797 /* REG5: de-assert AD/DA reset signals */
798 CM6206_REG5_DA_RSTN |
799 CM6206_REG5_AD_RSTN };
Daniel Macke5779992010-03-04 19:46:13 +0100800
801 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
802 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
803 if (err < 0)
804 return err;
805 }
806
807 return err;
808}
809
Takashi Iwai19570d72013-12-19 14:32:53 +0100810/* quirk for Plantronics GameCom 780 with CM6302 chip */
811static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
812{
813 /* set the initial volume and don't change; other values are either
814 * too loud or silent due to firmware bug (bko#65251)
815 */
Paul S McSpadden542baf92014-08-03 17:47:36 -0500816 u8 buf[2] = { 0x74, 0xe3 };
Takashi Iwai19570d72013-12-19 14:32:53 +0100817 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
818 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
819 UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
820}
821
Daniel Macke5779992010-03-04 19:46:13 +0100822/*
Mark Hills5e212332013-03-17 11:07:53 +0000823 * Novation Twitch DJ controller
Eduard Gilmutdinov11e424e2013-12-20 14:06:58 +0600824 * Focusrite Novation Saffire 6 USB audio card
Mark Hills5e212332013-03-17 11:07:53 +0000825 */
Eduard Gilmutdinov11e424e2013-12-20 14:06:58 +0600826static int snd_usb_novation_boot_quirk(struct usb_device *dev)
Mark Hills5e212332013-03-17 11:07:53 +0000827{
828 /* preemptively set up the device because otherwise the
829 * raw MIDI endpoints are not active */
830 usb_set_interface(dev, 0, 1);
831 return 0;
832}
833
834/*
Daniel Macke5779992010-03-04 19:46:13 +0100835 * This call will put the synth in "USB send" mode, i.e it will send MIDI
836 * messages through USB (this is disabled at startup). The synth will
837 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
838 * sign on its LCD. Values here are chosen based on sniffing USB traffic
839 * under Windows.
840 */
841static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
842{
843 int err, actual_length;
Daniel Macke5779992010-03-04 19:46:13 +0100844 /* "midi send" enable */
845 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
Takashi Iwai801ebf12019-06-24 15:08:28 +0200846 void *buf;
Daniel Macke5779992010-03-04 19:46:13 +0100847
Greg Kroah-Hartmanfcc2cc12020-09-14 17:37:46 +0200848 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
Takashi Iwai801ebf12019-06-24 15:08:28 +0200849 return -EINVAL;
850 buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
Daniel Macke5779992010-03-04 19:46:13 +0100851 if (!buf)
852 return -ENOMEM;
853 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
854 ARRAY_SIZE(seq), &actual_length, 1000);
855 kfree(buf);
856 if (err < 0)
857 return err;
858
859 return 0;
860}
861
862/*
Daniel Mack54a8c502011-02-11 11:08:06 +0000863 * Some sound cards from Native Instruments are in fact compliant to the USB
864 * audio standard of version 2 and other approved USB standards, even though
865 * they come up as vendor-specific device when first connected.
866 *
867 * However, they can be told to come up with a new set of descriptors
868 * upon their next enumeration, and the interfaces announced by the new
869 * descriptors will then be handled by the kernel's class drivers. As the
870 * product ID will also change, no further checks are required.
871 */
872
873static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
874{
Takashi Iwai801ebf12019-06-24 15:08:28 +0200875 int ret;
876
Takashi Iwai801ebf12019-06-24 15:08:28 +0200877 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Daniel Mack54a8c502011-02-11 11:08:06 +0000878 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
Eldad Zack889d6682013-04-05 20:49:46 +0200879 1, 0, NULL, 0, 1000);
Daniel Mack54a8c502011-02-11 11:08:06 +0000880
881 if (ret < 0)
882 return ret;
883
884 usb_reset_device(dev);
885
886 /* return -EAGAIN, so the creation of an audio interface for this
887 * temporary device is aborted. The device will reconnect with a
888 * new product ID */
889 return -EAGAIN;
890}
891
Damien Zammitcb998642012-12-19 11:27:22 +0100892static void mbox2_setup_48_24_magic(struct usb_device *dev)
893{
894 u8 srate[3];
895 u8 temp[12];
896
897 /* Choose 48000Hz permanently */
898 srate[0] = 0x80;
899 srate[1] = 0xbb;
900 srate[2] = 0x00;
901
902 /* Send the magic! */
903 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
904 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
905 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
906 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
907 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
908 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
909 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
910 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
911 return;
912}
913
914/* Digidesign Mbox 2 needs to load firmware onboard
915 * and driver must wait a few seconds for initialisation.
916 */
917
918#define MBOX2_FIRMWARE_SIZE 646
919#define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
920#define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
921
Damien Zammitb7b435e2013-01-04 09:51:44 +0100922static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
Damien Zammitcb998642012-12-19 11:27:22 +0100923{
924 struct usb_host_config *config = dev->actconfig;
925 int err;
Jiri Slaby4909a0c2013-02-17 14:33:04 +0100926 u8 bootresponse[0x12];
Damien Zammitcb998642012-12-19 11:27:22 +0100927 int fwsize;
928 int count;
929
930 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
931
932 if (fwsize != MBOX2_FIRMWARE_SIZE) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100933 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
Damien Zammitcb998642012-12-19 11:27:22 +0100934 return -ENODEV;
935 }
936
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100937 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
Damien Zammitcb998642012-12-19 11:27:22 +0100938
939 count = 0;
Damien Zammitb7b435e2013-01-04 09:51:44 +0100940 bootresponse[0] = MBOX2_BOOT_LOADING;
941 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
Damien Zammitcb998642012-12-19 11:27:22 +0100942 msleep(500); /* 0.5 second delay */
943 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
944 /* Control magic - load onboard firmware */
945 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
Damien Zammitb7b435e2013-01-04 09:51:44 +0100946 if (bootresponse[0] == MBOX2_BOOT_READY)
Damien Zammitcb998642012-12-19 11:27:22 +0100947 break;
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100948 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
Damien Zammitcb998642012-12-19 11:27:22 +0100949 count++;
950 }
951
Damien Zammitb7b435e2013-01-04 09:51:44 +0100952 if (bootresponse[0] != MBOX2_BOOT_READY) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100953 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
Damien Zammitcb998642012-12-19 11:27:22 +0100954 return -ENODEV;
955 }
956
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100957 dev_dbg(&dev->dev, "device initialised!\n");
Damien Zammitcb998642012-12-19 11:27:22 +0100958
959 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
960 &dev->descriptor, sizeof(dev->descriptor));
961 config = dev->actconfig;
962 if (err < 0)
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100963 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
Damien Zammitcb998642012-12-19 11:27:22 +0100964
965 err = usb_reset_configuration(dev);
966 if (err < 0)
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100967 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
968 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
Damien Zammitcb998642012-12-19 11:27:22 +0100969 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
970
971 mbox2_setup_48_24_magic(dev);
972
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100973 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
Damien Zammitcb998642012-12-19 11:27:22 +0100974
975 return 0; /* Successful boot */
976}
977
Alberto Aguirre16bafa72018-05-08 17:14:13 -0500978static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
979{
980 int err;
981
982 dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
983
984 /* If the Axe-Fx III has not fully booted, it will timeout when trying
985 * to enable the audio streaming interface. A more generous timeout is
986 * used here to detect when the Axe-Fx III has finished booting as the
987 * set interface message will be acked once it has
988 */
989 err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
990 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
991 1, 1, NULL, 0, 120000);
992 if (err < 0) {
993 dev_err(&dev->dev,
994 "failed waiting for Axe-Fx III to boot: %d\n", err);
995 return err;
996 }
997
998 dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
999
1000 err = usb_set_interface(dev, 1, 0);
1001 if (err < 0)
1002 dev_dbg(&dev->dev,
1003 "error stopping Axe-Fx III interface: %d\n", err);
1004
1005 return 0;
1006}
1007
Manuel Reinhardta6340902019-02-28 20:34:04 +01001008
1009#define MICROBOOK_BUF_SIZE 128
1010
1011static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1012 int buf_size, int *length)
1013{
1014 int err, actual_length;
1015
Greg Kroah-Hartmanfcc2cc12020-09-14 17:37:46 +02001016 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
Takashi Iwai801ebf12019-06-24 15:08:28 +02001017 return -EINVAL;
Manuel Reinhardta6340902019-02-28 20:34:04 +01001018 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1019 &actual_length, 1000);
1020 if (err < 0)
1021 return err;
1022
1023 print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1024 buf, actual_length, false);
1025
1026 memset(buf, 0, buf_size);
1027
Greg Kroah-Hartmanfcc2cc12020-09-14 17:37:46 +02001028 if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
Takashi Iwai801ebf12019-06-24 15:08:28 +02001029 return -EINVAL;
Manuel Reinhardta6340902019-02-28 20:34:04 +01001030 err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1031 &actual_length, 1000);
1032 if (err < 0)
1033 return err;
1034
1035 print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1036 buf, actual_length, false);
1037
1038 *length = actual_length;
1039 return 0;
1040}
1041
1042static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1043{
1044 int err, actual_length, poll_attempts = 0;
1045 static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1046 0x00, 0x00, 0x0b, 0x14,
1047 0x00, 0x00, 0x00, 0x01 };
1048 static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1049 0x00, 0x00, 0x0b, 0x18 };
1050 u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1051
1052 if (!buf)
1053 return -ENOMEM;
1054
1055 dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1056
1057 /* First we tell the device which sample rate to use. */
1058 memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1059 actual_length = sizeof(set_samplerate_seq);
1060 err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1061 &actual_length);
1062
1063 if (err < 0) {
1064 dev_err(&dev->dev,
1065 "failed setting the sample rate for Motu MicroBook II: %d\n",
1066 err);
1067 goto free_buf;
1068 }
1069
1070 /* Then we poll every 100 ms until the device informs of its readiness. */
1071 while (true) {
1072 if (++poll_attempts > 100) {
1073 dev_err(&dev->dev,
1074 "failed booting Motu MicroBook II: timeout\n");
1075 err = -ENODEV;
1076 goto free_buf;
1077 }
1078
1079 memset(buf, 0, MICROBOOK_BUF_SIZE);
1080 memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1081
1082 actual_length = sizeof(poll_ready_seq);
1083 err = snd_usb_motu_microbookii_communicate(
1084 dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1085 if (err < 0) {
1086 dev_err(&dev->dev,
1087 "failed booting Motu MicroBook II: communication error %d\n",
1088 err);
1089 goto free_buf;
1090 }
1091
1092 /* the device signals its readiness through a message of the
1093 * form
1094 * XX 06 00 00 00 00 0b 18 00 00 00 01
1095 * If the device is not yet ready to accept audio data, the
1096 * last byte of that sequence is 00.
1097 */
1098 if (actual_length == 12 && buf[actual_length - 1] == 1)
1099 break;
1100
1101 msleep(100);
1102 }
1103
1104 dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1105
1106free_buf:
1107 kfree(buf);
1108 return err;
1109}
1110
Alexander Tsoy73ac9f52020-01-12 13:23:58 +03001111static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1112{
Alexander Tsoy73ac9f52020-01-12 13:23:58 +03001113 msleep(2000);
1114
Alexander Tsoy73ac9f52020-01-12 13:23:58 +03001115 return 0;
1116}
1117
Daniel Mack54a8c502011-02-11 11:08:06 +00001118/*
Daniel Macke5779992010-03-04 19:46:13 +01001119 * Setup quirks
1120 */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001121#define MAUDIO_SET 0x01 /* parse device_setup */
1122#define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
1123#define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
Alexander Tsoy5ff40e62020-06-29 06:26:07 +03001124#define MAUDIO_SET_96K 0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001125#define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
1126#define MAUDIO_SET_DI 0x10 /* enable Digital Input */
1127#define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
Alexander Tsoy5ff40e62020-06-29 06:26:07 +03001128#define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48kHz+Digital Input */
1129#define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48kHz+No Digital Input */
1130#define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48kHz+Digital Input */
1131#define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48kHz+No Digital Input */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001132
1133static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1134 int iface, int altno)
1135{
1136 /* Reset ALL ifaces to 0 altsetting.
1137 * Call it for every possible altsetting of every interface.
1138 */
1139 usb_set_interface(chip->dev, iface, 0);
1140 if (chip->setup & MAUDIO_SET) {
1141 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1142 if (iface != 1 && iface != 2)
1143 return 1; /* skip all interfaces but 1 and 2 */
1144 } else {
1145 unsigned int mask;
1146 if (iface == 1 || iface == 2)
1147 return 1; /* skip interfaces 1 and 2 */
1148 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1149 return 1; /* skip this altsetting */
1150 mask = chip->setup & MAUDIO_SET_MASK;
1151 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1152 return 1; /* skip this altsetting */
1153 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1154 return 1; /* skip this altsetting */
1155 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1156 return 1; /* skip this altsetting */
1157 }
1158 }
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001159 usb_audio_dbg(chip,
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001160 "using altsetting %d for interface %d config %d\n",
1161 altno, iface, chip->setup);
1162 return 0; /* keep this altsetting */
1163}
Daniel Macke5779992010-03-04 19:46:13 +01001164
1165static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1166 int iface,
1167 int altno)
1168{
1169 /* Reset ALL ifaces to 0 altsetting.
1170 * Call it for every possible altsetting of every interface.
1171 */
1172 usb_set_interface(chip->dev, iface, 0);
1173
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001174 if (chip->setup & MAUDIO_SET) {
1175 unsigned int mask;
1176 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
Daniel Macke5779992010-03-04 19:46:13 +01001177 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001178 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
Daniel Macke5779992010-03-04 19:46:13 +01001179 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001180 mask = chip->setup & MAUDIO_SET_MASK;
1181 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
Daniel Macke5779992010-03-04 19:46:13 +01001182 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001183 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
Daniel Macke5779992010-03-04 19:46:13 +01001184 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001185 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
Daniel Macke5779992010-03-04 19:46:13 +01001186 return 1; /* skip this altsetting */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001187 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
Daniel Macke5779992010-03-04 19:46:13 +01001188 return 1; /* skip this altsetting */
1189 }
1190
1191 return 0; /* keep this altsetting */
1192}
1193
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001194static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1195 int iface, int altno)
1196{
1197 /* Reset ALL ifaces to 0 altsetting.
1198 * Call it for every possible altsetting of every interface.
1199 */
1200 usb_set_interface(chip->dev, iface, 0);
1201
1202 /* possible configuration where both inputs and only one output is
1203 *used is not supported by the current setup
1204 */
1205 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1206 if (chip->setup & MAUDIO_SET_96K) {
1207 if (altno != 3 && altno != 6)
1208 return 1;
1209 } else if (chip->setup & MAUDIO_SET_DI) {
1210 if (iface == 4)
1211 return 1; /* no analog input */
1212 if (altno != 2 && altno != 5)
1213 return 1; /* enable only altsets 2 and 5 */
1214 } else {
1215 if (iface == 5)
1216 return 1; /* disable digialt input */
1217 if (altno != 2 && altno != 5)
1218 return 1; /* enalbe only altsets 2 and 5 */
1219 }
1220 } else {
1221 /* keep only 16-Bit mode */
1222 if (altno != 1)
1223 return 1;
1224 }
1225
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001226 usb_audio_dbg(chip,
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001227 "using altsetting %d for interface %d config %d\n",
1228 altno, iface, chip->setup);
1229 return 0; /* keep this altsetting */
1230}
1231
Nick Kossifidis8dc5efe2020-02-15 03:23:35 +02001232static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1233 int iface, int altno)
1234{
1235 /*
1236 * Altno settings:
1237 *
1238 * Playback (Interface 1):
1239 * 1: 6 Analog + 2 S/PDIF
1240 * 2: 6 Analog + 2 S/PDIF
1241 * 3: 6 Analog
1242 *
1243 * Capture (Interface 2):
1244 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1245 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1246 * 3: 8 Analog
1247 */
1248
1249 /*
1250 * I'll leave 2 as the default one and
1251 * use device_setup to switch to the
1252 * other two.
1253 */
1254 if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1255 return 1;
1256 else if (chip->setup == 1 && altno != 1)
1257 return 1;
1258 else if (chip->setup == 2 && altno != 3)
1259 return 1;
1260
1261 return 0;
1262}
1263
Daniel Macke5779992010-03-04 19:46:13 +01001264int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1265 int iface,
1266 int altno)
1267{
1268 /* audiophile usb: skip altsets incompatible with device_setup */
1269 if (chip->usb_id == USB_ID(0x0763, 0x2003))
1270 return audiophile_skip_setting_quirk(chip, iface, altno);
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001271 /* quattro usb: skip altsets incompatible with device_setup */
1272 if (chip->usb_id == USB_ID(0x0763, 0x2001))
1273 return quattro_skip_setting_quirk(chip, iface, altno);
1274 /* fasttrackpro usb: skip altsets incompatible with device_setup */
1275 if (chip->usb_id == USB_ID(0x0763, 0x2012))
1276 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
Nick Kossifidis8dc5efe2020-02-15 03:23:35 +02001277 /* presonus studio 1810c: skip altsets incompatible with device_setup */
1278 if (chip->usb_id == USB_ID(0x0194f, 0x010c))
1279 return s1810c_skip_setting_quirk(chip, iface, altno);
1280
Daniel Macke5779992010-03-04 19:46:13 +01001281
1282 return 0;
1283}
1284
1285int snd_usb_apply_boot_quirk(struct usb_device *dev,
1286 struct usb_interface *intf,
Takashi Iwai79289e22016-01-11 11:33:34 +01001287 const struct snd_usb_audio_quirk *quirk,
1288 unsigned int id)
Daniel Macke5779992010-03-04 19:46:13 +01001289{
Daniel Mack3347b262011-02-11 11:34:12 +00001290 switch (id) {
1291 case USB_ID(0x041e, 0x3000):
1292 /* SB Extigy needs special boot-up sequence */
1293 /* if more models come, this will go to the quirk list. */
Daniel Macke5779992010-03-04 19:46:13 +01001294 return snd_usb_extigy_boot_quirk(dev, intf);
1295
Daniel Mack3347b262011-02-11 11:34:12 +00001296 case USB_ID(0x041e, 0x3020):
1297 /* SB Audigy 2 NX needs its own boot-up magic, too */
Daniel Macke5779992010-03-04 19:46:13 +01001298 return snd_usb_audigy2nx_boot_quirk(dev);
1299
Daniel Mack3347b262011-02-11 11:34:12 +00001300 case USB_ID(0x10f5, 0x0200):
1301 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
Daniel Macke5779992010-03-04 19:46:13 +01001302 return snd_usb_cm106_boot_quirk(dev);
1303
Daniel Mack3347b262011-02-11 11:34:12 +00001304 case USB_ID(0x0d8c, 0x0102):
1305 /* C-Media CM6206 / CM106-Like Sound Device */
Wolfgang Breyha8129e792011-04-28 16:18:40 +02001306 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
Daniel Macke5779992010-03-04 19:46:13 +01001307 return snd_usb_cm6206_boot_quirk(dev);
1308
Damien Zammitcb998642012-12-19 11:27:22 +01001309 case USB_ID(0x0dba, 0x3000):
1310 /* Digidesign Mbox 2 */
1311 return snd_usb_mbox2_boot_quirk(dev);
1312
Eduard Gilmutdinov11e424e2013-12-20 14:06:58 +06001313 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1314 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1315 return snd_usb_novation_boot_quirk(dev);
Mark Hills5e212332013-03-17 11:07:53 +00001316
Daniel Mack3347b262011-02-11 11:34:12 +00001317 case USB_ID(0x133e, 0x0815):
1318 /* Access Music VirusTI Desktop */
Daniel Macke5779992010-03-04 19:46:13 +01001319 return snd_usb_accessmusic_boot_quirk(dev);
1320
Daniel Mack759e890f2011-05-18 11:28:41 +02001321 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
Daniel Mack3347b262011-02-11 11:34:12 +00001322 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1323 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
Daniel Mack54a8c502011-02-11 11:08:06 +00001324 return snd_usb_nativeinstruments_boot_quirk(dev);
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001325 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1326 return snd_usb_fasttrackpro_boot_quirk(dev);
Takashi Iwai19570d72013-12-19 14:32:53 +01001327 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1328 return snd_usb_gamecon780_boot_quirk(dev);
Alberto Aguirre16bafa72018-05-08 17:14:13 -05001329 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1330 return snd_usb_axefx3_boot_quirk(dev);
Manuel Reinhardta6340902019-02-28 20:34:04 +01001331 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
Alexander Tsoy2edb84e2020-02-29 18:18:15 +03001332 /*
1333 * For some reason interface 3 with vendor-spec class is
1334 * detected on MicroBook IIc.
1335 */
1336 if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1337 USB_CLASS_VENDOR_SPEC &&
1338 get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1339 return snd_usb_motu_microbookii_boot_quirk(dev);
1340 break;
Daniel Mack3347b262011-02-11 11:34:12 +00001341 }
Daniel Mack54a8c502011-02-11 11:08:06 +00001342
Daniel Macke5779992010-03-04 19:46:13 +01001343 return 0;
1344}
1345
Alexander Tsoy73ac9f52020-01-12 13:23:58 +03001346int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1347 struct usb_interface *intf,
1348 const struct snd_usb_audio_quirk *quirk,
1349 unsigned int id)
1350{
1351 switch (id) {
1352 case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
1353 return snd_usb_motu_m_series_boot_quirk(dev);
1354 }
1355
1356 return 0;
1357}
1358
Daniel Macke5779992010-03-04 19:46:13 +01001359/*
1360 * check if the device uses big-endian samples
1361 */
Takashi Iwaicab941b2020-11-23 09:53:33 +01001362int snd_usb_is_big_endian_format(struct snd_usb_audio *chip,
1363 const struct audioformat *fp)
Daniel Macke5779992010-03-04 19:46:13 +01001364{
Adam Buchbinder48fc7f72012-09-19 21:48:00 -04001365 /* it depends on altsetting whether the device is big-endian or not */
Daniel Macke5779992010-03-04 19:46:13 +01001366 switch (chip->usb_id) {
1367 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001368 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1369 fp->altsetting == 5 || fp->altsetting == 6)
Daniel Macke5779992010-03-04 19:46:13 +01001370 return 1;
1371 break;
1372 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1373 if (chip->setup == 0x00 ||
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001374 fp->altsetting == 1 || fp->altsetting == 2 ||
1375 fp->altsetting == 3)
Daniel Macke5779992010-03-04 19:46:13 +01001376 return 1;
Guillaume Pellerin0f5733b2011-07-12 18:13:46 +02001377 break;
1378 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1379 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1380 fp->altsetting == 5 || fp->altsetting == 6)
1381 return 1;
1382 break;
Daniel Macke5779992010-03-04 19:46:13 +01001383 }
1384 return 0;
1385}
1386
1387/*
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -05001388 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
Daniel Macke5779992010-03-04 19:46:13 +01001389 * not for interface.
1390 */
1391
1392enum {
1393 EMU_QUIRK_SR_44100HZ = 0,
1394 EMU_QUIRK_SR_48000HZ,
1395 EMU_QUIRK_SR_88200HZ,
1396 EMU_QUIRK_SR_96000HZ,
1397 EMU_QUIRK_SR_176400HZ,
1398 EMU_QUIRK_SR_192000HZ
1399};
1400
1401static void set_format_emu_quirk(struct snd_usb_substream *subs,
Takashi Iwaicab941b2020-11-23 09:53:33 +01001402 const struct audioformat *fmt)
Daniel Macke5779992010-03-04 19:46:13 +01001403{
1404 unsigned char emu_samplerate_id = 0;
1405
1406 /* When capture is active
1407 * sample rate shouldn't be changed
1408 * by playback substream
1409 */
1410 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
Takashi Iwai6aa719d2020-11-23 09:53:36 +01001411 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].cur_audiofmt)
Daniel Macke5779992010-03-04 19:46:13 +01001412 return;
1413 }
1414
1415 switch (fmt->rate_min) {
1416 case 48000:
1417 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1418 break;
1419 case 88200:
1420 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1421 break;
1422 case 96000:
1423 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1424 break;
1425 case 176400:
1426 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1427 break;
1428 case 192000:
1429 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1430 break;
1431 default:
1432 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1433 break;
1434 }
1435 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
Calvin Owens1539d4f2013-04-12 22:33:59 -05001436 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
Daniel Macke5779992010-03-04 19:46:13 +01001437}
1438
Dmitry Panchenko7fccfec2020-06-01 13:22:24 +03001439
1440/*
1441 * Pioneer DJ DJM-900NXS2
1442 * Device needs to know the sample rate each time substream is started
1443 */
1444static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs)
1445{
Takashi Iwai6aa719d2020-11-23 09:53:36 +01001446 unsigned int cur_rate = subs->data_endpoint->cur_rate;
Dmitry Panchenko7fccfec2020-06-01 13:22:24 +03001447 /* Convert sample rate value to little endian */
1448 u8 sr[3];
1449
Takashi Iwai6aa719d2020-11-23 09:53:36 +01001450 sr[0] = cur_rate & 0xff;
1451 sr[1] = (cur_rate >> 8) & 0xff;
1452 sr[2] = (cur_rate >> 16) & 0xff;
Dmitry Panchenko7fccfec2020-06-01 13:22:24 +03001453
1454 /* Configure device */
1455 usb_set_interface(subs->dev, 0, 1);
1456 snd_usb_ctl_msg(subs->stream->chip->dev,
1457 usb_rcvctrlpipe(subs->stream->chip->dev, 0),
1458 0x01, 0x22, 0x0100, 0x0082, &sr, 0x0003);
1459
1460 return 0;
1461}
1462
Daniel Macke5779992010-03-04 19:46:13 +01001463void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
Takashi Iwaicab941b2020-11-23 09:53:33 +01001464 const struct audioformat *fmt)
Daniel Macke5779992010-03-04 19:46:13 +01001465{
1466 switch (subs->stream->chip->usb_id) {
1467 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1468 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1469 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -05001470 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
Daniel Macke5779992010-03-04 19:46:13 +01001471 set_format_emu_quirk(subs, fmt);
1472 break;
Dmitry Panchenko7fccfec2020-06-01 13:22:24 +03001473 case USB_ID(0x2b73, 0x000a): /* Pioneer DJ DJM-900NXS2 */
František Kučera14335d82020-08-25 17:31:13 +02001474 case USB_ID(0x2b73, 0x0017): /* Pioneer DJ DJM-250MK2 */
Dmitry Panchenko7fccfec2020-06-01 13:22:24 +03001475 pioneer_djm_set_format_quirk(subs);
1476 break;
Hector Martin1b7ecc22020-08-10 17:24:00 +09001477 case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1478 subs->stream_offset_adj = 2;
1479 break;
Daniel Macke5779992010-03-04 19:46:13 +01001480 }
1481}
1482
Joe Turnerb62b9982015-02-16 20:44:33 +00001483bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1484{
Eric Wong9fc88ad2015-03-31 07:34:05 +00001485 /* devices which do not support reading the sample rate. */
1486 switch (chip->usb_id) {
Takashi Iwai8be03a72020-01-05 09:19:00 +01001487 case USB_ID(0x041e, 0x4080): /* Creative Live Cam VF0610 */
1488 case USB_ID(0x04d8, 0xfeea): /* Benchmark DAC1 Pre */
Takashi Iwai84add302016-05-11 17:48:00 +02001489 case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
Takashi Iwai8be03a72020-01-05 09:19:00 +01001490 case USB_ID(0x05a3, 0x9420): /* ELP HD USB Camera */
Takashi Iwai51d4efa2020-01-04 12:09:36 +01001491 case USB_ID(0x05a7, 0x1020): /* Bose Companion 5 */
Takashi Iwai8be03a72020-01-05 09:19:00 +01001492 case USB_ID(0x074d, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
Takashi Iwaia8e800f2017-08-14 14:35:50 +02001493 case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
Ken Lin83d99562016-08-12 14:08:47 -04001494 case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
Takashi Iwai8be03a72020-01-05 09:19:00 +01001495 case USB_ID(0x21b4, 0x0081): /* AudioQuest DragonFly */
Arvind Sankar93f9d1a2020-02-11 11:22:35 -05001496 case USB_ID(0x2912, 0x30c8): /* Audioengine D1 */
Eric Wong9fc88ad2015-03-31 07:34:05 +00001497 return true;
1498 }
Takashi Iwaia6aa6cd2017-10-05 20:19:38 +02001499
1500 /* devices of these vendors don't support reading rate, either */
1501 switch (USB_ID_VENDOR(chip->usb_id)) {
Takashi Iwai8be03a72020-01-05 09:19:00 +01001502 case 0x045e: /* MS Lifecam */
1503 case 0x047f: /* Plantronics */
Takashi Iwaia6aa6cd2017-10-05 20:19:38 +02001504 case 0x1de7: /* Phoenix Audio */
1505 return true;
1506 }
1507
Eric Wong9fc88ad2015-03-31 07:34:05 +00001508 return false;
Joe Turnerb62b9982015-02-16 20:44:33 +00001509}
Jurgen Kramer6874daa2014-11-28 17:32:54 +01001510
Nobutaka Okabe71426532018-03-23 19:18:22 +09001511/* ITF-USB DSD based DACs need a vendor cmd to switch
Jurgen Kramer6874daa2014-11-28 17:32:54 +01001512 * between PCM and native DSD mode
1513 */
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001514static bool is_itf_usb_dsd_dac(unsigned int id)
Takashi Iwai8b28c932015-03-04 15:37:01 +01001515{
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001516 switch (id) {
Yick W. Tsec9808bb2020-06-13 11:40:06 +00001517 case USB_ID(0x154e, 0x1002): /* Denon DCD-1500RE */
Takashi Iwai8b28c932015-03-04 15:37:01 +01001518 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1519 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1520 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
Nobutaka Okabe71426532018-03-23 19:18:22 +09001521 case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001522 case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
Jussi Laako866f7ed2017-12-07 12:58:33 +02001523 case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
Nobutaka Okabeb0021482018-03-23 19:49:44 +09001524 case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
Nobutaka Okabe7f38ca02016-12-13 01:24:08 +09001525 return true;
1526 }
1527 return false;
1528}
1529
Takashi Iwaid767aba2020-11-23 09:53:24 +01001530int snd_usb_select_mode_quirk(struct snd_usb_audio *chip,
Takashi Iwaicab941b2020-11-23 09:53:33 +01001531 const struct audioformat *fmt)
Jurgen Kramer6874daa2014-11-28 17:32:54 +01001532{
Takashi Iwaid767aba2020-11-23 09:53:24 +01001533 struct usb_device *dev = chip->dev;
Jurgen Kramer6874daa2014-11-28 17:32:54 +01001534 int err;
1535
Takashi Iwaid767aba2020-11-23 09:53:24 +01001536 if (is_itf_usb_dsd_dac(chip->usb_id)) {
Jurgen Kramer6874daa2014-11-28 17:32:54 +01001537 /* First switch to alt set 0, otherwise the mode switch cmd
1538 * will not be accepted by the DAC
1539 */
1540 err = usb_set_interface(dev, fmt->iface, 0);
1541 if (err < 0)
1542 return err;
1543
Jia-Ju Baidf3f0342018-07-27 16:55:28 +08001544 msleep(20); /* Delay needed after setting the interface */
Jurgen Kramer6874daa2014-11-28 17:32:54 +01001545
Nobutaka Okabe7f38ca02016-12-13 01:24:08 +09001546 /* Vendor mode switch cmd is required. */
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001547 if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1548 /* DSD mode (DSD_U32) requested */
Nobutaka Okabe7f38ca02016-12-13 01:24:08 +09001549 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1550 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1551 1, 1, NULL, 0);
1552 if (err < 0)
1553 return err;
Nobutaka Okabe7f38ca02016-12-13 01:24:08 +09001554
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001555 } else {
1556 /* PCM or DOP mode (S32) requested */
1557 /* PCM mode (S16) requested */
Nobutaka Okabe7f38ca02016-12-13 01:24:08 +09001558 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1559 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1560 0, 1, NULL, 0);
1561 if (err < 0)
1562 return err;
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001563
Nobutaka Okabe7f38ca02016-12-13 01:24:08 +09001564 }
Jia-Ju Baidf3f0342018-07-27 16:55:28 +08001565 msleep(20);
Jurgen Kramer6874daa2014-11-28 17:32:54 +01001566 }
1567 return 0;
1568}
1569
Daniel Mack2b58fd52012-09-04 10:23:07 +02001570void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1571{
1572 /*
1573 * "Playback Design" products send bogus feedback data at the start
1574 * of the stream. Ignore them.
1575 */
Takashi Iwai79289e22016-01-11 11:33:34 +01001576 if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
Daniel Mack2b58fd52012-09-04 10:23:07 +02001577 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1578 ep->skip_packets = 4;
Eldad Zack83e3acd2013-01-13 23:02:03 +01001579
1580 /*
Matt Gruskine9a25e02013-02-09 12:56:35 -05001581 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
Alexander Tsoy5ff40e62020-06-29 06:26:07 +03001582 * world latency varies by approx. +/- 50 frames (at 96kHz) each time
Matt Gruskine9a25e02013-02-09 12:56:35 -05001583 * the stream is (re)started. When skipping packets 16 at endpoint
1584 * start up, the real world latency is stable within +/- 1 frame (also
Eldad Zack83e3acd2013-01-13 23:02:03 +01001585 * across power cycles).
1586 */
Matt Gruskine9a25e02013-02-09 12:56:35 -05001587 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1588 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
Eldad Zack83e3acd2013-01-13 23:02:03 +01001589 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1590 ep->skip_packets = 16;
Daniel Mack9abc1342016-08-22 08:53:36 +02001591
1592 /* Work around devices that report unreasonable feedback data */
Daniel Mackca0dd272016-08-22 08:53:37 +02001593 if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */
1594 ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
Daniel Mack9abc1342016-08-22 08:53:36 +02001595 ep->syncmaxsize == 4)
Daniel Mackca0dd272016-08-22 08:53:37 +02001596 ep->tenor_fb_quirk = 1;
Daniel Mack2b58fd52012-09-04 10:23:07 +02001597}
1598
Takashi Iwaid767aba2020-11-23 09:53:24 +01001599void snd_usb_set_interface_quirk(struct snd_usb_audio *chip)
Daniel Mack21bb5aa2013-04-10 00:56:03 +08001600{
Takashi Iwai79289e22016-01-11 11:33:34 +01001601 if (!chip)
1602 return;
Daniel Mack21bb5aa2013-04-10 00:56:03 +08001603 /*
1604 * "Playback Design" products need a 50ms delay after setting the
1605 * USB interface.
1606 */
Takashi Iwai79289e22016-01-11 11:33:34 +01001607 switch (USB_ID_VENDOR(chip->usb_id)) {
Guillaume Fougnies5a4ff9e2016-01-26 00:28:27 +01001608 case 0x23ba: /* Playback Design */
1609 case 0x0644: /* TEAC Corp. */
Jia-Ju Baidf3f0342018-07-27 16:55:28 +08001610 msleep(50);
Guillaume Fougnies5a4ff9e2016-01-26 00:28:27 +01001611 break;
1612 }
Daniel Mack21bb5aa2013-04-10 00:56:03 +08001613}
1614
Takashi Iwai79289e22016-01-11 11:33:34 +01001615/* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
Daniel Mack2b58fd52012-09-04 10:23:07 +02001616void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1617 __u8 request, __u8 requesttype, __u16 value,
1618 __u16 index, void *data, __u16 size)
1619{
Takashi Iwai79289e22016-01-11 11:33:34 +01001620 struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1621
1622 if (!chip)
1623 return;
Daniel Mack2b58fd52012-09-04 10:23:07 +02001624 /*
1625 * "Playback Design" products need a 20ms delay after each
1626 * class compliant request
1627 */
Takashi Iwai79289e22016-01-11 11:33:34 +01001628 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
Daniel Mack2b58fd52012-09-04 10:23:07 +02001629 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
Jia-Ju Baidf3f0342018-07-27 16:55:28 +08001630 msleep(20);
Jurgen Kramer6e84a8d2014-11-15 14:01:21 +01001631
Guillaume Fougnies5a4ff9e2016-01-26 00:28:27 +01001632 /*
1633 * "TEAC Corp." products need a 20ms delay after each
1634 * class compliant request
1635 */
Takashi Iwai79289e22016-01-11 11:33:34 +01001636 if (USB_ID_VENDOR(chip->usb_id) == 0x0644 &&
Guillaume Fougnies5a4ff9e2016-01-26 00:28:27 +01001637 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
Jia-Ju Baidf3f0342018-07-27 16:55:28 +08001638 msleep(20);
Guillaume Fougnies5a4ff9e2016-01-26 00:28:27 +01001639
Nobutaka Okabe71426532018-03-23 19:18:22 +09001640 /* ITF-USB DSD based DACs functionality need a delay
Jurgen Kramer6e84a8d2014-11-15 14:01:21 +01001641 * after each class compliant request
1642 */
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001643 if (is_itf_usb_dsd_dac(chip->usb_id)
Takashi Iwai8b28c932015-03-04 15:37:01 +01001644 && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
Jia-Ju Baidf3f0342018-07-27 16:55:28 +08001645 msleep(20);
Panu Matilainendacacb02014-11-30 18:45:40 +02001646
Joakim Tjernlund54a2a382020-11-17 13:28:03 +01001647 /* Zoom R16/24, many Logitech(at least H650e/H570e/BCC950),
1648 * Jabra 550a, Kingston HyperX needs a tiny delay here,
1649 * otherwise requests like get/set frequency return
1650 * as failed despite actually succeeding.
Panu Matilainendacacb02014-11-30 18:45:40 +02001651 */
Joakim Tjernlund07b3b5e92017-08-22 08:33:53 +02001652 if ((chip->usb_id == USB_ID(0x1686, 0x00dd) ||
Joakim Tjernlund54a2a382020-11-17 13:28:03 +01001653 USB_ID_VENDOR(chip->usb_id) == 0x046d || /* Logitech */
Jesus Ramos073919e2020-04-27 06:21:39 -07001654 chip->usb_id == USB_ID(0x0b0e, 0x0349) ||
1655 chip->usb_id == USB_ID(0x0951, 0x16ad)) &&
Panu Matilainendacacb02014-11-30 18:45:40 +02001656 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
Jia-Ju Baidf3f0342018-07-27 16:55:28 +08001657 usleep_range(1000, 2000);
Macpaul Lina32a1fc2020-06-23 19:03:23 +08001658
1659 /*
1660 * Samsung USBC Headset (AKG) need a tiny delay after each
1661 * class compliant request. (Model number: AAM625R or AAM627R)
1662 */
1663 if (chip->usb_id == USB_ID(0x04e8, 0xa051) &&
1664 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1665 usleep_range(5000, 6000);
Daniel Mack2b58fd52012-09-04 10:23:07 +02001666}
1667
Daniel Mack126825e2013-04-17 00:01:40 +08001668/*
1669 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1670 * augment the PCM format bit-field for DSD types. The UAC standards
1671 * don't have a designated bit field to denote DSD-capable interfaces,
1672 * hence all hardware that is known to support this format has to be
1673 * listed here.
1674 */
1675u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1676 struct audioformat *fp,
1677 unsigned int sample_bytes)
1678{
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001679 struct usb_interface *iface;
1680
Daniel Mack126825e2013-04-17 00:01:40 +08001681 /* Playback Designs */
Jussi Laakoeb7505d2019-08-28 00:08:46 +03001682 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1683 USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
Daniel Mack126825e2013-04-17 00:01:40 +08001684 switch (fp->altsetting) {
1685 case 1:
1686 fp->dsd_dop = true;
1687 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1688 case 2:
1689 fp->dsd_bitrev = true;
1690 return SNDRV_PCM_FMTBIT_DSD_U8;
1691 case 3:
1692 fp->dsd_bitrev = true;
1693 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1694 }
1695 }
1696
Jurgen Kramer848f3a82014-09-05 18:14:46 +02001697 /* XMOS based USB DACs */
1698 switch (chip->usb_id) {
Daniel Mackf6568912018-04-20 22:29:41 +02001699 case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
Daniel Mackf6568912018-04-20 22:29:41 +02001700 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
Jussi Laako9bb201a2017-10-15 12:41:32 +03001701 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
Jurgen Kramer848f3a82014-09-05 18:14:46 +02001702 if (fp->altsetting == 2)
Jussi Laakod42472e2014-11-21 16:04:46 +02001703 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
Jurgen Kramer848f3a82014-09-05 18:14:46 +02001704 break;
Jurgen Kramer3b7e5c72015-06-05 09:42:49 +02001705
Daniel Mackf6568912018-04-20 22:29:41 +02001706 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
Jussi Laako202e69e2019-01-29 00:47:01 +02001707 case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
Takashi Iwai547d2c92020-04-30 14:47:55 +02001708 case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
Jussi Laako202e69e2019-01-29 00:47:01 +02001709 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
Daniel Mackf6568912018-04-20 22:29:41 +02001710 case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1711 case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1712 case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
Daniel Mackf6568912018-04-20 22:29:41 +02001713 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1714 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
Jurgen Kramerad678b42016-01-29 14:59:25 +01001715 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
Daniel Mackf6568912018-04-20 22:29:41 +02001716 case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1717 case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1718 case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1719 case USB_ID(0x6b42, 0x0042): /* MSB Technology */
Jurgen Kramer848f3a82014-09-05 18:14:46 +02001720 if (fp->altsetting == 3)
Jussi Laakod42472e2014-11-21 16:04:46 +02001721 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
Jurgen Kramer848f3a82014-09-05 18:14:46 +02001722 break;
Jussi Laako3eff6822016-12-17 23:51:41 +02001723
Daniel Mack7c748662018-02-11 09:50:27 -04001724 /* Amanero Combo384 USB based DACs with native DSD support */
1725 case USB_ID(0x16d0, 0x071a): /* Amanero - Combo384 */
1726 case USB_ID(0x2ab6, 0x0004): /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1727 case USB_ID(0x2ab6, 0x0005): /* T+A USB HD Audio 1 */
1728 case USB_ID(0x2ab6, 0x0006): /* T+A USB HD Audio 2 */
Jussi Laako3eff6822016-12-17 23:51:41 +02001729 if (fp->altsetting == 2) {
Johan Hovoldf83914f2017-05-12 14:34:37 +02001730 switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
Jussi Laako3eff6822016-12-17 23:51:41 +02001731 case 0x199:
1732 return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1733 case 0x19b:
Jussi Laakof5ce8172017-11-01 23:32:33 +02001734 case 0x203:
Jussi Laako3eff6822016-12-17 23:51:41 +02001735 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1736 default:
1737 break;
1738 }
1739 }
1740 break;
Jussi Laakoed993c62017-08-18 10:42:14 +03001741 case USB_ID(0x16d0, 0x0a23):
1742 if (fp->altsetting == 2)
1743 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1744 break;
Jussi Laako3eff6822016-12-17 23:51:41 +02001745
Jurgen Kramer848f3a82014-09-05 18:14:46 +02001746 default:
1747 break;
1748 }
1749
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001750 /* ITF-USB DSD based DACs */
1751 if (is_itf_usb_dsd_dac(chip->usb_id)) {
1752 iface = usb_ifnum_to_if(chip->dev, fp->iface);
Jurgen Kramer7a2e9dd2014-11-28 17:32:53 +01001753
Nobutaka Okabef3b906d2018-03-23 19:21:13 +09001754 /* Altsetting 2 support native DSD if the num of altsets is
1755 * three (0-2),
1756 * Altsetting 3 support native DSD if the num of altsets is
1757 * four (0-3).
1758 */
1759 if (fp->altsetting == iface->num_altsetting - 1)
Nobutaka Okabe7f38ca02016-12-13 01:24:08 +09001760 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1761 }
1762
Jussi Laako3a572d92018-06-13 01:43:01 +03001763 /* Mostly generic method to detect many DSD-capable implementations -
1764 * from XMOS/Thesycon
1765 */
1766 switch (USB_ID_VENDOR(chip->usb_id)) {
Yue Wang1ea03582018-07-23 01:56:46 -07001767 case 0x152a: /* Thesycon devices */
Jussi Laakoeb7505d2019-08-28 00:08:46 +03001768 case 0x20b1: /* XMOS based devices */
Jussi Laako0067e152019-08-28 00:08:47 +03001769 case 0x22d9: /* Oppo */
Jussi Laakoeb7505d2019-08-28 00:08:46 +03001770 case 0x23ba: /* Playback Designs */
Jussi Laako3a572d92018-06-13 01:43:01 +03001771 case 0x25ce: /* Mytek devices */
Jussi Laako0067e152019-08-28 00:08:47 +03001772 case 0x278b: /* Rotel? */
Justin Songe2995b92019-10-24 12:27:14 +02001773 case 0x292b: /* Gustard/Ess based devices */
Amadej Kastelic725124d2020-12-15 19:09:05 +01001774 case 0x2972: /* FiiO devices */
Udo Eberhardt3bff2402019-02-05 17:20:47 +01001775 case 0x2ab6: /* T+A devices */
Artem Lapkin07815a22020-11-03 18:08:09 +08001776 case 0x3353: /* Khadas devices */
Jussi Laakof41f9002019-09-24 10:11:43 +03001777 case 0x3842: /* EVGA */
Ilya Pshonkin029d2c02019-09-17 10:49:34 +03001778 case 0xc502: /* HiBy devices */
Jussi Laako3a572d92018-06-13 01:43:01 +03001779 if (fp->dsd_raw)
1780 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1781 break;
1782 default:
1783 break;
1784
1785 }
1786
Daniel Mack126825e2013-04-17 00:01:40 +08001787 return 0;
1788}
Ruslan Bilovolceb18f52018-03-19 03:46:02 +02001789
1790void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1791 struct audioformat *fp,
1792 int stream)
1793{
1794 switch (chip->usb_id) {
1795 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1796 /* Optoplay sets the sample rate attribute although
1797 * it seems not supporting it in fact.
1798 */
1799 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
1800 break;
1801 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1802 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1803 /* doesn't set the sample rate attribute, but supports it */
1804 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
1805 break;
1806 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
1807 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1808 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1809 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1810 an older model 77d:223) */
1811 /*
1812 * plantronics headset and Griffin iMic have set adaptive-in
1813 * although it's really not...
1814 */
1815 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
1816 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
1817 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
1818 else
1819 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
1820 break;
Alexander Tsoy2edb84e2020-02-29 18:18:15 +03001821 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook IIc */
1822 /*
1823 * MaxPacketsOnly attribute is erroneously set in endpoint
1824 * descriptors. As a result this card produces noise with
Alexander Tsoy5ff40e62020-06-29 06:26:07 +03001825 * all sample rates other than 96 kHz.
Alexander Tsoy2edb84e2020-02-29 18:18:15 +03001826 */
1827 fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
1828 break;
Ruslan Bilovolceb18f52018-03-19 03:46:02 +02001829 }
1830}
Chris Wulff55f73262020-03-14 12:54:49 -04001831
Takashi Iwaid8695bc2020-03-25 11:33:19 +01001832/*
1833 * registration quirk:
1834 * the registration is skipped if a device matches with the given ID,
1835 * unless the interface reaches to the defined one. This is for delaying
1836 * the registration until the last known interface, so that the card and
1837 * devices appear at the same time.
1838 */
1839
1840struct registration_quirk {
1841 unsigned int usb_id; /* composed via USB_ID() */
1842 unsigned int interface; /* the interface to trigger register */
1843};
1844
1845#define REG_QUIRK_ENTRY(vendor, product, iface) \
1846 { .usb_id = USB_ID(vendor, product), .interface = (iface) }
1847
1848static const struct registration_quirk registration_quirks[] = {
1849 REG_QUIRK_ENTRY(0x0951, 0x16d8, 2), /* Kingston HyperX AMP */
Emmanuel Pescostafd60e062020-04-04 17:38:43 +02001850 REG_QUIRK_ENTRY(0x0951, 0x16ed, 2), /* Kingston HyperX Cloud Alpha S */
Christoffer Nielsen73094602020-06-19 13:48:22 +02001851 REG_QUIRK_ENTRY(0x0951, 0x16ea, 2), /* Kingston HyperX Cloud Flight S */
Takashi Iwaid8695bc2020-03-25 11:33:19 +01001852 { 0 } /* terminator */
1853};
1854
1855/* return true if skipping registration */
1856bool snd_usb_registration_quirk(struct snd_usb_audio *chip, int iface)
Chris Wulff55f73262020-03-14 12:54:49 -04001857{
Takashi Iwaid8695bc2020-03-25 11:33:19 +01001858 const struct registration_quirk *q;
1859
1860 for (q = registration_quirks; q->usb_id; q++)
1861 if (chip->usb_id == q->usb_id)
1862 return iface != q->interface;
1863
Chris Wulff55f73262020-03-14 12:54:49 -04001864 /* Register as normal */
Takashi Iwaid8695bc2020-03-25 11:33:19 +01001865 return false;
Chris Wulff55f73262020-03-14 12:54:49 -04001866}