1 // SPDX-License-Identifier: GPL-2.0-or-later
5 #include <linux/init.h>
6 #include <linux/slab.h>
8 #include <linux/usb/audio.h>
9 #include <linux/usb/midi.h>
10 #include <linux/bits.h>
12 #include <sound/control.h>
13 #include <sound/core.h>
14 #include <sound/info.h>
15 #include <sound/pcm.h>
20 #include "mixer_quirks.h"
30 * handle the quirks for the contained interfaces
32 static int create_composite_quirk(struct snd_usb_audio *chip,
33 struct usb_interface *iface,
34 struct usb_driver *driver,
35 const struct snd_usb_audio_quirk *quirk_comp)
37 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
38 const struct snd_usb_audio_quirk *quirk;
41 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
42 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
45 if (quirk->ifnum != probed_ifnum &&
46 usb_interface_claimed(iface))
48 err = snd_usb_create_quirk(chip, iface, driver, quirk);
53 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
54 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
57 if (quirk->ifnum != probed_ifnum &&
58 !usb_interface_claimed(iface))
59 usb_driver_claim_interface(driver, iface, (void *)-1L);
65 static int ignore_interface_quirk(struct snd_usb_audio *chip,
66 struct usb_interface *iface,
67 struct usb_driver *driver,
68 const struct snd_usb_audio_quirk *quirk)
75 * Allow alignment on audio sub-slot (channel samples) rather than
76 * on audio slots (audio frames)
78 static int create_align_transfer_quirk(struct snd_usb_audio *chip,
79 struct usb_interface *iface,
80 struct usb_driver *driver,
81 const struct snd_usb_audio_quirk *quirk)
84 return 1; /* Continue with creating streams and mixer */
87 static int create_any_midi_quirk(struct snd_usb_audio *chip,
88 struct usb_interface *intf,
89 struct usb_driver *driver,
90 const struct snd_usb_audio_quirk *quirk)
92 return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
96 * create a stream for an interface with proper descriptors
98 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
99 struct usb_interface *iface,
100 struct usb_driver *driver,
101 const struct snd_usb_audio_quirk *quirk)
103 struct usb_host_interface *alts;
104 struct usb_interface_descriptor *altsd;
107 if (chip->usb_id == USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
108 chip->tx_length_quirk = 1;
110 alts = &iface->altsetting[0];
111 altsd = get_iface_desc(alts);
112 err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
114 usb_audio_err(chip, "cannot setup if %d: error %d\n",
115 altsd->bInterfaceNumber, err);
118 /* reset the current interface */
119 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
124 * create a stream for an endpoint/altsetting without proper descriptors
126 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
127 struct usb_interface *iface,
128 struct usb_driver *driver,
129 const struct snd_usb_audio_quirk *quirk)
131 struct audioformat *fp;
132 struct usb_host_interface *alts;
133 struct usb_interface_descriptor *altsd;
135 unsigned *rate_table = NULL;
137 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
141 INIT_LIST_HEAD(&fp->list);
142 if (fp->nr_rates > MAX_NR_RATES) {
146 if (fp->nr_rates > 0) {
147 rate_table = kmemdup(fp->rate_table,
148 sizeof(int) * fp->nr_rates, GFP_KERNEL);
153 fp->rate_table = rate_table;
156 stream = (fp->endpoint & USB_DIR_IN)
157 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
158 err = snd_usb_add_audio_stream(chip, stream, fp);
161 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
162 fp->altset_idx >= iface->num_altsetting) {
166 alts = &iface->altsetting[fp->altset_idx];
167 altsd = get_iface_desc(alts);
168 if (altsd->bNumEndpoints < 1) {
173 fp->protocol = altsd->bInterfaceProtocol;
175 if (fp->datainterval == 0)
176 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
177 if (fp->maxpacksize == 0)
178 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
179 usb_set_interface(chip->dev, fp->iface, 0);
180 snd_usb_init_pitch(chip, fp);
181 snd_usb_init_sample_rate(chip, fp, fp->rate_max);
185 list_del(&fp->list); /* unlink for avoiding double-free */
191 static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
192 struct usb_interface *iface,
193 struct usb_driver *driver)
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;
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.
208 /* must have a non-zero altsetting for streaming */
209 if (iface->num_altsetting < 2)
211 alts = &iface->altsetting[1];
212 altsd = get_iface_desc(alts);
214 /* must have an isochronous endpoint for streaming */
215 if (altsd->bNumEndpoints < 1)
217 epd = get_endpoint(alts, 0);
218 if (!usb_endpoint_xfer_isoc(epd))
221 /* must have format descriptors */
222 ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
224 fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
226 if (!ashd || ashd->bLength < 7 ||
227 !fmtd || fmtd->bLength < 8)
230 return create_standard_audio_quirk(chip, iface, driver, NULL);
233 static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
234 struct usb_interface *iface,
235 struct usb_driver *driver,
236 struct usb_host_interface *alts)
238 static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
239 .type = QUIRK_MIDI_YAMAHA
241 struct usb_midi_in_jack_descriptor *injd;
242 struct usb_midi_out_jack_descriptor *outjd;
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);
251 if ((injd && !snd_usb_validate_midi_desc(injd)) ||
252 (outjd && !snd_usb_validate_midi_desc(outjd)))
254 if (injd && (injd->bLength < 5 ||
255 (injd->bJackType != USB_MS_EMBEDDED &&
256 injd->bJackType != USB_MS_EXTERNAL)))
258 if (outjd && (outjd->bLength < 6 ||
259 (outjd->bJackType != USB_MS_EMBEDDED &&
260 outjd->bJackType != USB_MS_EXTERNAL)))
262 return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
265 static 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)
270 static const struct snd_usb_audio_quirk roland_midi_quirk = {
271 .type = QUIRK_MIDI_ROLAND
273 u8 *roland_desc = NULL;
275 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
277 roland_desc = snd_usb_find_csint_desc(alts->extra,
282 if (roland_desc[0] < 6 || roland_desc[3] != 2)
284 return create_any_midi_quirk(chip, iface, driver,
289 static 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)
294 struct usb_ms_header_descriptor *mshd;
295 struct usb_ms_endpoint_descriptor *msepd;
297 /* must have the MIDIStreaming interface header descriptor*/
298 mshd = (struct usb_ms_header_descriptor *)alts->extra;
299 if (alts->extralen < 7 ||
301 mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
302 mshd->bDescriptorSubtype != USB_MS_HEADER)
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)
314 return create_any_midi_quirk(chip, iface, driver, NULL);
317 static int create_auto_midi_quirk(struct snd_usb_audio *chip,
318 struct usb_interface *iface,
319 struct usb_driver *driver)
321 struct usb_host_interface *alts;
322 struct usb_interface_descriptor *altsd;
323 struct usb_endpoint_descriptor *epd;
326 alts = &iface->altsetting[0];
327 altsd = get_iface_desc(alts);
329 /* must have at least one bulk/interrupt endpoint for streaming */
330 if (altsd->bNumEndpoints < 1)
332 epd = get_endpoint(alts, 0);
333 if (!usb_endpoint_xfer_bulk(epd) &&
334 !usb_endpoint_xfer_int(epd))
337 switch (USB_ID_VENDOR(chip->usb_id)) {
338 case 0x0499: /* Yamaha */
339 err = create_yamaha_midi_quirk(chip, iface, driver, alts);
343 case 0x0582: /* Roland */
344 err = create_roland_midi_quirk(chip, iface, driver, alts);
350 return create_std_midi_quirk(chip, iface, driver, alts);
353 static int create_autodetect_quirk(struct snd_usb_audio *chip,
354 struct usb_interface *iface,
355 struct usb_driver *driver)
359 err = create_auto_pcm_quirk(chip, iface, driver);
361 err = create_auto_midi_quirk(chip, iface, driver);
365 static 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)
370 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
371 int ifcount, ifnum, err;
373 err = create_autodetect_quirk(chip, iface, driver);
378 * ALSA PCM playback/capture devices cannot be registered in two steps,
379 * so we have to claim the other corresponding interface here.
381 ifcount = chip->dev->actconfig->desc.bNumInterfaces;
382 for (ifnum = 0; ifnum < ifcount; ifnum++) {
383 if (ifnum == probed_ifnum || quirk->ifnum >= 0)
385 iface = usb_ifnum_to_if(chip->dev, ifnum);
387 usb_interface_claimed(iface) ||
388 get_iface_desc(iface->altsetting)->bInterfaceClass !=
389 USB_CLASS_VENDOR_SPEC)
392 err = create_autodetect_quirk(chip, iface, driver);
394 usb_driver_claim_interface(driver, iface, (void *)-1L);
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.
404 static 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)
409 static const struct audioformat ua_format = {
410 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
412 .fmt_type = UAC_FORMAT_TYPE_I,
415 .rates = SNDRV_PCM_RATE_CONTINUOUS,
417 struct usb_host_interface *alts;
418 struct usb_interface_descriptor *altsd;
419 struct audioformat *fp;
422 /* both PCM and MIDI interfaces have 2 or more altsettings */
423 if (iface->num_altsetting < 2)
425 alts = &iface->altsetting[1];
426 altsd = get_iface_desc(alts);
428 if (altsd->bNumEndpoints == 2) {
429 static const struct snd_usb_midi_endpoint_info ua700_ep = {
430 .out_cables = 0x0003,
433 static const struct snd_usb_audio_quirk ua700_quirk = {
434 .type = QUIRK_MIDI_FIXED_ENDPOINT,
437 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
438 .out_cables = 0x0001,
441 static const struct snd_usb_audio_quirk uaxx_quirk = {
442 .type = QUIRK_MIDI_FIXED_ENDPOINT,
445 const struct snd_usb_audio_quirk *quirk =
446 chip->usb_id == USB_ID(0x0582, 0x002b)
447 ? &ua700_quirk : &uaxx_quirk;
448 return __snd_usbmidi_create(chip->card, iface,
449 &chip->midi_list, quirk,
453 if (altsd->bNumEndpoints != 1)
456 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
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);
465 INIT_LIST_HEAD(&fp->list);
467 switch (fp->maxpacksize) {
469 fp->rate_max = fp->rate_min = 44100;
473 fp->rate_max = fp->rate_min = 48000;
477 fp->rate_max = fp->rate_min = 96000;
480 usb_audio_err(chip, "unknown sample rate\n");
485 stream = (fp->endpoint & USB_DIR_IN)
486 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
487 err = snd_usb_add_audio_stream(chip, stream, fp);
489 list_del(&fp->list); /* unlink for avoiding double-free */
493 usb_set_interface(chip->dev, fp->iface, 0);
498 * Create a standard mixer for the specified interface.
500 static 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)
505 if (quirk->ifnum < 0)
508 return snd_usb_create_mixer(chip, quirk->ifnum, 0);
511 static 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)
516 driver->supports_autosuspend = 0;
517 return 1; /* Continue with creating streams and mixer */
521 * audio-interface quirks
523 * returns zero if no standard audio/MIDI parsing is needed.
524 * returns a positive value if standard audio/midi interfaces are parsed
526 * returns a negative value at error.
528 int 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)
533 typedef int (*quirk_func_t)(struct snd_usb_audio *,
534 struct usb_interface *,
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,
540 [QUIRK_AUTODETECT] = create_autodetect_quirks,
541 [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,
544 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
545 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
546 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
547 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
548 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
549 [QUIRK_MIDI_CME] = create_any_midi_quirk,
550 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
551 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
552 [QUIRK_MIDI_CH345] = create_any_midi_quirk,
553 [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,
556 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
557 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
558 [QUIRK_SETUP_DISABLE_AUTOSUSPEND] = setup_disable_autosuspend,
561 if (quirk->type < QUIRK_TYPE_COUNT) {
562 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
564 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
573 #define EXTIGY_FIRMWARE_SIZE_OLD 794
574 #define EXTIGY_FIRMWARE_SIZE_NEW 483
576 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
578 struct usb_host_config *config = dev->actconfig;
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) {
583 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
584 /* Send message to force it to reconnect with full interface. */
585 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
586 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
588 dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
589 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
590 &dev->descriptor, sizeof(dev->descriptor));
591 config = dev->actconfig;
593 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
594 err = usb_reset_configuration(dev);
596 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
597 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
598 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
599 return -ENODEV; /* quit this anyway */
604 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
608 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
609 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
612 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
613 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
620 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
624 if (dev->actconfig->desc.bConfigurationValue == 1) {
626 "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
632 err = usb_driver_set_configuration(dev, 2);
635 "error usb_driver_set_configuration: %d\n",
637 /* Always return an error, so that we stop creating a device
638 that will just be destroyed and recreated with a new
642 dev_info(&dev->dev, "Fast Track Pro config OK\n");
648 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
649 * documented in the device's data sheet.
651 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
655 buf[1] = value & 0xff;
656 buf[2] = (value >> 8) & 0xff;
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,
663 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
666 * Enable line-out driver mode, set headphone source to front
667 * channels, enable stereo mic.
669 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
673 * CM6206 registers from the CM6206 datasheet rev 2.1
675 #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)
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)
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)
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)
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
756 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
761 * Values here are chosen based on sniffing USB traffic
764 * REG0: DAC is master, sample rate 48kHz, no copyright
766 CM6206_REG0_SPDIFO_RATE_48K |
767 CM6206_REG0_SPDIFO_COPYRIGHT_NA,
769 * REG1: PLL binary search enable, soft mute enable.
771 CM6206_REG1_PLLBIN_EN |
772 CM6206_REG1_SOFT_MUTE_EN,
774 * REG2: enable output drivers,
775 * select front channels to the headphone output,
776 * then mute the headphone channels, run the MCU
779 CM6206_REG2_DRIVER_ON |
780 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
781 CM6206_REG2_MUTE_HEADPHONE_RIGHT |
782 CM6206_REG2_MUTE_HEADPHONE_LEFT,
784 * REG3: default flyspeed, set 2.5V mic bias
785 * enable all line out ports and enable SPDIF
787 CM6206_REG3_FLYSPEED_DEFAULT |
788 CM6206_REG3_VRAP25EN |
794 CM6206_REG3_SPDIFI_CANREC,
795 /* REG4 is just a bunch of GPIO lines */
797 /* REG5: de-assert AD/DA reset signals */
798 CM6206_REG5_DA_RSTN |
799 CM6206_REG5_AD_RSTN };
801 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
802 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
810 /* quirk for Plantronics GameCom 780 with CM6302 chip */
811 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
813 /* set the initial volume and don't change; other values are either
814 * too loud or silent due to firmware bug (bko#65251)
816 u8 buf[2] = { 0x74, 0xe3 };
817 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);
823 * Novation Twitch DJ controller
824 * Focusrite Novation Saffire 6 USB audio card
826 static int snd_usb_novation_boot_quirk(struct usb_device *dev)
828 /* preemptively set up the device because otherwise the
829 * raw MIDI endpoints are not active */
830 usb_set_interface(dev, 0, 1);
835 * 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
841 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
843 int err, actual_length;
844 /* "midi send" enable */
845 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
848 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
850 buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
853 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
854 ARRAY_SIZE(seq), &actual_length, 1000);
863 * 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.
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.
873 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
877 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
878 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
879 1, 0, NULL, 0, 1000);
884 usb_reset_device(dev);
886 /* return -EAGAIN, so the creation of an audio interface for this
887 * temporary device is aborted. The device will reconnect with a
892 static void mbox2_setup_48_24_magic(struct usb_device *dev)
897 /* Choose 48000Hz permanently */
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);
914 /* Digidesign Mbox 2 needs to load firmware onboard
915 * and driver must wait a few seconds for initialisation.
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 */
922 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
924 struct usb_host_config *config = dev->actconfig;
926 u8 bootresponse[0x12];
930 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
932 if (fwsize != MBOX2_FIRMWARE_SIZE) {
933 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
937 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
940 bootresponse[0] = MBOX2_BOOT_LOADING;
941 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
942 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);
946 if (bootresponse[0] == MBOX2_BOOT_READY)
948 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
952 if (bootresponse[0] != MBOX2_BOOT_READY) {
953 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
957 dev_dbg(&dev->dev, "device initialised!\n");
959 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
960 &dev->descriptor, sizeof(dev->descriptor));
961 config = dev->actconfig;
963 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
965 err = usb_reset_configuration(dev);
967 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
968 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
969 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
971 mbox2_setup_48_24_magic(dev);
973 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
975 return 0; /* Successful boot */
978 static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
982 dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
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
989 err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
990 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
991 1, 1, NULL, 0, 120000);
994 "failed waiting for Axe-Fx III to boot: %d\n", err);
998 dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
1000 err = usb_set_interface(dev, 1, 0);
1003 "error stopping Axe-Fx III interface: %d\n", err);
1009 #define MICROBOOK_BUF_SIZE 128
1011 static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1012 int buf_size, int *length)
1014 int err, actual_length;
1016 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
1018 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1019 &actual_length, 1000);
1023 print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1024 buf, actual_length, false);
1026 memset(buf, 0, buf_size);
1028 if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
1030 err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1031 &actual_length, 1000);
1035 print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1036 buf, actual_length, false);
1038 *length = actual_length;
1042 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
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);
1055 dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
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,
1065 "failed setting the sample rate for Motu MicroBook II: %d\n",
1070 /* Then we poll every 100 ms until the device informs of its readiness. */
1072 if (++poll_attempts > 100) {
1074 "failed booting Motu MicroBook II: timeout\n");
1079 memset(buf, 0, MICROBOOK_BUF_SIZE);
1080 memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1082 actual_length = sizeof(poll_ready_seq);
1083 err = snd_usb_motu_microbookii_communicate(
1084 dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1087 "failed booting Motu MicroBook II: communication error %d\n",
1092 /* the device signals its readiness through a message of the
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.
1098 if (actual_length == 12 && buf[actual_length - 1] == 1)
1104 dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1111 static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1121 #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 */
1124 #define MAUDIO_SET_96K 0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
1125 #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 */
1128 #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 */
1133 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1134 int iface, int altno)
1136 /* Reset ALL ifaces to 0 altsetting.
1137 * Call it for every possible altsetting of every interface.
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 */
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 */
1160 "using altsetting %d for interface %d config %d\n",
1161 altno, iface, chip->setup);
1162 return 0; /* keep this altsetting */
1165 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1169 /* Reset ALL ifaces to 0 altsetting.
1170 * Call it for every possible altsetting of every interface.
1172 usb_set_interface(chip->dev, iface, 0);
1174 if (chip->setup & MAUDIO_SET) {
1176 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1177 return 1; /* skip this altsetting */
1178 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1179 return 1; /* skip this altsetting */
1180 mask = chip->setup & MAUDIO_SET_MASK;
1181 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1182 return 1; /* skip this altsetting */
1183 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1184 return 1; /* skip this altsetting */
1185 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1186 return 1; /* skip this altsetting */
1187 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1188 return 1; /* skip this altsetting */
1191 return 0; /* keep this altsetting */
1194 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1195 int iface, int altno)
1197 /* Reset ALL ifaces to 0 altsetting.
1198 * Call it for every possible altsetting of every interface.
1200 usb_set_interface(chip->dev, iface, 0);
1202 /* possible configuration where both inputs and only one output is
1203 *used is not supported by the current setup
1205 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1206 if (chip->setup & MAUDIO_SET_96K) {
1207 if (altno != 3 && altno != 6)
1209 } else if (chip->setup & MAUDIO_SET_DI) {
1211 return 1; /* no analog input */
1212 if (altno != 2 && altno != 5)
1213 return 1; /* enable only altsets 2 and 5 */
1216 return 1; /* disable digialt input */
1217 if (altno != 2 && altno != 5)
1218 return 1; /* enalbe only altsets 2 and 5 */
1221 /* keep only 16-Bit mode */
1227 "using altsetting %d for interface %d config %d\n",
1228 altno, iface, chip->setup);
1229 return 0; /* keep this altsetting */
1232 static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1233 int iface, int altno)
1238 * Playback (Interface 1):
1239 * 1: 6 Analog + 2 S/PDIF
1240 * 2: 6 Analog + 2 S/PDIF
1243 * Capture (Interface 2):
1244 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1245 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1250 * I'll leave 2 as the default one and
1251 * use device_setup to switch to the
1254 if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1256 else if (chip->setup == 1 && altno != 1)
1258 else if (chip->setup == 2 && altno != 3)
1264 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
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);
1271 /* 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);
1277 /* 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);
1285 int snd_usb_apply_boot_quirk(struct usb_device *dev,
1286 struct usb_interface *intf,
1287 const struct snd_usb_audio_quirk *quirk,
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. */
1294 return snd_usb_extigy_boot_quirk(dev, intf);
1296 case USB_ID(0x041e, 0x3020):
1297 /* SB Audigy 2 NX needs its own boot-up magic, too */
1298 return snd_usb_audigy2nx_boot_quirk(dev);
1300 case USB_ID(0x10f5, 0x0200):
1301 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1302 return snd_usb_cm106_boot_quirk(dev);
1304 case USB_ID(0x0d8c, 0x0102):
1305 /* C-Media CM6206 / CM106-Like Sound Device */
1306 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1307 return snd_usb_cm6206_boot_quirk(dev);
1309 case USB_ID(0x0dba, 0x3000):
1310 /* Digidesign Mbox 2 */
1311 return snd_usb_mbox2_boot_quirk(dev);
1313 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);
1317 case USB_ID(0x133e, 0x0815):
1318 /* Access Music VirusTI Desktop */
1319 return snd_usb_accessmusic_boot_quirk(dev);
1321 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1322 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1323 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1324 return snd_usb_nativeinstruments_boot_quirk(dev);
1325 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1326 return snd_usb_fasttrackpro_boot_quirk(dev);
1327 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1328 return snd_usb_gamecon780_boot_quirk(dev);
1329 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1330 return snd_usb_axefx3_boot_quirk(dev);
1331 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1333 * For some reason interface 3 with vendor-spec class is
1334 * detected on MicroBook IIc.
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);
1346 int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1347 struct usb_interface *intf,
1348 const struct snd_usb_audio_quirk *quirk,
1352 case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
1353 return snd_usb_motu_m_series_boot_quirk(dev);
1360 * check if the device uses big-endian samples
1362 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip,
1363 const struct audioformat *fp)
1365 /* it depends on altsetting whether the device is big-endian or not */
1366 switch (chip->usb_id) {
1367 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1368 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1369 fp->altsetting == 5 || fp->altsetting == 6)
1372 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1373 if (chip->setup == 0x00 ||
1374 fp->altsetting == 1 || fp->altsetting == 2 ||
1375 fp->altsetting == 3)
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)
1388 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1389 * not for interface.
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
1401 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1402 const struct audioformat *fmt)
1404 unsigned char emu_samplerate_id = 0;
1406 /* When capture is active
1407 * sample rate shouldn't be changed
1408 * by playback substream
1410 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1411 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].cur_audiofmt)
1415 switch (fmt->rate_min) {
1417 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1420 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1423 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1426 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1429 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1432 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1435 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1436 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1441 * Pioneer DJ DJM-900NXS2
1442 * Device needs to know the sample rate each time substream is started
1444 static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs)
1446 unsigned int cur_rate = subs->data_endpoint->cur_rate;
1447 /* Convert sample rate value to little endian */
1450 sr[0] = cur_rate & 0xff;
1451 sr[1] = (cur_rate >> 8) & 0xff;
1452 sr[2] = (cur_rate >> 16) & 0xff;
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);
1463 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1464 const struct audioformat *fmt)
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 */
1470 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1471 set_format_emu_quirk(subs, fmt);
1473 case USB_ID(0x2b73, 0x000a): /* Pioneer DJ DJM-900NXS2 */
1474 case USB_ID(0x2b73, 0x0017): /* Pioneer DJ DJM-250MK2 */
1475 pioneer_djm_set_format_quirk(subs);
1477 case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1478 subs->stream_offset_adj = 2;
1483 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1485 /* devices which do not support reading the sample rate. */
1486 switch (chip->usb_id) {
1487 case USB_ID(0x041e, 0x4080): /* Creative Live Cam VF0610 */
1488 case USB_ID(0x04d8, 0xfeea): /* Benchmark DAC1 Pre */
1489 case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
1490 case USB_ID(0x05a3, 0x9420): /* ELP HD USB Camera */
1491 case USB_ID(0x05a7, 0x1020): /* Bose Companion 5 */
1492 case USB_ID(0x074d, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1493 case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
1494 case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
1495 case USB_ID(0x21b4, 0x0081): /* AudioQuest DragonFly */
1496 case USB_ID(0x2912, 0x30c8): /* Audioengine D1 */
1500 /* devices of these vendors don't support reading rate, either */
1501 switch (USB_ID_VENDOR(chip->usb_id)) {
1502 case 0x045e: /* MS Lifecam */
1503 case 0x047f: /* Plantronics */
1504 case 0x1de7: /* Phoenix Audio */
1511 /* ITF-USB DSD based DACs need a vendor cmd to switch
1512 * between PCM and native DSD mode
1514 static bool is_itf_usb_dsd_dac(unsigned int id)
1517 case USB_ID(0x154e, 0x1002): /* Denon DCD-1500RE */
1518 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 */
1521 case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
1522 case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
1523 case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
1524 case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
1530 int snd_usb_select_mode_quirk(struct snd_usb_audio *chip,
1531 const struct audioformat *fmt)
1533 struct usb_device *dev = chip->dev;
1536 if (is_itf_usb_dsd_dac(chip->usb_id)) {
1537 /* First switch to alt set 0, otherwise the mode switch cmd
1538 * will not be accepted by the DAC
1540 err = usb_set_interface(dev, fmt->iface, 0);
1544 msleep(20); /* Delay needed after setting the interface */
1546 /* Vendor mode switch cmd is required. */
1547 if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1548 /* DSD mode (DSD_U32) requested */
1549 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1550 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1556 /* PCM or DOP mode (S32) requested */
1557 /* PCM mode (S16) requested */
1558 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1559 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1570 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1573 * "Playback Design" products send bogus feedback data at the start
1574 * of the stream. Ignore them.
1576 if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1577 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1578 ep->skip_packets = 4;
1581 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1582 * world latency varies by approx. +/- 50 frames (at 96kHz) each time
1583 * the stream is (re)started. When skipping packets 16 at endpoint
1584 * start up, the real world latency is stable within +/- 1 frame (also
1585 * across power cycles).
1587 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1588 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1589 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1590 ep->skip_packets = 16;
1592 /* Work around devices that report unreasonable feedback data */
1593 if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */
1594 ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1595 ep->syncmaxsize == 4)
1596 ep->tenor_fb_quirk = 1;
1599 void snd_usb_set_interface_quirk(struct snd_usb_audio *chip)
1604 * "Playback Design" products need a 50ms delay after setting the
1607 switch (USB_ID_VENDOR(chip->usb_id)) {
1608 case 0x23ba: /* Playback Design */
1609 case 0x0644: /* TEAC Corp. */
1615 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1616 void 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)
1620 struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1625 * "Playback Design" products need a 20ms delay after each
1626 * class compliant request
1628 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1629 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1633 * "TEAC Corp." products need a 20ms delay after each
1634 * class compliant request
1636 if (USB_ID_VENDOR(chip->usb_id) == 0x0644 &&
1637 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1640 /* ITF-USB DSD based DACs functionality need a delay
1641 * after each class compliant request
1643 if (is_itf_usb_dsd_dac(chip->usb_id)
1644 && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1647 /* 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.
1652 if ((chip->usb_id == USB_ID(0x1686, 0x00dd) ||
1653 USB_ID_VENDOR(chip->usb_id) == 0x046d || /* Logitech */
1654 chip->usb_id == USB_ID(0x0b0e, 0x0349) ||
1655 chip->usb_id == USB_ID(0x0951, 0x16ad)) &&
1656 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1657 usleep_range(1000, 2000);
1660 * Samsung USBC Headset (AKG) need a tiny delay after each
1661 * class compliant request. (Model number: AAM625R or AAM627R)
1663 if (chip->usb_id == USB_ID(0x04e8, 0xa051) &&
1664 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1665 usleep_range(5000, 6000);
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
1675 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1676 struct audioformat *fp,
1677 unsigned int sample_bytes)
1679 struct usb_interface *iface;
1681 /* Playback Designs */
1682 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1683 USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
1684 switch (fp->altsetting) {
1687 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1689 fp->dsd_bitrev = true;
1690 return SNDRV_PCM_FMTBIT_DSD_U8;
1692 fp->dsd_bitrev = true;
1693 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1697 /* XMOS based USB DACs */
1698 switch (chip->usb_id) {
1699 case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
1700 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1701 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1702 if (fp->altsetting == 2)
1703 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1706 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1707 case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1708 case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
1709 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1710 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 */
1713 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1714 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1715 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1716 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 */
1720 if (fp->altsetting == 3)
1721 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1724 /* 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 */
1729 if (fp->altsetting == 2) {
1730 switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
1732 return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1735 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1741 case USB_ID(0x16d0, 0x0a23):
1742 if (fp->altsetting == 2)
1743 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1750 /* 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);
1754 /* Altsetting 2 support native DSD if the num of altsets is
1756 * Altsetting 3 support native DSD if the num of altsets is
1759 if (fp->altsetting == iface->num_altsetting - 1)
1760 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1763 /* Mostly generic method to detect many DSD-capable implementations -
1764 * from XMOS/Thesycon
1766 switch (USB_ID_VENDOR(chip->usb_id)) {
1767 case 0x152a: /* Thesycon devices */
1768 case 0x20b1: /* XMOS based devices */
1769 case 0x22d9: /* Oppo */
1770 case 0x23ba: /* Playback Designs */
1771 case 0x25ce: /* Mytek devices */
1772 case 0x278b: /* Rotel? */
1773 case 0x292b: /* Gustard/Ess based devices */
1774 case 0x2ab6: /* T+A devices */
1775 case 0x3353: /* Khadas devices */
1776 case 0x3842: /* EVGA */
1777 case 0xc502: /* HiBy devices */
1779 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1789 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1790 struct audioformat *fp,
1793 switch (chip->usb_id) {
1794 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1795 /* Optoplay sets the sample rate attribute although
1796 * it seems not supporting it in fact.
1798 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
1800 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1801 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1802 /* doesn't set the sample rate attribute, but supports it */
1803 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
1805 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
1806 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1807 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1808 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1809 an older model 77d:223) */
1811 * plantronics headset and Griffin iMic have set adaptive-in
1812 * although it's really not...
1814 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
1815 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
1816 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
1818 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
1820 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook IIc */
1822 * MaxPacketsOnly attribute is erroneously set in endpoint
1823 * descriptors. As a result this card produces noise with
1824 * all sample rates other than 96 kHz.
1826 fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
1832 * registration quirk:
1833 * the registration is skipped if a device matches with the given ID,
1834 * unless the interface reaches to the defined one. This is for delaying
1835 * the registration until the last known interface, so that the card and
1836 * devices appear at the same time.
1839 struct registration_quirk {
1840 unsigned int usb_id; /* composed via USB_ID() */
1841 unsigned int interface; /* the interface to trigger register */
1844 #define REG_QUIRK_ENTRY(vendor, product, iface) \
1845 { .usb_id = USB_ID(vendor, product), .interface = (iface) }
1847 static const struct registration_quirk registration_quirks[] = {
1848 REG_QUIRK_ENTRY(0x0951, 0x16d8, 2), /* Kingston HyperX AMP */
1849 REG_QUIRK_ENTRY(0x0951, 0x16ed, 2), /* Kingston HyperX Cloud Alpha S */
1850 REG_QUIRK_ENTRY(0x0951, 0x16ea, 2), /* Kingston HyperX Cloud Flight S */
1851 { 0 } /* terminator */
1854 /* return true if skipping registration */
1855 bool snd_usb_registration_quirk(struct snd_usb_audio *chip, int iface)
1857 const struct registration_quirk *q;
1859 for (q = registration_quirks; q->usb_id; q++)
1860 if (chip->usb_id == q->usb_id)
1861 return iface != q->interface;
1863 /* Register as normal */