2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/usb.h>
20 #include <linux/usb/audio.h>
21 #include <linux/usb/midi.h>
23 #include <sound/control.h>
24 #include <sound/core.h>
25 #include <sound/info.h>
26 #include <sound/pcm.h>
31 #include "mixer_quirks.h"
41 * handle the quirks for the contained interfaces
43 static int create_composite_quirk(struct snd_usb_audio *chip,
44 struct usb_interface *iface,
45 struct usb_driver *driver,
46 const struct snd_usb_audio_quirk *quirk_comp)
48 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
49 const struct snd_usb_audio_quirk *quirk;
52 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
53 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
56 if (quirk->ifnum != probed_ifnum &&
57 usb_interface_claimed(iface))
59 err = snd_usb_create_quirk(chip, iface, driver, quirk);
64 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
65 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
68 if (quirk->ifnum != probed_ifnum &&
69 !usb_interface_claimed(iface))
70 usb_driver_claim_interface(driver, iface, (void *)-1L);
76 static int ignore_interface_quirk(struct snd_usb_audio *chip,
77 struct usb_interface *iface,
78 struct usb_driver *driver,
79 const struct snd_usb_audio_quirk *quirk)
86 * Allow alignment on audio sub-slot (channel samples) rather than
87 * on audio slots (audio frames)
89 static int create_align_transfer_quirk(struct snd_usb_audio *chip,
90 struct usb_interface *iface,
91 struct usb_driver *driver,
92 const struct snd_usb_audio_quirk *quirk)
95 return 1; /* Continue with creating streams and mixer */
98 static int create_any_midi_quirk(struct snd_usb_audio *chip,
99 struct usb_interface *intf,
100 struct usb_driver *driver,
101 const struct snd_usb_audio_quirk *quirk)
103 return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
107 * create a stream for an interface with proper descriptors
109 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
110 struct usb_interface *iface,
111 struct usb_driver *driver,
112 const struct snd_usb_audio_quirk *quirk)
114 struct usb_host_interface *alts;
115 struct usb_interface_descriptor *altsd;
118 if (chip->usb_id == USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
119 chip->tx_length_quirk = 1;
121 alts = &iface->altsetting[0];
122 altsd = get_iface_desc(alts);
123 err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
125 usb_audio_err(chip, "cannot setup if %d: error %d\n",
126 altsd->bInterfaceNumber, err);
129 /* reset the current interface */
130 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
135 * create a stream for an endpoint/altsetting without proper descriptors
137 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
138 struct usb_interface *iface,
139 struct usb_driver *driver,
140 const struct snd_usb_audio_quirk *quirk)
142 struct audioformat *fp;
143 struct usb_host_interface *alts;
144 struct usb_interface_descriptor *altsd;
146 unsigned *rate_table = NULL;
148 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
150 usb_audio_err(chip, "cannot memdup\n");
153 if (fp->nr_rates > MAX_NR_RATES) {
157 if (fp->nr_rates > 0) {
158 rate_table = kmemdup(fp->rate_table,
159 sizeof(int) * fp->nr_rates, GFP_KERNEL);
164 fp->rate_table = rate_table;
167 stream = (fp->endpoint & USB_DIR_IN)
168 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
169 err = snd_usb_add_audio_stream(chip, stream, fp);
175 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
176 fp->altset_idx >= iface->num_altsetting) {
181 alts = &iface->altsetting[fp->altset_idx];
182 altsd = get_iface_desc(alts);
183 fp->protocol = altsd->bInterfaceProtocol;
185 if (fp->datainterval == 0)
186 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
187 if (fp->maxpacksize == 0)
188 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
189 usb_set_interface(chip->dev, fp->iface, 0);
190 snd_usb_init_pitch(chip, fp->iface, alts, fp);
191 snd_usb_init_sample_rate(chip, fp->iface, alts, fp, fp->rate_max);
195 static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
196 struct usb_interface *iface,
197 struct usb_driver *driver)
199 struct usb_host_interface *alts;
200 struct usb_interface_descriptor *altsd;
201 struct usb_endpoint_descriptor *epd;
202 struct uac1_as_header_descriptor *ashd;
203 struct uac_format_type_i_discrete_descriptor *fmtd;
206 * Most Roland/Yamaha audio streaming interfaces have more or less
207 * standard descriptors, but older devices might lack descriptors, and
208 * future ones might change, so ensure that we fail silently if the
209 * interface doesn't look exactly right.
212 /* must have a non-zero altsetting for streaming */
213 if (iface->num_altsetting < 2)
215 alts = &iface->altsetting[1];
216 altsd = get_iface_desc(alts);
218 /* must have an isochronous endpoint for streaming */
219 if (altsd->bNumEndpoints < 1)
221 epd = get_endpoint(alts, 0);
222 if (!usb_endpoint_xfer_isoc(epd))
225 /* must have format descriptors */
226 ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
228 fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
230 if (!ashd || ashd->bLength < 7 ||
231 !fmtd || fmtd->bLength < 8)
234 return create_standard_audio_quirk(chip, iface, driver, NULL);
237 static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
238 struct usb_interface *iface,
239 struct usb_driver *driver,
240 struct usb_host_interface *alts)
242 static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
243 .type = QUIRK_MIDI_YAMAHA
245 struct usb_midi_in_jack_descriptor *injd;
246 struct usb_midi_out_jack_descriptor *outjd;
248 /* must have some valid jack descriptors */
249 injd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
250 NULL, USB_MS_MIDI_IN_JACK);
251 outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
252 NULL, USB_MS_MIDI_OUT_JACK);
255 if (injd && (injd->bLength < 5 ||
256 (injd->bJackType != USB_MS_EMBEDDED &&
257 injd->bJackType != USB_MS_EXTERNAL)))
259 if (outjd && (outjd->bLength < 6 ||
260 (outjd->bJackType != USB_MS_EMBEDDED &&
261 outjd->bJackType != USB_MS_EXTERNAL)))
263 return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
266 static int create_roland_midi_quirk(struct snd_usb_audio *chip,
267 struct usb_interface *iface,
268 struct usb_driver *driver,
269 struct usb_host_interface *alts)
271 static const struct snd_usb_audio_quirk roland_midi_quirk = {
272 .type = QUIRK_MIDI_ROLAND
274 u8 *roland_desc = NULL;
276 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
278 roland_desc = snd_usb_find_csint_desc(alts->extra,
283 if (roland_desc[0] < 6 || roland_desc[3] != 2)
285 return create_any_midi_quirk(chip, iface, driver,
290 static int create_std_midi_quirk(struct snd_usb_audio *chip,
291 struct usb_interface *iface,
292 struct usb_driver *driver,
293 struct usb_host_interface *alts)
295 struct usb_ms_header_descriptor *mshd;
296 struct usb_ms_endpoint_descriptor *msepd;
298 /* must have the MIDIStreaming interface header descriptor*/
299 mshd = (struct usb_ms_header_descriptor *)alts->extra;
300 if (alts->extralen < 7 ||
302 mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
303 mshd->bDescriptorSubtype != USB_MS_HEADER)
305 /* must have the MIDIStreaming endpoint descriptor*/
306 msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra;
307 if (alts->endpoint[0].extralen < 4 ||
308 msepd->bLength < 4 ||
309 msepd->bDescriptorType != USB_DT_CS_ENDPOINT ||
310 msepd->bDescriptorSubtype != UAC_MS_GENERAL ||
311 msepd->bNumEmbMIDIJack < 1 ||
312 msepd->bNumEmbMIDIJack > 16)
315 return create_any_midi_quirk(chip, iface, driver, NULL);
318 static int create_auto_midi_quirk(struct snd_usb_audio *chip,
319 struct usb_interface *iface,
320 struct usb_driver *driver)
322 struct usb_host_interface *alts;
323 struct usb_interface_descriptor *altsd;
324 struct usb_endpoint_descriptor *epd;
327 alts = &iface->altsetting[0];
328 altsd = get_iface_desc(alts);
330 /* must have at least one bulk/interrupt endpoint for streaming */
331 if (altsd->bNumEndpoints < 1)
333 epd = get_endpoint(alts, 0);
334 if (!usb_endpoint_xfer_bulk(epd) &&
335 !usb_endpoint_xfer_int(epd))
338 switch (USB_ID_VENDOR(chip->usb_id)) {
339 case 0x0499: /* Yamaha */
340 err = create_yamaha_midi_quirk(chip, iface, driver, alts);
344 case 0x0582: /* Roland */
345 err = create_roland_midi_quirk(chip, iface, driver, alts);
351 return create_std_midi_quirk(chip, iface, driver, alts);
354 static int create_autodetect_quirk(struct snd_usb_audio *chip,
355 struct usb_interface *iface,
356 struct usb_driver *driver)
360 err = create_auto_pcm_quirk(chip, iface, driver);
362 err = create_auto_midi_quirk(chip, iface, driver);
366 static int create_autodetect_quirks(struct snd_usb_audio *chip,
367 struct usb_interface *iface,
368 struct usb_driver *driver,
369 const struct snd_usb_audio_quirk *quirk)
371 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
372 int ifcount, ifnum, err;
374 err = create_autodetect_quirk(chip, iface, driver);
379 * ALSA PCM playback/capture devices cannot be registered in two steps,
380 * so we have to claim the other corresponding interface here.
382 ifcount = chip->dev->actconfig->desc.bNumInterfaces;
383 for (ifnum = 0; ifnum < ifcount; ifnum++) {
384 if (ifnum == probed_ifnum || quirk->ifnum >= 0)
386 iface = usb_ifnum_to_if(chip->dev, ifnum);
388 usb_interface_claimed(iface) ||
389 get_iface_desc(iface->altsetting)->bInterfaceClass !=
390 USB_CLASS_VENDOR_SPEC)
393 err = create_autodetect_quirk(chip, iface, driver);
395 usb_driver_claim_interface(driver, iface, (void *)-1L);
402 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
403 * The only way to detect the sample rate is by looking at wMaxPacketSize.
405 static int create_uaxx_quirk(struct snd_usb_audio *chip,
406 struct usb_interface *iface,
407 struct usb_driver *driver,
408 const struct snd_usb_audio_quirk *quirk)
410 static const struct audioformat ua_format = {
411 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
413 .fmt_type = UAC_FORMAT_TYPE_I,
416 .rates = SNDRV_PCM_RATE_CONTINUOUS,
418 struct usb_host_interface *alts;
419 struct usb_interface_descriptor *altsd;
420 struct audioformat *fp;
423 /* both PCM and MIDI interfaces have 2 or more altsettings */
424 if (iface->num_altsetting < 2)
426 alts = &iface->altsetting[1];
427 altsd = get_iface_desc(alts);
429 if (altsd->bNumEndpoints == 2) {
430 static const struct snd_usb_midi_endpoint_info ua700_ep = {
431 .out_cables = 0x0003,
434 static const struct snd_usb_audio_quirk ua700_quirk = {
435 .type = QUIRK_MIDI_FIXED_ENDPOINT,
438 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
439 .out_cables = 0x0001,
442 static const struct snd_usb_audio_quirk uaxx_quirk = {
443 .type = QUIRK_MIDI_FIXED_ENDPOINT,
446 const struct snd_usb_audio_quirk *quirk =
447 chip->usb_id == USB_ID(0x0582, 0x002b)
448 ? &ua700_quirk : &uaxx_quirk;
449 return snd_usbmidi_create(chip->card, iface,
450 &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);
466 switch (fp->maxpacksize) {
468 fp->rate_max = fp->rate_min = 44100;
472 fp->rate_max = fp->rate_min = 48000;
476 fp->rate_max = fp->rate_min = 96000;
479 usb_audio_err(chip, "unknown sample rate\n");
484 stream = (fp->endpoint & USB_DIR_IN)
485 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
486 err = snd_usb_add_audio_stream(chip, stream, fp);
491 usb_set_interface(chip->dev, fp->iface, 0);
496 * Create a standard mixer for the specified interface.
498 static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
499 struct usb_interface *iface,
500 struct usb_driver *driver,
501 const struct snd_usb_audio_quirk *quirk)
503 if (quirk->ifnum < 0)
506 return snd_usb_create_mixer(chip, quirk->ifnum, 0);
510 * audio-interface quirks
512 * returns zero if no standard audio/MIDI parsing is needed.
513 * returns a positive value if standard audio/midi interfaces are parsed
515 * returns a negative value at error.
517 int snd_usb_create_quirk(struct snd_usb_audio *chip,
518 struct usb_interface *iface,
519 struct usb_driver *driver,
520 const struct snd_usb_audio_quirk *quirk)
522 typedef int (*quirk_func_t)(struct snd_usb_audio *,
523 struct usb_interface *,
525 const struct snd_usb_audio_quirk *);
526 static const quirk_func_t quirk_funcs[] = {
527 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
528 [QUIRK_COMPOSITE] = create_composite_quirk,
529 [QUIRK_AUTODETECT] = create_autodetect_quirks,
530 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
531 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
532 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
533 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
534 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
535 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
536 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
537 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
538 [QUIRK_MIDI_CME] = create_any_midi_quirk,
539 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
540 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
541 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
542 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
543 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
544 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
545 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
548 if (quirk->type < QUIRK_TYPE_COUNT) {
549 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
551 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
560 #define EXTIGY_FIRMWARE_SIZE_OLD 794
561 #define EXTIGY_FIRMWARE_SIZE_NEW 483
563 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
565 struct usb_host_config *config = dev->actconfig;
568 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
569 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
570 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
571 /* Send message to force it to reconnect with full interface. */
572 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
573 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
575 dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
576 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
577 &dev->descriptor, sizeof(dev->descriptor));
578 config = dev->actconfig;
580 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
581 err = usb_reset_configuration(dev);
583 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
584 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
585 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
586 return -ENODEV; /* quit this anyway */
591 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
595 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
596 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
599 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
600 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
607 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
611 if (dev->actconfig->desc.bConfigurationValue == 1) {
613 "Fast Track Pro switching to config #2\n");
614 /* This function has to be available by the usb core module.
615 * if it is not avialable the boot quirk has to be left out
616 * and the configuration has to be set by udev or hotplug
619 err = usb_driver_set_configuration(dev, 2);
622 "error usb_driver_set_configuration: %d\n",
624 /* Always return an error, so that we stop creating a device
625 that will just be destroyed and recreated with a new
629 dev_info(&dev->dev, "Fast Track Pro config OK\n");
635 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
636 * documented in the device's data sheet.
638 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
642 buf[1] = value & 0xff;
643 buf[2] = (value >> 8) & 0xff;
645 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
646 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
650 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
653 * Enable line-out driver mode, set headphone source to front
654 * channels, enable stereo mic.
656 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
660 * C-Media CM6206 is based on CM106 with two additional
661 * registers that are not documented in the data sheet.
662 * Values here are chosen based on sniffing USB traffic
665 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
668 int val[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
670 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
671 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
679 /* quirk for Plantronics GameCom 780 with CM6302 chip */
680 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
682 /* set the initial volume and don't change; other values are either
683 * too loud or silent due to firmware bug (bko#65251)
685 u8 buf[2] = { 0x74, 0xe3 };
686 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
687 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
688 UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
692 * Novation Twitch DJ controller
693 * Focusrite Novation Saffire 6 USB audio card
695 static int snd_usb_novation_boot_quirk(struct usb_device *dev)
697 /* preemptively set up the device because otherwise the
698 * raw MIDI endpoints are not active */
699 usb_set_interface(dev, 0, 1);
704 * This call will put the synth in "USB send" mode, i.e it will send MIDI
705 * messages through USB (this is disabled at startup). The synth will
706 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
707 * sign on its LCD. Values here are chosen based on sniffing USB traffic
710 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
712 int err, actual_length;
714 /* "midi send" enable */
715 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
717 void *buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
720 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
721 ARRAY_SIZE(seq), &actual_length, 1000);
730 * Some sound cards from Native Instruments are in fact compliant to the USB
731 * audio standard of version 2 and other approved USB standards, even though
732 * they come up as vendor-specific device when first connected.
734 * However, they can be told to come up with a new set of descriptors
735 * upon their next enumeration, and the interfaces announced by the new
736 * descriptors will then be handled by the kernel's class drivers. As the
737 * product ID will also change, no further checks are required.
740 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
742 int ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
743 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
744 1, 0, NULL, 0, 1000);
749 usb_reset_device(dev);
751 /* return -EAGAIN, so the creation of an audio interface for this
752 * temporary device is aborted. The device will reconnect with a
757 static void mbox2_setup_48_24_magic(struct usb_device *dev)
762 /* Choose 48000Hz permanently */
767 /* Send the magic! */
768 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
769 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
770 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
771 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
772 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
773 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
774 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
775 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
779 /* Digidesign Mbox 2 needs to load firmware onboard
780 * and driver must wait a few seconds for initialisation.
783 #define MBOX2_FIRMWARE_SIZE 646
784 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
785 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
787 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
789 struct usb_host_config *config = dev->actconfig;
791 u8 bootresponse[0x12];
795 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
797 if (fwsize != MBOX2_FIRMWARE_SIZE) {
798 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
802 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
805 bootresponse[0] = MBOX2_BOOT_LOADING;
806 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
807 msleep(500); /* 0.5 second delay */
808 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
809 /* Control magic - load onboard firmware */
810 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
811 if (bootresponse[0] == MBOX2_BOOT_READY)
813 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
817 if (bootresponse[0] != MBOX2_BOOT_READY) {
818 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
822 dev_dbg(&dev->dev, "device initialised!\n");
824 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
825 &dev->descriptor, sizeof(dev->descriptor));
826 config = dev->actconfig;
828 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
830 err = usb_reset_configuration(dev);
832 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
833 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
834 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
836 mbox2_setup_48_24_magic(dev);
838 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
840 return 0; /* Successful boot */
846 #define MAUDIO_SET 0x01 /* parse device_setup */
847 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
848 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
849 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
850 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
851 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
852 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
853 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
854 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
855 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
856 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
858 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
859 int iface, int altno)
861 /* Reset ALL ifaces to 0 altsetting.
862 * Call it for every possible altsetting of every interface.
864 usb_set_interface(chip->dev, iface, 0);
865 if (chip->setup & MAUDIO_SET) {
866 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
867 if (iface != 1 && iface != 2)
868 return 1; /* skip all interfaces but 1 and 2 */
871 if (iface == 1 || iface == 2)
872 return 1; /* skip interfaces 1 and 2 */
873 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
874 return 1; /* skip this altsetting */
875 mask = chip->setup & MAUDIO_SET_MASK;
876 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
877 return 1; /* skip this altsetting */
878 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
879 return 1; /* skip this altsetting */
880 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
881 return 1; /* skip this altsetting */
885 "using altsetting %d for interface %d config %d\n",
886 altno, iface, chip->setup);
887 return 0; /* keep this altsetting */
890 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
894 /* Reset ALL ifaces to 0 altsetting.
895 * Call it for every possible altsetting of every interface.
897 usb_set_interface(chip->dev, iface, 0);
899 if (chip->setup & MAUDIO_SET) {
901 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
902 return 1; /* skip this altsetting */
903 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
904 return 1; /* skip this altsetting */
905 mask = chip->setup & MAUDIO_SET_MASK;
906 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
907 return 1; /* skip this altsetting */
908 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
909 return 1; /* skip this altsetting */
910 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
911 return 1; /* skip this altsetting */
912 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
913 return 1; /* skip this altsetting */
916 return 0; /* keep this altsetting */
919 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
920 int iface, int altno)
922 /* Reset ALL ifaces to 0 altsetting.
923 * Call it for every possible altsetting of every interface.
925 usb_set_interface(chip->dev, iface, 0);
927 /* possible configuration where both inputs and only one output is
928 *used is not supported by the current setup
930 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
931 if (chip->setup & MAUDIO_SET_96K) {
932 if (altno != 3 && altno != 6)
934 } else if (chip->setup & MAUDIO_SET_DI) {
936 return 1; /* no analog input */
937 if (altno != 2 && altno != 5)
938 return 1; /* enable only altsets 2 and 5 */
941 return 1; /* disable digialt input */
942 if (altno != 2 && altno != 5)
943 return 1; /* enalbe only altsets 2 and 5 */
946 /* keep only 16-Bit mode */
952 "using altsetting %d for interface %d config %d\n",
953 altno, iface, chip->setup);
954 return 0; /* keep this altsetting */
957 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
961 /* audiophile usb: skip altsets incompatible with device_setup */
962 if (chip->usb_id == USB_ID(0x0763, 0x2003))
963 return audiophile_skip_setting_quirk(chip, iface, altno);
964 /* quattro usb: skip altsets incompatible with device_setup */
965 if (chip->usb_id == USB_ID(0x0763, 0x2001))
966 return quattro_skip_setting_quirk(chip, iface, altno);
967 /* fasttrackpro usb: skip altsets incompatible with device_setup */
968 if (chip->usb_id == USB_ID(0x0763, 0x2012))
969 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
974 int snd_usb_apply_boot_quirk(struct usb_device *dev,
975 struct usb_interface *intf,
976 const struct snd_usb_audio_quirk *quirk)
978 u32 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
979 le16_to_cpu(dev->descriptor.idProduct));
982 case USB_ID(0x041e, 0x3000):
983 /* SB Extigy needs special boot-up sequence */
984 /* if more models come, this will go to the quirk list. */
985 return snd_usb_extigy_boot_quirk(dev, intf);
987 case USB_ID(0x041e, 0x3020):
988 /* SB Audigy 2 NX needs its own boot-up magic, too */
989 return snd_usb_audigy2nx_boot_quirk(dev);
991 case USB_ID(0x10f5, 0x0200):
992 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
993 return snd_usb_cm106_boot_quirk(dev);
995 case USB_ID(0x0d8c, 0x0102):
996 /* C-Media CM6206 / CM106-Like Sound Device */
997 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
998 return snd_usb_cm6206_boot_quirk(dev);
1000 case USB_ID(0x0dba, 0x3000):
1001 /* Digidesign Mbox 2 */
1002 return snd_usb_mbox2_boot_quirk(dev);
1004 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1005 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1006 return snd_usb_novation_boot_quirk(dev);
1008 case USB_ID(0x133e, 0x0815):
1009 /* Access Music VirusTI Desktop */
1010 return snd_usb_accessmusic_boot_quirk(dev);
1012 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1013 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1014 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1015 return snd_usb_nativeinstruments_boot_quirk(dev);
1016 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1017 return snd_usb_fasttrackpro_boot_quirk(dev);
1018 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1019 return snd_usb_gamecon780_boot_quirk(dev);
1026 * check if the device uses big-endian samples
1028 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
1030 /* it depends on altsetting whether the device is big-endian or not */
1031 switch (chip->usb_id) {
1032 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1033 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1034 fp->altsetting == 5 || fp->altsetting == 6)
1037 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1038 if (chip->setup == 0x00 ||
1039 fp->altsetting == 1 || fp->altsetting == 2 ||
1040 fp->altsetting == 3)
1043 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1044 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1045 fp->altsetting == 5 || fp->altsetting == 6)
1053 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1054 * not for interface.
1058 EMU_QUIRK_SR_44100HZ = 0,
1059 EMU_QUIRK_SR_48000HZ,
1060 EMU_QUIRK_SR_88200HZ,
1061 EMU_QUIRK_SR_96000HZ,
1062 EMU_QUIRK_SR_176400HZ,
1063 EMU_QUIRK_SR_192000HZ
1066 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1067 struct audioformat *fmt)
1069 unsigned char emu_samplerate_id = 0;
1071 /* When capture is active
1072 * sample rate shouldn't be changed
1073 * by playback substream
1075 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1076 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
1080 switch (fmt->rate_min) {
1082 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1085 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1088 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1091 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1094 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1097 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1100 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1101 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1104 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1105 struct audioformat *fmt)
1107 switch (subs->stream->chip->usb_id) {
1108 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1109 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1110 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1111 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1112 set_format_emu_quirk(subs, fmt);
1117 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1119 /* devices which do not support reading the sample rate. */
1120 switch (chip->usb_id) {
1121 case USB_ID(0x045E, 0x075D): /* MS Lifecam Cinema */
1122 case USB_ID(0x045E, 0x076D): /* MS Lifecam HD-5000 */
1123 case USB_ID(0x045E, 0x0772): /* MS Lifecam Studio */
1124 case USB_ID(0x045E, 0x0779): /* MS Lifecam HD-3000 */
1125 case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */
1126 case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1132 /* Marantz/Denon USB DACs need a vendor cmd to switch
1133 * between PCM and native DSD mode
1135 static bool is_marantz_denon_dac(unsigned int id)
1138 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1139 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1140 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1146 int snd_usb_select_mode_quirk(struct snd_usb_substream *subs,
1147 struct audioformat *fmt)
1149 struct usb_device *dev = subs->dev;
1152 if (is_marantz_denon_dac(subs->stream->chip->usb_id)) {
1153 /* First switch to alt set 0, otherwise the mode switch cmd
1154 * will not be accepted by the DAC
1156 err = usb_set_interface(dev, fmt->iface, 0);
1160 mdelay(20); /* Delay needed after setting the interface */
1162 switch (fmt->altsetting) {
1163 case 2: /* DSD mode requested */
1164 case 1: /* PCM mode requested */
1165 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1166 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1167 fmt->altsetting - 1, 1, NULL, 0);
1177 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1180 * "Playback Design" products send bogus feedback data at the start
1181 * of the stream. Ignore them.
1183 if ((le16_to_cpu(ep->chip->dev->descriptor.idVendor) == 0x23ba) &&
1184 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1185 ep->skip_packets = 4;
1188 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1189 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1190 * the stream is (re)started. When skipping packets 16 at endpoint
1191 * start up, the real world latency is stable within +/- 1 frame (also
1192 * across power cycles).
1194 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1195 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1196 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1197 ep->skip_packets = 16;
1200 void snd_usb_set_interface_quirk(struct usb_device *dev)
1203 * "Playback Design" products need a 50ms delay after setting the
1206 if (le16_to_cpu(dev->descriptor.idVendor) == 0x23ba)
1210 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1211 __u8 request, __u8 requesttype, __u16 value,
1212 __u16 index, void *data, __u16 size)
1215 * "Playback Design" products need a 20ms delay after each
1216 * class compliant request
1218 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x23ba) &&
1219 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1222 /* Marantz/Denon devices with USB DAC functionality need a delay
1223 * after each class compliant request
1225 if (is_marantz_denon_dac(USB_ID(le16_to_cpu(dev->descriptor.idVendor),
1226 le16_to_cpu(dev->descriptor.idProduct)))
1227 && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1230 /* Zoom R16/24 needs a tiny delay here, otherwise requests like
1231 * get/set frequency return as failed despite actually succeeding.
1233 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x1686) &&
1234 (le16_to_cpu(dev->descriptor.idProduct) == 0x00dd) &&
1235 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1240 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1241 * augment the PCM format bit-field for DSD types. The UAC standards
1242 * don't have a designated bit field to denote DSD-capable interfaces,
1243 * hence all hardware that is known to support this format has to be
1246 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1247 struct audioformat *fp,
1248 unsigned int sample_bytes)
1250 /* Playback Designs */
1251 if (le16_to_cpu(chip->dev->descriptor.idVendor) == 0x23ba) {
1252 switch (fp->altsetting) {
1255 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1257 fp->dsd_bitrev = true;
1258 return SNDRV_PCM_FMTBIT_DSD_U8;
1260 fp->dsd_bitrev = true;
1261 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1265 /* XMOS based USB DACs */
1266 switch (chip->usb_id) {
1267 case USB_ID(0x20b1, 0x3008): /* iFi Audio micro/nano iDSD */
1268 case USB_ID(0x20b1, 0x2008): /* Matrix Audio X-Sabre */
1269 case USB_ID(0x20b1, 0x300a): /* Matrix Audio Mini-i Pro */
1270 if (fp->altsetting == 2)
1271 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1274 case USB_ID(0x20b1, 0x000a): /* Gustard DAC-X20U */
1275 case USB_ID(0x20b1, 0x2009): /* DIYINHK DSD DXD 384kHz USB to I2S/DSD */
1276 case USB_ID(0x20b1, 0x2023): /* JLsounds I2SoverUSB */
1277 case USB_ID(0x20b1, 0x3023): /* Aune X1S 32BIT/384 DSD DAC */
1278 if (fp->altsetting == 3)
1279 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1285 /* Denon/Marantz devices with USB DAC functionality */
1286 if (is_marantz_denon_dac(chip->usb_id)) {
1287 if (fp->altsetting == 2)
1288 return SNDRV_PCM_FMTBIT_DSD_U32_BE;