projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: oxfw: add an comment to Kconfig for TASCAM FireOne
[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>
aafe77cc 21#include <linux/usb/midi.h>
e5779998 22
9e38658f 23#include <sound/control.h>
e5779998
DM		 24#include <sound/core.h>
25#include <sound/info.h>
26#include <sound/pcm.h>
27
28#include "usbaudio.h"
29#include "card.h"
f0b5e634 30#include "mixer.h"
7b1eda22 31#include "mixer_quirks.h"
e5779998
DM		 32#include "midi.h"
33#include "quirks.h"
34#include "helper.h"
35#include "endpoint.h"
36#include "pcm.h"
3d8d4dcf 37#include "clock.h"
e8e8babf 38#include "stream.h"
e5779998
DM		 39
40/*
41 * handle the quirks for the contained interfaces
42 */
43static int create_composite_quirk(struct snd_usb_audio *chip,
44 struct usb_interface *iface,
45 struct usb_driver *driver,
85a81813 46 const struct snd_usb_audio_quirk *quirk_comp)
e5779998
DM		 47{
48 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
85a81813 49 const struct snd_usb_audio_quirk *quirk;
e5779998
DM		 50 int err;
51
85a81813 52 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
e5779998
DM		 53 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
54 if (!iface)
55 continue;
56 if (quirk->ifnum != probed_ifnum &&
57 usb_interface_claimed(iface))
58 continue;
59 err = snd_usb_create_quirk(chip, iface, driver, quirk);
60 if (err < 0)
61 return err;
d4b8fc66
TI		 62 }
63
85a81813 64 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
d4b8fc66
TI		 65 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
66 if (!iface)
67 continue;
68 if (quirk->ifnum != probed_ifnum &&
69 !usb_interface_claimed(iface))
e5779998
DM		 70 usb_driver_claim_interface(driver, iface, (void *)-1L);
71 }
d4b8fc66 72
e5779998
DM		 73 return 0;
74}
75
76static 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)
80{
81 return 0;
82}
83
84
85/*
86 * Allow alignment on audio sub-slot (channel samples) rather than
87 * on audio slots (audio frames)
88 */
89static 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)
93{
94 chip->txfr_quirk = 1;
95 return 1; /* Continue with creating streams and mixer */
96}
97
98static 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)
102{
103 return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
104}
105
106/*
107 * create a stream for an interface with proper descriptors
108 */
109static 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)
113{
114 struct usb_host_interface *alts;
115 struct usb_interface_descriptor *altsd;
116 int err;
117
e0570446
RW		 118 if (chip->usb_id == USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
119 chip->tx_length_quirk = 1;
120
e5779998
DM		 121 alts = &iface->altsetting[0];
122 altsd = get_iface_desc(alts);
e8e8babf 123 err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
e5779998 124 if (err < 0) {
0ba41d91 125 usb_audio_err(chip, "cannot setup if %d: error %d\n",
e5779998
DM		 126 altsd->bInterfaceNumber, err);
127 return err;
128 }
129 /* reset the current interface */
130 usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
131 return 0;
132}
133
134/*
135 * create a stream for an endpoint/altsetting without proper descriptors
136 */
137static 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)
141{
142 struct audioformat *fp;
143 struct usb_host_interface *alts;
42d4ab83 144 struct usb_interface_descriptor *altsd;
e5779998
DM		 145 int stream, err;
146 unsigned *rate_table = NULL;
147
148 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
8866f405 149 if (!fp) {
0ba41d91 150 usb_audio_err(chip, "cannot memdup\n");
e5779998
DM		 151 return -ENOMEM;
152 }
8866f405
XW		 153 if (fp->nr_rates > MAX_NR_RATES) {
154 kfree(fp);
155 return -EINVAL;
156 }
e5779998 157 if (fp->nr_rates > 0) {
43df2a57
TM		 158 rate_table = kmemdup(fp->rate_table,
159 sizeof(int) * fp->nr_rates, GFP_KERNEL);
e5779998
DM		 160 if (!rate_table) {
161 kfree(fp);
162 return -ENOMEM;
163 }
e5779998
DM		 164 fp->rate_table = rate_table;
165 }
166
167 stream = (fp->endpoint & USB_DIR_IN)
168 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
e8e8babf 169 err = snd_usb_add_audio_stream(chip, stream, fp);
e5779998
DM		 170 if (err < 0) {
171 kfree(fp);
172 kfree(rate_table);
173 return err;
174 }
175 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
176 fp->altset_idx >= iface->num_altsetting) {
177 kfree(fp);
178 kfree(rate_table);
179 return -EINVAL;
180 }
181 alts = &iface->altsetting[fp->altset_idx];
42d4ab83
EZ		 182 altsd = get_iface_desc(alts);
183 fp->protocol = altsd->bInterfaceProtocol;
184
59ea586f
MH		 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);
e5779998 189 usb_set_interface(chip->dev, fp->iface, 0);
767d75ad
DM		 190 snd_usb_init_pitch(chip, fp->iface, alts, fp);
191 snd_usb_init_sample_rate(chip, fp->iface, alts, fp, fp->rate_max);
e5779998
DM		 192 return 0;
193}
194
aafe77cc
CL		 195static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
196 struct usb_interface *iface,
197 struct usb_driver *driver)
198{
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;
204
205 /*
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.
210 */
211
212 /* must have a non-zero altsetting for streaming */
213 if (iface->num_altsetting < 2)
214 return -ENODEV;
215 alts = &iface->altsetting[1];
216 altsd = get_iface_desc(alts);
217
218 /* must have an isochronous endpoint for streaming */
219 if (altsd->bNumEndpoints < 1)
220 return -ENODEV;
221 epd = get_endpoint(alts, 0);
222 if (!usb_endpoint_xfer_isoc(epd))
223 return -ENODEV;
224
225 /* must have format descriptors */
226 ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
227 UAC_AS_GENERAL);
228 fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
229 UAC_FORMAT_TYPE);
230 if (!ashd || ashd->bLength < 7 ||
231 !fmtd || fmtd->bLength < 8)
232 return -ENODEV;
233
234 return create_standard_audio_quirk(chip, iface, driver, NULL);
235}
236
237static 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)
241{
242 static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
243 .type = QUIRK_MIDI_YAMAHA
244 };
245 struct usb_midi_in_jack_descriptor *injd;
246 struct usb_midi_out_jack_descriptor *outjd;
247
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);
253 if (!injd && !outjd)
254 return -ENODEV;
255 if (injd && (injd->bLength < 5 ||
256 (injd->bJackType != USB_MS_EMBEDDED &&
257 injd->bJackType != USB_MS_EXTERNAL)))
258 return -ENODEV;
259 if (outjd && (outjd->bLength < 6 ||
260 (outjd->bJackType != USB_MS_EMBEDDED &&
261 outjd->bJackType != USB_MS_EXTERNAL)))
262 return -ENODEV;
263 return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
264}
265
266static 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)
270{
271 static const struct snd_usb_audio_quirk roland_midi_quirk = {
272 .type = QUIRK_MIDI_ROLAND
273 };
274 u8 *roland_desc = NULL;
275
276 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
277 for (;;) {
278 roland_desc = snd_usb_find_csint_desc(alts->extra,
279 alts->extralen,
280 roland_desc, 0xf1);
281 if (!roland_desc)
282 return -ENODEV;
283 if (roland_desc[0] < 6 || roland_desc[3] != 2)
284 continue;
285 return create_any_midi_quirk(chip, iface, driver,
286 &roland_midi_quirk);
287 }
288}
289
290static 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)
294{
295 struct usb_ms_header_descriptor *mshd;
296 struct usb_ms_endpoint_descriptor *msepd;
297
298 /* must have the MIDIStreaming interface header descriptor*/
299 mshd = (struct usb_ms_header_descriptor *)alts->extra;
300 if (alts->extralen < 7 ||
301 mshd->bLength < 7 ||
302 mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
303 mshd->bDescriptorSubtype != USB_MS_HEADER)
304 return -ENODEV;
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)
313 return -ENODEV;
314
315 return create_any_midi_quirk(chip, iface, driver, NULL);
316}
317
318static int create_auto_midi_quirk(struct snd_usb_audio *chip,
319 struct usb_interface *iface,
320 struct usb_driver *driver)
321{
322 struct usb_host_interface *alts;
323 struct usb_interface_descriptor *altsd;
324 struct usb_endpoint_descriptor *epd;
325 int err;
326
327 alts = &iface->altsetting[0];
328 altsd = get_iface_desc(alts);
329
330 /* must have at least one bulk/interrupt endpoint for streaming */
331 if (altsd->bNumEndpoints < 1)
332 return -ENODEV;
333 epd = get_endpoint(alts, 0);
aa773bfe 334 if (!usb_endpoint_xfer_bulk(epd) &&
aafe77cc
CL		 335 !usb_endpoint_xfer_int(epd))
336 return -ENODEV;
337
338 switch (USB_ID_VENDOR(chip->usb_id)) {
339 case 0x0499: /* Yamaha */
340 err = create_yamaha_midi_quirk(chip, iface, driver, alts);
aa773bfe 341 if (err != -ENODEV)
aafe77cc
CL		 342 return err;
343 break;
344 case 0x0582: /* Roland */
345 err = create_roland_midi_quirk(chip, iface, driver, alts);
aa773bfe 346 if (err != -ENODEV)
aafe77cc
CL		 347 return err;
348 break;
349 }
350
351 return create_std_midi_quirk(chip, iface, driver, alts);
352}
353
354static int create_autodetect_quirk(struct snd_usb_audio *chip,
355 struct usb_interface *iface,
b1ce7ba6 356 struct usb_driver *driver)
aafe77cc
CL		 357{
358 int err;
359
360 err = create_auto_pcm_quirk(chip, iface, driver);
361 if (err == -ENODEV)
362 err = create_auto_midi_quirk(chip, iface, driver);
363 return err;
364}
365
b1ce7ba6
CL		 366static 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)
370{
371 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
372 int ifcount, ifnum, err;
373
374 err = create_autodetect_quirk(chip, iface, driver);
375 if (err < 0)
376 return err;
377
378 /*
379 * ALSA PCM playback/capture devices cannot be registered in two steps,
380 * so we have to claim the other corresponding interface here.
381 */
382 ifcount = chip->dev->actconfig->desc.bNumInterfaces;
383 for (ifnum = 0; ifnum < ifcount; ifnum++) {
384 if (ifnum == probed_ifnum || quirk->ifnum >= 0)
385 continue;
386 iface = usb_ifnum_to_if(chip->dev, ifnum);
387 if (!iface ||
388 usb_interface_claimed(iface) ||
389 get_iface_desc(iface->altsetting)->bInterfaceClass !=
390 USB_CLASS_VENDOR_SPEC)
391 continue;
392
393 err = create_autodetect_quirk(chip, iface, driver);
394 if (err >= 0)
395 usb_driver_claim_interface(driver, iface, (void *)-1L);
396 }
397
398 return 0;
399}
400
e5779998
DM		 401/*
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.
404 */
405static 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)
409{
410 static const struct audioformat ua_format = {
015eb0b0 411 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
e5779998
DM		 412 .channels = 2,
413 .fmt_type = UAC_FORMAT_TYPE_I,
414 .altsetting = 1,
415 .altset_idx = 1,
416 .rates = SNDRV_PCM_RATE_CONTINUOUS,
417 };
418 struct usb_host_interface *alts;
419 struct usb_interface_descriptor *altsd;
420 struct audioformat *fp;
421 int stream, err;
422
423 /* both PCM and MIDI interfaces have 2 or more altsettings */
424 if (iface->num_altsetting < 2)
425 return -ENXIO;
426 alts = &iface->altsetting[1];
427 altsd = get_iface_desc(alts);
428
429 if (altsd->bNumEndpoints == 2) {
430 static const struct snd_usb_midi_endpoint_info ua700_ep = {
431 .out_cables = 0x0003,
432 .in_cables = 0x0003
433 };
434 static const struct snd_usb_audio_quirk ua700_quirk = {
435 .type = QUIRK_MIDI_FIXED_ENDPOINT,
436 .data = &ua700_ep
437 };
438 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
439 .out_cables = 0x0001,
440 .in_cables = 0x0001
441 };
442 static const struct snd_usb_audio_quirk uaxx_quirk = {
443 .type = QUIRK_MIDI_FIXED_ENDPOINT,
444 .data = &uaxx_ep
445 };
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);
451 }
452
453 if (altsd->bNumEndpoints != 1)
454 return -ENXIO;
455
43df2a57 456 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
e5779998
DM		 457 if (!fp)
458 return -ENOMEM;
e5779998
DM		 459
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);
465
466 switch (fp->maxpacksize) {
467 case 0x120:
468 fp->rate_max = fp->rate_min = 44100;
469 break;
470 case 0x138:
471 case 0x140:
472 fp->rate_max = fp->rate_min = 48000;
473 break;
474 case 0x258:
475 case 0x260:
476 fp->rate_max = fp->rate_min = 96000;
477 break;
478 default:
0ba41d91 479 usb_audio_err(chip, "unknown sample rate\n");
e5779998
DM		 480 kfree(fp);
481 return -ENXIO;
482 }
483
484 stream = (fp->endpoint & USB_DIR_IN)
485 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
e8e8babf 486 err = snd_usb_add_audio_stream(chip, stream, fp);
e5779998
DM		 487 if (err < 0) {
488 kfree(fp);
489 return err;
490 }
491 usb_set_interface(chip->dev, fp->iface, 0);
492 return 0;
493}
494
014950b0
DM		 495/*
496 * Create a standard mixer for the specified interface.
497 */
498static 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)
502{
503 if (quirk->ifnum < 0)
504 return 0;
505
506 return snd_usb_create_mixer(chip, quirk->ifnum, 0);
507}
508
e5779998
DM		 509/*
510 * audio-interface quirks
511 *
512 * returns zero if no standard audio/MIDI parsing is needed.
25985edc 513 * returns a positive value if standard audio/midi interfaces are parsed
e5779998
DM		 514 * after this.
515 * returns a negative value at error.
516 */
517int 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)
521{
522 typedef int (*quirk_func_t)(struct snd_usb_audio *,
523 struct usb_interface *,
524 struct usb_driver *,
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,
b1ce7ba6 529 [QUIRK_AUTODETECT] = create_autodetect_quirks,
e5779998
DM		 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,
aafe77cc 533 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
e5779998
DM		 534 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
535 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
c7f57216 536 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
e5779998
DM		 537 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
538 [QUIRK_MIDI_CME] = create_any_midi_quirk,
4434ade8 539 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
1ef0e0a0 540 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
e5779998
DM		 541 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
542 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
543 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
014950b0
DM		 544 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
545 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
e5779998
DM		 546 };
547
548 if (quirk->type < QUIRK_TYPE_COUNT) {
549 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
550 } else {
0ba41d91 551 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
e5779998
DM		 552 return -ENXIO;
553 }
554}
555
556/*
557 * boot quirks
558 */
559
560#define EXTIGY_FIRMWARE_SIZE_OLD 794
561#define EXTIGY_FIRMWARE_SIZE_NEW 483
562
563static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
564{
565 struct usb_host_config *config = dev->actconfig;
566 int err;
567
568 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
569 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
0ba41d91 570 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
e5779998
DM		 571 /* Send message to force it to reconnect with full interface. */
572 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
17d900c4 573 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
0ba41d91
TI		 574 if (err < 0)
575 dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
e5779998
DM		 576 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
577 &dev->descriptor, sizeof(dev->descriptor));
578 config = dev->actconfig;
0ba41d91
TI		 579 if (err < 0)
580 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
e5779998 581 err = usb_reset_configuration(dev);
0ba41d91
TI		 582 if (err < 0)
583 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
584 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
e5779998
DM		 585 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
586 return -ENODEV; /* quit this anyway */
587 }
588 return 0;
589}
590
591static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
592{
593 u8 buf = 1;
594
595 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
596 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
17d900c4 597 0, 0, &buf, 1);
e5779998
DM		 598 if (buf == 0) {
599 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
600 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
17d900c4 601 1, 2000, NULL, 0);
e5779998
DM		 602 return -ENODEV;
603 }
604 return 0;
605}
606
0f5733b0
GP		 607static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
608{
609 int err;
610
611 if (dev->actconfig->desc.bConfigurationValue == 1) {
0ba41d91 612 dev_info(&dev->dev,
0f5733b0
GP		 613 "Fast Track Pro switching to config #2\n");
614 /* This function has to be available by the usb core module.
615 * if it is not avialable the boot quirk has to be left out
616 * and the configuration has to be set by udev or hotplug
617 * rules
618 */
619 err = usb_driver_set_configuration(dev, 2);
b98ae272 620 if (err < 0)
0ba41d91
TI		 621 dev_dbg(&dev->dev,
622 "error usb_driver_set_configuration: %d\n",
623 err);
b98ae272
DH		 624 /* Always return an error, so that we stop creating a device
625 that will just be destroyed and recreated with a new
626 configuration */
627 return -ENODEV;
0f5733b0 628 } else
0ba41d91 629 dev_info(&dev->dev, "Fast Track Pro config OK\n");
0f5733b0
GP		 630
631 return 0;
632}
633
e5779998
DM		 634/*
635 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
636 * documented in the device's data sheet.
637 */
638static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
639{
640 u8 buf[4];
641 buf[0] = 0x20;
642 buf[1] = value & 0xff;
643 buf[2] = (value >> 8) & 0xff;
644 buf[3] = reg;
645 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
646 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
17d900c4 647 0, 0, &buf, 4);
e5779998
DM		 648}
649
650static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
651{
652 /*
653 * Enable line-out driver mode, set headphone source to front
654 * channels, enable stereo mic.
655 */
656 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
657}
658
659/*
660 * C-Media CM6206 is based on CM106 with two additional
661 * registers that are not documented in the data sheet.
662 * Values here are chosen based on sniffing USB traffic
663 * under Windows.
664 */
665static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
666{
dac8f847 667 int err = 0, reg;
157186bc 668 int val[] = {0x2004, 0x3000, 0xf800, 0x143f, 0x0000, 0x3000};
e5779998
DM		 669
670 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
671 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
672 if (err < 0)
673 return err;
674 }
675
676 return err;
677}
678
19570d74
TI		 679/* quirk for Plantronics GameCom 780 with CM6302 chip */
680static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
681{
682 /* set the initial volume and don't change; other values are either
683 * too loud or silent due to firmware bug (bko#65251)
684 */
542baf94 685 u8 buf[2] = { 0x74, 0xe3 };
19570d74
TI		 686 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
687 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
688 UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
689}
690
5e212332
MH		 691/*
692 * Novation Twitch DJ controller
11e424e8 693 * Focusrite Novation Saffire 6 USB audio card
5e212332 694 */
11e424e8 695static int snd_usb_novation_boot_quirk(struct usb_device *dev)
5e212332
MH		 696{
697 /* preemptively set up the device because otherwise the
698 * raw MIDI endpoints are not active */
699 usb_set_interface(dev, 0, 1);
700 return 0;
701}
702
e5779998
DM		 703/*
704 * This call will put the synth in "USB send" mode, i.e it will send MIDI
705 * messages through USB (this is disabled at startup). The synth will
706 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
707 * sign on its LCD. Values here are chosen based on sniffing USB traffic
708 * under Windows.
709 */
710static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
711{
712 int err, actual_length;
713
714 /* "midi send" enable */
715 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
716
717 void *buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
718 if (!buf)
719 return -ENOMEM;
720 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
721 ARRAY_SIZE(seq), &actual_length, 1000);
722 kfree(buf);
723 if (err < 0)
724 return err;
725
726 return 0;
727}
728
54a8c500
DM		 729/*
730 * Some sound cards from Native Instruments are in fact compliant to the USB
731 * audio standard of version 2 and other approved USB standards, even though
732 * they come up as vendor-specific device when first connected.
733 *
734 * However, they can be told to come up with a new set of descriptors
735 * upon their next enumeration, and the interfaces announced by the new
736 * descriptors will then be handled by the kernel's class drivers. As the
737 * product ID will also change, no further checks are required.
738 */
739
740static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
741{
742 int ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
743 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
889d6684 744 1, 0, NULL, 0, 1000);
54a8c500
DM		 745
746 if (ret < 0)
747 return ret;
748
749 usb_reset_device(dev);
750
751 /* return -EAGAIN, so the creation of an audio interface for this
752 * temporary device is aborted. The device will reconnect with a
753 * new product ID */
754 return -EAGAIN;
755}
756
cb99864d
DZ		 757static void mbox2_setup_48_24_magic(struct usb_device *dev)
758{
759 u8 srate[3];
760 u8 temp[12];
761
762 /* Choose 48000Hz permanently */
763 srate[0] = 0x80;
764 srate[1] = 0xbb;
765 srate[2] = 0x00;
766
767 /* Send the magic! */
768 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
769 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
770 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
771 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
772 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
773 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
774 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
775 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
776 return;
777}
778
779/* Digidesign Mbox 2 needs to load firmware onboard
780 * and driver must wait a few seconds for initialisation.
781 */
782
783#define MBOX2_FIRMWARE_SIZE 646
784#define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
785#define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
786
b7b435e8 787static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
cb99864d
DZ		 788{
789 struct usb_host_config *config = dev->actconfig;
790 int err;
4909a0ca 791 u8 bootresponse[0x12];
cb99864d
DZ		 792 int fwsize;
793 int count;
794
795 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
796
797 if (fwsize != MBOX2_FIRMWARE_SIZE) {
0ba41d91 798 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
cb99864d
DZ		 799 return -ENODEV;
800 }
801
0ba41d91 802 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
cb99864d
DZ		 803
804 count = 0;
b7b435e8
DZ		 805 bootresponse[0] = MBOX2_BOOT_LOADING;
806 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
cb99864d
DZ		 807 msleep(500); /* 0.5 second delay */
808 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
809 /* Control magic - load onboard firmware */
810 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
b7b435e8 811 if (bootresponse[0] == MBOX2_BOOT_READY)
cb99864d 812 break;
0ba41d91 813 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
cb99864d
DZ		 814 count++;
815 }
816
b7b435e8 817 if (bootresponse[0] != MBOX2_BOOT_READY) {
0ba41d91 818 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
cb99864d
DZ		 819 return -ENODEV;
820 }
821
0ba41d91 822 dev_dbg(&dev->dev, "device initialised!\n");
cb99864d
DZ		 823
824 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
825 &dev->descriptor, sizeof(dev->descriptor));
826 config = dev->actconfig;
827 if (err < 0)
0ba41d91 828 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
cb99864d
DZ		 829
830 err = usb_reset_configuration(dev);
831 if (err < 0)
0ba41d91
TI		 832 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
833 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
cb99864d
DZ		 834 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
835
836 mbox2_setup_48_24_magic(dev);
837
0ba41d91 838 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
cb99864d
DZ		 839
840 return 0; /* Successful boot */
841}
842
e5779998
DM		 843/*
844 * Setup quirks
845 */
0f5733b0
GP		 846#define MAUDIO_SET 0x01 /* parse device_setup */
847#define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
848#define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
849#define MAUDIO_SET_96K 0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
850#define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
851#define MAUDIO_SET_DI 0x10 /* enable Digital Input */
852#define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
853#define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48KHz+Digital Input */
854#define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
855#define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48KHz+Digital Input */
856#define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
857
858static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
859 int iface, int altno)
860{
861 /* Reset ALL ifaces to 0 altsetting.
862 * Call it for every possible altsetting of every interface.
863 */
864 usb_set_interface(chip->dev, iface, 0);
865 if (chip->setup & MAUDIO_SET) {
866 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
867 if (iface != 1 && iface != 2)
868 return 1; /* skip all interfaces but 1 and 2 */
869 } else {
870 unsigned int mask;
871 if (iface == 1 || iface == 2)
872 return 1; /* skip interfaces 1 and 2 */
873 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
874 return 1; /* skip this altsetting */
875 mask = chip->setup & MAUDIO_SET_MASK;
876 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
877 return 1; /* skip this altsetting */
878 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
879 return 1; /* skip this altsetting */
880 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
881 return 1; /* skip this altsetting */
882 }
883 }
0ba41d91 884 usb_audio_dbg(chip,
0f5733b0
GP		 885 "using altsetting %d for interface %d config %d\n",
886 altno, iface, chip->setup);
887 return 0; /* keep this altsetting */
888}
e5779998
DM		 889
890static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
891 int iface,
892 int altno)
893{
894 /* Reset ALL ifaces to 0 altsetting.
895 * Call it for every possible altsetting of every interface.
896 */
897 usb_set_interface(chip->dev, iface, 0);
898
0f5733b0
GP		 899 if (chip->setup & MAUDIO_SET) {
900 unsigned int mask;
901 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
e5779998 902 return 1; /* skip this altsetting */
0f5733b0 903 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
e5779998 904 return 1; /* skip this altsetting */
0f5733b0
GP		 905 mask = chip->setup & MAUDIO_SET_MASK;
906 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
e5779998 907 return 1; /* skip this altsetting */
0f5733b0 908 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
e5779998 909 return 1; /* skip this altsetting */
0f5733b0 910 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
e5779998 911 return 1; /* skip this altsetting */
0f5733b0 912 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
e5779998
DM		 913 return 1; /* skip this altsetting */
914 }
915
916 return 0; /* keep this altsetting */
917}
918
0f5733b0
GP		 919static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
920 int iface, int altno)
921{
922 /* Reset ALL ifaces to 0 altsetting.
923 * Call it for every possible altsetting of every interface.
924 */
925 usb_set_interface(chip->dev, iface, 0);
926
927 /* possible configuration where both inputs and only one output is
928 *used is not supported by the current setup
929 */
930 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
931 if (chip->setup & MAUDIO_SET_96K) {
932 if (altno != 3 && altno != 6)
933 return 1;
934 } else if (chip->setup & MAUDIO_SET_DI) {
935 if (iface == 4)
936 return 1; /* no analog input */
937 if (altno != 2 && altno != 5)
938 return 1; /* enable only altsets 2 and 5 */
939 } else {
940 if (iface == 5)
941 return 1; /* disable digialt input */
942 if (altno != 2 && altno != 5)
943 return 1; /* enalbe only altsets 2 and 5 */
944 }
945 } else {
946 /* keep only 16-Bit mode */
947 if (altno != 1)
948 return 1;
949 }
950
0ba41d91 951 usb_audio_dbg(chip,
0f5733b0
GP		 952 "using altsetting %d for interface %d config %d\n",
953 altno, iface, chip->setup);
954 return 0; /* keep this altsetting */
955}
956
e5779998
DM		 957int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
958 int iface,
959 int altno)
960{
961 /* audiophile usb: skip altsets incompatible with device_setup */
962 if (chip->usb_id == USB_ID(0x0763, 0x2003))
963 return audiophile_skip_setting_quirk(chip, iface, altno);
0f5733b0
GP		 964 /* quattro usb: skip altsets incompatible with device_setup */
965 if (chip->usb_id == USB_ID(0x0763, 0x2001))
966 return quattro_skip_setting_quirk(chip, iface, altno);
967 /* fasttrackpro usb: skip altsets incompatible with device_setup */
968 if (chip->usb_id == USB_ID(0x0763, 0x2012))
969 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
e5779998
DM		 970
971 return 0;
972}
973
974int snd_usb_apply_boot_quirk(struct usb_device *dev,
975 struct usb_interface *intf,
976 const struct snd_usb_audio_quirk *quirk)
977{
978 u32 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
979 le16_to_cpu(dev->descriptor.idProduct));
980
3347b26c
DM		 981 switch (id) {
982 case USB_ID(0x041e, 0x3000):
983 /* SB Extigy needs special boot-up sequence */
984 /* if more models come, this will go to the quirk list. */
e5779998
DM		 985 return snd_usb_extigy_boot_quirk(dev, intf);
986
3347b26c
DM		 987 case USB_ID(0x041e, 0x3020):
988 /* SB Audigy 2 NX needs its own boot-up magic, too */
e5779998
DM		 989 return snd_usb_audigy2nx_boot_quirk(dev);
990
3347b26c
DM		 991 case USB_ID(0x10f5, 0x0200):
992 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
e5779998
DM		 993 return snd_usb_cm106_boot_quirk(dev);
994
3347b26c
DM		 995 case USB_ID(0x0d8c, 0x0102):
996 /* C-Media CM6206 / CM106-Like Sound Device */
8129e79e 997 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
e5779998
DM		 998 return snd_usb_cm6206_boot_quirk(dev);
999
cb99864d
DZ		 1000 case USB_ID(0x0dba, 0x3000):
1001 /* Digidesign Mbox 2 */
1002 return snd_usb_mbox2_boot_quirk(dev);
1003
11e424e8
EG		 1004 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1005 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1006 return snd_usb_novation_boot_quirk(dev);
5e212332 1007
3347b26c
DM		 1008 case USB_ID(0x133e, 0x0815):
1009 /* Access Music VirusTI Desktop */
e5779998
DM		 1010 return snd_usb_accessmusic_boot_quirk(dev);
1011
759e890f 1012 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
3347b26c
DM		 1013 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1014 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
54a8c500 1015 return snd_usb_nativeinstruments_boot_quirk(dev);
0f5733b0
GP		 1016 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1017 return snd_usb_fasttrackpro_boot_quirk(dev);
19570d74
TI		 1018 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1019 return snd_usb_gamecon780_boot_quirk(dev);
3347b26c 1020 }
54a8c500 1021
e5779998
DM		 1022 return 0;
1023}
1024
1025/*
1026 * check if the device uses big-endian samples
1027 */
1028int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
1029{
48fc7f7e 1030 /* it depends on altsetting whether the device is big-endian or not */
e5779998
DM		 1031 switch (chip->usb_id) {
1032 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
0f5733b0
GP		 1033 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1034 fp->altsetting == 5 || fp->altsetting == 6)
e5779998
DM		 1035 return 1;
1036 break;
1037 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1038 if (chip->setup == 0x00 ||
0f5733b0
GP		 1039 fp->altsetting == 1 || fp->altsetting == 2 ||
1040 fp->altsetting == 3)
1041 return 1;
1042 break;
1043 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1044 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1045 fp->altsetting == 5 || fp->altsetting == 6)
e5779998 1046 return 1;
0f5733b0 1047 break;
e5779998
DM		 1048 }
1049 return 0;
1050}
1051
1052/*
1cdfa9f3 1053 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
e5779998
DM		 1054 * not for interface.
1055 */
1056
1057enum {
1058 EMU_QUIRK_SR_44100HZ = 0,
1059 EMU_QUIRK_SR_48000HZ,
1060 EMU_QUIRK_SR_88200HZ,
1061 EMU_QUIRK_SR_96000HZ,
1062 EMU_QUIRK_SR_176400HZ,
1063 EMU_QUIRK_SR_192000HZ
1064};
1065
1066static void set_format_emu_quirk(struct snd_usb_substream *subs,
1067 struct audioformat *fmt)
1068{
1069 unsigned char emu_samplerate_id = 0;
1070
1071 /* When capture is active
1072 * sample rate shouldn't be changed
1073 * by playback substream
1074 */
1075 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1076 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
1077 return;
1078 }
1079
1080 switch (fmt->rate_min) {
1081 case 48000:
1082 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1083 break;
1084 case 88200:
1085 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1086 break;
1087 case 96000:
1088 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1089 break;
1090 case 176400:
1091 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1092 break;
1093 case 192000:
1094 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1095 break;
1096 default:
1097 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1098 break;
1099 }
1100 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1539d4f8 1101 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
e5779998
DM		 1102}
1103
1104void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1105 struct audioformat *fmt)
1106{
1107 switch (subs->stream->chip->usb_id) {
1108 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1109 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1110 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1cdfa9f3 1111 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
e5779998
DM		 1112 set_format_emu_quirk(subs, fmt);
1113 break;
1114 }
1115}
1116
b62b9980
JT		 1117bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1118{
9fc88ad6
EW		 1119 /* devices which do not support reading the sample rate. */
1120 switch (chip->usb_id) {
eef0342c 1121 case USB_ID(0x045E, 0x075D): /* MS Lifecam Cinema */
9fc88ad6 1122 case USB_ID(0x045E, 0x076D): /* MS Lifecam HD-5000 */
fa94b0d7 1123 case USB_ID(0x045E, 0x0772): /* MS Lifecam Studio */
ae425bb2 1124 case USB_ID(0x045E, 0x0779): /* MS Lifecam HD-3000 */
9fc88ad6 1125 case USB_ID(0x04D8, 0xFEEA): /* Benchmark DAC1 Pre */
2f80b295 1126 case USB_ID(0x074D, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
9fc88ad6
EW		 1127 return true;
1128 }
1129 return false;
b62b9980 1130}
6874daad
JK		 1131
1132/* Marantz/Denon USB DACs need a vendor cmd to switch
1133 * between PCM and native DSD mode
1134 */
8b28c93f
TI		 1135static bool is_marantz_denon_dac(unsigned int id)
1136{
1137 switch (id) {
1138 case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1139 case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1140 case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1141 return true;
1142 }
1143 return false;
1144}
1145
6874daad
JK		 1146int snd_usb_select_mode_quirk(struct snd_usb_substream *subs,
1147 struct audioformat *fmt)
1148{
1149 struct usb_device *dev = subs->dev;
1150 int err;
1151
8b28c93f 1152 if (is_marantz_denon_dac(subs->stream->chip->usb_id)) {
6874daad
JK		 1153 /* First switch to alt set 0, otherwise the mode switch cmd
1154 * will not be accepted by the DAC
1155 */
1156 err = usb_set_interface(dev, fmt->iface, 0);
1157 if (err < 0)
1158 return err;
1159
1160 mdelay(20); /* Delay needed after setting the interface */
1161
1162 switch (fmt->altsetting) {
1163 case 2: /* DSD mode requested */
1164 case 1: /* PCM mode requested */
1165 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1166 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1167 fmt->altsetting - 1, 1, NULL, 0);
1168 if (err < 0)
1169 return err;
1170 break;
1171 }
1172 mdelay(20);
1173 }
1174 return 0;
1175}
1176
2b58fd5b
DM		 1177void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1178{
1179 /*
1180 * "Playback Design" products send bogus feedback data at the start
1181 * of the stream. Ignore them.
1182 */
1183 if ((le16_to_cpu(ep->chip->dev->descriptor.idVendor) == 0x23ba) &&
1184 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1185 ep->skip_packets = 4;
83e3acd4
EZ		 1186
1187 /*
e9a25e04
MG		 1188 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1189 * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1190 * the stream is (re)started. When skipping packets 16 at endpoint
1191 * start up, the real world latency is stable within +/- 1 frame (also
83e3acd4
EZ		 1192 * across power cycles).
1193 */
e9a25e04
MG		 1194 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1195 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
83e3acd4
EZ		 1196 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1197 ep->skip_packets = 16;
2b58fd5b
DM		 1198}
1199
21bb5aaf
DM		 1200void snd_usb_set_interface_quirk(struct usb_device *dev)
1201{
1202 /*
1203 * "Playback Design" products need a 50ms delay after setting the
1204 * USB interface.
1205 */
1206 if (le16_to_cpu(dev->descriptor.idVendor) == 0x23ba)
1207 mdelay(50);
1208}
1209
2b58fd5b
DM		 1210void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1211 __u8 request, __u8 requesttype, __u16 value,
1212 __u16 index, void *data, __u16 size)
1213{
1214 /*
1215 * "Playback Design" products need a 20ms delay after each
1216 * class compliant request
1217 */
1218 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x23ba) &&
1219 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1220 mdelay(20);
6e84a8d7
JK		 1221
1222 /* Marantz/Denon devices with USB DAC functionality need a delay
1223 * after each class compliant request
1224 */
8b28c93f
TI		 1225 if (is_marantz_denon_dac(USB_ID(le16_to_cpu(dev->descriptor.idVendor),
1226 le16_to_cpu(dev->descriptor.idProduct)))
1227 && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1228 mdelay(20);
dacacb0a
PM		 1229
1230 /* Zoom R16/24 needs a tiny delay here, otherwise requests like
1231 * get/set frequency return as failed despite actually succeeding.
1232 */
1233 if ((le16_to_cpu(dev->descriptor.idVendor) == 0x1686) &&
1234 (le16_to_cpu(dev->descriptor.idProduct) == 0x00dd) &&
1235 (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1236 mdelay(1);
2b58fd5b
DM		 1237}
1238
126825e7
DM		 1239/*
1240 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1241 * augment the PCM format bit-field for DSD types. The UAC standards
1242 * don't have a designated bit field to denote DSD-capable interfaces,
1243 * hence all hardware that is known to support this format has to be
1244 * listed here.
1245 */
1246u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1247 struct audioformat *fp,
1248 unsigned int sample_bytes)
1249{
1250 /* Playback Designs */
1251 if (le16_to_cpu(chip->dev->descriptor.idVendor) == 0x23ba) {
1252 switch (fp->altsetting) {
1253 case 1:
1254 fp->dsd_dop = true;
1255 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1256 case 2:
1257 fp->dsd_bitrev = true;
1258 return SNDRV_PCM_FMTBIT_DSD_U8;
1259 case 3:
1260 fp->dsd_bitrev = true;
1261 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1262 }
1263 }
1264
848f3a82
JK		 1265 /* XMOS based USB DACs */
1266 switch (chip->usb_id) {
38f74d5b
JK		 1267 case USB_ID(0x20b1, 0x3008): /* iFi Audio micro/nano iDSD */
1268 case USB_ID(0x20b1, 0x2008): /* Matrix Audio X-Sabre */
1269 case USB_ID(0x20b1, 0x300a): /* Matrix Audio Mini-i Pro */
848f3a82 1270 if (fp->altsetting == 2)
d42472ec 1271 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
848f3a82 1272 break;
3b7e5c7e 1273
9544f8b6 1274 case USB_ID(0x20b1, 0x000a): /* Gustard DAC-X20U */
3b7e5c7e
JK		 1275 case USB_ID(0x20b1, 0x2009): /* DIYINHK DSD DXD 384kHz USB to I2S/DSD */
1276 case USB_ID(0x20b1, 0x2023): /* JLsounds I2SoverUSB */
848f3a82 1277 if (fp->altsetting == 3)
d42472ec 1278 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
848f3a82
JK		 1279 break;
1280 default:
1281 break;
1282 }
1283
7a2e9ddc 1284 /* Denon/Marantz devices with USB DAC functionality */
8b28c93f 1285 if (is_marantz_denon_dac(chip->usb_id)) {
7a2e9ddc
JK		 1286 if (fp->altsetting == 2)
1287 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
7a2e9ddc
JK		 1288 }
1289
126825e7
DM		 1290 return 0;
1291}
Linux 6.x block layer and io_uring tree(s)