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