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>
22 #include <sound/control.h>
23 #include <sound/core.h>
24 #include <sound/info.h>
25 #include <sound/pcm.h>
30 #include "mixer_quirks.h"
39 * handle the quirks for the contained interfaces
41 static int create_composite_quirk(struct snd_usb_audio
*chip
,
42 struct usb_interface
*iface
,
43 struct usb_driver
*driver
,
44 const struct snd_usb_audio_quirk
*quirk
)
46 int probed_ifnum
= get_iface_desc(iface
->altsetting
)->bInterfaceNumber
;
49 for (quirk
= quirk
->data
; quirk
->ifnum
>= 0; ++quirk
) {
50 iface
= usb_ifnum_to_if(chip
->dev
, quirk
->ifnum
);
53 if (quirk
->ifnum
!= probed_ifnum
&&
54 usb_interface_claimed(iface
))
56 err
= snd_usb_create_quirk(chip
, iface
, driver
, quirk
);
59 if (quirk
->ifnum
!= probed_ifnum
)
60 usb_driver_claim_interface(driver
, iface
, (void *)-1L);
65 static int ignore_interface_quirk(struct snd_usb_audio
*chip
,
66 struct usb_interface
*iface
,
67 struct usb_driver
*driver
,
68 const struct snd_usb_audio_quirk
*quirk
)
75 * Allow alignment on audio sub-slot (channel samples) rather than
76 * on audio slots (audio frames)
78 static int create_align_transfer_quirk(struct snd_usb_audio
*chip
,
79 struct usb_interface
*iface
,
80 struct usb_driver
*driver
,
81 const struct snd_usb_audio_quirk
*quirk
)
84 return 1; /* Continue with creating streams and mixer */
87 static int create_any_midi_quirk(struct snd_usb_audio
*chip
,
88 struct usb_interface
*intf
,
89 struct usb_driver
*driver
,
90 const struct snd_usb_audio_quirk
*quirk
)
92 return snd_usbmidi_create(chip
->card
, intf
, &chip
->midi_list
, quirk
);
96 * create a stream for an interface with proper descriptors
98 static int create_standard_audio_quirk(struct snd_usb_audio
*chip
,
99 struct usb_interface
*iface
,
100 struct usb_driver
*driver
,
101 const struct snd_usb_audio_quirk
*quirk
)
103 struct usb_host_interface
*alts
;
104 struct usb_interface_descriptor
*altsd
;
107 alts
= &iface
->altsetting
[0];
108 altsd
= get_iface_desc(alts
);
109 err
= snd_usb_parse_audio_endpoints(chip
, altsd
->bInterfaceNumber
);
111 snd_printk(KERN_ERR
"cannot setup if %d: error %d\n",
112 altsd
->bInterfaceNumber
, err
);
115 /* reset the current interface */
116 usb_set_interface(chip
->dev
, altsd
->bInterfaceNumber
, 0);
121 * create a stream for an endpoint/altsetting without proper descriptors
123 static int create_fixed_stream_quirk(struct snd_usb_audio
*chip
,
124 struct usb_interface
*iface
,
125 struct usb_driver
*driver
,
126 const struct snd_usb_audio_quirk
*quirk
)
128 struct audioformat
*fp
;
129 struct usb_host_interface
*alts
;
131 unsigned *rate_table
= NULL
;
133 fp
= kmemdup(quirk
->data
, sizeof(*fp
), GFP_KERNEL
);
135 snd_printk(KERN_ERR
"cannot memdup\n");
138 if (fp
->nr_rates
> 0) {
139 rate_table
= kmalloc(sizeof(int) * fp
->nr_rates
, GFP_KERNEL
);
144 memcpy(rate_table
, fp
->rate_table
, sizeof(int) * fp
->nr_rates
);
145 fp
->rate_table
= rate_table
;
148 stream
= (fp
->endpoint
& USB_DIR_IN
)
149 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
150 err
= snd_usb_add_audio_endpoint(chip
, stream
, fp
);
156 if (fp
->iface
!= get_iface_desc(&iface
->altsetting
[0])->bInterfaceNumber
||
157 fp
->altset_idx
>= iface
->num_altsetting
) {
162 alts
= &iface
->altsetting
[fp
->altset_idx
];
163 fp
->datainterval
= snd_usb_parse_datainterval(chip
, alts
);
164 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
165 usb_set_interface(chip
->dev
, fp
->iface
, 0);
166 snd_usb_init_pitch(chip
, fp
->iface
, alts
, fp
);
167 snd_usb_init_sample_rate(chip
, fp
->iface
, alts
, fp
, fp
->rate_max
);
172 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
173 * The only way to detect the sample rate is by looking at wMaxPacketSize.
175 static int create_uaxx_quirk(struct snd_usb_audio
*chip
,
176 struct usb_interface
*iface
,
177 struct usb_driver
*driver
,
178 const struct snd_usb_audio_quirk
*quirk
)
180 static const struct audioformat ua_format
= {
181 .formats
= SNDRV_PCM_FMTBIT_S24_3LE
,
183 .fmt_type
= UAC_FORMAT_TYPE_I
,
186 .rates
= SNDRV_PCM_RATE_CONTINUOUS
,
188 struct usb_host_interface
*alts
;
189 struct usb_interface_descriptor
*altsd
;
190 struct audioformat
*fp
;
193 /* both PCM and MIDI interfaces have 2 or more altsettings */
194 if (iface
->num_altsetting
< 2)
196 alts
= &iface
->altsetting
[1];
197 altsd
= get_iface_desc(alts
);
199 if (altsd
->bNumEndpoints
== 2) {
200 static const struct snd_usb_midi_endpoint_info ua700_ep
= {
201 .out_cables
= 0x0003,
204 static const struct snd_usb_audio_quirk ua700_quirk
= {
205 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
208 static const struct snd_usb_midi_endpoint_info uaxx_ep
= {
209 .out_cables
= 0x0001,
212 static const struct snd_usb_audio_quirk uaxx_quirk
= {
213 .type
= QUIRK_MIDI_FIXED_ENDPOINT
,
216 const struct snd_usb_audio_quirk
*quirk
=
217 chip
->usb_id
== USB_ID(0x0582, 0x002b)
218 ? &ua700_quirk
: &uaxx_quirk
;
219 return snd_usbmidi_create(chip
->card
, iface
,
220 &chip
->midi_list
, quirk
);
223 if (altsd
->bNumEndpoints
!= 1)
226 fp
= kmalloc(sizeof(*fp
), GFP_KERNEL
);
229 memcpy(fp
, &ua_format
, sizeof(*fp
));
231 fp
->iface
= altsd
->bInterfaceNumber
;
232 fp
->endpoint
= get_endpoint(alts
, 0)->bEndpointAddress
;
233 fp
->ep_attr
= get_endpoint(alts
, 0)->bmAttributes
;
234 fp
->datainterval
= 0;
235 fp
->maxpacksize
= le16_to_cpu(get_endpoint(alts
, 0)->wMaxPacketSize
);
237 switch (fp
->maxpacksize
) {
239 fp
->rate_max
= fp
->rate_min
= 44100;
243 fp
->rate_max
= fp
->rate_min
= 48000;
247 fp
->rate_max
= fp
->rate_min
= 96000;
250 snd_printk(KERN_ERR
"unknown sample rate\n");
255 stream
= (fp
->endpoint
& USB_DIR_IN
)
256 ? SNDRV_PCM_STREAM_CAPTURE
: SNDRV_PCM_STREAM_PLAYBACK
;
257 err
= snd_usb_add_audio_endpoint(chip
, stream
, fp
);
262 usb_set_interface(chip
->dev
, fp
->iface
, 0);
267 * Create a standard mixer for the specified interface.
269 static int create_standard_mixer_quirk(struct snd_usb_audio
*chip
,
270 struct usb_interface
*iface
,
271 struct usb_driver
*driver
,
272 const struct snd_usb_audio_quirk
*quirk
)
274 if (quirk
->ifnum
< 0)
277 return snd_usb_create_mixer(chip
, quirk
->ifnum
, 0);
281 * audio-interface quirks
283 * returns zero if no standard audio/MIDI parsing is needed.
284 * returns a positive value if standard audio/midi interfaces are parsed
286 * returns a negative value at error.
288 int snd_usb_create_quirk(struct snd_usb_audio
*chip
,
289 struct usb_interface
*iface
,
290 struct usb_driver
*driver
,
291 const struct snd_usb_audio_quirk
*quirk
)
293 typedef int (*quirk_func_t
)(struct snd_usb_audio
*,
294 struct usb_interface
*,
296 const struct snd_usb_audio_quirk
*);
297 static const quirk_func_t quirk_funcs
[] = {
298 [QUIRK_IGNORE_INTERFACE
] = ignore_interface_quirk
,
299 [QUIRK_COMPOSITE
] = create_composite_quirk
,
300 [QUIRK_MIDI_STANDARD_INTERFACE
] = create_any_midi_quirk
,
301 [QUIRK_MIDI_FIXED_ENDPOINT
] = create_any_midi_quirk
,
302 [QUIRK_MIDI_YAMAHA
] = create_any_midi_quirk
,
303 [QUIRK_MIDI_MIDIMAN
] = create_any_midi_quirk
,
304 [QUIRK_MIDI_NOVATION
] = create_any_midi_quirk
,
305 [QUIRK_MIDI_RAW_BYTES
] = create_any_midi_quirk
,
306 [QUIRK_MIDI_EMAGIC
] = create_any_midi_quirk
,
307 [QUIRK_MIDI_CME
] = create_any_midi_quirk
,
308 [QUIRK_MIDI_AKAI
] = create_any_midi_quirk
,
309 [QUIRK_AUDIO_STANDARD_INTERFACE
] = create_standard_audio_quirk
,
310 [QUIRK_AUDIO_FIXED_ENDPOINT
] = create_fixed_stream_quirk
,
311 [QUIRK_AUDIO_EDIROL_UAXX
] = create_uaxx_quirk
,
312 [QUIRK_AUDIO_ALIGN_TRANSFER
] = create_align_transfer_quirk
,
313 [QUIRK_AUDIO_STANDARD_MIXER
] = create_standard_mixer_quirk
,
316 if (quirk
->type
< QUIRK_TYPE_COUNT
) {
317 return quirk_funcs
[quirk
->type
](chip
, iface
, driver
, quirk
);
319 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
328 #define EXTIGY_FIRMWARE_SIZE_OLD 794
329 #define EXTIGY_FIRMWARE_SIZE_NEW 483
331 static int snd_usb_extigy_boot_quirk(struct usb_device
*dev
, struct usb_interface
*intf
)
333 struct usb_host_config
*config
= dev
->actconfig
;
336 if (le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_OLD
||
337 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
) == EXTIGY_FIRMWARE_SIZE_NEW
) {
338 snd_printdd("sending Extigy boot sequence...\n");
339 /* Send message to force it to reconnect with full interface. */
340 err
= snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
,0),
341 0x10, 0x43, 0x0001, 0x000a, NULL
, 0, 1000);
342 if (err
< 0) snd_printdd("error sending boot message: %d\n", err
);
343 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
344 &dev
->descriptor
, sizeof(dev
->descriptor
));
345 config
= dev
->actconfig
;
346 if (err
< 0) snd_printdd("error usb_get_descriptor: %d\n", err
);
347 err
= usb_reset_configuration(dev
);
348 if (err
< 0) snd_printdd("error usb_reset_configuration: %d\n", err
);
349 snd_printdd("extigy_boot: new boot length = %d\n",
350 le16_to_cpu(get_cfg_desc(config
)->wTotalLength
));
351 return -ENODEV
; /* quit this anyway */
356 static int snd_usb_audigy2nx_boot_quirk(struct usb_device
*dev
)
360 snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), 0x2a,
361 USB_DIR_IN
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
362 0, 0, &buf
, 1, 1000);
364 snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), 0x29,
365 USB_DIR_OUT
| USB_TYPE_VENDOR
| USB_RECIP_OTHER
,
366 1, 2000, NULL
, 0, 1000);
373 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
374 * documented in the device's data sheet.
376 static int snd_usb_cm106_write_int_reg(struct usb_device
*dev
, int reg
, u16 value
)
380 buf
[1] = value
& 0xff;
381 buf
[2] = (value
>> 8) & 0xff;
383 return snd_usb_ctl_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_CONFIGURATION
,
384 USB_DIR_OUT
| USB_TYPE_CLASS
| USB_RECIP_ENDPOINT
,
385 0, 0, &buf
, 4, 1000);
388 static int snd_usb_cm106_boot_quirk(struct usb_device
*dev
)
391 * Enable line-out driver mode, set headphone source to front
392 * channels, enable stereo mic.
394 return snd_usb_cm106_write_int_reg(dev
, 2, 0x8004);
398 * C-Media CM6206 is based on CM106 with two additional
399 * registers that are not documented in the data sheet.
400 * Values here are chosen based on sniffing USB traffic
403 static int snd_usb_cm6206_boot_quirk(struct usb_device
*dev
)
406 int val
[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
408 for (reg
= 0; reg
< ARRAY_SIZE(val
); reg
++) {
409 err
= snd_usb_cm106_write_int_reg(dev
, reg
, val
[reg
]);
418 * This call will put the synth in "USB send" mode, i.e it will send MIDI
419 * messages through USB (this is disabled at startup). The synth will
420 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
421 * sign on its LCD. Values here are chosen based on sniffing USB traffic
424 static int snd_usb_accessmusic_boot_quirk(struct usb_device
*dev
)
426 int err
, actual_length
;
428 /* "midi send" enable */
429 static const u8 seq
[] = { 0x4e, 0x73, 0x52, 0x01 };
431 void *buf
= kmemdup(seq
, ARRAY_SIZE(seq
), GFP_KERNEL
);
434 err
= usb_interrupt_msg(dev
, usb_sndintpipe(dev
, 0x05), buf
,
435 ARRAY_SIZE(seq
), &actual_length
, 1000);
444 * Some sound cards from Native Instruments are in fact compliant to the USB
445 * audio standard of version 2 and other approved USB standards, even though
446 * they come up as vendor-specific device when first connected.
448 * However, they can be told to come up with a new set of descriptors
449 * upon their next enumeration, and the interfaces announced by the new
450 * descriptors will then be handled by the kernel's class drivers. As the
451 * product ID will also change, no further checks are required.
454 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device
*dev
)
456 int ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
457 0xaf, USB_TYPE_VENDOR
| USB_RECIP_DEVICE
,
458 cpu_to_le16(1), 0, NULL
, 0, 1000);
463 usb_reset_device(dev
);
465 /* return -EAGAIN, so the creation of an audio interface for this
466 * temporary device is aborted. The device will reconnect with a
474 #define AUDIOPHILE_SET 0x01 /* if set, parse device_setup */
475 #define AUDIOPHILE_SET_DTS 0x02 /* if set, enable DTS Digital Output */
476 #define AUDIOPHILE_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
477 #define AUDIOPHILE_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
478 #define AUDIOPHILE_SET_DI 0x10 /* if set, enable Digital Input */
479 #define AUDIOPHILE_SET_MASK 0x1F /* bit mask for setup value */
480 #define AUDIOPHILE_SET_24B_48K_DI 0x19 /* value for 24bits+48KHz+Digital Input */
481 #define AUDIOPHILE_SET_24B_48K_NOTDI 0x09 /* value for 24bits+48KHz+No Digital Input */
482 #define AUDIOPHILE_SET_16B_48K_DI 0x11 /* value for 16bits+48KHz+Digital Input */
483 #define AUDIOPHILE_SET_16B_48K_NOTDI 0x01 /* value for 16bits+48KHz+No Digital Input */
485 static int audiophile_skip_setting_quirk(struct snd_usb_audio
*chip
,
489 /* Reset ALL ifaces to 0 altsetting.
490 * Call it for every possible altsetting of every interface.
492 usb_set_interface(chip
->dev
, iface
, 0);
494 if (chip
->setup
& AUDIOPHILE_SET
) {
495 if ((chip
->setup
& AUDIOPHILE_SET_DTS
)
497 return 1; /* skip this altsetting */
498 if ((chip
->setup
& AUDIOPHILE_SET_96K
)
500 return 1; /* skip this altsetting */
501 if ((chip
->setup
& AUDIOPHILE_SET_MASK
) ==
502 AUDIOPHILE_SET_24B_48K_DI
&& altno
!= 2)
503 return 1; /* skip this altsetting */
504 if ((chip
->setup
& AUDIOPHILE_SET_MASK
) ==
505 AUDIOPHILE_SET_24B_48K_NOTDI
&& altno
!= 3)
506 return 1; /* skip this altsetting */
507 if ((chip
->setup
& AUDIOPHILE_SET_MASK
) ==
508 AUDIOPHILE_SET_16B_48K_DI
&& altno
!= 4)
509 return 1; /* skip this altsetting */
510 if ((chip
->setup
& AUDIOPHILE_SET_MASK
) ==
511 AUDIOPHILE_SET_16B_48K_NOTDI
&& altno
!= 5)
512 return 1; /* skip this altsetting */
515 return 0; /* keep this altsetting */
518 int snd_usb_apply_interface_quirk(struct snd_usb_audio
*chip
,
522 /* audiophile usb: skip altsets incompatible with device_setup */
523 if (chip
->usb_id
== USB_ID(0x0763, 0x2003))
524 return audiophile_skip_setting_quirk(chip
, iface
, altno
);
529 int snd_usb_apply_boot_quirk(struct usb_device
*dev
,
530 struct usb_interface
*intf
,
531 const struct snd_usb_audio_quirk
*quirk
)
533 u32 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
534 le16_to_cpu(dev
->descriptor
.idProduct
));
537 case USB_ID(0x041e, 0x3000):
538 /* SB Extigy needs special boot-up sequence */
539 /* if more models come, this will go to the quirk list. */
540 return snd_usb_extigy_boot_quirk(dev
, intf
);
542 case USB_ID(0x041e, 0x3020):
543 /* SB Audigy 2 NX needs its own boot-up magic, too */
544 return snd_usb_audigy2nx_boot_quirk(dev
);
546 case USB_ID(0x10f5, 0x0200):
547 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
548 return snd_usb_cm106_boot_quirk(dev
);
550 case USB_ID(0x0d8c, 0x0102):
551 /* C-Media CM6206 / CM106-Like Sound Device */
552 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
553 return snd_usb_cm6206_boot_quirk(dev
);
555 case USB_ID(0x133e, 0x0815):
556 /* Access Music VirusTI Desktop */
557 return snd_usb_accessmusic_boot_quirk(dev
);
559 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
560 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
561 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
562 return snd_usb_nativeinstruments_boot_quirk(dev
);
569 * check if the device uses big-endian samples
571 int snd_usb_is_big_endian_format(struct snd_usb_audio
*chip
, struct audioformat
*fp
)
573 switch (chip
->usb_id
) {
574 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
575 if (fp
->endpoint
& USB_DIR_IN
)
578 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
579 if (chip
->setup
== 0x00 ||
580 fp
->altsetting
==1 || fp
->altsetting
==2 || fp
->altsetting
==3)
587 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
592 EMU_QUIRK_SR_44100HZ
= 0,
593 EMU_QUIRK_SR_48000HZ
,
594 EMU_QUIRK_SR_88200HZ
,
595 EMU_QUIRK_SR_96000HZ
,
596 EMU_QUIRK_SR_176400HZ
,
597 EMU_QUIRK_SR_192000HZ
600 static void set_format_emu_quirk(struct snd_usb_substream
*subs
,
601 struct audioformat
*fmt
)
603 unsigned char emu_samplerate_id
= 0;
605 /* When capture is active
606 * sample rate shouldn't be changed
607 * by playback substream
609 if (subs
->direction
== SNDRV_PCM_STREAM_PLAYBACK
) {
610 if (subs
->stream
->substream
[SNDRV_PCM_STREAM_CAPTURE
].interface
!= -1)
614 switch (fmt
->rate_min
) {
616 emu_samplerate_id
= EMU_QUIRK_SR_48000HZ
;
619 emu_samplerate_id
= EMU_QUIRK_SR_88200HZ
;
622 emu_samplerate_id
= EMU_QUIRK_SR_96000HZ
;
625 emu_samplerate_id
= EMU_QUIRK_SR_176400HZ
;
628 emu_samplerate_id
= EMU_QUIRK_SR_192000HZ
;
631 emu_samplerate_id
= EMU_QUIRK_SR_44100HZ
;
634 snd_emuusb_set_samplerate(subs
->stream
->chip
, emu_samplerate_id
);
637 void snd_usb_set_format_quirk(struct snd_usb_substream
*subs
,
638 struct audioformat
*fmt
)
640 switch (subs
->stream
->chip
->usb_id
) {
641 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
642 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
643 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
644 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
645 set_format_emu_quirk(subs
, fmt
);