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