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 if (altsd->bNumEndpoints < 1) {
189 fp->protocol = altsd->bInterfaceProtocol;
191 if (fp->datainterval == 0)
192 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
193 if (fp->maxpacksize == 0)
194 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
195 usb_set_interface(chip->dev, fp->iface, 0);
196 snd_usb_init_pitch(chip, fp->iface, alts, fp);
197 snd_usb_init_sample_rate(chip, fp->iface, alts, fp, fp->rate_max);
201 static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
202 struct usb_interface *iface,
203 struct usb_driver *driver)
205 struct usb_host_interface *alts;
206 struct usb_interface_descriptor *altsd;
207 struct usb_endpoint_descriptor *epd;
208 struct uac1_as_header_descriptor *ashd;
209 struct uac_format_type_i_discrete_descriptor *fmtd;
212 * Most Roland/Yamaha audio streaming interfaces have more or less
213 * standard descriptors, but older devices might lack descriptors, and
214 * future ones might change, so ensure that we fail silently if the
215 * interface doesn't look exactly right.
218 /* must have a non-zero altsetting for streaming */
219 if (iface->num_altsetting < 2)
221 alts = &iface->altsetting[1];
222 altsd = get_iface_desc(alts);
224 /* must have an isochronous endpoint for streaming */
225 if (altsd->bNumEndpoints < 1)
227 epd = get_endpoint(alts, 0);
228 if (!usb_endpoint_xfer_isoc(epd))
231 /* must have format descriptors */
232 ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
234 fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
236 if (!ashd || ashd->bLength < 7 ||
237 !fmtd || fmtd->bLength < 8)
240 return create_standard_audio_quirk(chip, iface, driver, NULL);
243 static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
244 struct usb_interface *iface,
245 struct usb_driver *driver,
246 struct usb_host_interface *alts)
248 static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
249 .type = QUIRK_MIDI_YAMAHA
251 struct usb_midi_in_jack_descriptor *injd;
252 struct usb_midi_out_jack_descriptor *outjd;
254 /* must have some valid jack descriptors */
255 injd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
256 NULL, USB_MS_MIDI_IN_JACK);
257 outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
258 NULL, USB_MS_MIDI_OUT_JACK);
261 if (injd && (injd->bLength < 5 ||
262 (injd->bJackType != USB_MS_EMBEDDED &&
263 injd->bJackType != USB_MS_EXTERNAL)))
265 if (outjd && (outjd->bLength < 6 ||
266 (outjd->bJackType != USB_MS_EMBEDDED &&
267 outjd->bJackType != USB_MS_EXTERNAL)))
269 return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
272 static int create_roland_midi_quirk(struct snd_usb_audio *chip,
273 struct usb_interface *iface,
274 struct usb_driver *driver,
275 struct usb_host_interface *alts)
277 static const struct snd_usb_audio_quirk roland_midi_quirk = {
278 .type = QUIRK_MIDI_ROLAND
280 u8 *roland_desc = NULL;
282 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
284 roland_desc = snd_usb_find_csint_desc(alts->extra,
289 if (roland_desc[0] < 6 || roland_desc[3] != 2)
291 return create_any_midi_quirk(chip, iface, driver,
296 static int create_std_midi_quirk(struct snd_usb_audio *chip,
297 struct usb_interface *iface,
298 struct usb_driver *driver,
299 struct usb_host_interface *alts)
301 struct usb_ms_header_descriptor *mshd;
302 struct usb_ms_endpoint_descriptor *msepd;
304 /* must have the MIDIStreaming interface header descriptor*/
305 mshd = (struct usb_ms_header_descriptor *)alts->extra;
306 if (alts->extralen < 7 ||
308 mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
309 mshd->bDescriptorSubtype != USB_MS_HEADER)
311 /* must have the MIDIStreaming endpoint descriptor*/
312 msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra;
313 if (alts->endpoint[0].extralen < 4 ||
314 msepd->bLength < 4 ||
315 msepd->bDescriptorType != USB_DT_CS_ENDPOINT ||
316 msepd->bDescriptorSubtype != UAC_MS_GENERAL ||
317 msepd->bNumEmbMIDIJack < 1 ||
318 msepd->bNumEmbMIDIJack > 16)
321 return create_any_midi_quirk(chip, iface, driver, NULL);
324 static int create_auto_midi_quirk(struct snd_usb_audio *chip,
325 struct usb_interface *iface,
326 struct usb_driver *driver)
328 struct usb_host_interface *alts;
329 struct usb_interface_descriptor *altsd;
330 struct usb_endpoint_descriptor *epd;
333 alts = &iface->altsetting[0];
334 altsd = get_iface_desc(alts);
336 /* must have at least one bulk/interrupt endpoint for streaming */
337 if (altsd->bNumEndpoints < 1)
339 epd = get_endpoint(alts, 0);
340 if (!usb_endpoint_xfer_bulk(epd) &&
341 !usb_endpoint_xfer_int(epd))
344 switch (USB_ID_VENDOR(chip->usb_id)) {
345 case 0x0499: /* Yamaha */
346 err = create_yamaha_midi_quirk(chip, iface, driver, alts);
350 case 0x0582: /* Roland */
351 err = create_roland_midi_quirk(chip, iface, driver, alts);
357 return create_std_midi_quirk(chip, iface, driver, alts);
360 static int create_autodetect_quirk(struct snd_usb_audio *chip,
361 struct usb_interface *iface,
362 struct usb_driver *driver)
366 err = create_auto_pcm_quirk(chip, iface, driver);
368 err = create_auto_midi_quirk(chip, iface, driver);
372 static int create_autodetect_quirks(struct snd_usb_audio *chip,
373 struct usb_interface *iface,
374 struct usb_driver *driver,
375 const struct snd_usb_audio_quirk *quirk)
377 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
378 int ifcount, ifnum, err;
380 err = create_autodetect_quirk(chip, iface, driver);
385 * ALSA PCM playback/capture devices cannot be registered in two steps,
386 * so we have to claim the other corresponding interface here.
388 ifcount = chip->dev->actconfig->desc.bNumInterfaces;
389 for (ifnum = 0; ifnum < ifcount; ifnum++) {
390 if (ifnum == probed_ifnum || quirk->ifnum >= 0)
392 iface = usb_ifnum_to_if(chip->dev, ifnum);
394 usb_interface_claimed(iface) ||
395 get_iface_desc(iface->altsetting)->bInterfaceClass !=
396 USB_CLASS_VENDOR_SPEC)
399 err = create_autodetect_quirk(chip, iface, driver);
401 usb_driver_claim_interface(driver, iface, (void *)-1L);
408 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
409 * The only way to detect the sample rate is by looking at wMaxPacketSize.
411 static int create_uaxx_quirk(struct snd_usb_audio *chip,
412 struct usb_interface *iface,
413 struct usb_driver *driver,
414 const struct snd_usb_audio_quirk *quirk)
416 static const struct audioformat ua_format = {
417 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
419 .fmt_type = UAC_FORMAT_TYPE_I,
422 .rates = SNDRV_PCM_RATE_CONTINUOUS,
424 struct usb_host_interface *alts;
425 struct usb_interface_descriptor *altsd;
426 struct audioformat *fp;
429 /* both PCM and MIDI interfaces have 2 or more altsettings */
430 if (iface->num_altsetting < 2)
432 alts = &iface->altsetting[1];
433 altsd = get_iface_desc(alts);
435 if (altsd->bNumEndpoints == 2) {
436 static const struct snd_usb_midi_endpoint_info ua700_ep = {
437 .out_cables = 0x0003,
440 static const struct snd_usb_audio_quirk ua700_quirk = {
441 .type = QUIRK_MIDI_FIXED_ENDPOINT,
444 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
445 .out_cables = 0x0001,
448 static const struct snd_usb_audio_quirk uaxx_quirk = {
449 .type = QUIRK_MIDI_FIXED_ENDPOINT,
452 const struct snd_usb_audio_quirk *quirk =
453 chip->usb_id == USB_ID(0x0582, 0x002b)
454 ? &ua700_quirk : &uaxx_quirk;
455 return snd_usbmidi_create(chip->card, iface,
456 &chip->midi_list, quirk);
459 if (altsd->bNumEndpoints != 1)
462 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
466 fp->iface = altsd->bInterfaceNumber;
467 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
468 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
469 fp->datainterval = 0;
470 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
472 switch (fp->maxpacksize) {
474 fp->rate_max = fp->rate_min = 44100;
478 fp->rate_max = fp->rate_min = 48000;
482 fp->rate_max = fp->rate_min = 96000;
485 usb_audio_err(chip, "unknown sample rate\n");
490 stream = (fp->endpoint & USB_DIR_IN)
491 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
492 err = snd_usb_add_audio_stream(chip, stream, fp);
497 usb_set_interface(chip->dev, fp->iface, 0);
502 * Create a standard mixer for the specified interface.
504 static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
505 struct usb_interface *iface,
506 struct usb_driver *driver,
507 const struct snd_usb_audio_quirk *quirk)
509 if (quirk->ifnum < 0)
512 return snd_usb_create_mixer(chip, quirk->ifnum, 0);
516 * audio-interface quirks
518 * returns zero if no standard audio/MIDI parsing is needed.
519 * returns a positive value if standard audio/midi interfaces are parsed
521 * returns a negative value at error.
523 int snd_usb_create_quirk(struct snd_usb_audio *chip,
524 struct usb_interface *iface,
525 struct usb_driver *driver,
526 const struct snd_usb_audio_quirk *quirk)
528 typedef int (*quirk_func_t)(struct snd_usb_audio *,
529 struct usb_interface *,
531 const struct snd_usb_audio_quirk *);
532 static const quirk_func_t quirk_funcs[] = {
533 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
534 [QUIRK_COMPOSITE] = create_composite_quirk,
535 [QUIRK_AUTODETECT] = create_autodetect_quirks,
536 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
537 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
538 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
539 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
540 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
541 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
542 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
543 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
544 [QUIRK_MIDI_CME] = create_any_midi_quirk,
545 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
546 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
547 [QUIRK_MIDI_CH345] = create_any_midi_quirk,
548 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
549 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
550 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
551 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
552 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
555 if (quirk->type < QUIRK_TYPE_COUNT) {
556 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
558 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
567 #define EXTIGY_FIRMWARE_SIZE_OLD 794
568 #define EXTIGY_FIRMWARE_SIZE_NEW 483
570 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
572 struct usb_host_config *config = dev->actconfig;
575 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
576 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
577 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
578 /* Send message to force it to reconnect with full interface. */
579 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
580 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
582 dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
583 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
584 &dev->descriptor, sizeof(dev->descriptor));
585 config = dev->actconfig;
587 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
588 err = usb_reset_configuration(dev);
590 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
591 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
592 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
593 return -ENODEV; /* quit this anyway */
598 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
602 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
603 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
606 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
607 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
614 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
618 if (dev->actconfig->desc.bConfigurationValue == 1) {
620 "Fast Track Pro switching to config #2\n");
621 /* This function has to be available by the usb core module.
622 * if it is not avialable the boot quirk has to be left out
623 * and the configuration has to be set by udev or hotplug
626 err = usb_driver_set_configuration(dev, 2);
629 "error usb_driver_set_configuration: %d\n",
631 /* Always return an error, so that we stop creating a device
632 that will just be destroyed and recreated with a new
636 dev_info(&dev->dev, "Fast Track Pro config OK\n");
642 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
643 * documented in the device's data sheet.
645 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
649 buf[1] = value & 0xff;
650 buf[2] = (value >> 8) & 0xff;
652 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
653 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
657 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
660 * Enable line-out driver mode, set headphone source to front
661 * channels, enable stereo mic.
663 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
667 * C-Media CM6206 is based on CM106 with two additional
668 * registers that are not documented in the data sheet.
669 * Values here are chosen based on sniffing USB traffic
672 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
675 int val[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
677 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
678 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
686 /* quirk for Plantronics GameCom 780 with CM6302 chip */
687 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
689 /* set the initial volume and don't change; other values are either
690 * too loud or silent due to firmware bug (bko#65251)
692 u8 buf[2] = { 0x74, 0xe3 };
693 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
694 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
695 UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
699 * Novation Twitch DJ controller
700 * Focusrite Novation Saffire 6 USB audio card
702 static int snd_usb_novation_boot_quirk(struct usb_device *dev)
704 /* preemptively set up the device because otherwise the
705 * raw MIDI endpoints are not active */
706 usb_set_interface(dev, 0, 1);
711 * This call will put the synth in "USB send" mode, i.e it will send MIDI
712 * messages through USB (this is disabled at startup). The synth will
713 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
714 * sign on its LCD. Values here are chosen based on sniffing USB traffic
717 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
719 int err, actual_length;
721 /* "midi send" enable */
722 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
724 void *buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
727 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
728 ARRAY_SIZE(seq), &actual_length, 1000);
737 * Some sound cards from Native Instruments are in fact compliant to the USB
738 * audio standard of version 2 and other approved USB standards, even though
739 * they come up as vendor-specific device when first connected.
741 * However, they can be told to come up with a new set of descriptors
742 * upon their next enumeration, and the interfaces announced by the new
743 * descriptors will then be handled by the kernel's class drivers. As the
744 * product ID will also change, no further checks are required.
747 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
749 int ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
750 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
751 1, 0, NULL, 0, 1000);
756 usb_reset_device(dev);
758 /* return -EAGAIN, so the creation of an audio interface for this
759 * temporary device is aborted. The device will reconnect with a
764 static void mbox2_setup_48_24_magic(struct usb_device *dev)
769 /* Choose 48000Hz permanently */
774 /* Send the magic! */
775 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
776 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
777 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
778 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
779 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
780 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
781 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
782 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
786 /* Digidesign Mbox 2 needs to load firmware onboard
787 * and driver must wait a few seconds for initialisation.
790 #define MBOX2_FIRMWARE_SIZE 646
791 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
792 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
794 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
796 struct usb_host_config *config = dev->actconfig;
798 u8 bootresponse[0x12];
802 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
804 if (fwsize != MBOX2_FIRMWARE_SIZE) {
805 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
809 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
812 bootresponse[0] = MBOX2_BOOT_LOADING;
813 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
814 msleep(500); /* 0.5 second delay */
815 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
816 /* Control magic - load onboard firmware */
817 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
818 if (bootresponse[0] == MBOX2_BOOT_READY)
820 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
824 if (bootresponse[0] != MBOX2_BOOT_READY) {
825 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
829 dev_dbg(&dev->dev, "device initialised!\n");
831 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
832 &dev->descriptor, sizeof(dev->descriptor));
833 config = dev->actconfig;
835 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
837 err = usb_reset_configuration(dev);
839 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
840 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
841 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
843 mbox2_setup_48_24_magic(dev);
845 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
847 return 0; /* Successful boot */
853 #define MAUDIO_SET 0x01 /* parse device_setup */
854 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
855 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
856 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
857 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
858 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
859 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
860 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
861 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
862 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
863 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
865 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
866 int iface, int altno)
868 /* Reset ALL ifaces to 0 altsetting.
869 * Call it for every possible altsetting of every interface.
871 usb_set_interface(chip->dev, iface, 0);
872 if (chip->setup & MAUDIO_SET) {
873 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
874 if (iface != 1 && iface != 2)
875 return 1; /* skip all interfaces but 1 and 2 */
878 if (iface == 1 || iface == 2)
879 return 1; /* skip interfaces 1 and 2 */
880 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
881 return 1; /* skip this altsetting */
882 mask = chip->setup & MAUDIO_SET_MASK;
883 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
884 return 1; /* skip this altsetting */
885 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
886 return 1; /* skip this altsetting */
887 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
888 return 1; /* skip this altsetting */
892 "using altsetting %d for interface %d config %d\n",
893 altno, iface, chip->setup);
894 return 0; /* keep this altsetting */
897 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
901 /* Reset ALL ifaces to 0 altsetting.
902 * Call it for every possible altsetting of every interface.
904 usb_set_interface(chip->dev, iface, 0);
906 if (chip->setup & MAUDIO_SET) {
908 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
909 return 1; /* skip this altsetting */
910 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
911 return 1; /* skip this altsetting */
912 mask = chip->setup & MAUDIO_SET_MASK;
913 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
914 return 1; /* skip this altsetting */
915 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
916 return 1; /* skip this altsetting */
917 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
918 return 1; /* skip this altsetting */
919 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
920 return 1; /* skip this altsetting */
923 return 0; /* keep this altsetting */
926 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
927 int iface, int altno)
929 /* Reset ALL ifaces to 0 altsetting.
930 * Call it for every possible altsetting of every interface.
932 usb_set_interface(chip->dev, iface, 0);
934 /* possible configuration where both inputs and only one output is
935 *used is not supported by the current setup
937 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
938 if (chip->setup & MAUDIO_SET_96K) {
939 if (altno != 3 && altno != 6)
941 } else if (chip->setup & MAUDIO_SET_DI) {
943 return 1; /* no analog input */
944 if (altno != 2 && altno != 5)
945 return 1; /* enable only altsets 2 and 5 */
948 return 1; /* disable digialt input */
949 if (altno != 2 && altno != 5)
950 return 1; /* enalbe only altsets 2 and 5 */
953 /* keep only 16-Bit mode */
959 "using altsetting %d for interface %d config %d\n",
960 altno, iface, chip->setup);
961 return 0; /* keep this altsetting */
964 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
968 /* audiophile usb: skip altsets incompatible with device_setup */
969 if (chip->usb_id == USB_ID(0x0763, 0x2003))
970 return audiophile_skip_setting_quirk(chip, iface, altno);
971 /* quattro usb: skip altsets incompatible with device_setup */
972 if (chip->usb_id == USB_ID(0x0763, 0x2001))
973 return quattro_skip_setting_quirk(chip, iface, altno);
974 /* fasttrackpro usb: skip altsets incompatible with device_setup */
975 if (chip->usb_id == USB_ID(0x0763, 0x2012))
976 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
981 int snd_usb_apply_boot_quirk(struct usb_device *dev,
982 struct usb_interface *intf,
983 const struct snd_usb_audio_quirk *quirk)
985 u32 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
986 le16_to_cpu(dev->descriptor.idProduct));
989 case USB_ID(0x041e, 0x3000):
990 /* SB Extigy needs special boot-up sequence */
991 /* if more models come, this will go to the quirk list. */
992 return snd_usb_extigy_boot_quirk(dev, intf);
994 case USB_ID(0x041e, 0x3020):
995 /* SB Audigy 2 NX needs its own boot-up magic, too */
996 return snd_usb_audigy2nx_boot_quirk(dev);
998 case USB_ID(0x10f5, 0x0200):
999 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1000 return snd_usb_cm106_boot_quirk(dev);
1002 case USB_ID(0x0d8c, 0x0102):
1003 /* C-Media CM6206 / CM106-Like Sound Device */
1004 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1005 return snd_usb_cm6206_boot_quirk(dev);
1007 case USB_ID(0x0dba, 0x3000):
1008 /* Digidesign Mbox 2 */
1009 return snd_usb_mbox2_boot_quirk(dev);
1011 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1012 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1013 return snd_usb_novation_boot_quirk(dev);
1015 case USB_ID(0x133e, 0x0815):
1016 /* Access Music VirusTI Desktop */
1017 return snd_usb_accessmusic_boot_quirk(dev);
1019 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1020 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1021 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1022 return snd_usb_nativeinstruments_boot_quirk(dev);
1023 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1024 return snd_usb_fasttrackpro_boot_quirk(dev);
1025 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1026 return snd_usb_gamecon780_boot_quirk(dev);
1033 * check if the device uses big-endian samples
1035 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
1037 /* it depends on altsetting whether the device is big-endian or not */
1038 switch (chip->usb_id) {
1039 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1040 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1041 fp->altsetting == 5 || fp->altsetting == 6)
1044 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1045 if (chip->setup == 0x00 ||
1046 fp->altsetting == 1 || fp->altsetting == 2 ||
1047 fp->altsetting == 3)
1050 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1051 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1052 fp->altsetting == 5 || fp->altsetting == 6)
1060 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1061 * not for interface.
1065 EMU_QUIRK_SR_44100HZ = 0,
1066 EMU_QUIRK_SR_48000HZ,
1067 EMU_QUIRK_SR_88200HZ,
1068 EMU_QUIRK_SR_96000HZ,
1069 EMU_QUIRK_SR_176400HZ,
1070 EMU_QUIRK_SR_192000HZ
1073 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1074 struct audioformat *fmt)
1076 unsigned char emu_samplerate_id = 0;
1078 /* When capture is active
1079 * sample rate shouldn't be changed
1080 * by playback substream
1082 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1083 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
1087 switch (fmt->rate_min) {
1089 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1092 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1095 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1098 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1101 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1104 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1107 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1108 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1111 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1112 struct audioformat *fmt)
1114 switch (subs->stream->chip->usb_id) {
1115 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1116 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1117 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1118 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1119 set_format_emu_quirk(subs, fmt);
1124 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1126 /* devices which do not support reading the sample rate. */
1127 switch (chip->usb_id) {
1128 case USB_ID(0x045E, 0x075D): /* MS Lifecam Cinema */
1129 case USB_ID(0x045E, 0x076D): /* MS Lifecam HD-5000 */
1130 case USB_ID(0x045E, 0x076F): /* MS Lifecam HD-6000 */
1131 case USB_ID(0x045E, 0x0772): /* MS Lifecam Studio */
1132 case USB_ID(0x045E, 0x0779): /* MS Lifecam HD-3000 */
1133 case USB_ID(0x047F, 0xAA05): /* Plantronics DA45 */
1134 case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */
1135 case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1136 case USB_ID(0x21B4, 0x0081): /* AudioQuest DragonFly */
1142 /* Marantz/Denon USB DACs need a vendor cmd to switch
1143 * between PCM and native DSD mode
1145 static bool is_marantz_denon_dac(unsigned int id)
1148 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1149 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1150 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1156 int snd_usb_select_mode_quirk(struct snd_usb_substream *subs,
1157 struct audioformat *fmt)
1159 struct usb_device *dev = subs->dev;
1162 if (is_marantz_denon_dac(subs->stream->chip->usb_id)) {
1163 /* First switch to alt set 0, otherwise the mode switch cmd
1164 * will not be accepted by the DAC
1166 err = usb_set_interface(dev, fmt->iface, 0);
1170 mdelay(20); /* Delay needed after setting the interface */
1172 switch (fmt->altsetting) {
1173 case 2: /* DSD mode requested */
1174 case 1: /* PCM mode requested */
1175 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1176 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1177 fmt->altsetting - 1, 1, NULL, 0);
1187 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1190 * "Playback Design" products send bogus feedback data at the start
1191 * of the stream. Ignore them.
1193 if ((le16_to_cpu(ep->chip->dev->descriptor.idVendor) == 0x23ba) &&
1194 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1195 ep->skip_packets = 4;
1198 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1199 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1200 * the stream is (re)started. When skipping packets 16 at endpoint
1201 * start up, the real world latency is stable within +/- 1 frame (also
1202 * across power cycles).
1204 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1205 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1206 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1207 ep->skip_packets = 16;
1210 void snd_usb_set_interface_quirk(struct usb_device *dev)
1213 * "Playback Design" products need a 50ms delay after setting the
1216 switch (le16_to_cpu(dev->descriptor.idVendor)) {
1217 case 0x23ba: /* Playback Design */
1218 case 0x0644: /* TEAC Corp. */
1224 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1225 __u8 request, __u8 requesttype, __u16 value,
1226 __u16 index, void *data, __u16 size)
1229 * "Playback Design" products need a 20ms delay after each
1230 * class compliant request
1232 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x23ba) &&
1233 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1237 * "TEAC Corp." products need a 20ms delay after each
1238 * class compliant request
1240 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x0644) &&
1241 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1244 /* Marantz/Denon devices with USB DAC functionality need a delay
1245 * after each class compliant request
1247 if (is_marantz_denon_dac(USB_ID(le16_to_cpu(dev->descriptor.idVendor),
1248 le16_to_cpu(dev->descriptor.idProduct)))
1249 && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1252 /* Zoom R16/24 needs a tiny delay here, otherwise requests like
1253 * get/set frequency return as failed despite actually succeeding.
1255 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x1686) &&
1256 (le16_to_cpu(dev->descriptor.idProduct) == 0x00dd) &&
1257 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1262 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1263 * augment the PCM format bit-field for DSD types. The UAC standards
1264 * don't have a designated bit field to denote DSD-capable interfaces,
1265 * hence all hardware that is known to support this format has to be
1268 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1269 struct audioformat *fp,
1270 unsigned int sample_bytes)
1272 /* Playback Designs */
1273 if (le16_to_cpu(chip->dev->descriptor.idVendor) == 0x23ba) {
1274 switch (fp->altsetting) {
1277 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1279 fp->dsd_bitrev = true;
1280 return SNDRV_PCM_FMTBIT_DSD_U8;
1282 fp->dsd_bitrev = true;
1283 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1287 /* XMOS based USB DACs */
1288 switch (chip->usb_id) {
1289 case USB_ID(0x20b1, 0x3008): /* iFi Audio micro/nano iDSD */
1290 case USB_ID(0x20b1, 0x2008): /* Matrix Audio X-Sabre */
1291 case USB_ID(0x20b1, 0x300a): /* Matrix Audio Mini-i Pro */
1292 case USB_ID(0x22d9, 0x0416): /* OPPO HA-1 */
1293 if (fp->altsetting == 2)
1294 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1297 case USB_ID(0x20b1, 0x000a): /* Gustard DAC-X20U */
1298 case USB_ID(0x20b1, 0x2009): /* DIYINHK DSD DXD 384kHz USB to I2S/DSD */
1299 case USB_ID(0x20b1, 0x2023): /* JLsounds I2SoverUSB */
1300 case USB_ID(0x20b1, 0x3023): /* Aune X1S 32BIT/384 DSD DAC */
1301 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1302 if (fp->altsetting == 3)
1303 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1309 /* Denon/Marantz devices with USB DAC functionality */
1310 if (is_marantz_denon_dac(chip->usb_id)) {
1311 if (fp->altsetting == 2)
1312 return SNDRV_PCM_FMTBIT_DSD_U32_BE;