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 */
create_composite_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk_comp)33 static 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(chip->dev, 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(chip->dev, 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
ignore_interface_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)70 static 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
create_any_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * intf,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)79 static 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, intf, quirk, 0);
85 }
86
87 /*
88 * create a stream for an interface with proper descriptors
89 */
create_standard_audio_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)90 static 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, 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(chip->dev, altsd->bInterfaceNumber, 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 */
add_audio_stream_from_fixed_fmt(struct snd_usb_audio * chip,struct audioformat * fp)115 static 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, 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, 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, fp->sync_ep,
136 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 */
create_fixed_stream_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)149 static 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(&fp->list);
165 if (fp->nr_rates > MAX_NR_RATES) {
166 kfree(fp);
167 return -EINVAL;
168 }
169 if (fp->nr_rates > 0) {
170 rate_table = kmemdup(fp->rate_table,
171 sizeof(int) * fp->nr_rates, GFP_KERNEL);
172 if (!rate_table) {
173 kfree(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(chip->dev, fp->iface, 0);
205 snd_usb_init_pitch(chip, fp);
206 snd_usb_init_sample_rate(chip, fp, fp->rate_max);
207 return 0;
208
209 error:
210 list_del(&fp->list); /* unlink for avoiding double-free */
211 kfree(fp);
212 kfree(rate_table);
213 return err;
214 }
215
create_auto_pcm_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver)216 static 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(alts->extra, alts->extralen, NULL,
248 UAC_AS_GENERAL);
249 fmtd = snd_usb_find_csint_desc(alts->extra, 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
create_yamaha_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,struct usb_host_interface * alts)258 static 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(alts->extra, alts->extralen,
271 NULL, USB_MS_MIDI_IN_JACK);
272 outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
273 NULL, USB_MS_MIDI_OUT_JACK);
274 if (!injd && !outjd)
275 return -ENODEV;
276 if ((injd && !snd_usb_validate_midi_desc(injd)) ||
277 (outjd && !snd_usb_validate_midi_desc(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, iface, driver, &yamaha_midi_quirk);
288 }
289
create_roland_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,struct usb_host_interface * alts)290 static 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(alts->extra,
303 alts->extralen,
304 roland_desc, 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, iface, driver,
310 &roland_midi_quirk);
311 }
312 }
313
create_std_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,struct usb_host_interface * alts)314 static 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, iface, driver, NULL);
340 }
341
create_auto_midi_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver)342 static 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
create_autodetect_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)378 static 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 */
create_uaxx_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)395 static 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(chip->card, iface,
440 &chip->midi_list, quirk,
441 chip->usb_id,
442 &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(&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(fp);
474 return -ENXIO;
475 }
476
477 err = add_audio_stream_from_fixed_fmt(chip, fp);
478 if (err < 0) {
479 list_del(&fp->list); /* unlink for avoiding double-free */
480 kfree(fp);
481 return err;
482 }
483 usb_set_interface(chip->dev, fp->iface, 0);
484 return 0;
485 }
486
487 /*
488 * Create a standard mixer for the specified interface.
489 */
create_standard_mixer_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)490 static 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, 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 */
snd_usb_create_quirk(struct snd_usb_audio * chip,struct usb_interface * iface,struct usb_driver * driver,const struct snd_usb_audio_quirk * quirk)509 int 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
snd_usb_extigy_boot_quirk(struct usb_device * dev,struct usb_interface * intf)555 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
556 {
557 struct usb_host_config *config = dev->actconfig;
558 int err;
559
560 if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
561 le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
562 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
563 /* Send message to force it to reconnect with full interface. */
564 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
565 0x10, 0x43, 0x0001, 0x000a, NULL, 0);
566 if (err < 0)
567 dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
568 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
569 &dev->descriptor, sizeof(dev->descriptor));
570 config = dev->actconfig;
571 if (err < 0)
572 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
573 err = usb_reset_configuration(dev);
574 if (err < 0)
575 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
576 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
577 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
578 return -ENODEV; /* quit this anyway */
579 }
580 return 0;
581 }
582
snd_usb_audigy2nx_boot_quirk(struct usb_device * dev)583 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
584 {
585 u8 buf = 1;
586
587 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
588 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
589 0, 0, &buf, 1);
590 if (buf == 0) {
591 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
592 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
593 1, 2000, NULL, 0);
594 return -ENODEV;
595 }
596 return 0;
597 }
598
snd_usb_fasttrackpro_boot_quirk(struct usb_device * dev)599 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
600 {
601 int err;
602
603 if (dev->actconfig->desc.bConfigurationValue == 1) {
604 dev_info(&dev->dev,
605 "Fast Track Pro switching to config #2\n");
606 /* This function has to be available by the usb core module.
607 * if it is not avialable the boot quirk has to be left out
608 * and the configuration has to be set by udev or hotplug
609 * rules
610 */
611 err = usb_driver_set_configuration(dev, 2);
612 if (err < 0)
613 dev_dbg(&dev->dev,
614 "error usb_driver_set_configuration: %d\n",
615 err);
616 /* Always return an error, so that we stop creating a device
617 that will just be destroyed and recreated with a new
618 configuration */
619 return -ENODEV;
620 } else
621 dev_info(&dev->dev, "Fast Track Pro config OK\n");
622
623 return 0;
624 }
625
626 /*
627 * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
628 * documented in the device's data sheet.
629 */
snd_usb_cm106_write_int_reg(struct usb_device * dev,int reg,u16 value)630 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
631 {
632 u8 buf[4];
633 buf[0] = 0x20;
634 buf[1] = value & 0xff;
635 buf[2] = (value >> 8) & 0xff;
636 buf[3] = reg;
637 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
638 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
639 0, 0, &buf, 4);
640 }
641
snd_usb_cm106_boot_quirk(struct usb_device * dev)642 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
643 {
644 /*
645 * Enable line-out driver mode, set headphone source to front
646 * channels, enable stereo mic.
647 */
648 return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
649 }
650
651 /*
652 * CM6206 registers from the CM6206 datasheet rev 2.1
653 */
654 #define CM6206_REG0_DMA_MASTER BIT(15)
655 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
656 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
657 /* Bit 4 thru 11 is the S/PDIF category code */
658 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
659 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
660 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
661 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
662 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
663
664 #define CM6206_REG1_TEST_SEL_CLK BIT(14)
665 #define CM6206_REG1_PLLBIN_EN BIT(13)
666 #define CM6206_REG1_SOFT_MUTE_EN BIT(12)
667 #define CM6206_REG1_GPIO4_OUT BIT(11)
668 #define CM6206_REG1_GPIO4_OE BIT(10)
669 #define CM6206_REG1_GPIO3_OUT BIT(9)
670 #define CM6206_REG1_GPIO3_OE BIT(8)
671 #define CM6206_REG1_GPIO2_OUT BIT(7)
672 #define CM6206_REG1_GPIO2_OE BIT(6)
673 #define CM6206_REG1_GPIO1_OUT BIT(5)
674 #define CM6206_REG1_GPIO1_OE BIT(4)
675 #define CM6206_REG1_SPDIFO_INVALID BIT(3)
676 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
677 #define CM6206_REG1_SPDIFO_DIS BIT(1)
678 #define CM6206_REG1_SPDIFI_MIX BIT(0)
679
680 #define CM6206_REG2_DRIVER_ON BIT(15)
681 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
682 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
683 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
684 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
685 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
686 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
687 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
688 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
689 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
690 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
691 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
692 #define CM6206_REG2_MUTE_CENTER BIT(5)
693 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
694 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
695 #define CM6206_REG2_EN_BTL BIT(2)
696 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
697 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
698 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
699 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
700
701 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
702 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
703 #define CM6206_REG3_VRAP25EN BIT(10)
704 #define CM6206_REG3_MSEL1 BIT(9)
705 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
706 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
707 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
708 #define CM6206_REG3_PINSEL BIT(6)
709 #define CM6206_REG3_FOE BIT(5)
710 #define CM6206_REG3_ROE BIT(4)
711 #define CM6206_REG3_CBOE BIT(3)
712 #define CM6206_REG3_LOSE BIT(2)
713 #define CM6206_REG3_HPOE BIT(1)
714 #define CM6206_REG3_SPDIFI_CANREC BIT(0)
715
716 #define CM6206_REG5_DA_RSTN BIT(13)
717 #define CM6206_REG5_AD_RSTN BIT(12)
718 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
719 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
720 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
721 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
722 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
723 #define CM6206_REG5_CODECM BIT(8)
724 #define CM6206_REG5_EN_HPF BIT(7)
725 #define CM6206_REG5_T_SEL_DSDA4 BIT(6)
726 #define CM6206_REG5_T_SEL_DSDA3 BIT(5)
727 #define CM6206_REG5_T_SEL_DSDA2 BIT(4)
728 #define CM6206_REG5_T_SEL_DSDA1 BIT(3)
729 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
730 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4
731 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
732 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
733 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
734
snd_usb_cm6206_boot_quirk(struct usb_device * dev)735 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
736 {
737 int err = 0, reg;
738 int val[] = {
739 /*
740 * Values here are chosen based on sniffing USB traffic
741 * under Windows.
742 *
743 * REG0: DAC is master, sample rate 48kHz, no copyright
744 */
745 CM6206_REG0_SPDIFO_RATE_48K |
746 CM6206_REG0_SPDIFO_COPYRIGHT_NA,
747 /*
748 * REG1: PLL binary search enable, soft mute enable.
749 */
750 CM6206_REG1_PLLBIN_EN |
751 CM6206_REG1_SOFT_MUTE_EN,
752 /*
753 * REG2: enable output drivers,
754 * select front channels to the headphone output,
755 * then mute the headphone channels, run the MCU
756 * at 1.5 MHz.
757 */
758 CM6206_REG2_DRIVER_ON |
759 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
760 CM6206_REG2_MUTE_HEADPHONE_RIGHT |
761 CM6206_REG2_MUTE_HEADPHONE_LEFT,
762 /*
763 * REG3: default flyspeed, set 2.5V mic bias
764 * enable all line out ports and enable SPDIF
765 */
766 CM6206_REG3_FLYSPEED_DEFAULT |
767 CM6206_REG3_VRAP25EN |
768 CM6206_REG3_FOE |
769 CM6206_REG3_ROE |
770 CM6206_REG3_CBOE |
771 CM6206_REG3_LOSE |
772 CM6206_REG3_HPOE |
773 CM6206_REG3_SPDIFI_CANREC,
774 /* REG4 is just a bunch of GPIO lines */
775 0x0000,
776 /* REG5: de-assert AD/DA reset signals */
777 CM6206_REG5_DA_RSTN |
778 CM6206_REG5_AD_RSTN };
779
780 for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
781 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
782 if (err < 0)
783 return err;
784 }
785
786 return err;
787 }
788
789 /* quirk for Plantronics GameCom 780 with CM6302 chip */
snd_usb_gamecon780_boot_quirk(struct usb_device * dev)790 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
791 {
792 /* set the initial volume and don't change; other values are either
793 * too loud or silent due to firmware bug (bko#65251)
794 */
795 u8 buf[2] = { 0x74, 0xe3 };
796 return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
797 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
798 UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
799 }
800
801 /*
802 * Novation Twitch DJ controller
803 * Focusrite Novation Saffire 6 USB audio card
804 */
snd_usb_novation_boot_quirk(struct usb_device * dev)805 static int snd_usb_novation_boot_quirk(struct usb_device *dev)
806 {
807 /* preemptively set up the device because otherwise the
808 * raw MIDI endpoints are not active */
809 usb_set_interface(dev, 0, 1);
810 return 0;
811 }
812
813 /*
814 * This call will put the synth in "USB send" mode, i.e it will send MIDI
815 * messages through USB (this is disabled at startup). The synth will
816 * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
817 * sign on its LCD. Values here are chosen based on sniffing USB traffic
818 * under Windows.
819 */
snd_usb_accessmusic_boot_quirk(struct usb_device * dev)820 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
821 {
822 int err, actual_length;
823 /* "midi send" enable */
824 static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
825 void *buf;
826
827 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
828 return -EINVAL;
829 buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
830 if (!buf)
831 return -ENOMEM;
832 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
833 ARRAY_SIZE(seq), &actual_length, 1000);
834 kfree(buf);
835 if (err < 0)
836 return err;
837
838 return 0;
839 }
840
841 /*
842 * Some sound cards from Native Instruments are in fact compliant to the USB
843 * audio standard of version 2 and other approved USB standards, even though
844 * they come up as vendor-specific device when first connected.
845 *
846 * However, they can be told to come up with a new set of descriptors
847 * upon their next enumeration, and the interfaces announced by the new
848 * descriptors will then be handled by the kernel's class drivers. As the
849 * product ID will also change, no further checks are required.
850 */
851
snd_usb_nativeinstruments_boot_quirk(struct usb_device * dev)852 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
853 {
854 int ret;
855
856 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
857 0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
858 1, 0, NULL, 0, 1000);
859
860 if (ret < 0)
861 return ret;
862
863 usb_reset_device(dev);
864
865 /* return -EAGAIN, so the creation of an audio interface for this
866 * temporary device is aborted. The device will reconnect with a
867 * new product ID */
868 return -EAGAIN;
869 }
870
mbox2_setup_48_24_magic(struct usb_device * dev)871 static void mbox2_setup_48_24_magic(struct usb_device *dev)
872 {
873 u8 srate[3];
874 u8 temp[12];
875
876 /* Choose 48000Hz permanently */
877 srate[0] = 0x80;
878 srate[1] = 0xbb;
879 srate[2] = 0x00;
880
881 /* Send the magic! */
882 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
883 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
884 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
885 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
886 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
887 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
888 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
889 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
890 return;
891 }
892
893 /* Digidesign Mbox 2 needs to load firmware onboard
894 * and driver must wait a few seconds for initialisation.
895 */
896
897 #define MBOX2_FIRMWARE_SIZE 646
898 #define MBOX2_BOOT_LOADING 0x01 /* Hard coded into the device */
899 #define MBOX2_BOOT_READY 0x02 /* Hard coded into the device */
900
snd_usb_mbox2_boot_quirk(struct usb_device * dev)901 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
902 {
903 struct usb_host_config *config = dev->actconfig;
904 int err;
905 u8 bootresponse[0x12];
906 int fwsize;
907 int count;
908
909 fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
910
911 if (fwsize != MBOX2_FIRMWARE_SIZE) {
912 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
913 return -ENODEV;
914 }
915
916 dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
917
918 count = 0;
919 bootresponse[0] = MBOX2_BOOT_LOADING;
920 while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
921 msleep(500); /* 0.5 second delay */
922 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
923 /* Control magic - load onboard firmware */
924 0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
925 if (bootresponse[0] == MBOX2_BOOT_READY)
926 break;
927 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
928 count++;
929 }
930
931 if (bootresponse[0] != MBOX2_BOOT_READY) {
932 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
933 return -ENODEV;
934 }
935
936 dev_dbg(&dev->dev, "device initialised!\n");
937
938 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
939 &dev->descriptor, sizeof(dev->descriptor));
940 config = dev->actconfig;
941 if (err < 0)
942 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
943
944 err = usb_reset_configuration(dev);
945 if (err < 0)
946 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
947 dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
948 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
949
950 mbox2_setup_48_24_magic(dev);
951
952 dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
953
954 return 0; /* Successful boot */
955 }
956
snd_usb_axefx3_boot_quirk(struct usb_device * dev)957 static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
958 {
959 int err;
960
961 dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
962
963 /* If the Axe-Fx III has not fully booted, it will timeout when trying
964 * to enable the audio streaming interface. A more generous timeout is
965 * used here to detect when the Axe-Fx III has finished booting as the
966 * set interface message will be acked once it has
967 */
968 err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
969 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
970 1, 1, NULL, 0, 120000);
971 if (err < 0) {
972 dev_err(&dev->dev,
973 "failed waiting for Axe-Fx III to boot: %d\n", err);
974 return err;
975 }
976
977 dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
978
979 err = usb_set_interface(dev, 1, 0);
980 if (err < 0)
981 dev_dbg(&dev->dev,
982 "error stopping Axe-Fx III interface: %d\n", err);
983
984 return 0;
985 }
986
mbox3_setup_defaults(struct usb_device * dev)987 static void mbox3_setup_defaults(struct usb_device *dev)
988 {
989 /* The Mbox 3 is "little endian" */
990 /* max volume is: 0x0000. */
991 /* min volume is: 0x0080 (shown in little endian form) */
992
993 u8 com_buff[2];
994
995 /* Deactivate Tuner */
996 /* on = 0x01*/
997 /* off = 0x00*/
998 com_buff[0] = 0x00;
999 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1000 0x01, 0x21, 0x0003, 0x2001, &com_buff, 1);
1001
1002 /* Set clock source to Internal (as opposed to S/PDIF) */
1003 /* Internal = 0x01*/
1004 /* S/PDIF = 0x02*/
1005 com_buff[0] = 0x01;
1006 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1007 1, 0x21, 0x0100, 0x8001, &com_buff, 1);
1008
1009 /* Mute the hardware loopbacks to start the device in a known state. */
1010 com_buff[0] = 0x00;
1011 com_buff[1] = 0x80;
1012 /* Analogue input 1 left channel: */
1013 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1014 1, 0x21, 0x0110, 0x4001, &com_buff, 2);
1015 /* Analogue input 1 right channel: */
1016 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1017 1, 0x21, 0x0111, 0x4001, &com_buff, 2);
1018 /* Analogue input 2 left channel: */
1019 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1020 1, 0x21, 0x0114, 0x4001, &com_buff, 2);
1021 /* Analogue input 2 right channel: */
1022 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1023 1, 0x21, 0x0115, 0x4001, &com_buff, 2);
1024 /* Analogue input 3 left channel: */
1025 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1026 1, 0x21, 0x0118, 0x4001, &com_buff, 2);
1027 /* Analogue input 3 right channel: */
1028 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1029 1, 0x21, 0x0119, 0x4001, &com_buff, 2);
1030 /* Analogue input 4 left channel: */
1031 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1032 1, 0x21, 0x011c, 0x4001, &com_buff, 2);
1033 /* Analogue input 4 right channel: */
1034 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1035 1, 0x21, 0x011d, 0x4001, &com_buff, 2);
1036
1037 /* Set software sends to output */
1038 com_buff[0] = 0x00;
1039 com_buff[1] = 0x00;
1040 /* Analogue software return 1 left channel: */
1041 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1042 1, 0x21, 0x0100, 0x4001, &com_buff, 2);
1043 com_buff[0] = 0x00;
1044 com_buff[1] = 0x80;
1045 /* Analogue software return 1 right channel: */
1046 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1047 1, 0x21, 0x0101, 0x4001, &com_buff, 2);
1048 com_buff[0] = 0x00;
1049 com_buff[1] = 0x80;
1050 /* Analogue software return 2 left channel: */
1051 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1052 1, 0x21, 0x0104, 0x4001, &com_buff, 2);
1053 com_buff[0] = 0x00;
1054 com_buff[1] = 0x00;
1055 /* Analogue software return 2 right channel: */
1056 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1057 1, 0x21, 0x0105, 0x4001, &com_buff, 2);
1058
1059 com_buff[0] = 0x00;
1060 com_buff[1] = 0x80;
1061 /* Analogue software return 3 left channel: */
1062 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1063 1, 0x21, 0x0108, 0x4001, &com_buff, 2);
1064 /* Analogue software return 3 right channel: */
1065 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1066 1, 0x21, 0x0109, 0x4001, &com_buff, 2);
1067 /* Analogue software return 4 left channel: */
1068 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1069 1, 0x21, 0x010c, 0x4001, &com_buff, 2);
1070 /* Analogue software return 4 right channel: */
1071 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1072 1, 0x21, 0x010d, 0x4001, &com_buff, 2);
1073
1074 /* Return to muting sends */
1075 com_buff[0] = 0x00;
1076 com_buff[1] = 0x80;
1077 /* Analogue fx return left channel: */
1078 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1079 1, 0x21, 0x0120, 0x4001, &com_buff, 2);
1080 /* Analogue fx return right channel: */
1081 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1082 1, 0x21, 0x0121, 0x4001, &com_buff, 2);
1083
1084 /* Analogue software input 1 fx send: */
1085 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1086 1, 0x21, 0x0100, 0x4201, &com_buff, 2);
1087 /* Analogue software input 2 fx send: */
1088 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1089 1, 0x21, 0x0101, 0x4201, &com_buff, 2);
1090 /* Analogue software input 3 fx send: */
1091 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1092 1, 0x21, 0x0102, 0x4201, &com_buff, 2);
1093 /* Analogue software input 4 fx send: */
1094 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1095 1, 0x21, 0x0103, 0x4201, &com_buff, 2);
1096 /* Analogue input 1 fx send: */
1097 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1098 1, 0x21, 0x0104, 0x4201, &com_buff, 2);
1099 /* Analogue input 2 fx send: */
1100 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1101 1, 0x21, 0x0105, 0x4201, &com_buff, 2);
1102 /* Analogue input 3 fx send: */
1103 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1104 1, 0x21, 0x0106, 0x4201, &com_buff, 2);
1105 /* Analogue input 4 fx send: */
1106 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1107 1, 0x21, 0x0107, 0x4201, &com_buff, 2);
1108
1109 /* Toggle allowing host control */
1110 /* Not needed
1111 com_buff[0] = 0x02;
1112 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1113 3, 0x21, 0x0000, 0x2001, &com_buff, 1);
1114 */
1115
1116 /* Do not dim fx returns */
1117 com_buff[0] = 0x00;
1118 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1119 3, 0x21, 0x0002, 0x2001, &com_buff, 1);
1120
1121 /* Do not set fx returns to mono */
1122 com_buff[0] = 0x00;
1123 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1124 3, 0x21, 0x0001, 0x2001, &com_buff, 1);
1125
1126 /* Mute the S/PDIF hardware loopback
1127 * same odd volume logic here as above
1128 */
1129 com_buff[0] = 0x00;
1130 com_buff[1] = 0x80;
1131 /* S/PDIF hardware input 1 left channel */
1132 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1133 1, 0x21, 0x0112, 0x4001, &com_buff, 2);
1134 /* S/PDIF hardware input 1 right channel */
1135 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1136 1, 0x21, 0x0113, 0x4001, &com_buff, 2);
1137 /* S/PDIF hardware input 2 left channel */
1138 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1139 1, 0x21, 0x0116, 0x4001, &com_buff, 2);
1140 /* S/PDIF hardware input 2 right channel */
1141 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1142 1, 0x21, 0x0117, 0x4001, &com_buff, 2);
1143 /* S/PDIF hardware input 3 left channel */
1144 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1145 1, 0x21, 0x011a, 0x4001, &com_buff, 2);
1146 /* S/PDIF hardware input 3 right channel */
1147 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1148 1, 0x21, 0x011b, 0x4001, &com_buff, 2);
1149 /* S/PDIF hardware input 4 left channel */
1150 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1151 1, 0x21, 0x011e, 0x4001, &com_buff, 2);
1152 /* S/PDIF hardware input 4 right channel */
1153 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1154 1, 0x21, 0x011f, 0x4001, &com_buff, 2);
1155 /* S/PDIF software return 1 left channel */
1156 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1157 1, 0x21, 0x0102, 0x4001, &com_buff, 2);
1158 /* S/PDIF software return 1 right channel */
1159 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1160 1, 0x21, 0x0103, 0x4001, &com_buff, 2);
1161 /* S/PDIF software return 2 left channel */
1162 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1163 1, 0x21, 0x0106, 0x4001, &com_buff, 2);
1164 /* S/PDIF software return 2 right channel */
1165 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1166 1, 0x21, 0x0107, 0x4001, &com_buff, 2);
1167
1168 com_buff[0] = 0x00;
1169 com_buff[1] = 0x00;
1170 /* S/PDIF software return 3 left channel */
1171 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1172 1, 0x21, 0x010a, 0x4001, &com_buff, 2);
1173
1174 com_buff[0] = 0x00;
1175 com_buff[1] = 0x80;
1176 /* S/PDIF software return 3 right channel */
1177 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1178 1, 0x21, 0x010b, 0x4001, &com_buff, 2);
1179 /* S/PDIF software return 4 left channel */
1180 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1181 1, 0x21, 0x010e, 0x4001, &com_buff, 2);
1182
1183 com_buff[0] = 0x00;
1184 com_buff[1] = 0x00;
1185 /* S/PDIF software return 4 right channel */
1186 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1187 1, 0x21, 0x010f, 0x4001, &com_buff, 2);
1188
1189 com_buff[0] = 0x00;
1190 com_buff[1] = 0x80;
1191 /* S/PDIF fx returns left channel */
1192 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1193 1, 0x21, 0x0122, 0x4001, &com_buff, 2);
1194 /* S/PDIF fx returns right channel */
1195 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1196 1, 0x21, 0x0123, 0x4001, &com_buff, 2);
1197
1198 /* Set the dropdown "Effect" to the first option */
1199 /* Room1 = 0x00 */
1200 /* Room2 = 0x01 */
1201 /* Room3 = 0x02 */
1202 /* Hall 1 = 0x03 */
1203 /* Hall 2 = 0x04 */
1204 /* Plate = 0x05 */
1205 /* Delay = 0x06 */
1206 /* Echo = 0x07 */
1207 com_buff[0] = 0x00;
1208 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1209 1, 0x21, 0x0200, 0x4301, &com_buff, 1); /* max is 0xff */
1210 /* min is 0x00 */
1211
1212
1213 /* Set the effect duration to 0 */
1214 /* max is 0xffff */
1215 /* min is 0x0000 */
1216 com_buff[0] = 0x00;
1217 com_buff[1] = 0x00;
1218 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1219 1, 0x21, 0x0400, 0x4301, &com_buff, 2);
1220
1221 /* Set the effect volume and feedback to 0 */
1222 /* max is 0xff */
1223 /* min is 0x00 */
1224 com_buff[0] = 0x00;
1225 /* feedback: */
1226 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1227 1, 0x21, 0x0500, 0x4301, &com_buff, 1);
1228 /* volume: */
1229 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1230 1, 0x21, 0x0300, 0x4301, &com_buff, 1);
1231
1232 /* Set soft button hold duration */
1233 /* 0x03 = 250ms */
1234 /* 0x05 = 500ms DEFAULT */
1235 /* 0x08 = 750ms */
1236 /* 0x0a = 1sec */
1237 com_buff[0] = 0x05;
1238 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1239 3, 0x21, 0x0005, 0x2001, &com_buff, 1);
1240
1241 /* Use dim LEDs for button of state */
1242 com_buff[0] = 0x00;
1243 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
1244 3, 0x21, 0x0004, 0x2001, &com_buff, 1);
1245 }
1246
1247 #define MBOX3_DESCRIPTOR_SIZE 464
1248
snd_usb_mbox3_boot_quirk(struct usb_device * dev)1249 static int snd_usb_mbox3_boot_quirk(struct usb_device *dev)
1250 {
1251 struct usb_host_config *config = dev->actconfig;
1252 int err;
1253 int descriptor_size;
1254
1255 descriptor_size = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
1256
1257 if (descriptor_size != MBOX3_DESCRIPTOR_SIZE) {
1258 dev_err(&dev->dev, "MBOX3: Invalid descriptor size=%d.\n", descriptor_size);
1259 return -ENODEV;
1260 }
1261
1262 dev_dbg(&dev->dev, "MBOX3: device initialised!\n");
1263
1264 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
1265 &dev->descriptor, sizeof(dev->descriptor));
1266 config = dev->actconfig;
1267 if (err < 0)
1268 dev_dbg(&dev->dev, "MBOX3: error usb_get_descriptor: %d\n", err);
1269
1270 err = usb_reset_configuration(dev);
1271 if (err < 0)
1272 dev_dbg(&dev->dev, "MBOX3: error usb_reset_configuration: %d\n", err);
1273
1274 dev_dbg(&dev->dev, "MBOX3: new boot length = %d\n",
1275 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
1276
1277 mbox3_setup_defaults(dev);
1278 dev_info(&dev->dev, "MBOX3: Initialized.");
1279
1280 return 0; /* Successful boot */
1281 }
1282
1283 #define MICROBOOK_BUF_SIZE 128
1284
snd_usb_motu_microbookii_communicate(struct usb_device * dev,u8 * buf,int buf_size,int * length)1285 static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1286 int buf_size, int *length)
1287 {
1288 int err, actual_length;
1289
1290 if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
1291 return -EINVAL;
1292 err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1293 &actual_length, 1000);
1294 if (err < 0)
1295 return err;
1296
1297 print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1298 buf, actual_length, false);
1299
1300 memset(buf, 0, buf_size);
1301
1302 if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
1303 return -EINVAL;
1304 err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1305 &actual_length, 1000);
1306 if (err < 0)
1307 return err;
1308
1309 print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1310 buf, actual_length, false);
1311
1312 *length = actual_length;
1313 return 0;
1314 }
1315
snd_usb_motu_microbookii_boot_quirk(struct usb_device * dev)1316 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1317 {
1318 int err, actual_length, poll_attempts = 0;
1319 static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1320 0x00, 0x00, 0x0b, 0x14,
1321 0x00, 0x00, 0x00, 0x01 };
1322 static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1323 0x00, 0x00, 0x0b, 0x18 };
1324 u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1325
1326 if (!buf)
1327 return -ENOMEM;
1328
1329 dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1330
1331 /* First we tell the device which sample rate to use. */
1332 memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1333 actual_length = sizeof(set_samplerate_seq);
1334 err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1335 &actual_length);
1336
1337 if (err < 0) {
1338 dev_err(&dev->dev,
1339 "failed setting the sample rate for Motu MicroBook II: %d\n",
1340 err);
1341 goto free_buf;
1342 }
1343
1344 /* Then we poll every 100 ms until the device informs of its readiness. */
1345 while (true) {
1346 if (++poll_attempts > 100) {
1347 dev_err(&dev->dev,
1348 "failed booting Motu MicroBook II: timeout\n");
1349 err = -ENODEV;
1350 goto free_buf;
1351 }
1352
1353 memset(buf, 0, MICROBOOK_BUF_SIZE);
1354 memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1355
1356 actual_length = sizeof(poll_ready_seq);
1357 err = snd_usb_motu_microbookii_communicate(
1358 dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1359 if (err < 0) {
1360 dev_err(&dev->dev,
1361 "failed booting Motu MicroBook II: communication error %d\n",
1362 err);
1363 goto free_buf;
1364 }
1365
1366 /* the device signals its readiness through a message of the
1367 * form
1368 * XX 06 00 00 00 00 0b 18 00 00 00 01
1369 * If the device is not yet ready to accept audio data, the
1370 * last byte of that sequence is 00.
1371 */
1372 if (actual_length == 12 && buf[actual_length - 1] == 1)
1373 break;
1374
1375 msleep(100);
1376 }
1377
1378 dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1379
1380 free_buf:
1381 kfree(buf);
1382 return err;
1383 }
1384
snd_usb_motu_m_series_boot_quirk(struct usb_device * dev)1385 static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1386 {
1387 msleep(4000);
1388
1389 return 0;
1390 }
1391
1392 /*
1393 * Setup quirks
1394 */
1395 #define MAUDIO_SET 0x01 /* parse device_setup */
1396 #define MAUDIO_SET_COMPATIBLE 0x80 /* use only "win-compatible" interfaces */
1397 #define MAUDIO_SET_DTS 0x02 /* enable DTS Digital Output */
1398 #define MAUDIO_SET_96K 0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
1399 #define MAUDIO_SET_24B 0x08 /* 24bits sample if set, 16bits otherwise */
1400 #define MAUDIO_SET_DI 0x10 /* enable Digital Input */
1401 #define MAUDIO_SET_MASK 0x1f /* bit mask for setup value */
1402 #define MAUDIO_SET_24B_48K_DI 0x19 /* 24bits+48kHz+Digital Input */
1403 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48kHz+No Digital Input */
1404 #define MAUDIO_SET_16B_48K_DI 0x11 /* 16bits+48kHz+Digital Input */
1405 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48kHz+No Digital Input */
1406
quattro_skip_setting_quirk(struct snd_usb_audio * chip,int iface,int altno)1407 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1408 int iface, int altno)
1409 {
1410 /* Reset ALL ifaces to 0 altsetting.
1411 * Call it for every possible altsetting of every interface.
1412 */
1413 usb_set_interface(chip->dev, iface, 0);
1414 if (chip->setup & MAUDIO_SET) {
1415 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1416 if (iface != 1 && iface != 2)
1417 return 1; /* skip all interfaces but 1 and 2 */
1418 } else {
1419 unsigned int mask;
1420 if (iface == 1 || iface == 2)
1421 return 1; /* skip interfaces 1 and 2 */
1422 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1423 return 1; /* skip this altsetting */
1424 mask = chip->setup & MAUDIO_SET_MASK;
1425 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1426 return 1; /* skip this altsetting */
1427 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1428 return 1; /* skip this altsetting */
1429 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1430 return 1; /* skip this altsetting */
1431 }
1432 }
1433 usb_audio_dbg(chip,
1434 "using altsetting %d for interface %d config %d\n",
1435 altno, iface, chip->setup);
1436 return 0; /* keep this altsetting */
1437 }
1438
audiophile_skip_setting_quirk(struct snd_usb_audio * chip,int iface,int altno)1439 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1440 int iface,
1441 int altno)
1442 {
1443 /* Reset ALL ifaces to 0 altsetting.
1444 * Call it for every possible altsetting of every interface.
1445 */
1446 usb_set_interface(chip->dev, iface, 0);
1447
1448 if (chip->setup & MAUDIO_SET) {
1449 unsigned int mask;
1450 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1451 return 1; /* skip this altsetting */
1452 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1453 return 1; /* skip this altsetting */
1454 mask = chip->setup & MAUDIO_SET_MASK;
1455 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1456 return 1; /* skip this altsetting */
1457 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1458 return 1; /* skip this altsetting */
1459 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1460 return 1; /* skip this altsetting */
1461 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1462 return 1; /* skip this altsetting */
1463 }
1464
1465 return 0; /* keep this altsetting */
1466 }
1467
fasttrackpro_skip_setting_quirk(struct snd_usb_audio * chip,int iface,int altno)1468 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1469 int iface, int altno)
1470 {
1471 /* Reset ALL ifaces to 0 altsetting.
1472 * Call it for every possible altsetting of every interface.
1473 */
1474 usb_set_interface(chip->dev, iface, 0);
1475
1476 /* possible configuration where both inputs and only one output is
1477 *used is not supported by the current setup
1478 */
1479 if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1480 if (chip->setup & MAUDIO_SET_96K) {
1481 if (altno != 3 && altno != 6)
1482 return 1;
1483 } else if (chip->setup & MAUDIO_SET_DI) {
1484 if (iface == 4)
1485 return 1; /* no analog input */
1486 if (altno != 2 && altno != 5)
1487 return 1; /* enable only altsets 2 and 5 */
1488 } else {
1489 if (iface == 5)
1490 return 1; /* disable digialt input */
1491 if (altno != 2 && altno != 5)
1492 return 1; /* enalbe only altsets 2 and 5 */
1493 }
1494 } else {
1495 /* keep only 16-Bit mode */
1496 if (altno != 1)
1497 return 1;
1498 }
1499
1500 usb_audio_dbg(chip,
1501 "using altsetting %d for interface %d config %d\n",
1502 altno, iface, chip->setup);
1503 return 0; /* keep this altsetting */
1504 }
1505
s1810c_skip_setting_quirk(struct snd_usb_audio * chip,int iface,int altno)1506 static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1507 int iface, int altno)
1508 {
1509 /*
1510 * Altno settings:
1511 *
1512 * Playback (Interface 1):
1513 * 1: 6 Analog + 2 S/PDIF
1514 * 2: 6 Analog + 2 S/PDIF
1515 * 3: 6 Analog
1516 *
1517 * Capture (Interface 2):
1518 * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1519 * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1520 * 3: 8 Analog
1521 */
1522
1523 /*
1524 * I'll leave 2 as the default one and
1525 * use device_setup to switch to the
1526 * other two.
1527 */
1528 if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1529 return 1;
1530 else if (chip->setup == 1 && altno != 1)
1531 return 1;
1532 else if (chip->setup == 2 && altno != 3)
1533 return 1;
1534
1535 return 0;
1536 }
1537
snd_usb_apply_interface_quirk(struct snd_usb_audio * chip,int iface,int altno)1538 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1539 int iface,
1540 int altno)
1541 {
1542 /* audiophile usb: skip altsets incompatible with device_setup */
1543 if (chip->usb_id == USB_ID(0x0763, 0x2003))
1544 return audiophile_skip_setting_quirk(chip, iface, altno);
1545 /* quattro usb: skip altsets incompatible with device_setup */
1546 if (chip->usb_id == USB_ID(0x0763, 0x2001))
1547 return quattro_skip_setting_quirk(chip, iface, altno);
1548 /* fasttrackpro usb: skip altsets incompatible with device_setup */
1549 if (chip->usb_id == USB_ID(0x0763, 0x2012))
1550 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
1551 /* presonus studio 1810c: skip altsets incompatible with device_setup */
1552 if (chip->usb_id == USB_ID(0x194f, 0x010c))
1553 return s1810c_skip_setting_quirk(chip, iface, altno);
1554
1555
1556 return 0;
1557 }
1558
snd_usb_apply_boot_quirk(struct usb_device * dev,struct usb_interface * intf,const struct snd_usb_audio_quirk * quirk,unsigned int id)1559 int snd_usb_apply_boot_quirk(struct usb_device *dev,
1560 struct usb_interface *intf,
1561 const struct snd_usb_audio_quirk *quirk,
1562 unsigned int id)
1563 {
1564 switch (id) {
1565 case USB_ID(0x041e, 0x3000):
1566 /* SB Extigy needs special boot-up sequence */
1567 /* if more models come, this will go to the quirk list. */
1568 return snd_usb_extigy_boot_quirk(dev, intf);
1569
1570 case USB_ID(0x041e, 0x3020):
1571 /* SB Audigy 2 NX needs its own boot-up magic, too */
1572 return snd_usb_audigy2nx_boot_quirk(dev);
1573
1574 case USB_ID(0x10f5, 0x0200):
1575 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1576 return snd_usb_cm106_boot_quirk(dev);
1577
1578 case USB_ID(0x0d8c, 0x0102):
1579 /* C-Media CM6206 / CM106-Like Sound Device */
1580 case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1581 return snd_usb_cm6206_boot_quirk(dev);
1582
1583 case USB_ID(0x0dba, 0x3000):
1584 /* Digidesign Mbox 2 */
1585 return snd_usb_mbox2_boot_quirk(dev);
1586 case USB_ID(0x0dba, 0x5000):
1587 /* Digidesign Mbox 3 */
1588 return snd_usb_mbox3_boot_quirk(dev);
1589
1590
1591 case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1592 case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1593 return snd_usb_novation_boot_quirk(dev);
1594
1595 case USB_ID(0x133e, 0x0815):
1596 /* Access Music VirusTI Desktop */
1597 return snd_usb_accessmusic_boot_quirk(dev);
1598
1599 case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1600 case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1601 case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1602 return snd_usb_nativeinstruments_boot_quirk(dev);
1603 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
1604 return snd_usb_fasttrackpro_boot_quirk(dev);
1605 case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1606 return snd_usb_gamecon780_boot_quirk(dev);
1607 case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1608 return snd_usb_axefx3_boot_quirk(dev);
1609 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1610 /*
1611 * For some reason interface 3 with vendor-spec class is
1612 * detected on MicroBook IIc.
1613 */
1614 if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1615 USB_CLASS_VENDOR_SPEC &&
1616 get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1617 return snd_usb_motu_microbookii_boot_quirk(dev);
1618 break;
1619 }
1620
1621 return 0;
1622 }
1623
snd_usb_apply_boot_quirk_once(struct usb_device * dev,struct usb_interface * intf,const struct snd_usb_audio_quirk * quirk,unsigned int id)1624 int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1625 struct usb_interface *intf,
1626 const struct snd_usb_audio_quirk *quirk,
1627 unsigned int id)
1628 {
1629 switch (id) {
1630 case USB_ID(0x07fd, 0x0008): /* MOTU M Series, 1st hardware version */
1631 return snd_usb_motu_m_series_boot_quirk(dev);
1632 }
1633
1634 return 0;
1635 }
1636
1637 /*
1638 * check if the device uses big-endian samples
1639 */
snd_usb_is_big_endian_format(struct snd_usb_audio * chip,const struct audioformat * fp)1640 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip,
1641 const struct audioformat *fp)
1642 {
1643 /* it depends on altsetting whether the device is big-endian or not */
1644 switch (chip->usb_id) {
1645 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1646 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1647 fp->altsetting == 5 || fp->altsetting == 6)
1648 return 1;
1649 break;
1650 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1651 if (chip->setup == 0x00 ||
1652 fp->altsetting == 1 || fp->altsetting == 2 ||
1653 fp->altsetting == 3)
1654 return 1;
1655 break;
1656 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1657 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1658 fp->altsetting == 5 || fp->altsetting == 6)
1659 return 1;
1660 break;
1661 }
1662 return 0;
1663 }
1664
1665 /*
1666 * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1667 * not for interface.
1668 */
1669
1670 enum {
1671 EMU_QUIRK_SR_44100HZ = 0,
1672 EMU_QUIRK_SR_48000HZ,
1673 EMU_QUIRK_SR_88200HZ,
1674 EMU_QUIRK_SR_96000HZ,
1675 EMU_QUIRK_SR_176400HZ,
1676 EMU_QUIRK_SR_192000HZ
1677 };
1678
set_format_emu_quirk(struct snd_usb_substream * subs,const struct audioformat * fmt)1679 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1680 const struct audioformat *fmt)
1681 {
1682 unsigned char emu_samplerate_id = 0;
1683
1684 /* When capture is active
1685 * sample rate shouldn't be changed
1686 * by playback substream
1687 */
1688 if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1689 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].cur_audiofmt)
1690 return;
1691 }
1692
1693 switch (fmt->rate_min) {
1694 case 48000:
1695 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1696 break;
1697 case 88200:
1698 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1699 break;
1700 case 96000:
1701 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1702 break;
1703 case 176400:
1704 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1705 break;
1706 case 192000:
1707 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1708 break;
1709 default:
1710 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1711 break;
1712 }
1713 snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1714 subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1715 }
1716
pioneer_djm_set_format_quirk(struct snd_usb_substream * subs,u16 windex)1717 static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs,
1718 u16 windex)
1719 {
1720 unsigned int cur_rate = subs->data_endpoint->cur_rate;
1721 u8 sr[3];
1722 // Convert to little endian
1723 sr[0] = cur_rate & 0xff;
1724 sr[1] = (cur_rate >> 8) & 0xff;
1725 sr[2] = (cur_rate >> 16) & 0xff;
1726 usb_set_interface(subs->dev, 0, 1);
1727 // we should derive windex from fmt-sync_ep but it's not set
1728 snd_usb_ctl_msg(subs->stream->chip->dev,
1729 usb_sndctrlpipe(subs->stream->chip->dev, 0),
1730 0x01, 0x22, 0x0100, windex, &sr, 0x0003);
1731 return 0;
1732 }
1733
mbox3_set_format_quirk(struct snd_usb_substream * subs,const struct audioformat * fmt)1734 static void mbox3_set_format_quirk(struct snd_usb_substream *subs,
1735 const struct audioformat *fmt)
1736 {
1737 __le32 buff4 = 0;
1738 u8 buff1 = 0x01;
1739 u32 new_rate = subs->data_endpoint->cur_rate;
1740 u32 current_rate;
1741
1742 // Get current rate from card and check if changing it is needed
1743 snd_usb_ctl_msg(subs->dev, usb_rcvctrlpipe(subs->dev, 0),
1744 0x01, 0x21 | USB_DIR_IN, 0x0100, 0x8101, &buff4, 4);
1745 current_rate = le32_to_cpu(buff4);
1746 dev_dbg(&subs->dev->dev,
1747 "MBOX3: Current configured sample rate: %d", current_rate);
1748 if (current_rate == new_rate) {
1749 dev_dbg(&subs->dev->dev,
1750 "MBOX3: No change needed (current rate:%d == new rate:%d)",
1751 current_rate, new_rate);
1752 return;
1753 }
1754
1755 // Set new rate
1756 dev_info(&subs->dev->dev,
1757 "MBOX3: Changing sample rate to: %d", new_rate);
1758 buff4 = cpu_to_le32(new_rate);
1759 snd_usb_ctl_msg(subs->dev, usb_sndctrlpipe(subs->dev, 0),
1760 0x01, 0x21, 0x0100, 0x8101, &buff4, 4);
1761
1762 // Set clock source to Internal
1763 snd_usb_ctl_msg(subs->dev, usb_sndctrlpipe(subs->dev, 0),
1764 0x01, 0x21, 0x0100, 0x8001, &buff1, 1);
1765
1766 // Check whether the change was successful
1767 buff4 = 0;
1768 snd_usb_ctl_msg(subs->dev, usb_rcvctrlpipe(subs->dev, 0),
1769 0x01, 0x21 | USB_DIR_IN, 0x0100, 0x8101, &buff4, 4);
1770 if (new_rate != le32_to_cpu(buff4))
1771 dev_warn(&subs->dev->dev, "MBOX3: Couldn't set the sample rate");
1772 }
1773
snd_usb_set_format_quirk(struct snd_usb_substream * subs,const struct audioformat * fmt)1774 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1775 const struct audioformat *fmt)
1776 {
1777 switch (subs->stream->chip->usb_id) {
1778 case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1779 case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1780 case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1781 case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1782 set_format_emu_quirk(subs, fmt);
1783 break;
1784 case USB_ID(0x534d, 0x0021): /* MacroSilicon MS2100/MS2106 */
1785 case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1786 subs->stream_offset_adj = 2;
1787 break;
1788 case USB_ID(0x2b73, 0x0013): /* Pioneer DJM-450 */
1789 pioneer_djm_set_format_quirk(subs, 0x0082);
1790 break;
1791 case USB_ID(0x08e4, 0x017f): /* Pioneer DJM-750 */
1792 case USB_ID(0x08e4, 0x0163): /* Pioneer DJM-850 */
1793 pioneer_djm_set_format_quirk(subs, 0x0086);
1794 break;
1795 case USB_ID(0x0dba, 0x5000):
1796 mbox3_set_format_quirk(subs, fmt); /* Digidesign Mbox 3 */
1797 break;
1798 }
1799 }
1800
snd_usb_select_mode_quirk(struct snd_usb_audio * chip,const struct audioformat * fmt)1801 int snd_usb_select_mode_quirk(struct snd_usb_audio *chip,
1802 const struct audioformat *fmt)
1803 {
1804 struct usb_device *dev = chip->dev;
1805 int err;
1806
1807 if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
1808 /* First switch to alt set 0, otherwise the mode switch cmd
1809 * will not be accepted by the DAC
1810 */
1811 err = usb_set_interface(dev, fmt->iface, 0);
1812 if (err < 0)
1813 return err;
1814
1815 msleep(20); /* Delay needed after setting the interface */
1816
1817 /* Vendor mode switch cmd is required. */
1818 if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1819 /* DSD mode (DSD_U32) requested */
1820 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1821 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1822 1, 1, NULL, 0);
1823 if (err < 0)
1824 return err;
1825
1826 } else {
1827 /* PCM or DOP mode (S32) requested */
1828 /* PCM mode (S16) requested */
1829 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1830 USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1831 0, 1, NULL, 0);
1832 if (err < 0)
1833 return err;
1834
1835 }
1836 msleep(20);
1837 }
1838 return 0;
1839 }
1840
snd_usb_endpoint_start_quirk(struct snd_usb_endpoint * ep)1841 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1842 {
1843 /*
1844 * "Playback Design" products send bogus feedback data at the start
1845 * of the stream. Ignore them.
1846 */
1847 if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1848 ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1849 ep->skip_packets = 4;
1850
1851 /*
1852 * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1853 * world latency varies by approx. +/- 50 frames (at 96kHz) each time
1854 * the stream is (re)started. When skipping packets 16 at endpoint
1855 * start up, the real world latency is stable within +/- 1 frame (also
1856 * across power cycles).
1857 */
1858 if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1859 ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1860 ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1861 ep->skip_packets = 16;
1862
1863 /* Work around devices that report unreasonable feedback data */
1864 if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) || /* TEAC UD-H01 */
1865 ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1866 ep->syncmaxsize == 4)
1867 ep->tenor_fb_quirk = 1;
1868 }
1869
1870 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
snd_usb_ctl_msg_quirk(struct usb_device * dev,unsigned int pipe,__u8 request,__u8 requesttype,__u16 value,__u16 index,void * data,__u16 size)1871 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1872 __u8 request, __u8 requesttype, __u16 value,
1873 __u16 index, void *data, __u16 size)
1874 {
1875 struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1876
1877 if (!chip || (requesttype & USB_TYPE_MASK) != USB_TYPE_CLASS)
1878 return;
1879
1880 if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY)
1881 msleep(20);
1882 else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_1M)
1883 usleep_range(1000, 2000);
1884 else if (chip->quirk_flags & QUIRK_FLAG_CTL_MSG_DELAY_5M)
1885 usleep_range(5000, 6000);
1886 }
1887
1888 /*
1889 * snd_usb_interface_dsd_format_quirks() is called from format.c to
1890 * augment the PCM format bit-field for DSD types. The UAC standards
1891 * don't have a designated bit field to denote DSD-capable interfaces,
1892 * hence all hardware that is known to support this format has to be
1893 * listed here.
1894 */
snd_usb_interface_dsd_format_quirks(struct snd_usb_audio * chip,struct audioformat * fp,unsigned int sample_bytes)1895 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1896 struct audioformat *fp,
1897 unsigned int sample_bytes)
1898 {
1899 struct usb_interface *iface;
1900
1901 /* Playback Designs */
1902 if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1903 USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
1904 switch (fp->altsetting) {
1905 case 1:
1906 fp->dsd_dop = true;
1907 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1908 case 2:
1909 fp->dsd_bitrev = true;
1910 return SNDRV_PCM_FMTBIT_DSD_U8;
1911 case 3:
1912 fp->dsd_bitrev = true;
1913 return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1914 }
1915 }
1916
1917 /* XMOS based USB DACs */
1918 switch (chip->usb_id) {
1919 case USB_ID(0x139f, 0x5504): /* Nagra DAC */
1920 case USB_ID(0x20b1, 0x3089): /* Mola-Mola DAC */
1921 case USB_ID(0x2522, 0x0007): /* LH Labs Geek Out 1V5 */
1922 case USB_ID(0x2522, 0x0009): /* LH Labs Geek Pulse X Inifinity 2V0 */
1923 case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1924 case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1925 if (fp->altsetting == 2)
1926 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1927 break;
1928
1929 case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1930 case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1931 case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
1932 case USB_ID(0x16d0, 0x06b4): /* NuPrime Audio HD-AVP/AVA */
1933 case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1934 case USB_ID(0x16d0, 0x09d8): /* NuPrime IDA-8 */
1935 case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1936 case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1937 case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
1938 case USB_ID(0x20a0, 0x4143): /* WaveIO USB Audio 2.0 */
1939 case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1940 case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1941 case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1942 case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1943 case USB_ID(0x278b, 0x5100): /* Rotel RC-1590 */
1944 case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1945 case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1946 case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1947 if (fp->altsetting == 3)
1948 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1949 break;
1950
1951 /* Amanero Combo384 USB based DACs with native DSD support */
1952 case USB_ID(0x16d0, 0x071a): /* Amanero - Combo384 */
1953 if (fp->altsetting == 2) {
1954 switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
1955 case 0x199:
1956 return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1957 case 0x19b:
1958 case 0x203:
1959 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1960 default:
1961 break;
1962 }
1963 }
1964 break;
1965 case USB_ID(0x16d0, 0x0a23):
1966 if (fp->altsetting == 2)
1967 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1968 break;
1969
1970 default:
1971 break;
1972 }
1973
1974 /* ITF-USB DSD based DACs */
1975 if (chip->quirk_flags & QUIRK_FLAG_ITF_USB_DSD_DAC) {
1976 iface = usb_ifnum_to_if(chip->dev, fp->iface);
1977
1978 /* Altsetting 2 support native DSD if the num of altsets is
1979 * three (0-2),
1980 * Altsetting 3 support native DSD if the num of altsets is
1981 * four (0-3).
1982 */
1983 if (fp->altsetting == iface->num_altsetting - 1)
1984 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1985 }
1986
1987 /* Mostly generic method to detect many DSD-capable implementations */
1988 if ((chip->quirk_flags & QUIRK_FLAG_DSD_RAW) && fp->dsd_raw)
1989 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1990
1991 return 0;
1992 }
1993
snd_usb_audioformat_attributes_quirk(struct snd_usb_audio * chip,struct audioformat * fp,int stream)1994 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1995 struct audioformat *fp,
1996 int stream)
1997 {
1998 switch (chip->usb_id) {
1999 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
2000 /* Optoplay sets the sample rate attribute although
2001 * it seems not supporting it in fact.
2002 */
2003 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
2004 break;
2005 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
2006 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
2007 /* doesn't set the sample rate attribute, but supports it */
2008 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
2009 break;
2010 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
2011 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
2012 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
2013 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
2014 an older model 77d:223) */
2015 /*
2016 * plantronics headset and Griffin iMic have set adaptive-in
2017 * although it's really not...
2018 */
2019 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
2020 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2021 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
2022 else
2023 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
2024 break;
2025 case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook IIc */
2026 /*
2027 * MaxPacketsOnly attribute is erroneously set in endpoint
2028 * descriptors. As a result this card produces noise with
2029 * all sample rates other than 96 kHz.
2030 */
2031 fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
2032 break;
2033 case USB_ID(0x1224, 0x2a25): /* Jieli Technology USB PHY 2.0 */
2034 /* mic works only when ep packet size is set to wMaxPacketSize */
2035 fp->attributes |= UAC_EP_CS_ATTR_FILL_MAX;
2036 break;
2037 case USB_ID(0x3511, 0x2b1e): /* Opencomm2 UC USB Bluetooth dongle */
2038 /* mic works only when ep pitch control is not set */
2039 if (stream == SNDRV_PCM_STREAM_CAPTURE)
2040 fp->attributes &= ~UAC_EP_CS_ATTR_PITCH_CONTROL;
2041 break;
2042 }
2043 }
2044
2045 /*
2046 * driver behavior quirk flags
2047 */
2048 struct usb_audio_quirk_flags_table {
2049 u32 id;
2050 u32 flags;
2051 };
2052
2053 #define DEVICE_FLG(vid, pid, _flags) \
2054 { .id = USB_ID(vid, pid), .flags = (_flags) }
2055 #define VENDOR_FLG(vid, _flags) DEVICE_FLG(vid, 0, _flags)
2056
2057 static const struct usb_audio_quirk_flags_table quirk_flags_table[] = {
2058 /* Device matches */
2059 DEVICE_FLG(0x041e, 0x3000, /* Creative SB Extigy */
2060 QUIRK_FLAG_IGNORE_CTL_ERROR),
2061 DEVICE_FLG(0x041e, 0x4080, /* Creative Live Cam VF0610 */
2062 QUIRK_FLAG_GET_SAMPLE_RATE),
2063 DEVICE_FLG(0x045e, 0x083c, /* MS USB Link headset */
2064 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY |
2065 QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2066 DEVICE_FLG(0x046d, 0x084c, /* Logitech ConferenceCam Connect */
2067 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2068 DEVICE_FLG(0x046d, 0x0991, /* Logitech QuickCam Pro */
2069 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR),
2070 DEVICE_FLG(0x046d, 0x09a4, /* Logitech QuickCam E 3500 */
2071 QUIRK_FLAG_CTL_MSG_DELAY_1M | QUIRK_FLAG_IGNORE_CTL_ERROR),
2072 DEVICE_FLG(0x0499, 0x1509, /* Steinberg UR22 */
2073 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2074 DEVICE_FLG(0x0499, 0x3108, /* Yamaha YIT-W12TX */
2075 QUIRK_FLAG_GET_SAMPLE_RATE),
2076 DEVICE_FLG(0x04d8, 0xfeea, /* Benchmark DAC1 Pre */
2077 QUIRK_FLAG_GET_SAMPLE_RATE),
2078 DEVICE_FLG(0x04e8, 0xa051, /* Samsung USBC Headset (AKG) */
2079 QUIRK_FLAG_SKIP_CLOCK_SELECTOR | QUIRK_FLAG_CTL_MSG_DELAY_5M),
2080 DEVICE_FLG(0x0525, 0xa4ad, /* Hamedal C20 usb camero */
2081 QUIRK_FLAG_IFACE_SKIP_CLOSE),
2082 DEVICE_FLG(0x054c, 0x0b8c, /* Sony WALKMAN NW-A45 DAC */
2083 QUIRK_FLAG_SET_IFACE_FIRST),
2084 DEVICE_FLG(0x0556, 0x0014, /* Phoenix Audio TMX320VC */
2085 QUIRK_FLAG_GET_SAMPLE_RATE),
2086 DEVICE_FLG(0x05a3, 0x9420, /* ELP HD USB Camera */
2087 QUIRK_FLAG_GET_SAMPLE_RATE),
2088 DEVICE_FLG(0x05a7, 0x1020, /* Bose Companion 5 */
2089 QUIRK_FLAG_GET_SAMPLE_RATE),
2090 DEVICE_FLG(0x05e1, 0x0408, /* Syntek STK1160 */
2091 QUIRK_FLAG_ALIGN_TRANSFER),
2092 DEVICE_FLG(0x05e1, 0x0480, /* Hauppauge Woodbury */
2093 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2094 DEVICE_FLG(0x0644, 0x8043, /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
2095 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2096 QUIRK_FLAG_IFACE_DELAY),
2097 DEVICE_FLG(0x0644, 0x8044, /* Esoteric D-05X */
2098 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2099 QUIRK_FLAG_IFACE_DELAY),
2100 DEVICE_FLG(0x0644, 0x804a, /* TEAC UD-301 */
2101 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2102 QUIRK_FLAG_IFACE_DELAY),
2103 DEVICE_FLG(0x0644, 0x805f, /* TEAC Model 12 */
2104 QUIRK_FLAG_FORCE_IFACE_RESET),
2105 DEVICE_FLG(0x0644, 0x806b, /* TEAC UD-701 */
2106 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY |
2107 QUIRK_FLAG_IFACE_DELAY),
2108 DEVICE_FLG(0x06f8, 0xb000, /* Hercules DJ Console (Windows Edition) */
2109 QUIRK_FLAG_IGNORE_CTL_ERROR),
2110 DEVICE_FLG(0x06f8, 0xd002, /* Hercules DJ Console (Macintosh Edition) */
2111 QUIRK_FLAG_IGNORE_CTL_ERROR),
2112 DEVICE_FLG(0x0711, 0x5800, /* MCT Trigger 5 USB-to-HDMI */
2113 QUIRK_FLAG_GET_SAMPLE_RATE),
2114 DEVICE_FLG(0x074d, 0x3553, /* Outlaw RR2150 (Micronas UAC3553B) */
2115 QUIRK_FLAG_GET_SAMPLE_RATE),
2116 DEVICE_FLG(0x0763, 0x2030, /* M-Audio Fast Track C400 */
2117 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2118 DEVICE_FLG(0x0763, 0x2031, /* M-Audio Fast Track C600 */
2119 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2120 DEVICE_FLG(0x07fd, 0x000b, /* MOTU M Series 2nd hardware revision */
2121 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2122 DEVICE_FLG(0x08bb, 0x2702, /* LineX FM Transmitter */
2123 QUIRK_FLAG_IGNORE_CTL_ERROR),
2124 DEVICE_FLG(0x0951, 0x16ad, /* Kingston HyperX */
2125 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2126 DEVICE_FLG(0x0b0e, 0x0349, /* Jabra 550a */
2127 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2128 DEVICE_FLG(0x0ecb, 0x205c, /* JBL Quantum610 Wireless */
2129 QUIRK_FLAG_FIXED_RATE),
2130 DEVICE_FLG(0x0ecb, 0x2069, /* JBL Quantum810 Wireless */
2131 QUIRK_FLAG_FIXED_RATE),
2132 DEVICE_FLG(0x0fd9, 0x0008, /* Hauppauge HVR-950Q */
2133 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2134 DEVICE_FLG(0x1224, 0x2a25, /* Jieli Technology USB PHY 2.0 */
2135 QUIRK_FLAG_GET_SAMPLE_RATE),
2136 DEVICE_FLG(0x1395, 0x740a, /* Sennheiser DECT */
2137 QUIRK_FLAG_GET_SAMPLE_RATE),
2138 DEVICE_FLG(0x1397, 0x0507, /* Behringer UMC202HD */
2139 QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2140 DEVICE_FLG(0x1397, 0x0508, /* Behringer UMC204HD */
2141 QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2142 DEVICE_FLG(0x1397, 0x0509, /* Behringer UMC404HD */
2143 QUIRK_FLAG_PLAYBACK_FIRST | QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2144 DEVICE_FLG(0x13e5, 0x0001, /* Serato Phono */
2145 QUIRK_FLAG_IGNORE_CTL_ERROR),
2146 DEVICE_FLG(0x154e, 0x1002, /* Denon DCD-1500RE */
2147 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2148 DEVICE_FLG(0x154e, 0x1003, /* Denon DA-300USB */
2149 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2150 DEVICE_FLG(0x154e, 0x3005, /* Marantz HD-DAC1 */
2151 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2152 DEVICE_FLG(0x154e, 0x3006, /* Marantz SA-14S1 */
2153 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2154 DEVICE_FLG(0x154e, 0x300b, /* Marantz SA-KI RUBY / SA-12 */
2155 QUIRK_FLAG_DSD_RAW),
2156 DEVICE_FLG(0x154e, 0x500e, /* Denon DN-X1600 */
2157 QUIRK_FLAG_IGNORE_CLOCK_SOURCE),
2158 DEVICE_FLG(0x1686, 0x00dd, /* Zoom R16/24 */
2159 QUIRK_FLAG_TX_LENGTH | QUIRK_FLAG_CTL_MSG_DELAY_1M),
2160 DEVICE_FLG(0x17aa, 0x1046, /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
2161 QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2162 DEVICE_FLG(0x17aa, 0x104d, /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
2163 QUIRK_FLAG_DISABLE_AUTOSUSPEND),
2164 DEVICE_FLG(0x1852, 0x5065, /* Luxman DA-06 */
2165 QUIRK_FLAG_ITF_USB_DSD_DAC | QUIRK_FLAG_CTL_MSG_DELAY),
2166 DEVICE_FLG(0x1901, 0x0191, /* GE B850V3 CP2114 audio interface */
2167 QUIRK_FLAG_GET_SAMPLE_RATE),
2168 DEVICE_FLG(0x19f7, 0x0035, /* RODE NT-USB+ */
2169 QUIRK_FLAG_GET_SAMPLE_RATE),
2170 DEVICE_FLG(0x1bcf, 0x2283, /* NexiGo N930AF FHD Webcam */
2171 QUIRK_FLAG_GET_SAMPLE_RATE),
2172 DEVICE_FLG(0x2040, 0x7200, /* Hauppauge HVR-950Q */
2173 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2174 DEVICE_FLG(0x2040, 0x7201, /* Hauppauge HVR-950Q-MXL */
2175 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2176 DEVICE_FLG(0x2040, 0x7210, /* Hauppauge HVR-950Q */
2177 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2178 DEVICE_FLG(0x2040, 0x7211, /* Hauppauge HVR-950Q-MXL */
2179 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2180 DEVICE_FLG(0x2040, 0x7213, /* Hauppauge HVR-950Q */
2181 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2182 DEVICE_FLG(0x2040, 0x7217, /* Hauppauge HVR-950Q */
2183 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2184 DEVICE_FLG(0x2040, 0x721b, /* Hauppauge HVR-950Q */
2185 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2186 DEVICE_FLG(0x2040, 0x721e, /* Hauppauge HVR-950Q */
2187 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2188 DEVICE_FLG(0x2040, 0x721f, /* Hauppauge HVR-950Q */
2189 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2190 DEVICE_FLG(0x2040, 0x7240, /* Hauppauge HVR-850 */
2191 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2192 DEVICE_FLG(0x2040, 0x7260, /* Hauppauge HVR-950Q */
2193 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2194 DEVICE_FLG(0x2040, 0x7270, /* Hauppauge HVR-950Q */
2195 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2196 DEVICE_FLG(0x2040, 0x7280, /* Hauppauge HVR-950Q */
2197 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2198 DEVICE_FLG(0x2040, 0x7281, /* Hauppauge HVR-950Q-MXL */
2199 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2200 DEVICE_FLG(0x2040, 0x8200, /* Hauppauge Woodbury */
2201 QUIRK_FLAG_SHARE_MEDIA_DEVICE | QUIRK_FLAG_ALIGN_TRANSFER),
2202 DEVICE_FLG(0x21b4, 0x0081, /* AudioQuest DragonFly */
2203 QUIRK_FLAG_GET_SAMPLE_RATE),
2204 DEVICE_FLG(0x21b4, 0x0230, /* Ayre QB-9 Twenty */
2205 QUIRK_FLAG_DSD_RAW),
2206 DEVICE_FLG(0x21b4, 0x0232, /* Ayre QX-5 Twenty */
2207 QUIRK_FLAG_DSD_RAW),
2208 DEVICE_FLG(0x2522, 0x0007, /* LH Labs Geek Out HD Audio 1V5 */
2209 QUIRK_FLAG_SET_IFACE_FIRST),
2210 DEVICE_FLG(0x2708, 0x0002, /* Audient iD14 */
2211 QUIRK_FLAG_IGNORE_CTL_ERROR),
2212 DEVICE_FLG(0x2912, 0x30c8, /* Audioengine D1 */
2213 QUIRK_FLAG_GET_SAMPLE_RATE),
2214 DEVICE_FLG(0x2b53, 0x0023, /* Fiero SC-01 (firmware v1.0.0 @ 48 kHz) */
2215 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2216 DEVICE_FLG(0x2b53, 0x0024, /* Fiero SC-01 (firmware v1.0.0 @ 96 kHz) */
2217 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2218 DEVICE_FLG(0x2b53, 0x0031, /* Fiero SC-01 (firmware v1.1.0) */
2219 QUIRK_FLAG_GENERIC_IMPLICIT_FB),
2220 DEVICE_FLG(0x30be, 0x0101, /* Schiit Hel */
2221 QUIRK_FLAG_IGNORE_CTL_ERROR),
2222 DEVICE_FLG(0x413c, 0xa506, /* Dell AE515 sound bar */
2223 QUIRK_FLAG_GET_SAMPLE_RATE),
2224 DEVICE_FLG(0x534d, 0x0021, /* MacroSilicon MS2100/MS2106 */
2225 QUIRK_FLAG_ALIGN_TRANSFER),
2226 DEVICE_FLG(0x534d, 0x2109, /* MacroSilicon MS2109 */
2227 QUIRK_FLAG_ALIGN_TRANSFER),
2228
2229 /* Vendor matches */
2230 VENDOR_FLG(0x045e, /* MS Lifecam */
2231 QUIRK_FLAG_GET_SAMPLE_RATE),
2232 VENDOR_FLG(0x046d, /* Logitech */
2233 QUIRK_FLAG_CTL_MSG_DELAY_1M),
2234 VENDOR_FLG(0x047f, /* Plantronics */
2235 QUIRK_FLAG_GET_SAMPLE_RATE | QUIRK_FLAG_CTL_MSG_DELAY),
2236 VENDOR_FLG(0x0644, /* TEAC Corp. */
2237 QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY),
2238 VENDOR_FLG(0x07fd, /* MOTU */
2239 QUIRK_FLAG_VALIDATE_RATES),
2240 VENDOR_FLG(0x1235, /* Focusrite Novation */
2241 QUIRK_FLAG_VALIDATE_RATES),
2242 VENDOR_FLG(0x1511, /* AURALiC */
2243 QUIRK_FLAG_DSD_RAW),
2244 VENDOR_FLG(0x152a, /* Thesycon devices */
2245 QUIRK_FLAG_DSD_RAW),
2246 VENDOR_FLG(0x18d1, /* iBasso devices */
2247 QUIRK_FLAG_DSD_RAW),
2248 VENDOR_FLG(0x1de7, /* Phoenix Audio */
2249 QUIRK_FLAG_GET_SAMPLE_RATE),
2250 VENDOR_FLG(0x20b1, /* XMOS based devices */
2251 QUIRK_FLAG_DSD_RAW),
2252 VENDOR_FLG(0x21ed, /* Accuphase Laboratory */
2253 QUIRK_FLAG_DSD_RAW),
2254 VENDOR_FLG(0x22d9, /* Oppo */
2255 QUIRK_FLAG_DSD_RAW),
2256 VENDOR_FLG(0x23ba, /* Playback Design */
2257 QUIRK_FLAG_CTL_MSG_DELAY | QUIRK_FLAG_IFACE_DELAY |
2258 QUIRK_FLAG_DSD_RAW),
2259 VENDOR_FLG(0x25ce, /* Mytek devices */
2260 QUIRK_FLAG_DSD_RAW),
2261 VENDOR_FLG(0x278b, /* Rotel? */
2262 QUIRK_FLAG_DSD_RAW),
2263 VENDOR_FLG(0x292b, /* Gustard/Ess based devices */
2264 QUIRK_FLAG_DSD_RAW),
2265 VENDOR_FLG(0x2972, /* FiiO devices */
2266 QUIRK_FLAG_DSD_RAW),
2267 VENDOR_FLG(0x2ab6, /* T+A devices */
2268 QUIRK_FLAG_DSD_RAW),
2269 VENDOR_FLG(0x2afd, /* McIntosh Laboratory, Inc. */
2270 QUIRK_FLAG_DSD_RAW),
2271 VENDOR_FLG(0x2d87, /* Cayin device */
2272 QUIRK_FLAG_DSD_RAW),
2273 VENDOR_FLG(0x3336, /* HEM devices */
2274 QUIRK_FLAG_DSD_RAW),
2275 VENDOR_FLG(0x3353, /* Khadas devices */
2276 QUIRK_FLAG_DSD_RAW),
2277 VENDOR_FLG(0x35f4, /* MSB Technology */
2278 QUIRK_FLAG_DSD_RAW),
2279 VENDOR_FLG(0x3842, /* EVGA */
2280 QUIRK_FLAG_DSD_RAW),
2281 VENDOR_FLG(0xc502, /* HiBy devices */
2282 QUIRK_FLAG_DSD_RAW),
2283
2284 {} /* terminator */
2285 };
2286
snd_usb_init_quirk_flags(struct snd_usb_audio * chip)2287 void snd_usb_init_quirk_flags(struct snd_usb_audio *chip)
2288 {
2289 const struct usb_audio_quirk_flags_table *p;
2290
2291 for (p = quirk_flags_table; p->id; p++) {
2292 if (chip->usb_id == p->id ||
2293 (!USB_ID_PRODUCT(p->id) &&
2294 USB_ID_VENDOR(chip->usb_id) == USB_ID_VENDOR(p->id))) {
2295 usb_audio_dbg(chip,
2296 "Set quirk_flags 0x%x for device %04x:%04x\n",
2297 p->flags, USB_ID_VENDOR(chip->usb_id),
2298 USB_ID_PRODUCT(chip->usb_id));
2299 chip->quirk_flags |= p->flags;
2300 return;
2301 }
2302 }
2303 }
2304