projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: usb-audio: Add support for Creative BT-D1 via usb sound quirks
[linux-2.6-block.git] / sound / usb / quirks.c
CommitLineData
e5779998
DM		 1/*
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.
6 *
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.
11 *
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
15 */
16
17#include <linux/init.h>
36db0456 18#include <linux/slab.h>
e5779998
DM		 19#include <linux/usb.h>
20#include <linux/usb/audio.h>
21
9e38658f 22#include <sound/control.h>
e5779998
DM		 23#include <sound/core.h>
24#include <sound/info.h>
25#include <sound/pcm.h>
26
27#include "usbaudio.h"
28#include "card.h"
f0b5e634 29#include "mixer.h"
7b1eda22 30#include "mixer_quirks.h"
e5779998
DM		 31#include "midi.h"
32#include "quirks.h"
33#include "helper.h"
34#include "endpoint.h"
35#include "pcm.h"
3d8d4dcf 36#include "clock.h"
e8e8babf 37#include "stream.h"
e5779998
DM		 38
39/*
40 * handle the quirks for the contained interfaces
41 */
42static int create_composite_quirk(struct snd_usb_audio *chip,
43 struct usb_interface *iface,
44 struct usb_driver *driver,
45 const struct snd_usb_audio_quirk *quirk)
46{
47 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
48 int err;
49
50 for (quirk = quirk->data; quirk->ifnum >= 0; ++quirk) {
51 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
52 if (!iface)
53 continue;
54 if (quirk->ifnum != probed_ifnum &&
55 usb_interface_claimed(iface))
56 continue;
57 err = snd_usb_create_quirk(chip, iface, driver, quirk);
58 if (err < 0)
59 return err;
60 if (quirk->ifnum != probed_ifnum)
61 usb_driver_claim_interface(driver, iface, (void *)-1L);
62 }
63 return 0;
64}
65
66static int ignore_interface_quirk(struct snd_usb_audio *chip,
67 struct usb_interface *iface,
68 struct usb_driver *driver,
69 const struct snd_usb_audio_quirk *quirk)
70{
71 return 0;
72}
73
74
75/*
76 * Allow alignment on audio sub-slot (channel samples) rather than
77 * on audio slots (audio frames)
78 */
79static int create_align_transfer_quirk(struct snd_usb_audio *chip,
80 struct usb_interface *iface,
81 struct usb_driver *driver,
82 const struct snd_usb_audio_quirk *quirk)
83{
84 chip->txfr_quirk = 1;
85 return 1; /* Continue with creating streams and mixer */
86}
87
88static int create_any_midi_quirk(struct snd_usb_audio *chip,
89 struct usb_interface *intf,
90 struct usb_driver *driver,
91 const struct snd_usb_audio_quirk *quirk)
92{
93 return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
94}
95
96/*
97 * create a stream for an interface with proper descriptors
98 */
99static int create_standard_audio_quirk(struct snd_usb_audio *chip,
100 struct usb_interface *iface,
101 struct usb_driver *driver,
102 const struct snd_usb_audio_quirk *quirk)
103{
104 struct usb_host_interface *alts;
105 struct usb_interface_descriptor *altsd;
106 int err;
107
108 alts = &iface->altsetting[0];
109 altsd = get_iface_desc(alts);
e8e8babf 110 err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
e5779998
DM		 111 if (err < 0) {
112 snd_printk(KERN_ERR "cannot setup if %d: error %d\n",
113 altsd->bInterfaceNumber, err);
114 return err;
115 }
116 /* reset the current interface */
117 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
118 return 0;
119}
120
121/*
122 * create a stream for an endpoint/altsetting without proper descriptors
123 */
124static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
125 struct usb_interface *iface,
126 struct usb_driver *driver,
127 const struct snd_usb_audio_quirk *quirk)
128{
129 struct audioformat *fp;
130 struct usb_host_interface *alts;
131 int stream, err;
132 unsigned *rate_table = NULL;
133
134 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
8866f405 135 if (!fp) {
e5779998
DM		 136 snd_printk(KERN_ERR "cannot memdup\n");
137 return -ENOMEM;
138 }
8866f405
XW		 139 if (fp->nr_rates > MAX_NR_RATES) {
140 kfree(fp);
141 return -EINVAL;
142 }
e5779998 143 if (fp->nr_rates > 0) {
43df2a57
TM		 144 rate_table = kmemdup(fp->rate_table,
145 sizeof(int) * fp->nr_rates, GFP_KERNEL);
e5779998
DM		 146 if (!rate_table) {
147 kfree(fp);
148 return -ENOMEM;
149 }
e5779998
DM		 150 fp->rate_table = rate_table;
151 }
152
153 stream = (fp->endpoint & USB_DIR_IN)
154 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
e8e8babf 155 err = snd_usb_add_audio_stream(chip, stream, fp);
e5779998
DM		 156 if (err < 0) {
157 kfree(fp);
158 kfree(rate_table);
159 return err;
160 }
161 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
162 fp->altset_idx >= iface->num_altsetting) {
163 kfree(fp);
164 kfree(rate_table);
165 return -EINVAL;
166 }
167 alts = &iface->altsetting[fp->altset_idx];
168 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
169 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
170 usb_set_interface(chip->dev, fp->iface, 0);
767d75ad
DM		 171 snd_usb_init_pitch(chip, fp->iface, alts, fp);
172 snd_usb_init_sample_rate(chip, fp->iface, alts, fp, fp->rate_max);
e5779998
DM		 173 return 0;
174}
175
176/*
177 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
178 * The only way to detect the sample rate is by looking at wMaxPacketSize.
179 */
180static int create_uaxx_quirk(struct snd_usb_audio *chip,
181 struct usb_interface *iface,
182 struct usb_driver *driver,
183 const struct snd_usb_audio_quirk *quirk)
184{
185 static const struct audioformat ua_format = {
015eb0b0 186 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
e5779998
DM		 187 .channels = 2,
188 .fmt_type = UAC_FORMAT_TYPE_I,
189 .altsetting = 1,
190 .altset_idx = 1,
191 .rates = SNDRV_PCM_RATE_CONTINUOUS,
192 };
193 struct usb_host_interface *alts;
194 struct usb_interface_descriptor *altsd;
195 struct audioformat *fp;
196 int stream, err;
197
198 /* both PCM and MIDI interfaces have 2 or more altsettings */
199 if (iface->num_altsetting < 2)
200 return -ENXIO;
201 alts = &iface->altsetting[1];
202 altsd = get_iface_desc(alts);
203
204 if (altsd->bNumEndpoints == 2) {
205 static const struct snd_usb_midi_endpoint_info ua700_ep = {
206 .out_cables = 0x0003,
207 .in_cables = 0x0003
208 };
209 static const struct snd_usb_audio_quirk ua700_quirk = {
210 .type = QUIRK_MIDI_FIXED_ENDPOINT,
211 .data = &ua700_ep
212 };
213 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
214 .out_cables = 0x0001,
215 .in_cables = 0x0001
216 };
217 static const struct snd_usb_audio_quirk uaxx_quirk = {
218 .type = QUIRK_MIDI_FIXED_ENDPOINT,
219 .data = &uaxx_ep
220 };
221 const struct snd_usb_audio_quirk *quirk =
222 chip->usb_id == USB_ID(0x0582, 0x002b)
223 ? &ua700_quirk : &uaxx_quirk;
224 return snd_usbmidi_create(chip->card, iface,
225 &chip->midi_list, quirk);
226 }
227
228 if (altsd->bNumEndpoints != 1)
229 return -ENXIO;
230
43df2a57 231 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
e5779998
DM		 232 if (!fp)
233 return -ENOMEM;
e5779998
DM		 234
235 fp->iface = altsd->bInterfaceNumber;
236 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
237 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
238 fp->datainterval = 0;
239 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
240
241 switch (fp->maxpacksize) {
242 case 0x120:
243 fp->rate_max = fp->rate_min = 44100;
244 break;
245 case 0x138:
246 case 0x140:
247 fp->rate_max = fp->rate_min = 48000;
248 break;
249 case 0x258:
250 case 0x260:
251 fp->rate_max = fp->rate_min = 96000;
252 break;
253 default:
254 snd_printk(KERN_ERR "unknown sample rate\n");
255 kfree(fp);
256 return -ENXIO;
257 }
258
259 stream = (fp->endpoint & USB_DIR_IN)
260 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
e8e8babf 261 err = snd_usb_add_audio_stream(chip, stream, fp);
e5779998
DM		 262 if (err < 0) {
263 kfree(fp);
264 return err;
265 }
266 usb_set_interface(chip->dev, fp->iface, 0);
267 return 0;
268}
269
014950b0
DM		 270/*
271 * Create a standard mixer for the specified interface.
272 */
273static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
274 struct usb_interface *iface,
275 struct usb_driver *driver,
276 const struct snd_usb_audio_quirk *quirk)
277{
278 if (quirk->ifnum < 0)
279 return 0;
280
281 return snd_usb_create_mixer(chip, quirk->ifnum, 0);
282}
283
e5779998
DM		 284/*
285 * audio-interface quirks
286 *
287 * returns zero if no standard audio/MIDI parsing is needed.
25985edc 288 * returns a positive value if standard audio/midi interfaces are parsed
e5779998
DM		 289 * after this.
290 * returns a negative value at error.
291 */
292int snd_usb_create_quirk(struct snd_usb_audio *chip,
293 struct usb_interface *iface,
294 struct usb_driver *driver,
295 const struct snd_usb_audio_quirk *quirk)
296{
297 typedef int (*quirk_func_t)(struct snd_usb_audio *,
298 struct usb_interface *,
299 struct usb_driver *,
300 const struct snd_usb_audio_quirk *);
301 static const quirk_func_t quirk_funcs[] = {
302 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
303 [QUIRK_COMPOSITE] = create_composite_quirk,
304 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
305 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
306 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
307 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
308 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
cb99864d 309 [QUIRK_MIDI_MBOX2] = create_any_midi_quirk,
c7f57216 310 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
e5779998
DM		 311 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
312 [QUIRK_MIDI_CME] = create_any_midi_quirk,
4434ade8 313 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
1ef0e0a0 314 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
e5779998
DM		 315 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
316 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
317 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
014950b0
DM		 318 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
319 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
e5779998
DM		 320 };
321
322 if (quirk->type < QUIRK_TYPE_COUNT) {
323 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
324 } else {
325 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
326 return -ENXIO;
327 }
328}
329
330/*
331 * boot quirks
332 */
333
334#define EXTIGY_FIRMWARE_SIZE_OLD 794
335#define EXTIGY_FIRMWARE_SIZE_NEW 483
336
337static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
338{
339 struct usb_host_config *config = dev->actconfig;
340 int err;
341
342 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
343 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
344 snd_printdd("sending Extigy boot sequence...\n");
345 /* Send message to force it to reconnect with full interface. */
346 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
17d900c4 347 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
e5779998
DM		 348 if (err < 0) snd_printdd("error sending boot message: %d\n", err);
349 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
350 &dev->descriptor, sizeof(dev->descriptor));
351 config = dev->actconfig;
352 if (err < 0) snd_printdd("error usb_get_descriptor: %d\n", err);
353 err = usb_reset_configuration(dev);
354 if (err < 0) snd_printdd("error usb_reset_configuration: %d\n", err);
355 snd_printdd("extigy_boot: new boot length = %d\n",
356 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
357 return -ENODEV; /* quit this anyway */
358 }
359 return 0;
360}
361
362static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
363{
364 u8 buf = 1;
365
366 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
367 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
17d900c4 368 0, 0, &buf, 1);
e5779998
DM		 369 if (buf == 0) {
370 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
371 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
17d900c4 372 1, 2000, NULL, 0);
e5779998
DM		 373 return -ENODEV;
374 }
375 return 0;
376}
377
0f5733b0
GP		 378static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
379{
380 int err;
381
382 if (dev->actconfig->desc.bConfigurationValue == 1) {
383 snd_printk(KERN_INFO "usb-audio: "
384 "Fast Track Pro switching to config #2\n");
385 /* This function has to be available by the usb core module.
386 * if it is not avialable the boot quirk has to be left out
387 * and the configuration has to be set by udev or hotplug
388 * rules
389 */
390 err = usb_driver_set_configuration(dev, 2);
391 if (err < 0) {
392 snd_printdd("error usb_driver_set_configuration: %d\n",
393 err);
394 return -ENODEV;
395 }
396 } else
397 snd_printk(KERN_INFO "usb-audio: Fast Track Pro config OK\n");
398
399 return 0;
400}
401
e5779998
DM		 402/*
403 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
404 * documented in the device's data sheet.
405 */
406static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
407{
408 u8 buf[4];
409 buf[0] = 0x20;
410 buf[1] = value & 0xff;
411 buf[2] = (value >> 8) & 0xff;
412 buf[3] = reg;
413 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
414 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
17d900c4 415 0, 0, &buf, 4);
e5779998
DM		 416}
417
418static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
419{
420 /*
421 * Enable line-out driver mode, set headphone source to front
422 * channels, enable stereo mic.
423 */
424 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
425}
426
427/*
428 * C-Media CM6206 is based on CM106 with two additional
429 * registers that are not documented in the data sheet.
430 * Values here are chosen based on sniffing USB traffic
431 * under Windows.
432 */
433static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
434{
dac8f847 435 int err = 0, reg;
157186bc 436 int val[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
e5779998
DM		 437
438 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
439 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
440 if (err < 0)
441 return err;
442 }
443
444 return err;
445}
446
447/*
448 * This call will put the synth in "USB send" mode, i.e it will send MIDI
449 * messages through USB (this is disabled at startup). The synth will
450 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
451 * sign on its LCD. Values here are chosen based on sniffing USB traffic
452 * under Windows.
453 */
454static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
455{
456 int err, actual_length;
457
458 /* "midi send" enable */
459 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
460
461 void *buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
462 if (!buf)
463 return -ENOMEM;
464 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
465 ARRAY_SIZE(seq), &actual_length, 1000);
466 kfree(buf);
467 if (err < 0)
468 return err;
469
470 return 0;
471}
472
54a8c500
DM		 473/*
474 * Some sound cards from Native Instruments are in fact compliant to the USB
475 * audio standard of version 2 and other approved USB standards, even though
476 * they come up as vendor-specific device when first connected.
477 *
478 * However, they can be told to come up with a new set of descriptors
479 * upon their next enumeration, and the interfaces announced by the new
480 * descriptors will then be handled by the kernel's class drivers. As the
481 * product ID will also change, no further checks are required.
482 */
483
484static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
485{
486 int ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
487 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
488 cpu_to_le16(1), 0, NULL, 0, 1000);
489
490 if (ret < 0)
491 return ret;
492
493 usb_reset_device(dev);
494
495 /* return -EAGAIN, so the creation of an audio interface for this
496 * temporary device is aborted. The device will reconnect with a
497 * new product ID */
498 return -EAGAIN;
499}
500
cb99864d
DZ		 501static void mbox2_setup_48_24_magic(struct usb_device *dev)
502{
503 u8 srate[3];
504 u8 temp[12];
505
506 /* Choose 48000Hz permanently */
507 srate[0] = 0x80;
508 srate[1] = 0xbb;
509 srate[2] = 0x00;
510
511 /* Send the magic! */
512 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
513 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
514 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
515 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
516 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
517 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
518 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
519 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
520 return;
521}
522
523/* Digidesign Mbox 2 needs to load firmware onboard
524 * and driver must wait a few seconds for initialisation.
525 */
526
527#define MBOX2_FIRMWARE_SIZE 646
528#define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
529#define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
530
531int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
532{
533 struct usb_host_config *config = dev->actconfig;
534 int err;
535 u8 bootresponse;
536 int fwsize;
537 int count;
538
539 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
540
541 if (fwsize != MBOX2_FIRMWARE_SIZE) {
542 snd_printk(KERN_ERR "usb-audio: Invalid firmware size=%d.\n", fwsize);
543 return -ENODEV;
544 }
545
546 snd_printd("usb-audio: Sending Digidesign Mbox 2 boot sequence...\n");
547
548 count = 0;
549 bootresponse = MBOX2_BOOT_LOADING;
550 while ((bootresponse == MBOX2_BOOT_LOADING) && (count < 10)) {
551 msleep(500); /* 0.5 second delay */
552 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
553 /* Control magic - load onboard firmware */
554 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
555 if (bootresponse == MBOX2_BOOT_READY)
556 break;
557 snd_printd("usb-audio: device not ready, resending boot sequence...\n");
558 count++;
559 }
560
561 if (bootresponse != MBOX2_BOOT_READY) {
562 snd_printk(KERN_ERR "usb-audio: Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse);
563 return -ENODEV;
564 }
565
566 snd_printdd("usb-audio: device initialised!\n");
567
568 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
569 &dev->descriptor, sizeof(dev->descriptor));
570 config = dev->actconfig;
571 if (err < 0)
572 snd_printd("error usb_get_descriptor: %d\n", err);
573
574 err = usb_reset_configuration(dev);
575 if (err < 0)
576 snd_printd("error usb_reset_configuration: %d\n", err);
577 snd_printdd("mbox2_boot: new boot length = %d\n",
578 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
579
580 mbox2_setup_48_24_magic(dev);
581
582 snd_printk(KERN_INFO "usb-audio: Digidesign Mbox 2: 24bit 48kHz");
583
584 return 0; /* Successful boot */
585}
586
e5779998
DM		 587/*
588 * Setup quirks
589 */
0f5733b0
GP		 590#define MAUDIO_SET 0x01 /* parse device_setup */
591#define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
592#define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
593#define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
594#define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
595#define MAUDIO_SET_DI 0x10 /* enable Digital Input */
596#define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
597#define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
598#define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
599#define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
600#define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
601
602static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
603 int iface, int altno)
604{
605 /* Reset ALL ifaces to 0 altsetting.
606 * Call it for every possible altsetting of every interface.
607 */
608 usb_set_interface(chip->dev, iface, 0);
609 if (chip->setup & MAUDIO_SET) {
610 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
611 if (iface != 1 && iface != 2)
612 return 1; /* skip all interfaces but 1 and 2 */
613 } else {
614 unsigned int mask;
615 if (iface == 1 || iface == 2)
616 return 1; /* skip interfaces 1 and 2 */
617 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
618 return 1; /* skip this altsetting */
619 mask = chip->setup & MAUDIO_SET_MASK;
620 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
621 return 1; /* skip this altsetting */
622 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
623 return 1; /* skip this altsetting */
624 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
625 return 1; /* skip this altsetting */
626 }
627 }
628 snd_printdd(KERN_INFO
629 "using altsetting %d for interface %d config %d\n",
630 altno, iface, chip->setup);
631 return 0; /* keep this altsetting */
632}
e5779998
DM		 633
634static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
635 int iface,
636 int altno)
637{
638 /* Reset ALL ifaces to 0 altsetting.
639 * Call it for every possible altsetting of every interface.
640 */
641 usb_set_interface(chip->dev, iface, 0);
642
0f5733b0
GP		 643 if (chip->setup & MAUDIO_SET) {
644 unsigned int mask;
645 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
e5779998 646 return 1; /* skip this altsetting */
0f5733b0 647 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
e5779998 648 return 1; /* skip this altsetting */
0f5733b0
GP		 649 mask = chip->setup & MAUDIO_SET_MASK;
650 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
e5779998 651 return 1; /* skip this altsetting */
0f5733b0 652 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
e5779998 653 return 1; /* skip this altsetting */
0f5733b0 654 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
e5779998 655 return 1; /* skip this altsetting */
0f5733b0 656 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
e5779998
DM		 657 return 1; /* skip this altsetting */
658 }
659
660 return 0; /* keep this altsetting */
661}
662
0f5733b0
GP		 663
664static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
665 int iface, int altno)
666{
667 /* Reset ALL ifaces to 0 altsetting.
668 * Call it for every possible altsetting of every interface.
669 */
670 usb_set_interface(chip->dev, iface, 0);
671
672 /* possible configuration where both inputs and only one output is
673 *used is not supported by the current setup
674 */
675 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
676 if (chip->setup & MAUDIO_SET_96K) {
677 if (altno != 3 && altno != 6)
678 return 1;
679 } else if (chip->setup & MAUDIO_SET_DI) {
680 if (iface == 4)
681 return 1; /* no analog input */
682 if (altno != 2 && altno != 5)
683 return 1; /* enable only altsets 2 and 5 */
684 } else {
685 if (iface == 5)
686 return 1; /* disable digialt input */
687 if (altno != 2 && altno != 5)
688 return 1; /* enalbe only altsets 2 and 5 */
689 }
690 } else {
691 /* keep only 16-Bit mode */
692 if (altno != 1)
693 return 1;
694 }
695
696 snd_printdd(KERN_INFO
697 "using altsetting %d for interface %d config %d\n",
698 altno, iface, chip->setup);
699 return 0; /* keep this altsetting */
700}
701
e5779998
DM		 702int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
703 int iface,
704 int altno)
705{
706 /* audiophile usb: skip altsets incompatible with device_setup */
707 if (chip->usb_id == USB_ID(0x0763, 0x2003))
708 return audiophile_skip_setting_quirk(chip, iface, altno);
0f5733b0
GP		 709 /* quattro usb: skip altsets incompatible with device_setup */
710 if (chip->usb_id == USB_ID(0x0763, 0x2001))
711 return quattro_skip_setting_quirk(chip, iface, altno);
712 /* fasttrackpro usb: skip altsets incompatible with device_setup */
713 if (chip->usb_id == USB_ID(0x0763, 0x2012))
714 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
e5779998
DM		 715
716 return 0;
717}
718
719int snd_usb_apply_boot_quirk(struct usb_device *dev,
720 struct usb_interface *intf,
721 const struct snd_usb_audio_quirk *quirk)
722{
723 u32 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
724 le16_to_cpu(dev->descriptor.idProduct));
725
3347b26c
DM		 726 switch (id) {
727 case USB_ID(0x041e, 0x3000):
728 /* SB Extigy needs special boot-up sequence */
729 /* if more models come, this will go to the quirk list. */
e5779998
DM		 730 return snd_usb_extigy_boot_quirk(dev, intf);
731
3347b26c
DM		 732 case USB_ID(0x041e, 0x3020):
733 /* SB Audigy 2 NX needs its own boot-up magic, too */
e5779998
DM		 734 return snd_usb_audigy2nx_boot_quirk(dev);
735
3347b26c
DM		 736 case USB_ID(0x10f5, 0x0200):
737 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
e5779998
DM		 738 return snd_usb_cm106_boot_quirk(dev);
739
3347b26c
DM		 740 case USB_ID(0x0d8c, 0x0102):
741 /* C-Media CM6206 / CM106-Like Sound Device */
8129e79e 742 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
e5779998
DM		 743 return snd_usb_cm6206_boot_quirk(dev);
744
cb99864d
DZ		 745 case USB_ID(0x0dba, 0x3000):
746 /* Digidesign Mbox 2 */
747 return snd_usb_mbox2_boot_quirk(dev);
748
3347b26c
DM		 749 case USB_ID(0x133e, 0x0815):
750 /* Access Music VirusTI Desktop */
e5779998
DM		 751 return snd_usb_accessmusic_boot_quirk(dev);
752
759e890f 753 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
3347b26c
DM		 754 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
755 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
54a8c500 756 return snd_usb_nativeinstruments_boot_quirk(dev);
0f5733b0
GP		 757 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
758 return snd_usb_fasttrackpro_boot_quirk(dev);
3347b26c 759 }
54a8c500 760
e5779998
DM		 761 return 0;
762}
763
764/*
765 * check if the device uses big-endian samples
766 */
767int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
768{
48fc7f7e 769 /* it depends on altsetting whether the device is big-endian or not */
e5779998
DM		 770 switch (chip->usb_id) {
771 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
0f5733b0
GP		 772 if (fp->altsetting == 2 || fp->altsetting == 3 ||
773 fp->altsetting == 5 || fp->altsetting == 6)
e5779998
DM		 774 return 1;
775 break;
776 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
777 if (chip->setup == 0x00 ||
0f5733b0
GP		 778 fp->altsetting == 1 || fp->altsetting == 2 ||
779 fp->altsetting == 3)
780 return 1;
781 break;
782 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
783 if (fp->altsetting == 2 || fp->altsetting == 3 ||
784 fp->altsetting == 5 || fp->altsetting == 6)
e5779998 785 return 1;
0f5733b0 786 break;
e5779998
DM		 787 }
788 return 0;
789}
790
791/*
1cdfa9f3 792 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
e5779998
DM		 793 * not for interface.
794 */
795
796enum {
797 EMU_QUIRK_SR_44100HZ = 0,
798 EMU_QUIRK_SR_48000HZ,
799 EMU_QUIRK_SR_88200HZ,
800 EMU_QUIRK_SR_96000HZ,
801 EMU_QUIRK_SR_176400HZ,
802 EMU_QUIRK_SR_192000HZ
803};
804
805static void set_format_emu_quirk(struct snd_usb_substream *subs,
806 struct audioformat *fmt)
807{
808 unsigned char emu_samplerate_id = 0;
809
810 /* When capture is active
811 * sample rate shouldn't be changed
812 * by playback substream
813 */
814 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
815 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
816 return;
817 }
818
819 switch (fmt->rate_min) {
820 case 48000:
821 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
822 break;
823 case 88200:
824 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
825 break;
826 case 96000:
827 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
828 break;
829 case 176400:
830 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
831 break;
832 case 192000:
833 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
834 break;
835 default:
836 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
837 break;
838 }
839 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
840}
841
842void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
843 struct audioformat *fmt)
844{
845 switch (subs->stream->chip->usb_id) {
846 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
847 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
848 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1cdfa9f3 849 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
e5779998
DM		 850 set_format_emu_quirk(subs, fmt);
851 break;
852 }
853}
854
2b58fd5b
DM		 855void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
856{
857 /*
858 * "Playback Design" products send bogus feedback data at the start
859 * of the stream. Ignore them.
860 */
861 if ((le16_to_cpu(ep->chip->dev->descriptor.idVendor) == 0x23ba) &&
862 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
863 ep->skip_packets = 4;
864}
865
866void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
867 __u8 request, __u8 requesttype, __u16 value,
868 __u16 index, void *data, __u16 size)
869{
870 /*
871 * "Playback Design" products need a 20ms delay after each
872 * class compliant request
873 */
874 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x23ba) &&
875 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
876 mdelay(20);
877}
878
Linux 6.x block layer and io_uring tree(s)