1 // SPDX-License-Identifier: GPL-2.0-or-later
5 #include <linux/init.h>
6 #include <linux/slab.h>
8 #include <linux/usb/audio.h>
9 #include <linux/usb/midi.h>
10 #include <linux/bits.h>
12 #include <sound/control.h>
13 #include <sound/core.h>
14 #include <sound/info.h>
15 #include <sound/pcm.h>
20 #include "mixer_quirks.h"
30 * handle the quirks for the contained interfaces
32 static int create_composite_quirk(struct snd_usb_audio
*chip
,
33 struct usb_interface
*iface
,
34 struct usb_driver
*driver
,
35 const struct snd_usb_audio_quirk
*quirk_comp
)
37 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
38 const struct snd_usb_audio_quirk
*quirk
;
41 for (quirk
= quirk_comp
->data
; quirk
->ifnum
>= 0; ++quirk
) {
42 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
45 if (quirk
->ifnum
!= probed_ifnum
&&
46 usb_interface_claimed(iface
))
48 err
= snd_usb_create_quirk(chip
, iface
, driver
, quirk
);
53 for (quirk
= quirk_comp
->data
; quirk
->ifnum
>= 0; ++quirk
) {
54 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
57 if (quirk
->ifnum
!= probed_ifnum
&&
58 !usb_interface_claimed(iface
))
59 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
65 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
66 struct usb_interface
*iface
,
67 struct usb_driver
*driver
,
68 const struct snd_usb_audio_quirk
*quirk
)
75 * Allow alignment on audio sub-slot (channel samples) rather than
76 * on audio slots (audio frames)
78 static int create_align_transfer_quirk(struct snd_usb_audio
*chip
,
79 struct usb_interface
*iface
,
80 struct usb_driver
*driver
,
81 const struct snd_usb_audio_quirk
*quirk
)
84 return 1; /* Continue with creating streams and mixer */
87 static int create_any_midi_quirk(struct snd_usb_audio
*chip
,
88 struct usb_interface
*intf
,
89 struct usb_driver
*driver
,
90 const struct snd_usb_audio_quirk
*quirk
)
92 return snd_usbmidi_create(chip
->card
, intf
, &chip
->midi_list
, quirk
);
96 * create a stream for an interface with proper descriptors
98 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
99 struct usb_interface
*iface
,
100 struct usb_driver
*driver
,
101 const struct snd_usb_audio_quirk
*quirk
)
103 struct usb_host_interface
*alts
;
104 struct usb_interface_descriptor
*altsd
;
107 if (chip
->usb_id
== USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
108 chip
->tx_length_quirk
= 1;
110 alts
= &iface
->altsetting
[0];
111 altsd
= get_iface_desc(alts
);
112 err
= snd_usb_parse_audio_interface(chip
, altsd
->bInterfaceNumber
);
114 usb_audio_err(chip
, "cannot setup if %d: error %d\n",
115 altsd
->bInterfaceNumber
, err
);
118 /* reset the current interface */
119 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
124 * create a stream for an endpoint/altsetting without proper descriptors
126 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
127 struct usb_interface
*iface
,
128 struct usb_driver
*driver
,
129 const struct snd_usb_audio_quirk
*quirk
)
131 struct audioformat
*fp
;
132 struct usb_host_interface
*alts
;
133 struct usb_interface_descriptor
*altsd
;
135 unsigned *rate_table
= NULL
;
137 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
141 INIT_LIST_HEAD(&fp
->list
);
142 if (fp
->nr_rates
> MAX_NR_RATES
) {
146 if (fp
->nr_rates
> 0) {
147 rate_table
= kmemdup(fp
->rate_table
,
148 sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
153 fp
->rate_table
= rate_table
;
156 stream
= (fp
->endpoint
& USB_DIR_IN
)
157 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
158 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
161 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
162 fp
->altset_idx
>= iface
->num_altsetting
) {
166 alts
= &iface
->altsetting
[fp
->altset_idx
];
167 altsd
= get_iface_desc(alts
);
168 if (altsd
->bNumEndpoints
< 1) {
173 fp
->protocol
= altsd
->bInterfaceProtocol
;
175 if (fp
->datainterval
== 0)
176 fp
->datainterval
= snd_usb_parse_datainterval(chip
, alts
);
177 if (fp
->maxpacksize
== 0)
178 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
179 usb_set_interface(chip
->dev
, fp
->iface
, 0);
180 snd_usb_init_pitch(chip
, fp
->iface
, alts
, fp
);
181 snd_usb_init_sample_rate(chip
, fp
->iface
, alts
, fp
, fp
->rate_max
);
185 list_del(&fp
->list
); /* unlink for avoiding double-free */
191 static int create_auto_pcm_quirk(struct snd_usb_audio
*chip
,
192 struct usb_interface
*iface
,
193 struct usb_driver
*driver
)
195 struct usb_host_interface
*alts
;
196 struct usb_interface_descriptor
*altsd
;
197 struct usb_endpoint_descriptor
*epd
;
198 struct uac1_as_header_descriptor
*ashd
;
199 struct uac_format_type_i_discrete_descriptor
*fmtd
;
202 * Most Roland/Yamaha audio streaming interfaces have more or less
203 * standard descriptors, but older devices might lack descriptors, and
204 * future ones might change, so ensure that we fail silently if the
205 * interface doesn't look exactly right.
208 /* must have a non-zero altsetting for streaming */
209 if (iface
->num_altsetting
< 2)
211 alts
= &iface
->altsetting
[1];
212 altsd
= get_iface_desc(alts
);
214 /* must have an isochronous endpoint for streaming */
215 if (altsd
->bNumEndpoints
< 1)
217 epd
= get_endpoint(alts
, 0);
218 if (!usb_endpoint_xfer_isoc(epd
))
221 /* must have format descriptors */
222 ashd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
224 fmtd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
226 if (!ashd
|| ashd
->bLength
< 7 ||
227 !fmtd
|| fmtd
->bLength
< 8)
230 return create_standard_audio_quirk(chip
, iface
, driver
, NULL
);
233 static int create_yamaha_midi_quirk(struct snd_usb_audio
*chip
,
234 struct usb_interface
*iface
,
235 struct usb_driver
*driver
,
236 struct usb_host_interface
*alts
)
238 static const struct snd_usb_audio_quirk yamaha_midi_quirk
= {
239 .type
= QUIRK_MIDI_YAMAHA
241 struct usb_midi_in_jack_descriptor
*injd
;
242 struct usb_midi_out_jack_descriptor
*outjd
;
244 /* must have some valid jack descriptors */
245 injd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
246 NULL
, USB_MS_MIDI_IN_JACK
);
247 outjd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
248 NULL
, USB_MS_MIDI_OUT_JACK
);
251 if ((injd
&& !snd_usb_validate_midi_desc(injd
)) ||
252 (outjd
&& !snd_usb_validate_midi_desc(outjd
)))
254 if (injd
&& (injd
->bLength
< 5 ||
255 (injd
->bJackType
!= USB_MS_EMBEDDED
&&
256 injd
->bJackType
!= USB_MS_EXTERNAL
)))
258 if (outjd
&& (outjd
->bLength
< 6 ||
259 (outjd
->bJackType
!= USB_MS_EMBEDDED
&&
260 outjd
->bJackType
!= USB_MS_EXTERNAL
)))
262 return create_any_midi_quirk(chip
, iface
, driver
, &yamaha_midi_quirk
);
265 static int create_roland_midi_quirk(struct snd_usb_audio
*chip
,
266 struct usb_interface
*iface
,
267 struct usb_driver
*driver
,
268 struct usb_host_interface
*alts
)
270 static const struct snd_usb_audio_quirk roland_midi_quirk
= {
271 .type
= QUIRK_MIDI_ROLAND
273 u8
*roland_desc
= NULL
;
275 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
277 roland_desc
= snd_usb_find_csint_desc(alts
->extra
,
282 if (roland_desc
[0] < 6 || roland_desc
[3] != 2)
284 return create_any_midi_quirk(chip
, iface
, driver
,
289 static int create_std_midi_quirk(struct snd_usb_audio
*chip
,
290 struct usb_interface
*iface
,
291 struct usb_driver
*driver
,
292 struct usb_host_interface
*alts
)
294 struct usb_ms_header_descriptor
*mshd
;
295 struct usb_ms_endpoint_descriptor
*msepd
;
297 /* must have the MIDIStreaming interface header descriptor*/
298 mshd
= (struct usb_ms_header_descriptor
*)alts
->extra
;
299 if (alts
->extralen
< 7 ||
301 mshd
->bDescriptorType
!= USB_DT_CS_INTERFACE
||
302 mshd
->bDescriptorSubtype
!= USB_MS_HEADER
)
304 /* must have the MIDIStreaming endpoint descriptor*/
305 msepd
= (struct usb_ms_endpoint_descriptor
*)alts
->endpoint
[0].extra
;
306 if (alts
->endpoint
[0].extralen
< 4 ||
307 msepd
->bLength
< 4 ||
308 msepd
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
309 msepd
->bDescriptorSubtype
!= UAC_MS_GENERAL
||
310 msepd
->bNumEmbMIDIJack
< 1 ||
311 msepd
->bNumEmbMIDIJack
> 16)
314 return create_any_midi_quirk(chip
, iface
, driver
, NULL
);
317 static int create_auto_midi_quirk(struct snd_usb_audio
*chip
,
318 struct usb_interface
*iface
,
319 struct usb_driver
*driver
)
321 struct usb_host_interface
*alts
;
322 struct usb_interface_descriptor
*altsd
;
323 struct usb_endpoint_descriptor
*epd
;
326 alts
= &iface
->altsetting
[0];
327 altsd
= get_iface_desc(alts
);
329 /* must have at least one bulk/interrupt endpoint for streaming */
330 if (altsd
->bNumEndpoints
< 1)
332 epd
= get_endpoint(alts
, 0);
333 if (!usb_endpoint_xfer_bulk(epd
) &&
334 !usb_endpoint_xfer_int(epd
))
337 switch (USB_ID_VENDOR(chip
->usb_id
)) {
338 case 0x0499: /* Yamaha */
339 err
= create_yamaha_midi_quirk(chip
, iface
, driver
, alts
);
343 case 0x0582: /* Roland */
344 err
= create_roland_midi_quirk(chip
, iface
, driver
, alts
);
350 return create_std_midi_quirk(chip
, iface
, driver
, alts
);
353 static int create_autodetect_quirk(struct snd_usb_audio
*chip
,
354 struct usb_interface
*iface
,
355 struct usb_driver
*driver
)
359 err
= create_auto_pcm_quirk(chip
, iface
, driver
);
361 err
= create_auto_midi_quirk(chip
, iface
, driver
);
365 static int create_autodetect_quirks(struct snd_usb_audio
*chip
,
366 struct usb_interface
*iface
,
367 struct usb_driver
*driver
,
368 const struct snd_usb_audio_quirk
*quirk
)
370 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
371 int ifcount
, ifnum
, err
;
373 err
= create_autodetect_quirk(chip
, iface
, driver
);
378 * ALSA PCM playback/capture devices cannot be registered in two steps,
379 * so we have to claim the other corresponding interface here.
381 ifcount
= chip
->dev
->actconfig
->desc
.bNumInterfaces
;
382 for (ifnum
= 0; ifnum
< ifcount
; ifnum
++) {
383 if (ifnum
== probed_ifnum
|| quirk
->ifnum
>= 0)
385 iface
= usb_ifnum_to_if(chip
->dev
, ifnum
);
387 usb_interface_claimed(iface
) ||
388 get_iface_desc(iface
->altsetting
)->bInterfaceClass
!=
389 USB_CLASS_VENDOR_SPEC
)
392 err
= create_autodetect_quirk(chip
, iface
, driver
);
394 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
401 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
402 * The only way to detect the sample rate is by looking at wMaxPacketSize.
404 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
405 struct usb_interface
*iface
,
406 struct usb_driver
*driver
,
407 const struct snd_usb_audio_quirk
*quirk
)
409 static const struct audioformat ua_format
= {
410 .formats
= SNDRV_PCM_FMTBIT_S24_3LE
,
412 .fmt_type
= UAC_FORMAT_TYPE_I
,
415 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
417 struct usb_host_interface
*alts
;
418 struct usb_interface_descriptor
*altsd
;
419 struct audioformat
*fp
;
422 /* both PCM and MIDI interfaces have 2 or more altsettings */
423 if (iface
->num_altsetting
< 2)
425 alts
= &iface
->altsetting
[1];
426 altsd
= get_iface_desc(alts
);
428 if (altsd
->bNumEndpoints
== 2) {
429 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
430 .out_cables
= 0x0003,
433 static const struct snd_usb_audio_quirk ua700_quirk
= {
434 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
437 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
438 .out_cables
= 0x0001,
441 static const struct snd_usb_audio_quirk uaxx_quirk
= {
442 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
445 const struct snd_usb_audio_quirk
*quirk
=
446 chip
->usb_id
== USB_ID(0x0582, 0x002b)
447 ? &ua700_quirk
: &uaxx_quirk
;
448 return __snd_usbmidi_create(chip
->card
, iface
,
449 &chip
->midi_list
, quirk
,
453 if (altsd
->bNumEndpoints
!= 1)
456 fp
= kmemdup(&ua_format
, sizeof(*fp
), GFP_KERNEL
);
460 fp
->iface
= altsd
->bInterfaceNumber
;
461 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
462 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
463 fp
->datainterval
= 0;
464 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
465 INIT_LIST_HEAD(&fp
->list
);
467 switch (fp
->maxpacksize
) {
469 fp
->rate_max
= fp
->rate_min
= 44100;
473 fp
->rate_max
= fp
->rate_min
= 48000;
477 fp
->rate_max
= fp
->rate_min
= 96000;
480 usb_audio_err(chip
, "unknown sample rate\n");
485 stream
= (fp
->endpoint
& USB_DIR_IN
)
486 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
487 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
489 list_del(&fp
->list
); /* unlink for avoiding double-free */
493 usb_set_interface(chip
->dev
, fp
->iface
, 0);
498 * Create a standard mixer for the specified interface.
500 static int create_standard_mixer_quirk(struct snd_usb_audio
*chip
,
501 struct usb_interface
*iface
,
502 struct usb_driver
*driver
,
503 const struct snd_usb_audio_quirk
*quirk
)
505 if (quirk
->ifnum
< 0)
508 return snd_usb_create_mixer(chip
, quirk
->ifnum
, 0);
512 static int setup_fmt_after_resume_quirk(struct snd_usb_audio
*chip
,
513 struct usb_interface
*iface
,
514 struct usb_driver
*driver
,
515 const struct snd_usb_audio_quirk
*quirk
)
517 chip
->setup_fmt_after_resume_quirk
= 1;
518 return 1; /* Continue with creating streams and mixer */
522 * audio-interface quirks
524 * returns zero if no standard audio/MIDI parsing is needed.
525 * returns a positive value if standard audio/midi interfaces are parsed
527 * returns a negative value at error.
529 int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
530 struct usb_interface
*iface
,
531 struct usb_driver
*driver
,
532 const struct snd_usb_audio_quirk
*quirk
)
534 typedef int (*quirk_func_t
)(struct snd_usb_audio
*,
535 struct usb_interface
*,
537 const struct snd_usb_audio_quirk
*);
538 static const quirk_func_t quirk_funcs
[] = {
539 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
540 [QUIRK_COMPOSITE
] = create_composite_quirk
,
541 [QUIRK_AUTODETECT
] = create_autodetect_quirks
,
542 [QUIRK_MIDI_STANDARD_INTERFACE
] = create_any_midi_quirk
,
543 [QUIRK_MIDI_FIXED_ENDPOINT
] = create_any_midi_quirk
,
544 [QUIRK_MIDI_YAMAHA
] = create_any_midi_quirk
,
545 [QUIRK_MIDI_ROLAND
] = create_any_midi_quirk
,
546 [QUIRK_MIDI_MIDIMAN
] = create_any_midi_quirk
,
547 [QUIRK_MIDI_NOVATION
] = create_any_midi_quirk
,
548 [QUIRK_MIDI_RAW_BYTES
] = create_any_midi_quirk
,
549 [QUIRK_MIDI_EMAGIC
] = create_any_midi_quirk
,
550 [QUIRK_MIDI_CME
] = create_any_midi_quirk
,
551 [QUIRK_MIDI_AKAI
] = create_any_midi_quirk
,
552 [QUIRK_MIDI_FTDI
] = create_any_midi_quirk
,
553 [QUIRK_MIDI_CH345
] = create_any_midi_quirk
,
554 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
555 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
556 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
,
557 [QUIRK_AUDIO_ALIGN_TRANSFER
] = create_align_transfer_quirk
,
558 [QUIRK_AUDIO_STANDARD_MIXER
] = create_standard_mixer_quirk
,
559 [QUIRK_SETUP_FMT_AFTER_RESUME
] = setup_fmt_after_resume_quirk
,
562 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
563 return quirk_funcs
[quirk
->type
](chip
, iface
, driver
, quirk
);
565 usb_audio_err(chip
, "invalid quirk type %d\n", quirk
->type
);
574 #define EXTIGY_FIRMWARE_SIZE_OLD 794
575 #define EXTIGY_FIRMWARE_SIZE_NEW 483
577 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
579 struct usb_host_config
*config
= dev
->actconfig
;
582 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
583 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
584 dev_dbg(&dev
->dev
, "sending Extigy boot sequence...\n");
585 /* Send message to force it to reconnect with full interface. */
586 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
587 0x10, 0x43, 0x0001, 0x000a, NULL
, 0);
589 dev_dbg(&dev
->dev
, "error sending boot message: %d\n", err
);
590 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
591 &dev
->descriptor
, sizeof(dev
->descriptor
));
592 config
= dev
->actconfig
;
594 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
595 err
= usb_reset_configuration(dev
);
597 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
598 dev_dbg(&dev
->dev
, "extigy_boot: new boot length = %d\n",
599 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
600 return -ENODEV
; /* quit this anyway */
605 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
609 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
610 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
613 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
614 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
621 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device
*dev
)
625 if (dev
->actconfig
->desc
.bConfigurationValue
== 1) {
627 "Fast Track Pro switching to config #2\n");
628 /* This function has to be available by the usb core module.
629 * if it is not avialable the boot quirk has to be left out
630 * and the configuration has to be set by udev or hotplug
633 err
= usb_driver_set_configuration(dev
, 2);
636 "error usb_driver_set_configuration: %d\n",
638 /* Always return an error, so that we stop creating a device
639 that will just be destroyed and recreated with a new
643 dev_info(&dev
->dev
, "Fast Track Pro config OK\n");
649 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
650 * documented in the device's data sheet.
652 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
656 buf
[1] = value
& 0xff;
657 buf
[2] = (value
>> 8) & 0xff;
659 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
660 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
664 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
667 * Enable line-out driver mode, set headphone source to front
668 * channels, enable stereo mic.
670 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
674 * CM6206 registers from the CM6206 datasheet rev 2.1
676 #define CM6206_REG0_DMA_MASTER BIT(15)
677 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
678 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
679 /* Bit 4 thru 11 is the S/PDIF category code */
680 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
681 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
682 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
683 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
684 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
686 #define CM6206_REG1_TEST_SEL_CLK BIT(14)
687 #define CM6206_REG1_PLLBIN_EN BIT(13)
688 #define CM6206_REG1_SOFT_MUTE_EN BIT(12)
689 #define CM6206_REG1_GPIO4_OUT BIT(11)
690 #define CM6206_REG1_GPIO4_OE BIT(10)
691 #define CM6206_REG1_GPIO3_OUT BIT(9)
692 #define CM6206_REG1_GPIO3_OE BIT(8)
693 #define CM6206_REG1_GPIO2_OUT BIT(7)
694 #define CM6206_REG1_GPIO2_OE BIT(6)
695 #define CM6206_REG1_GPIO1_OUT BIT(5)
696 #define CM6206_REG1_GPIO1_OE BIT(4)
697 #define CM6206_REG1_SPDIFO_INVALID BIT(3)
698 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
699 #define CM6206_REG1_SPDIFO_DIS BIT(1)
700 #define CM6206_REG1_SPDIFI_MIX BIT(0)
702 #define CM6206_REG2_DRIVER_ON BIT(15)
703 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
704 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
705 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
706 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
707 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
708 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
709 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
710 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
711 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
712 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
713 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
714 #define CM6206_REG2_MUTE_CENTER BIT(5)
715 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
716 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
717 #define CM6206_REG2_EN_BTL BIT(2)
718 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
719 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
720 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
721 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
723 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
724 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
725 #define CM6206_REG3_VRAP25EN BIT(10)
726 #define CM6206_REG3_MSEL1 BIT(9)
727 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
728 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
729 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
730 #define CM6206_REG3_PINSEL BIT(6)
731 #define CM6206_REG3_FOE BIT(5)
732 #define CM6206_REG3_ROE BIT(4)
733 #define CM6206_REG3_CBOE BIT(3)
734 #define CM6206_REG3_LOSE BIT(2)
735 #define CM6206_REG3_HPOE BIT(1)
736 #define CM6206_REG3_SPDIFI_CANREC BIT(0)
738 #define CM6206_REG5_DA_RSTN BIT(13)
739 #define CM6206_REG5_AD_RSTN BIT(12)
740 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
741 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
742 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
743 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
744 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
745 #define CM6206_REG5_CODECM BIT(8)
746 #define CM6206_REG5_EN_HPF BIT(7)
747 #define CM6206_REG5_T_SEL_DSDA4 BIT(6)
748 #define CM6206_REG5_T_SEL_DSDA3 BIT(5)
749 #define CM6206_REG5_T_SEL_DSDA2 BIT(4)
750 #define CM6206_REG5_T_SEL_DSDA1 BIT(3)
751 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
752 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4
753 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
754 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
755 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
757 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
762 * Values here are chosen based on sniffing USB traffic
765 * REG0: DAC is master, sample rate 48kHz, no copyright
767 CM6206_REG0_SPDIFO_RATE_48K
|
768 CM6206_REG0_SPDIFO_COPYRIGHT_NA
,
770 * REG1: PLL binary search enable, soft mute enable.
772 CM6206_REG1_PLLBIN_EN
|
773 CM6206_REG1_SOFT_MUTE_EN
,
775 * REG2: enable output drivers,
776 * select front channels to the headphone output,
777 * then mute the headphone channels, run the MCU
780 CM6206_REG2_DRIVER_ON
|
781 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS
|
782 CM6206_REG2_MUTE_HEADPHONE_RIGHT
|
783 CM6206_REG2_MUTE_HEADPHONE_LEFT
,
785 * REG3: default flyspeed, set 2.5V mic bias
786 * enable all line out ports and enable SPDIF
788 CM6206_REG3_FLYSPEED_DEFAULT
|
789 CM6206_REG3_VRAP25EN
|
795 CM6206_REG3_SPDIFI_CANREC
,
796 /* REG4 is just a bunch of GPIO lines */
798 /* REG5: de-assert AD/DA reset signals */
799 CM6206_REG5_DA_RSTN
|
800 CM6206_REG5_AD_RSTN
};
802 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
803 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
811 /* quirk for Plantronics GameCom 780 with CM6302 chip */
812 static int snd_usb_gamecon780_boot_quirk(struct usb_device
*dev
)
814 /* set the initial volume and don't change; other values are either
815 * too loud or silent due to firmware bug (bko#65251)
817 u8 buf
[2] = { 0x74, 0xe3 };
818 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
819 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
820 UAC_FU_VOLUME
<< 8, 9 << 8, buf
, 2);
824 * Novation Twitch DJ controller
825 * Focusrite Novation Saffire 6 USB audio card
827 static int snd_usb_novation_boot_quirk(struct usb_device
*dev
)
829 /* preemptively set up the device because otherwise the
830 * raw MIDI endpoints are not active */
831 usb_set_interface(dev
, 0, 1);
836 * This call will put the synth in "USB send" mode, i.e it will send MIDI
837 * messages through USB (this is disabled at startup). The synth will
838 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
839 * sign on its LCD. Values here are chosen based on sniffing USB traffic
842 static int snd_usb_accessmusic_boot_quirk(struct usb_device
*dev
)
844 int err
, actual_length
;
845 /* "midi send" enable */
846 static const u8 seq
[] = { 0x4e, 0x73, 0x52, 0x01 };
849 if (snd_usb_pipe_sanity_check(dev
, usb_sndintpipe(dev
, 0x05)))
851 buf
= kmemdup(seq
, ARRAY_SIZE(seq
), GFP_KERNEL
);
854 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x05), buf
,
855 ARRAY_SIZE(seq
), &actual_length
, 1000);
864 * Some sound cards from Native Instruments are in fact compliant to the USB
865 * audio standard of version 2 and other approved USB standards, even though
866 * they come up as vendor-specific device when first connected.
868 * However, they can be told to come up with a new set of descriptors
869 * upon their next enumeration, and the interfaces announced by the new
870 * descriptors will then be handled by the kernel's class drivers. As the
871 * product ID will also change, no further checks are required.
874 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device
*dev
)
878 if (snd_usb_pipe_sanity_check(dev
, usb_sndctrlpipe(dev
, 0)))
880 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
881 0xaf, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
882 1, 0, NULL
, 0, 1000);
887 usb_reset_device(dev
);
889 /* return -EAGAIN, so the creation of an audio interface for this
890 * temporary device is aborted. The device will reconnect with a
895 static void mbox2_setup_48_24_magic(struct usb_device
*dev
)
900 /* Choose 48000Hz permanently */
905 /* Send the magic! */
906 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
907 0x01, 0x22, 0x0100, 0x0085, &temp
, 0x0003);
908 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
909 0x81, 0xa2, 0x0100, 0x0085, &srate
, 0x0003);
910 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
911 0x81, 0xa2, 0x0100, 0x0086, &srate
, 0x0003);
912 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
913 0x81, 0xa2, 0x0100, 0x0003, &srate
, 0x0003);
917 /* Digidesign Mbox 2 needs to load firmware onboard
918 * and driver must wait a few seconds for initialisation.
921 #define MBOX2_FIRMWARE_SIZE 646
922 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
923 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
925 static int snd_usb_mbox2_boot_quirk(struct usb_device
*dev
)
927 struct usb_host_config
*config
= dev
->actconfig
;
929 u8 bootresponse
[0x12];
933 fwsize
= le16_to_cpu(get_cfg_desc(config
)->wTotalLength
);
935 if (fwsize
!= MBOX2_FIRMWARE_SIZE
) {
936 dev_err(&dev
->dev
, "Invalid firmware size=%d.\n", fwsize
);
940 dev_dbg(&dev
->dev
, "Sending Digidesign Mbox 2 boot sequence...\n");
943 bootresponse
[0] = MBOX2_BOOT_LOADING
;
944 while ((bootresponse
[0] == MBOX2_BOOT_LOADING
) && (count
< 10)) {
945 msleep(500); /* 0.5 second delay */
946 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
947 /* Control magic - load onboard firmware */
948 0x85, 0xc0, 0x0001, 0x0000, &bootresponse
, 0x0012);
949 if (bootresponse
[0] == MBOX2_BOOT_READY
)
951 dev_dbg(&dev
->dev
, "device not ready, resending boot sequence...\n");
955 if (bootresponse
[0] != MBOX2_BOOT_READY
) {
956 dev_err(&dev
->dev
, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse
[0]);
960 dev_dbg(&dev
->dev
, "device initialised!\n");
962 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
963 &dev
->descriptor
, sizeof(dev
->descriptor
));
964 config
= dev
->actconfig
;
966 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
968 err
= usb_reset_configuration(dev
);
970 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
971 dev_dbg(&dev
->dev
, "mbox2_boot: new boot length = %d\n",
972 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
974 mbox2_setup_48_24_magic(dev
);
976 dev_info(&dev
->dev
, "Digidesign Mbox 2: 24bit 48kHz");
978 return 0; /* Successful boot */
981 static int snd_usb_axefx3_boot_quirk(struct usb_device
*dev
)
985 dev_dbg(&dev
->dev
, "Waiting for Axe-Fx III to boot up...\n");
987 if (snd_usb_pipe_sanity_check(dev
, usb_sndctrlpipe(dev
, 0)))
989 /* If the Axe-Fx III has not fully booted, it will timeout when trying
990 * to enable the audio streaming interface. A more generous timeout is
991 * used here to detect when the Axe-Fx III has finished booting as the
992 * set interface message will be acked once it has
994 err
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
995 USB_REQ_SET_INTERFACE
, USB_RECIP_INTERFACE
,
996 1, 1, NULL
, 0, 120000);
999 "failed waiting for Axe-Fx III to boot: %d\n", err
);
1003 dev_dbg(&dev
->dev
, "Axe-Fx III is now ready\n");
1005 err
= usb_set_interface(dev
, 1, 0);
1008 "error stopping Axe-Fx III interface: %d\n", err
);
1014 #define MICROBOOK_BUF_SIZE 128
1016 static int snd_usb_motu_microbookii_communicate(struct usb_device
*dev
, u8
*buf
,
1017 int buf_size
, int *length
)
1019 int err
, actual_length
;
1021 if (snd_usb_pipe_sanity_check(dev
, usb_sndintpipe(dev
, 0x01)))
1023 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x01), buf
, *length
,
1024 &actual_length
, 1000);
1028 print_hex_dump(KERN_DEBUG
, "MicroBookII snd: ", DUMP_PREFIX_NONE
, 16, 1,
1029 buf
, actual_length
, false);
1031 memset(buf
, 0, buf_size
);
1033 if (snd_usb_pipe_sanity_check(dev
, usb_rcvintpipe(dev
, 0x82)))
1035 err
= usb_interrupt_msg(dev
, usb_rcvintpipe(dev
, 0x82), buf
, buf_size
,
1036 &actual_length
, 1000);
1040 print_hex_dump(KERN_DEBUG
, "MicroBookII rcv: ", DUMP_PREFIX_NONE
, 16, 1,
1041 buf
, actual_length
, false);
1043 *length
= actual_length
;
1047 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device
*dev
)
1049 int err
, actual_length
, poll_attempts
= 0;
1050 static const u8 set_samplerate_seq
[] = { 0x00, 0x00, 0x00, 0x00,
1051 0x00, 0x00, 0x0b, 0x14,
1052 0x00, 0x00, 0x00, 0x01 };
1053 static const u8 poll_ready_seq
[] = { 0x00, 0x04, 0x00, 0x00,
1054 0x00, 0x00, 0x0b, 0x18 };
1055 u8
*buf
= kzalloc(MICROBOOK_BUF_SIZE
, GFP_KERNEL
);
1060 dev_info(&dev
->dev
, "Waiting for MOTU Microbook II to boot up...\n");
1062 /* First we tell the device which sample rate to use. */
1063 memcpy(buf
, set_samplerate_seq
, sizeof(set_samplerate_seq
));
1064 actual_length
= sizeof(set_samplerate_seq
);
1065 err
= snd_usb_motu_microbookii_communicate(dev
, buf
, MICROBOOK_BUF_SIZE
,
1070 "failed setting the sample rate for Motu MicroBook II: %d\n",
1075 /* Then we poll every 100 ms until the device informs of its readiness. */
1077 if (++poll_attempts
> 100) {
1079 "failed booting Motu MicroBook II: timeout\n");
1084 memset(buf
, 0, MICROBOOK_BUF_SIZE
);
1085 memcpy(buf
, poll_ready_seq
, sizeof(poll_ready_seq
));
1087 actual_length
= sizeof(poll_ready_seq
);
1088 err
= snd_usb_motu_microbookii_communicate(
1089 dev
, buf
, MICROBOOK_BUF_SIZE
, &actual_length
);
1092 "failed booting Motu MicroBook II: communication error %d\n",
1097 /* the device signals its readiness through a message of the
1099 * XX 06 00 00 00 00 0b 18 00 00 00 01
1100 * If the device is not yet ready to accept audio data, the
1101 * last byte of that sequence is 00.
1103 if (actual_length
== 12 && buf
[actual_length
- 1] == 1)
1109 dev_info(&dev
->dev
, "MOTU MicroBook II ready\n");
1116 static int snd_usb_motu_m_series_boot_quirk(struct usb_device
*dev
)
1120 if (snd_usb_pipe_sanity_check(dev
, usb_sndctrlpipe(dev
, 0)))
1122 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
1123 1, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
1124 0x0, 0, NULL
, 0, 1000);
1131 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
1132 1, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
1133 0x20, 0, NULL
, 0, 1000);
1144 #define MAUDIO_SET 0x01 /* parse device_setup */
1145 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
1146 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
1147 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
1148 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
1149 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
1150 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
1151 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
1152 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
1153 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
1154 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
1156 static int quattro_skip_setting_quirk(struct snd_usb_audio
*chip
,
1157 int iface
, int altno
)
1159 /* Reset ALL ifaces to 0 altsetting.
1160 * Call it for every possible altsetting of every interface.
1162 usb_set_interface(chip
->dev
, iface
, 0);
1163 if (chip
->setup
& MAUDIO_SET
) {
1164 if (chip
->setup
& MAUDIO_SET_COMPATIBLE
) {
1165 if (iface
!= 1 && iface
!= 2)
1166 return 1; /* skip all interfaces but 1 and 2 */
1169 if (iface
== 1 || iface
== 2)
1170 return 1; /* skip interfaces 1 and 2 */
1171 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
1172 return 1; /* skip this altsetting */
1173 mask
= chip
->setup
& MAUDIO_SET_MASK
;
1174 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
1175 return 1; /* skip this altsetting */
1176 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
1177 return 1; /* skip this altsetting */
1178 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 4)
1179 return 1; /* skip this altsetting */
1183 "using altsetting %d for interface %d config %d\n",
1184 altno
, iface
, chip
->setup
);
1185 return 0; /* keep this altsetting */
1188 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
1192 /* Reset ALL ifaces to 0 altsetting.
1193 * Call it for every possible altsetting of every interface.
1195 usb_set_interface(chip
->dev
, iface
, 0);
1197 if (chip
->setup
& MAUDIO_SET
) {
1199 if ((chip
->setup
& MAUDIO_SET_DTS
) && altno
!= 6)
1200 return 1; /* skip this altsetting */
1201 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
1202 return 1; /* skip this altsetting */
1203 mask
= chip
->setup
& MAUDIO_SET_MASK
;
1204 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
1205 return 1; /* skip this altsetting */
1206 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
1207 return 1; /* skip this altsetting */
1208 if (mask
== MAUDIO_SET_16B_48K_DI
&& altno
!= 4)
1209 return 1; /* skip this altsetting */
1210 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 5)
1211 return 1; /* skip this altsetting */
1214 return 0; /* keep this altsetting */
1217 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio
*chip
,
1218 int iface
, int altno
)
1220 /* Reset ALL ifaces to 0 altsetting.
1221 * Call it for every possible altsetting of every interface.
1223 usb_set_interface(chip
->dev
, iface
, 0);
1225 /* possible configuration where both inputs and only one output is
1226 *used is not supported by the current setup
1228 if (chip
->setup
& (MAUDIO_SET
| MAUDIO_SET_24B
)) {
1229 if (chip
->setup
& MAUDIO_SET_96K
) {
1230 if (altno
!= 3 && altno
!= 6)
1232 } else if (chip
->setup
& MAUDIO_SET_DI
) {
1234 return 1; /* no analog input */
1235 if (altno
!= 2 && altno
!= 5)
1236 return 1; /* enable only altsets 2 and 5 */
1239 return 1; /* disable digialt input */
1240 if (altno
!= 2 && altno
!= 5)
1241 return 1; /* enalbe only altsets 2 and 5 */
1244 /* keep only 16-Bit mode */
1250 "using altsetting %d for interface %d config %d\n",
1251 altno
, iface
, chip
->setup
);
1252 return 0; /* keep this altsetting */
1255 static int s1810c_skip_setting_quirk(struct snd_usb_audio
*chip
,
1256 int iface
, int altno
)
1261 * Playback (Interface 1):
1262 * 1: 6 Analog + 2 S/PDIF
1263 * 2: 6 Analog + 2 S/PDIF
1266 * Capture (Interface 2):
1267 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1268 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1273 * I'll leave 2 as the default one and
1274 * use device_setup to switch to the
1277 if ((chip
->setup
== 0 || chip
->setup
> 2) && altno
!= 2)
1279 else if (chip
->setup
== 1 && altno
!= 1)
1281 else if (chip
->setup
== 2 && altno
!= 3)
1287 int snd_usb_apply_interface_quirk(struct snd_usb_audio
*chip
,
1291 /* audiophile usb: skip altsets incompatible with device_setup */
1292 if (chip
->usb_id
== USB_ID(0x0763, 0x2003))
1293 return audiophile_skip_setting_quirk(chip
, iface
, altno
);
1294 /* quattro usb: skip altsets incompatible with device_setup */
1295 if (chip
->usb_id
== USB_ID(0x0763, 0x2001))
1296 return quattro_skip_setting_quirk(chip
, iface
, altno
);
1297 /* fasttrackpro usb: skip altsets incompatible with device_setup */
1298 if (chip
->usb_id
== USB_ID(0x0763, 0x2012))
1299 return fasttrackpro_skip_setting_quirk(chip
, iface
, altno
);
1300 /* presonus studio 1810c: skip altsets incompatible with device_setup */
1301 if (chip
->usb_id
== USB_ID(0x0194f, 0x010c))
1302 return s1810c_skip_setting_quirk(chip
, iface
, altno
);
1308 int snd_usb_apply_boot_quirk(struct usb_device
*dev
,
1309 struct usb_interface
*intf
,
1310 const struct snd_usb_audio_quirk
*quirk
,
1314 case USB_ID(0x041e, 0x3000):
1315 /* SB Extigy needs special boot-up sequence */
1316 /* if more models come, this will go to the quirk list. */
1317 return snd_usb_extigy_boot_quirk(dev
, intf
);
1319 case USB_ID(0x041e, 0x3020):
1320 /* SB Audigy 2 NX needs its own boot-up magic, too */
1321 return snd_usb_audigy2nx_boot_quirk(dev
);
1323 case USB_ID(0x10f5, 0x0200):
1324 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1325 return snd_usb_cm106_boot_quirk(dev
);
1327 case USB_ID(0x0d8c, 0x0102):
1328 /* C-Media CM6206 / CM106-Like Sound Device */
1329 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1330 return snd_usb_cm6206_boot_quirk(dev
);
1332 case USB_ID(0x0dba, 0x3000):
1333 /* Digidesign Mbox 2 */
1334 return snd_usb_mbox2_boot_quirk(dev
);
1336 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1337 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1338 return snd_usb_novation_boot_quirk(dev
);
1340 case USB_ID(0x133e, 0x0815):
1341 /* Access Music VirusTI Desktop */
1342 return snd_usb_accessmusic_boot_quirk(dev
);
1344 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1345 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1346 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1347 return snd_usb_nativeinstruments_boot_quirk(dev
);
1348 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1349 return snd_usb_fasttrackpro_boot_quirk(dev
);
1350 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1351 return snd_usb_gamecon780_boot_quirk(dev
);
1352 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1353 return snd_usb_axefx3_boot_quirk(dev
);
1354 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1356 * For some reason interface 3 with vendor-spec class is
1357 * detected on MicroBook IIc.
1359 if (get_iface_desc(intf
->altsetting
)->bInterfaceClass
==
1360 USB_CLASS_VENDOR_SPEC
&&
1361 get_iface_desc(intf
->altsetting
)->bInterfaceNumber
< 3)
1362 return snd_usb_motu_microbookii_boot_quirk(dev
);
1369 int snd_usb_apply_boot_quirk_once(struct usb_device
*dev
,
1370 struct usb_interface
*intf
,
1371 const struct snd_usb_audio_quirk
*quirk
,
1375 case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
1376 return snd_usb_motu_m_series_boot_quirk(dev
);
1383 * check if the device uses big-endian samples
1385 int snd_usb_is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
1387 /* it depends on altsetting whether the device is big-endian or not */
1388 switch (chip
->usb_id
) {
1389 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1390 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1391 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1394 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1395 if (chip
->setup
== 0x00 ||
1396 fp
->altsetting
== 1 || fp
->altsetting
== 2 ||
1397 fp
->altsetting
== 3)
1400 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1401 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1402 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1410 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1411 * not for interface.
1415 EMU_QUIRK_SR_44100HZ
= 0,
1416 EMU_QUIRK_SR_48000HZ
,
1417 EMU_QUIRK_SR_88200HZ
,
1418 EMU_QUIRK_SR_96000HZ
,
1419 EMU_QUIRK_SR_176400HZ
,
1420 EMU_QUIRK_SR_192000HZ
1423 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
1424 struct audioformat
*fmt
)
1426 unsigned char emu_samplerate_id
= 0;
1428 /* When capture is active
1429 * sample rate shouldn't be changed
1430 * by playback substream
1432 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1433 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
1437 switch (fmt
->rate_min
) {
1439 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
1442 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
1445 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
1448 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
1451 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
1454 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
1457 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
1458 subs
->pkt_offset_adj
= (emu_samplerate_id
>= EMU_QUIRK_SR_176400HZ
) ? 4 : 0;
1461 void snd_usb_set_format_quirk(struct snd_usb_substream
*subs
,
1462 struct audioformat
*fmt
)
1464 switch (subs
->stream
->chip
->usb_id
) {
1465 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1466 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1467 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1468 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1469 set_format_emu_quirk(subs
, fmt
);
1474 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio
*chip
)
1476 /* devices which do not support reading the sample rate. */
1477 switch (chip
->usb_id
) {
1478 case USB_ID(0x041e, 0x4080): /* Creative Live Cam VF0610 */
1479 case USB_ID(0x04d8, 0xfeea): /* Benchmark DAC1 Pre */
1480 case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
1481 case USB_ID(0x05a3, 0x9420): /* ELP HD USB Camera */
1482 case USB_ID(0x05a7, 0x1020): /* Bose Companion 5 */
1483 case USB_ID(0x074d, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1484 case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
1485 case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
1486 case USB_ID(0x21b4, 0x0081): /* AudioQuest DragonFly */
1487 case USB_ID(0x2912, 0x30c8): /* Audioengine D1 */
1491 /* devices of these vendors don't support reading rate, either */
1492 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1493 case 0x045e: /* MS Lifecam */
1494 case 0x047f: /* Plantronics */
1495 case 0x1de7: /* Phoenix Audio */
1502 /* ITF-USB DSD based DACs need a vendor cmd to switch
1503 * between PCM and native DSD mode
1505 static bool is_itf_usb_dsd_dac(unsigned int id
)
1508 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1509 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1510 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1511 case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
1512 case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
1513 case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
1514 case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
1520 int snd_usb_select_mode_quirk(struct snd_usb_substream
*subs
,
1521 struct audioformat
*fmt
)
1523 struct usb_device
*dev
= subs
->dev
;
1526 if (is_itf_usb_dsd_dac(subs
->stream
->chip
->usb_id
)) {
1527 /* First switch to alt set 0, otherwise the mode switch cmd
1528 * will not be accepted by the DAC
1530 err
= usb_set_interface(dev
, fmt
->iface
, 0);
1534 msleep(20); /* Delay needed after setting the interface */
1536 /* Vendor mode switch cmd is required. */
1537 if (fmt
->formats
& SNDRV_PCM_FMTBIT_DSD_U32_BE
) {
1538 /* DSD mode (DSD_U32) requested */
1539 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0,
1540 USB_DIR_OUT
|USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
,
1546 /* PCM or DOP mode (S32) requested */
1547 /* PCM mode (S16) requested */
1548 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0,
1549 USB_DIR_OUT
|USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
,
1560 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint
*ep
)
1563 * "Playback Design" products send bogus feedback data at the start
1564 * of the stream. Ignore them.
1566 if (USB_ID_VENDOR(ep
->chip
->usb_id
) == 0x23ba &&
1567 ep
->type
== SND_USB_ENDPOINT_TYPE_SYNC
)
1568 ep
->skip_packets
= 4;
1571 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1572 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1573 * the stream is (re)started. When skipping packets 16 at endpoint
1574 * start up, the real world latency is stable within +/- 1 frame (also
1575 * across power cycles).
1577 if ((ep
->chip
->usb_id
== USB_ID(0x0763, 0x2030) ||
1578 ep
->chip
->usb_id
== USB_ID(0x0763, 0x2031)) &&
1579 ep
->type
== SND_USB_ENDPOINT_TYPE_DATA
)
1580 ep
->skip_packets
= 16;
1582 /* Work around devices that report unreasonable feedback data */
1583 if ((ep
->chip
->usb_id
== USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */
1584 ep
->chip
->usb_id
== USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1585 ep
->syncmaxsize
== 4)
1586 ep
->tenor_fb_quirk
= 1;
1589 void snd_usb_set_interface_quirk(struct usb_device
*dev
)
1591 struct snd_usb_audio
*chip
= dev_get_drvdata(&dev
->dev
);
1596 * "Playback Design" products need a 50ms delay after setting the
1599 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1600 case 0x23ba: /* Playback Design */
1601 case 0x0644: /* TEAC Corp. */
1607 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1608 void snd_usb_ctl_msg_quirk(struct usb_device
*dev
, unsigned int pipe
,
1609 __u8 request
, __u8 requesttype
, __u16 value
,
1610 __u16 index
, void *data
, __u16 size
)
1612 struct snd_usb_audio
*chip
= dev_get_drvdata(&dev
->dev
);
1617 * "Playback Design" products need a 20ms delay after each
1618 * class compliant request
1620 if (USB_ID_VENDOR(chip
->usb_id
) == 0x23ba &&
1621 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1625 * "TEAC Corp." products need a 20ms delay after each
1626 * class compliant request
1628 if (USB_ID_VENDOR(chip
->usb_id
) == 0x0644 &&
1629 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1632 /* ITF-USB DSD based DACs functionality need a delay
1633 * after each class compliant request
1635 if (is_itf_usb_dsd_dac(chip
->usb_id
)
1636 && (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1639 /* Zoom R16/24, Logitech H650e, Jabra 550a needs a tiny delay here,
1640 * otherwise requests like get/set frequency return as failed despite
1641 * actually succeeding.
1643 if ((chip
->usb_id
== USB_ID(0x1686, 0x00dd) ||
1644 chip
->usb_id
== USB_ID(0x046d, 0x0a46) ||
1645 chip
->usb_id
== USB_ID(0x0b0e, 0x0349)) &&
1646 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1647 usleep_range(1000, 2000);
1651 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1652 * augment the PCM format bit-field for DSD types. The UAC standards
1653 * don't have a designated bit field to denote DSD-capable interfaces,
1654 * hence all hardware that is known to support this format has to be
1657 u64
snd_usb_interface_dsd_format_quirks(struct snd_usb_audio
*chip
,
1658 struct audioformat
*fp
,
1659 unsigned int sample_bytes
)
1661 struct usb_interface
*iface
;
1663 /* Playback Designs */
1664 if (USB_ID_VENDOR(chip
->usb_id
) == 0x23ba &&
1665 USB_ID_PRODUCT(chip
->usb_id
) < 0x0110) {
1666 switch (fp
->altsetting
) {
1669 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1671 fp
->dsd_bitrev
= true;
1672 return SNDRV_PCM_FMTBIT_DSD_U8
;
1674 fp
->dsd_bitrev
= true;
1675 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1679 /* XMOS based USB DACs */
1680 switch (chip
->usb_id
) {
1681 case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
1682 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1683 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1684 if (fp
->altsetting
== 2)
1685 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1688 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1689 case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1690 case USB_ID(0x16b0, 0x06b2): /* NuPrime DAC-10 */
1691 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1692 case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1693 case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1694 case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
1695 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1696 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1697 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1698 case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1699 case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1700 case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1701 case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1702 if (fp
->altsetting
== 3)
1703 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1706 /* Amanero Combo384 USB based DACs with native DSD support */
1707 case USB_ID(0x16d0, 0x071a): /* Amanero - Combo384 */
1708 case USB_ID(0x2ab6, 0x0004): /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1709 case USB_ID(0x2ab6, 0x0005): /* T+A USB HD Audio 1 */
1710 case USB_ID(0x2ab6, 0x0006): /* T+A USB HD Audio 2 */
1711 if (fp
->altsetting
== 2) {
1712 switch (le16_to_cpu(chip
->dev
->descriptor
.bcdDevice
)) {
1714 return SNDRV_PCM_FMTBIT_DSD_U32_LE
;
1717 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1723 case USB_ID(0x16d0, 0x0a23):
1724 if (fp
->altsetting
== 2)
1725 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1732 /* ITF-USB DSD based DACs */
1733 if (is_itf_usb_dsd_dac(chip
->usb_id
)) {
1734 iface
= usb_ifnum_to_if(chip
->dev
, fp
->iface
);
1736 /* Altsetting 2 support native DSD if the num of altsets is
1738 * Altsetting 3 support native DSD if the num of altsets is
1741 if (fp
->altsetting
== iface
->num_altsetting
- 1)
1742 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1745 /* Mostly generic method to detect many DSD-capable implementations -
1746 * from XMOS/Thesycon
1748 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1749 case 0x152a: /* Thesycon devices */
1750 case 0x20b1: /* XMOS based devices */
1751 case 0x22d9: /* Oppo */
1752 case 0x23ba: /* Playback Designs */
1753 case 0x25ce: /* Mytek devices */
1754 case 0x278b: /* Rotel? */
1755 case 0x292b: /* Gustard/Ess based devices */
1756 case 0x2ab6: /* T+A devices */
1757 case 0x3842: /* EVGA */
1758 case 0xc502: /* HiBy devices */
1760 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1770 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio
*chip
,
1771 struct audioformat
*fp
,
1774 switch (chip
->usb_id
) {
1775 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1776 /* Optoplay sets the sample rate attribute although
1777 * it seems not supporting it in fact.
1779 fp
->attributes
&= ~UAC_EP_CS_ATTR_SAMPLE_RATE
;
1781 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1782 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1783 /* doesn't set the sample rate attribute, but supports it */
1784 fp
->attributes
|= UAC_EP_CS_ATTR_SAMPLE_RATE
;
1786 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
1787 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1788 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1789 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1790 an older model 77d:223) */
1792 * plantronics headset and Griffin iMic have set adaptive-in
1793 * although it's really not...
1795 fp
->ep_attr
&= ~USB_ENDPOINT_SYNCTYPE
;
1796 if (stream
== SNDRV_PCM_STREAM_PLAYBACK
)
1797 fp
->ep_attr
|= USB_ENDPOINT_SYNC_ADAPTIVE
;
1799 fp
->ep_attr
|= USB_ENDPOINT_SYNC_SYNC
;
1801 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook IIc */
1803 * MaxPacketsOnly attribute is erroneously set in endpoint
1804 * descriptors. As a result this card produces noise with
1805 * all sample rates other than 96 KHz.
1807 fp
->attributes
&= ~UAC_EP_CS_ATTR_FILL_MAX
;
1813 * registration quirk:
1814 * the registration is skipped if a device matches with the given ID,
1815 * unless the interface reaches to the defined one. This is for delaying
1816 * the registration until the last known interface, so that the card and
1817 * devices appear at the same time.
1820 struct registration_quirk
{
1821 unsigned int usb_id
; /* composed via USB_ID() */
1822 unsigned int interface
; /* the interface to trigger register */
1825 #define REG_QUIRK_ENTRY(vendor, product, iface) \
1826 { .usb_id = USB_ID(vendor, product), .interface = (iface) }
1828 static const struct registration_quirk registration_quirks
[] = {
1829 REG_QUIRK_ENTRY(0x0951, 0x16d8, 2), /* Kingston HyperX AMP */
1830 REG_QUIRK_ENTRY(0x0951, 0x16ed, 2), /* Kingston HyperX Cloud Alpha S */
1831 { 0 } /* terminator */
1834 /* return true if skipping registration */
1835 bool snd_usb_registration_quirk(struct snd_usb_audio
*chip
, int iface
)
1837 const struct registration_quirk
*q
;
1839 for (q
= registration_quirks
; q
->usb_id
; q
++)
1840 if (chip
->usb_id
== q
->usb_id
)
1841 return iface
!= q
->interface
;
1843 /* Register as normal */