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
)
48 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
51 for (quirk
= quirk
->data
; quirk
->ifnum
>= 0; ++quirk
) {
52 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
55 if (quirk
->ifnum
!= probed_ifnum
&&
56 usb_interface_claimed(iface
))
58 err
= snd_usb_create_quirk(chip
, iface
, driver
, quirk
);
61 if (quirk
->ifnum
!= probed_ifnum
)
62 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
67 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
68 struct usb_interface
*iface
,
69 struct usb_driver
*driver
,
70 const struct snd_usb_audio_quirk
*quirk
)
77 * Allow alignment on audio sub-slot (channel samples) rather than
78 * on audio slots (audio frames)
80 static int create_align_transfer_quirk(struct snd_usb_audio
*chip
,
81 struct usb_interface
*iface
,
82 struct usb_driver
*driver
,
83 const struct snd_usb_audio_quirk
*quirk
)
86 return 1; /* Continue with creating streams and mixer */
89 static int create_any_midi_quirk(struct snd_usb_audio
*chip
,
90 struct usb_interface
*intf
,
91 struct usb_driver
*driver
,
92 const struct snd_usb_audio_quirk
*quirk
)
94 return snd_usbmidi_create(chip
->card
, intf
, &chip
->midi_list
, quirk
);
98 * create a stream for an interface with proper descriptors
100 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
101 struct usb_interface
*iface
,
102 struct usb_driver
*driver
,
103 const struct snd_usb_audio_quirk
*quirk
)
105 struct usb_host_interface
*alts
;
106 struct usb_interface_descriptor
*altsd
;
109 alts
= &iface
->altsetting
[0];
110 altsd
= get_iface_desc(alts
);
111 err
= snd_usb_parse_audio_interface(chip
, altsd
->bInterfaceNumber
);
113 snd_printk(KERN_ERR
"cannot setup if %d: error %d\n",
114 altsd
->bInterfaceNumber
, err
);
117 /* reset the current interface */
118 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
123 * create a stream for an endpoint/altsetting without proper descriptors
125 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
126 struct usb_interface
*iface
,
127 struct usb_driver
*driver
,
128 const struct snd_usb_audio_quirk
*quirk
)
130 struct audioformat
*fp
;
131 struct usb_host_interface
*alts
;
132 struct usb_interface_descriptor
*altsd
;
134 unsigned *rate_table
= NULL
;
136 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
138 snd_printk(KERN_ERR
"cannot memdup\n");
141 if (fp
->nr_rates
> MAX_NR_RATES
) {
145 if (fp
->nr_rates
> 0) {
146 rate_table
= kmemdup(fp
->rate_table
,
147 sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
152 fp
->rate_table
= rate_table
;
155 stream
= (fp
->endpoint
& USB_DIR_IN
)
156 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
157 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
163 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
164 fp
->altset_idx
>= iface
->num_altsetting
) {
169 alts
= &iface
->altsetting
[fp
->altset_idx
];
170 altsd
= get_iface_desc(alts
);
171 fp
->protocol
= altsd
->bInterfaceProtocol
;
173 if (fp
->datainterval
== 0)
174 fp
->datainterval
= snd_usb_parse_datainterval(chip
, alts
);
175 if (fp
->maxpacksize
== 0)
176 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
177 usb_set_interface(chip
->dev
, fp
->iface
, 0);
178 snd_usb_init_pitch(chip
, fp
->iface
, alts
, fp
);
179 snd_usb_init_sample_rate(chip
, fp
->iface
, alts
, fp
, fp
->rate_max
);
183 static int create_auto_pcm_quirk(struct snd_usb_audio
*chip
,
184 struct usb_interface
*iface
,
185 struct usb_driver
*driver
)
187 struct usb_host_interface
*alts
;
188 struct usb_interface_descriptor
*altsd
;
189 struct usb_endpoint_descriptor
*epd
;
190 struct uac1_as_header_descriptor
*ashd
;
191 struct uac_format_type_i_discrete_descriptor
*fmtd
;
194 * Most Roland/Yamaha audio streaming interfaces have more or less
195 * standard descriptors, but older devices might lack descriptors, and
196 * future ones might change, so ensure that we fail silently if the
197 * interface doesn't look exactly right.
200 /* must have a non-zero altsetting for streaming */
201 if (iface
->num_altsetting
< 2)
203 alts
= &iface
->altsetting
[1];
204 altsd
= get_iface_desc(alts
);
206 /* must have an isochronous endpoint for streaming */
207 if (altsd
->bNumEndpoints
< 1)
209 epd
= get_endpoint(alts
, 0);
210 if (!usb_endpoint_xfer_isoc(epd
))
213 /* must have format descriptors */
214 ashd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
216 fmtd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
, NULL
,
218 if (!ashd
|| ashd
->bLength
< 7 ||
219 !fmtd
|| fmtd
->bLength
< 8)
222 return create_standard_audio_quirk(chip
, iface
, driver
, NULL
);
225 static int create_yamaha_midi_quirk(struct snd_usb_audio
*chip
,
226 struct usb_interface
*iface
,
227 struct usb_driver
*driver
,
228 struct usb_host_interface
*alts
)
230 static const struct snd_usb_audio_quirk yamaha_midi_quirk
= {
231 .type
= QUIRK_MIDI_YAMAHA
233 struct usb_midi_in_jack_descriptor
*injd
;
234 struct usb_midi_out_jack_descriptor
*outjd
;
236 /* must have some valid jack descriptors */
237 injd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
238 NULL
, USB_MS_MIDI_IN_JACK
);
239 outjd
= snd_usb_find_csint_desc(alts
->extra
, alts
->extralen
,
240 NULL
, USB_MS_MIDI_OUT_JACK
);
243 if (injd
&& (injd
->bLength
< 5 ||
244 (injd
->bJackType
!= USB_MS_EMBEDDED
&&
245 injd
->bJackType
!= USB_MS_EXTERNAL
)))
247 if (outjd
&& (outjd
->bLength
< 6 ||
248 (outjd
->bJackType
!= USB_MS_EMBEDDED
&&
249 outjd
->bJackType
!= USB_MS_EXTERNAL
)))
251 return create_any_midi_quirk(chip
, iface
, driver
, &yamaha_midi_quirk
);
254 static int create_roland_midi_quirk(struct snd_usb_audio
*chip
,
255 struct usb_interface
*iface
,
256 struct usb_driver
*driver
,
257 struct usb_host_interface
*alts
)
259 static const struct snd_usb_audio_quirk roland_midi_quirk
= {
260 .type
= QUIRK_MIDI_ROLAND
262 u8
*roland_desc
= NULL
;
264 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
266 roland_desc
= snd_usb_find_csint_desc(alts
->extra
,
271 if (roland_desc
[0] < 6 || roland_desc
[3] != 2)
273 return create_any_midi_quirk(chip
, iface
, driver
,
278 static int create_std_midi_quirk(struct snd_usb_audio
*chip
,
279 struct usb_interface
*iface
,
280 struct usb_driver
*driver
,
281 struct usb_host_interface
*alts
)
283 struct usb_ms_header_descriptor
*mshd
;
284 struct usb_ms_endpoint_descriptor
*msepd
;
286 /* must have the MIDIStreaming interface header descriptor*/
287 mshd
= (struct usb_ms_header_descriptor
*)alts
->extra
;
288 if (alts
->extralen
< 7 ||
290 mshd
->bDescriptorType
!= USB_DT_CS_INTERFACE
||
291 mshd
->bDescriptorSubtype
!= USB_MS_HEADER
)
293 /* must have the MIDIStreaming endpoint descriptor*/
294 msepd
= (struct usb_ms_endpoint_descriptor
*)alts
->endpoint
[0].extra
;
295 if (alts
->endpoint
[0].extralen
< 4 ||
296 msepd
->bLength
< 4 ||
297 msepd
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
298 msepd
->bDescriptorSubtype
!= UAC_MS_GENERAL
||
299 msepd
->bNumEmbMIDIJack
< 1 ||
300 msepd
->bNumEmbMIDIJack
> 16)
303 return create_any_midi_quirk(chip
, iface
, driver
, NULL
);
306 static int create_auto_midi_quirk(struct snd_usb_audio
*chip
,
307 struct usb_interface
*iface
,
308 struct usb_driver
*driver
)
310 struct usb_host_interface
*alts
;
311 struct usb_interface_descriptor
*altsd
;
312 struct usb_endpoint_descriptor
*epd
;
315 alts
= &iface
->altsetting
[0];
316 altsd
= get_iface_desc(alts
);
318 /* must have at least one bulk/interrupt endpoint for streaming */
319 if (altsd
->bNumEndpoints
< 1)
321 epd
= get_endpoint(alts
, 0);
322 if (!usb_endpoint_xfer_bulk(epd
) &&
323 !usb_endpoint_xfer_int(epd
))
326 switch (USB_ID_VENDOR(chip
->usb_id
)) {
327 case 0x0499: /* Yamaha */
328 err
= create_yamaha_midi_quirk(chip
, iface
, driver
, alts
);
332 case 0x0582: /* Roland */
333 err
= create_roland_midi_quirk(chip
, iface
, driver
, alts
);
339 return create_std_midi_quirk(chip
, iface
, driver
, alts
);
342 static int create_autodetect_quirk(struct snd_usb_audio
*chip
,
343 struct usb_interface
*iface
,
344 struct usb_driver
*driver
)
348 err
= create_auto_pcm_quirk(chip
, iface
, driver
);
350 err
= create_auto_midi_quirk(chip
, iface
, driver
);
354 static int create_autodetect_quirks(struct snd_usb_audio
*chip
,
355 struct usb_interface
*iface
,
356 struct usb_driver
*driver
,
357 const struct snd_usb_audio_quirk
*quirk
)
359 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
360 int ifcount
, ifnum
, err
;
362 err
= create_autodetect_quirk(chip
, iface
, driver
);
367 * ALSA PCM playback/capture devices cannot be registered in two steps,
368 * so we have to claim the other corresponding interface here.
370 ifcount
= chip
->dev
->actconfig
->desc
.bNumInterfaces
;
371 for (ifnum
= 0; ifnum
< ifcount
; ifnum
++) {
372 if (ifnum
== probed_ifnum
|| quirk
->ifnum
>= 0)
374 iface
= usb_ifnum_to_if(chip
->dev
, ifnum
);
376 usb_interface_claimed(iface
) ||
377 get_iface_desc(iface
->altsetting
)->bInterfaceClass
!=
378 USB_CLASS_VENDOR_SPEC
)
381 err
= create_autodetect_quirk(chip
, iface
, driver
);
383 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
390 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
391 * The only way to detect the sample rate is by looking at wMaxPacketSize.
393 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
394 struct usb_interface
*iface
,
395 struct usb_driver
*driver
,
396 const struct snd_usb_audio_quirk
*quirk
)
398 static const struct audioformat ua_format
= {
399 .formats
= SNDRV_PCM_FMTBIT_S24_3LE
,
401 .fmt_type
= UAC_FORMAT_TYPE_I
,
404 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
406 struct usb_host_interface
*alts
;
407 struct usb_interface_descriptor
*altsd
;
408 struct audioformat
*fp
;
411 /* both PCM and MIDI interfaces have 2 or more altsettings */
412 if (iface
->num_altsetting
< 2)
414 alts
= &iface
->altsetting
[1];
415 altsd
= get_iface_desc(alts
);
417 if (altsd
->bNumEndpoints
== 2) {
418 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
419 .out_cables
= 0x0003,
422 static const struct snd_usb_audio_quirk ua700_quirk
= {
423 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
426 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
427 .out_cables
= 0x0001,
430 static const struct snd_usb_audio_quirk uaxx_quirk
= {
431 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
434 const struct snd_usb_audio_quirk
*quirk
=
435 chip
->usb_id
== USB_ID(0x0582, 0x002b)
436 ? &ua700_quirk
: &uaxx_quirk
;
437 return snd_usbmidi_create(chip
->card
, iface
,
438 &chip
->midi_list
, quirk
);
441 if (altsd
->bNumEndpoints
!= 1)
444 fp
= kmemdup(&ua_format
, sizeof(*fp
), GFP_KERNEL
);
448 fp
->iface
= altsd
->bInterfaceNumber
;
449 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
450 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
451 fp
->datainterval
= 0;
452 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
454 switch (fp
->maxpacksize
) {
456 fp
->rate_max
= fp
->rate_min
= 44100;
460 fp
->rate_max
= fp
->rate_min
= 48000;
464 fp
->rate_max
= fp
->rate_min
= 96000;
467 snd_printk(KERN_ERR
"unknown sample rate\n");
472 stream
= (fp
->endpoint
& USB_DIR_IN
)
473 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
474 err
= snd_usb_add_audio_stream(chip
, stream
, fp
);
479 usb_set_interface(chip
->dev
, fp
->iface
, 0);
484 * Create a standard mixer for the specified interface.
486 static int create_standard_mixer_quirk(struct snd_usb_audio
*chip
,
487 struct usb_interface
*iface
,
488 struct usb_driver
*driver
,
489 const struct snd_usb_audio_quirk
*quirk
)
491 if (quirk
->ifnum
< 0)
494 return snd_usb_create_mixer(chip
, quirk
->ifnum
, 0);
498 * audio-interface quirks
500 * returns zero if no standard audio/MIDI parsing is needed.
501 * returns a positive value if standard audio/midi interfaces are parsed
503 * returns a negative value at error.
505 int snd_usb_create_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 typedef int (*quirk_func_t
)(struct snd_usb_audio
*,
511 struct usb_interface
*,
513 const struct snd_usb_audio_quirk
*);
514 static const quirk_func_t quirk_funcs
[] = {
515 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
516 [QUIRK_COMPOSITE
] = create_composite_quirk
,
517 [QUIRK_AUTODETECT
] = create_autodetect_quirks
,
518 [QUIRK_MIDI_STANDARD_INTERFACE
] = create_any_midi_quirk
,
519 [QUIRK_MIDI_FIXED_ENDPOINT
] = create_any_midi_quirk
,
520 [QUIRK_MIDI_YAMAHA
] = create_any_midi_quirk
,
521 [QUIRK_MIDI_ROLAND
] = create_any_midi_quirk
,
522 [QUIRK_MIDI_MIDIMAN
] = create_any_midi_quirk
,
523 [QUIRK_MIDI_NOVATION
] = create_any_midi_quirk
,
524 [QUIRK_MIDI_RAW_BYTES
] = create_any_midi_quirk
,
525 [QUIRK_MIDI_EMAGIC
] = create_any_midi_quirk
,
526 [QUIRK_MIDI_CME
] = create_any_midi_quirk
,
527 [QUIRK_MIDI_AKAI
] = create_any_midi_quirk
,
528 [QUIRK_MIDI_FTDI
] = create_any_midi_quirk
,
529 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
530 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
531 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
,
532 [QUIRK_AUDIO_ALIGN_TRANSFER
] = create_align_transfer_quirk
,
533 [QUIRK_AUDIO_STANDARD_MIXER
] = create_standard_mixer_quirk
,
536 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
537 return quirk_funcs
[quirk
->type
](chip
, iface
, driver
, quirk
);
539 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
548 #define EXTIGY_FIRMWARE_SIZE_OLD 794
549 #define EXTIGY_FIRMWARE_SIZE_NEW 483
551 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
553 struct usb_host_config
*config
= dev
->actconfig
;
556 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
557 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
558 snd_printdd("sending Extigy boot sequence...\n");
559 /* Send message to force it to reconnect with full interface. */
560 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
561 0x10, 0x43, 0x0001, 0x000a, NULL
, 0);
562 if (err
< 0) snd_printdd("error sending boot message: %d\n", err
);
563 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
564 &dev
->descriptor
, sizeof(dev
->descriptor
));
565 config
= dev
->actconfig
;
566 if (err
< 0) snd_printdd("error usb_get_descriptor: %d\n", err
);
567 err
= usb_reset_configuration(dev
);
568 if (err
< 0) snd_printdd("error usb_reset_configuration: %d\n", err
);
569 snd_printdd("extigy_boot: new boot length = %d\n",
570 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
571 return -ENODEV
; /* quit this anyway */
576 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
580 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
581 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
584 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
585 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
592 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device
*dev
)
596 if (dev
->actconfig
->desc
.bConfigurationValue
== 1) {
597 snd_printk(KERN_INFO
"usb-audio: "
598 "Fast Track Pro switching to config #2\n");
599 /* This function has to be available by the usb core module.
600 * if it is not avialable the boot quirk has to be left out
601 * and the configuration has to be set by udev or hotplug
604 err
= usb_driver_set_configuration(dev
, 2);
606 snd_printdd("error usb_driver_set_configuration: %d\n",
608 /* Always return an error, so that we stop creating a device
609 that will just be destroyed and recreated with a new
613 snd_printk(KERN_INFO
"usb-audio: Fast Track Pro config OK\n");
619 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
620 * documented in the device's data sheet.
622 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
626 buf
[1] = value
& 0xff;
627 buf
[2] = (value
>> 8) & 0xff;
629 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
630 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
634 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
637 * Enable line-out driver mode, set headphone source to front
638 * channels, enable stereo mic.
640 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
644 * C-Media CM6206 is based on CM106 with two additional
645 * registers that are not documented in the data sheet.
646 * Values here are chosen based on sniffing USB traffic
649 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
652 int val
[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
654 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
655 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
663 /* quirk for Plantronics GameCom 780 with CM6302 chip */
664 static int snd_usb_gamecon780_boot_quirk(struct usb_device
*dev
)
666 /* set the initial volume and don't change; other values are either
667 * too loud or silent due to firmware bug (bko#65251)
669 u8 buf
[2] = { 0x74, 0xdc };
670 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), UAC_SET_CUR
,
671 USB_RECIP_INTERFACE
| USB_TYPE_CLASS
| USB_DIR_OUT
,
672 UAC_FU_VOLUME
<< 8, 9 << 8, buf
, 2);
676 * Novation Twitch DJ controller
677 * Focusrite Novation Saffire 6 USB audio card
679 static int snd_usb_novation_boot_quirk(struct usb_device
*dev
)
681 /* preemptively set up the device because otherwise the
682 * raw MIDI endpoints are not active */
683 usb_set_interface(dev
, 0, 1);
688 * This call will put the synth in "USB send" mode, i.e it will send MIDI
689 * messages through USB (this is disabled at startup). The synth will
690 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
691 * sign on its LCD. Values here are chosen based on sniffing USB traffic
694 static int snd_usb_accessmusic_boot_quirk(struct usb_device
*dev
)
696 int err
, actual_length
;
698 /* "midi send" enable */
699 static const u8 seq
[] = { 0x4e, 0x73, 0x52, 0x01 };
701 void *buf
= kmemdup(seq
, ARRAY_SIZE(seq
), GFP_KERNEL
);
704 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x05), buf
,
705 ARRAY_SIZE(seq
), &actual_length
, 1000);
714 * Some sound cards from Native Instruments are in fact compliant to the USB
715 * audio standard of version 2 and other approved USB standards, even though
716 * they come up as vendor-specific device when first connected.
718 * However, they can be told to come up with a new set of descriptors
719 * upon their next enumeration, and the interfaces announced by the new
720 * descriptors will then be handled by the kernel's class drivers. As the
721 * product ID will also change, no further checks are required.
724 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device
*dev
)
726 int ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
727 0xaf, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
728 1, 0, NULL
, 0, 1000);
733 usb_reset_device(dev
);
735 /* return -EAGAIN, so the creation of an audio interface for this
736 * temporary device is aborted. The device will reconnect with a
741 static void mbox2_setup_48_24_magic(struct usb_device
*dev
)
746 /* Choose 48000Hz permanently */
751 /* Send the magic! */
752 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
753 0x01, 0x22, 0x0100, 0x0085, &temp
, 0x0003);
754 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
755 0x81, 0xa2, 0x0100, 0x0085, &srate
, 0x0003);
756 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
757 0x81, 0xa2, 0x0100, 0x0086, &srate
, 0x0003);
758 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0),
759 0x81, 0xa2, 0x0100, 0x0003, &srate
, 0x0003);
763 /* Digidesign Mbox 2 needs to load firmware onboard
764 * and driver must wait a few seconds for initialisation.
767 #define MBOX2_FIRMWARE_SIZE 646
768 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
769 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
771 static int snd_usb_mbox2_boot_quirk(struct usb_device
*dev
)
773 struct usb_host_config
*config
= dev
->actconfig
;
775 u8 bootresponse
[0x12];
779 fwsize
= le16_to_cpu(get_cfg_desc(config
)->wTotalLength
);
781 if (fwsize
!= MBOX2_FIRMWARE_SIZE
) {
782 snd_printk(KERN_ERR
"usb-audio: Invalid firmware size=%d.\n", fwsize
);
786 snd_printd("usb-audio: Sending Digidesign Mbox 2 boot sequence...\n");
789 bootresponse
[0] = MBOX2_BOOT_LOADING
;
790 while ((bootresponse
[0] == MBOX2_BOOT_LOADING
) && (count
< 10)) {
791 msleep(500); /* 0.5 second delay */
792 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0),
793 /* Control magic - load onboard firmware */
794 0x85, 0xc0, 0x0001, 0x0000, &bootresponse
, 0x0012);
795 if (bootresponse
[0] == MBOX2_BOOT_READY
)
797 snd_printd("usb-audio: device not ready, resending boot sequence...\n");
801 if (bootresponse
[0] != MBOX2_BOOT_READY
) {
802 snd_printk(KERN_ERR
"usb-audio: Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse
[0]);
806 snd_printdd("usb-audio: device initialised!\n");
808 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
809 &dev
->descriptor
, sizeof(dev
->descriptor
));
810 config
= dev
->actconfig
;
812 snd_printd("error usb_get_descriptor: %d\n", err
);
814 err
= usb_reset_configuration(dev
);
816 snd_printd("error usb_reset_configuration: %d\n", err
);
817 snd_printdd("mbox2_boot: new boot length = %d\n",
818 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
820 mbox2_setup_48_24_magic(dev
);
822 snd_printk(KERN_INFO
"usb-audio: Digidesign Mbox 2: 24bit 48kHz");
824 return 0; /* Successful boot */
830 #define MAUDIO_SET 0x01 /* parse device_setup */
831 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
832 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
833 #define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
834 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
835 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
836 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
837 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
838 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
839 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
840 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
842 static int quattro_skip_setting_quirk(struct snd_usb_audio
*chip
,
843 int iface
, int altno
)
845 /* Reset ALL ifaces to 0 altsetting.
846 * Call it for every possible altsetting of every interface.
848 usb_set_interface(chip
->dev
, iface
, 0);
849 if (chip
->setup
& MAUDIO_SET
) {
850 if (chip
->setup
& MAUDIO_SET_COMPATIBLE
) {
851 if (iface
!= 1 && iface
!= 2)
852 return 1; /* skip all interfaces but 1 and 2 */
855 if (iface
== 1 || iface
== 2)
856 return 1; /* skip interfaces 1 and 2 */
857 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
858 return 1; /* skip this altsetting */
859 mask
= chip
->setup
& MAUDIO_SET_MASK
;
860 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
861 return 1; /* skip this altsetting */
862 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
863 return 1; /* skip this altsetting */
864 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 4)
865 return 1; /* skip this altsetting */
868 snd_printdd(KERN_INFO
869 "using altsetting %d for interface %d config %d\n",
870 altno
, iface
, chip
->setup
);
871 return 0; /* keep this altsetting */
874 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
878 /* Reset ALL ifaces to 0 altsetting.
879 * Call it for every possible altsetting of every interface.
881 usb_set_interface(chip
->dev
, iface
, 0);
883 if (chip
->setup
& MAUDIO_SET
) {
885 if ((chip
->setup
& MAUDIO_SET_DTS
) && altno
!= 6)
886 return 1; /* skip this altsetting */
887 if ((chip
->setup
& MAUDIO_SET_96K
) && altno
!= 1)
888 return 1; /* skip this altsetting */
889 mask
= chip
->setup
& MAUDIO_SET_MASK
;
890 if (mask
== MAUDIO_SET_24B_48K_DI
&& altno
!= 2)
891 return 1; /* skip this altsetting */
892 if (mask
== MAUDIO_SET_24B_48K_NOTDI
&& altno
!= 3)
893 return 1; /* skip this altsetting */
894 if (mask
== MAUDIO_SET_16B_48K_DI
&& altno
!= 4)
895 return 1; /* skip this altsetting */
896 if (mask
== MAUDIO_SET_16B_48K_NOTDI
&& altno
!= 5)
897 return 1; /* skip this altsetting */
900 return 0; /* keep this altsetting */
903 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio
*chip
,
904 int iface
, int altno
)
906 /* Reset ALL ifaces to 0 altsetting.
907 * Call it for every possible altsetting of every interface.
909 usb_set_interface(chip
->dev
, iface
, 0);
911 /* possible configuration where both inputs and only one output is
912 *used is not supported by the current setup
914 if (chip
->setup
& (MAUDIO_SET
| MAUDIO_SET_24B
)) {
915 if (chip
->setup
& MAUDIO_SET_96K
) {
916 if (altno
!= 3 && altno
!= 6)
918 } else if (chip
->setup
& MAUDIO_SET_DI
) {
920 return 1; /* no analog input */
921 if (altno
!= 2 && altno
!= 5)
922 return 1; /* enable only altsets 2 and 5 */
925 return 1; /* disable digialt input */
926 if (altno
!= 2 && altno
!= 5)
927 return 1; /* enalbe only altsets 2 and 5 */
930 /* keep only 16-Bit mode */
935 snd_printdd(KERN_INFO
936 "using altsetting %d for interface %d config %d\n",
937 altno
, iface
, chip
->setup
);
938 return 0; /* keep this altsetting */
941 int snd_usb_apply_interface_quirk(struct snd_usb_audio
*chip
,
945 /* audiophile usb: skip altsets incompatible with device_setup */
946 if (chip
->usb_id
== USB_ID(0x0763, 0x2003))
947 return audiophile_skip_setting_quirk(chip
, iface
, altno
);
948 /* quattro usb: skip altsets incompatible with device_setup */
949 if (chip
->usb_id
== USB_ID(0x0763, 0x2001))
950 return quattro_skip_setting_quirk(chip
, iface
, altno
);
951 /* fasttrackpro usb: skip altsets incompatible with device_setup */
952 if (chip
->usb_id
== USB_ID(0x0763, 0x2012))
953 return fasttrackpro_skip_setting_quirk(chip
, iface
, altno
);
958 int snd_usb_apply_boot_quirk(struct usb_device
*dev
,
959 struct usb_interface
*intf
,
960 const struct snd_usb_audio_quirk
*quirk
)
962 u32 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
963 le16_to_cpu(dev
->descriptor
.idProduct
));
966 case USB_ID(0x041e, 0x3000):
967 /* SB Extigy needs special boot-up sequence */
968 /* if more models come, this will go to the quirk list. */
969 return snd_usb_extigy_boot_quirk(dev
, intf
);
971 case USB_ID(0x041e, 0x3020):
972 /* SB Audigy 2 NX needs its own boot-up magic, too */
973 return snd_usb_audigy2nx_boot_quirk(dev
);
975 case USB_ID(0x10f5, 0x0200):
976 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
977 return snd_usb_cm106_boot_quirk(dev
);
979 case USB_ID(0x0d8c, 0x0102):
980 /* C-Media CM6206 / CM106-Like Sound Device */
981 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
982 return snd_usb_cm6206_boot_quirk(dev
);
984 case USB_ID(0x0dba, 0x3000):
985 /* Digidesign Mbox 2 */
986 return snd_usb_mbox2_boot_quirk(dev
);
988 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
989 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
990 return snd_usb_novation_boot_quirk(dev
);
992 case USB_ID(0x133e, 0x0815):
993 /* Access Music VirusTI Desktop */
994 return snd_usb_accessmusic_boot_quirk(dev
);
996 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
997 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
998 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
999 return snd_usb_nativeinstruments_boot_quirk(dev
);
1000 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1001 return snd_usb_fasttrackpro_boot_quirk(dev
);
1002 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1003 return snd_usb_gamecon780_boot_quirk(dev
);
1010 * check if the device uses big-endian samples
1012 int snd_usb_is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
1014 /* it depends on altsetting whether the device is big-endian or not */
1015 switch (chip
->usb_id
) {
1016 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1017 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1018 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1021 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1022 if (chip
->setup
== 0x00 ||
1023 fp
->altsetting
== 1 || fp
->altsetting
== 2 ||
1024 fp
->altsetting
== 3)
1027 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1028 if (fp
->altsetting
== 2 || fp
->altsetting
== 3 ||
1029 fp
->altsetting
== 5 || fp
->altsetting
== 6)
1037 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1038 * not for interface.
1042 EMU_QUIRK_SR_44100HZ
= 0,
1043 EMU_QUIRK_SR_48000HZ
,
1044 EMU_QUIRK_SR_88200HZ
,
1045 EMU_QUIRK_SR_96000HZ
,
1046 EMU_QUIRK_SR_176400HZ
,
1047 EMU_QUIRK_SR_192000HZ
1050 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
1051 struct audioformat
*fmt
)
1053 unsigned char emu_samplerate_id
= 0;
1055 /* When capture is active
1056 * sample rate shouldn't be changed
1057 * by playback substream
1059 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
1060 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
1064 switch (fmt
->rate_min
) {
1066 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
1069 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
1072 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
1075 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
1078 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
1081 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
1084 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
1085 subs
->pkt_offset_adj
= (emu_samplerate_id
>= EMU_QUIRK_SR_176400HZ
) ? 4 : 0;
1088 void snd_usb_set_format_quirk(struct snd_usb_substream
*subs
,
1089 struct audioformat
*fmt
)
1091 switch (subs
->stream
->chip
->usb_id
) {
1092 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1093 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1094 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1095 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1096 set_format_emu_quirk(subs
, fmt
);
1101 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint
*ep
)
1104 * "Playback Design" products send bogus feedback data at the start
1105 * of the stream. Ignore them.
1107 if ((le16_to_cpu(ep
->chip
->dev
->descriptor
.idVendor
) == 0x23ba) &&
1108 ep
->type
== SND_USB_ENDPOINT_TYPE_SYNC
)
1109 ep
->skip_packets
= 4;
1112 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1113 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1114 * the stream is (re)started. When skipping packets 16 at endpoint
1115 * start up, the real world latency is stable within +/- 1 frame (also
1116 * across power cycles).
1118 if ((ep
->chip
->usb_id
== USB_ID(0x0763, 0x2030) ||
1119 ep
->chip
->usb_id
== USB_ID(0x0763, 0x2031)) &&
1120 ep
->type
== SND_USB_ENDPOINT_TYPE_DATA
)
1121 ep
->skip_packets
= 16;
1124 void snd_usb_set_interface_quirk(struct usb_device
*dev
)
1127 * "Playback Design" products need a 50ms delay after setting the
1130 if (le16_to_cpu(dev
->descriptor
.idVendor
) == 0x23ba)
1134 void snd_usb_ctl_msg_quirk(struct usb_device
*dev
, unsigned int pipe
,
1135 __u8 request
, __u8 requesttype
, __u16 value
,
1136 __u16 index
, void *data
, __u16 size
)
1139 * "Playback Design" products need a 20ms delay after each
1140 * class compliant request
1142 if ((le16_to_cpu(dev
->descriptor
.idVendor
) == 0x23ba) &&
1143 (requesttype
& USB_TYPE_MASK
) == USB_TYPE_CLASS
)
1148 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1149 * augment the PCM format bit-field for DSD types. The UAC standards
1150 * don't have a designated bit field to denote DSD-capable interfaces,
1151 * hence all hardware that is known to support this format has to be
1154 u64
snd_usb_interface_dsd_format_quirks(struct snd_usb_audio
*chip
,
1155 struct audioformat
*fp
,
1156 unsigned int sample_bytes
)
1158 /* Playback Designs */
1159 if (le16_to_cpu(chip
->dev
->descriptor
.idVendor
) == 0x23ba) {
1160 switch (fp
->altsetting
) {
1163 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;
1165 fp
->dsd_bitrev
= true;
1166 return SNDRV_PCM_FMTBIT_DSD_U8
;
1168 fp
->dsd_bitrev
= true;
1169 return SNDRV_PCM_FMTBIT_DSD_U16_LE
;