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>
22 #include <linux/bits.h>
24 #include <sound/control.h>
25 #include <sound/core.h>
26 #include <sound/info.h>
27 #include <sound/pcm.h>
32 #include "mixer_quirks.h"
42 * handle the quirks for the contained interfaces
44 static int create_composite_quirk(struct snd_usb_audio
*chip
,
45 struct usb_interface
*iface
,
46 struct usb_driver
*driver
,
47 const struct snd_usb_audio_quirk
*quirk_comp
)
49 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
50 const struct snd_usb_audio_quirk
*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
))
60 err
= snd_usb_create_quirk(chip
, iface
, driver
, quirk
);
65 for (quirk
= quirk_comp
->data
; quirk
->ifnum
>= 0; ++quirk
) {
66 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
69 if (quirk
->ifnum
!= probed_ifnum
&&
70 !usb_interface_claimed(iface
))
71 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
77 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
78 struct usb_interface
*iface
,
79 struct usb_driver
*driver
,
80 const struct snd_usb_audio_quirk
*quirk
)
87 * Allow alignment on audio sub-slot (channel samples) rather than
88 * on audio slots (audio frames)
90 static int create_align_transfer_quirk(struct snd_usb_audio
*chip
,
91 struct usb_interface
*iface
,
92 struct usb_driver
*driver
,
93 const struct snd_usb_audio_quirk
*quirk
)
96 return 1; /* Continue with creating streams and mixer */
99 static int create_any_midi_quirk(struct snd_usb_audio
*chip
,
100 struct usb_interface
*intf
,
101 struct usb_driver
*driver
,
102 const struct snd_usb_audio_quirk
*quirk
)
104 return snd_usbmidi_create(chip
->card
, intf
, &chip
->midi_list
, quirk
);
108 * create a stream for an interface with proper descriptors
110 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
111 struct usb_interface
*iface
,
112 struct usb_driver
*driver
,
113 const struct snd_usb_audio_quirk
*quirk
)
115 struct usb_host_interface
*alts
;
116 struct usb_interface_descriptor
*altsd
;
119 if (chip
->usb_id
== USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
120 chip
->tx_length_quirk
= 1;
122 alts
= &iface
->altsetting
[0];
123 altsd
= get_iface_desc(alts
);
124 err
= snd_usb_parse_audio_interface(chip
, altsd
->bInterfaceNumber
);
126 usb_audio_err(chip
, "cannot setup if %d: error %d\n",
127 altsd
->bInterfaceNumber
, err
);
130 /* reset the current interface */
131 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
136 * create a stream for an endpoint/altsetting without proper descriptors
138 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
139 struct usb_interface
*iface
,
140 struct usb_driver
*driver
,
141 const struct snd_usb_audio_quirk
*quirk
)
143 struct audioformat
*fp
;
144 struct usb_host_interface
*alts
;
145 struct usb_interface_descriptor
*altsd
;
147 unsigned *rate_table
= NULL
;
149 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
153 INIT_LIST_HEAD(&fp
->list
);
154 if (fp
->nr_rates
> MAX_NR_RATES
) {
158 if (fp
->nr_rates
> 0) {
159 rate_table
= kmemdup(fp
->rate_table
,
160 sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
165 fp
->rate_table
= rate_table
;
168 stream
= (fp
->endpoint
& USB_DIR_IN
)
169 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
170 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
173 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
174 fp
->altset_idx
>= iface
->num_altsetting
) {
178 alts
= &iface
->altsetting
[fp
->altset_idx
];
179 altsd
= get_iface_desc(alts
);
180 if (altsd
->bNumEndpoints
< 1) {
185 fp
->protocol
= altsd
->bInterfaceProtocol
;
187 if (fp
->datainterval
== 0)
188 fp
->datainterval
= snd_usb_parse_datainterval(chip
, alts
);
189 if (fp
->maxpacksize
== 0)
190 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
191 usb_set_interface(chip
->dev
, fp
->iface
, 0);
192 snd_usb_init_pitch(chip
, fp
->iface
, alts
, fp
);
193 snd_usb_init_sample_rate(chip
, fp
->iface
, alts
, fp
, fp
->rate_max
);
197 list_del(&fp
->list
); /* unlink for avoiding double-free */
203 static int create_auto_pcm_quirk(struct snd_usb_audio
*chip
,
204 struct usb_interface
*iface
,
205 struct usb_driver
*driver
)
207 struct usb_host_interface
*alts
;
208 struct usb_interface_descriptor
*altsd
;
209 struct usb_endpoint_descriptor
*epd
;
210 struct uac1_as_header_descriptor
*ashd
;
211 struct uac_format_type_i_discrete_descriptor
*fmtd
;
214 * Most Roland/Yamaha audio streaming interfaces have more or less
215 * standard descriptors, but older devices might lack descriptors, and
216 * future ones might change, so ensure that we fail silently if the
217 * interface doesn't look exactly right.
220 /* must have a non-zero altsetting for streaming */
221 if (iface
->num_altsetting
< 2)
223 alts
= &iface
->altsetting
[1];
224 altsd
= get_iface_desc(alts
);
226 /* must have an isochronous endpoint for streaming */
227 if (altsd
->bNumEndpoints
< 1)
229 epd
= get_endpoint(alts
, 0);
230 if (!usb_endpoint_xfer_isoc(epd
))
233 /* must have format descriptors */
234 ashd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
236 fmtd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
238 if (!ashd
|| ashd
->bLength
< 7 ||
239 !fmtd
|| fmtd
->bLength
< 8)
242 return create_standard_audio_quirk(chip
, iface
, driver
, NULL
);
245 static int create_yamaha_midi_quirk(struct snd_usb_audio
*chip
,
246 struct usb_interface
*iface
,
247 struct usb_driver
*driver
,
248 struct usb_host_interface
*alts
)
250 static const struct snd_usb_audio_quirk yamaha_midi_quirk
= {
251 .type
= QUIRK_MIDI_YAMAHA
253 struct usb_midi_in_jack_descriptor
*injd
;
254 struct usb_midi_out_jack_descriptor
*outjd
;
256 /* must have some valid jack descriptors */
257 injd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
258 NULL
, USB_MS_MIDI_IN_JACK
);
259 outjd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
260 NULL
, USB_MS_MIDI_OUT_JACK
);
263 if (injd
&& (injd
->bLength
< 5 ||
264 (injd
->bJackType
!= USB_MS_EMBEDDED
&&
265 injd
->bJackType
!= USB_MS_EXTERNAL
)))
267 if (outjd
&& (outjd
->bLength
< 6 ||
268 (outjd
->bJackType
!= USB_MS_EMBEDDED
&&
269 outjd
->bJackType
!= USB_MS_EXTERNAL
)))
271 return create_any_midi_quirk(chip
, iface
, driver
, &yamaha_midi_quirk
);
274 static int create_roland_midi_quirk(struct snd_usb_audio
*chip
,
275 struct usb_interface
*iface
,
276 struct usb_driver
*driver
,
277 struct usb_host_interface
*alts
)
279 static const struct snd_usb_audio_quirk roland_midi_quirk
= {
280 .type
= QUIRK_MIDI_ROLAND
282 u8
*roland_desc
= NULL
;
284 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
286 roland_desc
= snd_usb_find_csint_desc(alts
->extra
,
291 if (roland_desc
[0] < 6 || roland_desc
[3] != 2)
293 return create_any_midi_quirk(chip
, iface
, driver
,
298 static int create_std_midi_quirk(struct snd_usb_audio
*chip
,
299 struct usb_interface
*iface
,
300 struct usb_driver
*driver
,
301 struct usb_host_interface
*alts
)
303 struct usb_ms_header_descriptor
*mshd
;
304 struct usb_ms_endpoint_descriptor
*msepd
;
306 /* must have the MIDIStreaming interface header descriptor*/
307 mshd
= (struct usb_ms_header_descriptor
*)alts
->extra
;
308 if (alts
->extralen
< 7 ||
310 mshd
->bDescriptorType
!= USB_DT_CS_INTERFACE
||
311 mshd
->bDescriptorSubtype
!= USB_MS_HEADER
)
313 /* must have the MIDIStreaming endpoint descriptor*/
314 msepd
= (struct usb_ms_endpoint_descriptor
*)alts
->endpoint
[0].extra
;
315 if (alts
->endpoint
[0].extralen
< 4 ||
316 msepd
->bLength
< 4 ||
317 msepd
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
318 msepd
->bDescriptorSubtype
!= UAC_MS_GENERAL
||
319 msepd
->bNumEmbMIDIJack
< 1 ||
320 msepd
->bNumEmbMIDIJack
> 16)
323 return create_any_midi_quirk(chip
, iface
, driver
, NULL
);
326 static int create_auto_midi_quirk(struct snd_usb_audio
*chip
,
327 struct usb_interface
*iface
,
328 struct usb_driver
*driver
)
330 struct usb_host_interface
*alts
;
331 struct usb_interface_descriptor
*altsd
;
332 struct usb_endpoint_descriptor
*epd
;
335 alts
= &iface
->altsetting
[0];
336 altsd
= get_iface_desc(alts
);
338 /* must have at least one bulk/interrupt endpoint for streaming */
339 if (altsd
->bNumEndpoints
< 1)
341 epd
= get_endpoint(alts
, 0);
342 if (!usb_endpoint_xfer_bulk(epd
) &&
343 !usb_endpoint_xfer_int(epd
))
346 switch (USB_ID_VENDOR(chip
->usb_id
)) {
347 case 0x0499: /* Yamaha */
348 err
= create_yamaha_midi_quirk(chip
, iface
, driver
, alts
);
352 case 0x0582: /* Roland */
353 err
= create_roland_midi_quirk(chip
, iface
, driver
, alts
);
359 return create_std_midi_quirk(chip
, iface
, driver
, alts
);
362 static int create_autodetect_quirk(struct snd_usb_audio
*chip
,
363 struct usb_interface
*iface
,
364 struct usb_driver
*driver
)
368 err
= create_auto_pcm_quirk(chip
, iface
, driver
);
370 err
= create_auto_midi_quirk(chip
, iface
, driver
);
374 static int create_autodetect_quirks(struct snd_usb_audio
*chip
,
375 struct usb_interface
*iface
,
376 struct usb_driver
*driver
,
377 const struct snd_usb_audio_quirk
*quirk
)
379 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
380 int ifcount
, ifnum
, err
;
382 err
= create_autodetect_quirk(chip
, iface
, driver
);
387 * ALSA PCM playback/capture devices cannot be registered in two steps,
388 * so we have to claim the other corresponding interface here.
390 ifcount
= chip
->dev
->actconfig
->desc
.bNumInterfaces
;
391 for (ifnum
= 0; ifnum
< ifcount
; ifnum
++) {
392 if (ifnum
== probed_ifnum
|| quirk
->ifnum
>= 0)
394 iface
= usb_ifnum_to_if(chip
->dev
, ifnum
);
396 usb_interface_claimed(iface
) ||
397 get_iface_desc(iface
->altsetting
)->bInterfaceClass
!=
398 USB_CLASS_VENDOR_SPEC
)
401 err
= create_autodetect_quirk(chip
, iface
, driver
);
403 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
410 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
411 * The only way to detect the sample rate is by looking at wMaxPacketSize.
413 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
414 struct usb_interface
*iface
,
415 struct usb_driver
*driver
,
416 const struct snd_usb_audio_quirk
*quirk
)
418 static const struct audioformat ua_format
= {
419 .formats
= SNDRV_PCM_FMTBIT_S24_3LE
,
421 .fmt_type
= UAC_FORMAT_TYPE_I
,
424 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
426 struct usb_host_interface
*alts
;
427 struct usb_interface_descriptor
*altsd
;
428 struct audioformat
*fp
;
431 /* both PCM and MIDI interfaces have 2 or more altsettings */
432 if (iface
->num_altsetting
< 2)
434 alts
= &iface
->altsetting
[1];
435 altsd
= get_iface_desc(alts
);
437 if (altsd
->bNumEndpoints
== 2) {
438 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
439 .out_cables
= 0x0003,
442 static const struct snd_usb_audio_quirk ua700_quirk
= {
443 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
446 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
447 .out_cables
= 0x0001,
450 static const struct snd_usb_audio_quirk uaxx_quirk
= {
451 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
454 const struct snd_usb_audio_quirk
*quirk
=
455 chip
->usb_id
== USB_ID(0x0582, 0x002b)
456 ? &ua700_quirk
: &uaxx_quirk
;
457 return __snd_usbmidi_create(chip
->card
, iface
,
458 &chip
->midi_list
, quirk
,
462 if (altsd
->bNumEndpoints
!= 1)
465 fp
= kmemdup(&ua_format
, sizeof(*fp
), GFP_KERNEL
);
469 fp
->iface
= altsd
->bInterfaceNumber
;
470 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
471 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
472 fp
->datainterval
= 0;
473 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
474 INIT_LIST_HEAD(&fp
->list
);
476 switch (fp
->maxpacksize
) {
478 fp
->rate_max
= fp
->rate_min
= 44100;
482 fp
->rate_max
= fp
->rate_min
= 48000;
486 fp
->rate_max
= fp
->rate_min
= 96000;
489 usb_audio_err(chip
, "unknown sample rate\n");
494 stream
= (fp
->endpoint
& USB_DIR_IN
)
495 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
496 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
498 list_del(&fp
->list
); /* unlink for avoiding double-free */
502 usb_set_interface(chip
->dev
, fp
->iface
, 0);
507 * Create a standard mixer for the specified interface.
509 static int create_standard_mixer_quirk(struct snd_usb_audio
*chip
,
510 struct usb_interface
*iface
,
511 struct usb_driver
*driver
,
512 const struct snd_usb_audio_quirk
*quirk
)
514 if (quirk
->ifnum
< 0)
517 return snd_usb_create_mixer(chip
, quirk
->ifnum
, 0);
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
,
560 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
561 return quirk_funcs
[quirk
->type
](chip
, iface
, driver
, quirk
);
563 usb_audio_err(chip
, "invalid quirk type %d\n", quirk
->type
);
572 #define EXTIGY_FIRMWARE_SIZE_OLD 794
573 #define EXTIGY_FIRMWARE_SIZE_NEW 483
575 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
577 struct usb_host_config
*config
= dev
->actconfig
;
580 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
581 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
582 dev_dbg(&dev
->dev
, "sending Extigy boot sequence...\n");
583 /* Send message to force it to reconnect with full interface. */
584 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
585 0x10, 0x43, 0x0001, 0x000a, NULL
, 0);
587 dev_dbg(&dev
->dev
, "error sending boot message: %d\n", err
);
588 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
589 &dev
->descriptor
, sizeof(dev
->descriptor
));
590 config
= dev
->actconfig
;
592 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
593 err
= usb_reset_configuration(dev
);
595 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
596 dev_dbg(&dev
->dev
, "extigy_boot: new boot length = %d\n",
597 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
598 return -ENODEV
; /* quit this anyway */
603 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
607 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
608 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
611 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
612 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
619 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device
*dev
)
623 if (dev
->actconfig
->desc
.bConfigurationValue
== 1) {
625 "Fast Track Pro switching to config #2\n");
626 /* This function has to be available by the usb core module.
627 * if it is not avialable the boot quirk has to be left out
628 * and the configuration has to be set by udev or hotplug
631 err
= usb_driver_set_configuration(dev
, 2);
634 "error usb_driver_set_configuration: %d\n",
636 /* Always return an error, so that we stop creating a device
637 that will just be destroyed and recreated with a new
641 dev_info(&dev
->dev
, "Fast Track Pro config OK\n");
647 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
648 * documented in the device's data sheet.
650 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
654 buf
[1] = value
& 0xff;
655 buf
[2] = (value
>> 8) & 0xff;
657 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
658 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
662 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
665 * Enable line-out driver mode, set headphone source to front
666 * channels, enable stereo mic.
668 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
672 * CM6206 registers from the CM6206 datasheet rev 2.1
674 #define CM6206_REG0_DMA_MASTER BIT(15)
675 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
676 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
677 /* Bit 4 thru 11 is the S/PDIF category code */
678 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
679 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
680 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
681 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
682 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
684 #define CM6206_REG1_TEST_SEL_CLK BIT(14)
685 #define CM6206_REG1_PLLBIN_EN BIT(13)
686 #define CM6206_REG1_SOFT_MUTE_EN BIT(12)
687 #define CM6206_REG1_GPIO4_OUT BIT(11)
688 #define CM6206_REG1_GPIO4_OE BIT(10)
689 #define CM6206_REG1_GPIO3_OUT BIT(9)
690 #define CM6206_REG1_GPIO3_OE BIT(8)
691 #define CM6206_REG1_GPIO2_OUT BIT(7)
692 #define CM6206_REG1_GPIO2_OE BIT(6)
693 #define CM6206_REG1_GPIO1_OUT BIT(5)
694 #define CM6206_REG1_GPIO1_OE BIT(4)
695 #define CM6206_REG1_SPDIFO_INVALID BIT(3)
696 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
697 #define CM6206_REG1_SPDIFO_DIS BIT(1)
698 #define CM6206_REG1_SPDIFI_MIX BIT(0)
700 #define CM6206_REG2_DRIVER_ON BIT(15)
701 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
702 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
703 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
704 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
705 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
706 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
707 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
708 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
709 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
710 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
711 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
712 #define CM6206_REG2_MUTE_CENTER BIT(5)
713 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
714 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
715 #define CM6206_REG2_EN_BTL BIT(2)
716 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
717 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
718 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
719 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
721 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
722 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
723 #define CM6206_REG3_VRAP25EN BIT(10)
724 #define CM6206_REG3_MSEL1 BIT(9)
725 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
726 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
727 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
728 #define CM6206_REG3_PINSEL BIT(6)
729 #define CM6206_REG3_FOE BIT(5)
730 #define CM6206_REG3_ROE BIT(4)
731 #define CM6206_REG3_CBOE BIT(3)
732 #define CM6206_REG3_LOSE BIT(2)
733 #define CM6206_REG3_HPOE BIT(1)
734 #define CM6206_REG3_SPDIFI_CANREC BIT(0)
736 #define CM6206_REG5_DA_RSTN BIT(13)
737 #define CM6206_REG5_AD_RSTN BIT(12)
738 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
739 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
740 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
741 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
742 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
743 #define CM6206_REG5_CODECM BIT(8)
744 #define CM6206_REG5_EN_HPF BIT(7)
745 #define CM6206_REG5_T_SEL_DSDA4 BIT(6)
746 #define CM6206_REG5_T_SEL_DSDA3 BIT(5)
747 #define CM6206_REG5_T_SEL_DSDA2 BIT(4)
748 #define CM6206_REG5_T_SEL_DSDA1 BIT(3)
749 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
750 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4
751 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
752 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
753 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
755 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
760 * Values here are chosen based on sniffing USB traffic
763 * REG0: DAC is master, sample rate 48kHz, no copyright
765 CM6206_REG0_SPDIFO_RATE_48K
|
766 CM6206_REG0_SPDIFO_COPYRIGHT_NA
,
768 * REG1: PLL binary search enable, soft mute enable.
770 CM6206_REG1_PLLBIN_EN
|
771 CM6206_REG1_SOFT_MUTE_EN
,
773 * REG2: enable output drivers,
774 * select front channels to the headphone output,
775 * then mute the headphone channels, run the MCU
778 CM6206_REG2_DRIVER_ON
|
779 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS
|
780 CM6206_REG2_MUTE_HEADPHONE_RIGHT
|
781 CM6206_REG2_MUTE_HEADPHONE_LEFT
,
783 * REG3: default flyspeed, set 2.5V mic bias
784 * enable all line out ports and enable SPDIF
786 CM6206_REG3_FLYSPEED_DEFAULT
|
787 CM6206_REG3_VRAP25EN
|
793 CM6206_REG3_SPDIFI_CANREC
,
794 /* REG4 is just a bunch of GPIO lines */
796 /* REG5: de-assert AD/DA reset signals */
797 CM6206_REG5_DA_RSTN
|
798 CM6206_REG5_AD_RSTN
};
800 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
801 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
809 /* quirk for Plantronics GameCom 780 with CM6302 chip */
810 static int snd_usb_gamecon780_boot_quirk(struct usb_device
*dev
)
812 /* set the initial volume and don't change; other values are either
813 * too loud or silent due to firmware bug (bko#65251)
815 u8 buf
[2] = { 0x74, 0xe3 };
816 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
817 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
818 UAC_FU_VOLUME
<< 8, 9 << 8, buf
, 2);
822 * Novation Twitch DJ controller
823 * Focusrite Novation Saffire 6 USB audio card
825 static int snd_usb_novation_boot_quirk(struct usb_device
*dev
)
827 /* preemptively set up the device because otherwise the
828 * raw MIDI endpoints are not active */
829 usb_set_interface(dev
, 0, 1);
834 * This call will put the synth in "USB send" mode, i.e it will send MIDI
835 * messages through USB (this is disabled at startup). The synth will
836 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
837 * sign on its LCD. Values here are chosen based on sniffing USB traffic
840 static int snd_usb_accessmusic_boot_quirk(struct usb_device
*dev
)
842 int err
, actual_length
;
844 /* "midi send" enable */
845 static const u8 seq
[] = { 0x4e, 0x73, 0x52, 0x01 };
847 void *buf
= kmemdup(seq
, ARRAY_SIZE(seq
), GFP_KERNEL
);
850 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x05), buf
,
851 ARRAY_SIZE(seq
), &actual_length
, 1000);
860 * Some sound cards from Native Instruments are in fact compliant to the USB
861 * audio standard of version 2 and other approved USB standards, even though
862 * they come up as vendor-specific device when first connected.
864 * However, they can be told to come up with a new set of descriptors
865 * upon their next enumeration, and the interfaces announced by the new
866 * descriptors will then be handled by the kernel's class drivers. As the
867 * product ID will also change, no further checks are required.
870 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device
*dev
)
872 int ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
873 0xaf, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
874 1, 0, NULL
, 0, 1000);
879 usb_reset_device(dev
);
881 /* return -EAGAIN, so the creation of an audio interface for this
882 * temporary device is aborted. The device will reconnect with a
887 static void mbox2_setup_48_24_magic(struct usb_device
*dev
)
892 /* Choose 48000Hz permanently */
897 /* Send the magic! */
898 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
899 0x01, 0x22, 0x0100, 0x0085, &temp
, 0x0003);
900 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
901 0x81, 0xa2, 0x0100, 0x0085, &srate
, 0x0003);
902 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
903 0x81, 0xa2, 0x0100, 0x0086, &srate
, 0x0003);
904 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
905 0x81, 0xa2, 0x0100, 0x0003, &srate
, 0x0003);
909 /* Digidesign Mbox 2 needs to load firmware onboard
910 * and driver must wait a few seconds for initialisation.
913 #define MBOX2_FIRMWARE_SIZE 646
914 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
915 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
917 static int snd_usb_mbox2_boot_quirk(struct usb_device
*dev
)
919 struct usb_host_config
*config
= dev
->actconfig
;
921 u8 bootresponse
[0x12];
925 fwsize
= le16_to_cpu(get_cfg_desc(config
)->wTotalLength
);
927 if (fwsize
!= MBOX2_FIRMWARE_SIZE
) {
928 dev_err(&dev
->dev
, "Invalid firmware size=%d.\n", fwsize
);
932 dev_dbg(&dev
->dev
, "Sending Digidesign Mbox 2 boot sequence...\n");
935 bootresponse
[0] = MBOX2_BOOT_LOADING
;
936 while ((bootresponse
[0] == MBOX2_BOOT_LOADING
) && (count
< 10)) {
937 msleep(500); /* 0.5 second delay */
938 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
939 /* Control magic - load onboard firmware */
940 0x85, 0xc0, 0x0001, 0x0000, &bootresponse
, 0x0012);
941 if (bootresponse
[0] == MBOX2_BOOT_READY
)
943 dev_dbg(&dev
->dev
, "device not ready, resending boot sequence...\n");
947 if (bootresponse
[0] != MBOX2_BOOT_READY
) {
948 dev_err(&dev
->dev
, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse
[0]);
952 dev_dbg(&dev
->dev
, "device initialised!\n");
954 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
955 &dev
->descriptor
, sizeof(dev
->descriptor
));
956 config
= dev
->actconfig
;
958 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
960 err
= usb_reset_configuration(dev
);
962 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
963 dev_dbg(&dev
->dev
, "mbox2_boot: new boot length = %d\n",
964 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
966 mbox2_setup_48_24_magic(dev
);
968 dev_info(&dev
->dev
, "Digidesign Mbox 2: 24bit 48kHz");
970 return 0; /* Successful boot */
973 static int snd_usb_axefx3_boot_quirk(struct usb_device
*dev
)
977 dev_dbg(&dev
->dev
, "Waiting for Axe-Fx III to boot up...\n");
979 /* If the Axe-Fx III has not fully booted, it will timeout when trying
980 * to enable the audio streaming interface. A more generous timeout is
981 * used here to detect when the Axe-Fx III has finished booting as the
982 * set interface message will be acked once it has
984 err
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
985 USB_REQ_SET_INTERFACE
, USB_RECIP_INTERFACE
,
986 1, 1, NULL
, 0, 120000);
989 "failed waiting for Axe-Fx III to boot: %d\n", err
);
993 dev_dbg(&dev
->dev
, "Axe-Fx III is now ready\n");
995 err
= usb_set_interface(dev
, 1, 0);
998 "error stopping Axe-Fx III interface: %d\n", err
);
1004 #define MICROBOOK_BUF_SIZE 128
1006 static int snd_usb_motu_microbookii_communicate(struct usb_device
*dev
, u8
*buf
,
1007 int buf_size
, int *length
)
1009 int err
, actual_length
;
1011 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x01), buf
, *length
,
1012 &actual_length
, 1000);
1016 print_hex_dump(KERN_DEBUG
, "MicroBookII snd: ", DUMP_PREFIX_NONE
, 16, 1,
1017 buf
, actual_length
, false);
1019 memset(buf
, 0, buf_size
);
1021 err
= usb_interrupt_msg(dev
, usb_rcvintpipe(dev
, 0x82), buf
, buf_size
,
1022 &actual_length
, 1000);
1026 print_hex_dump(KERN_DEBUG
, "MicroBookII rcv: ", DUMP_PREFIX_NONE
, 16, 1,
1027 buf
, actual_length
, false);
1029 *length
= actual_length
;
1033 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device
*dev
)
1035 int err
, actual_length
, poll_attempts
= 0;
1036 static const u8 set_samplerate_seq
[] = { 0x00, 0x00, 0x00, 0x00,
1037 0x00, 0x00, 0x0b, 0x14,
1038 0x00, 0x00, 0x00, 0x01 };
1039 static const u8 poll_ready_seq
[] = { 0x00, 0x04, 0x00, 0x00,
1040 0x00, 0x00, 0x0b, 0x18 };
1041 u8
*buf
= kzalloc(MICROBOOK_BUF_SIZE
, GFP_KERNEL
);
1046 dev_info(&dev
->dev
, "Waiting for MOTU Microbook II to boot up...\n");
1048 /* First we tell the device which sample rate to use. */
1049 memcpy(buf
, set_samplerate_seq
, sizeof(set_samplerate_seq
));
1050 actual_length
= sizeof(set_samplerate_seq
);
1051 err
= snd_usb_motu_microbookii_communicate(dev
, buf
, MICROBOOK_BUF_SIZE
,
1056 "failed setting the sample rate for Motu MicroBook II: %d\n",
1061 /* Then we poll every 100 ms until the device informs of its readiness. */
1063 if (++poll_attempts
> 100) {
1065 "failed booting Motu MicroBook II: timeout\n");
1070 memset(buf
, 0, MICROBOOK_BUF_SIZE
);
1071 memcpy(buf
, poll_ready_seq
, sizeof(poll_ready_seq
));
1073 actual_length
= sizeof(poll_ready_seq
);
1074 err
= snd_usb_motu_microbookii_communicate(
1075 dev
, buf
, MICROBOOK_BUF_SIZE
, &actual_length
);
1078 "failed booting Motu MicroBook II: communication error %d\n",
1083 /* the device signals its readiness through a message of the
1085 * XX 06 00 00 00 00 0b 18 00 00 00 01
1086 * If the device is not yet ready to accept audio data, the
1087 * last byte of that sequence is 00.
1089 if (actual_length
== 12 && buf
[actual_length
- 1] == 1)
1095 dev_info(&dev
->dev
, "MOTU MicroBook II ready\n");
1105 #define MAUDIO_SET 0x01 /* parse device_setup */
1106 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
1107 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
1108 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
1109 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
1110 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
1111 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
1112 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
1113 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
1114 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
1115 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
1117 static int quattro_skip_setting_quirk(struct snd_usb_audio
*chip
,
1118 int iface
, int altno
)
1120 /* Reset ALL ifaces to 0 altsetting.
1121 * Call it for every possible altsetting of every interface.
1123 usb_set_interface(chip
->dev
, iface
, 0);
1124 if (chip
->setup
& MAUDIO_SET
) {
1125 if (chip
->setup
& MAUDIO_SET_COMPATIBLE
) {
1126 if (iface
!= 1 && iface
!= 2)
1127 return 1; /* skip all interfaces but 1 and 2 */
1130 if (iface
== 1 || iface
== 2)
1131 return 1; /* skip interfaces 1 and 2 */
1132 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
1133 return 1; /* skip this altsetting */
1134 mask
= chip
->setup
& MAUDIO_SET_MASK
;
1135 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
1136 return 1; /* skip this altsetting */
1137 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
1138 return 1; /* skip this altsetting */
1139 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 4)
1140 return 1; /* skip this altsetting */
1144 "using altsetting %d for interface %d config %d\n",
1145 altno
, iface
, chip
->setup
);
1146 return 0; /* keep this altsetting */
1149 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
1153 /* Reset ALL ifaces to 0 altsetting.
1154 * Call it for every possible altsetting of every interface.
1156 usb_set_interface(chip
->dev
, iface
, 0);
1158 if (chip
->setup
& MAUDIO_SET
) {
1160 if ((chip
->setup
& MAUDIO_SET_DTS
) && altno
!= 6)
1161 return 1; /* skip this altsetting */
1162 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
1163 return 1; /* skip this altsetting */
1164 mask
= chip
->setup
& MAUDIO_SET_MASK
;
1165 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
1166 return 1; /* skip this altsetting */
1167 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
1168 return 1; /* skip this altsetting */
1169 if (mask
== MAUDIO_SET_16B_48K_DI
&& altno
!= 4)
1170 return 1; /* skip this altsetting */
1171 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 5)
1172 return 1; /* skip this altsetting */
1175 return 0; /* keep this altsetting */
1178 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio
*chip
,
1179 int iface
, int altno
)
1181 /* Reset ALL ifaces to 0 altsetting.
1182 * Call it for every possible altsetting of every interface.
1184 usb_set_interface(chip
->dev
, iface
, 0);
1186 /* possible configuration where both inputs and only one output is
1187 *used is not supported by the current setup
1189 if (chip
->setup
& (MAUDIO_SET
| MAUDIO_SET_24B
)) {
1190 if (chip
->setup
& MAUDIO_SET_96K
) {
1191 if (altno
!= 3 && altno
!= 6)
1193 } else if (chip
->setup
& MAUDIO_SET_DI
) {
1195 return 1; /* no analog input */
1196 if (altno
!= 2 && altno
!= 5)
1197 return 1; /* enable only altsets 2 and 5 */
1200 return 1; /* disable digialt input */
1201 if (altno
!= 2 && altno
!= 5)
1202 return 1; /* enalbe only altsets 2 and 5 */
1205 /* keep only 16-Bit mode */
1211 "using altsetting %d for interface %d config %d\n",
1212 altno
, iface
, chip
->setup
);
1213 return 0; /* keep this altsetting */
1216 int snd_usb_apply_interface_quirk(struct snd_usb_audio
*chip
,
1220 /* audiophile usb: skip altsets incompatible with device_setup */
1221 if (chip
->usb_id
== USB_ID(0x0763, 0x2003))
1222 return audiophile_skip_setting_quirk(chip
, iface
, altno
);
1223 /* quattro usb: skip altsets incompatible with device_setup */
1224 if (chip
->usb_id
== USB_ID(0x0763, 0x2001))
1225 return quattro_skip_setting_quirk(chip
, iface
, altno
);
1226 /* fasttrackpro usb: skip altsets incompatible with device_setup */
1227 if (chip
->usb_id
== USB_ID(0x0763, 0x2012))
1228 return fasttrackpro_skip_setting_quirk(chip
, iface
, altno
);
1233 int snd_usb_apply_boot_quirk(struct usb_device
*dev
,
1234 struct usb_interface
*intf
,
1235 const struct snd_usb_audio_quirk
*quirk
,
1239 case USB_ID(0x041e, 0x3000):
1240 /* SB Extigy needs special boot-up sequence */
1241 /* if more models come, this will go to the quirk list. */
1242 return snd_usb_extigy_boot_quirk(dev
, intf
);
1244 case USB_ID(0x041e, 0x3020):
1245 /* SB Audigy 2 NX needs its own boot-up magic, too */
1246 return snd_usb_audigy2nx_boot_quirk(dev
);
1248 case USB_ID(0x10f5, 0x0200):
1249 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1250 return snd_usb_cm106_boot_quirk(dev
);
1252 case USB_ID(0x0d8c, 0x0102):
1253 /* C-Media CM6206 / CM106-Like Sound Device */
1254 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1255 return snd_usb_cm6206_boot_quirk(dev
);
1257 case USB_ID(0x0dba, 0x3000):
1258 /* Digidesign Mbox 2 */
1259 return snd_usb_mbox2_boot_quirk(dev
);
1261 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1262 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1263 return snd_usb_novation_boot_quirk(dev
);
1265 case USB_ID(0x133e, 0x0815):
1266 /* Access Music VirusTI Desktop */
1267 return snd_usb_accessmusic_boot_quirk(dev
);
1269 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1270 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1271 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1272 return snd_usb_nativeinstruments_boot_quirk(dev
);
1273 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1274 return snd_usb_fasttrackpro_boot_quirk(dev
);
1275 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1276 return snd_usb_gamecon780_boot_quirk(dev
);
1277 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1278 return snd_usb_axefx3_boot_quirk(dev
);
1279 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1280 return snd_usb_motu_microbookii_boot_quirk(dev
);
1287 * check if the device uses big-endian samples
1289 int snd_usb_is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
1291 /* it depends on altsetting whether the device is big-endian or not */
1292 switch (chip
->usb_id
) {
1293 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1294 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1295 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1298 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1299 if (chip
->setup
== 0x00 ||
1300 fp
->altsetting
== 1 || fp
->altsetting
== 2 ||
1301 fp
->altsetting
== 3)
1304 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1305 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1306 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1314 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1315 * not for interface.
1319 EMU_QUIRK_SR_44100HZ
= 0,
1320 EMU_QUIRK_SR_48000HZ
,
1321 EMU_QUIRK_SR_88200HZ
,
1322 EMU_QUIRK_SR_96000HZ
,
1323 EMU_QUIRK_SR_176400HZ
,
1324 EMU_QUIRK_SR_192000HZ
1327 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
1328 struct audioformat
*fmt
)
1330 unsigned char emu_samplerate_id
= 0;
1332 /* When capture is active
1333 * sample rate shouldn't be changed
1334 * by playback substream
1336 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1337 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
1341 switch (fmt
->rate_min
) {
1343 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
1346 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
1349 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
1352 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
1355 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
1358 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
1361 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
1362 subs
->pkt_offset_adj
= (emu_samplerate_id
>= EMU_QUIRK_SR_176400HZ
) ? 4 : 0;
1365 void snd_usb_set_format_quirk(struct snd_usb_substream
*subs
,
1366 struct audioformat
*fmt
)
1368 switch (subs
->stream
->chip
->usb_id
) {
1369 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1370 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1371 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1372 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1373 set_format_emu_quirk(subs
, fmt
);
1378 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio
*chip
)
1380 /* devices which do not support reading the sample rate. */
1381 switch (chip
->usb_id
) {
1382 case USB_ID(0x041E, 0x4080): /* Creative Live Cam VF0610 */
1383 case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */
1384 case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
1385 case USB_ID(0x05A3, 0x9420): /* ELP HD USB Camera */
1386 case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1387 case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
1388 case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
1389 case USB_ID(0x21B4, 0x0081): /* AudioQuest DragonFly */
1393 /* devices of these vendors don't support reading rate, either */
1394 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1395 case 0x045E: /* MS Lifecam */
1396 case 0x047F: /* Plantronics */
1397 case 0x1de7: /* Phoenix Audio */
1404 /* ITF-USB DSD based DACs need a vendor cmd to switch
1405 * between PCM and native DSD mode
1407 static bool is_itf_usb_dsd_dac(unsigned int id
)
1410 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1411 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1412 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1413 case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
1414 case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
1415 case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
1416 case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
1422 int snd_usb_select_mode_quirk(struct snd_usb_substream
*subs
,
1423 struct audioformat
*fmt
)
1425 struct usb_device
*dev
= subs
->dev
;
1428 if (is_itf_usb_dsd_dac(subs
->stream
->chip
->usb_id
)) {
1429 /* First switch to alt set 0, otherwise the mode switch cmd
1430 * will not be accepted by the DAC
1432 err
= usb_set_interface(dev
, fmt
->iface
, 0);
1436 msleep(20); /* Delay needed after setting the interface */
1438 /* Vendor mode switch cmd is required. */
1439 if (fmt
->formats
& SNDRV_PCM_FMTBIT_DSD_U32_BE
) {
1440 /* DSD mode (DSD_U32) requested */
1441 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0,
1442 USB_DIR_OUT
|USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
,
1448 /* PCM or DOP mode (S32) requested */
1449 /* PCM mode (S16) requested */
1450 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0,
1451 USB_DIR_OUT
|USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
,
1462 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint
*ep
)
1465 * "Playback Design" products send bogus feedback data at the start
1466 * of the stream. Ignore them.
1468 if (USB_ID_VENDOR(ep
->chip
->usb_id
) == 0x23ba &&
1469 ep
->type
== SND_USB_ENDPOINT_TYPE_SYNC
)
1470 ep
->skip_packets
= 4;
1473 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1474 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1475 * the stream is (re)started. When skipping packets 16 at endpoint
1476 * start up, the real world latency is stable within +/- 1 frame (also
1477 * across power cycles).
1479 if ((ep
->chip
->usb_id
== USB_ID(0x0763, 0x2030) ||
1480 ep
->chip
->usb_id
== USB_ID(0x0763, 0x2031)) &&
1481 ep
->type
== SND_USB_ENDPOINT_TYPE_DATA
)
1482 ep
->skip_packets
= 16;
1484 /* Work around devices that report unreasonable feedback data */
1485 if ((ep
->chip
->usb_id
== USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */
1486 ep
->chip
->usb_id
== USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1487 ep
->syncmaxsize
== 4)
1488 ep
->tenor_fb_quirk
= 1;
1491 void snd_usb_set_interface_quirk(struct usb_device
*dev
)
1493 struct snd_usb_audio
*chip
= dev_get_drvdata(&dev
->dev
);
1498 * "Playback Design" products need a 50ms delay after setting the
1501 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1502 case 0x23ba: /* Playback Design */
1503 case 0x0644: /* TEAC Corp. */
1509 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1510 void snd_usb_ctl_msg_quirk(struct usb_device
*dev
, unsigned int pipe
,
1511 __u8 request
, __u8 requesttype
, __u16 value
,
1512 __u16 index
, void *data
, __u16 size
)
1514 struct snd_usb_audio
*chip
= dev_get_drvdata(&dev
->dev
);
1519 * "Playback Design" products need a 20ms delay after each
1520 * class compliant request
1522 if (USB_ID_VENDOR(chip
->usb_id
) == 0x23ba &&
1523 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1527 * "TEAC Corp." products need a 20ms delay after each
1528 * class compliant request
1530 if (USB_ID_VENDOR(chip
->usb_id
) == 0x0644 &&
1531 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1534 /* ITF-USB DSD based DACs functionality need a delay
1535 * after each class compliant request
1537 if (is_itf_usb_dsd_dac(chip
->usb_id
)
1538 && (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1541 /* Zoom R16/24, Logitech H650e, Jabra 550a needs a tiny delay here,
1542 * otherwise requests like get/set frequency return as failed despite
1543 * actually succeeding.
1545 if ((chip
->usb_id
== USB_ID(0x1686, 0x00dd) ||
1546 chip
->usb_id
== USB_ID(0x046d, 0x0a46) ||
1547 chip
->usb_id
== USB_ID(0x0b0e, 0x0349)) &&
1548 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1549 usleep_range(1000, 2000);
1553 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1554 * augment the PCM format bit-field for DSD types. The UAC standards
1555 * don't have a designated bit field to denote DSD-capable interfaces,
1556 * hence all hardware that is known to support this format has to be
1559 u64
snd_usb_interface_dsd_format_quirks(struct snd_usb_audio
*chip
,
1560 struct audioformat
*fp
,
1561 unsigned int sample_bytes
)
1563 struct usb_interface
*iface
;
1565 /* Playback Designs */
1566 if (USB_ID_VENDOR(chip
->usb_id
) == 0x23ba) {
1567 switch (fp
->altsetting
) {
1570 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1572 fp
->dsd_bitrev
= true;
1573 return SNDRV_PCM_FMTBIT_DSD_U8
;
1575 fp
->dsd_bitrev
= true;
1576 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1580 /* XMOS based USB DACs */
1581 switch (chip
->usb_id
) {
1582 case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
1583 case USB_ID(0x22d9, 0x0416): /* OPPO HA-1 */
1584 case USB_ID(0x22d9, 0x0436): /* OPPO Sonica */
1585 case USB_ID(0x22d9, 0x0461): /* OPPO UDP-205 */
1586 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1587 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1588 if (fp
->altsetting
== 2)
1589 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1592 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1593 case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1594 case USB_ID(0x16b0, 0x06b2): /* NuPrime DAC-10 */
1595 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1596 case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1597 case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1598 case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
1599 case USB_ID(0x22d9, 0x0426): /* OPPO HA-2 */
1600 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1601 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1602 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1603 case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1604 case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1605 case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1606 case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1607 if (fp
->altsetting
== 3)
1608 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1611 /* Amanero Combo384 USB based DACs with native DSD support */
1612 case USB_ID(0x16d0, 0x071a): /* Amanero - Combo384 */
1613 case USB_ID(0x2ab6, 0x0004): /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1614 case USB_ID(0x2ab6, 0x0005): /* T+A USB HD Audio 1 */
1615 case USB_ID(0x2ab6, 0x0006): /* T+A USB HD Audio 2 */
1616 if (fp
->altsetting
== 2) {
1617 switch (le16_to_cpu(chip
->dev
->descriptor
.bcdDevice
)) {
1619 return SNDRV_PCM_FMTBIT_DSD_U32_LE
;
1622 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1628 case USB_ID(0x16d0, 0x0a23):
1629 if (fp
->altsetting
== 2)
1630 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1637 /* ITF-USB DSD based DACs */
1638 if (is_itf_usb_dsd_dac(chip
->usb_id
)) {
1639 iface
= usb_ifnum_to_if(chip
->dev
, fp
->iface
);
1641 /* Altsetting 2 support native DSD if the num of altsets is
1643 * Altsetting 3 support native DSD if the num of altsets is
1646 if (fp
->altsetting
== iface
->num_altsetting
- 1)
1647 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1650 /* Mostly generic method to detect many DSD-capable implementations -
1651 * from XMOS/Thesycon
1653 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1654 case 0x20b1: /* XMOS based devices */
1655 case 0x152a: /* Thesycon devices */
1656 case 0x25ce: /* Mytek devices */
1657 case 0x2ab6: /* T+A devices */
1659 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1669 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio
*chip
,
1670 struct audioformat
*fp
,
1673 switch (chip
->usb_id
) {
1674 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1675 /* Optoplay sets the sample rate attribute although
1676 * it seems not supporting it in fact.
1678 fp
->attributes
&= ~UAC_EP_CS_ATTR_SAMPLE_RATE
;
1680 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1681 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1682 /* doesn't set the sample rate attribute, but supports it */
1683 fp
->attributes
|= UAC_EP_CS_ATTR_SAMPLE_RATE
;
1685 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
1686 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1687 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1688 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1689 an older model 77d:223) */
1691 * plantronics headset and Griffin iMic have set adaptive-in
1692 * although it's really not...
1694 fp
->ep_attr
&= ~USB_ENDPOINT_SYNCTYPE
;
1695 if (stream
== SNDRV_PCM_STREAM_PLAYBACK
)
1696 fp
->ep_attr
|= USB_ENDPOINT_SYNC_ADAPTIVE
;
1698 fp
->ep_attr
|= USB_ENDPOINT_SYNC_SYNC
;