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                 return usb_driver_claim_interface(&usb_audio_driver, iface,
 185                                                   USB_AUDIO_IFACE_UNUSED);
 186         }
 187
 188         if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
 189              altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
 190             altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
 191                 dev_dbg(&dev->dev,
 192                         "%u:%d: skipping non-supported interface %d\n",
 193                         ctrlif, interface, altsd->bInterfaceClass);
 194                 /* skip non-supported classes */
 195                 return -EINVAL;
 196         }
 197
 198         if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
 199                 dev_err(&dev->dev, "low speed audio streaming not supported\n");
 200                 return -EINVAL;
 201         }
 202
 203         if (! snd_usb_parse_audio_interface(chip, interface)) {
 204                 usb_set_interface(dev, interface, 0); /* reset the current interface */
 205                 return usb_driver_claim_interface(&usb_audio_driver, iface,
 206                                                   USB_AUDIO_IFACE_UNUSED);
 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         DEVICE_NAME(0x05e1, 0x0408, "Syntek", "STK1160"),
 382         DEVICE_NAME(0x05e1, 0x0480, "Hauppauge", "Woodbury"),
 383
 384         /* ASUS ROG Strix */
 385         PROFILE_NAME(0x0b05, 0x1917,
 386                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 387         /* ASUS PRIME TRX40 PRO-S */
 388         PROFILE_NAME(0x0b05, 0x1918,
 389                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 390
 391         /* Dell WD15 Dock */
 392         PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
 393         /* Dell WD19 Dock */
 394         PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
 395
 396         DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
 397
 398         /*
 399          * The original product_name is "USB Sound Device", however this name
 400          * is also used by the CM106 based cards, so make it unique.
 401          */
 402         DEVICE_NAME(0x0d8c, 0x0102, NULL, "ICUSBAUDIO7D"),
 403         DEVICE_NAME(0x0d8c, 0x0103, NULL, "Audio Advantage MicroII"),
 404
 405         /* MSI TRX40 Creator */
 406         PROFILE_NAME(0x0db0, 0x0d64,
 407                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 408         /* MSI TRX40 */
 409         PROFILE_NAME(0x0db0, 0x543d,
 410                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 411
 412         DEVICE_NAME(0x0fd9, 0x0008, "Hauppauge", "HVR-950Q"),
 413
 414         /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
 415         DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
 416         DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
 417
 418         /* aka. Serato Scratch Live DJ Box */
 419         DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
 420
 421         /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
 422         PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
 423                      "Lenovo-ThinkStation-P620-Rear"),
 424         /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
 425         PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
 426                      "Lenovo-ThinkStation-P620-Main"),
 427
 428         /* Asrock TRX40 Creator */
 429         PROFILE_NAME(0x26ce, 0x0a01,
 430                      "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
 431
 432         DEVICE_NAME(0x2040, 0x7200, "Hauppauge", "HVR-950Q"),
 433         DEVICE_NAME(0x2040, 0x7201, "Hauppauge", "HVR-950Q-MXL"),
 434         DEVICE_NAME(0x2040, 0x7210, "Hauppauge", "HVR-950Q"),
 435         DEVICE_NAME(0x2040, 0x7211, "Hauppauge", "HVR-950Q-MXL"),
 436         DEVICE_NAME(0x2040, 0x7213, "Hauppauge", "HVR-950Q"),
 437         DEVICE_NAME(0x2040, 0x7217, "Hauppauge", "HVR-950Q"),
 438         DEVICE_NAME(0x2040, 0x721b, "Hauppauge", "HVR-950Q"),
 439         DEVICE_NAME(0x2040, 0x721e, "Hauppauge", "HVR-950Q"),
 440         DEVICE_NAME(0x2040, 0x721f, "Hauppauge", "HVR-950Q"),
 441         DEVICE_NAME(0x2040, 0x7240, "Hauppauge", "HVR-850"),
 442         DEVICE_NAME(0x2040, 0x7260, "Hauppauge", "HVR-950Q"),
 443         DEVICE_NAME(0x2040, 0x7270, "Hauppauge", "HVR-950Q"),
 444         DEVICE_NAME(0x2040, 0x7280, "Hauppauge", "HVR-950Q"),
 445         DEVICE_NAME(0x2040, 0x7281, "Hauppauge", "HVR-950Q-MXL"),
 446         DEVICE_NAME(0x2040, 0x8200, "Hauppauge", "Woodbury"),
 447
 448         { } /* terminator */
 449 };
 450
 451 static const struct usb_audio_device_name *
 452 lookup_device_name(u32 id)
 453 {
 454         static const struct usb_audio_device_name *p;
 455
 456         for (p = usb_audio_names; p->id; p++)
 457                 if (p->id == id)
 458                         return p;
 459         return NULL;
 460 }
 461
 462 /*
 463  * free the chip instance
 464  *
 465  * here we have to do not much, since pcm and controls are already freed
 466  *
 467  */
 468
 469 static void snd_usb_audio_free(struct snd_card *card)
 470 {
 471         struct snd_usb_audio *chip = card->private_data;
 472
 473         snd_usb_endpoint_free_all(chip);
 474
 475         mutex_destroy(&chip->mutex);
 476         if (!atomic_read(&chip->shutdown))
 477                 dev_set_drvdata(&chip->dev->dev, NULL);
 478 }
 479
 480 static void usb_audio_make_shortname(struct usb_device *dev,
 481                                      struct snd_usb_audio *chip,
 482                                      const struct snd_usb_audio_quirk *quirk)
 483 {
 484         struct snd_card *card = chip->card;
 485         const struct usb_audio_device_name *preset;
 486         const char *s = NULL;
 487
 488         preset = lookup_device_name(chip->usb_id);
 489         if (preset && preset->product_name)
 490                 s = preset->product_name;
 491         else if (quirk && quirk->product_name)
 492                 s = quirk->product_name;
 493         if (s && *s) {
 494                 strscpy(card->shortname, s, sizeof(card->shortname));
 495                 return;
 496         }
 497
 498         /* retrieve the device string as shortname */
 499         if (!dev->descriptor.iProduct ||
 500             usb_string(dev, dev->descriptor.iProduct,
 501                        card->shortname, sizeof(card->shortname)) <= 0) {
 502                 /* no name available from anywhere, so use ID */
 503                 sprintf(card->shortname, "USB Device %#04x:%#04x",
 504                         USB_ID_VENDOR(chip->usb_id),
 505                         USB_ID_PRODUCT(chip->usb_id));
 506         }
 507
 508         strim(card->shortname);
 509 }
 510
 511 static void usb_audio_make_longname(struct usb_device *dev,
 512                                     struct snd_usb_audio *chip,
 513                                     const struct snd_usb_audio_quirk *quirk)
 514 {
 515         struct snd_card *card = chip->card;
 516         const struct usb_audio_device_name *preset;
 517         const char *s = NULL;
 518         int len;
 519
 520         preset = lookup_device_name(chip->usb_id);
 521
 522         /* shortcut - if any pre-defined string is given, use it */
 523         if (preset && preset->profile_name)
 524                 s = preset->profile_name;
 525         if (s && *s) {
 526                 strscpy(card->longname, s, sizeof(card->longname));
 527                 return;
 528         }
 529
 530         if (preset && preset->vendor_name)
 531                 s = preset->vendor_name;
 532         else if (quirk && quirk->vendor_name)
 533                 s = quirk->vendor_name;
 534         *card->longname = 0;
 535         if (s && *s) {
 536                 strscpy(card->longname, s, sizeof(card->longname));
 537         } else {
 538                 /* retrieve the vendor and device strings as longname */
 539                 if (dev->descriptor.iManufacturer)
 540                         usb_string(dev, dev->descriptor.iManufacturer,
 541                                    card->longname, sizeof(card->longname));
 542                 /* we don't really care if there isn't any vendor string */
 543         }
 544         if (*card->longname) {
 545                 strim(card->longname);
 546                 if (*card->longname)
 547                         strlcat(card->longname, " ", sizeof(card->longname));
 548         }
 549
 550         strlcat(card->longname, card->shortname, sizeof(card->longname));
 551
 552         len = strlcat(card->longname, " at ", sizeof(card->longname));
 553
 554         if (len < sizeof(card->longname))
 555                 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
 556
 557         switch (snd_usb_get_speed(dev)) {
 558         case USB_SPEED_LOW:
 559                 strlcat(card->longname, ", low speed", sizeof(card->longname));
 560                 break;
 561         case USB_SPEED_FULL:
 562                 strlcat(card->longname, ", full speed", sizeof(card->longname));
 563                 break;
 564         case USB_SPEED_HIGH:
 565                 strlcat(card->longname, ", high speed", sizeof(card->longname));
 566                 break;
 567         case USB_SPEED_SUPER:
 568                 strlcat(card->longname, ", super speed", sizeof(card->longname));
 569                 break;
 570         case USB_SPEED_SUPER_PLUS:
 571                 strlcat(card->longname, ", super speed plus", sizeof(card->longname));
 572                 break;
 573         default:
 574                 break;
 575         }
 576 }
 577
 578 /*
 579  * create a chip instance and set its names.
 580  */
 581 static int snd_usb_audio_create(struct usb_interface *intf,
 582                                 struct usb_device *dev, int idx,
 583                                 const struct snd_usb_audio_quirk *quirk,
 584                                 unsigned int usb_id,
 585                                 struct snd_usb_audio **rchip)
 586 {
 587         struct snd_card *card;
 588         struct snd_usb_audio *chip;
 589         int err;
 590         char component[14];
 591
 592         *rchip = NULL;
 593
 594         switch (snd_usb_get_speed(dev)) {
 595         case USB_SPEED_LOW:
 596         case USB_SPEED_FULL:
 597         case USB_SPEED_HIGH:
 598         case USB_SPEED_WIRELESS:
 599         case USB_SPEED_SUPER:
 600         case USB_SPEED_SUPER_PLUS:
 601                 break;
 602         default:
 603                 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
 604                 return -ENXIO;
 605         }
 606
 607         err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
 608                            sizeof(*chip), &card);
 609         if (err < 0) {
 610                 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
 611                 return err;
 612         }
 613
 614         chip = card->private_data;
 615         mutex_init(&chip->mutex);
 616         init_waitqueue_head(&chip->shutdown_wait);
 617         chip->index = idx;
 618         chip->dev = dev;
 619         chip->card = card;
 620         chip->setup = device_setup[idx];
 621         chip->generic_implicit_fb = implicit_fb[idx];
 622         chip->autoclock = autoclock;
 623         atomic_set(&chip->active, 1); /* avoid autopm during probing */
 624         atomic_set(&chip->usage_count, 0);
 625         atomic_set(&chip->shutdown, 0);
 626
 627         chip->usb_id = usb_id;
 628         INIT_LIST_HEAD(&chip->pcm_list);
 629         INIT_LIST_HEAD(&chip->ep_list);
 630         INIT_LIST_HEAD(&chip->iface_ref_list);
 631         INIT_LIST_HEAD(&chip->midi_list);
 632         INIT_LIST_HEAD(&chip->mixer_list);
 633
 634         snd_usb_init_quirk_flags(chip);
 635
 636         card->private_free = snd_usb_audio_free;
 637
 638         strcpy(card->driver, "USB-Audio");
 639         sprintf(component, "USB%04x:%04x",
 640                 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
 641         snd_component_add(card, component);
 642
 643         usb_audio_make_shortname(dev, chip, quirk);
 644         usb_audio_make_longname(dev, chip, quirk);
 645
 646         snd_usb_audio_create_proc(chip);
 647
 648         *rchip = chip;
 649         return 0;
 650 }
 651
 652 /* look for a matching quirk alias id */
 653 static bool get_alias_id(struct usb_device *dev, unsigned int *id)
 654 {
 655         int i;
 656         unsigned int src, dst;
 657
 658         for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
 659                 if (!quirk_alias[i] ||
 660                     sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
 661                     src != *id)
 662                         continue;
 663                 dev_info(&dev->dev,
 664                          "device (%04x:%04x): applying quirk alias %04x:%04x\n",
 665                          USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
 666                          USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
 667                 *id = dst;
 668                 return true;
 669         }
 670
 671         return false;
 672 }
 673
 674 static bool check_delayed_register_option(struct snd_usb_audio *chip, int iface)
 675 {
 676         int i;
 677         unsigned int id, inum;
 678
 679         for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {
 680                 if (delayed_register[i] &&
 681                     sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&
 682                     id == chip->usb_id)
 683                         return inum != iface;
 684         }
 685
 686         return false;
 687 }
 688
 689 static const struct usb_device_id usb_audio_ids[]; /* defined below */
 690
 691 /* look for the corresponding quirk */
 692 static const struct snd_usb_audio_quirk *
 693 get_alias_quirk(struct usb_device *dev, unsigned int id)
 694 {
 695         const struct usb_device_id *p;
 696
 697         for (p = usb_audio_ids; p->match_flags; p++) {
 698                 /* FIXME: this checks only vendor:product pair in the list */
 699                 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
 700                     USB_DEVICE_ID_MATCH_DEVICE &&
 701                     p->idVendor == USB_ID_VENDOR(id) &&
 702                     p->idProduct == USB_ID_PRODUCT(id))
 703                         return (const struct snd_usb_audio_quirk *)p->driver_info;
 704         }
 705
 706         return NULL;
 707 }
 708
 709 /*
 710  * probe the active usb device
 711  *
 712  * note that this can be called multiple times per a device, when it
 713  * includes multiple audio control interfaces.
 714  *
 715  * thus we check the usb device pointer and creates the card instance
 716  * only at the first time.  the successive calls of this function will
 717  * append the pcm interface to the corresponding card.
 718  */
 719 static int usb_audio_probe(struct usb_interface *intf,
 720                            const struct usb_device_id *usb_id)
 721 {
 722         struct usb_device *dev = interface_to_usbdev(intf);
 723         const struct snd_usb_audio_quirk *quirk =
 724                 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
 725         struct snd_usb_audio *chip;
 726         int i, err;
 727         struct usb_host_interface *alts;
 728         int ifnum;
 729         u32 id;
 730
 731         alts = &intf->altsetting[0];
 732         ifnum = get_iface_desc(alts)->bInterfaceNumber;
 733         id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
 734                     le16_to_cpu(dev->descriptor.idProduct));
 735         if (get_alias_id(dev, &id))
 736                 quirk = get_alias_quirk(dev, id);
 737         if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
 738                 return -ENXIO;
 739         if (quirk && quirk->ifnum == QUIRK_NODEV_INTERFACE)
 740                 return -ENODEV;
 741
 742         err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
 743         if (err < 0)
 744                 return err;
 745
 746         /*
 747          * found a config.  now register to ALSA
 748          */
 749
 750         /* check whether it's already registered */
 751         chip = NULL;
 752         mutex_lock(&register_mutex);
 753         for (i = 0; i < SNDRV_CARDS; i++) {
 754                 if (usb_chip[i] && usb_chip[i]->dev == dev) {
 755                         if (atomic_read(&usb_chip[i]->shutdown)) {
 756                                 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
 757                                 err = -EIO;
 758                                 goto __error;
 759                         }
 760                         chip = usb_chip[i];
 761                         atomic_inc(&chip->active); /* avoid autopm */
 762                         break;
 763                 }
 764         }
 765         if (! chip) {
 766                 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
 767                 if (err < 0)
 768                         goto __error;
 769
 770                 /* it's a fresh one.
 771                  * now look for an empty slot and create a new card instance
 772                  */
 773                 for (i = 0; i < SNDRV_CARDS; i++)
 774                         if (!usb_chip[i] &&
 775                             (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
 776                             (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
 777                                 if (enable[i]) {
 778                                         err = snd_usb_audio_create(intf, dev, i, quirk,
 779                                                                    id, &chip);
 780                                         if (err < 0)
 781                                                 goto __error;
 782                                         break;
 783                                 } else if (vid[i] != -1 || pid[i] != -1) {
 784                                         dev_info(&dev->dev,
 785                                                  "device (%04x:%04x) is disabled\n",
 786                                                  USB_ID_VENDOR(id),
 787                                                  USB_ID_PRODUCT(id));
 788                                         err = -ENOENT;
 789                                         goto __error;
 790                                 }
 791                         }
 792                 if (!chip) {
 793                         dev_err(&dev->dev, "no available usb audio device\n");
 794                         err = -ENODEV;
 795                         goto __error;
 796                 }
 797         }
 798
 799         if (chip->num_interfaces >= MAX_CARD_INTERFACES) {
 800                 dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");
 801                 err = -EINVAL;
 802                 goto __error;
 803         }
 804
 805         dev_set_drvdata(&dev->dev, chip);
 806
 807         if (chip->quirk_flags & QUIRK_FLAG_DISABLE_AUTOSUSPEND)
 808                 usb_disable_autosuspend(interface_to_usbdev(intf));
 809
 810         /*
 811          * For devices with more than one control interface, we assume the
 812          * first contains the audio controls. We might need a more specific
 813          * check here in the future.
 814          */
 815         if (!chip->ctrl_intf)
 816                 chip->ctrl_intf = alts;
 817
 818         err = 1; /* continue */
 819         if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
 820                 /* need some special handlings */
 821                 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
 822                 if (err < 0)
 823                         goto __error;
 824         }
 825
 826         if (err > 0) {
 827                 /* create normal USB audio interfaces */
 828                 err = snd_usb_create_streams(chip, ifnum);
 829                 if (err < 0)
 830                         goto __error;
 831                 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
 832                 if (err < 0)
 833                         goto __error;
 834         }
 835
 836         if (chip->need_delayed_register) {
 837                 dev_info(&dev->dev,
 838                          "Found post-registration device assignment: %08x:%02x\n",
 839                          chip->usb_id, ifnum);
 840                 chip->need_delayed_register = false; /* clear again */
 841         }
 842
 843         /* we are allowed to call snd_card_register() many times, but first
 844          * check to see if a device needs to skip it or do anything special
 845          */
 846         if (!snd_usb_registration_quirk(chip, ifnum) &&
 847             !check_delayed_register_option(chip, ifnum)) {
 848                 err = snd_card_register(chip->card);
 849                 if (err < 0)
 850                         goto __error;
 851         }
 852
 853         if (chip->quirk_flags & QUIRK_FLAG_SHARE_MEDIA_DEVICE) {
 854                 /* don't want to fail when snd_media_device_create() fails */
 855                 snd_media_device_create(chip, intf);
 856         }
 857
 858         if (quirk)
 859                 chip->quirk_type = quirk->type;
 860
 861         usb_chip[chip->index] = chip;
 862         chip->intf[chip->num_interfaces] = intf;
 863         chip->num_interfaces++;
 864         usb_set_intfdata(intf, chip);
 865         atomic_dec(&chip->active);
 866         mutex_unlock(&register_mutex);
 867         return 0;
 868
 869  __error:
 870         if (chip) {
 871                 /* chip->active is inside the chip->card object,
 872                  * decrement before memory is possibly returned.
 873                  */
 874                 atomic_dec(&chip->active);
 875                 if (!chip->num_interfaces)
 876                         snd_card_free(chip->card);
 877         }
 878         mutex_unlock(&register_mutex);
 879         return err;
 880 }
 881
 882 /*
 883  * we need to take care of counter, since disconnection can be called also
 884  * many times as well as usb_audio_probe().
 885  */
 886 static void usb_audio_disconnect(struct usb_interface *intf)
 887 {
 888         struct snd_usb_audio *chip = usb_get_intfdata(intf);
 889         struct snd_card *card;
 890         struct list_head *p;
 891
 892         if (chip == USB_AUDIO_IFACE_UNUSED)
 893                 return;
 894
 895         card = chip->card;
 896
 897         mutex_lock(&register_mutex);
 898         if (atomic_inc_return(&chip->shutdown) == 1) {
 899                 struct snd_usb_stream *as;
 900                 struct snd_usb_endpoint *ep;
 901                 struct usb_mixer_interface *mixer;
 902
 903                 /* wait until all pending tasks done;
 904                  * they are protected by snd_usb_lock_shutdown()
 905                  */
 906                 wait_event(chip->shutdown_wait,
 907                            !atomic_read(&chip->usage_count));
 908                 snd_card_disconnect(card);
 909                 /* release the pcm resources */
 910                 list_for_each_entry(as, &chip->pcm_list, list) {
 911                         snd_usb_stream_disconnect(as);
 912                 }
 913                 /* release the endpoint resources */
 914                 list_for_each_entry(ep, &chip->ep_list, list) {
 915                         snd_usb_endpoint_release(ep);
 916                 }
 917                 /* release the midi resources */
 918                 list_for_each(p, &chip->midi_list) {
 919                         snd_usbmidi_disconnect(p);
 920                 }
 921                 /*
 922                  * Nice to check quirk && quirk->shares_media_device and
 923                  * then call the snd_media_device_delete(). Don't have
 924                  * access to the quirk here. snd_media_device_delete()
 925                  * accesses mixer_list
 926                  */
 927                 snd_media_device_delete(chip);
 928
 929                 /* release mixer resources */
 930                 list_for_each_entry(mixer, &chip->mixer_list, list) {
 931                         snd_usb_mixer_disconnect(mixer);
 932                 }
 933         }
 934
 935         if (chip->quirk_flags & QUIRK_FLAG_DISABLE_AUTOSUSPEND)
 936                 usb_enable_autosuspend(interface_to_usbdev(intf));
 937
 938         chip->num_interfaces--;
 939         if (chip->num_interfaces <= 0) {
 940                 usb_chip[chip->index] = NULL;
 941                 mutex_unlock(&register_mutex);
 942                 snd_card_free_when_closed(card);
 943         } else {
 944                 mutex_unlock(&register_mutex);
 945         }
 946 }
 947
 948 /* lock the shutdown (disconnect) task and autoresume */
 949 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
 950 {
 951         int err;
 952
 953         atomic_inc(&chip->usage_count);
 954         if (atomic_read(&chip->shutdown)) {
 955                 err = -EIO;
 956                 goto error;
 957         }
 958         err = snd_usb_autoresume(chip);
 959         if (err < 0)
 960                 goto error;
 961         return 0;
 962
 963  error:
 964         if (atomic_dec_and_test(&chip->usage_count))
 965                 wake_up(&chip->shutdown_wait);
 966         return err;
 967 }
 968
 969 /* autosuspend and unlock the shutdown */
 970 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
 971 {
 972         snd_usb_autosuspend(chip);
 973         if (atomic_dec_and_test(&chip->usage_count))
 974                 wake_up(&chip->shutdown_wait);
 975 }
 976
 977 #ifdef CONFIG_PM
 978
 979 int snd_usb_autoresume(struct snd_usb_audio *chip)
 980 {
 981         int i, err;
 982
 983         if (atomic_read(&chip->shutdown))
 984                 return -EIO;
 985         if (atomic_inc_return(&chip->active) != 1)
 986                 return 0;
 987
 988         for (i = 0; i < chip->num_interfaces; i++) {
 989                 err = usb_autopm_get_interface(chip->intf[i]);
 990                 if (err < 0) {
 991                         /* rollback */
 992                         while (--i >= 0)
 993                                 usb_autopm_put_interface(chip->intf[i]);
 994                         atomic_dec(&chip->active);
 995                         return err;
 996                 }
 997         }
 998         return 0;
 999 }
1000
1001 void snd_usb_autosuspend(struct snd_usb_audio *chip)
1002 {
1003         int i;
1004
1005         if (atomic_read(&chip->shutdown))
1006                 return;
1007         if (!atomic_dec_and_test(&chip->active))
1008                 return;
1009
1010         for (i = 0; i < chip->num_interfaces; i++)
1011                 usb_autopm_put_interface(chip->intf[i]);
1012 }
1013
1014 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
1015 {
1016         struct snd_usb_audio *chip = usb_get_intfdata(intf);
1017         struct snd_usb_stream *as;
1018         struct snd_usb_endpoint *ep;
1019         struct usb_mixer_interface *mixer;
1020         struct list_head *p;
1021
1022         if (chip == USB_AUDIO_IFACE_UNUSED)
1023                 return 0;
1024
1025         if (!chip->num_suspended_intf++) {
1026                 list_for_each_entry(as, &chip->pcm_list, list)
1027                         snd_usb_pcm_suspend(as);
1028                 list_for_each_entry(ep, &chip->ep_list, list)
1029                         snd_usb_endpoint_suspend(ep);
1030                 list_for_each(p, &chip->midi_list)
1031                         snd_usbmidi_suspend(p);
1032                 list_for_each_entry(mixer, &chip->mixer_list, list)
1033                         snd_usb_mixer_suspend(mixer);
1034         }
1035
1036         if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
1037                 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
1038                 chip->system_suspend = chip->num_suspended_intf;
1039         }
1040
1041         return 0;
1042 }
1043
1044 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
1045 {
1046         struct snd_usb_audio *chip = usb_get_intfdata(intf);
1047         struct snd_usb_stream *as;
1048         struct usb_mixer_interface *mixer;
1049         struct list_head *p;
1050         int err = 0;
1051
1052         if (chip == USB_AUDIO_IFACE_UNUSED)
1053                 return 0;
1054
1055         atomic_inc(&chip->active); /* avoid autopm */
1056         if (chip->num_suspended_intf > 1)
1057                 goto out;
1058
1059         list_for_each_entry(as, &chip->pcm_list, list) {
1060                 err = snd_usb_pcm_resume(as);
1061                 if (err < 0)
1062                         goto err_out;
1063         }
1064
1065         /*
1066          * ALSA leaves material resumption to user space
1067          * we just notify and restart the mixers
1068          */
1069         list_for_each_entry(mixer, &chip->mixer_list, list) {
1070                 err = snd_usb_mixer_resume(mixer, reset_resume);
1071                 if (err < 0)
1072                         goto err_out;
1073         }
1074
1075         list_for_each(p, &chip->midi_list) {
1076                 snd_usbmidi_resume(p);
1077         }
1078
1079  out:
1080         if (chip->num_suspended_intf == chip->system_suspend) {
1081                 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
1082                 chip->system_suspend = 0;
1083         }
1084         chip->num_suspended_intf--;
1085
1086 err_out:
1087         atomic_dec(&chip->active); /* allow autopm after this point */
1088         return err;
1089 }
1090
1091 static int usb_audio_resume(struct usb_interface *intf)
1092 {
1093         return __usb_audio_resume(intf, false);
1094 }
1095
1096 static int usb_audio_reset_resume(struct usb_interface *intf)
1097 {
1098         return __usb_audio_resume(intf, true);
1099 }
1100 #else
1101 #define usb_audio_suspend       NULL
1102 #define usb_audio_resume        NULL
1103 #define usb_audio_reset_resume  NULL
1104 #endif          /* CONFIG_PM */
1105
1106 static const struct usb_device_id usb_audio_ids [] = {
1107 #include "quirks-table.h"
1108     { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1109       .bInterfaceClass = USB_CLASS_AUDIO,
1110       .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
1111     { }                                         /* Terminating entry */
1112 };
1113 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
1114
1115 /*
1116  * entry point for linux usb interface
1117  */
1118
1119 static struct usb_driver usb_audio_driver = {
1120         .name =         "snd-usb-audio",
1121         .probe =        usb_audio_probe,
1122         .disconnect =   usb_audio_disconnect,
1123         .suspend =      usb_audio_suspend,
1124         .resume =       usb_audio_resume,
1125         .reset_resume = usb_audio_reset_resume,
1126         .id_table =     usb_audio_ids,
1127         .supports_autosuspend = 1,
1128 };
1129
1130 module_usb_driver(usb_audio_driver);