sound/usb/quirks.c

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