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