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
&& (injd
->bLength
< 5 ||
252 (injd
->bJackType
!= USB_MS_EMBEDDED
&&
253 injd
->bJackType
!= USB_MS_EXTERNAL
)))
255 if (outjd
&& (outjd
->bLength
< 6 ||
256 (outjd
->bJackType
!= USB_MS_EMBEDDED
&&
257 outjd
->bJackType
!= USB_MS_EXTERNAL
)))
259 return create_any_midi_quirk(chip
, iface
, driver
, &yamaha_midi_quirk
);
262 static int create_roland_midi_quirk(struct snd_usb_audio
*chip
,
263 struct usb_interface
*iface
,
264 struct usb_driver
*driver
,
265 struct usb_host_interface
*alts
)
267 static const struct snd_usb_audio_quirk roland_midi_quirk
= {
268 .type
= QUIRK_MIDI_ROLAND
270 u8
*roland_desc
= NULL
;
272 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
274 roland_desc
= snd_usb_find_csint_desc(alts
->extra
,
279 if (roland_desc
[0] < 6 || roland_desc
[3] != 2)
281 return create_any_midi_quirk(chip
, iface
, driver
,
286 static int create_std_midi_quirk(struct snd_usb_audio
*chip
,
287 struct usb_interface
*iface
,
288 struct usb_driver
*driver
,
289 struct usb_host_interface
*alts
)
291 struct usb_ms_header_descriptor
*mshd
;
292 struct usb_ms_endpoint_descriptor
*msepd
;
294 /* must have the MIDIStreaming interface header descriptor*/
295 mshd
= (struct usb_ms_header_descriptor
*)alts
->extra
;
296 if (alts
->extralen
< 7 ||
298 mshd
->bDescriptorType
!= USB_DT_CS_INTERFACE
||
299 mshd
->bDescriptorSubtype
!= USB_MS_HEADER
)
301 /* must have the MIDIStreaming endpoint descriptor*/
302 msepd
= (struct usb_ms_endpoint_descriptor
*)alts
->endpoint
[0].extra
;
303 if (alts
->endpoint
[0].extralen
< 4 ||
304 msepd
->bLength
< 4 ||
305 msepd
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
306 msepd
->bDescriptorSubtype
!= UAC_MS_GENERAL
||
307 msepd
->bNumEmbMIDIJack
< 1 ||
308 msepd
->bNumEmbMIDIJack
> 16)
311 return create_any_midi_quirk(chip
, iface
, driver
, NULL
);
314 static int create_auto_midi_quirk(struct snd_usb_audio
*chip
,
315 struct usb_interface
*iface
,
316 struct usb_driver
*driver
)
318 struct usb_host_interface
*alts
;
319 struct usb_interface_descriptor
*altsd
;
320 struct usb_endpoint_descriptor
*epd
;
323 alts
= &iface
->altsetting
[0];
324 altsd
= get_iface_desc(alts
);
326 /* must have at least one bulk/interrupt endpoint for streaming */
327 if (altsd
->bNumEndpoints
< 1)
329 epd
= get_endpoint(alts
, 0);
330 if (!usb_endpoint_xfer_bulk(epd
) &&
331 !usb_endpoint_xfer_int(epd
))
334 switch (USB_ID_VENDOR(chip
->usb_id
)) {
335 case 0x0499: /* Yamaha */
336 err
= create_yamaha_midi_quirk(chip
, iface
, driver
, alts
);
340 case 0x0582: /* Roland */
341 err
= create_roland_midi_quirk(chip
, iface
, driver
, alts
);
347 return create_std_midi_quirk(chip
, iface
, driver
, alts
);
350 static int create_autodetect_quirk(struct snd_usb_audio
*chip
,
351 struct usb_interface
*iface
,
352 struct usb_driver
*driver
)
356 err
= create_auto_pcm_quirk(chip
, iface
, driver
);
358 err
= create_auto_midi_quirk(chip
, iface
, driver
);
362 static int create_autodetect_quirks(struct snd_usb_audio
*chip
,
363 struct usb_interface
*iface
,
364 struct usb_driver
*driver
,
365 const struct snd_usb_audio_quirk
*quirk
)
367 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
368 int ifcount
, ifnum
, err
;
370 err
= create_autodetect_quirk(chip
, iface
, driver
);
375 * ALSA PCM playback/capture devices cannot be registered in two steps,
376 * so we have to claim the other corresponding interface here.
378 ifcount
= chip
->dev
->actconfig
->desc
.bNumInterfaces
;
379 for (ifnum
= 0; ifnum
< ifcount
; ifnum
++) {
380 if (ifnum
== probed_ifnum
|| quirk
->ifnum
>= 0)
382 iface
= usb_ifnum_to_if(chip
->dev
, ifnum
);
384 usb_interface_claimed(iface
) ||
385 get_iface_desc(iface
->altsetting
)->bInterfaceClass
!=
386 USB_CLASS_VENDOR_SPEC
)
389 err
= create_autodetect_quirk(chip
, iface
, driver
);
391 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
398 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
399 * The only way to detect the sample rate is by looking at wMaxPacketSize.
401 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
402 struct usb_interface
*iface
,
403 struct usb_driver
*driver
,
404 const struct snd_usb_audio_quirk
*quirk
)
406 static const struct audioformat ua_format
= {
407 .formats
= SNDRV_PCM_FMTBIT_S24_3LE
,
409 .fmt_type
= UAC_FORMAT_TYPE_I
,
412 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
414 struct usb_host_interface
*alts
;
415 struct usb_interface_descriptor
*altsd
;
416 struct audioformat
*fp
;
419 /* both PCM and MIDI interfaces have 2 or more altsettings */
420 if (iface
->num_altsetting
< 2)
422 alts
= &iface
->altsetting
[1];
423 altsd
= get_iface_desc(alts
);
425 if (altsd
->bNumEndpoints
== 2) {
426 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
427 .out_cables
= 0x0003,
430 static const struct snd_usb_audio_quirk ua700_quirk
= {
431 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
434 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
435 .out_cables
= 0x0001,
438 static const struct snd_usb_audio_quirk uaxx_quirk
= {
439 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
442 const struct snd_usb_audio_quirk
*quirk
=
443 chip
->usb_id
== USB_ID(0x0582, 0x002b)
444 ? &ua700_quirk
: &uaxx_quirk
;
445 return __snd_usbmidi_create(chip
->card
, iface
,
446 &chip
->midi_list
, quirk
,
450 if (altsd
->bNumEndpoints
!= 1)
453 fp
= kmemdup(&ua_format
, sizeof(*fp
), GFP_KERNEL
);
457 fp
->iface
= altsd
->bInterfaceNumber
;
458 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
459 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
460 fp
->datainterval
= 0;
461 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
462 INIT_LIST_HEAD(&fp
->list
);
464 switch (fp
->maxpacksize
) {
466 fp
->rate_max
= fp
->rate_min
= 44100;
470 fp
->rate_max
= fp
->rate_min
= 48000;
474 fp
->rate_max
= fp
->rate_min
= 96000;
477 usb_audio_err(chip
, "unknown sample rate\n");
482 stream
= (fp
->endpoint
& USB_DIR_IN
)
483 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
484 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
486 list_del(&fp
->list
); /* unlink for avoiding double-free */
490 usb_set_interface(chip
->dev
, fp
->iface
, 0);
495 * Create a standard mixer for the specified interface.
497 static int create_standard_mixer_quirk(struct snd_usb_audio
*chip
,
498 struct usb_interface
*iface
,
499 struct usb_driver
*driver
,
500 const struct snd_usb_audio_quirk
*quirk
)
502 if (quirk
->ifnum
< 0)
505 return snd_usb_create_mixer(chip
, quirk
->ifnum
, 0);
509 * audio-interface quirks
511 * returns zero if no standard audio/MIDI parsing is needed.
512 * returns a positive value if standard audio/midi interfaces are parsed
514 * returns a negative value at error.
516 int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
517 struct usb_interface
*iface
,
518 struct usb_driver
*driver
,
519 const struct snd_usb_audio_quirk
*quirk
)
521 typedef int (*quirk_func_t
)(struct snd_usb_audio
*,
522 struct usb_interface
*,
524 const struct snd_usb_audio_quirk
*);
525 static const quirk_func_t quirk_funcs
[] = {
526 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
527 [QUIRK_COMPOSITE
] = create_composite_quirk
,
528 [QUIRK_AUTODETECT
] = create_autodetect_quirks
,
529 [QUIRK_MIDI_STANDARD_INTERFACE
] = create_any_midi_quirk
,
530 [QUIRK_MIDI_FIXED_ENDPOINT
] = create_any_midi_quirk
,
531 [QUIRK_MIDI_YAMAHA
] = create_any_midi_quirk
,
532 [QUIRK_MIDI_ROLAND
] = create_any_midi_quirk
,
533 [QUIRK_MIDI_MIDIMAN
] = create_any_midi_quirk
,
534 [QUIRK_MIDI_NOVATION
] = create_any_midi_quirk
,
535 [QUIRK_MIDI_RAW_BYTES
] = create_any_midi_quirk
,
536 [QUIRK_MIDI_EMAGIC
] = create_any_midi_quirk
,
537 [QUIRK_MIDI_CME
] = create_any_midi_quirk
,
538 [QUIRK_MIDI_AKAI
] = create_any_midi_quirk
,
539 [QUIRK_MIDI_FTDI
] = create_any_midi_quirk
,
540 [QUIRK_MIDI_CH345
] = create_any_midi_quirk
,
541 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
542 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
543 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
,
544 [QUIRK_AUDIO_ALIGN_TRANSFER
] = create_align_transfer_quirk
,
545 [QUIRK_AUDIO_STANDARD_MIXER
] = create_standard_mixer_quirk
,
548 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
549 return quirk_funcs
[quirk
->type
](chip
, iface
, driver
, quirk
);
551 usb_audio_err(chip
, "invalid quirk type %d\n", quirk
->type
);
560 #define EXTIGY_FIRMWARE_SIZE_OLD 794
561 #define EXTIGY_FIRMWARE_SIZE_NEW 483
563 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
565 struct usb_host_config
*config
= dev
->actconfig
;
568 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
569 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
570 dev_dbg(&dev
->dev
, "sending Extigy boot sequence...\n");
571 /* Send message to force it to reconnect with full interface. */
572 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
573 0x10, 0x43, 0x0001, 0x000a, NULL
, 0);
575 dev_dbg(&dev
->dev
, "error sending boot message: %d\n", err
);
576 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
577 &dev
->descriptor
, sizeof(dev
->descriptor
));
578 config
= dev
->actconfig
;
580 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
581 err
= usb_reset_configuration(dev
);
583 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
584 dev_dbg(&dev
->dev
, "extigy_boot: new boot length = %d\n",
585 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
586 return -ENODEV
; /* quit this anyway */
591 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
595 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
596 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
599 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
600 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
607 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device
*dev
)
611 if (dev
->actconfig
->desc
.bConfigurationValue
== 1) {
613 "Fast Track Pro switching to config #2\n");
614 /* This function has to be available by the usb core module.
615 * if it is not avialable the boot quirk has to be left out
616 * and the configuration has to be set by udev or hotplug
619 err
= usb_driver_set_configuration(dev
, 2);
622 "error usb_driver_set_configuration: %d\n",
624 /* Always return an error, so that we stop creating a device
625 that will just be destroyed and recreated with a new
629 dev_info(&dev
->dev
, "Fast Track Pro config OK\n");
635 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
636 * documented in the device's data sheet.
638 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
642 buf
[1] = value
& 0xff;
643 buf
[2] = (value
>> 8) & 0xff;
645 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
646 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
650 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
653 * Enable line-out driver mode, set headphone source to front
654 * channels, enable stereo mic.
656 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
660 * CM6206 registers from the CM6206 datasheet rev 2.1
662 #define CM6206_REG0_DMA_MASTER BIT(15)
663 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
664 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
665 /* Bit 4 thru 11 is the S/PDIF category code */
666 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
667 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
668 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
669 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
670 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
672 #define CM6206_REG1_TEST_SEL_CLK BIT(14)
673 #define CM6206_REG1_PLLBIN_EN BIT(13)
674 #define CM6206_REG1_SOFT_MUTE_EN BIT(12)
675 #define CM6206_REG1_GPIO4_OUT BIT(11)
676 #define CM6206_REG1_GPIO4_OE BIT(10)
677 #define CM6206_REG1_GPIO3_OUT BIT(9)
678 #define CM6206_REG1_GPIO3_OE BIT(8)
679 #define CM6206_REG1_GPIO2_OUT BIT(7)
680 #define CM6206_REG1_GPIO2_OE BIT(6)
681 #define CM6206_REG1_GPIO1_OUT BIT(5)
682 #define CM6206_REG1_GPIO1_OE BIT(4)
683 #define CM6206_REG1_SPDIFO_INVALID BIT(3)
684 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
685 #define CM6206_REG1_SPDIFO_DIS BIT(1)
686 #define CM6206_REG1_SPDIFI_MIX BIT(0)
688 #define CM6206_REG2_DRIVER_ON BIT(15)
689 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
690 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
691 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
692 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
693 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
694 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
695 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
696 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
697 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
698 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
699 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
700 #define CM6206_REG2_MUTE_CENTER BIT(5)
701 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
702 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
703 #define CM6206_REG2_EN_BTL BIT(2)
704 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
705 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
706 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
707 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
709 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
710 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
711 #define CM6206_REG3_VRAP25EN BIT(10)
712 #define CM6206_REG3_MSEL1 BIT(9)
713 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
714 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
715 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
716 #define CM6206_REG3_PINSEL BIT(6)
717 #define CM6206_REG3_FOE BIT(5)
718 #define CM6206_REG3_ROE BIT(4)
719 #define CM6206_REG3_CBOE BIT(3)
720 #define CM6206_REG3_LOSE BIT(2)
721 #define CM6206_REG3_HPOE BIT(1)
722 #define CM6206_REG3_SPDIFI_CANREC BIT(0)
724 #define CM6206_REG5_DA_RSTN BIT(13)
725 #define CM6206_REG5_AD_RSTN BIT(12)
726 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
727 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
728 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
729 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
730 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
731 #define CM6206_REG5_CODECM BIT(8)
732 #define CM6206_REG5_EN_HPF BIT(7)
733 #define CM6206_REG5_T_SEL_DSDA4 BIT(6)
734 #define CM6206_REG5_T_SEL_DSDA3 BIT(5)
735 #define CM6206_REG5_T_SEL_DSDA2 BIT(4)
736 #define CM6206_REG5_T_SEL_DSDA1 BIT(3)
737 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
738 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4
739 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
740 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
741 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
743 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
748 * Values here are chosen based on sniffing USB traffic
751 * REG0: DAC is master, sample rate 48kHz, no copyright
753 CM6206_REG0_SPDIFO_RATE_48K
|
754 CM6206_REG0_SPDIFO_COPYRIGHT_NA
,
756 * REG1: PLL binary search enable, soft mute enable.
758 CM6206_REG1_PLLBIN_EN
|
759 CM6206_REG1_SOFT_MUTE_EN
,
761 * REG2: enable output drivers,
762 * select front channels to the headphone output,
763 * then mute the headphone channels, run the MCU
766 CM6206_REG2_DRIVER_ON
|
767 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS
|
768 CM6206_REG2_MUTE_HEADPHONE_RIGHT
|
769 CM6206_REG2_MUTE_HEADPHONE_LEFT
,
771 * REG3: default flyspeed, set 2.5V mic bias
772 * enable all line out ports and enable SPDIF
774 CM6206_REG3_FLYSPEED_DEFAULT
|
775 CM6206_REG3_VRAP25EN
|
781 CM6206_REG3_SPDIFI_CANREC
,
782 /* REG4 is just a bunch of GPIO lines */
784 /* REG5: de-assert AD/DA reset signals */
785 CM6206_REG5_DA_RSTN
|
786 CM6206_REG5_AD_RSTN
};
788 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
789 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
797 /* quirk for Plantronics GameCom 780 with CM6302 chip */
798 static int snd_usb_gamecon780_boot_quirk(struct usb_device
*dev
)
800 /* set the initial volume and don't change; other values are either
801 * too loud or silent due to firmware bug (bko#65251)
803 u8 buf
[2] = { 0x74, 0xe3 };
804 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
805 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
806 UAC_FU_VOLUME
<< 8, 9 << 8, buf
, 2);
810 * Novation Twitch DJ controller
811 * Focusrite Novation Saffire 6 USB audio card
813 static int snd_usb_novation_boot_quirk(struct usb_device
*dev
)
815 /* preemptively set up the device because otherwise the
816 * raw MIDI endpoints are not active */
817 usb_set_interface(dev
, 0, 1);
822 * This call will put the synth in "USB send" mode, i.e it will send MIDI
823 * messages through USB (this is disabled at startup). The synth will
824 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
825 * sign on its LCD. Values here are chosen based on sniffing USB traffic
828 static int snd_usb_accessmusic_boot_quirk(struct usb_device
*dev
)
830 int err
, actual_length
;
832 /* "midi send" enable */
833 static const u8 seq
[] = { 0x4e, 0x73, 0x52, 0x01 };
835 void *buf
= kmemdup(seq
, ARRAY_SIZE(seq
), GFP_KERNEL
);
838 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x05), buf
,
839 ARRAY_SIZE(seq
), &actual_length
, 1000);
848 * Some sound cards from Native Instruments are in fact compliant to the USB
849 * audio standard of version 2 and other approved USB standards, even though
850 * they come up as vendor-specific device when first connected.
852 * However, they can be told to come up with a new set of descriptors
853 * upon their next enumeration, and the interfaces announced by the new
854 * descriptors will then be handled by the kernel's class drivers. As the
855 * product ID will also change, no further checks are required.
858 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device
*dev
)
860 int ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
861 0xaf, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
862 1, 0, NULL
, 0, 1000);
867 usb_reset_device(dev
);
869 /* return -EAGAIN, so the creation of an audio interface for this
870 * temporary device is aborted. The device will reconnect with a
875 static void mbox2_setup_48_24_magic(struct usb_device
*dev
)
880 /* Choose 48000Hz permanently */
885 /* Send the magic! */
886 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
887 0x01, 0x22, 0x0100, 0x0085, &temp
, 0x0003);
888 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
889 0x81, 0xa2, 0x0100, 0x0085, &srate
, 0x0003);
890 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
891 0x81, 0xa2, 0x0100, 0x0086, &srate
, 0x0003);
892 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
893 0x81, 0xa2, 0x0100, 0x0003, &srate
, 0x0003);
897 /* Digidesign Mbox 2 needs to load firmware onboard
898 * and driver must wait a few seconds for initialisation.
901 #define MBOX2_FIRMWARE_SIZE 646
902 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
903 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
905 static int snd_usb_mbox2_boot_quirk(struct usb_device
*dev
)
907 struct usb_host_config
*config
= dev
->actconfig
;
909 u8 bootresponse
[0x12];
913 fwsize
= le16_to_cpu(get_cfg_desc(config
)->wTotalLength
);
915 if (fwsize
!= MBOX2_FIRMWARE_SIZE
) {
916 dev_err(&dev
->dev
, "Invalid firmware size=%d.\n", fwsize
);
920 dev_dbg(&dev
->dev
, "Sending Digidesign Mbox 2 boot sequence...\n");
923 bootresponse
[0] = MBOX2_BOOT_LOADING
;
924 while ((bootresponse
[0] == MBOX2_BOOT_LOADING
) && (count
< 10)) {
925 msleep(500); /* 0.5 second delay */
926 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
927 /* Control magic - load onboard firmware */
928 0x85, 0xc0, 0x0001, 0x0000, &bootresponse
, 0x0012);
929 if (bootresponse
[0] == MBOX2_BOOT_READY
)
931 dev_dbg(&dev
->dev
, "device not ready, resending boot sequence...\n");
935 if (bootresponse
[0] != MBOX2_BOOT_READY
) {
936 dev_err(&dev
->dev
, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse
[0]);
940 dev_dbg(&dev
->dev
, "device initialised!\n");
942 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
943 &dev
->descriptor
, sizeof(dev
->descriptor
));
944 config
= dev
->actconfig
;
946 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
948 err
= usb_reset_configuration(dev
);
950 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
951 dev_dbg(&dev
->dev
, "mbox2_boot: new boot length = %d\n",
952 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
954 mbox2_setup_48_24_magic(dev
);
956 dev_info(&dev
->dev
, "Digidesign Mbox 2: 24bit 48kHz");
958 return 0; /* Successful boot */
961 static int snd_usb_axefx3_boot_quirk(struct usb_device
*dev
)
965 dev_dbg(&dev
->dev
, "Waiting for Axe-Fx III to boot up...\n");
967 /* If the Axe-Fx III has not fully booted, it will timeout when trying
968 * to enable the audio streaming interface. A more generous timeout is
969 * used here to detect when the Axe-Fx III has finished booting as the
970 * set interface message will be acked once it has
972 err
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
973 USB_REQ_SET_INTERFACE
, USB_RECIP_INTERFACE
,
974 1, 1, NULL
, 0, 120000);
977 "failed waiting for Axe-Fx III to boot: %d\n", err
);
981 dev_dbg(&dev
->dev
, "Axe-Fx III is now ready\n");
983 err
= usb_set_interface(dev
, 1, 0);
986 "error stopping Axe-Fx III interface: %d\n", err
);
992 #define MICROBOOK_BUF_SIZE 128
994 static int snd_usb_motu_microbookii_communicate(struct usb_device
*dev
, u8
*buf
,
995 int buf_size
, int *length
)
997 int err
, actual_length
;
999 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x01), buf
, *length
,
1000 &actual_length
, 1000);
1004 print_hex_dump(KERN_DEBUG
, "MicroBookII snd: ", DUMP_PREFIX_NONE
, 16, 1,
1005 buf
, actual_length
, false);
1007 memset(buf
, 0, buf_size
);
1009 err
= usb_interrupt_msg(dev
, usb_rcvintpipe(dev
, 0x82), buf
, buf_size
,
1010 &actual_length
, 1000);
1014 print_hex_dump(KERN_DEBUG
, "MicroBookII rcv: ", DUMP_PREFIX_NONE
, 16, 1,
1015 buf
, actual_length
, false);
1017 *length
= actual_length
;
1021 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device
*dev
)
1023 int err
, actual_length
, poll_attempts
= 0;
1024 static const u8 set_samplerate_seq
[] = { 0x00, 0x00, 0x00, 0x00,
1025 0x00, 0x00, 0x0b, 0x14,
1026 0x00, 0x00, 0x00, 0x01 };
1027 static const u8 poll_ready_seq
[] = { 0x00, 0x04, 0x00, 0x00,
1028 0x00, 0x00, 0x0b, 0x18 };
1029 u8
*buf
= kzalloc(MICROBOOK_BUF_SIZE
, GFP_KERNEL
);
1034 dev_info(&dev
->dev
, "Waiting for MOTU Microbook II to boot up...\n");
1036 /* First we tell the device which sample rate to use. */
1037 memcpy(buf
, set_samplerate_seq
, sizeof(set_samplerate_seq
));
1038 actual_length
= sizeof(set_samplerate_seq
);
1039 err
= snd_usb_motu_microbookii_communicate(dev
, buf
, MICROBOOK_BUF_SIZE
,
1044 "failed setting the sample rate for Motu MicroBook II: %d\n",
1049 /* Then we poll every 100 ms until the device informs of its readiness. */
1051 if (++poll_attempts
> 100) {
1053 "failed booting Motu MicroBook II: timeout\n");
1058 memset(buf
, 0, MICROBOOK_BUF_SIZE
);
1059 memcpy(buf
, poll_ready_seq
, sizeof(poll_ready_seq
));
1061 actual_length
= sizeof(poll_ready_seq
);
1062 err
= snd_usb_motu_microbookii_communicate(
1063 dev
, buf
, MICROBOOK_BUF_SIZE
, &actual_length
);
1066 "failed booting Motu MicroBook II: communication error %d\n",
1071 /* the device signals its readiness through a message of the
1073 * XX 06 00 00 00 00 0b 18 00 00 00 01
1074 * If the device is not yet ready to accept audio data, the
1075 * last byte of that sequence is 00.
1077 if (actual_length
== 12 && buf
[actual_length
- 1] == 1)
1083 dev_info(&dev
->dev
, "MOTU MicroBook II ready\n");
1093 #define MAUDIO_SET 0x01 /* parse device_setup */
1094 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
1095 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
1096 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
1097 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
1098 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
1099 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
1100 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
1101 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
1102 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
1103 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
1105 static int quattro_skip_setting_quirk(struct snd_usb_audio
*chip
,
1106 int iface
, int altno
)
1108 /* Reset ALL ifaces to 0 altsetting.
1109 * Call it for every possible altsetting of every interface.
1111 usb_set_interface(chip
->dev
, iface
, 0);
1112 if (chip
->setup
& MAUDIO_SET
) {
1113 if (chip
->setup
& MAUDIO_SET_COMPATIBLE
) {
1114 if (iface
!= 1 && iface
!= 2)
1115 return 1; /* skip all interfaces but 1 and 2 */
1118 if (iface
== 1 || iface
== 2)
1119 return 1; /* skip interfaces 1 and 2 */
1120 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
1121 return 1; /* skip this altsetting */
1122 mask
= chip
->setup
& MAUDIO_SET_MASK
;
1123 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
1124 return 1; /* skip this altsetting */
1125 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
1126 return 1; /* skip this altsetting */
1127 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 4)
1128 return 1; /* skip this altsetting */
1132 "using altsetting %d for interface %d config %d\n",
1133 altno
, iface
, chip
->setup
);
1134 return 0; /* keep this altsetting */
1137 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
1141 /* Reset ALL ifaces to 0 altsetting.
1142 * Call it for every possible altsetting of every interface.
1144 usb_set_interface(chip
->dev
, iface
, 0);
1146 if (chip
->setup
& MAUDIO_SET
) {
1148 if ((chip
->setup
& MAUDIO_SET_DTS
) && altno
!= 6)
1149 return 1; /* skip this altsetting */
1150 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
1151 return 1; /* skip this altsetting */
1152 mask
= chip
->setup
& MAUDIO_SET_MASK
;
1153 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
1154 return 1; /* skip this altsetting */
1155 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
1156 return 1; /* skip this altsetting */
1157 if (mask
== MAUDIO_SET_16B_48K_DI
&& altno
!= 4)
1158 return 1; /* skip this altsetting */
1159 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 5)
1160 return 1; /* skip this altsetting */
1163 return 0; /* keep this altsetting */
1166 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio
*chip
,
1167 int iface
, int altno
)
1169 /* Reset ALL ifaces to 0 altsetting.
1170 * Call it for every possible altsetting of every interface.
1172 usb_set_interface(chip
->dev
, iface
, 0);
1174 /* possible configuration where both inputs and only one output is
1175 *used is not supported by the current setup
1177 if (chip
->setup
& (MAUDIO_SET
| MAUDIO_SET_24B
)) {
1178 if (chip
->setup
& MAUDIO_SET_96K
) {
1179 if (altno
!= 3 && altno
!= 6)
1181 } else if (chip
->setup
& MAUDIO_SET_DI
) {
1183 return 1; /* no analog input */
1184 if (altno
!= 2 && altno
!= 5)
1185 return 1; /* enable only altsets 2 and 5 */
1188 return 1; /* disable digialt input */
1189 if (altno
!= 2 && altno
!= 5)
1190 return 1; /* enalbe only altsets 2 and 5 */
1193 /* keep only 16-Bit mode */
1199 "using altsetting %d for interface %d config %d\n",
1200 altno
, iface
, chip
->setup
);
1201 return 0; /* keep this altsetting */
1204 int snd_usb_apply_interface_quirk(struct snd_usb_audio
*chip
,
1208 /* audiophile usb: skip altsets incompatible with device_setup */
1209 if (chip
->usb_id
== USB_ID(0x0763, 0x2003))
1210 return audiophile_skip_setting_quirk(chip
, iface
, altno
);
1211 /* quattro usb: skip altsets incompatible with device_setup */
1212 if (chip
->usb_id
== USB_ID(0x0763, 0x2001))
1213 return quattro_skip_setting_quirk(chip
, iface
, altno
);
1214 /* fasttrackpro usb: skip altsets incompatible with device_setup */
1215 if (chip
->usb_id
== USB_ID(0x0763, 0x2012))
1216 return fasttrackpro_skip_setting_quirk(chip
, iface
, altno
);
1221 int snd_usb_apply_boot_quirk(struct usb_device
*dev
,
1222 struct usb_interface
*intf
,
1223 const struct snd_usb_audio_quirk
*quirk
,
1227 case USB_ID(0x041e, 0x3000):
1228 /* SB Extigy needs special boot-up sequence */
1229 /* if more models come, this will go to the quirk list. */
1230 return snd_usb_extigy_boot_quirk(dev
, intf
);
1232 case USB_ID(0x041e, 0x3020):
1233 /* SB Audigy 2 NX needs its own boot-up magic, too */
1234 return snd_usb_audigy2nx_boot_quirk(dev
);
1236 case USB_ID(0x10f5, 0x0200):
1237 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1238 return snd_usb_cm106_boot_quirk(dev
);
1240 case USB_ID(0x0d8c, 0x0102):
1241 /* C-Media CM6206 / CM106-Like Sound Device */
1242 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1243 return snd_usb_cm6206_boot_quirk(dev
);
1245 case USB_ID(0x0dba, 0x3000):
1246 /* Digidesign Mbox 2 */
1247 return snd_usb_mbox2_boot_quirk(dev
);
1249 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1250 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1251 return snd_usb_novation_boot_quirk(dev
);
1253 case USB_ID(0x133e, 0x0815):
1254 /* Access Music VirusTI Desktop */
1255 return snd_usb_accessmusic_boot_quirk(dev
);
1257 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1258 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1259 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1260 return snd_usb_nativeinstruments_boot_quirk(dev
);
1261 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1262 return snd_usb_fasttrackpro_boot_quirk(dev
);
1263 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1264 return snd_usb_gamecon780_boot_quirk(dev
);
1265 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1266 return snd_usb_axefx3_boot_quirk(dev
);
1267 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1268 return snd_usb_motu_microbookii_boot_quirk(dev
);
1275 * check if the device uses big-endian samples
1277 int snd_usb_is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
1279 /* it depends on altsetting whether the device is big-endian or not */
1280 switch (chip
->usb_id
) {
1281 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1282 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1283 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1286 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1287 if (chip
->setup
== 0x00 ||
1288 fp
->altsetting
== 1 || fp
->altsetting
== 2 ||
1289 fp
->altsetting
== 3)
1292 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1293 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1294 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1302 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1303 * not for interface.
1307 EMU_QUIRK_SR_44100HZ
= 0,
1308 EMU_QUIRK_SR_48000HZ
,
1309 EMU_QUIRK_SR_88200HZ
,
1310 EMU_QUIRK_SR_96000HZ
,
1311 EMU_QUIRK_SR_176400HZ
,
1312 EMU_QUIRK_SR_192000HZ
1315 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
1316 struct audioformat
*fmt
)
1318 unsigned char emu_samplerate_id
= 0;
1320 /* When capture is active
1321 * sample rate shouldn't be changed
1322 * by playback substream
1324 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1325 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
1329 switch (fmt
->rate_min
) {
1331 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
1334 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
1337 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
1340 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
1343 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
1346 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
1349 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
1350 subs
->pkt_offset_adj
= (emu_samplerate_id
>= EMU_QUIRK_SR_176400HZ
) ? 4 : 0;
1353 void snd_usb_set_format_quirk(struct snd_usb_substream
*subs
,
1354 struct audioformat
*fmt
)
1356 switch (subs
->stream
->chip
->usb_id
) {
1357 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1358 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1359 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1360 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1361 set_format_emu_quirk(subs
, fmt
);
1366 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio
*chip
)
1368 /* devices which do not support reading the sample rate. */
1369 switch (chip
->usb_id
) {
1370 case USB_ID(0x041E, 0x4080): /* Creative Live Cam VF0610 */
1371 case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */
1372 case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
1373 case USB_ID(0x05A3, 0x9420): /* ELP HD USB Camera */
1374 case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1375 case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
1376 case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
1377 case USB_ID(0x21B4, 0x0081): /* AudioQuest DragonFly */
1381 /* devices of these vendors don't support reading rate, either */
1382 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1383 case 0x045E: /* MS Lifecam */
1384 case 0x047F: /* Plantronics */
1385 case 0x1de7: /* Phoenix Audio */
1392 /* ITF-USB DSD based DACs need a vendor cmd to switch
1393 * between PCM and native DSD mode
1395 static bool is_itf_usb_dsd_dac(unsigned int id
)
1398 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1399 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1400 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1401 case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
1402 case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
1403 case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
1404 case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
1410 int snd_usb_select_mode_quirk(struct snd_usb_substream
*subs
,
1411 struct audioformat
*fmt
)
1413 struct usb_device
*dev
= subs
->dev
;
1416 if (is_itf_usb_dsd_dac(subs
->stream
->chip
->usb_id
)) {
1417 /* First switch to alt set 0, otherwise the mode switch cmd
1418 * will not be accepted by the DAC
1420 err
= usb_set_interface(dev
, fmt
->iface
, 0);
1424 msleep(20); /* Delay needed after setting the interface */
1426 /* Vendor mode switch cmd is required. */
1427 if (fmt
->formats
& SNDRV_PCM_FMTBIT_DSD_U32_BE
) {
1428 /* DSD mode (DSD_U32) requested */
1429 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0,
1430 USB_DIR_OUT
|USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
,
1436 /* PCM or DOP mode (S32) requested */
1437 /* PCM mode (S16) requested */
1438 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0,
1439 USB_DIR_OUT
|USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
,
1450 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint
*ep
)
1453 * "Playback Design" products send bogus feedback data at the start
1454 * of the stream. Ignore them.
1456 if (USB_ID_VENDOR(ep
->chip
->usb_id
) == 0x23ba &&
1457 ep
->type
== SND_USB_ENDPOINT_TYPE_SYNC
)
1458 ep
->skip_packets
= 4;
1461 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1462 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1463 * the stream is (re)started. When skipping packets 16 at endpoint
1464 * start up, the real world latency is stable within +/- 1 frame (also
1465 * across power cycles).
1467 if ((ep
->chip
->usb_id
== USB_ID(0x0763, 0x2030) ||
1468 ep
->chip
->usb_id
== USB_ID(0x0763, 0x2031)) &&
1469 ep
->type
== SND_USB_ENDPOINT_TYPE_DATA
)
1470 ep
->skip_packets
= 16;
1472 /* Work around devices that report unreasonable feedback data */
1473 if ((ep
->chip
->usb_id
== USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */
1474 ep
->chip
->usb_id
== USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1475 ep
->syncmaxsize
== 4)
1476 ep
->tenor_fb_quirk
= 1;
1479 void snd_usb_set_interface_quirk(struct usb_device
*dev
)
1481 struct snd_usb_audio
*chip
= dev_get_drvdata(&dev
->dev
);
1486 * "Playback Design" products need a 50ms delay after setting the
1489 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1490 case 0x23ba: /* Playback Design */
1491 case 0x0644: /* TEAC Corp. */
1497 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1498 void snd_usb_ctl_msg_quirk(struct usb_device
*dev
, unsigned int pipe
,
1499 __u8 request
, __u8 requesttype
, __u16 value
,
1500 __u16 index
, void *data
, __u16 size
)
1502 struct snd_usb_audio
*chip
= dev_get_drvdata(&dev
->dev
);
1507 * "Playback Design" products need a 20ms delay after each
1508 * class compliant request
1510 if (USB_ID_VENDOR(chip
->usb_id
) == 0x23ba &&
1511 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1515 * "TEAC Corp." products need a 20ms delay after each
1516 * class compliant request
1518 if (USB_ID_VENDOR(chip
->usb_id
) == 0x0644 &&
1519 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1522 /* ITF-USB DSD based DACs functionality need a delay
1523 * after each class compliant request
1525 if (is_itf_usb_dsd_dac(chip
->usb_id
)
1526 && (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1529 /* Zoom R16/24, Logitech H650e, Jabra 550a needs a tiny delay here,
1530 * otherwise requests like get/set frequency return as failed despite
1531 * actually succeeding.
1533 if ((chip
->usb_id
== USB_ID(0x1686, 0x00dd) ||
1534 chip
->usb_id
== USB_ID(0x046d, 0x0a46) ||
1535 chip
->usb_id
== USB_ID(0x0b0e, 0x0349)) &&
1536 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1537 usleep_range(1000, 2000);
1541 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1542 * augment the PCM format bit-field for DSD types. The UAC standards
1543 * don't have a designated bit field to denote DSD-capable interfaces,
1544 * hence all hardware that is known to support this format has to be
1547 u64
snd_usb_interface_dsd_format_quirks(struct snd_usb_audio
*chip
,
1548 struct audioformat
*fp
,
1549 unsigned int sample_bytes
)
1551 struct usb_interface
*iface
;
1553 /* Playback Designs */
1554 if (USB_ID_VENDOR(chip
->usb_id
) == 0x23ba) {
1555 switch (fp
->altsetting
) {
1558 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1560 fp
->dsd_bitrev
= true;
1561 return SNDRV_PCM_FMTBIT_DSD_U8
;
1563 fp
->dsd_bitrev
= true;
1564 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1568 /* XMOS based USB DACs */
1569 switch (chip
->usb_id
) {
1570 case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
1571 case USB_ID(0x22d9, 0x0416): /* OPPO HA-1 */
1572 case USB_ID(0x22d9, 0x0436): /* OPPO Sonica */
1573 case USB_ID(0x22d9, 0x0461): /* OPPO UDP-205 */
1574 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1575 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1576 if (fp
->altsetting
== 2)
1577 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1580 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1581 case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1582 case USB_ID(0x16b0, 0x06b2): /* NuPrime DAC-10 */
1583 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1584 case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1585 case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1586 case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
1587 case USB_ID(0x22d9, 0x0426): /* OPPO HA-2 */
1588 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1589 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1590 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1591 case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1592 case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1593 case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1594 case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1595 if (fp
->altsetting
== 3)
1596 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1599 /* Amanero Combo384 USB based DACs with native DSD support */
1600 case USB_ID(0x16d0, 0x071a): /* Amanero - Combo384 */
1601 case USB_ID(0x2ab6, 0x0004): /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1602 case USB_ID(0x2ab6, 0x0005): /* T+A USB HD Audio 1 */
1603 case USB_ID(0x2ab6, 0x0006): /* T+A USB HD Audio 2 */
1604 if (fp
->altsetting
== 2) {
1605 switch (le16_to_cpu(chip
->dev
->descriptor
.bcdDevice
)) {
1607 return SNDRV_PCM_FMTBIT_DSD_U32_LE
;
1610 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1616 case USB_ID(0x16d0, 0x0a23):
1617 if (fp
->altsetting
== 2)
1618 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1625 /* ITF-USB DSD based DACs */
1626 if (is_itf_usb_dsd_dac(chip
->usb_id
)) {
1627 iface
= usb_ifnum_to_if(chip
->dev
, fp
->iface
);
1629 /* Altsetting 2 support native DSD if the num of altsets is
1631 * Altsetting 3 support native DSD if the num of altsets is
1634 if (fp
->altsetting
== iface
->num_altsetting
- 1)
1635 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1638 /* Mostly generic method to detect many DSD-capable implementations -
1639 * from XMOS/Thesycon
1641 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1642 case 0x20b1: /* XMOS based devices */
1643 case 0x152a: /* Thesycon devices */
1644 case 0x25ce: /* Mytek devices */
1645 case 0x2ab6: /* T+A devices */
1647 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1657 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio
*chip
,
1658 struct audioformat
*fp
,
1661 switch (chip
->usb_id
) {
1662 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1663 /* Optoplay sets the sample rate attribute although
1664 * it seems not supporting it in fact.
1666 fp
->attributes
&= ~UAC_EP_CS_ATTR_SAMPLE_RATE
;
1668 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1669 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1670 /* doesn't set the sample rate attribute, but supports it */
1671 fp
->attributes
|= UAC_EP_CS_ATTR_SAMPLE_RATE
;
1673 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
1674 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1675 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1676 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1677 an older model 77d:223) */
1679 * plantronics headset and Griffin iMic have set adaptive-in
1680 * although it's really not...
1682 fp
->ep_attr
&= ~USB_ENDPOINT_SYNCTYPE
;
1683 if (stream
== SNDRV_PCM_STREAM_PLAYBACK
)
1684 fp
->ep_attr
|= USB_ENDPOINT_SYNC_ADAPTIVE
;
1686 fp
->ep_attr
|= USB_ENDPOINT_SYNC_SYNC
;