sound/usb/quirks.c

   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 "quirks.h"
  23 #include "helper.h"
  24 #include "endpoint.h"
  25 #include "pcm.h"
  26 #include "clock.h"
  27 #include "stream.h"
  28
  29 /*
  30  * handle the quirks for the contained interfaces
  31  */
  32 static int create_composite_quirk(struct snd_usb_audio *chip,
  33                                   struct usb_interface *iface,
  34                                   struct usb_driver *driver,
  35                                   const struct snd_usb_audio_quirk *quirk_comp)
  36 {
  37         int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
  38         const struct snd_usb_audio_quirk *quirk;
  39         int err;
  40
  41         for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
  42                 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
  43                 if (!iface)
  44                         continue;
  45                 if (quirk->ifnum != probed_ifnum &&
  46                     usb_interface_claimed(iface))
  47                         continue;
  48                 err = snd_usb_create_quirk(chip, iface, driver, quirk);
  49                 if (err < 0)
  50                         return err;
  51         }
  52
  53         for (quirk = quirk_comp->data; quirk->ifnum >= 0; ++quirk) {
  54                 iface = usb_ifnum_to_if(chip->dev, quirk->ifnum);
  55                 if (!iface)
  56                         continue;
  57                 if (quirk->ifnum != probed_ifnum &&
  58                     !usb_interface_claimed(iface))
  59                         usb_driver_claim_interface(driver, iface, (void *)-1L);
  60         }
  61
  62         return 0;
  63 }
  64
  65 static int ignore_interface_quirk(struct snd_usb_audio *chip,
  66                                   struct usb_interface *iface,
  67                                   struct usb_driver *driver,
  68                                   const struct snd_usb_audio_quirk *quirk)
  69 {
  70         return 0;
  71 }
  72
  73
  74 /*
  75  * Allow alignment on audio sub-slot (channel samples) rather than
  76  * on audio slots (audio frames)
  77  */
  78 static int create_align_transfer_quirk(struct snd_usb_audio *chip,
  79                                        struct usb_interface *iface,
  80                                        struct usb_driver *driver,
  81                                        const struct snd_usb_audio_quirk *quirk)
  82 {
  83         chip->txfr_quirk = 1;
  84         return 1;       /* Continue with creating streams and mixer */
  85 }
  86
  87 static int create_any_midi_quirk(struct snd_usb_audio *chip,
  88                                  struct usb_interface *intf,
  89                                  struct usb_driver *driver,
  90                                  const struct snd_usb_audio_quirk *quirk)
  91 {
  92         return snd_usbmidi_create(chip->card, intf, &chip->midi_list, quirk);
  93 }
  94
  95 /*
  96  * create a stream for an interface with proper descriptors
  97  */
  98 static int create_standard_audio_quirk(struct snd_usb_audio *chip,
  99                                        struct usb_interface *iface,
 100                                        struct usb_driver *driver,
 101                                        const struct snd_usb_audio_quirk *quirk)
 102 {
 103         struct usb_host_interface *alts;
 104         struct usb_interface_descriptor *altsd;
 105         int err;
 106
 107         if (chip->usb_id == USB_ID(0x1686, 0x00dd)) /* Zoom R16/24 */
 108                 chip->tx_length_quirk = 1;
 109
 110         alts = &iface->altsetting[0];
 111         altsd = get_iface_desc(alts);
 112         err = snd_usb_parse_audio_interface(chip, altsd->bInterfaceNumber);
 113         if (err < 0) {
 114                 usb_audio_err(chip, "cannot setup if %d: error %d\n",
 115                            altsd->bInterfaceNumber, err);
 116                 return err;
 117         }
 118         /* reset the current interface */
 119         usb_set_interface(chip->dev, altsd->bInterfaceNumber, 0);
 120         return 0;
 121 }
 122
 123 /*
 124  * create a stream for an endpoint/altsetting without proper descriptors
 125  */
 126 static int create_fixed_stream_quirk(struct snd_usb_audio *chip,
 127                                      struct usb_interface *iface,
 128                                      struct usb_driver *driver,
 129                                      const struct snd_usb_audio_quirk *quirk)
 130 {
 131         struct audioformat *fp;
 132         struct usb_host_interface *alts;
 133         struct usb_interface_descriptor *altsd;
 134         int stream, err;
 135         unsigned *rate_table = NULL;
 136
 137         fp = kmemdup(quirk->data, sizeof(*fp), GFP_KERNEL);
 138         if (!fp)
 139                 return -ENOMEM;
 140
 141         INIT_LIST_HEAD(&fp->list);
 142         if (fp->nr_rates > MAX_NR_RATES) {
 143                 kfree(fp);
 144                 return -EINVAL;
 145         }
 146         if (fp->nr_rates > 0) {
 147                 rate_table = kmemdup(fp->rate_table,
 148                                      sizeof(int) * fp->nr_rates, GFP_KERNEL);
 149                 if (!rate_table) {
 150                         kfree(fp);
 151                         return -ENOMEM;
 152                 }
 153                 fp->rate_table = rate_table;
 154         }
 155
 156         stream = (fp->endpoint & USB_DIR_IN)
 157                 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
 158         err = snd_usb_add_audio_stream(chip, stream, fp);
 159         if (err < 0)
 160                 goto error;
 161         if (fp->iface != get_iface_desc(&iface->altsetting[0])->bInterfaceNumber ||
 162             fp->altset_idx >= iface->num_altsetting) {
 163                 err = -EINVAL;
 164                 goto error;
 165         }
 166         alts = &iface->altsetting[fp->altset_idx];
 167         altsd = get_iface_desc(alts);
 168         if (altsd->bNumEndpoints < 1) {
 169                 err = -EINVAL;
 170                 goto error;
 171         }
 172
 173         fp->protocol = altsd->bInterfaceProtocol;
 174
 175         if (fp->datainterval == 0)
 176                 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
 177         if (fp->maxpacksize == 0)
 178                 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
 179         usb_set_interface(chip->dev, fp->iface, 0);
 180         snd_usb_init_pitch(chip, fp->iface, alts, fp);
 181         snd_usb_init_sample_rate(chip, fp->iface, alts, fp, fp->rate_max);
 182         return 0;
 183
 184  error:
 185         list_del(&fp->list); /* unlink for avoiding double-free */
 186         kfree(fp);
 187         kfree(rate_table);
 188         return err;
 189 }
 190
 191 static int create_auto_pcm_quirk(struct snd_usb_audio *chip,
 192                                  struct usb_interface *iface,
 193                                  struct usb_driver *driver)
 194 {
 195         struct usb_host_interface *alts;
 196         struct usb_interface_descriptor *altsd;
 197         struct usb_endpoint_descriptor *epd;
 198         struct uac1_as_header_descriptor *ashd;
 199         struct uac_format_type_i_discrete_descriptor *fmtd;
 200
 201         /*
 202          * Most Roland/Yamaha audio streaming interfaces have more or less
 203          * standard descriptors, but older devices might lack descriptors, and
 204          * future ones might change, so ensure that we fail silently if the
 205          * interface doesn't look exactly right.
 206          */
 207
 208         /* must have a non-zero altsetting for streaming */
 209         if (iface->num_altsetting < 2)
 210                 return -ENODEV;
 211         alts = &iface->altsetting[1];
 212         altsd = get_iface_desc(alts);
 213
 214         /* must have an isochronous endpoint for streaming */
 215         if (altsd->bNumEndpoints < 1)
 216                 return -ENODEV;
 217         epd = get_endpoint(alts, 0);
 218         if (!usb_endpoint_xfer_isoc(epd))
 219                 return -ENODEV;
 220
 221         /* must have format descriptors */
 222         ashd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
 223                                        UAC_AS_GENERAL);
 224         fmtd = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL,
 225                                        UAC_FORMAT_TYPE);
 226         if (!ashd || ashd->bLength < 7 ||
 227             !fmtd || fmtd->bLength < 8)
 228                 return -ENODEV;
 229
 230         return create_standard_audio_quirk(chip, iface, driver, NULL);
 231 }
 232
 233 static int create_yamaha_midi_quirk(struct snd_usb_audio *chip,
 234                                     struct usb_interface *iface,
 235                                     struct usb_driver *driver,
 236                                     struct usb_host_interface *alts)
 237 {
 238         static const struct snd_usb_audio_quirk yamaha_midi_quirk = {
 239                 .type = QUIRK_MIDI_YAMAHA
 240         };
 241         struct usb_midi_in_jack_descriptor *injd;
 242         struct usb_midi_out_jack_descriptor *outjd;
 243
 244         /* must have some valid jack descriptors */
 245         injd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
 246                                        NULL, USB_MS_MIDI_IN_JACK);
 247         outjd = snd_usb_find_csint_desc(alts->extra, alts->extralen,
 248                                         NULL, USB_MS_MIDI_OUT_JACK);
 249         if (!injd && !outjd)
 250                 return -ENODEV;
 251         if ((injd && !snd_usb_validate_midi_desc(injd)) ||
 252             (outjd && !snd_usb_validate_midi_desc(outjd)))
 253                 return -ENODEV;
 254         if (injd && (injd->bLength < 5 ||
 255                      (injd->bJackType != USB_MS_EMBEDDED &&
 256                       injd->bJackType != USB_MS_EXTERNAL)))
 257                 return -ENODEV;
 258         if (outjd && (outjd->bLength < 6 ||
 259                       (outjd->bJackType != USB_MS_EMBEDDED &&
 260                        outjd->bJackType != USB_MS_EXTERNAL)))
 261                 return -ENODEV;
 262         return create_any_midi_quirk(chip, iface, driver, &yamaha_midi_quirk);
 263 }
 264
 265 static int create_roland_midi_quirk(struct snd_usb_audio *chip,
 266                                     struct usb_interface *iface,
 267                                     struct usb_driver *driver,
 268                                     struct usb_host_interface *alts)
 269 {
 270         static const struct snd_usb_audio_quirk roland_midi_quirk = {
 271                 .type = QUIRK_MIDI_ROLAND
 272         };
 273         u8 *roland_desc = NULL;
 274
 275         /* might have a vendor-specific descriptor <06 24 F1 02 ...> */
 276         for (;;) {
 277                 roland_desc = snd_usb_find_csint_desc(alts->extra,
 278                                                       alts->extralen,
 279                                                       roland_desc, 0xf1);
 280                 if (!roland_desc)
 281                         return -ENODEV;
 282                 if (roland_desc[0] < 6 || roland_desc[3] != 2)
 283                         continue;
 284                 return create_any_midi_quirk(chip, iface, driver,
 285                                              &roland_midi_quirk);
 286         }
 287 }
 288
 289 static int create_std_midi_quirk(struct snd_usb_audio *chip,
 290                                  struct usb_interface *iface,
 291                                  struct usb_driver *driver,
 292                                  struct usb_host_interface *alts)
 293 {
 294         struct usb_ms_header_descriptor *mshd;
 295         struct usb_ms_endpoint_descriptor *msepd;
 296
 297         /* must have the MIDIStreaming interface header descriptor*/
 298         mshd = (struct usb_ms_header_descriptor *)alts->extra;
 299         if (alts->extralen < 7 ||
 300             mshd->bLength < 7 ||
 301             mshd->bDescriptorType != USB_DT_CS_INTERFACE ||
 302             mshd->bDescriptorSubtype != USB_MS_HEADER)
 303                 return -ENODEV;
 304         /* must have the MIDIStreaming endpoint descriptor*/
 305         msepd = (struct usb_ms_endpoint_descriptor *)alts->endpoint[0].extra;
 306         if (alts->endpoint[0].extralen < 4 ||
 307             msepd->bLength < 4 ||
 308             msepd->bDescriptorType != USB_DT_CS_ENDPOINT ||
 309             msepd->bDescriptorSubtype != UAC_MS_GENERAL ||
 310             msepd->bNumEmbMIDIJack < 1 ||
 311             msepd->bNumEmbMIDIJack > 16)
 312                 return -ENODEV;
 313
 314         return create_any_midi_quirk(chip, iface, driver, NULL);
 315 }
 316
 317 static int create_auto_midi_quirk(struct snd_usb_audio *chip,
 318                                   struct usb_interface *iface,
 319                                   struct usb_driver *driver)
 320 {
 321         struct usb_host_interface *alts;
 322         struct usb_interface_descriptor *altsd;
 323         struct usb_endpoint_descriptor *epd;
 324         int err;
 325
 326         alts = &iface->altsetting[0];
 327         altsd = get_iface_desc(alts);
 328
 329         /* must have at least one bulk/interrupt endpoint for streaming */
 330         if (altsd->bNumEndpoints < 1)
 331                 return -ENODEV;
 332         epd = get_endpoint(alts, 0);
 333         if (!usb_endpoint_xfer_bulk(epd) &&
 334             !usb_endpoint_xfer_int(epd))
 335                 return -ENODEV;
 336
 337         switch (USB_ID_VENDOR(chip->usb_id)) {
 338         case 0x0499: /* Yamaha */
 339                 err = create_yamaha_midi_quirk(chip, iface, driver, alts);
 340                 if (err != -ENODEV)
 341                         return err;
 342                 break;
 343         case 0x0582: /* Roland */
 344                 err = create_roland_midi_quirk(chip, iface, driver, alts);
 345                 if (err != -ENODEV)
 346                         return err;
 347                 break;
 348         }
 349
 350         return create_std_midi_quirk(chip, iface, driver, alts);
 351 }
 352
 353 static int create_autodetect_quirk(struct snd_usb_audio *chip,
 354                                    struct usb_interface *iface,
 355                                    struct usb_driver *driver)
 356 {
 357         int err;
 358
 359         err = create_auto_pcm_quirk(chip, iface, driver);
 360         if (err == -ENODEV)
 361                 err = create_auto_midi_quirk(chip, iface, driver);
 362         return err;
 363 }
 364
 365 static int create_autodetect_quirks(struct snd_usb_audio *chip,
 366                                     struct usb_interface *iface,
 367                                     struct usb_driver *driver,
 368                                     const struct snd_usb_audio_quirk *quirk)
 369 {
 370         int probed_ifnum = get_iface_desc(iface->altsetting)->bInterfaceNumber;
 371         int ifcount, ifnum, err;
 372
 373         err = create_autodetect_quirk(chip, iface, driver);
 374         if (err < 0)
 375                 return err;
 376
 377         /*
 378          * ALSA PCM playback/capture devices cannot be registered in two steps,
 379          * so we have to claim the other corresponding interface here.
 380          */
 381         ifcount = chip->dev->actconfig->desc.bNumInterfaces;
 382         for (ifnum = 0; ifnum < ifcount; ifnum++) {
 383                 if (ifnum == probed_ifnum || quirk->ifnum >= 0)
 384                         continue;
 385                 iface = usb_ifnum_to_if(chip->dev, ifnum);
 386                 if (!iface ||
 387                     usb_interface_claimed(iface) ||
 388                     get_iface_desc(iface->altsetting)->bInterfaceClass !=
 389                                                         USB_CLASS_VENDOR_SPEC)
 390                         continue;
 391
 392                 err = create_autodetect_quirk(chip, iface, driver);
 393                 if (err >= 0)
 394                         usb_driver_claim_interface(driver, iface, (void *)-1L);
 395         }
 396
 397         return 0;
 398 }
 399
 400 /*
 401  * Create a stream for an Edirol UA-700/UA-25/UA-4FX interface.
 402  * The only way to detect the sample rate is by looking at wMaxPacketSize.
 403  */
 404 static int create_uaxx_quirk(struct snd_usb_audio *chip,
 405                              struct usb_interface *iface,
 406                              struct usb_driver *driver,
 407                              const struct snd_usb_audio_quirk *quirk)
 408 {
 409         static const struct audioformat ua_format = {
 410                 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
 411                 .channels = 2,
 412                 .fmt_type = UAC_FORMAT_TYPE_I,
 413                 .altsetting = 1,
 414                 .altset_idx = 1,
 415                 .rates = SNDRV_PCM_RATE_CONTINUOUS,
 416         };
 417         struct usb_host_interface *alts;
 418         struct usb_interface_descriptor *altsd;
 419         struct audioformat *fp;
 420         int stream, err;
 421
 422         /* both PCM and MIDI interfaces have 2 or more altsettings */
 423         if (iface->num_altsetting < 2)
 424                 return -ENXIO;
 425         alts = &iface->altsetting[1];
 426         altsd = get_iface_desc(alts);
 427
 428         if (altsd->bNumEndpoints == 2) {
 429                 static const struct snd_usb_midi_endpoint_info ua700_ep = {
 430                         .out_cables = 0x0003,
 431                         .in_cables  = 0x0003
 432                 };
 433                 static const struct snd_usb_audio_quirk ua700_quirk = {
 434                         .type = QUIRK_MIDI_FIXED_ENDPOINT,
 435                         .data = &ua700_ep
 436                 };
 437                 static const struct snd_usb_midi_endpoint_info uaxx_ep = {
 438                         .out_cables = 0x0001,
 439                         .in_cables  = 0x0001
 440                 };
 441                 static const struct snd_usb_audio_quirk uaxx_quirk = {
 442                         .type = QUIRK_MIDI_FIXED_ENDPOINT,
 443                         .data = &uaxx_ep
 444                 };
 445                 const struct snd_usb_audio_quirk *quirk =
 446                         chip->usb_id == USB_ID(0x0582, 0x002b)
 447                         ? &ua700_quirk : &uaxx_quirk;
 448                 return __snd_usbmidi_create(chip->card, iface,
 449                                           &chip->midi_list, quirk,
 450                                           chip->usb_id);
 451         }
 452
 453         if (altsd->bNumEndpoints != 1)
 454                 return -ENXIO;
 455
 456         fp = kmemdup(&ua_format, sizeof(*fp), GFP_KERNEL);
 457         if (!fp)
 458                 return -ENOMEM;
 459
 460         fp->iface = altsd->bInterfaceNumber;
 461         fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
 462         fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
 463         fp->datainterval = 0;
 464         fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
 465         INIT_LIST_HEAD(&fp->list);
 466
 467         switch (fp->maxpacksize) {
 468         case 0x120:
 469                 fp->rate_max = fp->rate_min = 44100;
 470                 break;
 471         case 0x138:
 472         case 0x140:
 473                 fp->rate_max = fp->rate_min = 48000;
 474                 break;
 475         case 0x258:
 476         case 0x260:
 477                 fp->rate_max = fp->rate_min = 96000;
 478                 break;
 479         default:
 480                 usb_audio_err(chip, "unknown sample rate\n");
 481                 kfree(fp);
 482                 return -ENXIO;
 483         }
 484
 485         stream = (fp->endpoint & USB_DIR_IN)
 486                 ? SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
 487         err = snd_usb_add_audio_stream(chip, stream, fp);
 488         if (err < 0) {
 489                 list_del(&fp->list); /* unlink for avoiding double-free */
 490                 kfree(fp);
 491                 return err;
 492         }
 493         usb_set_interface(chip->dev, fp->iface, 0);
 494         return 0;
 495 }
 496
 497 /*
 498  * Create a standard mixer for the specified interface.
 499  */
 500 static int create_standard_mixer_quirk(struct snd_usb_audio *chip,
 501                                        struct usb_interface *iface,
 502                                        struct usb_driver *driver,
 503                                        const struct snd_usb_audio_quirk *quirk)
 504 {
 505         if (quirk->ifnum < 0)
 506                 return 0;
 507
 508         return snd_usb_create_mixer(chip, quirk->ifnum, 0);
 509 }
 510
 511
 512 static int setup_fmt_after_resume_quirk(struct snd_usb_audio *chip,
 513                                        struct usb_interface *iface,
 514                                        struct usb_driver *driver,
 515                                        const struct snd_usb_audio_quirk *quirk)
 516 {
 517         chip->setup_fmt_after_resume_quirk = 1;
 518         return 1;       /* Continue with creating streams and mixer */
 519 }
 520
 521 static int setup_disable_autosuspend(struct snd_usb_audio *chip,
 522                                        struct usb_interface *iface,
 523                                        struct usb_driver *driver,
 524                                        const struct snd_usb_audio_quirk *quirk)
 525 {
 526         driver->supports_autosuspend = 0;
 527         return 1;       /* Continue with creating streams and mixer */
 528 }
 529
 530 /*
 531  * audio-interface quirks
 532  *
 533  * returns zero if no standard audio/MIDI parsing is needed.
 534  * returns a positive value if standard audio/midi interfaces are parsed
 535  * after this.
 536  * returns a negative value at error.
 537  */
 538 int snd_usb_create_quirk(struct snd_usb_audio *chip,
 539                          struct usb_interface *iface,
 540                          struct usb_driver *driver,
 541                          const struct snd_usb_audio_quirk *quirk)
 542 {
 543         typedef int (*quirk_func_t)(struct snd_usb_audio *,
 544                                     struct usb_interface *,
 545                                     struct usb_driver *,
 546                                     const struct snd_usb_audio_quirk *);
 547         static const quirk_func_t quirk_funcs[] = {
 548                 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
 549                 [QUIRK_COMPOSITE] = create_composite_quirk,
 550                 [QUIRK_AUTODETECT] = create_autodetect_quirks,
 551                 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
 552                 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
 553                 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
 554                 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
 555                 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
 556                 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
 557                 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
 558                 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
 559                 [QUIRK_MIDI_CME] = create_any_midi_quirk,
 560                 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
 561                 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
 562                 [QUIRK_MIDI_CH345] = create_any_midi_quirk,
 563                 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
 564                 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
 565                 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
 566                 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
 567                 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
 568                 [QUIRK_SETUP_FMT_AFTER_RESUME] = setup_fmt_after_resume_quirk,
 569                 [QUIRK_SETUP_DISABLE_AUTOSUSPEND] = setup_disable_autosuspend,
 570         };
 571
 572         if (quirk->type < QUIRK_TYPE_COUNT) {
 573                 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
 574         } else {
 575                 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
 576                 return -ENXIO;
 577         }
 578 }
 579
 580 /*
 581  * boot quirks
 582  */
 583
 584 #define EXTIGY_FIRMWARE_SIZE_OLD 794
 585 #define EXTIGY_FIRMWARE_SIZE_NEW 483
 586
 587 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
 588 {
 589         struct usb_host_config *config = dev->actconfig;
 590         int err;
 591
 592         if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
 593             le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
 594                 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
 595                 /* Send message to force it to reconnect with full interface. */
 596                 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
 597                                       0x10, 0x43, 0x0001, 0x000a, NULL, 0);
 598                 if (err < 0)
 599                         dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
 600                 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
 601                                 &dev->descriptor, sizeof(dev->descriptor));
 602                 config = dev->actconfig;
 603                 if (err < 0)
 604                         dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
 605                 err = usb_reset_configuration(dev);
 606                 if (err < 0)
 607                         dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
 608                 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
 609                             le16_to_cpu(get_cfg_desc(config)->wTotalLength));
 610                 return -ENODEV; /* quit this anyway */
 611         }
 612         return 0;
 613 }
 614
 615 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
 616 {
 617         u8 buf = 1;
 618
 619         snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
 620                         USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
 621                         0, 0, &buf, 1);
 622         if (buf == 0) {
 623                 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
 624                                 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
 625                                 1, 2000, NULL, 0);
 626                 return -ENODEV;
 627         }
 628         return 0;
 629 }
 630
 631 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
 632 {
 633         int err;
 634
 635         if (dev->actconfig->desc.bConfigurationValue == 1) {
 636                 dev_info(&dev->dev,
 637                            "Fast Track Pro switching to config #2\n");
 638                 /* This function has to be available by the usb core module.
 639                  * if it is not avialable the boot quirk has to be left out
 640                  * and the configuration has to be set by udev or hotplug
 641                  * rules
 642                  */
 643                 err = usb_driver_set_configuration(dev, 2);
 644                 if (err < 0)
 645                         dev_dbg(&dev->dev,
 646                                 "error usb_driver_set_configuration: %d\n",
 647                                 err);
 648                 /* Always return an error, so that we stop creating a device
 649                    that will just be destroyed and recreated with a new
 650                    configuration */
 651                 return -ENODEV;
 652         } else
 653                 dev_info(&dev->dev, "Fast Track Pro config OK\n");
 654
 655         return 0;
 656 }
 657
 658 /*
 659  * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
 660  * documented in the device's data sheet.
 661  */
 662 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
 663 {
 664         u8 buf[4];
 665         buf[0] = 0x20;
 666         buf[1] = value & 0xff;
 667         buf[2] = (value >> 8) & 0xff;
 668         buf[3] = reg;
 669         return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
 670                                USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
 671                                0, 0, &buf, 4);
 672 }
 673
 674 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
 675 {
 676         /*
 677          * Enable line-out driver mode, set headphone source to front
 678          * channels, enable stereo mic.
 679          */
 680         return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
 681 }
 682
 683 /*
 684  * CM6206 registers from the CM6206 datasheet rev 2.1
 685  */
 686 #define CM6206_REG0_DMA_MASTER BIT(15)
 687 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
 688 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
 689 /* Bit 4 thru 11 is the S/PDIF category code */
 690 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
 691 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
 692 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
 693 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
 694 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
 695
 696 #define CM6206_REG1_TEST_SEL_CLK BIT(14)
 697 #define CM6206_REG1_PLLBIN_EN BIT(13)
 698 #define CM6206_REG1_SOFT_MUTE_EN BIT(12)
 699 #define CM6206_REG1_GPIO4_OUT BIT(11)
 700 #define CM6206_REG1_GPIO4_OE BIT(10)
 701 #define CM6206_REG1_GPIO3_OUT BIT(9)
 702 #define CM6206_REG1_GPIO3_OE BIT(8)
 703 #define CM6206_REG1_GPIO2_OUT BIT(7)
 704 #define CM6206_REG1_GPIO2_OE BIT(6)
 705 #define CM6206_REG1_GPIO1_OUT BIT(5)
 706 #define CM6206_REG1_GPIO1_OE BIT(4)
 707 #define CM6206_REG1_SPDIFO_INVALID BIT(3)
 708 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
 709 #define CM6206_REG1_SPDIFO_DIS BIT(1)
 710 #define CM6206_REG1_SPDIFI_MIX BIT(0)
 711
 712 #define CM6206_REG2_DRIVER_ON BIT(15)
 713 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
 714 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
 715 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
 716 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
 717 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
 718 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
 719 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
 720 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
 721 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
 722 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
 723 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
 724 #define CM6206_REG2_MUTE_CENTER BIT(5)
 725 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
 726 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
 727 #define CM6206_REG2_EN_BTL BIT(2)
 728 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
 729 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
 730 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
 731 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
 732
 733 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
 734 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
 735 #define CM6206_REG3_VRAP25EN BIT(10)
 736 #define CM6206_REG3_MSEL1 BIT(9)
 737 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
 738 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
 739 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
 740 #define CM6206_REG3_PINSEL BIT(6)
 741 #define CM6206_REG3_FOE BIT(5)
 742 #define CM6206_REG3_ROE BIT(4)
 743 #define CM6206_REG3_CBOE BIT(3)
 744 #define CM6206_REG3_LOSE BIT(2)
 745 #define CM6206_REG3_HPOE BIT(1)
 746 #define CM6206_REG3_SPDIFI_CANREC BIT(0)
 747
 748 #define CM6206_REG5_DA_RSTN BIT(13)
 749 #define CM6206_REG5_AD_RSTN BIT(12)
 750 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
 751 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
 752 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
 753 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
 754 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
 755 #define CM6206_REG5_CODECM BIT(8)
 756 #define CM6206_REG5_EN_HPF BIT(7)
 757 #define CM6206_REG5_T_SEL_DSDA4 BIT(6)
 758 #define CM6206_REG5_T_SEL_DSDA3 BIT(5)
 759 #define CM6206_REG5_T_SEL_DSDA2 BIT(4)
 760 #define CM6206_REG5_T_SEL_DSDA1 BIT(3)
 761 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
 762 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4
 763 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
 764 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
 765 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
 766
 767 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
 768 {
 769         int err  = 0, reg;
 770         int val[] = {
 771                 /*
 772                  * Values here are chosen based on sniffing USB traffic
 773                  * under Windows.
 774                  *
 775                  * REG0: DAC is master, sample rate 48kHz, no copyright
 776                  */
 777                 CM6206_REG0_SPDIFO_RATE_48K |
 778                 CM6206_REG0_SPDIFO_COPYRIGHT_NA,
 779                 /*
 780                  * REG1: PLL binary search enable, soft mute enable.
 781                  */
 782                 CM6206_REG1_PLLBIN_EN |
 783                 CM6206_REG1_SOFT_MUTE_EN,
 784                 /*
 785                  * REG2: enable output drivers,
 786                  * select front channels to the headphone output,
 787                  * then mute the headphone channels, run the MCU
 788                  * at 1.5 MHz.
 789                  */
 790                 CM6206_REG2_DRIVER_ON |
 791                 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
 792                 CM6206_REG2_MUTE_HEADPHONE_RIGHT |
 793                 CM6206_REG2_MUTE_HEADPHONE_LEFT,
 794                 /*
 795                  * REG3: default flyspeed, set 2.5V mic bias
 796                  * enable all line out ports and enable SPDIF
 797                  */
 798                 CM6206_REG3_FLYSPEED_DEFAULT |
 799                 CM6206_REG3_VRAP25EN |
 800                 CM6206_REG3_FOE |
 801                 CM6206_REG3_ROE |
 802                 CM6206_REG3_CBOE |
 803                 CM6206_REG3_LOSE |
 804                 CM6206_REG3_HPOE |
 805                 CM6206_REG3_SPDIFI_CANREC,
 806                 /* REG4 is just a bunch of GPIO lines */
 807                 0x0000,
 808                 /* REG5: de-assert AD/DA reset signals */
 809                 CM6206_REG5_DA_RSTN |
 810                 CM6206_REG5_AD_RSTN };
 811
 812         for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
 813                 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
 814                 if (err < 0)
 815                         return err;
 816         }
 817
 818         return err;
 819 }
 820
 821 /* quirk for Plantronics GameCom 780 with CM6302 chip */
 822 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
 823 {
 824         /* set the initial volume and don't change; other values are either
 825          * too loud or silent due to firmware bug (bko#65251)
 826          */
 827         u8 buf[2] = { 0x74, 0xe3 };
 828         return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
 829                         USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
 830                         UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
 831 }
 832
 833 /*
 834  * Novation Twitch DJ controller
 835  * Focusrite Novation Saffire 6 USB audio card
 836  */
 837 static int snd_usb_novation_boot_quirk(struct usb_device *dev)
 838 {
 839         /* preemptively set up the device because otherwise the
 840          * raw MIDI endpoints are not active */
 841         usb_set_interface(dev, 0, 1);
 842         return 0;
 843 }
 844
 845 /*
 846  * This call will put the synth in "USB send" mode, i.e it will send MIDI
 847  * messages through USB (this is disabled at startup). The synth will
 848  * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
 849  * sign on its LCD. Values here are chosen based on sniffing USB traffic
 850  * under Windows.
 851  */
 852 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
 853 {
 854         int err, actual_length;
 855         /* "midi send" enable */
 856         static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
 857         void *buf;
 858
 859         if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x05)))
 860                 return -EINVAL;
 861         buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
 862         if (!buf)
 863                 return -ENOMEM;
 864         err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
 865                         ARRAY_SIZE(seq), &actual_length, 1000);
 866         kfree(buf);
 867         if (err < 0)
 868                 return err;
 869
 870         return 0;
 871 }
 872
 873 /*
 874  * Some sound cards from Native Instruments are in fact compliant to the USB
 875  * audio standard of version 2 and other approved USB standards, even though
 876  * they come up as vendor-specific device when first connected.
 877  *
 878  * However, they can be told to come up with a new set of descriptors
 879  * upon their next enumeration, and the interfaces announced by the new
 880  * descriptors will then be handled by the kernel's class drivers. As the
 881  * product ID will also change, no further checks are required.
 882  */
 883
 884 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
 885 {
 886         int ret;
 887
 888         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 889                                   0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 890                                   1, 0, NULL, 0, 1000);
 891
 892         if (ret < 0)
 893                 return ret;
 894
 895         usb_reset_device(dev);
 896
 897         /* return -EAGAIN, so the creation of an audio interface for this
 898          * temporary device is aborted. The device will reconnect with a
 899          * new product ID */
 900         return -EAGAIN;
 901 }
 902
 903 static void mbox2_setup_48_24_magic(struct usb_device *dev)
 904 {
 905         u8 srate[3];
 906         u8 temp[12];
 907
 908         /* Choose 48000Hz permanently */
 909         srate[0] = 0x80;
 910         srate[1] = 0xbb;
 911         srate[2] = 0x00;
 912
 913         /* Send the magic! */
 914         snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
 915                 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
 916         snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 917                 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
 918         snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 919                 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
 920         snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 921                 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
 922         return;
 923 }
 924
 925 /* Digidesign Mbox 2 needs to load firmware onboard
 926  * and driver must wait a few seconds for initialisation.
 927  */
 928
 929 #define MBOX2_FIRMWARE_SIZE    646
 930 #define MBOX2_BOOT_LOADING     0x01 /* Hard coded into the device */
 931 #define MBOX2_BOOT_READY       0x02 /* Hard coded into the device */
 932
 933 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
 934 {
 935         struct usb_host_config *config = dev->actconfig;
 936         int err;
 937         u8 bootresponse[0x12];
 938         int fwsize;
 939         int count;
 940
 941         fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
 942
 943         if (fwsize != MBOX2_FIRMWARE_SIZE) {
 944                 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
 945                 return -ENODEV;
 946         }
 947
 948         dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
 949
 950         count = 0;
 951         bootresponse[0] = MBOX2_BOOT_LOADING;
 952         while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
 953                 msleep(500); /* 0.5 second delay */
 954                 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
 955                         /* Control magic - load onboard firmware */
 956                         0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
 957                 if (bootresponse[0] == MBOX2_BOOT_READY)
 958                         break;
 959                 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
 960                 count++;
 961         }
 962
 963         if (bootresponse[0] != MBOX2_BOOT_READY) {
 964                 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
 965                 return -ENODEV;
 966         }
 967
 968         dev_dbg(&dev->dev, "device initialised!\n");
 969
 970         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
 971                 &dev->descriptor, sizeof(dev->descriptor));
 972         config = dev->actconfig;
 973         if (err < 0)
 974                 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
 975
 976         err = usb_reset_configuration(dev);
 977         if (err < 0)
 978                 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
 979         dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
 980                 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
 981
 982         mbox2_setup_48_24_magic(dev);
 983
 984         dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
 985
 986         return 0; /* Successful boot */
 987 }
 988
 989 static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
 990 {
 991         int err;
 992
 993         dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
 994
 995         /* If the Axe-Fx III has not fully booted, it will timeout when trying
 996          * to enable the audio streaming interface. A more generous timeout is
 997          * used here to detect when the Axe-Fx III has finished booting as the
 998          * set interface message will be acked once it has
 999          */
1000         err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1001                                 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
1002                                 1, 1, NULL, 0, 120000);
1003         if (err < 0) {
1004                 dev_err(&dev->dev,
1005                         "failed waiting for Axe-Fx III to boot: %d\n", err);
1006                 return err;
1007         }
1008
1009         dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
1010
1011         err = usb_set_interface(dev, 1, 0);
1012         if (err < 0)
1013                 dev_dbg(&dev->dev,
1014                         "error stopping Axe-Fx III interface: %d\n", err);
1015
1016         return 0;
1017 }
1018
1019
1020 #define MICROBOOK_BUF_SIZE 128
1021
1022 static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1023                                                 int buf_size, int *length)
1024 {
1025         int err, actual_length;
1026
1027         if (usb_pipe_type_check(dev, usb_sndintpipe(dev, 0x01)))
1028                 return -EINVAL;
1029         err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1030                                 &actual_length, 1000);
1031         if (err < 0)
1032                 return err;
1033
1034         print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1035                        buf, actual_length, false);
1036
1037         memset(buf, 0, buf_size);
1038
1039         if (usb_pipe_type_check(dev, usb_rcvintpipe(dev, 0x82)))
1040                 return -EINVAL;
1041         err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1042                                 &actual_length, 1000);
1043         if (err < 0)
1044                 return err;
1045
1046         print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1047                        buf, actual_length, false);
1048
1049         *length = actual_length;
1050         return 0;
1051 }
1052
1053 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1054 {
1055         int err, actual_length, poll_attempts = 0;
1056         static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1057                                                  0x00, 0x00, 0x0b, 0x14,
1058                                                  0x00, 0x00, 0x00, 0x01 };
1059         static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1060                                              0x00, 0x00, 0x0b, 0x18 };
1061         u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1062
1063         if (!buf)
1064                 return -ENOMEM;
1065
1066         dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1067
1068         /* First we tell the device which sample rate to use. */
1069         memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1070         actual_length = sizeof(set_samplerate_seq);
1071         err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1072                                                    &actual_length);
1073
1074         if (err < 0) {
1075                 dev_err(&dev->dev,
1076                         "failed setting the sample rate for Motu MicroBook II: %d\n",
1077                         err);
1078                 goto free_buf;
1079         }
1080
1081         /* Then we poll every 100 ms until the device informs of its readiness. */
1082         while (true) {
1083                 if (++poll_attempts > 100) {
1084                         dev_err(&dev->dev,
1085                                 "failed booting Motu MicroBook II: timeout\n");
1086                         err = -ENODEV;
1087                         goto free_buf;
1088                 }
1089
1090                 memset(buf, 0, MICROBOOK_BUF_SIZE);
1091                 memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1092
1093                 actual_length = sizeof(poll_ready_seq);
1094                 err = snd_usb_motu_microbookii_communicate(
1095                         dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1096                 if (err < 0) {
1097                         dev_err(&dev->dev,
1098                                 "failed booting Motu MicroBook II: communication error %d\n",
1099                                 err);
1100                         goto free_buf;
1101                 }
1102
1103                 /* the device signals its readiness through a message of the
1104                  * form
1105                  *           XX 06 00 00 00 00 0b 18  00 00 00 01
1106                  * If the device is not yet ready to accept audio data, the
1107                  * last byte of that sequence is 00.
1108                  */
1109                 if (actual_length == 12 && buf[actual_length - 1] == 1)
1110                         break;
1111
1112                 msleep(100);
1113         }
1114
1115         dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1116
1117 free_buf:
1118         kfree(buf);
1119         return err;
1120 }
1121
1122 static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1123 {
1124         int ret;
1125
1126         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1127                               1, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
1128                               0x0, 0, NULL, 0, 1000);
1129
1130         if (ret < 0)
1131                 return ret;
1132
1133         msleep(2000);
1134
1135         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1136                               1, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
1137                               0x20, 0, NULL, 0, 1000);
1138
1139         if (ret < 0)
1140                 return ret;
1141
1142         return 0;
1143 }
1144
1145 /*
1146  * Setup quirks
1147  */
1148 #define MAUDIO_SET              0x01 /* parse device_setup */
1149 #define MAUDIO_SET_COMPATIBLE   0x80 /* use only "win-compatible" interfaces */
1150 #define MAUDIO_SET_DTS          0x02 /* enable DTS Digital Output */
1151 #define MAUDIO_SET_96K          0x04 /* 48-96kHz rate if set, 8-48kHz otherwise */
1152 #define MAUDIO_SET_24B          0x08 /* 24bits sample if set, 16bits otherwise */
1153 #define MAUDIO_SET_DI           0x10 /* enable Digital Input */
1154 #define MAUDIO_SET_MASK         0x1f /* bit mask for setup value */
1155 #define MAUDIO_SET_24B_48K_DI    0x19 /* 24bits+48kHz+Digital Input */
1156 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48kHz+No Digital Input */
1157 #define MAUDIO_SET_16B_48K_DI    0x11 /* 16bits+48kHz+Digital Input */
1158 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48kHz+No Digital Input */
1159
1160 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1161                                       int iface, int altno)
1162 {
1163         /* Reset ALL ifaces to 0 altsetting.
1164          * Call it for every possible altsetting of every interface.
1165          */
1166         usb_set_interface(chip->dev, iface, 0);
1167         if (chip->setup & MAUDIO_SET) {
1168                 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1169                         if (iface != 1 && iface != 2)
1170                                 return 1; /* skip all interfaces but 1 and 2 */
1171                 } else {
1172                         unsigned int mask;
1173                         if (iface == 1 || iface == 2)
1174                                 return 1; /* skip interfaces 1 and 2 */
1175                         if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1176                                 return 1; /* skip this altsetting */
1177                         mask = chip->setup & MAUDIO_SET_MASK;
1178                         if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1179                                 return 1; /* skip this altsetting */
1180                         if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1181                                 return 1; /* skip this altsetting */
1182                         if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1183                                 return 1; /* skip this altsetting */
1184                 }
1185         }
1186         usb_audio_dbg(chip,
1187                     "using altsetting %d for interface %d config %d\n",
1188                     altno, iface, chip->setup);
1189         return 0; /* keep this altsetting */
1190 }
1191
1192 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1193                                          int iface,
1194                                          int altno)
1195 {
1196         /* Reset ALL ifaces to 0 altsetting.
1197          * Call it for every possible altsetting of every interface.
1198          */
1199         usb_set_interface(chip->dev, iface, 0);
1200
1201         if (chip->setup & MAUDIO_SET) {
1202                 unsigned int mask;
1203                 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1204                         return 1; /* skip this altsetting */
1205                 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1206                         return 1; /* skip this altsetting */
1207                 mask = chip->setup & MAUDIO_SET_MASK;
1208                 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1209                         return 1; /* skip this altsetting */
1210                 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1211                         return 1; /* skip this altsetting */
1212                 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1213                         return 1; /* skip this altsetting */
1214                 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1215                         return 1; /* skip this altsetting */
1216         }
1217
1218         return 0; /* keep this altsetting */
1219 }
1220
1221 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1222                                            int iface, int altno)
1223 {
1224         /* Reset ALL ifaces to 0 altsetting.
1225          * Call it for every possible altsetting of every interface.
1226          */
1227         usb_set_interface(chip->dev, iface, 0);
1228
1229         /* possible configuration where both inputs and only one output is
1230          *used is not supported by the current setup
1231          */
1232         if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1233                 if (chip->setup & MAUDIO_SET_96K) {
1234                         if (altno != 3 && altno != 6)
1235                                 return 1;
1236                 } else if (chip->setup & MAUDIO_SET_DI) {
1237                         if (iface == 4)
1238                                 return 1; /* no analog input */
1239                         if (altno != 2 && altno != 5)
1240                                 return 1; /* enable only altsets 2 and 5 */
1241                 } else {
1242                         if (iface == 5)
1243                                 return 1; /* disable digialt input */
1244                         if (altno != 2 && altno != 5)
1245                                 return 1; /* enalbe only altsets 2 and 5 */
1246                 }
1247         } else {
1248                 /* keep only 16-Bit mode */
1249                 if (altno != 1)
1250                         return 1;
1251         }
1252
1253         usb_audio_dbg(chip,
1254                     "using altsetting %d for interface %d config %d\n",
1255                     altno, iface, chip->setup);
1256         return 0; /* keep this altsetting */
1257 }
1258
1259 static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1260                                            int iface, int altno)
1261 {
1262         /*
1263          * Altno settings:
1264          *
1265          * Playback (Interface 1):
1266          * 1: 6 Analog + 2 S/PDIF
1267          * 2: 6 Analog + 2 S/PDIF
1268          * 3: 6 Analog
1269          *
1270          * Capture (Interface 2):
1271          * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1272          * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1273          * 3: 8 Analog
1274          */
1275
1276         /*
1277          * I'll leave 2 as the default one and
1278          * use device_setup to switch to the
1279          * other two.
1280          */
1281         if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1282                 return 1;
1283         else if (chip->setup == 1 && altno != 1)
1284                 return 1;
1285         else if (chip->setup == 2 && altno != 3)
1286                 return 1;
1287
1288         return 0;
1289 }
1290
1291 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1292                                   int iface,
1293                                   int altno)
1294 {
1295         /* audiophile usb: skip altsets incompatible with device_setup */
1296         if (chip->usb_id == USB_ID(0x0763, 0x2003))
1297                 return audiophile_skip_setting_quirk(chip, iface, altno);
1298         /* quattro usb: skip altsets incompatible with device_setup */
1299         if (chip->usb_id == USB_ID(0x0763, 0x2001))
1300                 return quattro_skip_setting_quirk(chip, iface, altno);
1301         /* fasttrackpro usb: skip altsets incompatible with device_setup */
1302         if (chip->usb_id == USB_ID(0x0763, 0x2012))
1303                 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
1304         /* presonus studio 1810c: skip altsets incompatible with device_setup */
1305         if (chip->usb_id == USB_ID(0x0194f, 0x010c))
1306                 return s1810c_skip_setting_quirk(chip, iface, altno);
1307
1308
1309         return 0;
1310 }
1311
1312 int snd_usb_apply_boot_quirk(struct usb_device *dev,
1313                              struct usb_interface *intf,
1314                              const struct snd_usb_audio_quirk *quirk,
1315                              unsigned int id)
1316 {
1317         switch (id) {
1318         case USB_ID(0x041e, 0x3000):
1319                 /* SB Extigy needs special boot-up sequence */
1320                 /* if more models come, this will go to the quirk list. */
1321                 return snd_usb_extigy_boot_quirk(dev, intf);
1322
1323         case USB_ID(0x041e, 0x3020):
1324                 /* SB Audigy 2 NX needs its own boot-up magic, too */
1325                 return snd_usb_audigy2nx_boot_quirk(dev);
1326
1327         case USB_ID(0x10f5, 0x0200):
1328                 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1329                 return snd_usb_cm106_boot_quirk(dev);
1330
1331         case USB_ID(0x0d8c, 0x0102):
1332                 /* C-Media CM6206 / CM106-Like Sound Device */
1333         case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1334                 return snd_usb_cm6206_boot_quirk(dev);
1335
1336         case USB_ID(0x0dba, 0x3000):
1337                 /* Digidesign Mbox 2 */
1338                 return snd_usb_mbox2_boot_quirk(dev);
1339
1340         case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1341         case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1342                 return snd_usb_novation_boot_quirk(dev);
1343
1344         case USB_ID(0x133e, 0x0815):
1345                 /* Access Music VirusTI Desktop */
1346                 return snd_usb_accessmusic_boot_quirk(dev);
1347
1348         case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1349         case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1350         case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1351                 return snd_usb_nativeinstruments_boot_quirk(dev);
1352         case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1353                 return snd_usb_fasttrackpro_boot_quirk(dev);
1354         case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1355                 return snd_usb_gamecon780_boot_quirk(dev);
1356         case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1357                 return snd_usb_axefx3_boot_quirk(dev);
1358         case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1359                 /*
1360                  * For some reason interface 3 with vendor-spec class is
1361                  * detected on MicroBook IIc.
1362                  */
1363                 if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1364                     USB_CLASS_VENDOR_SPEC &&
1365                     get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1366                         return snd_usb_motu_microbookii_boot_quirk(dev);
1367                 break;
1368         }
1369
1370         return 0;
1371 }
1372
1373 int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1374                                   struct usb_interface *intf,
1375                                   const struct snd_usb_audio_quirk *quirk,
1376                                   unsigned int id)
1377 {
1378         switch (id) {
1379         case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
1380                 return snd_usb_motu_m_series_boot_quirk(dev);
1381         }
1382
1383         return 0;
1384 }
1385
1386 /*
1387  * check if the device uses big-endian samples
1388  */
1389 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
1390 {
1391         /* it depends on altsetting whether the device is big-endian or not */
1392         switch (chip->usb_id) {
1393         case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1394                 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1395                         fp->altsetting == 5 || fp->altsetting == 6)
1396                         return 1;
1397                 break;
1398         case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1399                 if (chip->setup == 0x00 ||
1400                         fp->altsetting == 1 || fp->altsetting == 2 ||
1401                         fp->altsetting == 3)
1402                         return 1;
1403                 break;
1404         case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1405                 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1406                         fp->altsetting == 5 || fp->altsetting == 6)
1407                         return 1;
1408                 break;
1409         }
1410         return 0;
1411 }
1412
1413 /*
1414  * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1415  * not for interface.
1416  */
1417
1418 enum {
1419         EMU_QUIRK_SR_44100HZ = 0,
1420         EMU_QUIRK_SR_48000HZ,
1421         EMU_QUIRK_SR_88200HZ,
1422         EMU_QUIRK_SR_96000HZ,
1423         EMU_QUIRK_SR_176400HZ,
1424         EMU_QUIRK_SR_192000HZ
1425 };
1426
1427 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1428                                  struct audioformat *fmt)
1429 {
1430         unsigned char emu_samplerate_id = 0;
1431
1432         /* When capture is active
1433          * sample rate shouldn't be changed
1434          * by playback substream
1435          */
1436         if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1437                 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
1438                         return;
1439         }
1440
1441         switch (fmt->rate_min) {
1442         case 48000:
1443                 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1444                 break;
1445         case 88200:
1446                 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1447                 break;
1448         case 96000:
1449                 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1450                 break;
1451         case 176400:
1452                 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1453                 break;
1454         case 192000:
1455                 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1456                 break;
1457         default:
1458                 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1459                 break;
1460         }
1461         snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1462         subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1463 }
1464
1465
1466 /*
1467  * Pioneer DJ DJM-900NXS2
1468  * Device needs to know the sample rate each time substream is started
1469  */
1470 static int pioneer_djm_set_format_quirk(struct snd_usb_substream *subs)
1471 {
1472
1473         /* Convert sample rate value to little endian */
1474         u8 sr[3];
1475
1476         sr[0] = subs->cur_rate & 0xff;
1477         sr[1] = (subs->cur_rate >> 8) & 0xff;
1478         sr[2] = (subs->cur_rate >> 16) & 0xff;
1479
1480         /* Configure device */
1481         usb_set_interface(subs->dev, 0, 1);
1482         snd_usb_ctl_msg(subs->stream->chip->dev,
1483                 usb_rcvctrlpipe(subs->stream->chip->dev, 0),
1484                 0x01, 0x22, 0x0100, 0x0082, &sr, 0x0003);
1485
1486         return 0;
1487 }
1488
1489 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1490                               struct audioformat *fmt)
1491 {
1492         switch (subs->stream->chip->usb_id) {
1493         case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1494         case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1495         case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1496         case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1497                 set_format_emu_quirk(subs, fmt);
1498                 break;
1499         case USB_ID(0x2b73, 0x000a): /* Pioneer DJ DJM-900NXS2 */
1500         case USB_ID(0x2b73, 0x0017): /* Pioneer DJ DJM-250MK2 */
1501                 pioneer_djm_set_format_quirk(subs);
1502                 break;
1503         case USB_ID(0x534d, 0x2109): /* MacroSilicon MS2109 */
1504                 subs->stream_offset_adj = 2;
1505                 break;
1506         }
1507 }
1508
1509 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1510 {
1511         /* devices which do not support reading the sample rate. */
1512         switch (chip->usb_id) {
1513         case USB_ID(0x041e, 0x4080): /* Creative Live Cam VF0610 */
1514         case USB_ID(0x04d8, 0xfeea): /* Benchmark DAC1 Pre */
1515         case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
1516         case USB_ID(0x05a3, 0x9420): /* ELP HD USB Camera */
1517         case USB_ID(0x05a7, 0x1020): /* Bose Companion 5 */
1518         case USB_ID(0x074d, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1519         case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
1520         case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
1521         case USB_ID(0x21b4, 0x0081): /* AudioQuest DragonFly */
1522         case USB_ID(0x2912, 0x30c8): /* Audioengine D1 */
1523                 return true;
1524         }
1525
1526         /* devices of these vendors don't support reading rate, either */
1527         switch (USB_ID_VENDOR(chip->usb_id)) {
1528         case 0x045e: /* MS Lifecam */
1529         case 0x047f: /* Plantronics */
1530         case 0x1de7: /* Phoenix Audio */
1531                 return true;
1532         }
1533
1534         return false;
1535 }
1536
1537 /* ITF-USB DSD based DACs need a vendor cmd to switch
1538  * between PCM and native DSD mode
1539  */
1540 static bool is_itf_usb_dsd_dac(unsigned int id)
1541 {
1542         switch (id) {
1543         case USB_ID(0x154e, 0x1002): /* Denon DCD-1500RE */
1544         case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1545         case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1546         case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1547         case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
1548         case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
1549         case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
1550         case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
1551                 return true;
1552         }
1553         return false;
1554 }
1555
1556 int snd_usb_select_mode_quirk(struct snd_usb_substream *subs,
1557                               struct audioformat *fmt)
1558 {
1559         struct usb_device *dev = subs->dev;
1560         int err;
1561
1562         if (is_itf_usb_dsd_dac(subs->stream->chip->usb_id)) {
1563                 /* First switch to alt set 0, otherwise the mode switch cmd
1564                  * will not be accepted by the DAC
1565                  */
1566                 err = usb_set_interface(dev, fmt->iface, 0);
1567                 if (err < 0)
1568                         return err;
1569
1570                 msleep(20); /* Delay needed after setting the interface */
1571
1572                 /* Vendor mode switch cmd is required. */
1573                 if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1574                         /* DSD mode (DSD_U32) requested */
1575                         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1576                                               USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1577                                               1, 1, NULL, 0);
1578                         if (err < 0)
1579                                 return err;
1580
1581                 } else {
1582                         /* PCM or DOP mode (S32) requested */
1583                         /* PCM mode (S16) requested */
1584                         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1585                                               USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1586                                               0, 1, NULL, 0);
1587                         if (err < 0)
1588                                 return err;
1589
1590                 }
1591                 msleep(20);
1592         }
1593         return 0;
1594 }
1595
1596 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1597 {
1598         /*
1599          * "Playback Design" products send bogus feedback data at the start
1600          * of the stream. Ignore them.
1601          */
1602         if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1603             ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1604                 ep->skip_packets = 4;
1605
1606         /*
1607          * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1608          * world latency varies by approx. +/- 50 frames (at 96kHz) each time
1609          * the stream is (re)started. When skipping packets 16 at endpoint
1610          * start up, the real world latency is stable within +/- 1 frame (also
1611          * across power cycles).
1612          */
1613         if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1614              ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1615             ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1616                 ep->skip_packets = 16;
1617
1618         /* Work around devices that report unreasonable feedback data */
1619         if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) ||  /* TEAC UD-H01 */
1620              ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1621             ep->syncmaxsize == 4)
1622                 ep->tenor_fb_quirk = 1;
1623 }
1624
1625 void snd_usb_set_interface_quirk(struct usb_device *dev)
1626 {
1627         struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1628
1629         if (!chip)
1630                 return;
1631         /*
1632          * "Playback Design" products need a 50ms delay after setting the
1633          * USB interface.
1634          */
1635         switch (USB_ID_VENDOR(chip->usb_id)) {
1636         case 0x23ba: /* Playback Design */
1637         case 0x0644: /* TEAC Corp. */
1638                 msleep(50);
1639                 break;
1640         }
1641 }
1642
1643 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1644 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1645                            __u8 request, __u8 requesttype, __u16 value,
1646                            __u16 index, void *data, __u16 size)
1647 {
1648         struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1649
1650         if (!chip)
1651                 return;
1652         /*
1653          * "Playback Design" products need a 20ms delay after each
1654          * class compliant request
1655          */
1656         if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1657             (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1658                 msleep(20);
1659
1660         /*
1661          * "TEAC Corp." products need a 20ms delay after each
1662          * class compliant request
1663          */
1664         if (USB_ID_VENDOR(chip->usb_id) == 0x0644 &&
1665             (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1666                 msleep(20);
1667
1668         /* ITF-USB DSD based DACs functionality need a delay
1669          * after each class compliant request
1670          */
1671         if (is_itf_usb_dsd_dac(chip->usb_id)
1672             && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1673                 msleep(20);
1674
1675         /* Zoom R16/24, many Logitech(at least H650e/H570e/BCC950),
1676          * Jabra 550a, Kingston HyperX needs a tiny delay here,
1677          * otherwise requests like get/set frequency return
1678          * as failed despite actually succeeding.
1679          */
1680         if ((chip->usb_id == USB_ID(0x1686, 0x00dd) ||
1681              USB_ID_VENDOR(chip->usb_id) == 0x046d  || /* Logitech */
1682              chip->usb_id == USB_ID(0x0b0e, 0x0349) ||
1683              chip->usb_id == USB_ID(0x0951, 0x16ad)) &&
1684             (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1685                 usleep_range(1000, 2000);
1686
1687         /*
1688          * Samsung USBC Headset (AKG) need a tiny delay after each
1689          * class compliant request. (Model number: AAM625R or AAM627R)
1690          */
1691         if (chip->usb_id == USB_ID(0x04e8, 0xa051) &&
1692             (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1693                 usleep_range(5000, 6000);
1694 }
1695
1696 /*
1697  * snd_usb_interface_dsd_format_quirks() is called from format.c to
1698  * augment the PCM format bit-field for DSD types. The UAC standards
1699  * don't have a designated bit field to denote DSD-capable interfaces,
1700  * hence all hardware that is known to support this format has to be
1701  * listed here.
1702  */
1703 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1704                                         struct audioformat *fp,
1705                                         unsigned int sample_bytes)
1706 {
1707         struct usb_interface *iface;
1708
1709         /* Playback Designs */
1710         if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1711             USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
1712                 switch (fp->altsetting) {
1713                 case 1:
1714                         fp->dsd_dop = true;
1715                         return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1716                 case 2:
1717                         fp->dsd_bitrev = true;
1718                         return SNDRV_PCM_FMTBIT_DSD_U8;
1719                 case 3:
1720                         fp->dsd_bitrev = true;
1721                         return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1722                 }
1723         }
1724
1725         /* XMOS based USB DACs */
1726         switch (chip->usb_id) {
1727         case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
1728         case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1729         case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1730                 if (fp->altsetting == 2)
1731                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1732                 break;
1733
1734         case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1735         case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1736         case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
1737         case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1738         case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1739         case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1740         case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
1741         case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1742         case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1743         case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1744         case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1745         case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1746         case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1747         case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1748                 if (fp->altsetting == 3)
1749                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1750                 break;
1751
1752         /* Amanero Combo384 USB based DACs with native DSD support */
1753         case USB_ID(0x16d0, 0x071a):  /* Amanero - Combo384 */
1754         case USB_ID(0x2ab6, 0x0004):  /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1755         case USB_ID(0x2ab6, 0x0005):  /* T+A USB HD Audio 1 */
1756         case USB_ID(0x2ab6, 0x0006):  /* T+A USB HD Audio 2 */
1757                 if (fp->altsetting == 2) {
1758                         switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
1759                         case 0x199:
1760                                 return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1761                         case 0x19b:
1762                         case 0x203:
1763                                 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1764                         default:
1765                                 break;
1766                         }
1767                 }
1768                 break;
1769         case USB_ID(0x16d0, 0x0a23):
1770                 if (fp->altsetting == 2)
1771                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1772                 break;
1773
1774         default:
1775                 break;
1776         }
1777
1778         /* ITF-USB DSD based DACs */
1779         if (is_itf_usb_dsd_dac(chip->usb_id)) {
1780                 iface = usb_ifnum_to_if(chip->dev, fp->iface);
1781
1782                 /* Altsetting 2 support native DSD if the num of altsets is
1783                  * three (0-2),
1784                  * Altsetting 3 support native DSD if the num of altsets is
1785                  * four (0-3).
1786                  */
1787                 if (fp->altsetting == iface->num_altsetting - 1)
1788                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1789         }
1790
1791         /* Mostly generic method to detect many DSD-capable implementations -
1792          * from XMOS/Thesycon
1793          */
1794         switch (USB_ID_VENDOR(chip->usb_id)) {
1795         case 0x152a:  /* Thesycon devices */
1796         case 0x20b1:  /* XMOS based devices */
1797         case 0x22d9:  /* Oppo */
1798         case 0x23ba:  /* Playback Designs */
1799         case 0x25ce:  /* Mytek devices */
1800         case 0x278b:  /* Rotel? */
1801         case 0x292b:  /* Gustard/Ess based devices */
1802         case 0x2ab6:  /* T+A devices */
1803         case 0x3353:  /* Khadas devices */
1804         case 0x3842:  /* EVGA */
1805         case 0xc502:  /* HiBy devices */
1806                 if (fp->dsd_raw)
1807                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1808                 break;
1809         default:
1810                 break;
1811
1812         }
1813
1814         return 0;
1815 }
1816
1817 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1818                                           struct audioformat *fp,
1819                                           int stream)
1820 {
1821         switch (chip->usb_id) {
1822         case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1823                 /* Optoplay sets the sample rate attribute although
1824                  * it seems not supporting it in fact.
1825                  */
1826                 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
1827                 break;
1828         case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1829         case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1830                 /* doesn't set the sample rate attribute, but supports it */
1831                 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
1832                 break;
1833         case USB_ID(0x0763, 0x2001):  /* M-Audio Quattro USB */
1834         case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1835         case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1836         case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1837                                         an older model 77d:223) */
1838         /*
1839          * plantronics headset and Griffin iMic have set adaptive-in
1840          * although it's really not...
1841          */
1842                 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
1843                 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
1844                         fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
1845                 else
1846                         fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
1847                 break;
1848         case USB_ID(0x07fd, 0x0004):  /* MOTU MicroBook IIc */
1849                 /*
1850                  * MaxPacketsOnly attribute is erroneously set in endpoint
1851                  * descriptors. As a result this card produces noise with
1852                  * all sample rates other than 96 kHz.
1853                  */
1854                 fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
1855                 break;
1856         }
1857 }
1858
1859 /*
1860  * registration quirk:
1861  * the registration is skipped if a device matches with the given ID,
1862  * unless the interface reaches to the defined one.  This is for delaying
1863  * the registration until the last known interface, so that the card and
1864  * devices appear at the same time.
1865  */
1866
1867 struct registration_quirk {
1868         unsigned int usb_id;    /* composed via USB_ID() */
1869         unsigned int interface; /* the interface to trigger register */
1870 };
1871
1872 #define REG_QUIRK_ENTRY(vendor, product, iface) \
1873         { .usb_id = USB_ID(vendor, product), .interface = (iface) }
1874
1875 static const struct registration_quirk registration_quirks[] = {
1876         REG_QUIRK_ENTRY(0x0951, 0x16d8, 2),     /* Kingston HyperX AMP */
1877         REG_QUIRK_ENTRY(0x0951, 0x16ed, 2),     /* Kingston HyperX Cloud Alpha S */
1878         REG_QUIRK_ENTRY(0x0951, 0x16ea, 2),     /* Kingston HyperX Cloud Flight S */
1879         { 0 }                                   /* terminator */
1880 };
1881
1882 /* return true if skipping registration */
1883 bool snd_usb_registration_quirk(struct snd_usb_audio *chip, int iface)
1884 {
1885         const struct registration_quirk *q;
1886
1887         for (q = registration_quirks; q->usb_id; q++)
1888                 if (chip->usb_id == q->usb_id)
1889                         return iface != q->interface;
1890
1891         /* Register as normal */
1892         return false;
1893 }