2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/usb.h>
20 #include <linux/usb/audio.h>
21 #include <linux/usb/midi.h>
23 #include <sound/control.h>
24 #include <sound/core.h>
25 #include <sound/info.h>
26 #include <sound/pcm.h>
31 #include "mixer_quirks.h"
41 * handle the quirks for the contained interfaces
43 static int create_composite_quirk(struct snd_usb_audio
*chip
,
44 struct usb_interface
*iface
,
45 struct usb_driver
*driver
,
46 const struct snd_usb_audio_quirk
*quirk_comp
)
48 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
49 const struct snd_usb_audio_quirk
*quirk
;
52 for (quirk
= quirk_comp
->data
; quirk
->ifnum
>= 0; ++quirk
) {
53 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
56 if (quirk
->ifnum
!= probed_ifnum
&&
57 usb_interface_claimed(iface
))
59 err
= snd_usb_create_quirk(chip
, iface
, driver
, quirk
);
64 for (quirk
= quirk_comp
->data
; quirk
->ifnum
>= 0; ++quirk
) {
65 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
68 if (quirk
->ifnum
!= probed_ifnum
&&
69 !usb_interface_claimed(iface
))
70 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
76 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
77 struct usb_interface
*iface
,
78 struct usb_driver
*driver
,
79 const struct snd_usb_audio_quirk
*quirk
)
86 * Allow alignment on audio sub-slot (channel samples) rather than
87 * on audio slots (audio frames)
89 static int create_align_transfer_quirk(struct snd_usb_audio
*chip
,
90 struct usb_interface
*iface
,
91 struct usb_driver
*driver
,
92 const struct snd_usb_audio_quirk
*quirk
)
95 return 1; /* Continue with creating streams and mixer */
98 static int create_any_midi_quirk(struct snd_usb_audio
*chip
,
99 struct usb_interface
*intf
,
100 struct usb_driver
*driver
,
101 const struct snd_usb_audio_quirk
*quirk
)
103 return snd_usbmidi_create(chip
->card
, intf
, &chip
->midi_list
, quirk
);
107 * create a stream for an interface with proper descriptors
109 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
110 struct usb_interface
*iface
,
111 struct usb_driver
*driver
,
112 const struct snd_usb_audio_quirk
*quirk
)
114 struct usb_host_interface
*alts
;
115 struct usb_interface_descriptor
*altsd
;
118 if (chip
->usb_id
== USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
119 chip
->tx_length_quirk
= 1;
121 alts
= &iface
->altsetting
[0];
122 altsd
= get_iface_desc(alts
);
123 err
= snd_usb_parse_audio_interface(chip
, altsd
->bInterfaceNumber
);
125 usb_audio_err(chip
, "cannot setup if %d: error %d\n",
126 altsd
->bInterfaceNumber
, err
);
129 /* reset the current interface */
130 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
135 * create a stream for an endpoint/altsetting without proper descriptors
137 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
138 struct usb_interface
*iface
,
139 struct usb_driver
*driver
,
140 const struct snd_usb_audio_quirk
*quirk
)
142 struct audioformat
*fp
;
143 struct usb_host_interface
*alts
;
144 struct usb_interface_descriptor
*altsd
;
146 unsigned *rate_table
= NULL
;
148 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
150 usb_audio_err(chip
, "cannot memdup\n");
153 if (fp
->nr_rates
> MAX_NR_RATES
) {
157 if (fp
->nr_rates
> 0) {
158 rate_table
= kmemdup(fp
->rate_table
,
159 sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
164 fp
->rate_table
= rate_table
;
167 stream
= (fp
->endpoint
& USB_DIR_IN
)
168 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
169 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
172 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
173 fp
->altset_idx
>= iface
->num_altsetting
) {
177 alts
= &iface
->altsetting
[fp
->altset_idx
];
178 altsd
= get_iface_desc(alts
);
179 if (altsd
->bNumEndpoints
< 1) {
184 fp
->protocol
= altsd
->bInterfaceProtocol
;
186 if (fp
->datainterval
== 0)
187 fp
->datainterval
= snd_usb_parse_datainterval(chip
, alts
);
188 if (fp
->maxpacksize
== 0)
189 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
190 usb_set_interface(chip
->dev
, fp
->iface
, 0);
191 snd_usb_init_pitch(chip
, fp
->iface
, alts
, fp
);
192 snd_usb_init_sample_rate(chip
, fp
->iface
, alts
, fp
, fp
->rate_max
);
201 static int create_auto_pcm_quirk(struct snd_usb_audio
*chip
,
202 struct usb_interface
*iface
,
203 struct usb_driver
*driver
)
205 struct usb_host_interface
*alts
;
206 struct usb_interface_descriptor
*altsd
;
207 struct usb_endpoint_descriptor
*epd
;
208 struct uac1_as_header_descriptor
*ashd
;
209 struct uac_format_type_i_discrete_descriptor
*fmtd
;
212 * Most Roland/Yamaha audio streaming interfaces have more or less
213 * standard descriptors, but older devices might lack descriptors, and
214 * future ones might change, so ensure that we fail silently if the
215 * interface doesn't look exactly right.
218 /* must have a non-zero altsetting for streaming */
219 if (iface
->num_altsetting
< 2)
221 alts
= &iface
->altsetting
[1];
222 altsd
= get_iface_desc(alts
);
224 /* must have an isochronous endpoint for streaming */
225 if (altsd
->bNumEndpoints
< 1)
227 epd
= get_endpoint(alts
, 0);
228 if (!usb_endpoint_xfer_isoc(epd
))
231 /* must have format descriptors */
232 ashd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
234 fmtd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
236 if (!ashd
|| ashd
->bLength
< 7 ||
237 !fmtd
|| fmtd
->bLength
< 8)
240 return create_standard_audio_quirk(chip
, iface
, driver
, NULL
);
243 static int create_yamaha_midi_quirk(struct snd_usb_audio
*chip
,
244 struct usb_interface
*iface
,
245 struct usb_driver
*driver
,
246 struct usb_host_interface
*alts
)
248 static const struct snd_usb_audio_quirk yamaha_midi_quirk
= {
249 .type
= QUIRK_MIDI_YAMAHA
251 struct usb_midi_in_jack_descriptor
*injd
;
252 struct usb_midi_out_jack_descriptor
*outjd
;
254 /* must have some valid jack descriptors */
255 injd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
256 NULL
, USB_MS_MIDI_IN_JACK
);
257 outjd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
258 NULL
, USB_MS_MIDI_OUT_JACK
);
261 if (injd
&& (injd
->bLength
< 5 ||
262 (injd
->bJackType
!= USB_MS_EMBEDDED
&&
263 injd
->bJackType
!= USB_MS_EXTERNAL
)))
265 if (outjd
&& (outjd
->bLength
< 6 ||
266 (outjd
->bJackType
!= USB_MS_EMBEDDED
&&
267 outjd
->bJackType
!= USB_MS_EXTERNAL
)))
269 return create_any_midi_quirk(chip
, iface
, driver
, &yamaha_midi_quirk
);
272 static int create_roland_midi_quirk(struct snd_usb_audio
*chip
,
273 struct usb_interface
*iface
,
274 struct usb_driver
*driver
,
275 struct usb_host_interface
*alts
)
277 static const struct snd_usb_audio_quirk roland_midi_quirk
= {
278 .type
= QUIRK_MIDI_ROLAND
280 u8
*roland_desc
= NULL
;
282 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
284 roland_desc
= snd_usb_find_csint_desc(alts
->extra
,
289 if (roland_desc
[0] < 6 || roland_desc
[3] != 2)
291 return create_any_midi_quirk(chip
, iface
, driver
,
296 static int create_std_midi_quirk(struct snd_usb_audio
*chip
,
297 struct usb_interface
*iface
,
298 struct usb_driver
*driver
,
299 struct usb_host_interface
*alts
)
301 struct usb_ms_header_descriptor
*mshd
;
302 struct usb_ms_endpoint_descriptor
*msepd
;
304 /* must have the MIDIStreaming interface header descriptor*/
305 mshd
= (struct usb_ms_header_descriptor
*)alts
->extra
;
306 if (alts
->extralen
< 7 ||
308 mshd
->bDescriptorType
!= USB_DT_CS_INTERFACE
||
309 mshd
->bDescriptorSubtype
!= USB_MS_HEADER
)
311 /* must have the MIDIStreaming endpoint descriptor*/
312 msepd
= (struct usb_ms_endpoint_descriptor
*)alts
->endpoint
[0].extra
;
313 if (alts
->endpoint
[0].extralen
< 4 ||
314 msepd
->bLength
< 4 ||
315 msepd
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
316 msepd
->bDescriptorSubtype
!= UAC_MS_GENERAL
||
317 msepd
->bNumEmbMIDIJack
< 1 ||
318 msepd
->bNumEmbMIDIJack
> 16)
321 return create_any_midi_quirk(chip
, iface
, driver
, NULL
);
324 static int create_auto_midi_quirk(struct snd_usb_audio
*chip
,
325 struct usb_interface
*iface
,
326 struct usb_driver
*driver
)
328 struct usb_host_interface
*alts
;
329 struct usb_interface_descriptor
*altsd
;
330 struct usb_endpoint_descriptor
*epd
;
333 alts
= &iface
->altsetting
[0];
334 altsd
= get_iface_desc(alts
);
336 /* must have at least one bulk/interrupt endpoint for streaming */
337 if (altsd
->bNumEndpoints
< 1)
339 epd
= get_endpoint(alts
, 0);
340 if (!usb_endpoint_xfer_bulk(epd
) &&
341 !usb_endpoint_xfer_int(epd
))
344 switch (USB_ID_VENDOR(chip
->usb_id
)) {
345 case 0x0499: /* Yamaha */
346 err
= create_yamaha_midi_quirk(chip
, iface
, driver
, alts
);
350 case 0x0582: /* Roland */
351 err
= create_roland_midi_quirk(chip
, iface
, driver
, alts
);
357 return create_std_midi_quirk(chip
, iface
, driver
, alts
);
360 static int create_autodetect_quirk(struct snd_usb_audio
*chip
,
361 struct usb_interface
*iface
,
362 struct usb_driver
*driver
)
366 err
= create_auto_pcm_quirk(chip
, iface
, driver
);
368 err
= create_auto_midi_quirk(chip
, iface
, driver
);
372 static int create_autodetect_quirks(struct snd_usb_audio
*chip
,
373 struct usb_interface
*iface
,
374 struct usb_driver
*driver
,
375 const struct snd_usb_audio_quirk
*quirk
)
377 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
378 int ifcount
, ifnum
, err
;
380 err
= create_autodetect_quirk(chip
, iface
, driver
);
385 * ALSA PCM playback/capture devices cannot be registered in two steps,
386 * so we have to claim the other corresponding interface here.
388 ifcount
= chip
->dev
->actconfig
->desc
.bNumInterfaces
;
389 for (ifnum
= 0; ifnum
< ifcount
; ifnum
++) {
390 if (ifnum
== probed_ifnum
|| quirk
->ifnum
>= 0)
392 iface
= usb_ifnum_to_if(chip
->dev
, ifnum
);
394 usb_interface_claimed(iface
) ||
395 get_iface_desc(iface
->altsetting
)->bInterfaceClass
!=
396 USB_CLASS_VENDOR_SPEC
)
399 err
= create_autodetect_quirk(chip
, iface
, driver
);
401 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
408 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
409 * The only way to detect the sample rate is by looking at wMaxPacketSize.
411 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
412 struct usb_interface
*iface
,
413 struct usb_driver
*driver
,
414 const struct snd_usb_audio_quirk
*quirk
)
416 static const struct audioformat ua_format
= {
417 .formats
= SNDRV_PCM_FMTBIT_S24_3LE
,
419 .fmt_type
= UAC_FORMAT_TYPE_I
,
422 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
424 struct usb_host_interface
*alts
;
425 struct usb_interface_descriptor
*altsd
;
426 struct audioformat
*fp
;
429 /* both PCM and MIDI interfaces have 2 or more altsettings */
430 if (iface
->num_altsetting
< 2)
432 alts
= &iface
->altsetting
[1];
433 altsd
= get_iface_desc(alts
);
435 if (altsd
->bNumEndpoints
== 2) {
436 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
437 .out_cables
= 0x0003,
440 static const struct snd_usb_audio_quirk ua700_quirk
= {
441 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
444 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
445 .out_cables
= 0x0001,
448 static const struct snd_usb_audio_quirk uaxx_quirk
= {
449 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
452 const struct snd_usb_audio_quirk
*quirk
=
453 chip
->usb_id
== USB_ID(0x0582, 0x002b)
454 ? &ua700_quirk
: &uaxx_quirk
;
455 return __snd_usbmidi_create(chip
->card
, iface
,
456 &chip
->midi_list
, quirk
,
460 if (altsd
->bNumEndpoints
!= 1)
463 fp
= kmemdup(&ua_format
, sizeof(*fp
), GFP_KERNEL
);
467 fp
->iface
= altsd
->bInterfaceNumber
;
468 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
469 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
470 fp
->datainterval
= 0;
471 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
473 switch (fp
->maxpacksize
) {
475 fp
->rate_max
= fp
->rate_min
= 44100;
479 fp
->rate_max
= fp
->rate_min
= 48000;
483 fp
->rate_max
= fp
->rate_min
= 96000;
486 usb_audio_err(chip
, "unknown sample rate\n");
491 stream
= (fp
->endpoint
& USB_DIR_IN
)
492 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
493 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
498 usb_set_interface(chip
->dev
, fp
->iface
, 0);
503 * Create a standard mixer for the specified interface.
505 static int create_standard_mixer_quirk(struct snd_usb_audio
*chip
,
506 struct usb_interface
*iface
,
507 struct usb_driver
*driver
,
508 const struct snd_usb_audio_quirk
*quirk
)
510 if (quirk
->ifnum
< 0)
513 return snd_usb_create_mixer(chip
, quirk
->ifnum
, 0);
517 * audio-interface quirks
519 * returns zero if no standard audio/MIDI parsing is needed.
520 * returns a positive value if standard audio/midi interfaces are parsed
522 * returns a negative value at error.
524 int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
525 struct usb_interface
*iface
,
526 struct usb_driver
*driver
,
527 const struct snd_usb_audio_quirk
*quirk
)
529 typedef int (*quirk_func_t
)(struct snd_usb_audio
*,
530 struct usb_interface
*,
532 const struct snd_usb_audio_quirk
*);
533 static const quirk_func_t quirk_funcs
[] = {
534 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
535 [QUIRK_COMPOSITE
] = create_composite_quirk
,
536 [QUIRK_AUTODETECT
] = create_autodetect_quirks
,
537 [QUIRK_MIDI_STANDARD_INTERFACE
] = create_any_midi_quirk
,
538 [QUIRK_MIDI_FIXED_ENDPOINT
] = create_any_midi_quirk
,
539 [QUIRK_MIDI_YAMAHA
] = create_any_midi_quirk
,
540 [QUIRK_MIDI_ROLAND
] = create_any_midi_quirk
,
541 [QUIRK_MIDI_MIDIMAN
] = create_any_midi_quirk
,
542 [QUIRK_MIDI_NOVATION
] = create_any_midi_quirk
,
543 [QUIRK_MIDI_RAW_BYTES
] = create_any_midi_quirk
,
544 [QUIRK_MIDI_EMAGIC
] = create_any_midi_quirk
,
545 [QUIRK_MIDI_CME
] = create_any_midi_quirk
,
546 [QUIRK_MIDI_AKAI
] = create_any_midi_quirk
,
547 [QUIRK_MIDI_FTDI
] = create_any_midi_quirk
,
548 [QUIRK_MIDI_CH345
] = create_any_midi_quirk
,
549 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
550 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
551 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
,
552 [QUIRK_AUDIO_ALIGN_TRANSFER
] = create_align_transfer_quirk
,
553 [QUIRK_AUDIO_STANDARD_MIXER
] = create_standard_mixer_quirk
,
556 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
557 return quirk_funcs
[quirk
->type
](chip
, iface
, driver
, quirk
);
559 usb_audio_err(chip
, "invalid quirk type %d\n", quirk
->type
);
568 #define EXTIGY_FIRMWARE_SIZE_OLD 794
569 #define EXTIGY_FIRMWARE_SIZE_NEW 483
571 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
573 struct usb_host_config
*config
= dev
->actconfig
;
576 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
577 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
578 dev_dbg(&dev
->dev
, "sending Extigy boot sequence...\n");
579 /* Send message to force it to reconnect with full interface. */
580 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
581 0x10, 0x43, 0x0001, 0x000a, NULL
, 0);
583 dev_dbg(&dev
->dev
, "error sending boot message: %d\n", err
);
584 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
585 &dev
->descriptor
, sizeof(dev
->descriptor
));
586 config
= dev
->actconfig
;
588 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
589 err
= usb_reset_configuration(dev
);
591 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
592 dev_dbg(&dev
->dev
, "extigy_boot: new boot length = %d\n",
593 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
594 return -ENODEV
; /* quit this anyway */
599 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
603 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
604 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
607 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
608 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
615 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device
*dev
)
619 if (dev
->actconfig
->desc
.bConfigurationValue
== 1) {
621 "Fast Track Pro switching to config #2\n");
622 /* This function has to be available by the usb core module.
623 * if it is not avialable the boot quirk has to be left out
624 * and the configuration has to be set by udev or hotplug
627 err
= usb_driver_set_configuration(dev
, 2);
630 "error usb_driver_set_configuration: %d\n",
632 /* Always return an error, so that we stop creating a device
633 that will just be destroyed and recreated with a new
637 dev_info(&dev
->dev
, "Fast Track Pro config OK\n");
643 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
644 * documented in the device's data sheet.
646 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
650 buf
[1] = value
& 0xff;
651 buf
[2] = (value
>> 8) & 0xff;
653 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
654 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
658 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
661 * Enable line-out driver mode, set headphone source to front
662 * channels, enable stereo mic.
664 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
668 * C-Media CM6206 is based on CM106 with two additional
669 * registers that are not documented in the data sheet.
670 * Values here are chosen based on sniffing USB traffic
673 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
676 int val
[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
678 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
679 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
687 /* quirk for Plantronics GameCom 780 with CM6302 chip */
688 static int snd_usb_gamecon780_boot_quirk(struct usb_device
*dev
)
690 /* set the initial volume and don't change; other values are either
691 * too loud or silent due to firmware bug (bko#65251)
693 u8 buf
[2] = { 0x74, 0xe3 };
694 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
695 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
696 UAC_FU_VOLUME
<< 8, 9 << 8, buf
, 2);
700 * Novation Twitch DJ controller
701 * Focusrite Novation Saffire 6 USB audio card
703 static int snd_usb_novation_boot_quirk(struct usb_device
*dev
)
705 /* preemptively set up the device because otherwise the
706 * raw MIDI endpoints are not active */
707 usb_set_interface(dev
, 0, 1);
712 * This call will put the synth in "USB send" mode, i.e it will send MIDI
713 * messages through USB (this is disabled at startup). The synth will
714 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
715 * sign on its LCD. Values here are chosen based on sniffing USB traffic
718 static int snd_usb_accessmusic_boot_quirk(struct usb_device
*dev
)
720 int err
, actual_length
;
722 /* "midi send" enable */
723 static const u8 seq
[] = { 0x4e, 0x73, 0x52, 0x01 };
725 void *buf
= kmemdup(seq
, ARRAY_SIZE(seq
), GFP_KERNEL
);
728 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x05), buf
,
729 ARRAY_SIZE(seq
), &actual_length
, 1000);
738 * Some sound cards from Native Instruments are in fact compliant to the USB
739 * audio standard of version 2 and other approved USB standards, even though
740 * they come up as vendor-specific device when first connected.
742 * However, they can be told to come up with a new set of descriptors
743 * upon their next enumeration, and the interfaces announced by the new
744 * descriptors will then be handled by the kernel's class drivers. As the
745 * product ID will also change, no further checks are required.
748 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device
*dev
)
750 int ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
751 0xaf, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
752 1, 0, NULL
, 0, 1000);
757 usb_reset_device(dev
);
759 /* return -EAGAIN, so the creation of an audio interface for this
760 * temporary device is aborted. The device will reconnect with a
765 static void mbox2_setup_48_24_magic(struct usb_device
*dev
)
770 /* Choose 48000Hz permanently */
775 /* Send the magic! */
776 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
777 0x01, 0x22, 0x0100, 0x0085, &temp
, 0x0003);
778 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
779 0x81, 0xa2, 0x0100, 0x0085, &srate
, 0x0003);
780 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
781 0x81, 0xa2, 0x0100, 0x0086, &srate
, 0x0003);
782 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
783 0x81, 0xa2, 0x0100, 0x0003, &srate
, 0x0003);
787 /* Digidesign Mbox 2 needs to load firmware onboard
788 * and driver must wait a few seconds for initialisation.
791 #define MBOX2_FIRMWARE_SIZE 646
792 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
793 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
795 static int snd_usb_mbox2_boot_quirk(struct usb_device
*dev
)
797 struct usb_host_config
*config
= dev
->actconfig
;
799 u8 bootresponse
[0x12];
803 fwsize
= le16_to_cpu(get_cfg_desc(config
)->wTotalLength
);
805 if (fwsize
!= MBOX2_FIRMWARE_SIZE
) {
806 dev_err(&dev
->dev
, "Invalid firmware size=%d.\n", fwsize
);
810 dev_dbg(&dev
->dev
, "Sending Digidesign Mbox 2 boot sequence...\n");
813 bootresponse
[0] = MBOX2_BOOT_LOADING
;
814 while ((bootresponse
[0] == MBOX2_BOOT_LOADING
) && (count
< 10)) {
815 msleep(500); /* 0.5 second delay */
816 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
817 /* Control magic - load onboard firmware */
818 0x85, 0xc0, 0x0001, 0x0000, &bootresponse
, 0x0012);
819 if (bootresponse
[0] == MBOX2_BOOT_READY
)
821 dev_dbg(&dev
->dev
, "device not ready, resending boot sequence...\n");
825 if (bootresponse
[0] != MBOX2_BOOT_READY
) {
826 dev_err(&dev
->dev
, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse
[0]);
830 dev_dbg(&dev
->dev
, "device initialised!\n");
832 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
833 &dev
->descriptor
, sizeof(dev
->descriptor
));
834 config
= dev
->actconfig
;
836 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
838 err
= usb_reset_configuration(dev
);
840 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
841 dev_dbg(&dev
->dev
, "mbox2_boot: new boot length = %d\n",
842 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
844 mbox2_setup_48_24_magic(dev
);
846 dev_info(&dev
->dev
, "Digidesign Mbox 2: 24bit 48kHz");
848 return 0; /* Successful boot */
854 #define MAUDIO_SET 0x01 /* parse device_setup */
855 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
856 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
857 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
858 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
859 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
860 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
861 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
862 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
863 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
864 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
866 static int quattro_skip_setting_quirk(struct snd_usb_audio
*chip
,
867 int iface
, int altno
)
869 /* Reset ALL ifaces to 0 altsetting.
870 * Call it for every possible altsetting of every interface.
872 usb_set_interface(chip
->dev
, iface
, 0);
873 if (chip
->setup
& MAUDIO_SET
) {
874 if (chip
->setup
& MAUDIO_SET_COMPATIBLE
) {
875 if (iface
!= 1 && iface
!= 2)
876 return 1; /* skip all interfaces but 1 and 2 */
879 if (iface
== 1 || iface
== 2)
880 return 1; /* skip interfaces 1 and 2 */
881 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
882 return 1; /* skip this altsetting */
883 mask
= chip
->setup
& MAUDIO_SET_MASK
;
884 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
885 return 1; /* skip this altsetting */
886 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
887 return 1; /* skip this altsetting */
888 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 4)
889 return 1; /* skip this altsetting */
893 "using altsetting %d for interface %d config %d\n",
894 altno
, iface
, chip
->setup
);
895 return 0; /* keep this altsetting */
898 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
902 /* Reset ALL ifaces to 0 altsetting.
903 * Call it for every possible altsetting of every interface.
905 usb_set_interface(chip
->dev
, iface
, 0);
907 if (chip
->setup
& MAUDIO_SET
) {
909 if ((chip
->setup
& MAUDIO_SET_DTS
) && altno
!= 6)
910 return 1; /* skip this altsetting */
911 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
912 return 1; /* skip this altsetting */
913 mask
= chip
->setup
& MAUDIO_SET_MASK
;
914 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
915 return 1; /* skip this altsetting */
916 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
917 return 1; /* skip this altsetting */
918 if (mask
== MAUDIO_SET_16B_48K_DI
&& altno
!= 4)
919 return 1; /* skip this altsetting */
920 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 5)
921 return 1; /* skip this altsetting */
924 return 0; /* keep this altsetting */
927 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio
*chip
,
928 int iface
, int altno
)
930 /* Reset ALL ifaces to 0 altsetting.
931 * Call it for every possible altsetting of every interface.
933 usb_set_interface(chip
->dev
, iface
, 0);
935 /* possible configuration where both inputs and only one output is
936 *used is not supported by the current setup
938 if (chip
->setup
& (MAUDIO_SET
| MAUDIO_SET_24B
)) {
939 if (chip
->setup
& MAUDIO_SET_96K
) {
940 if (altno
!= 3 && altno
!= 6)
942 } else if (chip
->setup
& MAUDIO_SET_DI
) {
944 return 1; /* no analog input */
945 if (altno
!= 2 && altno
!= 5)
946 return 1; /* enable only altsets 2 and 5 */
949 return 1; /* disable digialt input */
950 if (altno
!= 2 && altno
!= 5)
951 return 1; /* enalbe only altsets 2 and 5 */
954 /* keep only 16-Bit mode */
960 "using altsetting %d for interface %d config %d\n",
961 altno
, iface
, chip
->setup
);
962 return 0; /* keep this altsetting */
965 int snd_usb_apply_interface_quirk(struct snd_usb_audio
*chip
,
969 /* audiophile usb: skip altsets incompatible with device_setup */
970 if (chip
->usb_id
== USB_ID(0x0763, 0x2003))
971 return audiophile_skip_setting_quirk(chip
, iface
, altno
);
972 /* quattro usb: skip altsets incompatible with device_setup */
973 if (chip
->usb_id
== USB_ID(0x0763, 0x2001))
974 return quattro_skip_setting_quirk(chip
, iface
, altno
);
975 /* fasttrackpro usb: skip altsets incompatible with device_setup */
976 if (chip
->usb_id
== USB_ID(0x0763, 0x2012))
977 return fasttrackpro_skip_setting_quirk(chip
, iface
, altno
);
982 int snd_usb_apply_boot_quirk(struct usb_device
*dev
,
983 struct usb_interface
*intf
,
984 const struct snd_usb_audio_quirk
*quirk
,
988 case USB_ID(0x041e, 0x3000):
989 /* SB Extigy needs special boot-up sequence */
990 /* if more models come, this will go to the quirk list. */
991 return snd_usb_extigy_boot_quirk(dev
, intf
);
993 case USB_ID(0x041e, 0x3020):
994 /* SB Audigy 2 NX needs its own boot-up magic, too */
995 return snd_usb_audigy2nx_boot_quirk(dev
);
997 case USB_ID(0x10f5, 0x0200):
998 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
999 return snd_usb_cm106_boot_quirk(dev
);
1001 case USB_ID(0x0d8c, 0x0102):
1002 /* C-Media CM6206 / CM106-Like Sound Device */
1003 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1004 return snd_usb_cm6206_boot_quirk(dev
);
1006 case USB_ID(0x0dba, 0x3000):
1007 /* Digidesign Mbox 2 */
1008 return snd_usb_mbox2_boot_quirk(dev
);
1010 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1011 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1012 return snd_usb_novation_boot_quirk(dev
);
1014 case USB_ID(0x133e, 0x0815):
1015 /* Access Music VirusTI Desktop */
1016 return snd_usb_accessmusic_boot_quirk(dev
);
1018 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1019 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1020 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1021 return snd_usb_nativeinstruments_boot_quirk(dev
);
1022 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1023 return snd_usb_fasttrackpro_boot_quirk(dev
);
1024 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1025 return snd_usb_gamecon780_boot_quirk(dev
);
1032 * check if the device uses big-endian samples
1034 int snd_usb_is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
1036 /* it depends on altsetting whether the device is big-endian or not */
1037 switch (chip
->usb_id
) {
1038 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1039 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1040 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1043 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1044 if (chip
->setup
== 0x00 ||
1045 fp
->altsetting
== 1 || fp
->altsetting
== 2 ||
1046 fp
->altsetting
== 3)
1049 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1050 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1051 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1059 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1060 * not for interface.
1064 EMU_QUIRK_SR_44100HZ
= 0,
1065 EMU_QUIRK_SR_48000HZ
,
1066 EMU_QUIRK_SR_88200HZ
,
1067 EMU_QUIRK_SR_96000HZ
,
1068 EMU_QUIRK_SR_176400HZ
,
1069 EMU_QUIRK_SR_192000HZ
1072 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
1073 struct audioformat
*fmt
)
1075 unsigned char emu_samplerate_id
= 0;
1077 /* When capture is active
1078 * sample rate shouldn't be changed
1079 * by playback substream
1081 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1082 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
1086 switch (fmt
->rate_min
) {
1088 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
1091 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
1094 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
1097 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
1100 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
1103 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
1106 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
1107 subs
->pkt_offset_adj
= (emu_samplerate_id
>= EMU_QUIRK_SR_176400HZ
) ? 4 : 0;
1110 void snd_usb_set_format_quirk(struct snd_usb_substream
*subs
,
1111 struct audioformat
*fmt
)
1113 switch (subs
->stream
->chip
->usb_id
) {
1114 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1115 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1116 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1117 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1118 set_format_emu_quirk(subs
, fmt
);
1123 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio
*chip
)
1125 /* devices which do not support reading the sample rate. */
1126 switch (chip
->usb_id
) {
1127 case USB_ID(0x045E, 0x075D): /* MS Lifecam Cinema */
1128 case USB_ID(0x045E, 0x076D): /* MS Lifecam HD-5000 */
1129 case USB_ID(0x045E, 0x076F): /* MS Lifecam HD-6000 */
1130 case USB_ID(0x045E, 0x0772): /* MS Lifecam Studio */
1131 case USB_ID(0x045E, 0x0779): /* MS Lifecam HD-3000 */
1132 case USB_ID(0x047F, 0xAA05): /* Plantronics DA45 */
1133 case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */
1134 case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1135 case USB_ID(0x21B4, 0x0081): /* AudioQuest DragonFly */
1141 /* Marantz/Denon USB DACs need a vendor cmd to switch
1142 * between PCM and native DSD mode
1144 static bool is_marantz_denon_dac(unsigned int id
)
1147 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1148 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1149 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1155 int snd_usb_select_mode_quirk(struct snd_usb_substream
*subs
,
1156 struct audioformat
*fmt
)
1158 struct usb_device
*dev
= subs
->dev
;
1161 if (is_marantz_denon_dac(subs
->stream
->chip
->usb_id
)) {
1162 /* First switch to alt set 0, otherwise the mode switch cmd
1163 * will not be accepted by the DAC
1165 err
= usb_set_interface(dev
, fmt
->iface
, 0);
1169 mdelay(20); /* Delay needed after setting the interface */
1171 switch (fmt
->altsetting
) {
1172 case 2: /* DSD mode requested */
1173 case 1: /* PCM mode requested */
1174 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0,
1175 USB_DIR_OUT
|USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
,
1176 fmt
->altsetting
- 1, 1, NULL
, 0);
1186 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint
*ep
)
1189 * "Playback Design" products send bogus feedback data at the start
1190 * of the stream. Ignore them.
1192 if (USB_ID_VENDOR(ep
->chip
->usb_id
) == 0x23ba &&
1193 ep
->type
== SND_USB_ENDPOINT_TYPE_SYNC
)
1194 ep
->skip_packets
= 4;
1197 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1198 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1199 * the stream is (re)started. When skipping packets 16 at endpoint
1200 * start up, the real world latency is stable within +/- 1 frame (also
1201 * across power cycles).
1203 if ((ep
->chip
->usb_id
== USB_ID(0x0763, 0x2030) ||
1204 ep
->chip
->usb_id
== USB_ID(0x0763, 0x2031)) &&
1205 ep
->type
== SND_USB_ENDPOINT_TYPE_DATA
)
1206 ep
->skip_packets
= 16;
1209 void snd_usb_set_interface_quirk(struct usb_device
*dev
)
1211 struct snd_usb_audio
*chip
= dev_get_drvdata(&dev
->dev
);
1216 * "Playback Design" products need a 50ms delay after setting the
1219 switch (USB_ID_VENDOR(chip
->usb_id
)) {
1220 case 0x23ba: /* Playback Design */
1221 case 0x0644: /* TEAC Corp. */
1227 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1228 void snd_usb_ctl_msg_quirk(struct usb_device
*dev
, unsigned int pipe
,
1229 __u8 request
, __u8 requesttype
, __u16 value
,
1230 __u16 index
, void *data
, __u16 size
)
1232 struct snd_usb_audio
*chip
= dev_get_drvdata(&dev
->dev
);
1237 * "Playback Design" products need a 20ms delay after each
1238 * class compliant request
1240 if (USB_ID_VENDOR(chip
->usb_id
) == 0x23ba &&
1241 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1245 * "TEAC Corp." products need a 20ms delay after each
1246 * class compliant request
1248 if (USB_ID_VENDOR(chip
->usb_id
) == 0x0644 &&
1249 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1252 /* Marantz/Denon devices with USB DAC functionality need a delay
1253 * after each class compliant request
1255 if (is_marantz_denon_dac(chip
->usb_id
)
1256 && (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1259 /* Zoom R16/24 needs a tiny delay here, otherwise requests like
1260 * get/set frequency return as failed despite actually succeeding.
1262 if (chip
->usb_id
== USB_ID(0x1686, 0x00dd) &&
1263 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1268 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1269 * augment the PCM format bit-field for DSD types. The UAC standards
1270 * don't have a designated bit field to denote DSD-capable interfaces,
1271 * hence all hardware that is known to support this format has to be
1274 u64
snd_usb_interface_dsd_format_quirks(struct snd_usb_audio
*chip
,
1275 struct audioformat
*fp
,
1276 unsigned int sample_bytes
)
1278 /* Playback Designs */
1279 if (USB_ID_VENDOR(chip
->usb_id
) == 0x23ba) {
1280 switch (fp
->altsetting
) {
1283 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1285 fp
->dsd_bitrev
= true;
1286 return SNDRV_PCM_FMTBIT_DSD_U8
;
1288 fp
->dsd_bitrev
= true;
1289 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1293 /* XMOS based USB DACs */
1294 switch (chip
->usb_id
) {
1295 case USB_ID(0x20b1, 0x3008): /* iFi Audio micro/nano iDSD */
1296 case USB_ID(0x20b1, 0x2008): /* Matrix Audio X-Sabre */
1297 case USB_ID(0x20b1, 0x300a): /* Matrix Audio Mini-i Pro */
1298 case USB_ID(0x22d9, 0x0416): /* OPPO HA-1 */
1299 if (fp
->altsetting
== 2)
1300 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1303 case USB_ID(0x20b1, 0x000a): /* Gustard DAC-X20U */
1304 case USB_ID(0x20b1, 0x2009): /* DIYINHK DSD DXD 384kHz USB to I2S/DSD */
1305 case USB_ID(0x20b1, 0x2023): /* JLsounds I2SoverUSB */
1306 case USB_ID(0x20b1, 0x3023): /* Aune X1S 32BIT/384 DSD DAC */
1307 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1308 if (fp
->altsetting
== 3)
1309 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1315 /* Denon/Marantz devices with USB DAC functionality */
1316 if (is_marantz_denon_dac(chip
->usb_id
)) {
1317 if (fp
->altsetting
== 2)
1318 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;