projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: usb-audio: Simplify snd_usb_init_sample_rate() arguments
[linux-block.git] / sound / usb / quirks.c
CommitLineData
1a59d1b8 1// SPDX-License-Identifier: GPL-2.0-or-later
e5779998 2/*
e5779998
DM		 3 */
4
5#include <linux/init.h>
36db0456 6#include <linux/slab.h>
e5779998
DM		 7#include <linux/usb.h>
8#include <linux/usb/audio.h>
aafe77cc 9#include <linux/usb/midi.h>
ad43d528 10#include <linux/bits.h>
e5779998 11
9e38658f 12#include <sound/control.h>
e5779998
DM		 13#include <sound/core.h>
14#include <sound/info.h>
15#include <sound/pcm.h>
16
17#include "usbaudio.h"
18#include "card.h"
f0b5e634 19#include "mixer.h"
7b1eda22 20#include "mixer_quirks.h"
e5779998
DM		 21#include "midi.h"
22#include "quirks.h"
23#include "helper.h"
24#include "endpoint.h"
25#include "pcm.h"
3d8d4dcf 26#include "clock.h"
e8e8babf 27#include "stream.h"
e5779998
DM		 28
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,
85a81813 35 const struct snd_usb_audio_quirk *quirk_comp)
e5779998
DM		 36{
37 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
85a81813 38 const struct snd_usb_audio_quirk *quirk;
e5779998
DM		 39 int err;
40
85a81813 41 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
e5779998
DM		 42 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
43 if (!iface)
44 continue;
45 if (quirk->ifnum != probed_ifnum &&
46 usb_interface_claimed(iface))
47 continue;
48 err = snd_usb_create_quirk(chip, iface, driver, quirk);
49 if (err < 0)
50 return err;
d4b8fc66
TI		 51 }
52
85a81813 53 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
d4b8fc66
TI		 54 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
55 if (!iface)
56 continue;
57 if (quirk->ifnum != probed_ifnum &&
58 !usb_interface_claimed(iface))
e5779998
DM		 59 usb_driver_claim_interface(driver, iface, (void *)-1L);
60 }
d4b8fc66 61
e5779998
DM		 62 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
e0570446
RW		 107 if (chip->usb_id == USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
108 chip->tx_length_quirk = 1;
109
e5779998
DM		 110 alts = &iface->altsetting[0];
111 altsd = get_iface_desc(alts);
e8e8babf 112 err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
e5779998 113 if (err < 0) {
0ba41d91 114 usb_audio_err(chip, "cannot setup if %d: error %d\n",
e5779998
DM		 115 altsd->bInterfaceNumber, err);
116 return err;
117 }
118 /* reset the current interface */
119 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
120 return 0;
121}
122
123/*
124 * create a stream for an endpoint/altsetting without proper descriptors
125 */
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;
42d4ab83 133 struct usb_interface_descriptor *altsd;
e5779998
DM		 134 int stream, err;
135 unsigned *rate_table = NULL;
136
137 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
9ecb2406 138 if (!fp)
e5779998 139 return -ENOMEM;
9ecb2406 140
836b34a9 141 INIT_LIST_HEAD(&fp->list);
8866f405
XW		 142 if (fp->nr_rates > MAX_NR_RATES) {
143 kfree(fp);
144 return -EINVAL;
145 }
e5779998 146 if (fp->nr_rates > 0) {
43df2a57
TM		 147 rate_table = kmemdup(fp->rate_table,
148 sizeof(int) * fp->nr_rates, GFP_KERNEL);
e5779998
DM		 149 if (!rate_table) {
150 kfree(fp);
151 return -ENOMEM;
152 }
e5779998
DM		 153 fp->rate_table = rate_table;
154 }
155
156 stream = (fp->endpoint & USB_DIR_IN)
157 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
e8e8babf 158 err = snd_usb_add_audio_stream(chip, stream, fp);
902eb7fd
TI		 159 if (err < 0)
160 goto error;
e5779998
DM		 161 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
162 fp->altset_idx >= iface->num_altsetting) {
902eb7fd
TI		 163 err = -EINVAL;
164 goto error;
e5779998
DM		 165 }
166 alts = &iface->altsetting[fp->altset_idx];
42d4ab83 167 altsd = get_iface_desc(alts);
0f886ca1 168 if (altsd->bNumEndpoints < 1) {
902eb7fd
TI		 169 err = -EINVAL;
170 goto error;
0f886ca1
TI		 171 }
172
42d4ab83
EZ		 173 fp->protocol = altsd->bInterfaceProtocol;
174
59ea586f
MH		 175 if (fp->datainterval == 0)
176 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
177 if (fp->maxpacksize == 0)
178 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
e5779998 179 usb_set_interface(chip->dev, fp->iface, 0);
767d75ad 180 snd_usb_init_pitch(chip, fp->iface, alts, fp);
953a446b 181 snd_usb_init_sample_rate(chip, fp, fp->rate_max);
e5779998 182 return 0;
902eb7fd
TI		 183
184 error:
836b34a9 185 list_del(&fp->list); /* unlink for avoiding double-free */
902eb7fd
TI		 186 kfree(fp);
187 kfree(rate_table);
188 return err;
e5779998
DM		 189}
190
aafe77cc
CL		 191static 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;
cc9dbfa9
TI		 251 if ((injd && !snd_usb_validate_midi_desc(injd)) ||
252 (outjd && !snd_usb_validate_midi_desc(outjd)))
57f87706 253 return -ENODEV;
aafe77cc
CL		 254 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);
aa773bfe 333 if (!usb_endpoint_xfer_bulk(epd) &&
aafe77cc
CL		 334 !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);
aa773bfe 340 if (err != -ENODEV)
aafe77cc
CL		 341 return err;
342 break;
343 case 0x0582: /* Roland */
344 err = create_roland_midi_quirk(chip, iface, driver, alts);
aa773bfe 345 if (err != -ENODEV)
aafe77cc
CL		 346 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,
b1ce7ba6 355 struct usb_driver *driver)
aafe77cc
CL		 356{
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
b1ce7ba6
CL		 365static 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
e5779998
DM		 400/*
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 = {
015eb0b0 410 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
e5779998
DM		 411 .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;
79289e24
TI		 448 return __snd_usbmidi_create(chip->card, iface,
449 &chip->midi_list, quirk,
450 chip->usb_id);
e5779998
DM		 451 }
452
453 if (altsd->bNumEndpoints != 1)
454 return -ENXIO;
455
43df2a57 456 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
e5779998
DM		 457 if (!fp)
458 return -ENOMEM;
e5779998
DM		 459
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);
836b34a9 465 INIT_LIST_HEAD(&fp->list);
e5779998
DM		 466
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:
0ba41d91 480 usb_audio_err(chip, "unknown sample rate\n");
e5779998
DM		 481 kfree(fp);
482 return -ENXIO;
483 }
484
485 stream = (fp->endpoint & USB_DIR_IN)
486 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
e8e8babf 487 err = snd_usb_add_audio_stream(chip, stream, fp);
e5779998 488 if (err < 0) {
836b34a9 489 list_del(&fp->list); /* unlink for avoiding double-free */
e5779998
DM		 490 kfree(fp);
491 return err;
492 }
493 usb_set_interface(chip->dev, fp->iface, 0);
494 return 0;
495}
496
014950b0
DM		 497/*
498 * 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
92adc96f
HW		 511
512static int setup_fmt_after_resume_quirk(struct snd_usb_audio *chip,
513 struct usb_interface *iface,
514 struct usb_driver *driver,
515 const struct snd_usb_audio_quirk *quirk)
516{
517 chip->setup_fmt_after_resume_quirk = 1;
518 return 1; /* Continue with creating streams and mixer */
519}
520
1965c436
KHF		 521static int setup_disable_autosuspend(struct snd_usb_audio *chip,
522 struct usb_interface *iface,
523 struct usb_driver *driver,
524 const struct snd_usb_audio_quirk *quirk)
525{
526 driver->supports_autosuspend = 0;
527 return 1; /* Continue with creating streams and mixer */
528}
529
e5779998
DM		 530/*
531 * audio-interface quirks
532 *
533 * returns zero if no standard audio/MIDI parsing is needed.
25985edc 534 * returns a positive value if standard audio/midi interfaces are parsed
e5779998
DM		 535 * after this.
536 * returns a negative value at error.
537 */
538int snd_usb_create_quirk(struct snd_usb_audio *chip,
539 struct usb_interface *iface,
540 struct usb_driver *driver,
541 const struct snd_usb_audio_quirk *quirk)
542{
543 typedef int (*quirk_func_t)(struct snd_usb_audio *,
544 struct usb_interface *,
545 struct usb_driver *,
546 const struct snd_usb_audio_quirk *);
547 static const quirk_func_t quirk_funcs[] = {
548 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
549 [QUIRK_COMPOSITE] = create_composite_quirk,
b1ce7ba6 550 [QUIRK_AUTODETECT] = create_autodetect_quirks,
e5779998
DM		 551 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
552 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
553 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
aafe77cc 554 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
e5779998
DM		 555 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
556 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
c7f57216 557 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
e5779998
DM		 558 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
559 [QUIRK_MIDI_CME] = create_any_midi_quirk,
4434ade8 560 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
1ef0e0a0 561 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
1ca8b201 562 [QUIRK_MIDI_CH345] = create_any_midi_quirk,
e5779998
DM		 563 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
564 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
565 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
014950b0
DM		 566 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
567 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
92adc96f 568 [QUIRK_SETUP_FMT_AFTER_RESUME] = setup_fmt_after_resume_quirk,
1965c436 569 [QUIRK_SETUP_DISABLE_AUTOSUSPEND] = setup_disable_autosuspend,
e5779998
DM		 570 };
571
572 if (quirk->type < QUIRK_TYPE_COUNT) {
573 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
574 } else {
0ba41d91 575 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
e5779998
DM		 576 return -ENXIO;
577 }
578}
579
580/*
581 * boot quirks
582 */
583
584#define EXTIGY_FIRMWARE_SIZE_OLD 794
585#define EXTIGY_FIRMWARE_SIZE_NEW 483
586
587static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
588{
589 struct usb_host_config *config = dev->actconfig;
590 int err;
591
592 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
593 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
0ba41d91 594 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
e5779998
DM		 595 /* Send message to force it to reconnect with full interface. */
596 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
17d900c4 597 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
0ba41d91
TI		 598 if (err < 0)
599 dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
e5779998
DM		 600 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
601 &dev->descriptor, sizeof(dev->descriptor));
602 config = dev->actconfig;
0ba41d91
TI		 603 if (err < 0)
604 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
e5779998 605 err = usb_reset_configuration(dev);
0ba41d91
TI		 606 if (err < 0)
607 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
608 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
e5779998
DM		 609 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
610 return -ENODEV; /* quit this anyway */
611 }
612 return 0;
613}
614
615static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
616{
617 u8 buf = 1;
618
619 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
620 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
17d900c4 621 0, 0, &buf, 1);
e5779998
DM		 622 if (buf == 0) {
623 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
624 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
17d900c4 625 1, 2000, NULL, 0);
e5779998
DM		 626 return -ENODEV;
627 }
628 return 0;
629}
630
0f5733b0
GP		 631static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
632{
633 int err;
634
635 if (dev->actconfig->desc.bConfigurationValue == 1) {
0ba41d91 636 dev_info(&dev->dev,
0f5733b0
GP		 637 "Fast Track Pro switching to config #2\n");
638 /* This function has to be available by the usb core module.
639 * if it is not avialable the boot quirk has to be left out
640 * and the configuration has to be set by udev or hotplug
641 * rules
642 */
643 err = usb_driver_set_configuration(dev, 2);
b98ae272 644 if (err < 0)
0ba41d91
TI		 645 dev_dbg(&dev->dev,
646 "error usb_driver_set_configuration: %d\n",
647 err);
b98ae272
DH		 648 /* Always return an error, so that we stop creating a device
649 that will just be destroyed and recreated with a new
650 configuration */
651 return -ENODEV;
0f5733b0 652 } else
0ba41d91 653 dev_info(&dev->dev, "Fast Track Pro config OK\n");
0f5733b0
GP		 654
655 return 0;
656}
657
e5779998
DM		 658/*
659 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
660 * documented in the device's data sheet.
661 */
662static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
663{
664 u8 buf[4];
665 buf[0] = 0x20;
666 buf[1] = value & 0xff;
667 buf[2] = (value >> 8) & 0xff;
668 buf[3] = reg;
669 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
670 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
17d900c4 671 0, 0, &buf, 4);
e5779998
DM		 672}
673
674static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
675{
676 /*
677 * Enable line-out driver mode, set headphone source to front
678 * channels, enable stereo mic.
679 */
680 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
681}
682
683/*
ad43d528 684 * CM6206 registers from the CM6206 datasheet rev 2.1
e5779998 685 */
ad43d528
LW		 686#define CM6206_REG0_DMA_MASTER BIT(15)
687#define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
688#define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
689/* Bit 4 thru 11 is the S/PDIF category code */
690#define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
691#define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
692#define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
693#define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
694#define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
695
696#define CM6206_REG1_TEST_SEL_CLK BIT(14)
697#define CM6206_REG1_PLLBIN_EN BIT(13)
698#define CM6206_REG1_SOFT_MUTE_EN BIT(12)
699#define CM6206_REG1_GPIO4_OUT BIT(11)
700#define CM6206_REG1_GPIO4_OE BIT(10)
701#define CM6206_REG1_GPIO3_OUT BIT(9)
702#define CM6206_REG1_GPIO3_OE BIT(8)
703#define CM6206_REG1_GPIO2_OUT BIT(7)
704#define CM6206_REG1_GPIO2_OE BIT(6)
705#define CM6206_REG1_GPIO1_OUT BIT(5)
706#define CM6206_REG1_GPIO1_OE BIT(4)
707#define CM6206_REG1_SPDIFO_INVALID BIT(3)
708#define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
709#define CM6206_REG1_SPDIFO_DIS BIT(1)
710#define CM6206_REG1_SPDIFI_MIX BIT(0)
711
712#define CM6206_REG2_DRIVER_ON BIT(15)
713#define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
714#define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
715#define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
716#define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
717#define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
718#define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
719#define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
720#define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
721#define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
722#define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
723#define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
724#define CM6206_REG2_MUTE_CENTER BIT(5)
725#define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
726#define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
727#define CM6206_REG2_EN_BTL BIT(2)
728#define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
729#define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
730#define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
731#define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
732
733/* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
734#define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
735#define CM6206_REG3_VRAP25EN BIT(10)
736#define CM6206_REG3_MSEL1 BIT(9)
737#define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
738#define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
739#define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
740#define CM6206_REG3_PINSEL BIT(6)
741#define CM6206_REG3_FOE BIT(5)
742#define CM6206_REG3_ROE BIT(4)
743#define CM6206_REG3_CBOE BIT(3)
744#define CM6206_REG3_LOSE BIT(2)
745#define CM6206_REG3_HPOE BIT(1)
746#define CM6206_REG3_SPDIFI_CANREC BIT(0)
747
748#define CM6206_REG5_DA_RSTN BIT(13)
749#define CM6206_REG5_AD_RSTN BIT(12)
750#define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
751#define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
752#define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
753#define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
754#define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
755#define CM6206_REG5_CODECM BIT(8)
756#define CM6206_REG5_EN_HPF BIT(7)
757#define CM6206_REG5_T_SEL_DSDA4 BIT(6)
758#define CM6206_REG5_T_SEL_DSDA3 BIT(5)
759#define CM6206_REG5_T_SEL_DSDA2 BIT(4)
760#define CM6206_REG5_T_SEL_DSDA1 BIT(3)
761#define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
762#define CM6206_REG5_T_SEL_DSDAD_FRONT 4
763#define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
764#define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
765#define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
766
e5779998
DM		 767static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
768{
dac8f847 769 int err = 0, reg;
ad43d528
LW		 770 int val[] = {
771 /*
772 * Values here are chosen based on sniffing USB traffic
773 * under Windows.
774 *
775 * REG0: DAC is master, sample rate 48kHz, no copyright
776 */
777 CM6206_REG0_SPDIFO_RATE_48K |
778 CM6206_REG0_SPDIFO_COPYRIGHT_NA,
779 /*
780 * REG1: PLL binary search enable, soft mute enable.
781 */
782 CM6206_REG1_PLLBIN_EN |
f5c9571e 783 CM6206_REG1_SOFT_MUTE_EN,
ad43d528
LW		 784 /*
785 * REG2: enable output drivers,
786 * select front channels to the headphone output,
787 * then mute the headphone channels, run the MCU
788 * at 1.5 MHz.
789 */
790 CM6206_REG2_DRIVER_ON |
791 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
792 CM6206_REG2_MUTE_HEADPHONE_RIGHT |
793 CM6206_REG2_MUTE_HEADPHONE_LEFT,
794 /*
795 * REG3: default flyspeed, set 2.5V mic bias
796 * enable all line out ports and enable SPDIF
797 */
798 CM6206_REG3_FLYSPEED_DEFAULT |
799 CM6206_REG3_VRAP25EN |
800 CM6206_REG3_FOE |
801 CM6206_REG3_ROE |
802 CM6206_REG3_CBOE |
803 CM6206_REG3_LOSE |
804 CM6206_REG3_HPOE |
805 CM6206_REG3_SPDIFI_CANREC,
806 /* REG4 is just a bunch of GPIO lines */
807 0x0000,
808 /* REG5: de-assert AD/DA reset signals */
809 CM6206_REG5_DA_RSTN |
810 CM6206_REG5_AD_RSTN };
e5779998
DM		 811
812 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
813 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
814 if (err < 0)
815 return err;
816 }
817
818 return err;
819}
820
19570d74
TI		 821/* quirk for Plantronics GameCom 780 with CM6302 chip */
822static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
823{
824 /* set the initial volume and don't change; other values are either
825 * too loud or silent due to firmware bug (bko#65251)
826 */
542baf94 827 u8 buf[2] = { 0x74, 0xe3 };
19570d74
TI		 828 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
829 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
830 UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
831}
832
5e212332
MH		 833/*
834 * Novation Twitch DJ controller
11e424e8 835 * Focusrite Novation Saffire 6 USB audio card
5e212332 836 */
11e424e8 837static int snd_usb_novation_boot_quirk(struct usb_device *dev)
5e212332
MH		 838{
839 /* preemptively set up the device because otherwise the
840 * raw MIDI endpoints are not active */
841 usb_set_interface(dev, 0, 1);
842 return 0;
843}
844
e5779998
DM		 845/*
846 * This call will put the synth in "USB send" mode, i.e it will send MIDI
847 * messages through USB (this is disabled at startup). The synth will
848 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
849 * sign on its LCD. Values here are chosen based on sniffing USB traffic
850 * under Windows.
851 */
852static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
853{
854 int err, actual_length;
e5779998
DM		 855 /* "midi send" enable */
856 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
801ebf10 857 void *buf;
e5779998 858
fcc2cc1f 859 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
801ebf10
TI		 860 return -EINVAL;
861 buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
e5779998
DM		 862 if (!buf)
863 return -ENOMEM;
864 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
865 ARRAY_SIZE(seq), &actual_length, 1000);
866 kfree(buf);
867 if (err < 0)
868 return err;
869
870 return 0;
871}
872
54a8c500
DM		 873/*
874 * Some sound cards from Native Instruments are in fact compliant to the USB
875 * audio standard of version 2 and other approved USB standards, even though
876 * they come up as vendor-specific device when first connected.
877 *
878 * However, they can be told to come up with a new set of descriptors
879 * upon their next enumeration, and the interfaces announced by the new
880 * descriptors will then be handled by the kernel's class drivers. As the
881 * product ID will also change, no further checks are required.
882 */
883
884static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
885{
801ebf10
TI		 886 int ret;
887
801ebf10 888 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
54a8c500 889 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
889d6684 890 1, 0, NULL, 0, 1000);
54a8c500
DM		 891
892 if (ret < 0)
893 return ret;
894
895 usb_reset_device(dev);
896
897 /* return -EAGAIN, so the creation of an audio interface for this
898 * temporary device is aborted. The device will reconnect with a
899 * new product ID */
900 return -EAGAIN;
901}
902
cb99864d
DZ		 903static void mbox2_setup_48_24_magic(struct usb_device *dev)
904{
905 u8 srate[3];
906 u8 temp[12];
907
908 /* Choose 48000Hz permanently */
909 srate[0] = 0x80;
910 srate[1] = 0xbb;
911 srate[2] = 0x00;
912
913 /* Send the magic! */
914 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
915 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
916 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
917 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
918 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
919 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
920 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
921 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
922 return;
923}
924
925/* Digidesign Mbox 2 needs to load firmware onboard
926 * and driver must wait a few seconds for initialisation.
927 */
928
929#define MBOX2_FIRMWARE_SIZE 646
930#define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
931#define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
932
b7b435e8 933static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
cb99864d
DZ		 934{
935 struct usb_host_config *config = dev->actconfig;
936 int err;
4909a0ca 937 u8 bootresponse[0x12];
cb99864d
DZ		 938 int fwsize;
939 int count;
940
941 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
942
943 if (fwsize != MBOX2_FIRMWARE_SIZE) {
0ba41d91 944 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
cb99864d
DZ		 945 return -ENODEV;
946 }
947
0ba41d91 948 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
cb99864d
DZ		 949
950 count = 0;
b7b435e8
DZ		 951 bootresponse[0] = MBOX2_BOOT_LOADING;
952 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
cb99864d
DZ		 953 msleep(500); /* 0.5 second delay */
954 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
955 /* Control magic - load onboard firmware */
956 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
b7b435e8 957 if (bootresponse[0] == MBOX2_BOOT_READY)
cb99864d 958 break;
0ba41d91 959 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
cb99864d
DZ		 960 count++;
961 }
962
b7b435e8 963 if (bootresponse[0] != MBOX2_BOOT_READY) {
0ba41d91 964 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
cb99864d
DZ		 965 return -ENODEV;
966 }
967
0ba41d91 968 dev_dbg(&dev->dev, "device initialised!\n");
cb99864d
DZ		 969
970 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
971 &dev->descriptor, sizeof(dev->descriptor));
972 config = dev->actconfig;
973 if (err < 0)
0ba41d91 974 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
cb99864d
DZ		 975
976 err = usb_reset_configuration(dev);
977 if (err < 0)
0ba41d91
TI		 978 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
979 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
cb99864d
DZ		 980 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
981
982 mbox2_setup_48_24_magic(dev);
983
0ba41d91 984 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
cb99864d
DZ		 985
986 return 0; /* Successful boot */
987}
988
16bafa79
AA		 989static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
990{
991 int err;
992
993 dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
994
995 /* If the Axe-Fx III has not fully booted, it will timeout when trying
996 * to enable the audio streaming interface. A more generous timeout is
997 * used here to detect when the Axe-Fx III has finished booting as the
998 * set interface message will be acked once it has
999 */
1000 err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1001 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
1002 1, 1, NULL, 0, 120000);
1003 if (err < 0) {
1004 dev_err(&dev->dev,
1005 "failed waiting for Axe-Fx III to boot: %d\n", err);
1006 return err;
1007 }
1008
1009 dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
1010
1011 err = usb_set_interface(dev, 1, 0);
1012 if (err < 0)
1013 dev_dbg(&dev->dev,
1014 "error stopping Axe-Fx III interface: %d\n", err);
1015
1016 return 0;
1017}
1018
a634090a
MR		 1019
1020#define MICROBOOK_BUF_SIZE 128
1021
1022static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1023 int buf_size, int *length)
1024{
1025 int err, actual_length;
1026
fcc2cc1f 1027 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
801ebf10 1028 return -EINVAL;
a634090a
MR		 1029 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1030 &actual_length, 1000);
1031 if (err < 0)
1032 return err;
1033
1034 print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1035 buf, actual_length, false);
1036
1037 memset(buf, 0, buf_size);
1038
fcc2cc1f 1039 if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
801ebf10 1040 return -EINVAL;
a634090a
MR		 1041 err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1042 &actual_length, 1000);
1043 if (err < 0)
1044 return err;
1045
1046 print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1047 buf, actual_length, false);
1048
1049 *length = actual_length;
1050 return 0;
1051}
1052
1053static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1054{
1055 int err, actual_length, poll_attempts = 0;
1056 static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1057 0x00, 0x00, 0x0b, 0x14,
1058 0x00, 0x00, 0x00, 0x01 };
1059 static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1060 0x00, 0x00, 0x0b, 0x18 };
1061 u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1062
1063 if (!buf)
1064 return -ENOMEM;
1065
1066 dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1067
1068 /* First we tell the device which sample rate to use. */
1069 memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1070 actual_length = sizeof(set_samplerate_seq);
1071 err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1072 &actual_length);
1073
1074 if (err < 0) {
1075 dev_err(&dev->dev,
1076 "failed setting the sample rate for Motu MicroBook II: %d\n",
1077 err);
1078 goto free_buf;
1079 }
1080
1081 /* Then we poll every 100 ms until the device informs of its readiness. */
1082 while (true) {
1083 if (++poll_attempts > 100) {
1084 dev_err(&dev->dev,
1085 "failed booting Motu MicroBook II: timeout\n");
1086 err = -ENODEV;
1087 goto free_buf;
1088 }
1089
1090 memset(buf, 0, MICROBOOK_BUF_SIZE);
1091 memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1092
1093 actual_length = sizeof(poll_ready_seq);
1094 err = snd_usb_motu_microbookii_communicate(
1095 dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1096 if (err < 0) {
1097 dev_err(&dev->dev,
1098 "failed booting Motu MicroBook II: communication error %d\n",
1099 err);
1100 goto free_buf;
1101 }
1102
1103 /* the device signals its readiness through a message of the
1104 * form
1105 * XX 06 00 00 00 00 0b 18 00 00 00 01
1106 * If the device is not yet ready to accept audio data, the
1107 * last byte of that sequence is 00.
1108 */
1109 if (actual_length == 12 && buf[actual_length - 1] == 1)
1110 break;
1111
1112 msleep(100);
1113 }
1114
1115 dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1116
1117free_buf:
1118 kfree(buf);
1119 return err;
1120}
1121
73ac9f5e
AT		 1122static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1123{
1124 int ret;
1125
73ac9f5e
AT		 1126 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1127 1, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
1128 0x0, 0, NULL, 0, 1000);
1129
1130 if (ret < 0)
1131 return ret;
1132
1133 msleep(2000);
1134
1135 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1136 1, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
1137 0x20, 0, NULL, 0, 1000);
1138
1139 if (ret < 0)
1140 return ret;
1141
1142 return 0;
1143}
1144
e5779998
DM		 1145/*
1146 * Setup quirks
1147 */
0f5733b0
GP		 1148#define MAUDIO_SET 0x01 /* parse device_setup */
1149#define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
1150#define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
5ff40e6d 1151#define MAUDIO_SET_96K 0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
0f5733b0
GP		 1152#define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
1153#define MAUDIO_SET_DI 0x10 /* enable Digital Input */
1154#define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
5ff40e6d
AT		 1155#define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48kHz+Digital Input */
1156#define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48kHz+No Digital Input */
1157#define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48kHz+Digital Input */
1158#define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48kHz+No Digital Input */
0f5733b0
GP		 1159
1160static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1161 int iface, int altno)
1162{
1163 /* Reset ALL ifaces to 0 altsetting.
1164 * Call it for every possible altsetting of every interface.
1165 */
1166 usb_set_interface(chip->dev, iface, 0);
1167 if (chip->setup & MAUDIO_SET) {
1168 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1169 if (iface != 1 && iface != 2)
1170 return 1; /* skip all interfaces but 1 and 2 */
1171 } else {
1172 unsigned int mask;
1173 if (iface == 1 || iface == 2)
1174 return 1; /* skip interfaces 1 and 2 */
1175 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1176 return 1; /* skip this altsetting */
1177 mask = chip->setup & MAUDIO_SET_MASK;
1178 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1179 return 1; /* skip this altsetting */
1180 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1181 return 1; /* skip this altsetting */
1182 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1183 return 1; /* skip this altsetting */
1184 }
1185 }
0ba41d91 1186 usb_audio_dbg(chip,
0f5733b0
GP		 1187 "using altsetting %d for interface %d config %d\n",
1188 altno, iface, chip->setup);
1189 return 0; /* keep this altsetting */
1190}
e5779998
DM		 1191
1192static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1193 int iface,
1194 int altno)
1195{
1196 /* Reset ALL ifaces to 0 altsetting.
1197 * Call it for every possible altsetting of every interface.
1198 */
1199 usb_set_interface(chip->dev, iface, 0);
1200
0f5733b0
GP		 1201 if (chip->setup & MAUDIO_SET) {
1202 unsigned int mask;
1203 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
e5779998 1204 return 1; /* skip this altsetting */
0f5733b0 1205 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
e5779998 1206 return 1; /* skip this altsetting */
0f5733b0
GP		 1207 mask = chip->setup & MAUDIO_SET_MASK;
1208 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
e5779998 1209 return 1; /* skip this altsetting */
0f5733b0 1210 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
e5779998 1211 return 1; /* skip this altsetting */
0f5733b0 1212 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
e5779998 1213 return 1; /* skip this altsetting */
0f5733b0 1214 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
e5779998
DM		 1215 return 1; /* skip this altsetting */
1216 }
1217
1218 return 0; /* keep this altsetting */
1219}
1220
0f5733b0
GP		 1221static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1222 int iface, int altno)
1223{
1224 /* Reset ALL ifaces to 0 altsetting.
1225 * Call it for every possible altsetting of every interface.
1226 */
1227 usb_set_interface(chip->dev, iface, 0);
1228
1229 /* possible configuration where both inputs and only one output is
1230 *used is not supported by the current setup
1231 */
1232 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1233 if (chip->setup & MAUDIO_SET_96K) {
1234 if (altno != 3 && altno != 6)
1235 return 1;
1236 } else if (chip->setup & MAUDIO_SET_DI) {
1237 if (iface == 4)
1238 return 1; /* no analog input */
1239 if (altno != 2 && altno != 5)
1240 return 1; /* enable only altsets 2 and 5 */
1241 } else {
1242 if (iface == 5)
1243 return 1; /* disable digialt input */
1244 if (altno != 2 && altno != 5)
1245 return 1; /* enalbe only altsets 2 and 5 */
1246 }
1247 } else {
1248 /* keep only 16-Bit mode */
1249 if (altno != 1)
1250 return 1;
1251 }
1252
0ba41d91 1253 usb_audio_dbg(chip,
0f5733b0
GP		 1254 "using altsetting %d for interface %d config %d\n",
1255 altno, iface, chip->setup);
1256 return 0; /* keep this altsetting */
1257}
1258
8dc5efe3
NK		 1259static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1260 int iface, int altno)
1261{
1262 /*
1263 * Altno settings:
1264 *
1265 * Playback (Interface 1):
1266 * 1: 6 Analog + 2 S/PDIF
1267 * 2: 6 Analog + 2 S/PDIF
1268 * 3: 6 Analog
1269 *
1270 * Capture (Interface 2):
1271 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1272 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1273 * 3: 8 Analog
1274 */
1275
1276 /*
1277 * I'll leave 2 as the default one and
1278 * use device_setup to switch to the
1279 * other two.
1280 */
1281 if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1282 return 1;
1283 else if (chip->setup == 1 && altno != 1)
1284 return 1;
1285 else if (chip->setup == 2 && altno != 3)
1286 return 1;
1287
1288 return 0;
1289}
1290
e5779998
DM		 1291int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1292 int iface,
1293 int altno)
1294{
1295 /* audiophile usb: skip altsets incompatible with device_setup */
1296 if (chip->usb_id == USB_ID(0x0763, 0x2003))
1297 return audiophile_skip_setting_quirk(chip, iface, altno);
0f5733b0
GP		 1298 /* quattro usb: skip altsets incompatible with device_setup */
1299 if (chip->usb_id == USB_ID(0x0763, 0x2001))
1300 return quattro_skip_setting_quirk(chip, iface, altno);
1301 /* fasttrackpro usb: skip altsets incompatible with device_setup */
1302 if (chip->usb_id == USB_ID(0x0763, 0x2012))
1303 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
8dc5efe3
NK		 1304 /* presonus studio 1810c: skip altsets incompatible with device_setup */
1305 if (chip->usb_id == USB_ID(0x0194f, 0x010c))
1306 return s1810c_skip_setting_quirk(chip, iface, altno);
1307
e5779998
DM		 1308
1309 return 0;
1310}
1311
1312int snd_usb_apply_boot_quirk(struct usb_device *dev,
1313 struct usb_interface *intf,
79289e24
TI		 1314 const struct snd_usb_audio_quirk *quirk,
1315 unsigned int id)
e5779998 1316{
3347b26c
DM		 1317 switch (id) {
1318 case USB_ID(0x041e, 0x3000):
1319 /* SB Extigy needs special boot-up sequence */
1320 /* if more models come, this will go to the quirk list. */
e5779998
DM		 1321 return snd_usb_extigy_boot_quirk(dev, intf);
1322
3347b26c
DM		 1323 case USB_ID(0x041e, 0x3020):
1324 /* SB Audigy 2 NX needs its own boot-up magic, too */
e5779998
DM		 1325 return snd_usb_audigy2nx_boot_quirk(dev);
1326
3347b26c
DM		 1327 case USB_ID(0x10f5, 0x0200):
1328 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
e5779998
DM		 1329 return snd_usb_cm106_boot_quirk(dev);
1330
3347b26c
DM		 1331 case USB_ID(0x0d8c, 0x0102):
1332 /* C-Media CM6206 / CM106-Like Sound Device */
8129e79e 1333 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
e5779998
DM		 1334 return snd_usb_cm6206_boot_quirk(dev);
1335
cb99864d
DZ		 1336 case USB_ID(0x0dba, 0x3000):
1337 /* Digidesign Mbox 2 */
1338 return snd_usb_mbox2_boot_quirk(dev);
1339
11e424e8
EG		 1340 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1341 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1342 return snd_usb_novation_boot_quirk(dev);
5e212332 1343
3347b26c
DM		 1344 case USB_ID(0x133e, 0x0815):
1345 /* Access Music VirusTI Desktop */
e5779998
DM		 1346 return snd_usb_accessmusic_boot_quirk(dev);
1347
759e890f 1348 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
3347b26c
DM		 1349 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1350 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
54a8c500 1351 return snd_usb_nativeinstruments_boot_quirk(dev);
0f5733b0
GP		 1352 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1353 return snd_usb_fasttrackpro_boot_quirk(dev);
19570d74
TI		 1354 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1355 return snd_usb_gamecon780_boot_quirk(dev);
16bafa79
AA		 1356 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1357 return snd_usb_axefx3_boot_quirk(dev);
a634090a 1358 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
2edb84e3
AT		 1359 /*
1360 * For some reason interface 3 with vendor-spec class is
1361 * detected on MicroBook IIc.
1362 */
1363 if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1364 USB_CLASS_VENDOR_SPEC &&
1365 get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1366 return snd_usb_motu_microbookii_boot_quirk(dev);
1367 break;
3347b26c 1368 }
54a8c500 1369
e5779998
DM		 1370 return 0;
1371}
1372
73ac9f5e
AT		 1373int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1374 struct usb_interface *intf,
1375 const struct snd_usb_audio_quirk *quirk,
1376 unsigned int id)
1377{
1378 switch (id) {
1379 case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
1380 return snd_usb_motu_m_series_boot_quirk(dev);
1381 }
1382
1383 return 0;
1384}
1385
e5779998
DM		 1386/*
1387 * check if the device uses big-endian samples
1388 */
1389int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
1390{
48fc7f7e 1391 /* it depends on altsetting whether the device is big-endian or not */
e5779998
DM		 1392 switch (chip->usb_id) {
1393 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
0f5733b0
GP		 1394 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1395 fp->altsetting == 5 || fp->altsetting == 6)
e5779998
DM		 1396 return 1;
1397 break;
1398 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1399 if (chip->setup == 0x00 ||
0f5733b0
GP		 1400 fp->altsetting == 1 || fp->altsetting == 2 ||
1401 fp->altsetting == 3)
1402 return 1;
1403 break;
1404 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1405 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1406 fp->altsetting == 5 || fp->altsetting == 6)
e5779998 1407 return 1;
0f5733b0 1408 break;
e5779998
DM		 1409 }
1410 return 0;
1411}
1412
1413/*
1cdfa9f3 1414 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
e5779998
DM		 1415 * not for interface.
1416 */
1417
1418enum {
1419 EMU_QUIRK_SR_44100HZ = 0,
1420 EMU_QUIRK_SR_48000HZ,
1421 EMU_QUIRK_SR_88200HZ,
1422 EMU_QUIRK_SR_96000HZ,
1423 EMU_QUIRK_SR_176400HZ,
1424 EMU_QUIRK_SR_192000HZ
1425};
1426
1427static void set_format_emu_quirk(struct snd_usb_substream *subs,
1428 struct audioformat *fmt)
1429{
1430 unsigned char emu_samplerate_id = 0;
1431
1432 /* When capture is active
1433 * sample rate shouldn't be changed
1434 * by playback substream
1435 */
1436 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1437 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
1438 return;
1439 }
1440
1441 switch (fmt->rate_min) {
1442 case 48000:
1443 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1444 break;
1445 case 88200:
1446 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1447 break;
1448 case 96000:
1449 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1450 break;
1451 case 176400:
1452 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1453 break;
1454 case 192000:
1455 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1456 break;
1457 default:
1458 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1459 break;
1460 }
1461 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1539d4f8 1462 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
e5779998
DM		 1463}
1464
7fccfecf
DP		 1465
1466/*
1467 * Pioneer DJ DJM-900NXS2
1468 * Device needs to know the sample rate each time substream is started
1469 */
1470static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs)
1471{
1472
1473 /* Convert sample rate value to little endian */
1474 u8 sr[3];
1475
1476 sr[0] = subs->cur_rate & 0xff;
1477 sr[1] = (subs->cur_rate >> 8) & 0xff;
1478 sr[2] = (subs->cur_rate >> 16) & 0xff;
1479
1480 /* Configure device */
1481 usb_set_interface(subs->dev, 0, 1);
1482 snd_usb_ctl_msg(subs->stream->chip->dev,
1483 usb_rcvctrlpipe(subs->stream->chip->dev, 0),
1484 0x01, 0x22, 0x0100, 0x0082, &sr, 0x0003);
1485
1486 return 0;
1487}
1488
e5779998
DM		 1489void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1490 struct audioformat *fmt)
1491{
1492 switch (subs->stream->chip->usb_id) {
1493 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1494 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1495 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1cdfa9f3 1496 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
e5779998
DM		 1497 set_format_emu_quirk(subs, fmt);
1498 break;
7fccfecf 1499 case USB_ID(0x2b73, 0x000a): /* Pioneer DJ DJM-900NXS2 */
14335d8b 1500 case USB_ID(0x2b73, 0x0017): /* Pioneer DJ DJM-250MK2 */
7fccfecf
DP		 1501 pioneer_djm_set_format_quirk(subs);
1502 break;
1b7ecc24
HM		 1503 case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1504 subs->stream_offset_adj = 2;
1505 break;
e5779998
DM		 1506 }
1507}
1508
b62b9980
JT		 1509bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1510{
9fc88ad6
EW		 1511 /* devices which do not support reading the sample rate. */
1512 switch (chip->usb_id) {
8be03a71
TI		 1513 case USB_ID(0x041e, 0x4080): /* Creative Live Cam VF0610 */
1514 case USB_ID(0x04d8, 0xfeea): /* Benchmark DAC1 Pre */
84add303 1515 case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
8be03a71 1516 case USB_ID(0x05a3, 0x9420): /* ELP HD USB Camera */
51d4efab 1517 case USB_ID(0x05a7, 0x1020): /* Bose Companion 5 */
8be03a71 1518 case USB_ID(0x074d, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
a8e800fe 1519 case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
83d9956b 1520 case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
8be03a71 1521 case USB_ID(0x21b4, 0x0081): /* AudioQuest DragonFly */
93f9d1a4 1522 case USB_ID(0x2912, 0x30c8): /* Audioengine D1 */
9fc88ad6
EW		 1523 return true;
1524 }
a6aa6cdc
TI		 1525
1526 /* devices of these vendors don't support reading rate, either */
1527 switch (USB_ID_VENDOR(chip->usb_id)) {
8be03a71
TI		 1528 case 0x045e: /* MS Lifecam */
1529 case 0x047f: /* Plantronics */
a6aa6cdc
TI		 1530 case 0x1de7: /* Phoenix Audio */
1531 return true;
1532 }
1533
9fc88ad6 1534 return false;
b62b9980 1535}
6874daad 1536
71426535 1537/* ITF-USB DSD based DACs need a vendor cmd to switch
6874daad
JK		 1538 * between PCM and native DSD mode
1539 */
f3b906d7 1540static bool is_itf_usb_dsd_dac(unsigned int id)
8b28c93f 1541{
f3b906d7 1542 switch (id) {
c9808bbf 1543 case USB_ID(0x154e, 0x1002): /* Denon DCD-1500RE */
8b28c93f
TI		 1544 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1545 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1546 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
71426535 1547 case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
f3b906d7 1548 case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
866f7ed7 1549 case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
b0021486 1550 case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
7f38ca04
NO		 1551 return true;
1552 }
1553 return false;
1554}
1555
d767aba2 1556int snd_usb_select_mode_quirk(struct snd_usb_audio *chip,
6874daad
JK		 1557 struct audioformat *fmt)
1558{
d767aba2 1559 struct usb_device *dev = chip->dev;
6874daad
JK		 1560 int err;
1561
d767aba2 1562 if (is_itf_usb_dsd_dac(chip->usb_id)) {
6874daad
JK		 1563 /* First switch to alt set 0, otherwise the mode switch cmd
1564 * will not be accepted by the DAC
1565 */
1566 err = usb_set_interface(dev, fmt->iface, 0);
1567 if (err < 0)
1568 return err;
1569
df3f0347 1570 msleep(20); /* Delay needed after setting the interface */
6874daad 1571
7f38ca04 1572 /* Vendor mode switch cmd is required. */
f3b906d7
NO		 1573 if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1574 /* DSD mode (DSD_U32) requested */
7f38ca04
NO		 1575 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1576 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1577 1, 1, NULL, 0);
1578 if (err < 0)
1579 return err;
7f38ca04 1580
f3b906d7
NO		 1581 } else {
1582 /* PCM or DOP mode (S32) requested */
1583 /* PCM mode (S16) requested */
7f38ca04
NO		 1584 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1585 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1586 0, 1, NULL, 0);
1587 if (err < 0)
1588 return err;
f3b906d7 1589
7f38ca04 1590 }
df3f0347 1591 msleep(20);
6874daad
JK		 1592 }
1593 return 0;
1594}
1595
2b58fd5b
DM		 1596void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1597{
1598 /*
1599 * "Playback Design" products send bogus feedback data at the start
1600 * of the stream. Ignore them.
1601 */
79289e24 1602 if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
2b58fd5b
DM		 1603 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1604 ep->skip_packets = 4;
83e3acd4
EZ		 1605
1606 /*
e9a25e04 1607 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
5ff40e6d 1608 * world latency varies by approx. +/- 50 frames (at 96kHz) each time
e9a25e04
MG		 1609 * the stream is (re)started. When skipping packets 16 at endpoint
1610 * start up, the real world latency is stable within +/- 1 frame (also
83e3acd4
EZ		 1611 * across power cycles).
1612 */
e9a25e04
MG		 1613 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1614 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
83e3acd4
EZ		 1615 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1616 ep->skip_packets = 16;
9abc1341
DM		 1617
1618 /* Work around devices that report unreasonable feedback data */
ca0dd273
DM		 1619 if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */
1620 ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
9abc1341 1621 ep->syncmaxsize == 4)
ca0dd273 1622 ep->tenor_fb_quirk = 1;
2b58fd5b
DM		 1623}
1624
d767aba2 1625void snd_usb_set_interface_quirk(struct snd_usb_audio *chip)
21bb5aaf 1626{
79289e24
TI		 1627 if (!chip)
1628 return;
21bb5aaf
DM		 1629 /*
1630 * "Playback Design" products need a 50ms delay after setting the
1631 * USB interface.
1632 */
79289e24 1633 switch (USB_ID_VENDOR(chip->usb_id)) {
5a4ff9ec
GF		 1634 case 0x23ba: /* Playback Design */
1635 case 0x0644: /* TEAC Corp. */
df3f0347 1636 msleep(50);
5a4ff9ec
GF		 1637 break;
1638 }
21bb5aaf
DM		 1639}
1640
79289e24 1641/* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
2b58fd5b
DM		 1642void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1643 __u8 request, __u8 requesttype, __u16 value,
1644 __u16 index, void *data, __u16 size)
1645{
79289e24
TI		 1646 struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1647
1648 if (!chip)
1649 return;
2b58fd5b
DM		 1650 /*
1651 * "Playback Design" products need a 20ms delay after each
1652 * class compliant request
1653 */
79289e24 1654 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
2b58fd5b 1655 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
df3f0347 1656 msleep(20);
6e84a8d7 1657
5a4ff9ec
GF		 1658 /*
1659 * "TEAC Corp." products need a 20ms delay after each
1660 * class compliant request
1661 */
79289e24 1662 if (USB_ID_VENDOR(chip->usb_id) == 0x0644 &&
5a4ff9ec 1663 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
df3f0347 1664 msleep(20);
5a4ff9ec 1665
71426535 1666 /* ITF-USB DSD based DACs functionality need a delay
6e84a8d7
JK		 1667 * after each class compliant request
1668 */
f3b906d7 1669 if (is_itf_usb_dsd_dac(chip->usb_id)
8b28c93f 1670 && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
df3f0347 1671 msleep(20);
dacacb0a 1672
54a2a389
JT		 1673 /* Zoom R16/24, many Logitech(at least H650e/H570e/BCC950),
1674 * Jabra 550a, Kingston HyperX needs a tiny delay here,
1675 * otherwise requests like get/set frequency return
1676 * as failed despite actually succeeding.
dacacb0a 1677 */
07b3b5e9 1678 if ((chip->usb_id == USB_ID(0x1686, 0x00dd) ||
54a2a389 1679 USB_ID_VENDOR(chip->usb_id) == 0x046d || /* Logitech */
073919e0
JR		 1680 chip->usb_id == USB_ID(0x0b0e, 0x0349) ||
1681 chip->usb_id == USB_ID(0x0951, 0x16ad)) &&
dacacb0a 1682 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
df3f0347 1683 usleep_range(1000, 2000);
a32a1fc9
ML		 1684
1685 /*
1686 * Samsung USBC Headset (AKG) need a tiny delay after each
1687 * class compliant request. (Model number: AAM625R or AAM627R)
1688 */
1689 if (chip->usb_id == USB_ID(0x04e8, 0xa051) &&
1690 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1691 usleep_range(5000, 6000);
2b58fd5b
DM		 1692}
1693
126825e7
DM		 1694/*
1695 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1696 * augment the PCM format bit-field for DSD types. The UAC standards
1697 * don't have a designated bit field to denote DSD-capable interfaces,
1698 * hence all hardware that is known to support this format has to be
1699 * listed here.
1700 */
1701u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1702 struct audioformat *fp,
1703 unsigned int sample_bytes)
1704{
f3b906d7
NO		 1705 struct usb_interface *iface;
1706
126825e7 1707 /* Playback Designs */
eb7505d5
JL		 1708 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1709 USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
126825e7
DM		 1710 switch (fp->altsetting) {
1711 case 1:
1712 fp->dsd_dop = true;
1713 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1714 case 2:
1715 fp->dsd_bitrev = true;
1716 return SNDRV_PCM_FMTBIT_DSD_U8;
1717 case 3:
1718 fp->dsd_bitrev = true;
1719 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1720 }
1721 }
1722
848f3a82
JK		 1723 /* XMOS based USB DACs */
1724 switch (chip->usb_id) {
f656891c 1725 case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
f656891c 1726 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
9bb201a5 1727 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
848f3a82 1728 if (fp->altsetting == 2)
d42472ec 1729 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
848f3a82 1730 break;
3b7e5c7e 1731
f656891c 1732 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
202e69e6 1733 case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
547d2c9c 1734 case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
202e69e6 1735 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
f656891c
DM		 1736 case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1737 case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1738 case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
f656891c
DM		 1739 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1740 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
ad678b4c 1741 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
f656891c
DM		 1742 case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1743 case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1744 case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1745 case USB_ID(0x6b42, 0x0042): /* MSB Technology */
848f3a82 1746 if (fp->altsetting == 3)
d42472ec 1747 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
848f3a82 1748 break;
3eff682d 1749
7c74866b
DM		 1750 /* Amanero Combo384 USB based DACs with native DSD support */
1751 case USB_ID(0x16d0, 0x071a): /* Amanero - Combo384 */
1752 case USB_ID(0x2ab6, 0x0004): /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1753 case USB_ID(0x2ab6, 0x0005): /* T+A USB HD Audio 1 */
1754 case USB_ID(0x2ab6, 0x0006): /* T+A USB HD Audio 2 */
3eff682d 1755 if (fp->altsetting == 2) {
f83914fd 1756 switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
3eff682d
JL		 1757 case 0x199:
1758 return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1759 case 0x19b:
f5ce8179 1760 case 0x203:
3eff682d
JL		 1761 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1762 default:
1763 break;
1764 }
1765 }
1766 break;
ed993c6f
JL		 1767 case USB_ID(0x16d0, 0x0a23):
1768 if (fp->altsetting == 2)
1769 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1770 break;
3eff682d 1771
848f3a82
JK		 1772 default:
1773 break;
1774 }
1775
f3b906d7
NO		 1776 /* ITF-USB DSD based DACs */
1777 if (is_itf_usb_dsd_dac(chip->usb_id)) {
1778 iface = usb_ifnum_to_if(chip->dev, fp->iface);
7a2e9ddc 1779
f3b906d7
NO		 1780 /* Altsetting 2 support native DSD if the num of altsets is
1781 * three (0-2),
1782 * Altsetting 3 support native DSD if the num of altsets is
1783 * four (0-3).
1784 */
1785 if (fp->altsetting == iface->num_altsetting - 1)
7f38ca04
NO		 1786 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1787 }
1788
3a572d94
JL		 1789 /* Mostly generic method to detect many DSD-capable implementations -
1790 * from XMOS/Thesycon
1791 */
1792 switch (USB_ID_VENDOR(chip->usb_id)) {
1ea0358e 1793 case 0x152a: /* Thesycon devices */
eb7505d5 1794 case 0x20b1: /* XMOS based devices */
0067e154 1795 case 0x22d9: /* Oppo */
eb7505d5 1796 case 0x23ba: /* Playback Designs */
3a572d94 1797 case 0x25ce: /* Mytek devices */
0067e154 1798 case 0x278b: /* Rotel? */
e2995b95 1799 case 0x292b: /* Gustard/Ess based devices */
3bff2407 1800 case 0x2ab6: /* T+A devices */
07815a2b 1801 case 0x3353: /* Khadas devices */
f41f9005 1802 case 0x3842: /* EVGA */
029d2c0f 1803 case 0xc502: /* HiBy devices */
3a572d94
JL		 1804 if (fp->dsd_raw)
1805 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1806 break;
1807 default:
1808 break;
1809
1810 }
1811
126825e7
DM		 1812 return 0;
1813}
ceb18f51
RB		 1814
1815void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1816 struct audioformat *fp,
1817 int stream)
1818{
1819 switch (chip->usb_id) {
1820 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1821 /* Optoplay sets the sample rate attribute although
1822 * it seems not supporting it in fact.
1823 */
1824 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
1825 break;
1826 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1827 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1828 /* doesn't set the sample rate attribute, but supports it */
1829 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
1830 break;
1831 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
1832 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1833 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1834 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1835 an older model 77d:223) */
1836 /*
1837 * plantronics headset and Griffin iMic have set adaptive-in
1838 * although it's really not...
1839 */
1840 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
1841 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
1842 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
1843 else
1844 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
1845 break;
2edb84e3
AT		 1846 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook IIc */
1847 /*
1848 * MaxPacketsOnly attribute is erroneously set in endpoint
1849 * descriptors. As a result this card produces noise with
5ff40e6d 1850 * all sample rates other than 96 kHz.
2edb84e3
AT		 1851 */
1852 fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
1853 break;
ceb18f51
RB		 1854 }
1855}
55f73261 1856
d8695bc5
TI		 1857/*
1858 * registration quirk:
1859 * the registration is skipped if a device matches with the given ID,
1860 * unless the interface reaches to the defined one. This is for delaying
1861 * the registration until the last known interface, so that the card and
1862 * devices appear at the same time.
1863 */
1864
1865struct registration_quirk {
1866 unsigned int usb_id; /* composed via USB_ID() */
1867 unsigned int interface; /* the interface to trigger register */
1868};
1869
1870#define REG_QUIRK_ENTRY(vendor, product, iface) \
1871 { .usb_id = USB_ID(vendor, product), .interface = (iface) }
1872
1873static const struct registration_quirk registration_quirks[] = {
1874 REG_QUIRK_ENTRY(0x0951, 0x16d8, 2), /* Kingston HyperX AMP */
fd60e068 1875 REG_QUIRK_ENTRY(0x0951, 0x16ed, 2), /* Kingston HyperX Cloud Alpha S */
73094608 1876 REG_QUIRK_ENTRY(0x0951, 0x16ea, 2), /* Kingston HyperX Cloud Flight S */
d8695bc5
TI		 1877 { 0 } /* terminator */
1878};
1879
1880/* return true if skipping registration */
1881bool snd_usb_registration_quirk(struct snd_usb_audio *chip, int iface)
55f73261 1882{
d8695bc5
TI		 1883 const struct registration_quirk *q;
1884
1885 for (q = registration_quirks; q->usb_id; q++)
1886 if (chip->usb_id == q->usb_id)
1887 return iface != q->interface;
1888
55f73261 1889 /* Register as normal */
d8695bc5 1890 return false;
55f73261 1891}
Linux 6.x block layer and io_uring tree(s)