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