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