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