2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/usb.h>
20 #include <linux/usb/audio.h>
21 #include <linux/usb/midi.h>
23 #include <sound/control.h>
24 #include <sound/core.h>
25 #include <sound/info.h>
26 #include <sound/pcm.h>
31 #include "mixer_quirks.h"
41 * handle the quirks for the contained interfaces
43 static int create_composite_quirk(struct snd_usb_audio
*chip
,
44 struct usb_interface
*iface
,
45 struct usb_driver
*driver
,
46 const struct snd_usb_audio_quirk
*quirk_comp
)
48 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
49 const struct snd_usb_audio_quirk
*quirk
;
52 for (quirk
= quirk_comp
->data
; quirk
->ifnum
>= 0; ++quirk
) {
53 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
56 if (quirk
->ifnum
!= probed_ifnum
&&
57 usb_interface_claimed(iface
))
59 err
= snd_usb_create_quirk(chip
, iface
, driver
, quirk
);
64 for (quirk
= quirk_comp
->data
; quirk
->ifnum
>= 0; ++quirk
) {
65 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
68 if (quirk
->ifnum
!= probed_ifnum
&&
69 !usb_interface_claimed(iface
))
70 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
76 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
77 struct usb_interface
*iface
,
78 struct usb_driver
*driver
,
79 const struct snd_usb_audio_quirk
*quirk
)
86 * Allow alignment on audio sub-slot (channel samples) rather than
87 * on audio slots (audio frames)
89 static int create_align_transfer_quirk(struct snd_usb_audio
*chip
,
90 struct usb_interface
*iface
,
91 struct usb_driver
*driver
,
92 const struct snd_usb_audio_quirk
*quirk
)
95 return 1; /* Continue with creating streams and mixer */
98 static int create_any_midi_quirk(struct snd_usb_audio
*chip
,
99 struct usb_interface
*intf
,
100 struct usb_driver
*driver
,
101 const struct snd_usb_audio_quirk
*quirk
)
103 return snd_usbmidi_create(chip
->card
, intf
, &chip
->midi_list
, quirk
);
107 * create a stream for an interface with proper descriptors
109 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
110 struct usb_interface
*iface
,
111 struct usb_driver
*driver
,
112 const struct snd_usb_audio_quirk
*quirk
)
114 struct usb_host_interface
*alts
;
115 struct usb_interface_descriptor
*altsd
;
118 if (chip
->usb_id
== USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
119 chip
->tx_length_quirk
= 1;
121 alts
= &iface
->altsetting
[0];
122 altsd
= get_iface_desc(alts
);
123 err
= snd_usb_parse_audio_interface(chip
, altsd
->bInterfaceNumber
);
125 usb_audio_err(chip
, "cannot setup if %d: error %d\n",
126 altsd
->bInterfaceNumber
, err
);
129 /* reset the current interface */
130 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
135 * create a stream for an endpoint/altsetting without proper descriptors
137 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
138 struct usb_interface
*iface
,
139 struct usb_driver
*driver
,
140 const struct snd_usb_audio_quirk
*quirk
)
142 struct audioformat
*fp
;
143 struct usb_host_interface
*alts
;
144 struct usb_interface_descriptor
*altsd
;
146 unsigned *rate_table
= NULL
;
148 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
150 usb_audio_err(chip
, "cannot memdup\n");
153 if (fp
->nr_rates
> MAX_NR_RATES
) {
157 if (fp
->nr_rates
> 0) {
158 rate_table
= kmemdup(fp
->rate_table
,
159 sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
164 fp
->rate_table
= rate_table
;
167 stream
= (fp
->endpoint
& USB_DIR_IN
)
168 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
169 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
175 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
176 fp
->altset_idx
>= iface
->num_altsetting
) {
181 alts
= &iface
->altsetting
[fp
->altset_idx
];
182 altsd
= get_iface_desc(alts
);
183 fp
->protocol
= altsd
->bInterfaceProtocol
;
185 if (fp
->datainterval
== 0)
186 fp
->datainterval
= snd_usb_parse_datainterval(chip
, alts
);
187 if (fp
->maxpacksize
== 0)
188 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
189 usb_set_interface(chip
->dev
, fp
->iface
, 0);
190 snd_usb_init_pitch(chip
, fp
->iface
, alts
, fp
);
191 snd_usb_init_sample_rate(chip
, fp
->iface
, alts
, fp
, fp
->rate_max
);
195 static int create_auto_pcm_quirk(struct snd_usb_audio
*chip
,
196 struct usb_interface
*iface
,
197 struct usb_driver
*driver
)
199 struct usb_host_interface
*alts
;
200 struct usb_interface_descriptor
*altsd
;
201 struct usb_endpoint_descriptor
*epd
;
202 struct uac1_as_header_descriptor
*ashd
;
203 struct uac_format_type_i_discrete_descriptor
*fmtd
;
206 * Most Roland/Yamaha audio streaming interfaces have more or less
207 * standard descriptors, but older devices might lack descriptors, and
208 * future ones might change, so ensure that we fail silently if the
209 * interface doesn't look exactly right.
212 /* must have a non-zero altsetting for streaming */
213 if (iface
->num_altsetting
< 2)
215 alts
= &iface
->altsetting
[1];
216 altsd
= get_iface_desc(alts
);
218 /* must have an isochronous endpoint for streaming */
219 if (altsd
->bNumEndpoints
< 1)
221 epd
= get_endpoint(alts
, 0);
222 if (!usb_endpoint_xfer_isoc(epd
))
225 /* must have format descriptors */
226 ashd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
228 fmtd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
230 if (!ashd
|| ashd
->bLength
< 7 ||
231 !fmtd
|| fmtd
->bLength
< 8)
234 return create_standard_audio_quirk(chip
, iface
, driver
, NULL
);
237 static int create_yamaha_midi_quirk(struct snd_usb_audio
*chip
,
238 struct usb_interface
*iface
,
239 struct usb_driver
*driver
,
240 struct usb_host_interface
*alts
)
242 static const struct snd_usb_audio_quirk yamaha_midi_quirk
= {
243 .type
= QUIRK_MIDI_YAMAHA
245 struct usb_midi_in_jack_descriptor
*injd
;
246 struct usb_midi_out_jack_descriptor
*outjd
;
248 /* must have some valid jack descriptors */
249 injd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
250 NULL
, USB_MS_MIDI_IN_JACK
);
251 outjd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
252 NULL
, USB_MS_MIDI_OUT_JACK
);
255 if (injd
&& (injd
->bLength
< 5 ||
256 (injd
->bJackType
!= USB_MS_EMBEDDED
&&
257 injd
->bJackType
!= USB_MS_EXTERNAL
)))
259 if (outjd
&& (outjd
->bLength
< 6 ||
260 (outjd
->bJackType
!= USB_MS_EMBEDDED
&&
261 outjd
->bJackType
!= USB_MS_EXTERNAL
)))
263 return create_any_midi_quirk(chip
, iface
, driver
, &yamaha_midi_quirk
);
266 static int create_roland_midi_quirk(struct snd_usb_audio
*chip
,
267 struct usb_interface
*iface
,
268 struct usb_driver
*driver
,
269 struct usb_host_interface
*alts
)
271 static const struct snd_usb_audio_quirk roland_midi_quirk
= {
272 .type
= QUIRK_MIDI_ROLAND
274 u8
*roland_desc
= NULL
;
276 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
278 roland_desc
= snd_usb_find_csint_desc(alts
->extra
,
283 if (roland_desc
[0] < 6 || roland_desc
[3] != 2)
285 return create_any_midi_quirk(chip
, iface
, driver
,
290 static int create_std_midi_quirk(struct snd_usb_audio
*chip
,
291 struct usb_interface
*iface
,
292 struct usb_driver
*driver
,
293 struct usb_host_interface
*alts
)
295 struct usb_ms_header_descriptor
*mshd
;
296 struct usb_ms_endpoint_descriptor
*msepd
;
298 /* must have the MIDIStreaming interface header descriptor*/
299 mshd
= (struct usb_ms_header_descriptor
*)alts
->extra
;
300 if (alts
->extralen
< 7 ||
302 mshd
->bDescriptorType
!= USB_DT_CS_INTERFACE
||
303 mshd
->bDescriptorSubtype
!= USB_MS_HEADER
)
305 /* must have the MIDIStreaming endpoint descriptor*/
306 msepd
= (struct usb_ms_endpoint_descriptor
*)alts
->endpoint
[0].extra
;
307 if (alts
->endpoint
[0].extralen
< 4 ||
308 msepd
->bLength
< 4 ||
309 msepd
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
310 msepd
->bDescriptorSubtype
!= UAC_MS_GENERAL
||
311 msepd
->bNumEmbMIDIJack
< 1 ||
312 msepd
->bNumEmbMIDIJack
> 16)
315 return create_any_midi_quirk(chip
, iface
, driver
, NULL
);
318 static int create_auto_midi_quirk(struct snd_usb_audio
*chip
,
319 struct usb_interface
*iface
,
320 struct usb_driver
*driver
)
322 struct usb_host_interface
*alts
;
323 struct usb_interface_descriptor
*altsd
;
324 struct usb_endpoint_descriptor
*epd
;
327 alts
= &iface
->altsetting
[0];
328 altsd
= get_iface_desc(alts
);
330 /* must have at least one bulk/interrupt endpoint for streaming */
331 if (altsd
->bNumEndpoints
< 1)
333 epd
= get_endpoint(alts
, 0);
334 if (!usb_endpoint_xfer_bulk(epd
) &&
335 !usb_endpoint_xfer_int(epd
))
338 switch (USB_ID_VENDOR(chip
->usb_id
)) {
339 case 0x0499: /* Yamaha */
340 err
= create_yamaha_midi_quirk(chip
, iface
, driver
, alts
);
344 case 0x0582: /* Roland */
345 err
= create_roland_midi_quirk(chip
, iface
, driver
, alts
);
351 return create_std_midi_quirk(chip
, iface
, driver
, alts
);
354 static int create_autodetect_quirk(struct snd_usb_audio
*chip
,
355 struct usb_interface
*iface
,
356 struct usb_driver
*driver
)
360 err
= create_auto_pcm_quirk(chip
, iface
, driver
);
362 err
= create_auto_midi_quirk(chip
, iface
, driver
);
366 static int create_autodetect_quirks(struct snd_usb_audio
*chip
,
367 struct usb_interface
*iface
,
368 struct usb_driver
*driver
,
369 const struct snd_usb_audio_quirk
*quirk
)
371 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
372 int ifcount
, ifnum
, err
;
374 err
= create_autodetect_quirk(chip
, iface
, driver
);
379 * ALSA PCM playback/capture devices cannot be registered in two steps,
380 * so we have to claim the other corresponding interface here.
382 ifcount
= chip
->dev
->actconfig
->desc
.bNumInterfaces
;
383 for (ifnum
= 0; ifnum
< ifcount
; ifnum
++) {
384 if (ifnum
== probed_ifnum
|| quirk
->ifnum
>= 0)
386 iface
= usb_ifnum_to_if(chip
->dev
, ifnum
);
388 usb_interface_claimed(iface
) ||
389 get_iface_desc(iface
->altsetting
)->bInterfaceClass
!=
390 USB_CLASS_VENDOR_SPEC
)
393 err
= create_autodetect_quirk(chip
, iface
, driver
);
395 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
402 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
403 * The only way to detect the sample rate is by looking at wMaxPacketSize.
405 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
406 struct usb_interface
*iface
,
407 struct usb_driver
*driver
,
408 const struct snd_usb_audio_quirk
*quirk
)
410 static const struct audioformat ua_format
= {
411 .formats
= SNDRV_PCM_FMTBIT_S24_3LE
,
413 .fmt_type
= UAC_FORMAT_TYPE_I
,
416 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
418 struct usb_host_interface
*alts
;
419 struct usb_interface_descriptor
*altsd
;
420 struct audioformat
*fp
;
423 /* both PCM and MIDI interfaces have 2 or more altsettings */
424 if (iface
->num_altsetting
< 2)
426 alts
= &iface
->altsetting
[1];
427 altsd
= get_iface_desc(alts
);
429 if (altsd
->bNumEndpoints
== 2) {
430 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
431 .out_cables
= 0x0003,
434 static const struct snd_usb_audio_quirk ua700_quirk
= {
435 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
438 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
439 .out_cables
= 0x0001,
442 static const struct snd_usb_audio_quirk uaxx_quirk
= {
443 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
446 const struct snd_usb_audio_quirk
*quirk
=
447 chip
->usb_id
== USB_ID(0x0582, 0x002b)
448 ? &ua700_quirk
: &uaxx_quirk
;
449 return snd_usbmidi_create(chip
->card
, iface
,
450 &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
);
466 switch (fp
->maxpacksize
) {
468 fp
->rate_max
= fp
->rate_min
= 44100;
472 fp
->rate_max
= fp
->rate_min
= 48000;
476 fp
->rate_max
= fp
->rate_min
= 96000;
479 usb_audio_err(chip
, "unknown sample rate\n");
484 stream
= (fp
->endpoint
& USB_DIR_IN
)
485 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
486 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
491 usb_set_interface(chip
->dev
, fp
->iface
, 0);
496 * Create a standard mixer for the specified interface.
498 static int create_standard_mixer_quirk(struct snd_usb_audio
*chip
,
499 struct usb_interface
*iface
,
500 struct usb_driver
*driver
,
501 const struct snd_usb_audio_quirk
*quirk
)
503 if (quirk
->ifnum
< 0)
506 return snd_usb_create_mixer(chip
, quirk
->ifnum
, 0);
510 * audio-interface quirks
512 * returns zero if no standard audio/MIDI parsing is needed.
513 * returns a positive value if standard audio/midi interfaces are parsed
515 * returns a negative value at error.
517 int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
518 struct usb_interface
*iface
,
519 struct usb_driver
*driver
,
520 const struct snd_usb_audio_quirk
*quirk
)
522 typedef int (*quirk_func_t
)(struct snd_usb_audio
*,
523 struct usb_interface
*,
525 const struct snd_usb_audio_quirk
*);
526 static const quirk_func_t quirk_funcs
[] = {
527 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
528 [QUIRK_COMPOSITE
] = create_composite_quirk
,
529 [QUIRK_AUTODETECT
] = create_autodetect_quirks
,
530 [QUIRK_MIDI_STANDARD_INTERFACE
] = create_any_midi_quirk
,
531 [QUIRK_MIDI_FIXED_ENDPOINT
] = create_any_midi_quirk
,
532 [QUIRK_MIDI_YAMAHA
] = create_any_midi_quirk
,
533 [QUIRK_MIDI_ROLAND
] = create_any_midi_quirk
,
534 [QUIRK_MIDI_MIDIMAN
] = create_any_midi_quirk
,
535 [QUIRK_MIDI_NOVATION
] = create_any_midi_quirk
,
536 [QUIRK_MIDI_RAW_BYTES
] = create_any_midi_quirk
,
537 [QUIRK_MIDI_EMAGIC
] = create_any_midi_quirk
,
538 [QUIRK_MIDI_CME
] = create_any_midi_quirk
,
539 [QUIRK_MIDI_AKAI
] = create_any_midi_quirk
,
540 [QUIRK_MIDI_FTDI
] = create_any_midi_quirk
,
541 [QUIRK_MIDI_CH345
] = create_any_midi_quirk
,
542 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
543 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
544 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
,
545 [QUIRK_AUDIO_ALIGN_TRANSFER
] = create_align_transfer_quirk
,
546 [QUIRK_AUDIO_STANDARD_MIXER
] = create_standard_mixer_quirk
,
549 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
550 return quirk_funcs
[quirk
->type
](chip
, iface
, driver
, quirk
);
552 usb_audio_err(chip
, "invalid quirk type %d\n", quirk
->type
);
561 #define EXTIGY_FIRMWARE_SIZE_OLD 794
562 #define EXTIGY_FIRMWARE_SIZE_NEW 483
564 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
566 struct usb_host_config
*config
= dev
->actconfig
;
569 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
570 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
571 dev_dbg(&dev
->dev
, "sending Extigy boot sequence...\n");
572 /* Send message to force it to reconnect with full interface. */
573 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
574 0x10, 0x43, 0x0001, 0x000a, NULL
, 0);
576 dev_dbg(&dev
->dev
, "error sending boot message: %d\n", err
);
577 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
578 &dev
->descriptor
, sizeof(dev
->descriptor
));
579 config
= dev
->actconfig
;
581 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
582 err
= usb_reset_configuration(dev
);
584 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
585 dev_dbg(&dev
->dev
, "extigy_boot: new boot length = %d\n",
586 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
587 return -ENODEV
; /* quit this anyway */
592 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
596 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
597 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
600 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
601 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
608 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device
*dev
)
612 if (dev
->actconfig
->desc
.bConfigurationValue
== 1) {
614 "Fast Track Pro switching to config #2\n");
615 /* This function has to be available by the usb core module.
616 * if it is not avialable the boot quirk has to be left out
617 * and the configuration has to be set by udev or hotplug
620 err
= usb_driver_set_configuration(dev
, 2);
623 "error usb_driver_set_configuration: %d\n",
625 /* Always return an error, so that we stop creating a device
626 that will just be destroyed and recreated with a new
630 dev_info(&dev
->dev
, "Fast Track Pro config OK\n");
636 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
637 * documented in the device's data sheet.
639 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
643 buf
[1] = value
& 0xff;
644 buf
[2] = (value
>> 8) & 0xff;
646 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
647 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
651 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
654 * Enable line-out driver mode, set headphone source to front
655 * channels, enable stereo mic.
657 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
661 * C-Media CM6206 is based on CM106 with two additional
662 * registers that are not documented in the data sheet.
663 * Values here are chosen based on sniffing USB traffic
666 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
669 int val
[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
671 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
672 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
680 /* quirk for Plantronics GameCom 780 with CM6302 chip */
681 static int snd_usb_gamecon780_boot_quirk(struct usb_device
*dev
)
683 /* set the initial volume and don't change; other values are either
684 * too loud or silent due to firmware bug (bko#65251)
686 u8 buf
[2] = { 0x74, 0xe3 };
687 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
688 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
689 UAC_FU_VOLUME
<< 8, 9 << 8, buf
, 2);
693 * Novation Twitch DJ controller
694 * Focusrite Novation Saffire 6 USB audio card
696 static int snd_usb_novation_boot_quirk(struct usb_device
*dev
)
698 /* preemptively set up the device because otherwise the
699 * raw MIDI endpoints are not active */
700 usb_set_interface(dev
, 0, 1);
705 * This call will put the synth in "USB send" mode, i.e it will send MIDI
706 * messages through USB (this is disabled at startup). The synth will
707 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
708 * sign on its LCD. Values here are chosen based on sniffing USB traffic
711 static int snd_usb_accessmusic_boot_quirk(struct usb_device
*dev
)
713 int err
, actual_length
;
715 /* "midi send" enable */
716 static const u8 seq
[] = { 0x4e, 0x73, 0x52, 0x01 };
718 void *buf
= kmemdup(seq
, ARRAY_SIZE(seq
), GFP_KERNEL
);
721 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x05), buf
,
722 ARRAY_SIZE(seq
), &actual_length
, 1000);
731 * Some sound cards from Native Instruments are in fact compliant to the USB
732 * audio standard of version 2 and other approved USB standards, even though
733 * they come up as vendor-specific device when first connected.
735 * However, they can be told to come up with a new set of descriptors
736 * upon their next enumeration, and the interfaces announced by the new
737 * descriptors will then be handled by the kernel's class drivers. As the
738 * product ID will also change, no further checks are required.
741 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device
*dev
)
743 int ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
744 0xaf, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
745 1, 0, NULL
, 0, 1000);
750 usb_reset_device(dev
);
752 /* return -EAGAIN, so the creation of an audio interface for this
753 * temporary device is aborted. The device will reconnect with a
758 static void mbox2_setup_48_24_magic(struct usb_device
*dev
)
763 /* Choose 48000Hz permanently */
768 /* Send the magic! */
769 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
770 0x01, 0x22, 0x0100, 0x0085, &temp
, 0x0003);
771 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
772 0x81, 0xa2, 0x0100, 0x0085, &srate
, 0x0003);
773 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
774 0x81, 0xa2, 0x0100, 0x0086, &srate
, 0x0003);
775 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
776 0x81, 0xa2, 0x0100, 0x0003, &srate
, 0x0003);
780 /* Digidesign Mbox 2 needs to load firmware onboard
781 * and driver must wait a few seconds for initialisation.
784 #define MBOX2_FIRMWARE_SIZE 646
785 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
786 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
788 static int snd_usb_mbox2_boot_quirk(struct usb_device
*dev
)
790 struct usb_host_config
*config
= dev
->actconfig
;
792 u8 bootresponse
[0x12];
796 fwsize
= le16_to_cpu(get_cfg_desc(config
)->wTotalLength
);
798 if (fwsize
!= MBOX2_FIRMWARE_SIZE
) {
799 dev_err(&dev
->dev
, "Invalid firmware size=%d.\n", fwsize
);
803 dev_dbg(&dev
->dev
, "Sending Digidesign Mbox 2 boot sequence...\n");
806 bootresponse
[0] = MBOX2_BOOT_LOADING
;
807 while ((bootresponse
[0] == MBOX2_BOOT_LOADING
) && (count
< 10)) {
808 msleep(500); /* 0.5 second delay */
809 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
810 /* Control magic - load onboard firmware */
811 0x85, 0xc0, 0x0001, 0x0000, &bootresponse
, 0x0012);
812 if (bootresponse
[0] == MBOX2_BOOT_READY
)
814 dev_dbg(&dev
->dev
, "device not ready, resending boot sequence...\n");
818 if (bootresponse
[0] != MBOX2_BOOT_READY
) {
819 dev_err(&dev
->dev
, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse
[0]);
823 dev_dbg(&dev
->dev
, "device initialised!\n");
825 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
826 &dev
->descriptor
, sizeof(dev
->descriptor
));
827 config
= dev
->actconfig
;
829 dev_dbg(&dev
->dev
, "error usb_get_descriptor: %d\n", err
);
831 err
= usb_reset_configuration(dev
);
833 dev_dbg(&dev
->dev
, "error usb_reset_configuration: %d\n", err
);
834 dev_dbg(&dev
->dev
, "mbox2_boot: new boot length = %d\n",
835 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
837 mbox2_setup_48_24_magic(dev
);
839 dev_info(&dev
->dev
, "Digidesign Mbox 2: 24bit 48kHz");
841 return 0; /* Successful boot */
847 #define MAUDIO_SET 0x01 /* parse device_setup */
848 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
849 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
850 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
851 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
852 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
853 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
854 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
855 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
856 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
857 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
859 static int quattro_skip_setting_quirk(struct snd_usb_audio
*chip
,
860 int iface
, int altno
)
862 /* Reset ALL ifaces to 0 altsetting.
863 * Call it for every possible altsetting of every interface.
865 usb_set_interface(chip
->dev
, iface
, 0);
866 if (chip
->setup
& MAUDIO_SET
) {
867 if (chip
->setup
& MAUDIO_SET_COMPATIBLE
) {
868 if (iface
!= 1 && iface
!= 2)
869 return 1; /* skip all interfaces but 1 and 2 */
872 if (iface
== 1 || iface
== 2)
873 return 1; /* skip interfaces 1 and 2 */
874 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
875 return 1; /* skip this altsetting */
876 mask
= chip
->setup
& MAUDIO_SET_MASK
;
877 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
878 return 1; /* skip this altsetting */
879 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
880 return 1; /* skip this altsetting */
881 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 4)
882 return 1; /* skip this altsetting */
886 "using altsetting %d for interface %d config %d\n",
887 altno
, iface
, chip
->setup
);
888 return 0; /* keep this altsetting */
891 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
895 /* Reset ALL ifaces to 0 altsetting.
896 * Call it for every possible altsetting of every interface.
898 usb_set_interface(chip
->dev
, iface
, 0);
900 if (chip
->setup
& MAUDIO_SET
) {
902 if ((chip
->setup
& MAUDIO_SET_DTS
) && altno
!= 6)
903 return 1; /* skip this altsetting */
904 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
905 return 1; /* skip this altsetting */
906 mask
= chip
->setup
& MAUDIO_SET_MASK
;
907 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
908 return 1; /* skip this altsetting */
909 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
910 return 1; /* skip this altsetting */
911 if (mask
== MAUDIO_SET_16B_48K_DI
&& altno
!= 4)
912 return 1; /* skip this altsetting */
913 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 5)
914 return 1; /* skip this altsetting */
917 return 0; /* keep this altsetting */
920 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio
*chip
,
921 int iface
, int altno
)
923 /* Reset ALL ifaces to 0 altsetting.
924 * Call it for every possible altsetting of every interface.
926 usb_set_interface(chip
->dev
, iface
, 0);
928 /* possible configuration where both inputs and only one output is
929 *used is not supported by the current setup
931 if (chip
->setup
& (MAUDIO_SET
| MAUDIO_SET_24B
)) {
932 if (chip
->setup
& MAUDIO_SET_96K
) {
933 if (altno
!= 3 && altno
!= 6)
935 } else if (chip
->setup
& MAUDIO_SET_DI
) {
937 return 1; /* no analog input */
938 if (altno
!= 2 && altno
!= 5)
939 return 1; /* enable only altsets 2 and 5 */
942 return 1; /* disable digialt input */
943 if (altno
!= 2 && altno
!= 5)
944 return 1; /* enalbe only altsets 2 and 5 */
947 /* keep only 16-Bit mode */
953 "using altsetting %d for interface %d config %d\n",
954 altno
, iface
, chip
->setup
);
955 return 0; /* keep this altsetting */
958 int snd_usb_apply_interface_quirk(struct snd_usb_audio
*chip
,
962 /* audiophile usb: skip altsets incompatible with device_setup */
963 if (chip
->usb_id
== USB_ID(0x0763, 0x2003))
964 return audiophile_skip_setting_quirk(chip
, iface
, altno
);
965 /* quattro usb: skip altsets incompatible with device_setup */
966 if (chip
->usb_id
== USB_ID(0x0763, 0x2001))
967 return quattro_skip_setting_quirk(chip
, iface
, altno
);
968 /* fasttrackpro usb: skip altsets incompatible with device_setup */
969 if (chip
->usb_id
== USB_ID(0x0763, 0x2012))
970 return fasttrackpro_skip_setting_quirk(chip
, iface
, altno
);
975 int snd_usb_apply_boot_quirk(struct usb_device
*dev
,
976 struct usb_interface
*intf
,
977 const struct snd_usb_audio_quirk
*quirk
)
979 u32 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
980 le16_to_cpu(dev
->descriptor
.idProduct
));
983 case USB_ID(0x041e, 0x3000):
984 /* SB Extigy needs special boot-up sequence */
985 /* if more models come, this will go to the quirk list. */
986 return snd_usb_extigy_boot_quirk(dev
, intf
);
988 case USB_ID(0x041e, 0x3020):
989 /* SB Audigy 2 NX needs its own boot-up magic, too */
990 return snd_usb_audigy2nx_boot_quirk(dev
);
992 case USB_ID(0x10f5, 0x0200):
993 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
994 return snd_usb_cm106_boot_quirk(dev
);
996 case USB_ID(0x0d8c, 0x0102):
997 /* C-Media CM6206 / CM106-Like Sound Device */
998 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
999 return snd_usb_cm6206_boot_quirk(dev
);
1001 case USB_ID(0x0dba, 0x3000):
1002 /* Digidesign Mbox 2 */
1003 return snd_usb_mbox2_boot_quirk(dev
);
1005 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1006 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1007 return snd_usb_novation_boot_quirk(dev
);
1009 case USB_ID(0x133e, 0x0815):
1010 /* Access Music VirusTI Desktop */
1011 return snd_usb_accessmusic_boot_quirk(dev
);
1013 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1014 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1015 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1016 return snd_usb_nativeinstruments_boot_quirk(dev
);
1017 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1018 return snd_usb_fasttrackpro_boot_quirk(dev
);
1019 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1020 return snd_usb_gamecon780_boot_quirk(dev
);
1027 * check if the device uses big-endian samples
1029 int snd_usb_is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
1031 /* it depends on altsetting whether the device is big-endian or not */
1032 switch (chip
->usb_id
) {
1033 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1034 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1035 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1038 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1039 if (chip
->setup
== 0x00 ||
1040 fp
->altsetting
== 1 || fp
->altsetting
== 2 ||
1041 fp
->altsetting
== 3)
1044 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1045 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1046 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1054 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1055 * not for interface.
1059 EMU_QUIRK_SR_44100HZ
= 0,
1060 EMU_QUIRK_SR_48000HZ
,
1061 EMU_QUIRK_SR_88200HZ
,
1062 EMU_QUIRK_SR_96000HZ
,
1063 EMU_QUIRK_SR_176400HZ
,
1064 EMU_QUIRK_SR_192000HZ
1067 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
1068 struct audioformat
*fmt
)
1070 unsigned char emu_samplerate_id
= 0;
1072 /* When capture is active
1073 * sample rate shouldn't be changed
1074 * by playback substream
1076 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1077 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
1081 switch (fmt
->rate_min
) {
1083 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
1086 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
1089 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
1092 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
1095 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
1098 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
1101 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
1102 subs
->pkt_offset_adj
= (emu_samplerate_id
>= EMU_QUIRK_SR_176400HZ
) ? 4 : 0;
1105 void snd_usb_set_format_quirk(struct snd_usb_substream
*subs
,
1106 struct audioformat
*fmt
)
1108 switch (subs
->stream
->chip
->usb_id
) {
1109 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1110 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1111 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1112 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1113 set_format_emu_quirk(subs
, fmt
);
1118 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio
*chip
)
1120 /* devices which do not support reading the sample rate. */
1121 switch (chip
->usb_id
) {
1122 case USB_ID(0x045E, 0x075D): /* MS Lifecam Cinema */
1123 case USB_ID(0x045E, 0x076D): /* MS Lifecam HD-5000 */
1124 case USB_ID(0x045E, 0x0772): /* MS Lifecam Studio */
1125 case USB_ID(0x045E, 0x0779): /* MS Lifecam HD-3000 */
1126 case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */
1127 case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1128 case USB_ID(0x21B4, 0x0081): /* AudioQuest DragonFly */
1134 /* Marantz/Denon USB DACs need a vendor cmd to switch
1135 * between PCM and native DSD mode
1137 static bool is_marantz_denon_dac(unsigned int id
)
1140 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1141 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1142 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1148 int snd_usb_select_mode_quirk(struct snd_usb_substream
*subs
,
1149 struct audioformat
*fmt
)
1151 struct usb_device
*dev
= subs
->dev
;
1154 if (is_marantz_denon_dac(subs
->stream
->chip
->usb_id
)) {
1155 /* First switch to alt set 0, otherwise the mode switch cmd
1156 * will not be accepted by the DAC
1158 err
= usb_set_interface(dev
, fmt
->iface
, 0);
1162 mdelay(20); /* Delay needed after setting the interface */
1164 switch (fmt
->altsetting
) {
1165 case 2: /* DSD mode requested */
1166 case 1: /* PCM mode requested */
1167 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0,
1168 USB_DIR_OUT
|USB_TYPE_VENDOR
|USB_RECIP_INTERFACE
,
1169 fmt
->altsetting
- 1, 1, NULL
, 0);
1179 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint
*ep
)
1182 * "Playback Design" products send bogus feedback data at the start
1183 * of the stream. Ignore them.
1185 if ((le16_to_cpu(ep
->chip
->dev
->descriptor
.idVendor
) == 0x23ba) &&
1186 ep
->type
== SND_USB_ENDPOINT_TYPE_SYNC
)
1187 ep
->skip_packets
= 4;
1190 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1191 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1192 * the stream is (re)started. When skipping packets 16 at endpoint
1193 * start up, the real world latency is stable within +/- 1 frame (also
1194 * across power cycles).
1196 if ((ep
->chip
->usb_id
== USB_ID(0x0763, 0x2030) ||
1197 ep
->chip
->usb_id
== USB_ID(0x0763, 0x2031)) &&
1198 ep
->type
== SND_USB_ENDPOINT_TYPE_DATA
)
1199 ep
->skip_packets
= 16;
1202 void snd_usb_set_interface_quirk(struct usb_device
*dev
)
1205 * "Playback Design" products need a 50ms delay after setting the
1208 if (le16_to_cpu(dev
->descriptor
.idVendor
) == 0x23ba)
1212 void snd_usb_ctl_msg_quirk(struct usb_device
*dev
, unsigned int pipe
,
1213 __u8 request
, __u8 requesttype
, __u16 value
,
1214 __u16 index
, void *data
, __u16 size
)
1217 * "Playback Design" products need a 20ms delay after each
1218 * class compliant request
1220 if ((le16_to_cpu(dev
->descriptor
.idVendor
) == 0x23ba) &&
1221 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1224 /* Marantz/Denon devices with USB DAC functionality need a delay
1225 * after each class compliant request
1227 if (is_marantz_denon_dac(USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
1228 le16_to_cpu(dev
->descriptor
.idProduct
)))
1229 && (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1232 /* Zoom R16/24 needs a tiny delay here, otherwise requests like
1233 * get/set frequency return as failed despite actually succeeding.
1235 if ((le16_to_cpu(dev
->descriptor
.idVendor
) == 0x1686) &&
1236 (le16_to_cpu(dev
->descriptor
.idProduct
) == 0x00dd) &&
1237 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1242 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1243 * augment the PCM format bit-field for DSD types. The UAC standards
1244 * don't have a designated bit field to denote DSD-capable interfaces,
1245 * hence all hardware that is known to support this format has to be
1248 u64
snd_usb_interface_dsd_format_quirks(struct snd_usb_audio
*chip
,
1249 struct audioformat
*fp
,
1250 unsigned int sample_bytes
)
1252 /* Playback Designs */
1253 if (le16_to_cpu(chip
->dev
->descriptor
.idVendor
) == 0x23ba) {
1254 switch (fp
->altsetting
) {
1257 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1259 fp
->dsd_bitrev
= true;
1260 return SNDRV_PCM_FMTBIT_DSD_U8
;
1262 fp
->dsd_bitrev
= true;
1263 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1267 /* XMOS based USB DACs */
1268 switch (chip
->usb_id
) {
1269 case USB_ID(0x20b1, 0x3008): /* iFi Audio micro/nano iDSD */
1270 case USB_ID(0x20b1, 0x2008): /* Matrix Audio X-Sabre */
1271 case USB_ID(0x20b1, 0x300a): /* Matrix Audio Mini-i Pro */
1272 if (fp
->altsetting
== 2)
1273 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1276 case USB_ID(0x20b1, 0x000a): /* Gustard DAC-X20U */
1277 case USB_ID(0x20b1, 0x2009): /* DIYINHK DSD DXD 384kHz USB to I2S/DSD */
1278 case USB_ID(0x20b1, 0x2023): /* JLsounds I2SoverUSB */
1279 case USB_ID(0x20b1, 0x3023): /* Aune X1S 32BIT/384 DSD DAC */
1280 if (fp
->altsetting
== 3)
1281 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;
1287 /* Denon/Marantz devices with USB DAC functionality */
1288 if (is_marantz_denon_dac(chip
->usb_id
)) {
1289 if (fp
->altsetting
== 2)
1290 return SNDRV_PCM_FMTBIT_DSD_U32_BE
;