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 /*
 522  * audio-interface quirks
 523  *
 524  * returns zero if no standard audio/MIDI parsing is needed.
 525  * returns a positive value if standard audio/midi interfaces are parsed
 526  * after this.
 527  * returns a negative value at error.
 528  */
 529 int snd_usb_create_quirk(struct snd_usb_audio *chip,
 530                          struct usb_interface *iface,
 531                          struct usb_driver *driver,
 532                          const struct snd_usb_audio_quirk *quirk)
 533 {
 534         typedef int (*quirk_func_t)(struct snd_usb_audio *,
 535                                     struct usb_interface *,
 536                                     struct usb_driver *,
 537                                     const struct snd_usb_audio_quirk *);
 538         static const quirk_func_t quirk_funcs[] = {
 539                 [QUIRK_IGNORE_INTERFACE] = ignore_interface_quirk,
 540                 [QUIRK_COMPOSITE] = create_composite_quirk,
 541                 [QUIRK_AUTODETECT] = create_autodetect_quirks,
 542                 [QUIRK_MIDI_STANDARD_INTERFACE] = create_any_midi_quirk,
 543                 [QUIRK_MIDI_FIXED_ENDPOINT] = create_any_midi_quirk,
 544                 [QUIRK_MIDI_YAMAHA] = create_any_midi_quirk,
 545                 [QUIRK_MIDI_ROLAND] = create_any_midi_quirk,
 546                 [QUIRK_MIDI_MIDIMAN] = create_any_midi_quirk,
 547                 [QUIRK_MIDI_NOVATION] = create_any_midi_quirk,
 548                 [QUIRK_MIDI_RAW_BYTES] = create_any_midi_quirk,
 549                 [QUIRK_MIDI_EMAGIC] = create_any_midi_quirk,
 550                 [QUIRK_MIDI_CME] = create_any_midi_quirk,
 551                 [QUIRK_MIDI_AKAI] = create_any_midi_quirk,
 552                 [QUIRK_MIDI_FTDI] = create_any_midi_quirk,
 553                 [QUIRK_MIDI_CH345] = create_any_midi_quirk,
 554                 [QUIRK_AUDIO_STANDARD_INTERFACE] = create_standard_audio_quirk,
 555                 [QUIRK_AUDIO_FIXED_ENDPOINT] = create_fixed_stream_quirk,
 556                 [QUIRK_AUDIO_EDIROL_UAXX] = create_uaxx_quirk,
 557                 [QUIRK_AUDIO_ALIGN_TRANSFER] = create_align_transfer_quirk,
 558                 [QUIRK_AUDIO_STANDARD_MIXER] = create_standard_mixer_quirk,
 559                 [QUIRK_SETUP_FMT_AFTER_RESUME] = setup_fmt_after_resume_quirk,
 560         };
 561
 562         if (quirk->type < QUIRK_TYPE_COUNT) {
 563                 return quirk_funcs[quirk->type](chip, iface, driver, quirk);
 564         } else {
 565                 usb_audio_err(chip, "invalid quirk type %d\n", quirk->type);
 566                 return -ENXIO;
 567         }
 568 }
 569
 570 /*
 571  * boot quirks
 572  */
 573
 574 #define EXTIGY_FIRMWARE_SIZE_OLD 794
 575 #define EXTIGY_FIRMWARE_SIZE_NEW 483
 576
 577 static int snd_usb_extigy_boot_quirk(struct usb_device *dev, struct usb_interface *intf)
 578 {
 579         struct usb_host_config *config = dev->actconfig;
 580         int err;
 581
 582         if (le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_OLD ||
 583             le16_to_cpu(get_cfg_desc(config)->wTotalLength) == EXTIGY_FIRMWARE_SIZE_NEW) {
 584                 dev_dbg(&dev->dev, "sending Extigy boot sequence...\n");
 585                 /* Send message to force it to reconnect with full interface. */
 586                 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev,0),
 587                                       0x10, 0x43, 0x0001, 0x000a, NULL, 0);
 588                 if (err < 0)
 589                         dev_dbg(&dev->dev, "error sending boot message: %d\n", err);
 590                 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
 591                                 &dev->descriptor, sizeof(dev->descriptor));
 592                 config = dev->actconfig;
 593                 if (err < 0)
 594                         dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
 595                 err = usb_reset_configuration(dev);
 596                 if (err < 0)
 597                         dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
 598                 dev_dbg(&dev->dev, "extigy_boot: new boot length = %d\n",
 599                             le16_to_cpu(get_cfg_desc(config)->wTotalLength));
 600                 return -ENODEV; /* quit this anyway */
 601         }
 602         return 0;
 603 }
 604
 605 static int snd_usb_audigy2nx_boot_quirk(struct usb_device *dev)
 606 {
 607         u8 buf = 1;
 608
 609         snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), 0x2a,
 610                         USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER,
 611                         0, 0, &buf, 1);
 612         if (buf == 0) {
 613                 snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0x29,
 614                                 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_OTHER,
 615                                 1, 2000, NULL, 0);
 616                 return -ENODEV;
 617         }
 618         return 0;
 619 }
 620
 621 static int snd_usb_fasttrackpro_boot_quirk(struct usb_device *dev)
 622 {
 623         int err;
 624
 625         if (dev->actconfig->desc.bConfigurationValue == 1) {
 626                 dev_info(&dev->dev,
 627                            "Fast Track Pro switching to config #2\n");
 628                 /* This function has to be available by the usb core module.
 629                  * if it is not avialable the boot quirk has to be left out
 630                  * and the configuration has to be set by udev or hotplug
 631                  * rules
 632                  */
 633                 err = usb_driver_set_configuration(dev, 2);
 634                 if (err < 0)
 635                         dev_dbg(&dev->dev,
 636                                 "error usb_driver_set_configuration: %d\n",
 637                                 err);
 638                 /* Always return an error, so that we stop creating a device
 639                    that will just be destroyed and recreated with a new
 640                    configuration */
 641                 return -ENODEV;
 642         } else
 643                 dev_info(&dev->dev, "Fast Track Pro config OK\n");
 644
 645         return 0;
 646 }
 647
 648 /*
 649  * C-Media CM106/CM106+ have four 16-bit internal registers that are nicely
 650  * documented in the device's data sheet.
 651  */
 652 static int snd_usb_cm106_write_int_reg(struct usb_device *dev, int reg, u16 value)
 653 {
 654         u8 buf[4];
 655         buf[0] = 0x20;
 656         buf[1] = value & 0xff;
 657         buf[2] = (value >> 8) & 0xff;
 658         buf[3] = reg;
 659         return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_CONFIGURATION,
 660                                USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_ENDPOINT,
 661                                0, 0, &buf, 4);
 662 }
 663
 664 static int snd_usb_cm106_boot_quirk(struct usb_device *dev)
 665 {
 666         /*
 667          * Enable line-out driver mode, set headphone source to front
 668          * channels, enable stereo mic.
 669          */
 670         return snd_usb_cm106_write_int_reg(dev, 2, 0x8004);
 671 }
 672
 673 /*
 674  * CM6206 registers from the CM6206 datasheet rev 2.1
 675  */
 676 #define CM6206_REG0_DMA_MASTER BIT(15)
 677 #define CM6206_REG0_SPDIFO_RATE_48K (2 << 12)
 678 #define CM6206_REG0_SPDIFO_RATE_96K (7 << 12)
 679 /* Bit 4 thru 11 is the S/PDIF category code */
 680 #define CM6206_REG0_SPDIFO_CAT_CODE_GENERAL (0 << 4)
 681 #define CM6206_REG0_SPDIFO_EMPHASIS_CD BIT(3)
 682 #define CM6206_REG0_SPDIFO_COPYRIGHT_NA BIT(2)
 683 #define CM6206_REG0_SPDIFO_NON_AUDIO BIT(1)
 684 #define CM6206_REG0_SPDIFO_PRO_FORMAT BIT(0)
 685
 686 #define CM6206_REG1_TEST_SEL_CLK BIT(14)
 687 #define CM6206_REG1_PLLBIN_EN BIT(13)
 688 #define CM6206_REG1_SOFT_MUTE_EN BIT(12)
 689 #define CM6206_REG1_GPIO4_OUT BIT(11)
 690 #define CM6206_REG1_GPIO4_OE BIT(10)
 691 #define CM6206_REG1_GPIO3_OUT BIT(9)
 692 #define CM6206_REG1_GPIO3_OE BIT(8)
 693 #define CM6206_REG1_GPIO2_OUT BIT(7)
 694 #define CM6206_REG1_GPIO2_OE BIT(6)
 695 #define CM6206_REG1_GPIO1_OUT BIT(5)
 696 #define CM6206_REG1_GPIO1_OE BIT(4)
 697 #define CM6206_REG1_SPDIFO_INVALID BIT(3)
 698 #define CM6206_REG1_SPDIF_LOOP_EN BIT(2)
 699 #define CM6206_REG1_SPDIFO_DIS BIT(1)
 700 #define CM6206_REG1_SPDIFI_MIX BIT(0)
 701
 702 #define CM6206_REG2_DRIVER_ON BIT(15)
 703 #define CM6206_REG2_HEADP_SEL_SIDE_CHANNELS (0 << 13)
 704 #define CM6206_REG2_HEADP_SEL_SURROUND_CHANNELS (1 << 13)
 705 #define CM6206_REG2_HEADP_SEL_CENTER_SUBW (2 << 13)
 706 #define CM6206_REG2_HEADP_SEL_FRONT_CHANNELS (3 << 13)
 707 #define CM6206_REG2_MUTE_HEADPHONE_RIGHT BIT(12)
 708 #define CM6206_REG2_MUTE_HEADPHONE_LEFT BIT(11)
 709 #define CM6206_REG2_MUTE_REAR_SURROUND_RIGHT BIT(10)
 710 #define CM6206_REG2_MUTE_REAR_SURROUND_LEFT BIT(9)
 711 #define CM6206_REG2_MUTE_SIDE_SURROUND_RIGHT BIT(8)
 712 #define CM6206_REG2_MUTE_SIDE_SURROUND_LEFT BIT(7)
 713 #define CM6206_REG2_MUTE_SUBWOOFER BIT(6)
 714 #define CM6206_REG2_MUTE_CENTER BIT(5)
 715 #define CM6206_REG2_MUTE_RIGHT_FRONT BIT(3)
 716 #define CM6206_REG2_MUTE_LEFT_FRONT BIT(3)
 717 #define CM6206_REG2_EN_BTL BIT(2)
 718 #define CM6206_REG2_MCUCLKSEL_1_5_MHZ (0)
 719 #define CM6206_REG2_MCUCLKSEL_3_MHZ (1)
 720 #define CM6206_REG2_MCUCLKSEL_6_MHZ (2)
 721 #define CM6206_REG2_MCUCLKSEL_12_MHZ (3)
 722
 723 /* Bit 11..13 sets the sensitivity to FLY tuner volume control VP/VD signal */
 724 #define CM6206_REG3_FLYSPEED_DEFAULT (2 << 11)
 725 #define CM6206_REG3_VRAP25EN BIT(10)
 726 #define CM6206_REG3_MSEL1 BIT(9)
 727 #define CM6206_REG3_SPDIFI_RATE_44_1K BIT(0 << 7)
 728 #define CM6206_REG3_SPDIFI_RATE_48K BIT(2 << 7)
 729 #define CM6206_REG3_SPDIFI_RATE_32K BIT(3 << 7)
 730 #define CM6206_REG3_PINSEL BIT(6)
 731 #define CM6206_REG3_FOE BIT(5)
 732 #define CM6206_REG3_ROE BIT(4)
 733 #define CM6206_REG3_CBOE BIT(3)
 734 #define CM6206_REG3_LOSE BIT(2)
 735 #define CM6206_REG3_HPOE BIT(1)
 736 #define CM6206_REG3_SPDIFI_CANREC BIT(0)
 737
 738 #define CM6206_REG5_DA_RSTN BIT(13)
 739 #define CM6206_REG5_AD_RSTN BIT(12)
 740 #define CM6206_REG5_SPDIFO_AD2SPDO BIT(12)
 741 #define CM6206_REG5_SPDIFO_SEL_FRONT (0 << 9)
 742 #define CM6206_REG5_SPDIFO_SEL_SIDE_SUR (1 << 9)
 743 #define CM6206_REG5_SPDIFO_SEL_CEN_LFE (2 << 9)
 744 #define CM6206_REG5_SPDIFO_SEL_REAR_SUR (3 << 9)
 745 #define CM6206_REG5_CODECM BIT(8)
 746 #define CM6206_REG5_EN_HPF BIT(7)
 747 #define CM6206_REG5_T_SEL_DSDA4 BIT(6)
 748 #define CM6206_REG5_T_SEL_DSDA3 BIT(5)
 749 #define CM6206_REG5_T_SEL_DSDA2 BIT(4)
 750 #define CM6206_REG5_T_SEL_DSDA1 BIT(3)
 751 #define CM6206_REG5_T_SEL_DSDAD_NORMAL 0
 752 #define CM6206_REG5_T_SEL_DSDAD_FRONT 4
 753 #define CM6206_REG5_T_SEL_DSDAD_S_SURROUND 5
 754 #define CM6206_REG5_T_SEL_DSDAD_CEN_LFE 6
 755 #define CM6206_REG5_T_SEL_DSDAD_R_SURROUND 7
 756
 757 static int snd_usb_cm6206_boot_quirk(struct usb_device *dev)
 758 {
 759         int err  = 0, reg;
 760         int val[] = {
 761                 /*
 762                  * Values here are chosen based on sniffing USB traffic
 763                  * under Windows.
 764                  *
 765                  * REG0: DAC is master, sample rate 48kHz, no copyright
 766                  */
 767                 CM6206_REG0_SPDIFO_RATE_48K |
 768                 CM6206_REG0_SPDIFO_COPYRIGHT_NA,
 769                 /*
 770                  * REG1: PLL binary search enable, soft mute enable.
 771                  */
 772                 CM6206_REG1_PLLBIN_EN |
 773                 CM6206_REG1_SOFT_MUTE_EN,
 774                 /*
 775                  * REG2: enable output drivers,
 776                  * select front channels to the headphone output,
 777                  * then mute the headphone channels, run the MCU
 778                  * at 1.5 MHz.
 779                  */
 780                 CM6206_REG2_DRIVER_ON |
 781                 CM6206_REG2_HEADP_SEL_FRONT_CHANNELS |
 782                 CM6206_REG2_MUTE_HEADPHONE_RIGHT |
 783                 CM6206_REG2_MUTE_HEADPHONE_LEFT,
 784                 /*
 785                  * REG3: default flyspeed, set 2.5V mic bias
 786                  * enable all line out ports and enable SPDIF
 787                  */
 788                 CM6206_REG3_FLYSPEED_DEFAULT |
 789                 CM6206_REG3_VRAP25EN |
 790                 CM6206_REG3_FOE |
 791                 CM6206_REG3_ROE |
 792                 CM6206_REG3_CBOE |
 793                 CM6206_REG3_LOSE |
 794                 CM6206_REG3_HPOE |
 795                 CM6206_REG3_SPDIFI_CANREC,
 796                 /* REG4 is just a bunch of GPIO lines */
 797                 0x0000,
 798                 /* REG5: de-assert AD/DA reset signals */
 799                 CM6206_REG5_DA_RSTN |
 800                 CM6206_REG5_AD_RSTN };
 801
 802         for (reg = 0; reg < ARRAY_SIZE(val); reg++) {
 803                 err = snd_usb_cm106_write_int_reg(dev, reg, val[reg]);
 804                 if (err < 0)
 805                         return err;
 806         }
 807
 808         return err;
 809 }
 810
 811 /* quirk for Plantronics GameCom 780 with CM6302 chip */
 812 static int snd_usb_gamecon780_boot_quirk(struct usb_device *dev)
 813 {
 814         /* set the initial volume and don't change; other values are either
 815          * too loud or silent due to firmware bug (bko#65251)
 816          */
 817         u8 buf[2] = { 0x74, 0xe3 };
 818         return snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
 819                         USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
 820                         UAC_FU_VOLUME << 8, 9 << 8, buf, 2);
 821 }
 822
 823 /*
 824  * Novation Twitch DJ controller
 825  * Focusrite Novation Saffire 6 USB audio card
 826  */
 827 static int snd_usb_novation_boot_quirk(struct usb_device *dev)
 828 {
 829         /* preemptively set up the device because otherwise the
 830          * raw MIDI endpoints are not active */
 831         usb_set_interface(dev, 0, 1);
 832         return 0;
 833 }
 834
 835 /*
 836  * This call will put the synth in "USB send" mode, i.e it will send MIDI
 837  * messages through USB (this is disabled at startup). The synth will
 838  * acknowledge by sending a sysex on endpoint 0x85 and by displaying a USB
 839  * sign on its LCD. Values here are chosen based on sniffing USB traffic
 840  * under Windows.
 841  */
 842 static int snd_usb_accessmusic_boot_quirk(struct usb_device *dev)
 843 {
 844         int err, actual_length;
 845         /* "midi send" enable */
 846         static const u8 seq[] = { 0x4e, 0x73, 0x52, 0x01 };
 847         void *buf;
 848
 849         if (snd_usb_pipe_sanity_check(dev, usb_sndintpipe(dev, 0x05)))
 850                 return -EINVAL;
 851         buf = kmemdup(seq, ARRAY_SIZE(seq), GFP_KERNEL);
 852         if (!buf)
 853                 return -ENOMEM;
 854         err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x05), buf,
 855                         ARRAY_SIZE(seq), &actual_length, 1000);
 856         kfree(buf);
 857         if (err < 0)
 858                 return err;
 859
 860         return 0;
 861 }
 862
 863 /*
 864  * Some sound cards from Native Instruments are in fact compliant to the USB
 865  * audio standard of version 2 and other approved USB standards, even though
 866  * they come up as vendor-specific device when first connected.
 867  *
 868  * However, they can be told to come up with a new set of descriptors
 869  * upon their next enumeration, and the interfaces announced by the new
 870  * descriptors will then be handled by the kernel's class drivers. As the
 871  * product ID will also change, no further checks are required.
 872  */
 873
 874 static int snd_usb_nativeinstruments_boot_quirk(struct usb_device *dev)
 875 {
 876         int ret;
 877
 878         if (snd_usb_pipe_sanity_check(dev, usb_sndctrlpipe(dev, 0)))
 879                 return -EINVAL;
 880         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 881                                   0xaf, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 882                                   1, 0, NULL, 0, 1000);
 883
 884         if (ret < 0)
 885                 return ret;
 886
 887         usb_reset_device(dev);
 888
 889         /* return -EAGAIN, so the creation of an audio interface for this
 890          * temporary device is aborted. The device will reconnect with a
 891          * new product ID */
 892         return -EAGAIN;
 893 }
 894
 895 static void mbox2_setup_48_24_magic(struct usb_device *dev)
 896 {
 897         u8 srate[3];
 898         u8 temp[12];
 899
 900         /* Choose 48000Hz permanently */
 901         srate[0] = 0x80;
 902         srate[1] = 0xbb;
 903         srate[2] = 0x00;
 904
 905         /* Send the magic! */
 906         snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
 907                 0x01, 0x22, 0x0100, 0x0085, &temp, 0x0003);
 908         snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 909                 0x81, 0xa2, 0x0100, 0x0085, &srate, 0x0003);
 910         snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 911                 0x81, 0xa2, 0x0100, 0x0086, &srate, 0x0003);
 912         snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0),
 913                 0x81, 0xa2, 0x0100, 0x0003, &srate, 0x0003);
 914         return;
 915 }
 916
 917 /* Digidesign Mbox 2 needs to load firmware onboard
 918  * and driver must wait a few seconds for initialisation.
 919  */
 920
 921 #define MBOX2_FIRMWARE_SIZE    646
 922 #define MBOX2_BOOT_LOADING     0x01 /* Hard coded into the device */
 923 #define MBOX2_BOOT_READY       0x02 /* Hard coded into the device */
 924
 925 static int snd_usb_mbox2_boot_quirk(struct usb_device *dev)
 926 {
 927         struct usb_host_config *config = dev->actconfig;
 928         int err;
 929         u8 bootresponse[0x12];
 930         int fwsize;
 931         int count;
 932
 933         fwsize = le16_to_cpu(get_cfg_desc(config)->wTotalLength);
 934
 935         if (fwsize != MBOX2_FIRMWARE_SIZE) {
 936                 dev_err(&dev->dev, "Invalid firmware size=%d.\n", fwsize);
 937                 return -ENODEV;
 938         }
 939
 940         dev_dbg(&dev->dev, "Sending Digidesign Mbox 2 boot sequence...\n");
 941
 942         count = 0;
 943         bootresponse[0] = MBOX2_BOOT_LOADING;
 944         while ((bootresponse[0] == MBOX2_BOOT_LOADING) && (count < 10)) {
 945                 msleep(500); /* 0.5 second delay */
 946                 snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0),
 947                         /* Control magic - load onboard firmware */
 948                         0x85, 0xc0, 0x0001, 0x0000, &bootresponse, 0x0012);
 949                 if (bootresponse[0] == MBOX2_BOOT_READY)
 950                         break;
 951                 dev_dbg(&dev->dev, "device not ready, resending boot sequence...\n");
 952                 count++;
 953         }
 954
 955         if (bootresponse[0] != MBOX2_BOOT_READY) {
 956                 dev_err(&dev->dev, "Unknown bootresponse=%d, or timed out, ignoring device.\n", bootresponse[0]);
 957                 return -ENODEV;
 958         }
 959
 960         dev_dbg(&dev->dev, "device initialised!\n");
 961
 962         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
 963                 &dev->descriptor, sizeof(dev->descriptor));
 964         config = dev->actconfig;
 965         if (err < 0)
 966                 dev_dbg(&dev->dev, "error usb_get_descriptor: %d\n", err);
 967
 968         err = usb_reset_configuration(dev);
 969         if (err < 0)
 970                 dev_dbg(&dev->dev, "error usb_reset_configuration: %d\n", err);
 971         dev_dbg(&dev->dev, "mbox2_boot: new boot length = %d\n",
 972                 le16_to_cpu(get_cfg_desc(config)->wTotalLength));
 973
 974         mbox2_setup_48_24_magic(dev);
 975
 976         dev_info(&dev->dev, "Digidesign Mbox 2: 24bit 48kHz");
 977
 978         return 0; /* Successful boot */
 979 }
 980
 981 static int snd_usb_axefx3_boot_quirk(struct usb_device *dev)
 982 {
 983         int err;
 984
 985         dev_dbg(&dev->dev, "Waiting for Axe-Fx III to boot up...\n");
 986
 987         if (snd_usb_pipe_sanity_check(dev, usb_sndctrlpipe(dev, 0)))
 988                 return -EINVAL;
 989         /* If the Axe-Fx III has not fully booted, it will timeout when trying
 990          * to enable the audio streaming interface. A more generous timeout is
 991          * used here to detect when the Axe-Fx III has finished booting as the
 992          * set interface message will be acked once it has
 993          */
 994         err = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 995                                 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
 996                                 1, 1, NULL, 0, 120000);
 997         if (err < 0) {
 998                 dev_err(&dev->dev,
 999                         "failed waiting for Axe-Fx III to boot: %d\n", err);
1000                 return err;
1001         }
1002
1003         dev_dbg(&dev->dev, "Axe-Fx III is now ready\n");
1004
1005         err = usb_set_interface(dev, 1, 0);
1006         if (err < 0)
1007                 dev_dbg(&dev->dev,
1008                         "error stopping Axe-Fx III interface: %d\n", err);
1009
1010         return 0;
1011 }
1012
1013
1014 #define MICROBOOK_BUF_SIZE 128
1015
1016 static int snd_usb_motu_microbookii_communicate(struct usb_device *dev, u8 *buf,
1017                                                 int buf_size, int *length)
1018 {
1019         int err, actual_length;
1020
1021         if (snd_usb_pipe_sanity_check(dev, usb_sndintpipe(dev, 0x01)))
1022                 return -EINVAL;
1023         err = usb_interrupt_msg(dev, usb_sndintpipe(dev, 0x01), buf, *length,
1024                                 &actual_length, 1000);
1025         if (err < 0)
1026                 return err;
1027
1028         print_hex_dump(KERN_DEBUG, "MicroBookII snd: ", DUMP_PREFIX_NONE, 16, 1,
1029                        buf, actual_length, false);
1030
1031         memset(buf, 0, buf_size);
1032
1033         if (snd_usb_pipe_sanity_check(dev, usb_rcvintpipe(dev, 0x82)))
1034                 return -EINVAL;
1035         err = usb_interrupt_msg(dev, usb_rcvintpipe(dev, 0x82), buf, buf_size,
1036                                 &actual_length, 1000);
1037         if (err < 0)
1038                 return err;
1039
1040         print_hex_dump(KERN_DEBUG, "MicroBookII rcv: ", DUMP_PREFIX_NONE, 16, 1,
1041                        buf, actual_length, false);
1042
1043         *length = actual_length;
1044         return 0;
1045 }
1046
1047 static int snd_usb_motu_microbookii_boot_quirk(struct usb_device *dev)
1048 {
1049         int err, actual_length, poll_attempts = 0;
1050         static const u8 set_samplerate_seq[] = { 0x00, 0x00, 0x00, 0x00,
1051                                                  0x00, 0x00, 0x0b, 0x14,
1052                                                  0x00, 0x00, 0x00, 0x01 };
1053         static const u8 poll_ready_seq[] = { 0x00, 0x04, 0x00, 0x00,
1054                                              0x00, 0x00, 0x0b, 0x18 };
1055         u8 *buf = kzalloc(MICROBOOK_BUF_SIZE, GFP_KERNEL);
1056
1057         if (!buf)
1058                 return -ENOMEM;
1059
1060         dev_info(&dev->dev, "Waiting for MOTU Microbook II to boot up...\n");
1061
1062         /* First we tell the device which sample rate to use. */
1063         memcpy(buf, set_samplerate_seq, sizeof(set_samplerate_seq));
1064         actual_length = sizeof(set_samplerate_seq);
1065         err = snd_usb_motu_microbookii_communicate(dev, buf, MICROBOOK_BUF_SIZE,
1066                                                    &actual_length);
1067
1068         if (err < 0) {
1069                 dev_err(&dev->dev,
1070                         "failed setting the sample rate for Motu MicroBook II: %d\n",
1071                         err);
1072                 goto free_buf;
1073         }
1074
1075         /* Then we poll every 100 ms until the device informs of its readiness. */
1076         while (true) {
1077                 if (++poll_attempts > 100) {
1078                         dev_err(&dev->dev,
1079                                 "failed booting Motu MicroBook II: timeout\n");
1080                         err = -ENODEV;
1081                         goto free_buf;
1082                 }
1083
1084                 memset(buf, 0, MICROBOOK_BUF_SIZE);
1085                 memcpy(buf, poll_ready_seq, sizeof(poll_ready_seq));
1086
1087                 actual_length = sizeof(poll_ready_seq);
1088                 err = snd_usb_motu_microbookii_communicate(
1089                         dev, buf, MICROBOOK_BUF_SIZE, &actual_length);
1090                 if (err < 0) {
1091                         dev_err(&dev->dev,
1092                                 "failed booting Motu MicroBook II: communication error %d\n",
1093                                 err);
1094                         goto free_buf;
1095                 }
1096
1097                 /* the device signals its readiness through a message of the
1098                  * form
1099                  *           XX 06 00 00 00 00 0b 18  00 00 00 01
1100                  * If the device is not yet ready to accept audio data, the
1101                  * last byte of that sequence is 00.
1102                  */
1103                 if (actual_length == 12 && buf[actual_length - 1] == 1)
1104                         break;
1105
1106                 msleep(100);
1107         }
1108
1109         dev_info(&dev->dev, "MOTU MicroBook II ready\n");
1110
1111 free_buf:
1112         kfree(buf);
1113         return err;
1114 }
1115
1116 static int snd_usb_motu_m_series_boot_quirk(struct usb_device *dev)
1117 {
1118         int ret;
1119
1120         if (snd_usb_pipe_sanity_check(dev, usb_sndctrlpipe(dev, 0)))
1121                 return -EINVAL;
1122         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1123                               1, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
1124                               0x0, 0, NULL, 0, 1000);
1125
1126         if (ret < 0)
1127                 return ret;
1128
1129         msleep(2000);
1130
1131         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1132                               1, USB_TYPE_VENDOR | USB_RECIP_DEVICE,
1133                               0x20, 0, NULL, 0, 1000);
1134
1135         if (ret < 0)
1136                 return ret;
1137
1138         return 0;
1139 }
1140
1141 /*
1142  * Setup quirks
1143  */
1144 #define MAUDIO_SET              0x01 /* parse device_setup */
1145 #define MAUDIO_SET_COMPATIBLE   0x80 /* use only "win-compatible" interfaces */
1146 #define MAUDIO_SET_DTS          0x02 /* enable DTS Digital Output */
1147 #define MAUDIO_SET_96K          0x04 /* 48-96KHz rate if set, 8-48KHz otherwise */
1148 #define MAUDIO_SET_24B          0x08 /* 24bits sample if set, 16bits otherwise */
1149 #define MAUDIO_SET_DI           0x10 /* enable Digital Input */
1150 #define MAUDIO_SET_MASK         0x1f /* bit mask for setup value */
1151 #define MAUDIO_SET_24B_48K_DI    0x19 /* 24bits+48KHz+Digital Input */
1152 #define MAUDIO_SET_24B_48K_NOTDI 0x09 /* 24bits+48KHz+No Digital Input */
1153 #define MAUDIO_SET_16B_48K_DI    0x11 /* 16bits+48KHz+Digital Input */
1154 #define MAUDIO_SET_16B_48K_NOTDI 0x01 /* 16bits+48KHz+No Digital Input */
1155
1156 static int quattro_skip_setting_quirk(struct snd_usb_audio *chip,
1157                                       int iface, int altno)
1158 {
1159         /* Reset ALL ifaces to 0 altsetting.
1160          * Call it for every possible altsetting of every interface.
1161          */
1162         usb_set_interface(chip->dev, iface, 0);
1163         if (chip->setup & MAUDIO_SET) {
1164                 if (chip->setup & MAUDIO_SET_COMPATIBLE) {
1165                         if (iface != 1 && iface != 2)
1166                                 return 1; /* skip all interfaces but 1 and 2 */
1167                 } else {
1168                         unsigned int mask;
1169                         if (iface == 1 || iface == 2)
1170                                 return 1; /* skip interfaces 1 and 2 */
1171                         if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1172                                 return 1; /* skip this altsetting */
1173                         mask = chip->setup & MAUDIO_SET_MASK;
1174                         if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1175                                 return 1; /* skip this altsetting */
1176                         if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1177                                 return 1; /* skip this altsetting */
1178                         if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 4)
1179                                 return 1; /* skip this altsetting */
1180                 }
1181         }
1182         usb_audio_dbg(chip,
1183                     "using altsetting %d for interface %d config %d\n",
1184                     altno, iface, chip->setup);
1185         return 0; /* keep this altsetting */
1186 }
1187
1188 static int audiophile_skip_setting_quirk(struct snd_usb_audio *chip,
1189                                          int iface,
1190                                          int altno)
1191 {
1192         /* Reset ALL ifaces to 0 altsetting.
1193          * Call it for every possible altsetting of every interface.
1194          */
1195         usb_set_interface(chip->dev, iface, 0);
1196
1197         if (chip->setup & MAUDIO_SET) {
1198                 unsigned int mask;
1199                 if ((chip->setup & MAUDIO_SET_DTS) && altno != 6)
1200                         return 1; /* skip this altsetting */
1201                 if ((chip->setup & MAUDIO_SET_96K) && altno != 1)
1202                         return 1; /* skip this altsetting */
1203                 mask = chip->setup & MAUDIO_SET_MASK;
1204                 if (mask == MAUDIO_SET_24B_48K_DI && altno != 2)
1205                         return 1; /* skip this altsetting */
1206                 if (mask == MAUDIO_SET_24B_48K_NOTDI && altno != 3)
1207                         return 1; /* skip this altsetting */
1208                 if (mask == MAUDIO_SET_16B_48K_DI && altno != 4)
1209                         return 1; /* skip this altsetting */
1210                 if (mask == MAUDIO_SET_16B_48K_NOTDI && altno != 5)
1211                         return 1; /* skip this altsetting */
1212         }
1213
1214         return 0; /* keep this altsetting */
1215 }
1216
1217 static int fasttrackpro_skip_setting_quirk(struct snd_usb_audio *chip,
1218                                            int iface, int altno)
1219 {
1220         /* Reset ALL ifaces to 0 altsetting.
1221          * Call it for every possible altsetting of every interface.
1222          */
1223         usb_set_interface(chip->dev, iface, 0);
1224
1225         /* possible configuration where both inputs and only one output is
1226          *used is not supported by the current setup
1227          */
1228         if (chip->setup & (MAUDIO_SET | MAUDIO_SET_24B)) {
1229                 if (chip->setup & MAUDIO_SET_96K) {
1230                         if (altno != 3 && altno != 6)
1231                                 return 1;
1232                 } else if (chip->setup & MAUDIO_SET_DI) {
1233                         if (iface == 4)
1234                                 return 1; /* no analog input */
1235                         if (altno != 2 && altno != 5)
1236                                 return 1; /* enable only altsets 2 and 5 */
1237                 } else {
1238                         if (iface == 5)
1239                                 return 1; /* disable digialt input */
1240                         if (altno != 2 && altno != 5)
1241                                 return 1; /* enalbe only altsets 2 and 5 */
1242                 }
1243         } else {
1244                 /* keep only 16-Bit mode */
1245                 if (altno != 1)
1246                         return 1;
1247         }
1248
1249         usb_audio_dbg(chip,
1250                     "using altsetting %d for interface %d config %d\n",
1251                     altno, iface, chip->setup);
1252         return 0; /* keep this altsetting */
1253 }
1254
1255 static int s1810c_skip_setting_quirk(struct snd_usb_audio *chip,
1256                                            int iface, int altno)
1257 {
1258         /*
1259          * Altno settings:
1260          *
1261          * Playback (Interface 1):
1262          * 1: 6 Analog + 2 S/PDIF
1263          * 2: 6 Analog + 2 S/PDIF
1264          * 3: 6 Analog
1265          *
1266          * Capture (Interface 2):
1267          * 1: 8 Analog + 2 S/PDIF + 8 ADAT
1268          * 2: 8 Analog + 2 S/PDIF + 4 ADAT
1269          * 3: 8 Analog
1270          */
1271
1272         /*
1273          * I'll leave 2 as the default one and
1274          * use device_setup to switch to the
1275          * other two.
1276          */
1277         if ((chip->setup == 0 || chip->setup > 2) && altno != 2)
1278                 return 1;
1279         else if (chip->setup == 1 && altno != 1)
1280                 return 1;
1281         else if (chip->setup == 2 && altno != 3)
1282                 return 1;
1283
1284         return 0;
1285 }
1286
1287 int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,
1288                                   int iface,
1289                                   int altno)
1290 {
1291         /* audiophile usb: skip altsets incompatible with device_setup */
1292         if (chip->usb_id == USB_ID(0x0763, 0x2003))
1293                 return audiophile_skip_setting_quirk(chip, iface, altno);
1294         /* quattro usb: skip altsets incompatible with device_setup */
1295         if (chip->usb_id == USB_ID(0x0763, 0x2001))
1296                 return quattro_skip_setting_quirk(chip, iface, altno);
1297         /* fasttrackpro usb: skip altsets incompatible with device_setup */
1298         if (chip->usb_id == USB_ID(0x0763, 0x2012))
1299                 return fasttrackpro_skip_setting_quirk(chip, iface, altno);
1300         /* presonus studio 1810c: skip altsets incompatible with device_setup */
1301         if (chip->usb_id == USB_ID(0x0194f, 0x010c))
1302                 return s1810c_skip_setting_quirk(chip, iface, altno);
1303
1304
1305         return 0;
1306 }
1307
1308 int snd_usb_apply_boot_quirk(struct usb_device *dev,
1309                              struct usb_interface *intf,
1310                              const struct snd_usb_audio_quirk *quirk,
1311                              unsigned int id)
1312 {
1313         switch (id) {
1314         case USB_ID(0x041e, 0x3000):
1315                 /* SB Extigy needs special boot-up sequence */
1316                 /* if more models come, this will go to the quirk list. */
1317                 return snd_usb_extigy_boot_quirk(dev, intf);
1318
1319         case USB_ID(0x041e, 0x3020):
1320                 /* SB Audigy 2 NX needs its own boot-up magic, too */
1321                 return snd_usb_audigy2nx_boot_quirk(dev);
1322
1323         case USB_ID(0x10f5, 0x0200):
1324                 /* C-Media CM106 / Turtle Beach Audio Advantage Roadie */
1325                 return snd_usb_cm106_boot_quirk(dev);
1326
1327         case USB_ID(0x0d8c, 0x0102):
1328                 /* C-Media CM6206 / CM106-Like Sound Device */
1329         case USB_ID(0x0ccd, 0x00b1): /* Terratec Aureon 7.1 USB */
1330                 return snd_usb_cm6206_boot_quirk(dev);
1331
1332         case USB_ID(0x0dba, 0x3000):
1333                 /* Digidesign Mbox 2 */
1334                 return snd_usb_mbox2_boot_quirk(dev);
1335
1336         case USB_ID(0x1235, 0x0010): /* Focusrite Novation Saffire 6 USB */
1337         case USB_ID(0x1235, 0x0018): /* Focusrite Novation Twitch */
1338                 return snd_usb_novation_boot_quirk(dev);
1339
1340         case USB_ID(0x133e, 0x0815):
1341                 /* Access Music VirusTI Desktop */
1342                 return snd_usb_accessmusic_boot_quirk(dev);
1343
1344         case USB_ID(0x17cc, 0x1000): /* Komplete Audio 6 */
1345         case USB_ID(0x17cc, 0x1010): /* Traktor Audio 6 */
1346         case USB_ID(0x17cc, 0x1020): /* Traktor Audio 10 */
1347                 return snd_usb_nativeinstruments_boot_quirk(dev);
1348         case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1349                 return snd_usb_fasttrackpro_boot_quirk(dev);
1350         case USB_ID(0x047f, 0xc010): /* Plantronics Gamecom 780 */
1351                 return snd_usb_gamecon780_boot_quirk(dev);
1352         case USB_ID(0x2466, 0x8010): /* Fractal Audio Axe-Fx 3 */
1353                 return snd_usb_axefx3_boot_quirk(dev);
1354         case USB_ID(0x07fd, 0x0004): /* MOTU MicroBook II */
1355                 /*
1356                  * For some reason interface 3 with vendor-spec class is
1357                  * detected on MicroBook IIc.
1358                  */
1359                 if (get_iface_desc(intf->altsetting)->bInterfaceClass ==
1360                     USB_CLASS_VENDOR_SPEC &&
1361                     get_iface_desc(intf->altsetting)->bInterfaceNumber < 3)
1362                         return snd_usb_motu_microbookii_boot_quirk(dev);
1363                 break;
1364         }
1365
1366         return 0;
1367 }
1368
1369 int snd_usb_apply_boot_quirk_once(struct usb_device *dev,
1370                                   struct usb_interface *intf,
1371                                   const struct snd_usb_audio_quirk *quirk,
1372                                   unsigned int id)
1373 {
1374         switch (id) {
1375         case USB_ID(0x07fd, 0x0008): /* MOTU M Series */
1376                 return snd_usb_motu_m_series_boot_quirk(dev);
1377         }
1378
1379         return 0;
1380 }
1381
1382 /*
1383  * check if the device uses big-endian samples
1384  */
1385 int snd_usb_is_big_endian_format(struct snd_usb_audio *chip, struct audioformat *fp)
1386 {
1387         /* it depends on altsetting whether the device is big-endian or not */
1388         switch (chip->usb_id) {
1389         case USB_ID(0x0763, 0x2001): /* M-Audio Quattro: captured data only */
1390                 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1391                         fp->altsetting == 5 || fp->altsetting == 6)
1392                         return 1;
1393                 break;
1394         case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1395                 if (chip->setup == 0x00 ||
1396                         fp->altsetting == 1 || fp->altsetting == 2 ||
1397                         fp->altsetting == 3)
1398                         return 1;
1399                 break;
1400         case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro */
1401                 if (fp->altsetting == 2 || fp->altsetting == 3 ||
1402                         fp->altsetting == 5 || fp->altsetting == 6)
1403                         return 1;
1404                 break;
1405         }
1406         return 0;
1407 }
1408
1409 /*
1410  * For E-Mu 0404USB/0202USB/TrackerPre/0204 sample rate should be set for device,
1411  * not for interface.
1412  */
1413
1414 enum {
1415         EMU_QUIRK_SR_44100HZ = 0,
1416         EMU_QUIRK_SR_48000HZ,
1417         EMU_QUIRK_SR_88200HZ,
1418         EMU_QUIRK_SR_96000HZ,
1419         EMU_QUIRK_SR_176400HZ,
1420         EMU_QUIRK_SR_192000HZ
1421 };
1422
1423 static void set_format_emu_quirk(struct snd_usb_substream *subs,
1424                                  struct audioformat *fmt)
1425 {
1426         unsigned char emu_samplerate_id = 0;
1427
1428         /* When capture is active
1429          * sample rate shouldn't be changed
1430          * by playback substream
1431          */
1432         if (subs->direction == SNDRV_PCM_STREAM_PLAYBACK) {
1433                 if (subs->stream->substream[SNDRV_PCM_STREAM_CAPTURE].interface != -1)
1434                         return;
1435         }
1436
1437         switch (fmt->rate_min) {
1438         case 48000:
1439                 emu_samplerate_id = EMU_QUIRK_SR_48000HZ;
1440                 break;
1441         case 88200:
1442                 emu_samplerate_id = EMU_QUIRK_SR_88200HZ;
1443                 break;
1444         case 96000:
1445                 emu_samplerate_id = EMU_QUIRK_SR_96000HZ;
1446                 break;
1447         case 176400:
1448                 emu_samplerate_id = EMU_QUIRK_SR_176400HZ;
1449                 break;
1450         case 192000:
1451                 emu_samplerate_id = EMU_QUIRK_SR_192000HZ;
1452                 break;
1453         default:
1454                 emu_samplerate_id = EMU_QUIRK_SR_44100HZ;
1455                 break;
1456         }
1457         snd_emuusb_set_samplerate(subs->stream->chip, emu_samplerate_id);
1458         subs->pkt_offset_adj = (emu_samplerate_id >= EMU_QUIRK_SR_176400HZ) ? 4 : 0;
1459 }
1460
1461 void snd_usb_set_format_quirk(struct snd_usb_substream *subs,
1462                               struct audioformat *fmt)
1463 {
1464         switch (subs->stream->chip->usb_id) {
1465         case USB_ID(0x041e, 0x3f02): /* E-Mu 0202 USB */
1466         case USB_ID(0x041e, 0x3f04): /* E-Mu 0404 USB */
1467         case USB_ID(0x041e, 0x3f0a): /* E-Mu Tracker Pre */
1468         case USB_ID(0x041e, 0x3f19): /* E-Mu 0204 USB */
1469                 set_format_emu_quirk(subs, fmt);
1470                 break;
1471         }
1472 }
1473
1474 bool snd_usb_get_sample_rate_quirk(struct snd_usb_audio *chip)
1475 {
1476         /* devices which do not support reading the sample rate. */
1477         switch (chip->usb_id) {
1478         case USB_ID(0x041e, 0x4080): /* Creative Live Cam VF0610 */
1479         case USB_ID(0x04d8, 0xfeea): /* Benchmark DAC1 Pre */
1480         case USB_ID(0x0556, 0x0014): /* Phoenix Audio TMX320VC */
1481         case USB_ID(0x05a3, 0x9420): /* ELP HD USB Camera */
1482         case USB_ID(0x05a7, 0x1020): /* Bose Companion 5 */
1483         case USB_ID(0x074d, 0x3553): /* Outlaw RR2150 (Micronas UAC3553B) */
1484         case USB_ID(0x1395, 0x740a): /* Sennheiser DECT */
1485         case USB_ID(0x1901, 0x0191): /* GE B850V3 CP2114 audio interface */
1486         case USB_ID(0x21b4, 0x0081): /* AudioQuest DragonFly */
1487         case USB_ID(0x2912, 0x30c8): /* Audioengine D1 */
1488                 return true;
1489         }
1490
1491         /* devices of these vendors don't support reading rate, either */
1492         switch (USB_ID_VENDOR(chip->usb_id)) {
1493         case 0x045e: /* MS Lifecam */
1494         case 0x047f: /* Plantronics */
1495         case 0x1de7: /* Phoenix Audio */
1496                 return true;
1497         }
1498
1499         return false;
1500 }
1501
1502 /* ITF-USB DSD based DACs need a vendor cmd to switch
1503  * between PCM and native DSD mode
1504  */
1505 static bool is_itf_usb_dsd_dac(unsigned int id)
1506 {
1507         switch (id) {
1508         case USB_ID(0x154e, 0x1003): /* Denon DA-300USB */
1509         case USB_ID(0x154e, 0x3005): /* Marantz HD-DAC1 */
1510         case USB_ID(0x154e, 0x3006): /* Marantz SA-14S1 */
1511         case USB_ID(0x1852, 0x5065): /* Luxman DA-06 */
1512         case USB_ID(0x0644, 0x8043): /* TEAC UD-501/UD-501V2/UD-503/NT-503 */
1513         case USB_ID(0x0644, 0x8044): /* Esoteric D-05X */
1514         case USB_ID(0x0644, 0x804a): /* TEAC UD-301 */
1515                 return true;
1516         }
1517         return false;
1518 }
1519
1520 int snd_usb_select_mode_quirk(struct snd_usb_substream *subs,
1521                               struct audioformat *fmt)
1522 {
1523         struct usb_device *dev = subs->dev;
1524         int err;
1525
1526         if (is_itf_usb_dsd_dac(subs->stream->chip->usb_id)) {
1527                 /* First switch to alt set 0, otherwise the mode switch cmd
1528                  * will not be accepted by the DAC
1529                  */
1530                 err = usb_set_interface(dev, fmt->iface, 0);
1531                 if (err < 0)
1532                         return err;
1533
1534                 msleep(20); /* Delay needed after setting the interface */
1535
1536                 /* Vendor mode switch cmd is required. */
1537                 if (fmt->formats & SNDRV_PCM_FMTBIT_DSD_U32_BE) {
1538                         /* DSD mode (DSD_U32) requested */
1539                         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1540                                               USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1541                                               1, 1, NULL, 0);
1542                         if (err < 0)
1543                                 return err;
1544
1545                 } else {
1546                         /* PCM or DOP mode (S32) requested */
1547                         /* PCM mode (S16) requested */
1548                         err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), 0,
1549                                               USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE,
1550                                               0, 1, NULL, 0);
1551                         if (err < 0)
1552                                 return err;
1553
1554                 }
1555                 msleep(20);
1556         }
1557         return 0;
1558 }
1559
1560 void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)
1561 {
1562         /*
1563          * "Playback Design" products send bogus feedback data at the start
1564          * of the stream. Ignore them.
1565          */
1566         if (USB_ID_VENDOR(ep->chip->usb_id) == 0x23ba &&
1567             ep->type == SND_USB_ENDPOINT_TYPE_SYNC)
1568                 ep->skip_packets = 4;
1569
1570         /*
1571          * M-Audio Fast Track C400/C600 - when packets are not skipped, real
1572          * world latency varies by approx. +/- 50 frames (at 96KHz) each time
1573          * the stream is (re)started. When skipping packets 16 at endpoint
1574          * start up, the real world latency is stable within +/- 1 frame (also
1575          * across power cycles).
1576          */
1577         if ((ep->chip->usb_id == USB_ID(0x0763, 0x2030) ||
1578              ep->chip->usb_id == USB_ID(0x0763, 0x2031)) &&
1579             ep->type == SND_USB_ENDPOINT_TYPE_DATA)
1580                 ep->skip_packets = 16;
1581
1582         /* Work around devices that report unreasonable feedback data */
1583         if ((ep->chip->usb_id == USB_ID(0x0644, 0x8038) ||  /* TEAC UD-H01 */
1584              ep->chip->usb_id == USB_ID(0x1852, 0x5034)) && /* T+A Dac8 */
1585             ep->syncmaxsize == 4)
1586                 ep->tenor_fb_quirk = 1;
1587 }
1588
1589 void snd_usb_set_interface_quirk(struct usb_device *dev)
1590 {
1591         struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1592
1593         if (!chip)
1594                 return;
1595         /*
1596          * "Playback Design" products need a 50ms delay after setting the
1597          * USB interface.
1598          */
1599         switch (USB_ID_VENDOR(chip->usb_id)) {
1600         case 0x23ba: /* Playback Design */
1601         case 0x0644: /* TEAC Corp. */
1602                 msleep(50);
1603                 break;
1604         }
1605 }
1606
1607 /* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */
1608 void snd_usb_ctl_msg_quirk(struct usb_device *dev, unsigned int pipe,
1609                            __u8 request, __u8 requesttype, __u16 value,
1610                            __u16 index, void *data, __u16 size)
1611 {
1612         struct snd_usb_audio *chip = dev_get_drvdata(&dev->dev);
1613
1614         if (!chip)
1615                 return;
1616         /*
1617          * "Playback Design" products need a 20ms delay after each
1618          * class compliant request
1619          */
1620         if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1621             (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1622                 msleep(20);
1623
1624         /*
1625          * "TEAC Corp." products need a 20ms delay after each
1626          * class compliant request
1627          */
1628         if (USB_ID_VENDOR(chip->usb_id) == 0x0644 &&
1629             (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1630                 msleep(20);
1631
1632         /* ITF-USB DSD based DACs functionality need a delay
1633          * after each class compliant request
1634          */
1635         if (is_itf_usb_dsd_dac(chip->usb_id)
1636             && (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1637                 msleep(20);
1638
1639         /* Zoom R16/24, Logitech H650e, Jabra 550a, Kingston HyperX needs a tiny
1640          * delay here, otherwise requests like get/set frequency return as
1641          * failed despite actually succeeding.
1642          */
1643         if ((chip->usb_id == USB_ID(0x1686, 0x00dd) ||
1644              chip->usb_id == USB_ID(0x046d, 0x0a46) ||
1645              chip->usb_id == USB_ID(0x0b0e, 0x0349) ||
1646              chip->usb_id == USB_ID(0x0951, 0x16ad)) &&
1647             (requesttype & USB_TYPE_MASK) == USB_TYPE_CLASS)
1648                 usleep_range(1000, 2000);
1649 }
1650
1651 /*
1652  * snd_usb_interface_dsd_format_quirks() is called from format.c to
1653  * augment the PCM format bit-field for DSD types. The UAC standards
1654  * don't have a designated bit field to denote DSD-capable interfaces,
1655  * hence all hardware that is known to support this format has to be
1656  * listed here.
1657  */
1658 u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip,
1659                                         struct audioformat *fp,
1660                                         unsigned int sample_bytes)
1661 {
1662         struct usb_interface *iface;
1663
1664         /* Playback Designs */
1665         if (USB_ID_VENDOR(chip->usb_id) == 0x23ba &&
1666             USB_ID_PRODUCT(chip->usb_id) < 0x0110) {
1667                 switch (fp->altsetting) {
1668                 case 1:
1669                         fp->dsd_dop = true;
1670                         return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1671                 case 2:
1672                         fp->dsd_bitrev = true;
1673                         return SNDRV_PCM_FMTBIT_DSD_U8;
1674                 case 3:
1675                         fp->dsd_bitrev = true;
1676                         return SNDRV_PCM_FMTBIT_DSD_U16_LE;
1677                 }
1678         }
1679
1680         /* XMOS based USB DACs */
1681         switch (chip->usb_id) {
1682         case USB_ID(0x1511, 0x0037): /* AURALiC VEGA */
1683         case USB_ID(0x2522, 0x0012): /* LH Labs VI DAC Infinity */
1684         case USB_ID(0x2772, 0x0230): /* Pro-Ject Pre Box S2 Digital */
1685                 if (fp->altsetting == 2)
1686                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1687                 break;
1688
1689         case USB_ID(0x0d8c, 0x0316): /* Hegel HD12 DSD */
1690         case USB_ID(0x10cb, 0x0103): /* The Bit Opus #3; with fp->dsd_raw */
1691         case USB_ID(0x16d0, 0x06b2): /* NuPrime DAC-10 */
1692         case USB_ID(0x16d0, 0x09dd): /* Encore mDSD */
1693         case USB_ID(0x16d0, 0x0733): /* Furutech ADL Stratos */
1694         case USB_ID(0x16d0, 0x09db): /* NuPrime Audio DAC-9 */
1695         case USB_ID(0x1db5, 0x0003): /* Bryston BDA3 */
1696         case USB_ID(0x22e1, 0xca01): /* HDTA Serenade DSD */
1697         case USB_ID(0x249c, 0x9326): /* M2Tech Young MkIII */
1698         case USB_ID(0x2616, 0x0106): /* PS Audio NuWave DAC */
1699         case USB_ID(0x2622, 0x0041): /* Audiolab M-DAC+ */
1700         case USB_ID(0x27f7, 0x3002): /* W4S DAC-2v2SE */
1701         case USB_ID(0x29a2, 0x0086): /* Mutec MC3+ USB */
1702         case USB_ID(0x6b42, 0x0042): /* MSB Technology */
1703                 if (fp->altsetting == 3)
1704                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1705                 break;
1706
1707         /* Amanero Combo384 USB based DACs with native DSD support */
1708         case USB_ID(0x16d0, 0x071a):  /* Amanero - Combo384 */
1709         case USB_ID(0x2ab6, 0x0004):  /* T+A DAC8DSD-V2.0, MP1000E-V2.0, MP2000R-V2.0, MP2500R-V2.0, MP3100HV-V2.0 */
1710         case USB_ID(0x2ab6, 0x0005):  /* T+A USB HD Audio 1 */
1711         case USB_ID(0x2ab6, 0x0006):  /* T+A USB HD Audio 2 */
1712                 if (fp->altsetting == 2) {
1713                         switch (le16_to_cpu(chip->dev->descriptor.bcdDevice)) {
1714                         case 0x199:
1715                                 return SNDRV_PCM_FMTBIT_DSD_U32_LE;
1716                         case 0x19b:
1717                         case 0x203:
1718                                 return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1719                         default:
1720                                 break;
1721                         }
1722                 }
1723                 break;
1724         case USB_ID(0x16d0, 0x0a23):
1725                 if (fp->altsetting == 2)
1726                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1727                 break;
1728
1729         default:
1730                 break;
1731         }
1732
1733         /* ITF-USB DSD based DACs */
1734         if (is_itf_usb_dsd_dac(chip->usb_id)) {
1735                 iface = usb_ifnum_to_if(chip->dev, fp->iface);
1736
1737                 /* Altsetting 2 support native DSD if the num of altsets is
1738                  * three (0-2),
1739                  * Altsetting 3 support native DSD if the num of altsets is
1740                  * four (0-3).
1741                  */
1742                 if (fp->altsetting == iface->num_altsetting - 1)
1743                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1744         }
1745
1746         /* Mostly generic method to detect many DSD-capable implementations -
1747          * from XMOS/Thesycon
1748          */
1749         switch (USB_ID_VENDOR(chip->usb_id)) {
1750         case 0x152a:  /* Thesycon devices */
1751         case 0x20b1:  /* XMOS based devices */
1752         case 0x22d9:  /* Oppo */
1753         case 0x23ba:  /* Playback Designs */
1754         case 0x25ce:  /* Mytek devices */
1755         case 0x278b:  /* Rotel? */
1756         case 0x292b:  /* Gustard/Ess based devices */
1757         case 0x2ab6:  /* T+A devices */
1758         case 0x3842:  /* EVGA */
1759         case 0xc502:  /* HiBy devices */
1760                 if (fp->dsd_raw)
1761                         return SNDRV_PCM_FMTBIT_DSD_U32_BE;
1762                 break;
1763         default:
1764                 break;
1765
1766         }
1767
1768         return 0;
1769 }
1770
1771 void snd_usb_audioformat_attributes_quirk(struct snd_usb_audio *chip,
1772                                           struct audioformat *fp,
1773                                           int stream)
1774 {
1775         switch (chip->usb_id) {
1776         case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
1777                 /* Optoplay sets the sample rate attribute although
1778                  * it seems not supporting it in fact.
1779                  */
1780                 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
1781                 break;
1782         case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
1783         case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
1784                 /* doesn't set the sample rate attribute, but supports it */
1785                 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
1786                 break;
1787         case USB_ID(0x0763, 0x2001):  /* M-Audio Quattro USB */
1788         case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
1789         case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
1790         case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
1791                                         an older model 77d:223) */
1792         /*
1793          * plantronics headset and Griffin iMic have set adaptive-in
1794          * although it's really not...
1795          */
1796                 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
1797                 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
1798                         fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
1799                 else
1800                         fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
1801                 break;
1802         case USB_ID(0x07fd, 0x0004):  /* MOTU MicroBook IIc */
1803                 /*
1804                  * MaxPacketsOnly attribute is erroneously set in endpoint
1805                  * descriptors. As a result this card produces noise with
1806                  * all sample rates other than 96 KHz.
1807                  */
1808                 fp->attributes &= ~UAC_EP_CS_ATTR_FILL_MAX;
1809                 break;
1810         }
1811 }
1812
1813 /*
1814  * registration quirk:
1815  * the registration is skipped if a device matches with the given ID,
1816  * unless the interface reaches to the defined one.  This is for delaying
1817  * the registration until the last known interface, so that the card and
1818  * devices appear at the same time.
1819  */
1820
1821 struct registration_quirk {
1822         unsigned int usb_id;    /* composed via USB_ID() */
1823         unsigned int interface; /* the interface to trigger register */
1824 };
1825
1826 #define REG_QUIRK_ENTRY(vendor, product, iface) \
1827         { .usb_id = USB_ID(vendor, product), .interface = (iface) }
1828
1829 static const struct registration_quirk registration_quirks[] = {
1830         REG_QUIRK_ENTRY(0x0951, 0x16d8, 2),     /* Kingston HyperX AMP */
1831         REG_QUIRK_ENTRY(0x0951, 0x16ed, 2),     /* Kingston HyperX Cloud Alpha S */
1832         { 0 }                                   /* terminator */
1833 };
1834
1835 /* return true if skipping registration */
1836 bool snd_usb_registration_quirk(struct snd_usb_audio *chip, int iface)
1837 {
1838         const struct registration_quirk *q;
1839
1840         for (q = registration_quirks; q->usb_id; q++)
1841                 if (chip->usb_id == q->usb_id)
1842                         return iface != q->interface;
1843
1844         /* Register as normal */
1845         return false;
1846 }