sound/usb/card.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *   (Tentative) USB Audio Driver for ALSA
   4  *
   5  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
   6  *
   7  *   Many codes borrowed from audio.c by
   8  *          Alan Cox (alan@lxorguk.ukuu.org.uk)
   9  *          Thomas Sailer (sailer@ife.ee.ethz.ch)
  10  *
  11  *   Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com>
  12  *
  13  *  NOTES:
  14  *
  15  *   - the linked URBs would be preferred but not used so far because of
  16  *     the instability of unlinking.
  17  *   - type II is not supported properly.  there is no device which supports
  18  *     this type *correctly*.  SB extigy looks as if it supports, but it's
  19  *     indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
  20  */
  21
  22
  23 #include <linux/bitops.h>
  24 #include <linux/init.h>
  25 #include <linux/list.h>
  26 #include <linux/slab.h>
  27 #include <linux/string.h>
  28 #include <linux/ctype.h>
  29 #include <linux/usb.h>
  30 #include <linux/moduleparam.h>
  31 #include <linux/mutex.h>
  32 #include <linux/usb/audio.h>
  33 #include <linux/usb/audio-v2.h>
  34 #include <linux/usb/audio-v3.h>
  35 #include <linux/module.h>
  36
  37 #include <sound/control.h>
  38 #include <sound/core.h>
  39 #include <sound/info.h>
  40 #include <sound/pcm.h>
  41 #include <sound/pcm_params.h>
  42 #include <sound/initval.h>
  43
  44 #include "usbaudio.h"
  45 #include "card.h"
  46 #include "midi.h"
  47 #include "mixer.h"
  48 #include "proc.h"
  49 #include "quirks.h"
  50 #include "endpoint.h"
  51 #include "helper.h"
  52 #include "pcm.h"
  53 #include "format.h"
  54 #include "power.h"
  55 #include "stream.h"
  56 #include "media.h"
  57
  58 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
  59 MODULE_DESCRIPTION("USB Audio");
  60 MODULE_LICENSE("GPL");
  61
  62 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
  63 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
  64 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
  65 /* Vendor/product IDs for this card */
  66 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
  67 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
  68 static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
  69 static bool ignore_ctl_error;
  70 static bool autoclock = true;
  71 static char *quirk_alias[SNDRV_CARDS];
  72 static char *delayed_register[SNDRV_CARDS];
  73 static bool implicit_fb[SNDRV_CARDS];
  74
  75 bool snd_usb_use_vmalloc = true;
  76 bool snd_usb_skip_validation;
  77
  78 module_param_array(index, int, NULL, 0444);
  79 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
  80 module_param_array(id, charp, NULL, 0444);
  81 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
  82 module_param_array(enable, bool, NULL, 0444);
  83 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
  84 module_param_array(vid, int, NULL, 0444);
  85 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
  86 module_param_array(pid, int, NULL, 0444);
  87 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
  88 module_param_array(device_setup, int, NULL, 0444);
  89 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
  90 module_param(ignore_ctl_error, bool, 0444);
  91 MODULE_PARM_DESC(ignore_ctl_error,
  92                  "Ignore errors from USB controller for mixer interfaces.");
  93 module_param(autoclock, bool, 0444);
  94 MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
  95 module_param_array(quirk_alias, charp, NULL, 0444);
  96 MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");
  97 module_param_array(delayed_register, charp, NULL, 0444);
  98 MODULE_PARM_DESC(delayed_register, "Quirk for delayed registration, given by id:iface, e.g. 0123abcd:4.");
  99 module_param_array(implicit_fb, bool, NULL, 0444);
 100 MODULE_PARM_DESC(implicit_fb, "Apply generic implicit feedback sync mode.");
 101 module_param_named(use_vmalloc, snd_usb_use_vmalloc, bool, 0444);
 102 MODULE_PARM_DESC(use_vmalloc, "Use vmalloc for PCM intermediate buffers (default: yes).");
 103 module_param_named(skip_validation, snd_usb_skip_validation, bool, 0444);
 104 MODULE_PARM_DESC(skip_validation, "Skip unit descriptor validation (default: no).");
 105
 106 /*
 107  * we keep the snd_usb_audio_t instances by ourselves for merging
 108  * the all interfaces on the same card as one sound device.
 109  */
 110
 111 static DEFINE_MUTEX(register_mutex);
 112 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
 113 static struct usb_driver usb_audio_driver;
 114
 115 /*
 116  * disconnect streams
 117  * called from usb_audio_disconnect()
 118  */
 119 static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
 120 {
 121         int idx;
 122         struct snd_usb_substream *subs;
 123
 124         for (idx = 0; idx < 2; idx++) {
 125                 subs = &as->substream[idx];
 126                 if (!subs->num_formats)
 127                         continue;
 128                 subs->data_endpoint = NULL;
 129                 subs->sync_endpoint = NULL;
 130         }
 131 }
 132
 133 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
 134 {
 135         struct usb_device *dev = chip->dev;
 136         struct usb_host_interface *alts;
 137         struct usb_interface_descriptor *altsd;
 138         struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
 139
 140         if (!iface) {
 141                 dev_err(&dev->dev, "%u:%d : does not exist\n",
 142                         ctrlif, interface);
 143                 return -EINVAL;
 144         }
 145
 146         alts = &iface->altsetting[0];
 147         altsd = get_iface_desc(alts);
 148
 149         /*
 150          * Android with both accessory and audio interfaces enabled gets the
 151          * interface numbers wrong.
 152          */
 153         if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
 154              chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
 155             interface == 0 &&
 156             altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
 157             altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
 158                 interface = 2;
 159                 iface = usb_ifnum_to_if(dev, interface);
 160                 if (!iface)
 161                         return -EINVAL;
 162                 alts = &iface->altsetting[0];
 163                 altsd = get_iface_desc(alts);
 164         }
 165
 166         if (usb_interface_claimed(iface)) {
 167                 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
 168                         ctrlif, interface);
 169                 return -EINVAL;
 170         }
 171
 172         if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
 173              altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
 174             altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
 175                 int err = __snd_usbmidi_create(chip->card, iface,
 176                                              &chip->midi_list, NULL,
 177                                              chip->usb_id);
 178                 if (err < 0) {
 179                         dev_err(&dev->dev,
 180                                 "%u:%d: cannot create sequencer device\n",
 181                                 ctrlif, interface);
 182                         return -EINVAL;
 183                 }
 184                 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
 185
 186                 return 0;
 187         }
 188
 189         if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
 190              altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
 191             altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
 192                 dev_dbg(&dev->dev,
 193                         "%u:%d: skipping non-supported interface %d\n",
 194                         ctrlif, interface, altsd->bInterfaceClass);
 195                 /* skip non-supported classes */
 196                 return -EINVAL;
 197         }
 198
 199         if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
 200                 dev_err(&dev->dev, "low speed audio streaming not supported\n");
 201                 return -EINVAL;
 202         }
 203
 204         if (! snd_usb_parse_audio_interface(chip, interface)) {
 205                 usb_set_interface(dev, interface, 0); /* reset the current interface */
 206                 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
 207         }
 208
 209         return 0;
 210 }
 211
 212 /*
 213  * parse audio control descriptor and create pcm/midi streams
 214  */
 215 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
 216 {
 217         struct usb_device *dev = chip->dev;
 218         struct usb_host_interface *host_iface;
 219         struct usb_interface_descriptor *altsd;
 220         int i, protocol;
 221
 222         /* find audiocontrol interface */
 223         host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
 224         altsd = get_iface_desc(host_iface);
 225         protocol = altsd->bInterfaceProtocol;
 226
 227         switch (protocol) {
 228         default:
 229                 dev_warn(&dev->dev,
 230                          "unknown interface protocol %#02x, assuming v1\n",
 231                          protocol);
 232                 fallthrough;
 233
 234         case UAC_VERSION_1: {
 235                 struct uac1_ac_header_descriptor *h1;
 236                 int rest_bytes;
 237
 238                 h1 = snd_usb_find_csint_desc(host_iface->extra,
 239                                                          host_iface->extralen,
 240                                                          NULL, UAC_HEADER);
 241                 if (!h1 || h1->bLength < sizeof(*h1)) {
 242                         dev_err(&dev->dev, "cannot find UAC_HEADER\n");
 243                         return -EINVAL;
 244                 }
 245
 246                 rest_bytes = (void *)(host_iface->extra +
 247                                 host_iface->extralen) - (void *)h1;
 248
 249                 /* just to be sure -- this shouldn't hit at all */
 250                 if (rest_bytes <= 0) {
 251                         dev_err(&dev->dev, "invalid control header\n");
 252                         return -EINVAL;
 253                 }
 254
 255                 if (rest_bytes < sizeof(*h1)) {
 256                         dev_err(&dev->dev, "too short v1 buffer descriptor\n");
 257                         return -EINVAL;
 258                 }
 259
 260                 if (!h1->bInCollection) {
 261                         dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
 262                         return -EINVAL;
 263                 }
 264
 265                 if (rest_bytes < h1->bLength) {
 266                         dev_err(&dev->dev, "invalid buffer length (v1)\n");
 267                         return -EINVAL;
 268                 }
 269
 270                 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
 271                         dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
 272                         return -EINVAL;
 273                 }
 274
 275                 for (i = 0; i < h1->bInCollection; i++)
 276                         snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
 277
 278                 break;
 279         }
 280
 281         case UAC_VERSION_2:
 282         case UAC_VERSION_3: {
 283                 struct usb_interface_assoc_descriptor *assoc =
 284                         usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
 285
 286                 if (!assoc) {
 287                         /*
 288                          * Firmware writers cannot count to three.  So to find
 289                          * the IAD on the NuForce UDH-100, also check the next
 290                          * interface.
 291                          */
 292                         struct usb_interface *iface =
 293                                 usb_ifnum_to_if(dev, ctrlif + 1);
 294                         if (iface &&
 295                             iface->intf_assoc &&
 296                             iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
 297                             iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
 298                                 assoc = iface->intf_assoc;
 299                 }
 300
 301                 if (!assoc) {
 302                         dev_err(&dev->dev, "Audio class v2/v3 interfaces need an interface association\n");
 303                         return -EINVAL;
 304                 }
 305
 306                 if (protocol == UAC_VERSION_3) {
 307                         int badd = assoc->bFunctionSubClass;
 308
 309                         if (badd != UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0 &&
 310                             (badd < UAC3_FUNCTION_SUBCLASS_GENERIC_IO ||
 311                              badd > UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE)) {
 312                                 dev_err(&dev->dev,
 313                                         "Unsupported UAC3 BADD profile\n");
 314                                 return -EINVAL;
 315                         }
 316
 317                         chip->badd_profile = badd;
 318                 }
 319
 320                 for (i = 0; i < assoc->bInterfaceCount; i++) {
 321                         int intf = assoc->bFirstInterface + i;
 322
 323                         if (intf != ctrlif)
 324                                 snd_usb_create_stream(chip, ctrlif, intf);
 325                 }
 326
 327                 break;
 328         }
 329         }
 330
 331         return 0;
 332 }
 333
 334 /*
 335  * Profile name preset table
 336  */
 337 struct usb_audio_device_name {
 338         u32 id;
 339         const char *vendor_name;
 340         const char *product_name;
 341         const char *profile_name;       /* override card->longname */
 342 };
 343
 344 #define PROFILE_NAME(vid, pid, vendor, product, profile)         \
 345         { .id = USB_ID(vid, pid), .vendor_name = (vendor),       \
 346           .product_name = (product), .profile_name = (profile) }
 347 #define DEVICE_NAME(vid, pid, vendor, product) \
 348         PROFILE_NAME(vid, pid, vendor, product, NULL)
 349
 350 /* vendor/product and profile name presets, sorted in device id order */
 351 static const struct usb_audio_device_name usb_audio_names[] = {
 352         /* HP Thunderbolt Dock Audio Headset */
 353         PROFILE_NAME(0x03f0, 0x0269, "HP", "Thunderbolt Dock Audio Headset",
 354                      "HP-Thunderbolt-Dock-Audio-Headset"),
 355         /* HP Thunderbolt Dock Audio Module */
 356         PROFILE_NAME(0x03f0, 0x0567, "HP", "Thunderbolt Dock Audio Module",
 357                      "HP-Thunderbolt-Dock-Audio-Module"),
 358
 359         /* Two entries for Gigabyte TRX40 Aorus Master:
 360          * TRX40 Aorus Master has two USB-audio devices, one for the front
 361          * headphone with ESS SABRE9218 DAC chip, while another for the rest
 362          * I/O (the rear panel and the front mic) with Realtek ALC1220-VB.
 363          * Here we provide two distinct names for making UCM profiles easier.
 364          */
 365         PROFILE_NAME(0x0414, 0xa000, "Gigabyte", "Aorus Master Front Headphone",
 366                      "Gigabyte-Aorus-Master-Front-Headphone"),
 367         PROFILE_NAME(0x0414, 0xa001, "Gigabyte", "Aorus Master Main Audio",
 368                      "Gigabyte-Aorus-Master-Main-Audio"),
 369
 370         /* Gigabyte TRX40 Aorus Pro WiFi */
 371         PROFILE_NAME(0x0414, 0xa002,
 372                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 373
 374         /* Creative/E-Mu devices */
 375         DEVICE_NAME(0x041e, 0x3010, "Creative Labs", "Sound Blaster MP3+"),
 376         /* Creative/Toshiba Multimedia Center SB-0500 */
 377         DEVICE_NAME(0x041e, 0x3048, "Toshiba", "SB-0500"),
 378
 379         DEVICE_NAME(0x046d, 0x0990, "Logitech, Inc.", "QuickCam Pro 9000"),
 380
 381         /* ASUS ROG Strix */
 382         PROFILE_NAME(0x0b05, 0x1917,
 383                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 384         /* ASUS PRIME TRX40 PRO-S */
 385         PROFILE_NAME(0x0b05, 0x1918,
 386                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 387
 388         /* Dell WD15 Dock */
 389         PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
 390         /* Dell WD19 Dock */
 391         PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
 392
 393         DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
 394
 395         /*
 396          * The original product_name is "USB Sound Device", however this name
 397          * is also used by the CM106 based cards, so make it unique.
 398          */
 399         DEVICE_NAME(0x0d8c, 0x0102, NULL, "ICUSBAUDIO7D"),
 400         DEVICE_NAME(0x0d8c, 0x0103, NULL, "Audio Advantage MicroII"),
 401
 402         /* MSI TRX40 Creator */
 403         PROFILE_NAME(0x0db0, 0x0d64,
 404                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 405         /* MSI TRX40 */
 406         PROFILE_NAME(0x0db0, 0x543d,
 407                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 408
 409         /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
 410         DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
 411         DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
 412
 413         /* aka. Serato Scratch Live DJ Box */
 414         DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
 415
 416         /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
 417         PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
 418                      "Lenovo-ThinkStation-P620-Rear"),
 419         /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
 420         PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
 421                      "Lenovo-ThinkStation-P620-Main"),
 422
 423         /* Asrock TRX40 Creator */
 424         PROFILE_NAME(0x26ce, 0x0a01,
 425                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 426
 427         { } /* terminator */
 428 };
 429
 430 static const struct usb_audio_device_name *
 431 lookup_device_name(u32 id)
 432 {
 433         static const struct usb_audio_device_name *p;
 434
 435         for (p = usb_audio_names; p->id; p++)
 436                 if (p->id == id)
 437                         return p;
 438         return NULL;
 439 }
 440
 441 /*
 442  * free the chip instance
 443  *
 444  * here we have to do not much, since pcm and controls are already freed
 445  *
 446  */
 447
 448 static void snd_usb_audio_free(struct snd_card *card)
 449 {
 450         struct snd_usb_audio *chip = card->private_data;
 451
 452         snd_usb_endpoint_free_all(chip);
 453
 454         mutex_destroy(&chip->mutex);
 455         if (!atomic_read(&chip->shutdown))
 456                 dev_set_drvdata(&chip->dev->dev, NULL);
 457 }
 458
 459 static void usb_audio_make_shortname(struct usb_device *dev,
 460                                      struct snd_usb_audio *chip,
 461                                      const struct snd_usb_audio_quirk *quirk)
 462 {
 463         struct snd_card *card = chip->card;
 464         const struct usb_audio_device_name *preset;
 465         const char *s = NULL;
 466
 467         preset = lookup_device_name(chip->usb_id);
 468         if (preset && preset->product_name)
 469                 s = preset->product_name;
 470         else if (quirk && quirk->product_name)
 471                 s = quirk->product_name;
 472         if (s && *s) {
 473                 strscpy(card->shortname, s, sizeof(card->shortname));
 474                 return;
 475         }
 476
 477         /* retrieve the device string as shortname */
 478         if (!dev->descriptor.iProduct ||
 479             usb_string(dev, dev->descriptor.iProduct,
 480                        card->shortname, sizeof(card->shortname)) <= 0) {
 481                 /* no name available from anywhere, so use ID */
 482                 sprintf(card->shortname, "USB Device %#04x:%#04x",
 483                         USB_ID_VENDOR(chip->usb_id),
 484                         USB_ID_PRODUCT(chip->usb_id));
 485         }
 486
 487         strim(card->shortname);
 488 }
 489
 490 static void usb_audio_make_longname(struct usb_device *dev,
 491                                     struct snd_usb_audio *chip,
 492                                     const struct snd_usb_audio_quirk *quirk)
 493 {
 494         struct snd_card *card = chip->card;
 495         const struct usb_audio_device_name *preset;
 496         const char *s = NULL;
 497         int len;
 498
 499         preset = lookup_device_name(chip->usb_id);
 500
 501         /* shortcut - if any pre-defined string is given, use it */
 502         if (preset && preset->profile_name)
 503                 s = preset->profile_name;
 504         if (s && *s) {
 505                 strscpy(card->longname, s, sizeof(card->longname));
 506                 return;
 507         }
 508
 509         if (preset && preset->vendor_name)
 510                 s = preset->vendor_name;
 511         else if (quirk && quirk->vendor_name)
 512                 s = quirk->vendor_name;
 513         *card->longname = 0;
 514         if (s && *s) {
 515                 strscpy(card->longname, s, sizeof(card->longname));
 516         } else {
 517                 /* retrieve the vendor and device strings as longname */
 518                 if (dev->descriptor.iManufacturer)
 519                         usb_string(dev, dev->descriptor.iManufacturer,
 520                                    card->longname, sizeof(card->longname));
 521                 /* we don't really care if there isn't any vendor string */
 522         }
 523         if (*card->longname) {
 524                 strim(card->longname);
 525                 if (*card->longname)
 526                         strlcat(card->longname, " ", sizeof(card->longname));
 527         }
 528
 529         strlcat(card->longname, card->shortname, sizeof(card->longname));
 530
 531         len = strlcat(card->longname, " at ", sizeof(card->longname));
 532
 533         if (len < sizeof(card->longname))
 534                 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
 535
 536         switch (snd_usb_get_speed(dev)) {
 537         case USB_SPEED_LOW:
 538                 strlcat(card->longname, ", low speed", sizeof(card->longname));
 539                 break;
 540         case USB_SPEED_FULL:
 541                 strlcat(card->longname, ", full speed", sizeof(card->longname));
 542                 break;
 543         case USB_SPEED_HIGH:
 544                 strlcat(card->longname, ", high speed", sizeof(card->longname));
 545                 break;
 546         case USB_SPEED_SUPER:
 547                 strlcat(card->longname, ", super speed", sizeof(card->longname));
 548                 break;
 549         case USB_SPEED_SUPER_PLUS:
 550                 strlcat(card->longname, ", super speed plus", sizeof(card->longname));
 551                 break;
 552         default:
 553                 break;
 554         }
 555 }
 556
 557 /*
 558  * create a chip instance and set its names.
 559  */
 560 static int snd_usb_audio_create(struct usb_interface *intf,
 561                                 struct usb_device *dev, int idx,
 562                                 const struct snd_usb_audio_quirk *quirk,
 563                                 unsigned int usb_id,
 564                                 struct snd_usb_audio **rchip)
 565 {
 566         struct snd_card *card;
 567         struct snd_usb_audio *chip;
 568         int err;
 569         char component[14];
 570
 571         *rchip = NULL;
 572
 573         switch (snd_usb_get_speed(dev)) {
 574         case USB_SPEED_LOW:
 575         case USB_SPEED_FULL:
 576         case USB_SPEED_HIGH:
 577         case USB_SPEED_WIRELESS:
 578         case USB_SPEED_SUPER:
 579         case USB_SPEED_SUPER_PLUS:
 580                 break;
 581         default:
 582                 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
 583                 return -ENXIO;
 584         }
 585
 586         err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
 587                            sizeof(*chip), &card);
 588         if (err < 0) {
 589                 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
 590                 return err;
 591         }
 592
 593         chip = card->private_data;
 594         mutex_init(&chip->mutex);
 595         init_waitqueue_head(&chip->shutdown_wait);
 596         chip->index = idx;
 597         chip->dev = dev;
 598         chip->card = card;
 599         chip->setup = device_setup[idx];
 600         chip->generic_implicit_fb = implicit_fb[idx];
 601         chip->autoclock = autoclock;
 602         atomic_set(&chip->active, 1); /* avoid autopm during probing */
 603         atomic_set(&chip->usage_count, 0);
 604         atomic_set(&chip->shutdown, 0);
 605
 606         chip->usb_id = usb_id;
 607         INIT_LIST_HEAD(&chip->pcm_list);
 608         INIT_LIST_HEAD(&chip->ep_list);
 609         INIT_LIST_HEAD(&chip->iface_ref_list);
 610         INIT_LIST_HEAD(&chip->midi_list);
 611         INIT_LIST_HEAD(&chip->mixer_list);
 612
 613         card->private_free = snd_usb_audio_free;
 614
 615         strcpy(card->driver, "USB-Audio");
 616         sprintf(component, "USB%04x:%04x",
 617                 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
 618         snd_component_add(card, component);
 619
 620         usb_audio_make_shortname(dev, chip, quirk);
 621         usb_audio_make_longname(dev, chip, quirk);
 622
 623         snd_usb_audio_create_proc(chip);
 624
 625         *rchip = chip;
 626         return 0;
 627 }
 628
 629 /* look for a matching quirk alias id */
 630 static bool get_alias_id(struct usb_device *dev, unsigned int *id)
 631 {
 632         int i;
 633         unsigned int src, dst;
 634
 635         for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
 636                 if (!quirk_alias[i] ||
 637                     sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
 638                     src != *id)
 639                         continue;
 640                 dev_info(&dev->dev,
 641                          "device (%04x:%04x): applying quirk alias %04x:%04x\n",
 642                          USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
 643                          USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
 644                 *id = dst;
 645                 return true;
 646         }
 647
 648         return false;
 649 }
 650
 651 static bool check_delayed_register_option(struct snd_usb_audio *chip, int iface)
 652 {
 653         int i;
 654         unsigned int id, inum;
 655
 656         for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {
 657                 if (delayed_register[i] &&
 658                     sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&
 659                     id == chip->usb_id)
 660                         return inum != iface;
 661         }
 662
 663         return false;
 664 }
 665
 666 static const struct usb_device_id usb_audio_ids[]; /* defined below */
 667
 668 /* look for the corresponding quirk */
 669 static const struct snd_usb_audio_quirk *
 670 get_alias_quirk(struct usb_device *dev, unsigned int id)
 671 {
 672         const struct usb_device_id *p;
 673
 674         for (p = usb_audio_ids; p->match_flags; p++) {
 675                 /* FIXME: this checks only vendor:product pair in the list */
 676                 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
 677                     USB_DEVICE_ID_MATCH_DEVICE &&
 678                     p->idVendor == USB_ID_VENDOR(id) &&
 679                     p->idProduct == USB_ID_PRODUCT(id))
 680                         return (const struct snd_usb_audio_quirk *)p->driver_info;
 681         }
 682
 683         return NULL;
 684 }
 685
 686 /*
 687  * probe the active usb device
 688  *
 689  * note that this can be called multiple times per a device, when it
 690  * includes multiple audio control interfaces.
 691  *
 692  * thus we check the usb device pointer and creates the card instance
 693  * only at the first time.  the successive calls of this function will
 694  * append the pcm interface to the corresponding card.
 695  */
 696 static int usb_audio_probe(struct usb_interface *intf,
 697                            const struct usb_device_id *usb_id)
 698 {
 699         struct usb_device *dev = interface_to_usbdev(intf);
 700         const struct snd_usb_audio_quirk *quirk =
 701                 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
 702         struct snd_usb_audio *chip;
 703         int i, err;
 704         struct usb_host_interface *alts;
 705         int ifnum;
 706         u32 id;
 707
 708         alts = &intf->altsetting[0];
 709         ifnum = get_iface_desc(alts)->bInterfaceNumber;
 710         id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
 711                     le16_to_cpu(dev->descriptor.idProduct));
 712         if (get_alias_id(dev, &id))
 713                 quirk = get_alias_quirk(dev, id);
 714         if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
 715                 return -ENXIO;
 716
 717         err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
 718         if (err < 0)
 719                 return err;
 720
 721         /*
 722          * found a config.  now register to ALSA
 723          */
 724
 725         /* check whether it's already registered */
 726         chip = NULL;
 727         mutex_lock(&register_mutex);
 728         for (i = 0; i < SNDRV_CARDS; i++) {
 729                 if (usb_chip[i] && usb_chip[i]->dev == dev) {
 730                         if (atomic_read(&usb_chip[i]->shutdown)) {
 731                                 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
 732                                 err = -EIO;
 733                                 goto __error;
 734                         }
 735                         chip = usb_chip[i];
 736                         atomic_inc(&chip->active); /* avoid autopm */
 737                         break;
 738                 }
 739         }
 740         if (! chip) {
 741                 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
 742                 if (err < 0)
 743                         goto __error;
 744
 745                 /* it's a fresh one.
 746                  * now look for an empty slot and create a new card instance
 747                  */
 748                 for (i = 0; i < SNDRV_CARDS; i++)
 749                         if (!usb_chip[i] &&
 750                             (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
 751                             (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
 752                                 if (enable[i]) {
 753                                         err = snd_usb_audio_create(intf, dev, i, quirk,
 754                                                                    id, &chip);
 755                                         if (err < 0)
 756                                                 goto __error;
 757                                         break;
 758                                 } else if (vid[i] != -1 || pid[i] != -1) {
 759                                         dev_info(&dev->dev,
 760                                                  "device (%04x:%04x) is disabled\n",
 761                                                  USB_ID_VENDOR(id),
 762                                                  USB_ID_PRODUCT(id));
 763                                         err = -ENOENT;
 764                                         goto __error;
 765                                 }
 766                         }
 767                 if (!chip) {
 768                         dev_err(&dev->dev, "no available usb audio device\n");
 769                         err = -ENODEV;
 770                         goto __error;
 771                 }
 772         }
 773
 774         if (chip->num_interfaces >= MAX_CARD_INTERFACES) {
 775                 dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");
 776                 err = -EINVAL;
 777                 goto __error;
 778         }
 779
 780         dev_set_drvdata(&dev->dev, chip);
 781
 782         /*
 783          * For devices with more than one control interface, we assume the
 784          * first contains the audio controls. We might need a more specific
 785          * check here in the future.
 786          */
 787         if (!chip->ctrl_intf)
 788                 chip->ctrl_intf = alts;
 789
 790         chip->txfr_quirk = 0;
 791         err = 1; /* continue */
 792         if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
 793                 /* need some special handlings */
 794                 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
 795                 if (err < 0)
 796                         goto __error;
 797         }
 798
 799         if (err > 0) {
 800                 /* create normal USB audio interfaces */
 801                 err = snd_usb_create_streams(chip, ifnum);
 802                 if (err < 0)
 803                         goto __error;
 804                 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
 805                 if (err < 0)
 806                         goto __error;
 807         }
 808
 809         if (chip->need_delayed_register) {
 810                 dev_info(&dev->dev,
 811                          "Found post-registration device assignment: %08x:%02x\n",
 812                          chip->usb_id, ifnum);
 813                 chip->need_delayed_register = false; /* clear again */
 814         }
 815
 816         /* we are allowed to call snd_card_register() many times, but first
 817          * check to see if a device needs to skip it or do anything special
 818          */
 819         if (!snd_usb_registration_quirk(chip, ifnum) &&
 820             !check_delayed_register_option(chip, ifnum)) {
 821                 err = snd_card_register(chip->card);
 822                 if (err < 0)
 823                         goto __error;
 824         }
 825
 826         if (quirk && quirk->shares_media_device) {
 827                 /* don't want to fail when snd_media_device_create() fails */
 828                 snd_media_device_create(chip, intf);
 829         }
 830
 831         if (quirk)
 832                 chip->quirk_type = quirk->type;
 833
 834         usb_chip[chip->index] = chip;
 835         chip->intf[chip->num_interfaces] = intf;
 836         chip->num_interfaces++;
 837         usb_set_intfdata(intf, chip);
 838         atomic_dec(&chip->active);
 839         mutex_unlock(&register_mutex);
 840         return 0;
 841
 842  __error:
 843         if (chip) {
 844                 /* chip->active is inside the chip->card object,
 845                  * decrement before memory is possibly returned.
 846                  */
 847                 atomic_dec(&chip->active);
 848                 if (!chip->num_interfaces)
 849                         snd_card_free(chip->card);
 850         }
 851         mutex_unlock(&register_mutex);
 852         return err;
 853 }
 854
 855 /*
 856  * we need to take care of counter, since disconnection can be called also
 857  * many times as well as usb_audio_probe().
 858  */
 859 static void usb_audio_disconnect(struct usb_interface *intf)
 860 {
 861         struct snd_usb_audio *chip = usb_get_intfdata(intf);
 862         struct snd_card *card;
 863         struct list_head *p;
 864
 865         if (chip == (void *)-1L)
 866                 return;
 867
 868         card = chip->card;
 869
 870         mutex_lock(&register_mutex);
 871         if (atomic_inc_return(&chip->shutdown) == 1) {
 872                 struct snd_usb_stream *as;
 873                 struct snd_usb_endpoint *ep;
 874                 struct usb_mixer_interface *mixer;
 875
 876                 /* wait until all pending tasks done;
 877                  * they are protected by snd_usb_lock_shutdown()
 878                  */
 879                 wait_event(chip->shutdown_wait,
 880                            !atomic_read(&chip->usage_count));
 881                 snd_card_disconnect(card);
 882                 /* release the pcm resources */
 883                 list_for_each_entry(as, &chip->pcm_list, list) {
 884                         snd_usb_stream_disconnect(as);
 885                 }
 886                 /* release the endpoint resources */
 887                 list_for_each_entry(ep, &chip->ep_list, list) {
 888                         snd_usb_endpoint_release(ep);
 889                 }
 890                 /* release the midi resources */
 891                 list_for_each(p, &chip->midi_list) {
 892                         snd_usbmidi_disconnect(p);
 893                 }
 894                 /*
 895                  * Nice to check quirk && quirk->shares_media_device and
 896                  * then call the snd_media_device_delete(). Don't have
 897                  * access to the quirk here. snd_media_device_delete()
 898                  * accesses mixer_list
 899                  */
 900                 snd_media_device_delete(chip);
 901
 902                 /* release mixer resources */
 903                 list_for_each_entry(mixer, &chip->mixer_list, list) {
 904                         snd_usb_mixer_disconnect(mixer);
 905                 }
 906         }
 907
 908         if (chip->quirk_type & QUIRK_SETUP_DISABLE_AUTOSUSPEND)
 909                 usb_enable_autosuspend(interface_to_usbdev(intf));
 910
 911         chip->num_interfaces--;
 912         if (chip->num_interfaces <= 0) {
 913                 usb_chip[chip->index] = NULL;
 914                 mutex_unlock(&register_mutex);
 915                 snd_card_free_when_closed(card);
 916         } else {
 917                 mutex_unlock(&register_mutex);
 918         }
 919 }
 920
 921 /* lock the shutdown (disconnect) task and autoresume */
 922 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
 923 {
 924         int err;
 925
 926         atomic_inc(&chip->usage_count);
 927         if (atomic_read(&chip->shutdown)) {
 928                 err = -EIO;
 929                 goto error;
 930         }
 931         err = snd_usb_autoresume(chip);
 932         if (err < 0)
 933                 goto error;
 934         return 0;
 935
 936  error:
 937         if (atomic_dec_and_test(&chip->usage_count))
 938                 wake_up(&chip->shutdown_wait);
 939         return err;
 940 }
 941
 942 /* autosuspend and unlock the shutdown */
 943 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
 944 {
 945         snd_usb_autosuspend(chip);
 946         if (atomic_dec_and_test(&chip->usage_count))
 947                 wake_up(&chip->shutdown_wait);
 948 }
 949
 950 #ifdef CONFIG_PM
 951
 952 int snd_usb_autoresume(struct snd_usb_audio *chip)
 953 {
 954         int i, err;
 955
 956         if (atomic_read(&chip->shutdown))
 957                 return -EIO;
 958         if (atomic_inc_return(&chip->active) != 1)
 959                 return 0;
 960
 961         for (i = 0; i < chip->num_interfaces; i++) {
 962                 err = usb_autopm_get_interface(chip->intf[i]);
 963                 if (err < 0) {
 964                         /* rollback */
 965                         while (--i >= 0)
 966                                 usb_autopm_put_interface(chip->intf[i]);
 967                         atomic_dec(&chip->active);
 968                         return err;
 969                 }
 970         }
 971         return 0;
 972 }
 973
 974 void snd_usb_autosuspend(struct snd_usb_audio *chip)
 975 {
 976         int i;
 977
 978         if (atomic_read(&chip->shutdown))
 979                 return;
 980         if (!atomic_dec_and_test(&chip->active))
 981                 return;
 982
 983         for (i = 0; i < chip->num_interfaces; i++)
 984                 usb_autopm_put_interface(chip->intf[i]);
 985 }
 986
 987 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
 988 {
 989         struct snd_usb_audio *chip = usb_get_intfdata(intf);
 990         struct snd_usb_stream *as;
 991         struct snd_usb_endpoint *ep;
 992         struct usb_mixer_interface *mixer;
 993         struct list_head *p;
 994
 995         if (chip == (void *)-1L)
 996                 return 0;
 997
 998         if (!chip->num_suspended_intf++) {
 999                 list_for_each_entry(as, &chip->pcm_list, list)
1000                         snd_usb_pcm_suspend(as);
1001                 list_for_each_entry(ep, &chip->ep_list, list)
1002                         snd_usb_endpoint_suspend(ep);
1003                 list_for_each(p, &chip->midi_list)
1004                         snd_usbmidi_suspend(p);
1005                 list_for_each_entry(mixer, &chip->mixer_list, list)
1006                         snd_usb_mixer_suspend(mixer);
1007         }
1008
1009         if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
1010                 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
1011                 chip->system_suspend = chip->num_suspended_intf;
1012         }
1013
1014         return 0;
1015 }
1016
1017 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
1018 {
1019         struct snd_usb_audio *chip = usb_get_intfdata(intf);
1020         struct snd_usb_stream *as;
1021         struct usb_mixer_interface *mixer;
1022         struct list_head *p;
1023         int err = 0;
1024
1025         if (chip == (void *)-1L)
1026                 return 0;
1027
1028         atomic_inc(&chip->active); /* avoid autopm */
1029         if (chip->num_suspended_intf > 1)
1030                 goto out;
1031
1032         list_for_each_entry(as, &chip->pcm_list, list) {
1033                 err = snd_usb_pcm_resume(as);
1034                 if (err < 0)
1035                         goto err_out;
1036         }
1037
1038         /*
1039          * ALSA leaves material resumption to user space
1040          * we just notify and restart the mixers
1041          */
1042         list_for_each_entry(mixer, &chip->mixer_list, list) {
1043                 err = snd_usb_mixer_resume(mixer, reset_resume);
1044                 if (err < 0)
1045                         goto err_out;
1046         }
1047
1048         list_for_each(p, &chip->midi_list) {
1049                 snd_usbmidi_resume(p);
1050         }
1051
1052  out:
1053         if (chip->num_suspended_intf == chip->system_suspend) {
1054                 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
1055                 chip->system_suspend = 0;
1056         }
1057         chip->num_suspended_intf--;
1058
1059 err_out:
1060         atomic_dec(&chip->active); /* allow autopm after this point */
1061         return err;
1062 }
1063
1064 static int usb_audio_resume(struct usb_interface *intf)
1065 {
1066         return __usb_audio_resume(intf, false);
1067 }
1068
1069 static int usb_audio_reset_resume(struct usb_interface *intf)
1070 {
1071         return __usb_audio_resume(intf, true);
1072 }
1073 #else
1074 #define usb_audio_suspend       NULL
1075 #define usb_audio_resume        NULL
1076 #define usb_audio_reset_resume  NULL
1077 #endif          /* CONFIG_PM */
1078
1079 static const struct usb_device_id usb_audio_ids [] = {
1080 #include "quirks-table.h"
1081     { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1082       .bInterfaceClass = USB_CLASS_AUDIO,
1083       .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
1084     { }                                         /* Terminating entry */
1085 };
1086 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
1087
1088 /*
1089  * entry point for linux usb interface
1090  */
1091
1092 static struct usb_driver usb_audio_driver = {
1093         .name =         "snd-usb-audio",
1094         .probe =        usb_audio_probe,
1095         .disconnect =   usb_audio_disconnect,
1096         .suspend =      usb_audio_suspend,
1097         .resume =       usb_audio_resume,
1098         .reset_resume = usb_audio_reset_resume,
1099         .id_table =     usb_audio_ids,
1100         .supports_autosuspend = 1,
1101 };
1102
1103 module_usb_driver(usb_audio_driver);