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