1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 */
4
5#include <linux/init.h>
6#include <linux/slab.h>
7#include <linux/usb.h>
8#include <linux/usb/audio.h>
9#include <linux/usb/midi.h>
10#include <linux/bits.h>
11
12#include <sound/control.h>
13#include <sound/core.h>
14#include <sound/info.h>
15#include <sound/pcm.h>
16
17#include "usbaudio.h"
18#include "card.h"
19#include "mixer.h"
20#include "mixer_quirks.h"
21#include "midi.h"
22#include "midi2.h"
23#include "quirks.h"
24#include "helper.h"
25#include "endpoint.h"
26#include "pcm.h"
27#include "clock.h"
28#include "stream.h"
29
30/*
31 * handle the quirks for the contained interfaces
32 */
33static int create_composite_quirk(struct snd_usb_audio *chip,
34 struct usb_interface *iface,
35 struct usb_driver *driver,
36 const struct snd_usb_audio_quirk *quirk_comp)
37{
38 int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
39 const struct snd_usb_audio_quirk *quirk;
40 int err;
41
42 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
43 iface = usb_ifnum_to_if(dev: chip->dev, ifnum: quirk->ifnum);
44 if (!iface)
45 continue;
46 if (quirk->ifnum != probed_ifnum &&
47 usb_interface_claimed(iface))
48 continue;
49 err = snd_usb_create_quirk(chip, iface, driver, quirk);
50 if (err < 0)
51 return err;
52 }
53
54 for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
55 iface = usb_ifnum_to_if(dev: chip->dev, ifnum: quirk->ifnum);
56 if (!iface)
57 continue;
58 if (quirk->ifnum != probed_ifnum &&
59 !usb_interface_claimed(iface)) {
60 err = usb_driver_claim_interface(driver, iface,
61 USB_AUDIO_IFACE_UNUSED);
62 if (err < 0)
63 return err;
64 }
65 }
66
67 return 0;
68}
69
70static int ignore_interface_quirk(struct snd_usb_audio *chip,
71 struct usb_interface *iface,
72 struct usb_driver *driver,
73 const struct snd_usb_audio_quirk *quirk)
74{
75 return 0;
76}
77
78
79static int create_any_midi_quirk(struct snd_usb_audio *chip,
80 struct usb_interface *intf,
81 struct usb_driver *driver,
82 const struct snd_usb_audio_quirk *quirk)
83{
84 return snd_usb_midi_v2_create(chip, iface: intf, quirk, usb_id: 0);
85}
86
87/*
88 * create a stream for an interface with proper descriptors
89 */
90static int create_standard_audio_quirk(struct snd_usb_audio *chip,
91 struct usb_interface *iface,
92 struct usb_driver *driver,
93 const struct snd_usb_audio_quirk *quirk)
94{
95 struct usb_host_interface *alts;
96 struct usb_interface_descriptor *altsd;
97 int err;
98
99 alts = &iface->altsetting[0];
100 altsd = get_iface_desc(alts);
101 err = snd_usb_parse_audio_interface(chip, iface_no: altsd->bInterfaceNumber);
102 if (err < 0) {
103 usb_audio_err(chip, "cannot setup if %d: error %d\n",
104 altsd->bInterfaceNumber, err);
105 return err;
106 }
107 /* reset the current interface */
108 usb_set_interface(dev: chip->dev, ifnum: altsd->bInterfaceNumber, alternate: 0);
109 return 0;
110}
111
112/* create the audio stream and the corresponding endpoints from the fixed
113 * audioformat object; this is used for quirks with the fixed EPs
114 */
115static int add_audio_stream_from_fixed_fmt(struct snd_usb_audio *chip,
116 struct audioformat *fp)
117{
118 int stream, err;
119
120 stream = (fp->endpoint & USB_DIR_IN) ?
121 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
122
123 snd_usb_audioformat_set_sync_ep(chip, fmt: fp);
124
125 err = snd_usb_add_audio_stream(chip, stream, fp);
126 if (err < 0)
127 return err;
128
129 err = snd_usb_add_endpoint(chip, ep_num: fp->endpoint,
130 SND_USB_ENDPOINT_TYPE_DATA);
131 if (err < 0)
132 return err;
133
134 if (fp->sync_ep) {
135 err = snd_usb_add_endpoint(chip, ep_num: fp->sync_ep,
136 type: fp->implicit_fb ?
137 SND_USB_ENDPOINT_TYPE_DATA :
138 SND_USB_ENDPOINT_TYPE_SYNC);
139 if (err < 0)
140 return err;
141 }
142
143 return 0;
144}
145
146/*
147 * create a stream for an endpoint/altsetting without proper descriptors
148 */
149static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
150 struct usb_interface *iface,
151 struct usb_driver *driver,
152 const struct snd_usb_audio_quirk *quirk)
153{
154 struct audioformat *fp;
155 struct usb_host_interface *alts;
156 struct usb_interface_descriptor *altsd;
157 unsigned *rate_table = NULL;
158 int err;
159
160 fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
161 if (!fp)
162 return -ENOMEM;
163
164 INIT_LIST_HEAD(list: &fp->list);
165 if (fp->nr_rates > MAX_NR_RATES) {
166 kfree(objp: fp);
167 return -EINVAL;
168 }
169 if (fp->nr_rates > 0) {
170 rate_table = kmemdup_array(src: fp->rate_table, count: fp->nr_rates, element_size: sizeof(int),
171 GFP_KERNEL);
172 if (!rate_table) {
173 kfree(objp: fp);
174 return -ENOMEM;
175 }
176 fp->rate_table = rate_table;
177 }
178
179 if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
180 fp->altset_idx >= iface->num_altsetting) {
181 err = -EINVAL;
182 goto error;
183 }
184 alts = &iface->altsetting[fp->altset_idx];
185 altsd = get_iface_desc(alts);
186 if (altsd->bNumEndpoints <= fp->ep_idx) {
187 err = -EINVAL;
188 goto error;
189 }
190
191 fp->protocol = altsd->bInterfaceProtocol;
192
193 if (fp->datainterval == 0)
194 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
195 if (fp->maxpacksize == 0)
196 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, fp->ep_idx)->wMaxPacketSize);
197 if (!fp->fmt_type)
198 fp->fmt_type = UAC_FORMAT_TYPE_I;
199
200 err = add_audio_stream_from_fixed_fmt(chip, fp);
201 if (err < 0)
202 goto error;
203
204 usb_set_interface(dev: chip->dev, ifnum: fp->iface, alternate: 0);
205 snd_usb_init_pitch(chip, fmt: fp);
206 snd_usb_init_sample_rate(chip, fmt: fp, rate: fp->rate_max);
207 return 0;
208
209 error:
210 list_del(entry: &fp->list); /* unlink for avoiding double-free */
211 kfree(objp: fp);
212 kfree(objp: rate_table);
213 return err;
214}
215
216static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
217 struct usb_interface *iface,
218 struct usb_driver *driver)
219{
220 struct usb_host_interface *alts;
221 struct usb_interface_descriptor *altsd;
222 struct usb_endpoint_descriptor *epd;
223 struct uac1_as_header_descriptor *ashd;
224 struct uac_format_type_i_discrete_descriptor *fmtd;
225
226 /*
227 * Most Roland/Yamaha audio streaming interfaces have more or less
228 * standard descriptors, but older devices might lack descriptors, and
229 * future ones might change, so ensure that we fail silently if the
230 * interface doesn't look exactly right.
231 */
232
233 /* must have a non-zero altsetting for streaming */
234 if (iface->num_altsetting < 2)
235 return -ENODEV;
236 alts = &iface->altsetting[1];
237 altsd = get_iface_desc(alts);
238
239 /* must have an isochronous endpoint for streaming */
240 if (altsd->bNumEndpoints < 1)
241 return -ENODEV;
242 epd = get_endpoint(alts, 0);
243 if (!usb_endpoint_xfer_isoc(epd))
244 return -ENODEV;
245
246 /* must have format descriptors */
247 ashd = snd_usb_find_csint_desc(descstart: alts->extra, desclen: alts->extralen, NULL,
248 UAC_AS_GENERAL);
249 fmtd = snd_usb_find_csint_desc(descstart: alts->extra, desclen: alts->extralen, NULL,
250 UAC_FORMAT_TYPE);
251 if (!ashd || ashd->bLength < 7 ||
252 !fmtd || fmtd->bLength < 8)
253 return -ENODEV;
254
255 return create_standard_audio_quirk(chip, iface, driver, NULL);
256}
257
258static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
259 struct usb_interface *iface,
260 struct usb_driver *driver,
261 struct usb_host_interface *alts)
262{
263 static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
264 .type = QUIRK_MIDI_YAMAHA
265 };
266 struct usb_midi_in_jack_descriptor *injd;
267 struct usb_midi_out_jack_descriptor *outjd;
268
269 /* must have some valid jack descriptors */
270 injd = snd_usb_find_csint_desc(descstart: alts->extra, desclen: alts->extralen,
271 NULL, USB_MS_MIDI_IN_JACK);
272 outjd = snd_usb_find_csint_desc(descstart: alts->extra, desclen: alts->extralen,
273 NULL, USB_MS_MIDI_OUT_JACK);
274 if (!injd && !outjd)
275 return -ENODEV;
276 if ((injd && !snd_usb_validate_midi_desc(p: injd)) ||
277 (outjd && !snd_usb_validate_midi_desc(p: outjd)))
278 return -ENODEV;
279 if (injd && (injd->bLength < 5 ||
280 (injd->bJackType != USB_MS_EMBEDDED &&
281 injd->bJackType != USB_MS_EXTERNAL)))
282 return -ENODEV;
283 if (outjd && (outjd->bLength < 6 ||
284 (outjd->bJackType != USB_MS_EMBEDDED &&
285 outjd->bJackType != USB_MS_EXTERNAL)))
286 return -ENODEV;
287 return create_any_midi_quirk(chip, intf: iface, driver, quirk: &yamaha_midi_quirk);
288}
289
290static int create_roland_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 static const struct snd_usb_audio_quirk roland_midi_quirk = {
296 .type = QUIRK_MIDI_ROLAND
297 };
298 u8 *roland_desc = NULL;
299
300 /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
301 for (;;) {
302 roland_desc = snd_usb_find_csint_desc(descstart: alts->extra,
303 desclen: alts->extralen,
304 after: roland_desc, dsubtype: 0xf1);
305 if (!roland_desc)
306 return -ENODEV;
307 if (roland_desc[0] < 6 || roland_desc[3] != 2)
308 continue;
309 return create_any_midi_quirk(chip, intf: iface, driver,
310 quirk: &roland_midi_quirk);
311 }
312}
313
314static int create_std_midi_quirk(struct snd_usb_audio *chip,
315 struct usb_interface *iface,
316 struct usb_driver *driver,
317 struct usb_host_interface *alts)
318{
319 struct usb_ms_header_descriptor *mshd;
320 struct usb_ms_endpoint_descriptor *msepd;
321
322 /* must have the MIDIStreaming interface header descriptor*/
323 mshd = (struct usb_ms_header_descriptor *)alts->extra;
324 if (alts->extralen < 7 ||
325 mshd->bLength < 7 ||
326 mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
327 mshd->bDescriptorSubtype != USB_MS_HEADER)
328 return -ENODEV;
329 /* must have the MIDIStreaming endpoint descriptor*/
330 msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra;
331 if (alts->endpoint[0].extralen < 4 ||
332 msepd->bLength < 4 ||
333 msepd->bDescriptorType != USB_DT_CS_ENDPOINT ||
334 msepd->bDescriptorSubtype != UAC_MS_GENERAL ||
335 msepd->bNumEmbMIDIJack < 1 ||
336 msepd->bNumEmbMIDIJack > 16)
337 return -ENODEV;
338
339 return create_any_midi_quirk(chip, intf: iface, driver, NULL);
340}
341
342static int create_auto_midi_quirk(struct snd_usb_audio *chip,
343 struct usb_interface *iface,
344 struct usb_driver *driver)
345{
346 struct usb_host_interface *alts;
347 struct usb_interface_descriptor *altsd;
348 struct usb_endpoint_descriptor *epd;
349 int err;
350
351 alts = &iface->altsetting[0];
352 altsd = get_iface_desc(alts);
353
354 /* must have at least one bulk/interrupt endpoint for streaming */
355 if (altsd->bNumEndpoints < 1)
356 return -ENODEV;
357 epd = get_endpoint(alts, 0);
358 if (!usb_endpoint_xfer_bulk(epd) &&
359 !usb_endpoint_xfer_int(epd))
360 return -ENODEV;
361
362 switch (USB_ID_VENDOR(chip->usb_id)) {
363 case 0x0499: /* Yamaha */
364 err = create_yamaha_midi_quirk(chip, iface, driver, alts);
365 if (err != -ENODEV)
366 return err;
367 break;
368 case 0x0582: /* Roland */
369 err = create_roland_midi_quirk(chip, iface, driver, alts);
370 if (err != -ENODEV)
371 return err;
372 break;
373 }
374
375 return create_std_midi_quirk(chip, iface, driver, alts);
376}
377
378static int create_autodetect_quirk(struct snd_usb_audio *chip,
379 struct usb_interface *iface,
380 struct usb_driver *driver,
381 const struct snd_usb_audio_quirk *quirk)
382{
383 int err;
384
385 err = create_auto_pcm_quirk(chip, iface, driver);
386 if (err == -ENODEV)
387 err = create_auto_midi_quirk(chip, iface, driver);
388 return err;
389}
390
391/*
392 * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
393 * The only way to detect the sample rate is by looking at wMaxPacketSize.
394 */
395static int create_uaxx_quirk(struct snd_usb_audio *chip,
396 struct usb_interface *iface,
397 struct usb_driver *driver,
398 const struct snd_usb_audio_quirk *quirk)
399{
400 static const struct audioformat ua_format = {
401 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
402 .channels = 2,
403 .fmt_type = UAC_FORMAT_TYPE_I,
404 .altsetting = 1,
405 .altset_idx = 1,
406 .rates = SNDRV_PCM_RATE_CONTINUOUS,
407 };
408 struct usb_host_interface *alts;
409 struct usb_interface_descriptor *altsd;
410 struct audioformat *fp;
411 int err;
412
413 /* both PCM and MIDI interfaces have 2 or more altsettings */
414 if (iface->num_altsetting < 2)
415 return -ENXIO;
416 alts = &iface->altsetting[1];
417 altsd = get_iface_desc(alts);
418
419 if (altsd->bNumEndpoints == 2) {
420 static const struct snd_usb_midi_endpoint_info ua700_ep = {
421 .out_cables = 0x0003,
422 .in_cables = 0x0003
423 };
424 static const struct snd_usb_audio_quirk ua700_quirk = {
425 .type = QUIRK_MIDI_FIXED_ENDPOINT,
426 .data = &ua700_ep
427 };
428 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
429 .out_cables = 0x0001,
430 .in_cables = 0x0001
431 };
432 static const struct snd_usb_audio_quirk uaxx_quirk = {
433 .type = QUIRK_MIDI_FIXED_ENDPOINT,
434 .data = &uaxx_ep
435 };
436 const struct snd_usb_audio_quirk *quirk =
437 chip->usb_id == USB_ID(0x0582, 0x002b)
438 ? &ua700_quirk : &uaxx_quirk;
439 return __snd_usbmidi_create(card: chip->card, iface,
440 midi_list: &chip->midi_list, quirk,
441 usb_id: chip->usb_id,
442 num_rawmidis: &chip->num_rawmidis);
443 }
444
445 if (altsd->bNumEndpoints != 1)
446 return -ENXIO;
447
448 fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
449 if (!fp)
450 return -ENOMEM;
451
452 fp->iface = altsd->bInterfaceNumber;
453 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
454 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
455 fp->datainterval = 0;
456 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
457 INIT_LIST_HEAD(list: &fp->list);
458
459 switch (fp->maxpacksize) {
460 case 0x120:
461 fp->rate_max = fp->rate_min = 44100;
462 break;
463 case 0x138:
464 case 0x140:
465 fp->rate_max = fp->rate_min = 48000;
466 break;
467 case 0x258:
468 case 0x260:
469 fp->rate_max = fp->rate_min = 96000;
470 break;
471 default:
472 usb_audio_err(chip, "unknown sample rate\n");
473 kfree(objp: fp);
474 return -ENXIO;
475 }
476
477 err = add_audio_stream_from_fixed_fmt(chip, fp);
478 if (err < 0) {
479 list_del(entry: &fp->list); /* unlink for avoiding double-free */
480 kfree(objp: fp);
481 return err;
482 }
483 usb_set_interface(dev: chip->dev, ifnum: fp->iface, alternate: 0);
484 return 0;
485}
486
487/*
488 * Create a standard mixer for the specified interface.
489 */
490static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
491 struct usb_interface *iface,
492 struct usb_driver *driver,
493 const struct snd_usb_audio_quirk *quirk)
494{
495 if (quirk->ifnum < 0)
496 return 0;
497
498 return snd_usb_create_mixer(chip, ctrlif: quirk->ifnum);
499}
500
501/*
502 * audio-interface quirks
503 *
504 * returns zero if no standard audio/MIDI parsing is needed.
505 * returns a positive value if standard audio/midi interfaces are parsed
506 * after this.
507 * returns a negative value at error.
508 */
509int snd_usb_create_quirk(struct snd_usb_audio *chip,
510 struct usb_interface *iface,
511 struct usb_driver *driver,
512 const struct snd_usb_audio_quirk *quirk)
513{
514 typedef int (*quirk_func_t)(struct snd_usb_audio *,
515 struct usb_interface *,
516 struct usb_driver *,
517 const struct snd_usb_audio_quirk *);
518 static const quirk_func_t quirk_funcs[] = {
519 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
520 [QUIRK_COMPOSITE] = create_composite_quirk,
521 [QUIRK_AUTODETECT] = create_autodetect_quirk,
522 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
523 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
524 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
525 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
526 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
527 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
528 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
529 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
530 [QUIRK_MIDI_CME] = create_any_midi_quirk,
531 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
532 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
533 [QUIRK_MIDI_CH345] = create_any_midi_quirk,
534 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
535 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
536 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
537 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
538 };
539
540 if (quirk->type < QUIRK_TYPE_COUNT) {
541 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
542 } else {
543 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
544 return -ENXIO;
545 }
546}
547
548/*
549 * boot quirks
550 */
551
552#define EXTIGY_FIRMWARE_SIZE_OLD 794
553#define EXTIGY_FIRMWARE_SIZE_NEW 483
554
555static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
556{
557 struct usb_host_config *config = dev->actconfig;
558 struct usb_device_descriptor *new_device_descriptor __free(kfree) = NULL;
559 int err;
560
561 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
562 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
563 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
564 /* Send message to force it to reconnect with full interface. */
565 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
566 request: 0x10, requesttype: 0x43, value: 0x0001, index: 0x000a, NULL, size: 0);
567 if (err < 0)
568 dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
569
570 new_device_descriptor = kmalloc(sizeof(*new_device_descriptor), GFP_KERNEL);
571 if (!new_device_descriptor)
572 return -ENOMEM;
573 err = usb_get_descriptor(dev, USB_DT_DEVICE, descindex: 0,
574 buf: new_device_descriptor, size: sizeof(*new_device_descriptor));
575 if (err < 0)
576 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
577 if (new_device_descriptor->bNumConfigurations > dev->descriptor.bNumConfigurations)
578 dev_dbg(&dev->dev, "error too large bNumConfigurations: %d\n",
579 new_device_descriptor->bNumConfigurations);
580 else
581 memcpy(&dev->descriptor, new_device_descriptor, sizeof(dev->descriptor));
582 err = usb_reset_configuration(dev);
583 if (err < 0)
584 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
585 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
586 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
587 return -ENODEV; /* quit this anyway */
588 }
589 return 0;
590}
591
592static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
593{
594 u8 buf = 1;
595
596 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), request: 0x2a,
597 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
598 value: 0, index: 0, data: &buf, size: 1);
599 if (buf == 0) {
600 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), request: 0x29,
601 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
602 value: 1, index: 2000, NULL, size: 0);
603 return -ENODEV;
604 }
605 return 0;
606}
607
608static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
609{
610 int err;
611
612 if (dev->actconfig->desc.bConfigurationValue == 1) {
613 dev_info(&dev->dev,
614 "Fast Track Pro switching to config #2\n");
615 /* This function has to be available by the usb core module.
616 * if it is not avialable the boot quirk has to be left out
617 * and the configuration has to be set by udev or hotplug
618 * rules
619 */
620 err = usb_driver_set_configuration(udev: dev, config: 2);
621 if (err < 0)
622 dev_dbg(&dev->dev,
623 "error usb_driver_set_configuration: %d\n",
624 err);
625 /* Always return an error, so that we stop creating a device
626 that will just be destroyed and recreated with a new
627 configuration */
628 return -ENODEV;
629 } else
630 dev_info(&dev->dev, "Fast Track Pro config OK\n");
631
632 return 0;
633}
634
635/*
636 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
637 * documented in the device's data sheet.
638 */
639static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
640{
641 u8 buf[4];
642 buf[0] = 0x20;
643 buf[1] = value & 0xff;
644 buf[2] = (value >> 8) & 0xff;
645 buf[3] = reg;
646 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
647 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
648 value: 0, index: 0, data: &buf, size: 4);
649}
650
651static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
652{
653 /*
654 * Enable line-out driver mode, set headphone source to front
655 * channels, enable stereo mic.
656 */
657 return snd_usb_cm106_write_int_reg(dev, reg: 2, value: 0x8004);
658}
659
660/*
661 * CM6206 registers from the CM6206 datasheet rev 2.1
662 */
663#define CM6206_REG0_DMA_MASTER BIT(15)
664#define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
665#define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
666/* Bit 4 thru 11 is the S/PDIF category code */
667#define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
668#define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
669#define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
670#define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
671#define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
672
673#define CM6206_REG1_TEST_SEL_CLK BIT(14)
674#define CM6206_REG1_PLLBIN_EN BIT(13)
675#define CM6206_REG1_SOFT_MUTE_EN BIT(12)
676#define CM6206_REG1_GPIO4_OUT BIT(11)
677#define CM6206_REG1_GPIO4_OE BIT(10)
678#define CM6206_REG1_GPIO3_OUT BIT(9)
679#define CM6206_REG1_GPIO3_OE BIT(8)
680#define CM6206_REG1_GPIO2_OUT BIT(7)
681#define CM6206_REG1_GPIO2_OE BIT(6)
682#define CM6206_REG1_GPIO1_OUT BIT(5)
683#define CM6206_REG1_GPIO1_OE BIT(4)
684#define CM6206_REG1_SPDIFO_INVALID BIT(3)
685#define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
686#define CM6206_REG1_SPDIFO_DIS BIT(1)
687#define CM6206_REG1_SPDIFI_MIX BIT(0)
688
689#define CM6206_REG2_DRIVER_ON BIT(15)
690#define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
691#define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
692#define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
693#define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
694#define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
695#define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
696#define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
697#define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
698#define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
699#define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
700#define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
701#define CM6206_REG2_MUTE_CENTER BIT(5)
702#define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
703#define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
704#define CM6206_REG2_EN_BTL BIT(2)
705#define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
706#define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
707#define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
708#define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
709
710/* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
711#define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
712#define CM6206_REG3_VRAP25EN BIT(10)
713#define CM6206_REG3_MSEL1 BIT(9)
714#define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
715#define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
716#define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
717#define CM6206_REG3_PINSEL BIT(6)
718#define CM6206_REG3_FOE BIT(5)
719#define CM6206_REG3_ROE BIT(4)
720#define CM6206_REG3_CBOE BIT(3)
721#define CM6206_REG3_LOSE BIT(2)
722#define CM6206_REG3_HPOE BIT(1)
723#define CM6206_REG3_SPDIFI_CANREC BIT(0)
724
725#define CM6206_REG5_DA_RSTN BIT(13)
726#define CM6206_REG5_AD_RSTN BIT(12)
727#define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
728#define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
729#define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
730#define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
731#define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
732#define CM6206_REG5_CODECM BIT(8)
733#define CM6206_REG5_EN_HPF BIT(7)
734#define CM6206_REG5_T_SEL_DSDA4 BIT(6)
735#define CM6206_REG5_T_SEL_DSDA3 BIT(5)
736#define CM6206_REG5_T_SEL_DSDA2 BIT(4)
737#define CM6206_REG5_T_SEL_DSDA1 BIT(3)
738#define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
739#define CM6206_REG5_T_SEL_DSDAD_FRONT 4
740#define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
741#define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
742#define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
743
744static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
745{
746 int err = 0, reg;
747 int val[] = {
748 /*
749 * Values here are chosen based on sniffing USB traffic
750 * under Windows.
751 *
752 * REG0: DAC is master, sample rate 48kHz, no copyright
753 */
754 CM6206_REG0_SPDIFO_RATE_48K |
755 CM6206_REG0_SPDIFO_COPYRIGHT_NA,
756 /*
757 * REG1: PLL binary search enable, soft mute enable.
758 */
759 CM6206_REG1_PLLBIN_EN |
760 CM6206_REG1_SOFT_MUTE_EN,
761 /*
762 * REG2: enable output drivers,
763 * select front channels to the headphone output,
764 * then mute the headphone channels, run the MCU
765 * at 1.5 MHz.
766 */
767 CM6206_REG2_DRIVER_ON |
768 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
769 CM6206_REG2_MUTE_HEADPHONE_RIGHT |
770 CM6206_REG2_MUTE_HEADPHONE_LEFT,
771 /*
772 * REG3: default flyspeed, set 2.5V mic bias
773 * enable all line out ports and enable SPDIF
774 */
775 CM6206_REG3_FLYSPEED_DEFAULT |
776 CM6206_REG3_VRAP25EN |
777 CM6206_REG3_FOE |
778 CM6206_REG3_ROE |
779 CM6206_REG3_CBOE |
780 CM6206_REG3_LOSE |
781 CM6206_REG3_HPOE |
782 CM6206_REG3_SPDIFI_CANREC,
783 /* REG4 is just a bunch of GPIO lines */
784 0x0000,
785 /* REG5: de-assert AD/DA reset signals */
786 CM6206_REG5_DA_RSTN |
787 CM6206_REG5_AD_RSTN };
788
789 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
790 err = snd_usb_cm106_write_int_reg(dev, reg, value: val[reg]);
791 if (err < 0)
792 return err;
793 }
794
795 return err;
796}
797
798/* quirk for Plantronics GameCom 780 with CM6302 chip */
799static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
800{
801 /* set the initial volume and don't change; other values are either
802 * too loud or silent due to firmware bug (bko#65251)
803 */
804 u8 buf[2] = { 0x74, 0xe3 };
805 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
806 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
807 UAC_FU_VOLUME << 8, index: 9 << 8, data: buf, size: 2);
808}
809
810/*
811 * Novation Twitch DJ controller
812 * Focusrite Novation Saffire 6 USB audio card
813 */
814static int snd_usb_novation_boot_quirk(struct usb_device *dev)
815{
816 /* preemptively set up the device because otherwise the
817 * raw MIDI endpoints are not active */
818 usb_set_interface(dev, ifnum: 0, alternate: 1);
819 return 0;
820}
821
822/*
823 * This call will put the synth in "USB send" mode, i.e it will send MIDI
824 * messages through USB (this is disabled at startup). The synth will
825 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
826 * sign on its LCD. Values here are chosen based on sniffing USB traffic
827 * under Windows.
828 */
829static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
830{
831 int err, actual_length;
832 /* "midi send" enable */
833 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
834 void *buf;
835
836 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
837 return -EINVAL;
838 buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
839 if (!buf)
840 return -ENOMEM;
841 err = usb_interrupt_msg(usb_dev: dev, usb_sndintpipe(dev, 0x05), data: buf,
842 ARRAY_SIZE(seq), actual_length: &actual_length, timeout: 1000);
843 kfree(objp: buf);
844 if (err < 0)
845 return err;
846
847 return 0;
848}
849
850/*
851 * Some sound cards from Native Instruments are in fact compliant to the USB
852 * audio standard of version 2 and other approved USB standards, even though
853 * they come up as vendor-specific device when first connected.
854 *
855 * However, they can be told to come up with a new set of descriptors
856 * upon their next enumeration, and the interfaces announced by the new
857 * descriptors will then be handled by the kernel's class drivers. As the
858 * product ID will also change, no further checks are required.
859 */
860
861static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
862{
863 int ret;
864
865 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
866 request: 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
867 value: 1, index: 0, NULL, size: 0, timeout: 1000);
868
869 if (ret < 0)
870 return ret;
871
872 usb_reset_device(dev);
873
874 /* return -EAGAIN, so the creation of an audio interface for this
875 * temporary device is aborted. The device will reconnect with a
876 * new product ID */
877 return -EAGAIN;
878}
879
880static void mbox2_setup_48_24_magic(struct usb_device *dev)
881{
882 u8 srate[3];
883 u8 temp[12];
884
885 /* Choose 48000Hz permanently */
886 srate[0] = 0x80;
887 srate[1] = 0xbb;
888 srate[2] = 0x00;
889
890 /* Send the magic! */
891 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
892 request: 0x01, requesttype: 0x22, value: 0x0100, index: 0x0085, data: &temp, size: 0x0003);
893 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
894 request: 0x81, requesttype: 0xa2, value: 0x0100, index: 0x0085, data: &srate, size: 0x0003);
895 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
896 request: 0x81, requesttype: 0xa2, value: 0x0100, index: 0x0086, data: &srate, size: 0x0003);
897 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
898 request: 0x81, requesttype: 0xa2, value: 0x0100, index: 0x0003, data: &srate, size: 0x0003);
899 return;
900}
901
902/* Digidesign Mbox 2 needs to load firmware onboard
903 * and driver must wait a few seconds for initialisation.
904 */
905
906#define MBOX2_FIRMWARE_SIZE 646
907#define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
908#define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
909
910static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
911{
912 struct usb_host_config *config = dev->actconfig;
913 struct usb_device_descriptor *new_device_descriptor __free(kfree) = NULL;
914 int err;
915 u8 bootresponse[0x12];
916 int fwsize;
917 int count;
918
919 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
920
921 if (fwsize != MBOX2_FIRMWARE_SIZE) {
922 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
923 return -ENODEV;
924 }
925
926 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
927
928 count = 0;
929 bootresponse[0] = MBOX2_BOOT_LOADING;
930 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
931 msleep(msecs: 500); /* 0.5 second delay */
932 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
933 /* Control magic - load onboard firmware */
934 request: 0x85, requesttype: 0xc0, value: 0x0001, index: 0x0000, data: &bootresponse, size: 0x0012);
935 if (bootresponse[0] == MBOX2_BOOT_READY)
936 break;
937 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
938 count++;
939 }
940
941 if (bootresponse[0] != MBOX2_BOOT_READY) {
942 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
943 return -ENODEV;
944 }
945
946 dev_dbg(&dev->dev, "device initialised!\n");
947
948 new_device_descriptor = kmalloc(sizeof(*new_device_descriptor), GFP_KERNEL);
949 if (!new_device_descriptor)
950 return -ENOMEM;
951
952 err = usb_get_descriptor(dev, USB_DT_DEVICE, descindex: 0,
953 buf: new_device_descriptor, size: sizeof(*new_device_descriptor));
954 if (err < 0)
955 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
956 if (new_device_descriptor->bNumConfigurations > dev->descriptor.bNumConfigurations)
957 dev_dbg(&dev->dev, "error too large bNumConfigurations: %d\n",
958 new_device_descriptor->bNumConfigurations);
959 else
960 memcpy(&dev->descriptor, new_device_descriptor, sizeof(dev->descriptor));
961
962 err = usb_reset_configuration(dev);
963 if (err < 0)
964 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
965 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
966 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
967
968 mbox2_setup_48_24_magic(dev);
969
970 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
971
972 return 0; /* Successful boot */
973}
974
975static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
976{
977 int err;
978
979 dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
980
981 /* If the Axe-Fx III has not fully booted, it will timeout when trying
982 * to enable the audio streaming interface. A more generous timeout is
983 * used here to detect when the Axe-Fx III has finished booting as the
984 * set interface message will be acked once it has
985 */
986 err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
987 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
988 value: 1, index: 1, NULL, size: 0, timeout: 120000);
989 if (err < 0) {
990 dev_err(&dev->dev,
991 "failed waiting for Axe-Fx III to boot: %d\n", err);
992 return err;
993 }
994
995 dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
996
997 err = usb_set_interface(dev, ifnum: 1, alternate: 0);
998 if (err < 0)
999 dev_dbg(&dev->dev,
1000 "error stopping Axe-Fx III interface: %d\n", err);
1001
1002 return 0;
1003}
1004
1005static void mbox3_setup_defaults(struct usb_device *dev)
1006{
1007 /* The Mbox 3 is "little endian" */
1008 /* max volume is: 0x0000. */
1009 /* min volume is: 0x0080 (shown in little endian form) */
1010
1011 u8 com_buff[2];
1012
1013 /* Deactivate Tuner */
1014 /* on = 0x01*/
1015 /* off = 0x00*/
1016 com_buff[0] = 0x00;
1017 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1018 request: 0x01, requesttype: 0x21, value: 0x0003, index: 0x2001, data: &com_buff, size: 1);
1019
1020 /* Set clock source to Internal (as opposed to S/PDIF) */
1021 /* Internal = 0x01*/
1022 /* S/PDIF = 0x02*/
1023 com_buff[0] = 0x01;
1024 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1025 request: 1, requesttype: 0x21, value: 0x0100, index: 0x8001, data: &com_buff, size: 1);
1026
1027 /* Mute the hardware loopbacks to start the device in a known state. */
1028 com_buff[0] = 0x00;
1029 com_buff[1] = 0x80;
1030 /* Analogue input 1 left channel: */
1031 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1032 request: 1, requesttype: 0x21, value: 0x0110, index: 0x4001, data: &com_buff, size: 2);
1033 /* Analogue input 1 right channel: */
1034 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1035 request: 1, requesttype: 0x21, value: 0x0111, index: 0x4001, data: &com_buff, size: 2);
1036 /* Analogue input 2 left channel: */
1037 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1038 request: 1, requesttype: 0x21, value: 0x0114, index: 0x4001, data: &com_buff, size: 2);
1039 /* Analogue input 2 right channel: */
1040 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1041 request: 1, requesttype: 0x21, value: 0x0115, index: 0x4001, data: &com_buff, size: 2);
1042 /* Analogue input 3 left channel: */
1043 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1044 request: 1, requesttype: 0x21, value: 0x0118, index: 0x4001, data: &com_buff, size: 2);
1045 /* Analogue input 3 right channel: */
1046 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1047 request: 1, requesttype: 0x21, value: 0x0119, index: 0x4001, data: &com_buff, size: 2);
1048 /* Analogue input 4 left channel: */
1049 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1050 request: 1, requesttype: 0x21, value: 0x011c, index: 0x4001, data: &com_buff, size: 2);
1051 /* Analogue input 4 right channel: */
1052 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1053 request: 1, requesttype: 0x21, value: 0x011d, index: 0x4001, data: &com_buff, size: 2);
1054
1055 /* Set software sends to output */
1056 com_buff[0] = 0x00;
1057 com_buff[1] = 0x00;
1058 /* Analogue software return 1 left channel: */
1059 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1060 request: 1, requesttype: 0x21, value: 0x0100, index: 0x4001, data: &com_buff, size: 2);
1061 com_buff[0] = 0x00;
1062 com_buff[1] = 0x80;
1063 /* Analogue software return 1 right channel: */
1064 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1065 request: 1, requesttype: 0x21, value: 0x0101, index: 0x4001, data: &com_buff, size: 2);
1066 com_buff[0] = 0x00;
1067 com_buff[1] = 0x80;
1068 /* Analogue software return 2 left channel: */
1069 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1070 request: 1, requesttype: 0x21, value: 0x0104, index: 0x4001, data: &com_buff, size: 2);
1071 com_buff[0] = 0x00;
1072 com_buff[1] = 0x00;
1073 /* Analogue software return 2 right channel: */
1074 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1075 request: 1, requesttype: 0x21, value: 0x0105, index: 0x4001, data: &com_buff, size: 2);
1076
1077 com_buff[0] = 0x00;
1078 com_buff[1] = 0x80;
1079 /* Analogue software return 3 left channel: */
1080 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1081 request: 1, requesttype: 0x21, value: 0x0108, index: 0x4001, data: &com_buff, size: 2);
1082 /* Analogue software return 3 right channel: */
1083 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1084 request: 1, requesttype: 0x21, value: 0x0109, index: 0x4001, data: &com_buff, size: 2);
1085 /* Analogue software return 4 left channel: */
1086 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1087 request: 1, requesttype: 0x21, value: 0x010c, index: 0x4001, data: &com_buff, size: 2);
1088 /* Analogue software return 4 right channel: */
1089 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1090 request: 1, requesttype: 0x21, value: 0x010d, index: 0x4001, data: &com_buff, size: 2);
1091
1092 /* Return to muting sends */
1093 com_buff[0] = 0x00;
1094 com_buff[1] = 0x80;
1095 /* Analogue fx return left channel: */
1096 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1097 request: 1, requesttype: 0x21, value: 0x0120, index: 0x4001, data: &com_buff, size: 2);
1098 /* Analogue fx return right channel: */
1099 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1100 request: 1, requesttype: 0x21, value: 0x0121, index: 0x4001, data: &com_buff, size: 2);
1101
1102 /* Analogue software input 1 fx send: */
1103 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1104 request: 1, requesttype: 0x21, value: 0x0100, index: 0x4201, data: &com_buff, size: 2);
1105 /* Analogue software input 2 fx send: */
1106 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1107 request: 1, requesttype: 0x21, value: 0x0101, index: 0x4201, data: &com_buff, size: 2);
1108 /* Analogue software input 3 fx send: */
1109 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1110 request: 1, requesttype: 0x21, value: 0x0102, index: 0x4201, data: &com_buff, size: 2);
1111 /* Analogue software input 4 fx send: */
1112 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1113 request: 1, requesttype: 0x21, value: 0x0103, index: 0x4201, data: &com_buff, size: 2);
1114 /* Analogue input 1 fx send: */
1115 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1116 request: 1, requesttype: 0x21, value: 0x0104, index: 0x4201, data: &com_buff, size: 2);
1117 /* Analogue input 2 fx send: */
1118 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1119 request: 1, requesttype: 0x21, value: 0x0105, index: 0x4201, data: &com_buff, size: 2);
1120 /* Analogue input 3 fx send: */
1121 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1122 request: 1, requesttype: 0x21, value: 0x0106, index: 0x4201, data: &com_buff, size: 2);
1123 /* Analogue input 4 fx send: */
1124 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1125 request: 1, requesttype: 0x21, value: 0x0107, index: 0x4201, data: &com_buff, size: 2);
1126
1127 /* Toggle allowing host control */
1128 /* Not needed
1129 com_buff[0] = 0x02;
1130 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1131 3, 0x21, 0x0000, 0x2001, &com_buff, 1);
1132 */
1133
1134 /* Do not dim fx returns */
1135 com_buff[0] = 0x00;
1136 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1137 request: 3, requesttype: 0x21, value: 0x0002, index: 0x2001, data: &com_buff, size: 1);
1138
1139 /* Do not set fx returns to mono */
1140 com_buff[0] = 0x00;
1141 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1142 request: 3, requesttype: 0x21, value: 0x0001, index: 0x2001, data: &com_buff, size: 1);
1143
1144 /* Mute the S/PDIF hardware loopback
1145 * same odd volume logic here as above
1146 */
1147 com_buff[0] = 0x00;
1148 com_buff[1] = 0x80;
1149 /* S/PDIF hardware input 1 left channel */
1150 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1151 request: 1, requesttype: 0x21, value: 0x0112, index: 0x4001, data: &com_buff, size: 2);
1152 /* S/PDIF hardware input 1 right channel */
1153 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1154 request: 1, requesttype: 0x21, value: 0x0113, index: 0x4001, data: &com_buff, size: 2);
1155 /* S/PDIF hardware input 2 left channel */
1156 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1157 request: 1, requesttype: 0x21, value: 0x0116, index: 0x4001, data: &com_buff, size: 2);
1158 /* S/PDIF hardware input 2 right channel */
1159 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1160 request: 1, requesttype: 0x21, value: 0x0117, index: 0x4001, data: &com_buff, size: 2);
1161 /* S/PDIF hardware input 3 left channel */
1162 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1163 request: 1, requesttype: 0x21, value: 0x011a, index: 0x4001, data: &com_buff, size: 2);
1164 /* S/PDIF hardware input 3 right channel */
1165 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1166 request: 1, requesttype: 0x21, value: 0x011b, index: 0x4001, data: &com_buff, size: 2);
1167 /* S/PDIF hardware input 4 left channel */
1168 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1169 request: 1, requesttype: 0x21, value: 0x011e, index: 0x4001, data: &com_buff, size: 2);
1170 /* S/PDIF hardware input 4 right channel */
1171 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1172 request: 1, requesttype: 0x21, value: 0x011f, index: 0x4001, data: &com_buff, size: 2);
1173 /* S/PDIF software return 1 left channel */
1174 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1175 request: 1, requesttype: 0x21, value: 0x0102, index: 0x4001, data: &com_buff, size: 2);
1176 /* S/PDIF software return 1 right channel */
1177 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1178 request: 1, requesttype: 0x21, value: 0x0103, index: 0x4001, data: &com_buff, size: 2);
1179 /* S/PDIF software return 2 left channel */
1180 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1181 request: 1, requesttype: 0x21, value: 0x0106, index: 0x4001, data: &com_buff, size: 2);
1182 /* S/PDIF software return 2 right channel */
1183 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1184 request: 1, requesttype: 0x21, value: 0x0107, index: 0x4001, data: &com_buff, size: 2);
1185
1186 com_buff[0] = 0x00;
1187 com_buff[1] = 0x00;
1188 /* S/PDIF software return 3 left channel */
1189 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1190 request: 1, requesttype: 0x21, value: 0x010a, index: 0x4001, data: &com_buff, size: 2);
1191
1192 com_buff[0] = 0x00;
1193 com_buff[1] = 0x80;
1194 /* S/PDIF software return 3 right channel */
1195 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1196 request: 1, requesttype: 0x21, value: 0x010b, index: 0x4001, data: &com_buff, size: 2);
1197 /* S/PDIF software return 4 left channel */
1198 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1199 request: 1, requesttype: 0x21, value: 0x010e, index: 0x4001, data: &com_buff, size: 2);
1200
1201 com_buff[0] = 0x00;
1202 com_buff[1] = 0x00;
1203 /* S/PDIF software return 4 right channel */
1204 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1205 request: 1, requesttype: 0x21, value: 0x010f, index: 0x4001, data: &com_buff, size: 2);
1206
1207 com_buff[0] = 0x00;
1208 com_buff[1] = 0x80;
1209 /* S/PDIF fx returns left channel */
1210 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1211 request: 1, requesttype: 0x21, value: 0x0122, index: 0x4001, data: &com_buff, size: 2);
1212 /* S/PDIF fx returns right channel */
1213 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1214 request: 1, requesttype: 0x21, value: 0x0123, index: 0x4001, data: &com_buff, size: 2);
1215
1216 /* Set the dropdown "Effect" to the first option */
1217 /* Room1 = 0x00 */
1218 /* Room2 = 0x01 */
1219 /* Room3 = 0x02 */
1220 /* Hall 1 = 0x03 */
1221 /* Hall 2 = 0x04 */
1222 /* Plate = 0x05 */
1223 /* Delay = 0x06 */
1224 /* Echo = 0x07 */
1225 com_buff[0] = 0x00;
1226 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1227 request: 1, requesttype: 0x21, value: 0x0200, index: 0x4301, data: &com_buff, size: 1); /* max is 0xff */
1228 /* min is 0x00 */
1229
1230
1231 /* Set the effect duration to 0 */
1232 /* max is 0xffff */
1233 /* min is 0x0000 */
1234 com_buff[0] = 0x00;
1235 com_buff[1] = 0x00;
1236 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1237 request: 1, requesttype: 0x21, value: 0x0400, index: 0x4301, data: &com_buff, size: 2);
1238
1239 /* Set the effect volume and feedback to 0 */
1240 /* max is 0xff */
1241 /* min is 0x00 */
1242 com_buff[0] = 0x00;
1243 /* feedback: */
1244 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1245 request: 1, requesttype: 0x21, value: 0x0500, index: 0x4301, data: &com_buff, size: 1);
1246 /* volume: */
1247 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1248 request: 1, requesttype: 0x21, value: 0x0300, index: 0x4301, data: &com_buff, size: 1);
1249
1250 /* Set soft button hold duration */
1251 /* 0x03 = 250ms */
1252 /* 0x05 = 500ms DEFAULT */
1253 /* 0x08 = 750ms */
1254 /* 0x0a = 1sec */
1255 com_buff[0] = 0x05;
1256 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1257 request: 3, requesttype: 0x21, value: 0x0005, index: 0x2001, data: &com_buff, size: 1);
1258
1259 /* Use dim LEDs for button of state */
1260 com_buff[0] = 0x00;
1261 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1262 request: 3, requesttype: 0x21, value: 0x0004, index: 0x2001, data: &com_buff, size: 1);
1263}
1264
1265#define MBOX3_DESCRIPTOR_SIZE 464
1266
1267static int snd_usb_mbox3_boot_quirk(struct usb_device *dev)
1268{
1269 struct usb_host_config *config = dev->actconfig;
1270 struct usb_device_descriptor *new_device_descriptor __free(kfree) = NULL;
1271 int err;
1272 int descriptor_size;
1273
1274 descriptor_size = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
1275
1276 if (descriptor_size != MBOX3_DESCRIPTOR_SIZE) {
1277 dev_err(&dev->dev, "MBOX3: Invalid descriptor size=%d.\n", descriptor_size);
1278 return -ENODEV;
1279 }
1280
1281 dev_dbg(&dev->dev, "MBOX3: device initialised!\n");
1282
1283 new_device_descriptor = kmalloc(sizeof(*new_device_descriptor), GFP_KERNEL);
1284 if (!new_device_descriptor)
1285 return -ENOMEM;
1286
1287 err = usb_get_descriptor(dev, USB_DT_DEVICE, descindex: 0,
1288 buf: new_device_descriptor, size: sizeof(*new_device_descriptor));
1289 if (err < 0)
1290 dev_dbg(&dev->dev, "MBOX3: error usb_get_descriptor: %d\n", err);
1291 if (new_device_descriptor->bNumConfigurations > dev->descriptor.bNumConfigurations)
1292 dev_dbg(&dev->dev, "MBOX3: error too large bNumConfigurations: %d\n",
1293 new_device_descriptor->bNumConfigurations);
1294 else
1295 memcpy(&dev->descriptor, new_device_descriptor, sizeof(dev->descriptor));
1296
1297 err = usb_reset_configuration(dev);
1298 if (err < 0)
1299 dev_dbg(&dev->dev, "MBOX3: error usb_reset_configuration: %d\n", err);
1300
1301 dev_dbg(&dev->dev, "MBOX3: new boot length = %d\n",
1302 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
1303
1304 mbox3_setup_defaults(dev);
1305 dev_info(&dev->dev, "MBOX3: Initialized.");
1306
1307 return 0; /* Successful boot */
1308}
1309
1310#define MICROBOOK_BUF_SIZE 128
1311
1312static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1313 int buf_size, int *length)
1314{
1315 int err, actual_length;
1316
1317 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
1318 return -EINVAL;
1319 err = usb_interrupt_msg(usb_dev: dev, usb_sndintpipe(dev, 0x01), data: buf, len: *length,
1320 actual_length: &actual_length, timeout: 1000);
1321 if (err < 0)
1322 return err;
1323
1324 print_hex_dump(KERN_DEBUG, prefix_str: "MicroBookII snd: ", prefix_type: DUMP_PREFIX_NONE, rowsize: 16, groupsize: 1,
1325 buf, len: actual_length, ascii: false);
1326
1327 memset(buf, 0, buf_size);
1328
1329 if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
1330 return -EINVAL;
1331 err = usb_interrupt_msg(usb_dev: dev, usb_rcvintpipe(dev, 0x82), data: buf, len: buf_size,
1332 actual_length: &actual_length, timeout: 1000);
1333 if (err < 0)
1334 return err;
1335
1336 print_hex_dump(KERN_DEBUG, prefix_str: "MicroBookII rcv: ", prefix_type: DUMP_PREFIX_NONE, rowsize: 16, groupsize: 1,
1337 buf, len: actual_length, ascii: false);
1338
1339 *length = actual_length;
1340 return 0;
1341}
1342
1343static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1344{
1345 int err, actual_length, poll_attempts = 0;
1346 static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1347 0x00, 0x00, 0x0b, 0x14,
1348 0x00, 0x00, 0x00, 0x01 };
1349 static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1350 0x00, 0x00, 0x0b, 0x18 };
1351 u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1352
1353 if (!buf)
1354 return -ENOMEM;
1355
1356 dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1357
1358 /* First we tell the device which sample rate to use. */
1359 memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1360 actual_length = sizeof(set_samplerate_seq);
1361 err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1362 length: &actual_length);
1363
1364 if (err < 0) {
1365 dev_err(&dev->dev,
1366 "failed setting the sample rate for Motu MicroBook II: %d\n",
1367 err);
1368 goto free_buf;
1369 }
1370
1371 /* Then we poll every 100 ms until the device informs of its readiness. */
1372 while (true) {
1373 if (++poll_attempts > 100) {
1374 dev_err(&dev->dev,
1375 "failed booting Motu MicroBook II: timeout\n");
1376 err = -ENODEV;
1377 goto free_buf;
1378 }
1379
1380 memset(buf, 0, MICROBOOK_BUF_SIZE);
1381 memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1382
1383 actual_length = sizeof(poll_ready_seq);
1384 err = snd_usb_motu_microbookii_communicate(
1385 dev, buf, MICROBOOK_BUF_SIZE, length: &actual_length);
1386 if (err < 0) {
1387 dev_err(&dev->dev,
1388 "failed booting Motu MicroBook II: communication error %d\n",
1389 err);
1390 goto free_buf;
1391 }
1392
1393 /* the device signals its readiness through a message of the
1394 * form
1395 * XX 06 00 00 00 00 0b 18 00 00 00 01
1396 * If the device is not yet ready to accept audio data, the
1397 * last byte of that sequence is 00.
1398 */
1399 if (actual_length == 12 && buf[actual_length - 1] == 1)
1400 break;
1401
1402 msleep(msecs: 100);
1403 }
1404
1405 dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1406
1407free_buf:
1408 kfree(objp: buf);
1409 return err;
1410}
1411
1412static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1413{
1414 msleep(msecs: 4000);
1415
1416 return 0;
1417}
1418
1419static int snd_usb_rme_digiface_boot_quirk(struct usb_device *dev)
1420{
1421 /* Disable mixer, internal clock, all outputs ADAT, 48kHz, TMS off */
1422 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1423 request: 16, requesttype: 0x40, value: 0x2410, index: 0x7fff, NULL, size: 0);
1424 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1425 request: 18, requesttype: 0x40, value: 0x0104, index: 0xffff, NULL, size: 0);
1426
1427 /* Disable loopback for all inputs */
1428 for (int ch = 0; ch < 32; ch++)
1429 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1430 request: 22, requesttype: 0x40, value: 0x400, index: ch, NULL, size: 0);
1431
1432 /* Unity gain for all outputs */
1433 for (int ch = 0; ch < 34; ch++)
1434 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1435 request: 21, requesttype: 0x40, value: 0x9000, index: 0x100 + ch, NULL, size: 0);
1436
1437 return 0;
1438}
1439
1440/*
1441 * Setup quirks
1442 */
1443#define MAUDIO_SET 0x01 /* parse device_setup */
1444#define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
1445#define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
1446#define MAUDIO_SET_96K 0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
1447#define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
1448#define MAUDIO_SET_DI 0x10 /* enable Digital Input */
1449#define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
1450#define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48kHz+Digital Input */
1451#define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48kHz+No Digital Input */
1452#define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48kHz+Digital Input */
1453#define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48kHz+No Digital Input */
1454
1455static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1456 int iface, int altno)
1457{
1458 /* Reset ALL ifaces to 0 altsetting.
1459 * Call it for every possible altsetting of every interface.
1460 */
1461 usb_set_interface(dev: chip->dev, ifnum: iface, alternate: 0);
1462 if (chip->setup & MAUDIO_SET) {
1463 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1464 if (iface != 1 && iface != 2)
1465 return 1; /* skip all interfaces but 1 and 2 */
1466 } else {
1467 unsigned int mask;
1468 if (iface == 1 || iface == 2)
1469 return 1; /* skip interfaces 1 and 2 */
1470 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1471 return 1; /* skip this altsetting */
1472 mask = chip->setup & MAUDIO_SET_MASK;
1473 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1474 return 1; /* skip this altsetting */
1475 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1476 return 1; /* skip this altsetting */
1477 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1478 return 1; /* skip this altsetting */
1479 }
1480 }
1481 usb_audio_dbg(chip,
1482 "using altsetting %d for interface %d config %d\n",
1483 altno, iface, chip->setup);
1484 return 0; /* keep this altsetting */
1485}
1486
1487static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1488 int iface,
1489 int altno)
1490{
1491 /* Reset ALL ifaces to 0 altsetting.
1492 * Call it for every possible altsetting of every interface.
1493 */
1494 usb_set_interface(dev: chip->dev, ifnum: iface, alternate: 0);
1495
1496 if (chip->setup & MAUDIO_SET) {
1497 unsigned int mask;
1498 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1499 return 1; /* skip this altsetting */
1500 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1501 return 1; /* skip this altsetting */
1502 mask = chip->setup & MAUDIO_SET_MASK;
1503 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1504 return 1; /* skip this altsetting */
1505 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1506 return 1; /* skip this altsetting */
1507 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1508 return 1; /* skip this altsetting */
1509 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1510 return 1; /* skip this altsetting */
1511 }
1512
1513 return 0; /* keep this altsetting */
1514}
1515
1516static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1517 int iface, int altno)
1518{
1519 /* Reset ALL ifaces to 0 altsetting.
1520 * Call it for every possible altsetting of every interface.
1521 */
1522 usb_set_interface(dev: chip->dev, ifnum: iface, alternate: 0);
1523
1524 /* possible configuration where both inputs and only one output is
1525 *used is not supported by the current setup
1526 */
1527 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1528 if (chip->setup & MAUDIO_SET_96K) {
1529 if (altno != 3 && altno != 6)
1530 return 1;
1531 } else if (chip->setup & MAUDIO_SET_DI) {
1532 if (iface == 4)
1533 return 1; /* no analog input */
1534 if (altno != 2 && altno != 5)
1535 return 1; /* enable only altsets 2 and 5 */
1536 } else {
1537 if (iface == 5)
1538 return 1; /* disable digialt input */
1539 if (altno != 2 && altno != 5)
1540 return 1; /* enalbe only altsets 2 and 5 */
1541 }
1542 } else {
1543 /* keep only 16-Bit mode */
1544 if (altno != 1)
1545 return 1;
1546 }
1547
1548 usb_audio_dbg(chip,
1549 "using altsetting %d for interface %d config %d\n",
1550 altno, iface, chip->setup);
1551 return 0; /* keep this altsetting */
1552}
1553
1554static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1555 int iface, int altno)
1556{
1557 /*
1558 * Altno settings:
1559 *
1560 * Playback (Interface 1):
1561 * 1: 6 Analog + 2 S/PDIF
1562 * 2: 6 Analog + 2 S/PDIF
1563 * 3: 6 Analog
1564 *
1565 * Capture (Interface 2):
1566 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1567 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1568 * 3: 8 Analog
1569 */
1570
1571 /*
1572 * I'll leave 2 as the default one and
1573 * use device_setup to switch to the
1574 * other two.
1575 */
1576 if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1577 return 1;
1578 else if (chip->setup == 1 && altno != 1)
1579 return 1;
1580 else if (chip->setup == 2 && altno != 3)
1581 return 1;
1582
1583 return 0;
1584}
1585
1586int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1587 int iface,
1588 int altno)
1589{
1590 /* audiophile usb: skip altsets incompatible with device_setup */
1591 if (chip->usb_id == USB_ID(0x0763, 0x2003))
1592 return audiophile_skip_setting_quirk(chip, iface, altno);
1593 /* quattro usb: skip altsets incompatible with device_setup */
1594 if (chip->usb_id == USB_ID(0x0763, 0x2001))
1595 return quattro_skip_setting_quirk(chip, iface, altno);
1596 /* fasttrackpro usb: skip altsets incompatible with device_setup */
1597 if (chip->usb_id == USB_ID(0x0763, 0x2012))
1598 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
1599 /* presonus studio 1810c: skip altsets incompatible with device_setup */
1600 if (chip->usb_id == USB_ID(0x194f, 0x010c))
1601 return s1810c_skip_setting_quirk(chip, iface, altno);
1602
1603 return 0;
1604}
1605
1606int snd_usb_apply_boot_quirk(struct usb_device *dev,
1607 struct usb_interface *intf,
1608 const struct snd_usb_audio_quirk *quirk,
1609 unsigned int id)
1610{
1611 switch (id) {
1612 case USB_ID(0x041e, 0x3000):
1613 /* SB Extigy needs special boot-up sequence */
1614 /* if more models come, this will go to the quirk list. */
1615 return snd_usb_extigy_boot_quirk(dev, intf);
1616
1617 case USB_ID(0x041e, 0x3020):
1618 /* SB Audigy 2 NX needs its own boot-up magic, too */
1619 return snd_usb_audigy2nx_boot_quirk(dev);
1620
1621 case USB_ID(0x10f5, 0x0200):
1622 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1623 return snd_usb_cm106_boot_quirk(dev);
1624
1625 case USB_ID(0x0d8c, 0x0102):
1626 /* C-Media CM6206 / CM106-Like Sound Device */
1627 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1628 return snd_usb_cm6206_boot_quirk(dev);
1629
1630 case USB_ID(0x0dba, 0x3000):
1631 /* Digidesign Mbox 2 */
1632 return snd_usb_mbox2_boot_quirk(dev);
1633 case USB_ID(0x0dba, 0x5000):
1634 /* Digidesign Mbox 3 */
1635 return snd_usb_mbox3_boot_quirk(dev);
1636
1637
1638 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1639 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1640 return snd_usb_novation_boot_quirk(dev);
1641
1642 case USB_ID(0x133e, 0x0815):
1643 /* Access Music VirusTI Desktop */
1644 return snd_usb_accessmusic_boot_quirk(dev);
1645
1646 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1647 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1648 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1649 return snd_usb_nativeinstruments_boot_quirk(dev);
1650 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1651 return snd_usb_fasttrackpro_boot_quirk(dev);
1652 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1653 return snd_usb_gamecon780_boot_quirk(dev);
1654 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1655 return snd_usb_axefx3_boot_quirk(dev);
1656 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1657 /*
1658 * For some reason interface 3 with vendor-spec class is
1659 * detected on MicroBook IIc.
1660 */
1661 if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1662 USB_CLASS_VENDOR_SPEC &&
1663 get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1664 return snd_usb_motu_microbookii_boot_quirk(dev);
1665 break;
1666 case USB_ID(0x2a39, 0x3f8c): /* RME Digiface USB */
1667 case USB_ID(0x2a39, 0x3fa0): /* RME Digiface USB (alternate) */
1668 return snd_usb_rme_digiface_boot_quirk(dev);
1669 }
1670
1671 return 0;
1672}
1673
1674int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1675 struct usb_interface *intf,
1676 const struct snd_usb_audio_quirk *quirk,
1677 unsigned int id)
1678{
1679 switch (id) {
1680 case USB_ID(0x07fd, 0x0008): /* MOTU M Series, 1st hardware version */
1681 return snd_usb_motu_m_series_boot_quirk(dev);
1682 }
1683
1684 return 0;
1685}
1686
1687/*
1688 * check if the device uses big-endian samples
1689 */
1690int snd_usb_is_big_endian_format(struct snd_usb_audio *chip,
1691 const struct audioformat *fp)
1692{
1693 /* it depends on altsetting whether the device is big-endian or not */
1694 switch (chip->usb_id) {
1695 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1696 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1697 fp->altsetting == 5 || fp->altsetting == 6)
1698 return 1;
1699 break;
1700 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1701 if (chip->setup == 0x00 ||
1702 fp->altsetting == 1 || fp->altsetting == 2 ||
1703 fp->altsetting == 3)
1704 return 1;
1705 break;
1706 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1707 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1708 fp->altsetting == 5 || fp->altsetting == 6)
1709 return 1;
1710 break;
1711 }
1712 return 0;
1713}
1714
1715/*
1716 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1717 * not for interface.
1718 */
1719
1720enum {
1721 EMU_QUIRK_SR_44100HZ = 0,
1722 EMU_QUIRK_SR_48000HZ,
1723 EMU_QUIRK_SR_88200HZ,
1724 EMU_QUIRK_SR_96000HZ,
1725 EMU_QUIRK_SR_176400HZ,
1726 EMU_QUIRK_SR_192000HZ
1727};
1728
1729static void set_format_emu_quirk(struct snd_usb_substream *subs,
1730 const struct audioformat *fmt)
1731{
1732 unsigned char emu_samplerate_id = 0;
1733
1734 /* When capture is active
1735 * sample rate shouldn't be changed
1736 * by playback substream
1737 */
1738 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1739 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].cur_audiofmt)
1740 return;
1741 }
1742
1743 switch (fmt->rate_min) {
1744 case 48000:
1745 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1746 break;
1747 case 88200:
1748 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1749 break;
1750 case 96000:
1751 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1752 break;
1753 case 176400:
1754 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1755 break;
1756 case 192000:
1757 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1758 break;
1759 default:
1760 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1761 break;
1762 }
1763 snd_emuusb_set_samplerate(chip: subs->stream->chip, samplerate_id: emu_samplerate_id);
1764 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1765}
1766
1767static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs,
1768 u16 windex)
1769{
1770 unsigned int cur_rate = subs->data_endpoint->cur_rate;
1771 u8 sr[3];
1772 // Convert to little endian
1773 sr[0] = cur_rate & 0xff;
1774 sr[1] = (cur_rate >> 8) & 0xff;
1775 sr[2] = (cur_rate >> 16) & 0xff;
1776 usb_set_interface(dev: subs->dev, ifnum: 0, alternate: 1);
1777 // we should derive windex from fmt-sync_ep but it's not set
1778 snd_usb_ctl_msg(dev: subs->stream->chip->dev,
1779 usb_sndctrlpipe(subs->stream->chip->dev, 0),
1780 request: 0x01, requesttype: 0x22, value: 0x0100, index: windex, data: &sr, size: 0x0003);
1781 return 0;
1782}
1783
1784static void mbox3_set_format_quirk(struct snd_usb_substream *subs,
1785 const struct audioformat *fmt)
1786{
1787 __le32 buff4 = 0;
1788 u8 buff1 = 0x01;
1789 u32 new_rate = subs->data_endpoint->cur_rate;
1790 u32 current_rate;
1791
1792 // Get current rate from card and check if changing it is needed
1793 snd_usb_ctl_msg(dev: subs->dev, usb_rcvctrlpipe(subs->dev, 0),
1794 request: 0x01, requesttype: 0x21 | USB_DIR_IN, value: 0x0100, index: 0x8101, data: &buff4, size: 4);
1795 current_rate = le32_to_cpu(buff4);
1796 dev_dbg(&subs->dev->dev,
1797 "MBOX3: Current configured sample rate: %d", current_rate);
1798 if (current_rate == new_rate) {
1799 dev_dbg(&subs->dev->dev,
1800 "MBOX3: No change needed (current rate:%d == new rate:%d)",
1801 current_rate, new_rate);
1802 return;
1803 }
1804
1805 // Set new rate
1806 dev_info(&subs->dev->dev,
1807 "MBOX3: Changing sample rate to: %d", new_rate);
1808 buff4 = cpu_to_le32(new_rate);
1809 snd_usb_ctl_msg(dev: subs->dev, usb_sndctrlpipe(subs->dev, 0),
1810 request: 0x01, requesttype: 0x21, value: 0x0100, index: 0x8101, data: &buff4, size: 4);
1811
1812 // Set clock source to Internal
1813 snd_usb_ctl_msg(dev: subs->dev, usb_sndctrlpipe(subs->dev, 0),
1814 request: 0x01, requesttype: 0x21, value: 0x0100, index: 0x8001, data: &buff1, size: 1);
1815
1816 // Check whether the change was successful
1817 buff4 = 0;
1818 snd_usb_ctl_msg(dev: subs->dev, usb_rcvctrlpipe(subs->dev, 0),
1819 request: 0x01, requesttype: 0x21 | USB_DIR_IN, value: 0x0100, index: 0x8101, data: &buff4, size: 4);
1820 if (new_rate != le32_to_cpu(buff4))
1821 dev_warn(&subs->dev->dev, "MBOX3: Couldn't set the sample rate");
1822}
1823
1824static const int rme_digiface_rate_table[] = {
1825 32000, 44100, 48000, 0,
1826 64000, 88200, 96000, 0,
1827 128000, 176400, 192000, 0,
1828};
1829
1830static int rme_digiface_set_format_quirk(struct snd_usb_substream *subs)
1831{
1832 unsigned int cur_rate = subs->data_endpoint->cur_rate;
1833 u16 val;
1834 int speed_mode;
1835 int id;
1836
1837 for (id = 0; id < ARRAY_SIZE(rme_digiface_rate_table); id++) {
1838 if (rme_digiface_rate_table[id] == cur_rate)
1839 break;
1840 }
1841
1842 if (id >= ARRAY_SIZE(rme_digiface_rate_table))
1843 return -EINVAL;
1844
1845 /* 2, 3, 4 for 1x, 2x, 4x */
1846 speed_mode = (id >> 2) + 2;
1847 val = (id << 3) | (speed_mode << 12);
1848
1849 /* Set the sample rate */
1850 snd_usb_ctl_msg(dev: subs->stream->chip->dev,
1851 usb_sndctrlpipe(subs->stream->chip->dev, 0),
1852 request: 16, requesttype: 0x40, value: val, index: 0x7078, NULL, size: 0);
1853 return 0;
1854}
1855
1856void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1857 const struct audioformat *fmt)
1858{
1859 switch (subs->stream->chip->usb_id) {
1860 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1861 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1862 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1863 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1864 set_format_emu_quirk(subs, fmt);
1865 break;
1866 case USB_ID(0x534d, 0x0021): /* MacroSilicon MS2100/MS2106 */
1867 case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1868 subs->stream_offset_adj = 2;
1869 break;
1870 case USB_ID(0x2b73, 0x000a): /* Pioneer DJM-900NXS2 */
1871 case USB_ID(0x2b73, 0x0013): /* Pioneer DJM-450 */
1872 case USB_ID(0x2b73, 0x0034): /* Pioneer DJM-V10 */
1873 pioneer_djm_set_format_quirk(subs, windex: 0x0082);
1874 break;
1875 case USB_ID(0x08e4, 0x017f): /* Pioneer DJM-750 */
1876 case USB_ID(0x08e4, 0x0163): /* Pioneer DJM-850 */
1877 pioneer_djm_set_format_quirk(subs, windex: 0x0086);
1878 break;
1879 case USB_ID(0x0dba, 0x5000):
1880 mbox3_set_format_quirk(subs, fmt); /* Digidesign Mbox 3 */
1881 break;
1882 case USB_ID(0x2a39, 0x3f8c): /* RME Digiface USB */
1883 case USB_ID(0x2a39, 0x3fa0): /* RME Digiface USB (alternate) */
1884 rme_digiface_set_format_quirk(subs);
1885 break;
1886 }
1887}
1888
1889int snd_usb_select_mode_quirk(struct snd_usb_audio *chip,
1890 const struct audioformat *fmt)
1891{
1892 struct usb_device *dev = chip->dev;
1893 int err;
1894
1895 if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
1896 /* First switch to alt set 0, otherwise the mode switch cmd
1897 * will not be accepted by the DAC
1898 */
1899 err = usb_set_interface(dev, ifnum: fmt->iface, alternate: 0);
1900 if (err < 0)
1901 return err;
1902
1903 msleep(msecs: 20); /* Delay needed after setting the interface */
1904
1905 /* Vendor mode switch cmd is required. */
1906 if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1907 /* DSD mode (DSD_U32) requested */
1908 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), request: 0,
1909 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1910 value: 1, index: 1, NULL, size: 0);
1911 if (err < 0)
1912 return err;
1913
1914 } else {
1915 /* PCM or DOP mode (S32) requested */
1916 /* PCM mode (S16) requested */
1917 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), request: 0,
1918 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1919 value: 0, index: 1, NULL, size: 0);
1920 if (err < 0)
1921 return err;
1922
1923 }
1924 msleep(msecs: 20);
1925 }
1926 return 0;
1927}
1928
1929void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1930{
1931 /*
1932 * "Playback Design" products send bogus feedback data at the start
1933 * of the stream. Ignore them.
1934 */
1935 if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1936 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1937 ep->skip_packets = 4;
1938
1939 /*
1940 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1941 * world latency varies by approx. +/- 50 frames (at 96kHz) each time
1942 * the stream is (re)started. When skipping packets 16 at endpoint
1943 * start up, the real world latency is stable within +/- 1 frame (also
1944 * across power cycles).
1945 */
1946 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1947 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1948 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1949 ep->skip_packets = 16;
1950
1951 /* Work around devices that report unreasonable feedback data */
1952 if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */
1953 ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1954 ep->syncmaxsize == 4)
1955 ep->tenor_fb_quirk = 1;
1956}
1957
1958/* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1959void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1960 __u8 request, __u8 requesttype, __u16 value,
1961 __u16 index, void *data, __u16 size)
1962{
1963 struct snd_usb_audio *chip = dev_get_drvdata(dev: &dev->dev);
1964
1965 if (!chip || (requesttype & USB_TYPE_MASK) != USB_TYPE_CLASS)
1966 return;
1967
1968 if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY)
1969 msleep(msecs: 20);
1970 else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_1M)
1971 usleep_range(min: 1000, max: 2000);
1972 else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_5M)
1973 usleep_range(min: 5000, max: 6000);
1974}
1975
1976/*
1977 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1978 * augment the PCM format bit-field for DSD types. The UAC standards
1979 * don't have a designated bit field to denote DSD-capable interfaces,
1980 * hence all hardware that is known to support this format has to be
1981 * listed here.
1982 */
1983u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1984 struct audioformat *fp,
1985 unsigned int sample_bytes)
1986{
1987 struct usb_interface *iface;
1988
1989 /* Playback Designs */
1990 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1991 USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
1992 switch (fp->altsetting) {
1993 case 1:
1994 fp->dsd_dop = true;
1995 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1996 case 2:
1997 fp->dsd_bitrev = true;
1998 return SNDRV_PCM_FMTBIT_DSD_U8;
1999 case 3:
2000 fp->dsd_bitrev = true;
2001 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
2002 }
2003 }
2004
2005 /* XMOS based USB DACs */
2006 switch (chip->usb_id) {
2007 case USB_ID(0x139f, 0x5504): /* Nagra DAC */
2008 case USB_ID(0x20b1, 0x3089): /* Mola-Mola DAC */
2009 case USB_ID(0x2522, 0x0007): /* LH Labs Geek Out 1V5 */
2010 case USB_ID(0x2522, 0x0009): /* LH Labs Geek Pulse X Inifinity 2V0 */
2011 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
2012 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
2013 if (fp->altsetting == 2)
2014 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2015 break;
2016
2017 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
2018 case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
2019 case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
2020 case USB_ID(0x16d0, 0x06b4): /* NuPrime Audio HD-AVP/AVA */
2021 case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
2022 case USB_ID(0x16d0, 0x09d8): /* NuPrime IDA-8 */
2023 case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
2024 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
2025 case USB_ID(0x16d0, 0x0ab1): /* PureAudio APA DAC */
2026 case USB_ID(0x16d0, 0xeca1): /* PureAudio Lotus DAC5, DAC5 SE, DAC5 Pro */
2027 case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
2028 case USB_ID(0x20a0, 0x4143): /* WaveIO USB Audio 2.0 */
2029 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
2030 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
2031 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
2032 case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
2033 case USB_ID(0x2622, 0x0061): /* LEAK Stereo 230 */
2034 case USB_ID(0x278b, 0x5100): /* Rotel RC-1590 */
2035 case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
2036 case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
2037 case USB_ID(0x6b42, 0x0042): /* MSB Technology */
2038 if (fp->altsetting == 3)
2039 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2040 break;
2041
2042 /* Amanero Combo384 USB based DACs with native DSD support */
2043 case USB_ID(0x16d0, 0x071a): /* Amanero - Combo384 */
2044 if (fp->altsetting == 2) {
2045 switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
2046 case 0x199:
2047 return SNDRV_PCM_FMTBIT_DSD_U32_LE;
2048 case 0x19b:
2049 case 0x203:
2050 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2051 default:
2052 break;
2053 }
2054 }
2055 break;
2056 case USB_ID(0x16d0, 0x0a23):
2057 if (fp->altsetting == 2)
2058 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2059 break;
2060
2061 default:
2062 break;
2063 }
2064
2065 /* ITF-USB DSD based DACs */
2066 if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
2067 iface = usb_ifnum_to_if(dev: chip->dev, ifnum: fp->iface);
2068
2069 /* Altsetting 2 support native DSD if the num of altsets is
2070 * three (0-2),
2071 * Altsetting 3 support native DSD if the num of altsets is
2072 * four (0-3).
2073 */
2074 if (fp->altsetting == iface->num_altsetting - 1)
2075 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2076 }
2077
2078 /* Mostly generic method to detect many DSD-capable implementations */
2079 if ((chip->quirk_flags & QUIRK_FLAG_DSD_RAW) && fp->dsd_raw)
2080 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
2081
2082 return 0;
2083}
2084
2085void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
2086 struct audioformat *fp,
2087 int stream)
2088{
2089 switch (chip->usb_id) {
2090 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2091 /* Optoplay sets the sample rate attribute although
2092 * it seems not supporting it in fact.
2093 */
2094 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
2095 break;
2096 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2097 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2098 /* doesn't set the sample rate attribute, but supports it */
2099 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
2100 break;
2101 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
2102 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
2103 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2104 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2105 an older model 77d:223) */
2106 /*
2107 * plantronics headset and Griffin iMic have set adaptive-in
2108 * although it's really not...
2109 */
2110 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
2111 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2112 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
2113 else
2114 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
2115 break;
2116 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook IIc */
2117 /*
2118 * MaxPacketsOnly attribute is erroneously set in endpoint
2119 * descriptors. As a result this card produces noise with
2120 * all sample rates other than 96 kHz.
2121 */
2122 fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
2123 break;
2124 case USB_ID(0x1224, 0x2a25): /* Jieli Technology USB PHY 2.0 */
2125 /* mic works only when ep packet size is set to wMaxPacketSize */
2126 fp->attributes |= UAC_EP_CS_ATTR_FILL_MAX;
2127 break;
2128 case USB_ID(0x3511, 0x2b1e): /* Opencomm2 UC USB Bluetooth dongle */
2129 /* mic works only when ep pitch control is not set */
2130 if (stream == SNDRV_PCM_STREAM_CAPTURE)
2131 fp->attributes &= ~UAC_EP_CS_ATTR_PITCH_CONTROL;
2132 break;
2133 }
2134}
2135
2136/*
2137 * driver behavior quirk flags
2138 */
2139struct usb_audio_quirk_flags_table {
2140 u32 id;
2141 u32 flags;
2142};
2143
2144#define DEVICE_FLG(vid, pid, _flags) \
2145 { .id = USB_ID(vid, pid), .flags = (_flags) }
2146#define VENDOR_FLG(vid, _flags) DEVICE_FLG(vid, 0, _flags)
2147
2148static const struct usb_audio_quirk_flags_table quirk_flags_table[] = {
2149 /* Device matches */
2150 DEVICE_FLG(0x03f0, 0x654a, /* HP 320 FHD Webcam */
2151 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_MIC_RES_16),
2152 DEVICE_FLG(0x041e, 0x3000, /* Creative SB Extigy */
2153 QUIRK_FLAG_IGNORE_CTL_ERROR),
2154 DEVICE_FLG(0x041e, 0x4080, /* Creative Live Cam VF0610 */
2155 QUIRK_FLAG_GET_SAMPLE_RATE),
2156 DEVICE_FLG(0x045e, 0x083c, /* MS USB Link headset */
2157 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY |
2158 QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2159 DEVICE_FLG(0x045e, 0x070f, /* MS LifeChat LX-3000 Headset */
2160 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2161 DEVICE_FLG(0x046d, 0x0807, /* Logitech Webcam C500 */
2162 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2163 DEVICE_FLG(0x046d, 0x0808, /* Logitech Webcam C600 */
2164 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2165 DEVICE_FLG(0x046d, 0x0809,
2166 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2167 DEVICE_FLG(0x046d, 0x0819, /* Logitech Webcam C210 */
2168 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2169 DEVICE_FLG(0x046d, 0x081b, /* HD Webcam c310 */
2170 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2171 DEVICE_FLG(0x046d, 0x081d, /* HD Webcam c510 */
2172 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2173 DEVICE_FLG(0x046d, 0x0825, /* HD Webcam c270 */
2174 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2175 DEVICE_FLG(0x046d, 0x0826, /* HD Webcam c525 */
2176 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2177 DEVICE_FLG(0x046d, 0x084c, /* Logitech ConferenceCam Connect */
2178 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2179 DEVICE_FLG(0x046d, 0x08ca, /* Logitech Quickcam Fusion */
2180 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2181 DEVICE_FLG(0x046d, 0x0991, /* Logitech QuickCam Pro */
2182 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR |
2183 QUIRK_FLAG_MIC_RES_384),
2184 DEVICE_FLG(0x046d, 0x09a2, /* QuickCam Communicate Deluxe/S7500 */
2185 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIC_RES_384),
2186 DEVICE_FLG(0x046d, 0x09a4, /* Logitech QuickCam E 3500 */
2187 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR),
2188 DEVICE_FLG(0x046d, 0x0a8f, /* Logitech H390 headset */
2189 QUIRK_FLAG_CTL_MSG_DELAY_1M |
2190 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2191 DEVICE_FLG(0x0499, 0x1506, /* Yamaha THR5 */
2192 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2193 DEVICE_FLG(0x0499, 0x1509, /* Steinberg UR22 */
2194 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2195 DEVICE_FLG(0x0499, 0x3108, /* Yamaha YIT-W12TX */
2196 QUIRK_FLAG_GET_SAMPLE_RATE),
2197 DEVICE_FLG(0x04d8, 0xfeea, /* Benchmark DAC1 Pre */
2198 QUIRK_FLAG_GET_SAMPLE_RATE),
2199 DEVICE_FLG(0x04e8, 0xa051, /* Samsung USBC Headset (AKG) */
2200 QUIRK_FLAG_SKIP_CLOCK_SELECTOR | QUIRK_FLAG_CTL_MSG_DELAY_5M),
2201 DEVICE_FLG(0x0525, 0xa4ad, /* Hamedal C20 usb camero */
2202 QUIRK_FLAG_IFACE_SKIP_CLOSE),
2203 DEVICE_FLG(0x054c, 0x0b8c, /* Sony WALKMAN NW-A45 DAC */
2204 QUIRK_FLAG_SET_IFACE_FIRST),
2205 DEVICE_FLG(0x0556, 0x0014, /* Phoenix Audio TMX320VC */
2206 QUIRK_FLAG_GET_SAMPLE_RATE),
2207 DEVICE_FLG(0x0572, 0x1b08, /* Conexant Systems (Rockwell), Inc. */
2208 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2209 DEVICE_FLG(0x0572, 0x1b09, /* Conexant Systems (Rockwell), Inc. */
2210 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2211 DEVICE_FLG(0x05a3, 0x9420, /* ELP HD USB Camera */
2212 QUIRK_FLAG_GET_SAMPLE_RATE),
2213 DEVICE_FLG(0x05a7, 0x1020, /* Bose Companion 5 */
2214 QUIRK_FLAG_GET_SAMPLE_RATE),
2215 DEVICE_FLG(0x05e1, 0x0408, /* Syntek STK1160 */
2216 QUIRK_FLAG_ALIGN_TRANSFER),
2217 DEVICE_FLG(0x05e1, 0x0480, /* Hauppauge Woodbury */
2218 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2219 DEVICE_FLG(0x0644, 0x8043, /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
2220 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2221 QUIRK_FLAG_IFACE_DELAY),
2222 DEVICE_FLG(0x0644, 0x8044, /* Esoteric D-05X */
2223 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2224 QUIRK_FLAG_IFACE_DELAY | QUIRK_FLAG_FORCE_IFACE_RESET),
2225 DEVICE_FLG(0x0644, 0x804a, /* TEAC UD-301 */
2226 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2227 QUIRK_FLAG_IFACE_DELAY),
2228 DEVICE_FLG(0x0644, 0x805f, /* TEAC Model 12 */
2229 QUIRK_FLAG_FORCE_IFACE_RESET),
2230 DEVICE_FLG(0x0644, 0x806b, /* TEAC UD-701 */
2231 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2232 QUIRK_FLAG_IFACE_DELAY | QUIRK_FLAG_FORCE_IFACE_RESET),
2233 DEVICE_FLG(0x0644, 0x807d, /* TEAC UD-507 */
2234 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2235 QUIRK_FLAG_IFACE_DELAY | QUIRK_FLAG_FORCE_IFACE_RESET),
2236 DEVICE_FLG(0x0644, 0x806c, /* Esoteric XD */
2237 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2238 QUIRK_FLAG_IFACE_DELAY | QUIRK_FLAG_FORCE_IFACE_RESET),
2239 DEVICE_FLG(0x06f8, 0xb000, /* Hercules DJ Console (Windows Edition) */
2240 QUIRK_FLAG_IGNORE_CTL_ERROR),
2241 DEVICE_FLG(0x06f8, 0xd002, /* Hercules DJ Console (Macintosh Edition) */
2242 QUIRK_FLAG_IGNORE_CTL_ERROR),
2243 DEVICE_FLG(0x0711, 0x5800, /* MCT Trigger 5 USB-to-HDMI */
2244 QUIRK_FLAG_GET_SAMPLE_RATE),
2245 DEVICE_FLG(0x074d, 0x3553, /* Outlaw RR2150 (Micronas UAC3553B) */
2246 QUIRK_FLAG_GET_SAMPLE_RATE),
2247 DEVICE_FLG(0x0763, 0x2030, /* M-Audio Fast Track C400 */
2248 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2249 DEVICE_FLG(0x0763, 0x2031, /* M-Audio Fast Track C600 */
2250 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2251 DEVICE_FLG(0x07fd, 0x000b, /* MOTU M Series 2nd hardware revision */
2252 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2253 DEVICE_FLG(0x08bb, 0x2702, /* LineX FM Transmitter */
2254 QUIRK_FLAG_IGNORE_CTL_ERROR),
2255 DEVICE_FLG(0x0951, 0x16ad, /* Kingston HyperX */
2256 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2257 DEVICE_FLG(0x0b05, 0x18a6, /* ASUSTek Computer, Inc. */
2258 QUIRK_FLAG_MIXER_CAPTURE_MIN_MUTE),
2259 DEVICE_FLG(0x0b0e, 0x0349, /* Jabra 550a */
2260 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2261 DEVICE_FLG(0x0bda, 0x498a, /* Realtek Semiconductor Corp. */
2262 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE | QUIRK_FLAG_MIXER_CAPTURE_MIN_MUTE),
2263 DEVICE_FLG(0x0c45, 0x6340, /* Sonix HD USB Camera */
2264 QUIRK_FLAG_GET_SAMPLE_RATE),
2265 DEVICE_FLG(0x0c45, 0x636b, /* Microdia JP001 USB Camera */
2266 QUIRK_FLAG_GET_SAMPLE_RATE),
2267 DEVICE_FLG(0x0d8c, 0x000c, /* C-Media */
2268 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2269 DEVICE_FLG(0x0d8c, 0x0012, /* C-Media */
2270 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2271 DEVICE_FLG(0x0d8c, 0x0014, /* C-Media */
2272 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2273 DEVICE_FLG(0x0ecb, 0x205c, /* JBL Quantum610 Wireless */
2274 QUIRK_FLAG_FIXED_RATE),
2275 DEVICE_FLG(0x0ecb, 0x2069, /* JBL Quantum810 Wireless */
2276 QUIRK_FLAG_FIXED_RATE),
2277 DEVICE_FLG(0x0fd9, 0x0008, /* Hauppauge HVR-950Q */
2278 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2279 DEVICE_FLG(0x1038, 0x1294, /* SteelSeries Arctis Pro Wireless */
2280 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2281 DEVICE_FLG(0x1101, 0x0003, /* Audioengine D1 */
2282 QUIRK_FLAG_GET_SAMPLE_RATE),
2283 DEVICE_FLG(0x12d1, 0x3a07, /* Huawei Technologies Co., Ltd. */
2284 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE | QUIRK_FLAG_MIXER_CAPTURE_MIN_MUTE),
2285 DEVICE_FLG(0x1224, 0x2a25, /* Jieli Technology USB PHY 2.0 */
2286 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_MIC_RES_16),
2287 DEVICE_FLG(0x1395, 0x740a, /* Sennheiser DECT */
2288 QUIRK_FLAG_GET_SAMPLE_RATE),
2289 DEVICE_FLG(0x1397, 0x0507, /* Behringer UMC202HD */
2290 QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2291 DEVICE_FLG(0x1397, 0x0508, /* Behringer UMC204HD */
2292 QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2293 DEVICE_FLG(0x1397, 0x0509, /* Behringer UMC404HD */
2294 QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2295 DEVICE_FLG(0x13e5, 0x0001, /* Serato Phono */
2296 QUIRK_FLAG_IGNORE_CTL_ERROR),
2297 DEVICE_FLG(0x154e, 0x1002, /* Denon DCD-1500RE */
2298 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2299 DEVICE_FLG(0x154e, 0x1003, /* Denon DA-300USB */
2300 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2301 DEVICE_FLG(0x154e, 0x3005, /* Marantz HD-DAC1 */
2302 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2303 DEVICE_FLG(0x154e, 0x3006, /* Marantz SA-14S1 */
2304 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2305 DEVICE_FLG(0x154e, 0x300b, /* Marantz SA-KI RUBY / SA-12 */
2306 QUIRK_FLAG_DSD_RAW),
2307 DEVICE_FLG(0x154e, 0x500e, /* Denon DN-X1600 */
2308 QUIRK_FLAG_IGNORE_CLOCK_SOURCE),
2309 DEVICE_FLG(0x1686, 0x00dd, /* Zoom R16/24 */
2310 QUIRK_FLAG_TX_LENGTH | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2311 DEVICE_FLG(0x16d0, 0x0ab1, /* PureAudio APA DAC */
2312 QUIRK_FLAG_DSD_RAW),
2313 DEVICE_FLG(0x16d0, 0xeca1, /* PureAudio Lotus DAC5, DAC5 SE and DAC5 Pro */
2314 QUIRK_FLAG_DSD_RAW),
2315 DEVICE_FLG(0x17aa, 0x1046, /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
2316 QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2317 DEVICE_FLG(0x17aa, 0x104d, /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
2318 QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2319 DEVICE_FLG(0x17ef, 0x3083, /* Lenovo TBT3 dock */
2320 QUIRK_FLAG_GET_SAMPLE_RATE),
2321 DEVICE_FLG(0x1852, 0x5062, /* Luxman D-08u */
2322 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2323 DEVICE_FLG(0x1852, 0x5065, /* Luxman DA-06 */
2324 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2325 DEVICE_FLG(0x1901, 0x0191, /* GE B850V3 CP2114 audio interface */
2326 QUIRK_FLAG_GET_SAMPLE_RATE),
2327 DEVICE_FLG(0x19f7, 0x0003, /* RODE NT-USB */
2328 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2329 DEVICE_FLG(0x19f7, 0x0035, /* RODE NT-USB+ */
2330 QUIRK_FLAG_GET_SAMPLE_RATE),
2331 DEVICE_FLG(0x1bcf, 0x2281, /* HD Webcam */
2332 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_MIC_RES_16),
2333 DEVICE_FLG(0x1bcf, 0x2283, /* NexiGo N930AF FHD Webcam */
2334 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_MIC_RES_16),
2335 DEVICE_FLG(0x2040, 0x7200, /* Hauppauge HVR-950Q */
2336 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2337 DEVICE_FLG(0x2040, 0x7201, /* Hauppauge HVR-950Q-MXL */
2338 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2339 DEVICE_FLG(0x2040, 0x7210, /* Hauppauge HVR-950Q */
2340 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2341 DEVICE_FLG(0x2040, 0x7211, /* Hauppauge HVR-950Q-MXL */
2342 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2343 DEVICE_FLG(0x2040, 0x7213, /* Hauppauge HVR-950Q */
2344 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2345 DEVICE_FLG(0x2040, 0x7217, /* Hauppauge HVR-950Q */
2346 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2347 DEVICE_FLG(0x2040, 0x721b, /* Hauppauge HVR-950Q */
2348 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2349 DEVICE_FLG(0x2040, 0x721e, /* Hauppauge HVR-950Q */
2350 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2351 DEVICE_FLG(0x2040, 0x721f, /* Hauppauge HVR-950Q */
2352 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2353 DEVICE_FLG(0x2040, 0x7240, /* Hauppauge HVR-850 */
2354 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2355 DEVICE_FLG(0x2040, 0x7260, /* Hauppauge HVR-950Q */
2356 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2357 DEVICE_FLG(0x2040, 0x7270, /* Hauppauge HVR-950Q */
2358 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2359 DEVICE_FLG(0x2040, 0x7280, /* Hauppauge HVR-950Q */
2360 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2361 DEVICE_FLG(0x2040, 0x7281, /* Hauppauge HVR-950Q-MXL */
2362 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2363 DEVICE_FLG(0x2040, 0x8200, /* Hauppauge Woodbury */
2364 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2365 DEVICE_FLG(0x21b4, 0x0081, /* AudioQuest DragonFly */
2366 QUIRK_FLAG_GET_SAMPLE_RATE),
2367 DEVICE_FLG(0x21b4, 0x0230, /* Ayre QB-9 Twenty */
2368 QUIRK_FLAG_DSD_RAW),
2369 DEVICE_FLG(0x21b4, 0x0232, /* Ayre QX-5 Twenty */
2370 QUIRK_FLAG_DSD_RAW),
2371 DEVICE_FLG(0x2522, 0x0007, /* LH Labs Geek Out HD Audio 1V5 */
2372 QUIRK_FLAG_SET_IFACE_FIRST),
2373 DEVICE_FLG(0x262a, 0x9302, /* ddHiFi TC44C */
2374 QUIRK_FLAG_DSD_RAW),
2375 DEVICE_FLG(0x2708, 0x0002, /* Audient iD14 */
2376 QUIRK_FLAG_IGNORE_CTL_ERROR),
2377 DEVICE_FLG(0x2912, 0x30c8, /* Audioengine D1 */
2378 QUIRK_FLAG_GET_SAMPLE_RATE),
2379 DEVICE_FLG(0x2a70, 0x1881, /* OnePlus Technology (Shenzhen) Co., Ltd. BE02T */
2380 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE | QUIRK_FLAG_MIXER_CAPTURE_MIN_MUTE),
2381 DEVICE_FLG(0x2b53, 0x0023, /* Fiero SC-01 (firmware v1.0.0 @ 48 kHz) */
2382 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2383 DEVICE_FLG(0x2b53, 0x0024, /* Fiero SC-01 (firmware v1.0.0 @ 96 kHz) */
2384 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2385 DEVICE_FLG(0x2b53, 0x0031, /* Fiero SC-01 (firmware v1.1.0) */
2386 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2387 DEVICE_FLG(0x2d95, 0x8011, /* VIVO USB-C HEADSET */
2388 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2389 DEVICE_FLG(0x2d95, 0x8021, /* VIVO USB-C-XE710 HEADSET */
2390 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2391 DEVICE_FLG(0x2d99, 0x0026, /* HECATE G2 GAMING HEADSET */
2392 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2393 DEVICE_FLG(0x2fc6, 0xf06b, /* MOONDROP Moonriver2 Ti */
2394 QUIRK_FLAG_CTL_MSG_DELAY),
2395 DEVICE_FLG(0x2fc6, 0xf0b7, /* iBasso DC07 Pro */
2396 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2397 DEVICE_FLG(0x30be, 0x0101, /* Schiit Hel */
2398 QUIRK_FLAG_IGNORE_CTL_ERROR),
2399 DEVICE_FLG(0x3255, 0x0000, /* Luxman D-10X */
2400 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2401 DEVICE_FLG(0x339b, 0x3a07, /* Synaptics HONOR USB-C HEADSET */
2402 QUIRK_FLAG_MIXER_PLAYBACK_MIN_MUTE),
2403 DEVICE_FLG(0x413c, 0xa506, /* Dell AE515 sound bar */
2404 QUIRK_FLAG_GET_SAMPLE_RATE),
2405 DEVICE_FLG(0x534d, 0x0021, /* MacroSilicon MS2100/MS2106 */
2406 QUIRK_FLAG_ALIGN_TRANSFER),
2407 DEVICE_FLG(0x534d, 0x2109, /* MacroSilicon MS2109 */
2408 QUIRK_FLAG_ALIGN_TRANSFER),
2409
2410 /* Vendor matches */
2411 VENDOR_FLG(0x045e, /* MS Lifecam */
2412 QUIRK_FLAG_GET_SAMPLE_RATE),
2413 VENDOR_FLG(0x046d, /* Logitech */
2414 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2415 VENDOR_FLG(0x047f, /* Plantronics */
2416 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY),
2417 VENDOR_FLG(0x0644, /* TEAC Corp. */
2418 QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY),
2419 VENDOR_FLG(0x07fd, /* MOTU */
2420 QUIRK_FLAG_VALIDATE_RATES),
2421 VENDOR_FLG(0x1235, /* Focusrite Novation */
2422 QUIRK_FLAG_VALIDATE_RATES),
2423 VENDOR_FLG(0x1511, /* AURALiC */
2424 QUIRK_FLAG_DSD_RAW),
2425 VENDOR_FLG(0x152a, /* Thesycon devices */
2426 QUIRK_FLAG_DSD_RAW),
2427 VENDOR_FLG(0x18d1, /* iBasso devices */
2428 QUIRK_FLAG_DSD_RAW),
2429 VENDOR_FLG(0x1de7, /* Phoenix Audio */
2430 QUIRK_FLAG_GET_SAMPLE_RATE),
2431 VENDOR_FLG(0x20b1, /* XMOS based devices */
2432 QUIRK_FLAG_DSD_RAW),
2433 VENDOR_FLG(0x21ed, /* Accuphase Laboratory */
2434 QUIRK_FLAG_DSD_RAW),
2435 VENDOR_FLG(0x22d9, /* Oppo */
2436 QUIRK_FLAG_DSD_RAW),
2437 VENDOR_FLG(0x23ba, /* Playback Design */
2438 QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY |
2439 QUIRK_FLAG_DSD_RAW),
2440 VENDOR_FLG(0x25ce, /* Mytek devices */
2441 QUIRK_FLAG_DSD_RAW),
2442 VENDOR_FLG(0x2622, /* IAG Limited devices */
2443 QUIRK_FLAG_DSD_RAW),
2444 VENDOR_FLG(0x2772, /* Musical Fidelity devices */
2445 QUIRK_FLAG_DSD_RAW),
2446 VENDOR_FLG(0x278b, /* Rotel? */
2447 QUIRK_FLAG_DSD_RAW),
2448 VENDOR_FLG(0x292b, /* Gustard/Ess based devices */
2449 QUIRK_FLAG_DSD_RAW),
2450 VENDOR_FLG(0x2972, /* FiiO devices */
2451 QUIRK_FLAG_DSD_RAW),
2452 VENDOR_FLG(0x2ab6, /* T+A devices */
2453 QUIRK_FLAG_DSD_RAW),
2454 VENDOR_FLG(0x2afd, /* McIntosh Laboratory, Inc. */
2455 QUIRK_FLAG_DSD_RAW),
2456 VENDOR_FLG(0x2d87, /* Cayin device */
2457 QUIRK_FLAG_DSD_RAW),
2458 VENDOR_FLG(0x2fc6, /* Comture-inc devices */
2459 QUIRK_FLAG_DSD_RAW),
2460 VENDOR_FLG(0x3336, /* HEM devices */
2461 QUIRK_FLAG_DSD_RAW),
2462 VENDOR_FLG(0x3353, /* Khadas devices */
2463 QUIRK_FLAG_DSD_RAW),
2464 VENDOR_FLG(0x35f4, /* MSB Technology */
2465 QUIRK_FLAG_DSD_RAW),
2466 VENDOR_FLG(0x3842, /* EVGA */
2467 QUIRK_FLAG_DSD_RAW),
2468 VENDOR_FLG(0xc502, /* HiBy devices */
2469 QUIRK_FLAG_DSD_RAW),
2470
2471 {} /* terminator */
2472};
2473
2474#define QUIRK_STRING_ENTRY(x) \
2475 [QUIRK_TYPE_ ## x] = __stringify(x)
2476
2477static const char *const snd_usb_audio_quirk_flag_names[] = {
2478 QUIRK_STRING_ENTRY(GET_SAMPLE_RATE),
2479 QUIRK_STRING_ENTRY(SHARE_MEDIA_DEVICE),
2480 QUIRK_STRING_ENTRY(ALIGN_TRANSFER),
2481 QUIRK_STRING_ENTRY(TX_LENGTH),
2482 QUIRK_STRING_ENTRY(PLAYBACK_FIRST),
2483 QUIRK_STRING_ENTRY(SKIP_CLOCK_SELECTOR),
2484 QUIRK_STRING_ENTRY(IGNORE_CLOCK_SOURCE),
2485 QUIRK_STRING_ENTRY(ITF_USB_DSD_DAC),
2486 QUIRK_STRING_ENTRY(CTL_MSG_DELAY),
2487 QUIRK_STRING_ENTRY(CTL_MSG_DELAY_1M),
2488 QUIRK_STRING_ENTRY(CTL_MSG_DELAY_5M),
2489 QUIRK_STRING_ENTRY(IFACE_DELAY),
2490 QUIRK_STRING_ENTRY(VALIDATE_RATES),
2491 QUIRK_STRING_ENTRY(DISABLE_AUTOSUSPEND),
2492 QUIRK_STRING_ENTRY(IGNORE_CTL_ERROR),
2493 QUIRK_STRING_ENTRY(DSD_RAW),
2494 QUIRK_STRING_ENTRY(SET_IFACE_FIRST),
2495 QUIRK_STRING_ENTRY(GENERIC_IMPLICIT_FB),
2496 QUIRK_STRING_ENTRY(SKIP_IMPLICIT_FB),
2497 QUIRK_STRING_ENTRY(IFACE_SKIP_CLOSE),
2498 QUIRK_STRING_ENTRY(FORCE_IFACE_RESET),
2499 QUIRK_STRING_ENTRY(FIXED_RATE),
2500 QUIRK_STRING_ENTRY(MIC_RES_16),
2501 QUIRK_STRING_ENTRY(MIC_RES_384),
2502 QUIRK_STRING_ENTRY(MIXER_PLAYBACK_MIN_MUTE),
2503 QUIRK_STRING_ENTRY(MIXER_CAPTURE_MIN_MUTE),
2504 NULL
2505};
2506
2507const char *snd_usb_quirk_flag_find_name(unsigned long index)
2508{
2509 if (index >= ARRAY_SIZE(snd_usb_audio_quirk_flag_names))
2510 return NULL;
2511
2512 return snd_usb_audio_quirk_flag_names[index];
2513}
2514
2515u32 snd_usb_quirk_flags_from_name(const char *name)
2516{
2517 int i;
2518
2519 if (!name || !*name)
2520 return 0;
2521
2522 for (i = 0; snd_usb_audio_quirk_flag_names[i]; i++) {
2523 if (strcasecmp(s1: name, s2: snd_usb_audio_quirk_flag_names[i]) == 0)
2524 return BIT_U32(i);
2525 }
2526
2527 return 0;
2528}
2529
2530void snd_usb_apply_flag_dbg(const char *reason,
2531 struct snd_usb_audio *chip,
2532 unsigned long flag)
2533{
2534 unsigned long bit;
2535
2536 for_each_set_bit(bit, &flag, BYTES_TO_BITS(sizeof(flag))) {
2537 const char *name = snd_usb_audio_quirk_flag_names[bit];
2538
2539 if (name)
2540 usb_audio_dbg(chip,
2541 "From %s apply quirk flag %s for device %04x:%04x\n",
2542 reason, name, USB_ID_VENDOR(chip->usb_id),
2543 USB_ID_PRODUCT(chip->usb_id));
2544 else
2545 usb_audio_warn(chip,
2546 "From %s apply unknown quirk flag 0x%lx for device %04x:%04x\n",
2547 reason, bit, USB_ID_VENDOR(chip->usb_id),
2548 USB_ID_PRODUCT(chip->usb_id));
2549 }
2550}
2551
2552void snd_usb_init_quirk_flags_table(struct snd_usb_audio *chip)
2553{
2554 const struct usb_audio_quirk_flags_table *p;
2555
2556 for (p = quirk_flags_table; p->id; p++) {
2557 if (chip->usb_id == p->id ||
2558 (!USB_ID_PRODUCT(p->id) &&
2559 USB_ID_VENDOR(chip->usb_id) == USB_ID_VENDOR(p->id))) {
2560 snd_usb_apply_flag_dbg(reason: "builtin table", chip, flag: p->flags);
2561 chip->quirk_flags |= p->flags;
2562 return;
2563 }
2564 }
2565}
2566
2567void snd_usb_init_quirk_flags_parse_string(struct snd_usb_audio *chip,
2568 const char *str)
2569{
2570 u16 chip_vid = USB_ID_VENDOR(chip->usb_id);
2571 u16 chip_pid = USB_ID_PRODUCT(chip->usb_id);
2572 u32 mask_flags, unmask_flags, bit;
2573 char *p, *field, *flag;
2574 bool is_unmask;
2575 u16 vid, pid;
2576
2577 char *val __free(kfree) = kstrdup(s: str, GFP_KERNEL);
2578
2579 if (!val)
2580 return;
2581
2582 for (p = val; p && *p;) {
2583 /* Each entry consists of VID:PID:flags */
2584 field = strsep(&p, ":");
2585 if (!field)
2586 break;
2587
2588 if (strcmp(field, "*") == 0)
2589 vid = 0;
2590 else if (kstrtou16(s: field, base: 16, res: &vid))
2591 break;
2592
2593 field = strsep(&p, ":");
2594 if (!field)
2595 break;
2596
2597 if (strcmp(field, "*") == 0)
2598 pid = 0;
2599 else if (kstrtou16(s: field, base: 16, res: &pid))
2600 break;
2601
2602 field = strsep(&p, ";");
2603 if (!field || !*field)
2604 break;
2605
2606 if ((vid != 0 && vid != chip_vid) ||
2607 (pid != 0 && pid != chip_pid))
2608 continue;
2609
2610 /* Collect the flags */
2611 mask_flags = 0;
2612 unmask_flags = 0;
2613 while (field && *field) {
2614 flag = strsep(&field, "|");
2615
2616 if (!flag)
2617 break;
2618
2619 if (*flag == '!') {
2620 is_unmask = true;
2621 flag++;
2622 } else {
2623 is_unmask = false;
2624 }
2625
2626 if (!kstrtou32(s: flag, base: 16, res: &bit)) {
2627 if (is_unmask)
2628 unmask_flags |= bit;
2629 else
2630 mask_flags |= bit;
2631
2632 break;
2633 }
2634
2635 bit = snd_usb_quirk_flags_from_name(name: flag);
2636
2637 if (bit) {
2638 if (is_unmask)
2639 unmask_flags |= bit;
2640 else
2641 mask_flags |= bit;
2642 } else {
2643 pr_warn("snd_usb_audio: unknown flag %s while parsing param quirk_flags\n",
2644 flag);
2645 }
2646 }
2647
2648 chip->quirk_flags &= ~unmask_flags;
2649 chip->quirk_flags |= mask_flags;
2650 snd_usb_apply_flag_dbg(reason: "module param", chip,
2651 flag: chip->quirk_flags);
2652 }
2653}
2654

source code of linux/sound/usb/quirks.c