1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * (Tentative) USB Audio Driver for ALSA
5 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
7 * Many codes borrowed from audio.c by
8 * Alan Cox (alan@lxorguk.ukuu.org.uk)
9 * Thomas Sailer (sailer@ife.ee.ethz.ch)
11 * Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com>
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).
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>
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>
58 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
59 MODULE_DESCRIPTION("USB Audio");
60 MODULE_LICENSE("GPL");
61 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
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];
77 bool snd_usb_use_vmalloc = true;
78 bool snd_usb_skip_validation;
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).");
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.
113 static DEFINE_MUTEX(register_mutex);
114 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
115 static struct usb_driver usb_audio_driver;
119 * called from usb_audio_disconnect()
121 static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
124 struct snd_usb_substream *subs;
126 for (idx = 0; idx < 2; idx++) {
127 subs = &as->substream[idx];
128 if (!subs->num_formats)
130 subs->data_endpoint = NULL;
131 subs->sync_endpoint = NULL;
135 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
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);
143 dev_err(&dev->dev, "%u:%d : does not exist\n",
148 alts = &iface->altsetting[0];
149 altsd = get_iface_desc(alts);
152 * Android with both accessory and audio interfaces enabled gets the
153 * interface numbers wrong.
155 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
156 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
158 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
159 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
161 iface = usb_ifnum_to_if(dev, interface);
164 alts = &iface->altsetting[0];
165 altsd = get_iface_desc(alts);
168 if (usb_interface_claimed(iface)) {
169 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
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,
182 "%u:%d: cannot create sequencer device\n",
186 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
191 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
192 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
193 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
195 "%u:%d: skipping non-supported interface %d\n",
196 ctrlif, interface, altsd->bInterfaceClass);
197 /* skip non-supported classes */
201 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
202 dev_err(&dev->dev, "low speed audio streaming not supported\n");
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);
215 * parse audio control descriptor and create pcm/midi streams
217 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
219 struct usb_device *dev = chip->dev;
220 struct usb_host_interface *host_iface;
221 struct usb_interface_descriptor *altsd;
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;
232 "unknown interface protocol %#02x, assuming v1\n",
236 case UAC_VERSION_1: {
237 struct uac1_ac_header_descriptor *h1;
240 h1 = snd_usb_find_csint_desc(host_iface->extra,
241 host_iface->extralen,
243 if (!h1 || h1->bLength < sizeof(*h1)) {
244 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
248 rest_bytes = (void *)(host_iface->extra +
249 host_iface->extralen) - (void *)h1;
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");
257 if (rest_bytes < sizeof(*h1)) {
258 dev_err(&dev->dev, "too short v1 buffer descriptor\n");
262 if (!h1->bInCollection) {
263 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
267 if (rest_bytes < h1->bLength) {
268 dev_err(&dev->dev, "invalid buffer length (v1)\n");
272 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
273 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
277 for (i = 0; i < h1->bInCollection; i++)
278 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
284 case UAC_VERSION_3: {
285 struct usb_interface_assoc_descriptor *assoc =
286 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
290 * Firmware writers cannot count to three. So to find
291 * the IAD on the NuForce UDH-100, also check the next
294 struct usb_interface *iface =
295 usb_ifnum_to_if(dev, ctrlif + 1);
298 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
299 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
300 assoc = iface->intf_assoc;
304 dev_err(&dev->dev, "Audio class v2/v3 interfaces need an interface association\n");
308 if (protocol == UAC_VERSION_3) {
309 int badd = assoc->bFunctionSubClass;
311 if (badd != UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0 &&
312 (badd < UAC3_FUNCTION_SUBCLASS_GENERIC_IO ||
313 badd > UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE)) {
315 "Unsupported UAC3 BADD profile\n");
319 chip->badd_profile = badd;
322 for (i = 0; i < assoc->bInterfaceCount; i++) {
323 int intf = assoc->bFirstInterface + i;
326 snd_usb_create_stream(chip, ctrlif, intf);
337 * Profile name preset table
339 struct usb_audio_device_name {
341 const char *vendor_name;
342 const char *product_name;
343 const char *profile_name; /* override card->longname */
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)
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"),
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.
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"),
372 /* Gigabyte TRX40 Aorus Pro WiFi */
373 PROFILE_NAME(0x0414, 0xa002,
374 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
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"),
381 DEVICE_NAME(0x046d, 0x0990, "Logitech, Inc.", "QuickCam Pro 9000"),
384 PROFILE_NAME(0x0b05, 0x1917,
385 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
388 PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
390 PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
392 DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
395 * The original product_name is "USB Sound Device", however this name
396 * is also used by the CM106 based cards, so make it unique.
398 DEVICE_NAME(0x0d8c, 0x0102, NULL, "ICUSBAUDIO7D"),
399 DEVICE_NAME(0x0d8c, 0x0103, NULL, "Audio Advantage MicroII"),
401 /* MSI TRX40 Creator */
402 PROFILE_NAME(0x0db0, 0x0d64,
403 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
405 PROFILE_NAME(0x0db0, 0x543d,
406 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
408 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
409 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
410 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
412 /* aka. Serato Scratch Live DJ Box */
413 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
415 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
416 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
417 "Lenovo-ThinkStation-P620-Rear"),
418 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
419 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
420 "Lenovo-ThinkStation-P620-Main"),
422 /* Asrock TRX40 Creator */
423 PROFILE_NAME(0x26ce, 0x0a01,
424 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
429 static const struct usb_audio_device_name *
430 lookup_device_name(u32 id)
432 static const struct usb_audio_device_name *p;
434 for (p = usb_audio_names; p->id; p++)
441 * free the chip instance
443 * here we have to do not much, since pcm and controls are already freed
447 static void snd_usb_audio_free(struct snd_card *card)
449 struct snd_usb_audio *chip = card->private_data;
450 struct snd_usb_endpoint *ep, *n;
452 list_for_each_entry_safe(ep, n, &chip->ep_list, list)
453 snd_usb_endpoint_free(ep);
455 mutex_destroy(&chip->mutex);
456 if (!atomic_read(&chip->shutdown))
457 dev_set_drvdata(&chip->dev->dev, NULL);
460 static void usb_audio_make_shortname(struct usb_device *dev,
461 struct snd_usb_audio *chip,
462 const struct snd_usb_audio_quirk *quirk)
464 struct snd_card *card = chip->card;
465 const struct usb_audio_device_name *preset;
466 const char *s = NULL;
468 preset = lookup_device_name(chip->usb_id);
469 if (preset && preset->product_name)
470 s = preset->product_name;
471 else if (quirk && quirk->product_name)
472 s = quirk->product_name;
474 strlcpy(card->shortname, s, sizeof(card->shortname));
478 /* retrieve the device string as shortname */
479 if (!dev->descriptor.iProduct ||
480 usb_string(dev, dev->descriptor.iProduct,
481 card->shortname, sizeof(card->shortname)) <= 0) {
482 /* no name available from anywhere, so use ID */
483 sprintf(card->shortname, "USB Device %#04x:%#04x",
484 USB_ID_VENDOR(chip->usb_id),
485 USB_ID_PRODUCT(chip->usb_id));
488 strim(card->shortname);
491 static void usb_audio_make_longname(struct usb_device *dev,
492 struct snd_usb_audio *chip,
493 const struct snd_usb_audio_quirk *quirk)
495 struct snd_card *card = chip->card;
496 const struct usb_audio_device_name *preset;
497 const char *s = NULL;
500 preset = lookup_device_name(chip->usb_id);
502 /* shortcut - if any pre-defined string is given, use it */
503 if (preset && preset->profile_name)
504 s = preset->profile_name;
506 strlcpy(card->longname, s, sizeof(card->longname));
510 if (preset && preset->vendor_name)
511 s = preset->vendor_name;
512 else if (quirk && quirk->vendor_name)
513 s = quirk->vendor_name;
515 len = strlcpy(card->longname, s, sizeof(card->longname));
517 /* retrieve the vendor and device strings as longname */
518 if (dev->descriptor.iManufacturer)
519 len = usb_string(dev, dev->descriptor.iManufacturer,
520 card->longname, sizeof(card->longname));
523 /* we don't really care if there isn't any vendor string */
526 strim(card->longname);
528 strlcat(card->longname, " ", sizeof(card->longname));
531 strlcat(card->longname, card->shortname, sizeof(card->longname));
533 len = strlcat(card->longname, " at ", sizeof(card->longname));
535 if (len < sizeof(card->longname))
536 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
538 switch (snd_usb_get_speed(dev)) {
540 strlcat(card->longname, ", low speed", sizeof(card->longname));
543 strlcat(card->longname, ", full speed", sizeof(card->longname));
546 strlcat(card->longname, ", high speed", sizeof(card->longname));
548 case USB_SPEED_SUPER:
549 strlcat(card->longname, ", super speed", sizeof(card->longname));
551 case USB_SPEED_SUPER_PLUS:
552 strlcat(card->longname, ", super speed plus", sizeof(card->longname));
560 * create a chip instance and set its names.
562 static int snd_usb_audio_create(struct usb_interface *intf,
563 struct usb_device *dev, int idx,
564 const struct snd_usb_audio_quirk *quirk,
566 struct snd_usb_audio **rchip)
568 struct snd_card *card;
569 struct snd_usb_audio *chip;
575 switch (snd_usb_get_speed(dev)) {
579 case USB_SPEED_WIRELESS:
580 case USB_SPEED_SUPER:
581 case USB_SPEED_SUPER_PLUS:
584 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
588 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
589 sizeof(*chip), &card);
591 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
595 chip = card->private_data;
596 mutex_init(&chip->mutex);
597 init_waitqueue_head(&chip->shutdown_wait);
601 chip->setup = device_setup[idx];
602 chip->generic_implicit_fb = implicit_fb[idx];
603 chip->autoclock = autoclock;
604 atomic_set(&chip->active, 1); /* avoid autopm during probing */
605 atomic_set(&chip->usage_count, 0);
606 atomic_set(&chip->shutdown, 0);
608 chip->usb_id = usb_id;
609 INIT_LIST_HEAD(&chip->pcm_list);
610 INIT_LIST_HEAD(&chip->ep_list);
611 INIT_LIST_HEAD(&chip->midi_list);
612 INIT_LIST_HEAD(&chip->mixer_list);
614 card->private_free = snd_usb_audio_free;
616 strcpy(card->driver, "USB-Audio");
617 sprintf(component, "USB%04x:%04x",
618 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
619 snd_component_add(card, component);
621 usb_audio_make_shortname(dev, chip, quirk);
622 usb_audio_make_longname(dev, chip, quirk);
624 snd_usb_audio_create_proc(chip);
630 /* look for a matching quirk alias id */
631 static bool get_alias_id(struct usb_device *dev, unsigned int *id)
634 unsigned int src, dst;
636 for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
637 if (!quirk_alias[i] ||
638 sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
642 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
643 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
644 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
652 static bool check_delayed_register_option(struct snd_usb_audio *chip, int iface)
655 unsigned int id, inum;
657 for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {
658 if (delayed_register[i] &&
659 sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&
661 return inum != iface;
667 static const struct usb_device_id usb_audio_ids[]; /* defined below */
669 /* look for the corresponding quirk */
670 static const struct snd_usb_audio_quirk *
671 get_alias_quirk(struct usb_device *dev, unsigned int id)
673 const struct usb_device_id *p;
675 for (p = usb_audio_ids; p->match_flags; p++) {
676 /* FIXME: this checks only vendor:product pair in the list */
677 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
678 USB_DEVICE_ID_MATCH_DEVICE &&
679 p->idVendor == USB_ID_VENDOR(id) &&
680 p->idProduct == USB_ID_PRODUCT(id))
681 return (const struct snd_usb_audio_quirk *)p->driver_info;
688 * probe the active usb device
690 * note that this can be called multiple times per a device, when it
691 * includes multiple audio control interfaces.
693 * thus we check the usb device pointer and creates the card instance
694 * only at the first time. the successive calls of this function will
695 * append the pcm interface to the corresponding card.
697 static int usb_audio_probe(struct usb_interface *intf,
698 const struct usb_device_id *usb_id)
700 struct usb_device *dev = interface_to_usbdev(intf);
701 const struct snd_usb_audio_quirk *quirk =
702 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
703 struct snd_usb_audio *chip;
705 struct usb_host_interface *alts;
709 alts = &intf->altsetting[0];
710 ifnum = get_iface_desc(alts)->bInterfaceNumber;
711 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
712 le16_to_cpu(dev->descriptor.idProduct));
713 if (get_alias_id(dev, &id))
714 quirk = get_alias_quirk(dev, id);
715 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
718 err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
723 * found a config. now register to ALSA
726 /* check whether it's already registered */
728 mutex_lock(®ister_mutex);
729 for (i = 0; i < SNDRV_CARDS; i++) {
730 if (usb_chip[i] && usb_chip[i]->dev == dev) {
731 if (atomic_read(&usb_chip[i]->shutdown)) {
732 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
737 atomic_inc(&chip->active); /* avoid autopm */
742 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
747 * now look for an empty slot and create a new card instance
749 for (i = 0; i < SNDRV_CARDS; i++)
751 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
752 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
754 err = snd_usb_audio_create(intf, dev, i, quirk,
759 } else if (vid[i] != -1 || pid[i] != -1) {
761 "device (%04x:%04x) is disabled\n",
769 dev_err(&dev->dev, "no available usb audio device\n");
775 if (chip->num_interfaces >= MAX_CARD_INTERFACES) {
776 dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");
781 dev_set_drvdata(&dev->dev, chip);
784 * For devices with more than one control interface, we assume the
785 * first contains the audio controls. We might need a more specific
786 * check here in the future.
788 if (!chip->ctrl_intf)
789 chip->ctrl_intf = alts;
791 chip->txfr_quirk = 0;
792 err = 1; /* continue */
793 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
794 /* need some special handlings */
795 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
801 /* create normal USB audio interfaces */
802 err = snd_usb_create_streams(chip, ifnum);
805 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
810 if (chip->need_delayed_register) {
812 "Found post-registration device assignment: %08x:%02x\n",
813 chip->usb_id, ifnum);
814 chip->need_delayed_register = false; /* clear again */
817 /* we are allowed to call snd_card_register() many times, but first
818 * check to see if a device needs to skip it or do anything special
820 if (!snd_usb_registration_quirk(chip, ifnum) &&
821 !check_delayed_register_option(chip, ifnum)) {
822 err = snd_card_register(chip->card);
827 if (quirk && quirk->shares_media_device) {
828 /* don't want to fail when snd_media_device_create() fails */
829 snd_media_device_create(chip, intf);
832 usb_chip[chip->index] = chip;
833 chip->intf[chip->num_interfaces] = intf;
834 chip->num_interfaces++;
835 usb_set_intfdata(intf, chip);
836 atomic_dec(&chip->active);
837 mutex_unlock(®ister_mutex);
842 /* chip->active is inside the chip->card object,
843 * decrement before memory is possibly returned.
845 atomic_dec(&chip->active);
846 if (!chip->num_interfaces)
847 snd_card_free(chip->card);
849 mutex_unlock(®ister_mutex);
854 * we need to take care of counter, since disconnection can be called also
855 * many times as well as usb_audio_probe().
857 static void usb_audio_disconnect(struct usb_interface *intf)
859 struct snd_usb_audio *chip = usb_get_intfdata(intf);
860 struct snd_card *card;
863 if (chip == (void *)-1L)
868 mutex_lock(®ister_mutex);
869 if (atomic_inc_return(&chip->shutdown) == 1) {
870 struct snd_usb_stream *as;
871 struct snd_usb_endpoint *ep;
872 struct usb_mixer_interface *mixer;
874 /* wait until all pending tasks done;
875 * they are protected by snd_usb_lock_shutdown()
877 wait_event(chip->shutdown_wait,
878 !atomic_read(&chip->usage_count));
879 snd_card_disconnect(card);
880 /* release the pcm resources */
881 list_for_each_entry(as, &chip->pcm_list, list) {
882 snd_usb_stream_disconnect(as);
884 /* release the endpoint resources */
885 list_for_each_entry(ep, &chip->ep_list, list) {
886 snd_usb_endpoint_release(ep);
888 /* release the midi resources */
889 list_for_each(p, &chip->midi_list) {
890 snd_usbmidi_disconnect(p);
893 * Nice to check quirk && quirk->shares_media_device and
894 * then call the snd_media_device_delete(). Don't have
895 * access to the quirk here. snd_media_device_delete()
896 * accesses mixer_list
898 snd_media_device_delete(chip);
900 /* release mixer resources */
901 list_for_each_entry(mixer, &chip->mixer_list, list) {
902 snd_usb_mixer_disconnect(mixer);
906 chip->num_interfaces--;
907 if (chip->num_interfaces <= 0) {
908 usb_chip[chip->index] = NULL;
909 mutex_unlock(®ister_mutex);
910 snd_card_free_when_closed(card);
912 mutex_unlock(®ister_mutex);
916 /* lock the shutdown (disconnect) task and autoresume */
917 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
921 atomic_inc(&chip->usage_count);
922 if (atomic_read(&chip->shutdown)) {
926 err = snd_usb_autoresume(chip);
932 if (atomic_dec_and_test(&chip->usage_count))
933 wake_up(&chip->shutdown_wait);
937 /* autosuspend and unlock the shutdown */
938 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
940 snd_usb_autosuspend(chip);
941 if (atomic_dec_and_test(&chip->usage_count))
942 wake_up(&chip->shutdown_wait);
947 int snd_usb_autoresume(struct snd_usb_audio *chip)
951 if (atomic_read(&chip->shutdown))
953 if (atomic_inc_return(&chip->active) != 1)
956 for (i = 0; i < chip->num_interfaces; i++) {
957 err = usb_autopm_get_interface(chip->intf[i]);
961 usb_autopm_put_interface(chip->intf[i]);
962 atomic_dec(&chip->active);
969 void snd_usb_autosuspend(struct snd_usb_audio *chip)
973 if (atomic_read(&chip->shutdown))
975 if (!atomic_dec_and_test(&chip->active))
978 for (i = 0; i < chip->num_interfaces; i++)
979 usb_autopm_put_interface(chip->intf[i]);
982 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
984 struct snd_usb_audio *chip = usb_get_intfdata(intf);
985 struct snd_usb_stream *as;
986 struct snd_usb_endpoint *ep;
987 struct usb_mixer_interface *mixer;
990 if (chip == (void *)-1L)
993 if (!chip->num_suspended_intf++) {
994 list_for_each_entry(as, &chip->pcm_list, list)
995 snd_usb_pcm_suspend(as);
996 list_for_each_entry(ep, &chip->ep_list, list)
997 snd_usb_endpoint_suspend(ep);
998 list_for_each(p, &chip->midi_list)
999 snd_usbmidi_suspend(p);
1000 list_for_each_entry(mixer, &chip->mixer_list, list)
1001 snd_usb_mixer_suspend(mixer);
1004 if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
1005 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
1006 chip->system_suspend = chip->num_suspended_intf;
1012 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
1014 struct snd_usb_audio *chip = usb_get_intfdata(intf);
1015 struct snd_usb_stream *as;
1016 struct usb_mixer_interface *mixer;
1017 struct list_head *p;
1020 if (chip == (void *)-1L)
1023 atomic_inc(&chip->active); /* avoid autopm */
1024 if (chip->num_suspended_intf > 1)
1027 list_for_each_entry(as, &chip->pcm_list, list) {
1028 err = snd_usb_pcm_resume(as);
1034 * ALSA leaves material resumption to user space
1035 * we just notify and restart the mixers
1037 list_for_each_entry(mixer, &chip->mixer_list, list) {
1038 err = snd_usb_mixer_resume(mixer, reset_resume);
1043 list_for_each(p, &chip->midi_list) {
1044 snd_usbmidi_resume(p);
1048 if (chip->num_suspended_intf == chip->system_suspend) {
1049 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
1050 chip->system_suspend = 0;
1052 chip->num_suspended_intf--;
1055 atomic_dec(&chip->active); /* allow autopm after this point */
1059 static int usb_audio_resume(struct usb_interface *intf)
1061 return __usb_audio_resume(intf, false);
1064 static int usb_audio_reset_resume(struct usb_interface *intf)
1066 return __usb_audio_resume(intf, true);
1069 #define usb_audio_suspend NULL
1070 #define usb_audio_resume NULL
1071 #define usb_audio_reset_resume NULL
1072 #endif /* CONFIG_PM */
1074 static const struct usb_device_id usb_audio_ids [] = {
1075 #include "quirks-table.h"
1076 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1077 .bInterfaceClass = USB_CLASS_AUDIO,
1078 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
1079 { } /* Terminating entry */
1081 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
1084 * entry point for linux usb interface
1087 static struct usb_driver usb_audio_driver = {
1088 .name = "snd-usb-audio",
1089 .probe = usb_audio_probe,
1090 .disconnect = usb_audio_disconnect,
1091 .suspend = usb_audio_suspend,
1092 .resume = usb_audio_resume,
1093 .reset_resume = usb_audio_reset_resume,
1094 .id_table = usb_audio_ids,
1095 .supports_autosuspend = 1,
1098 module_usb_driver(usb_audio_driver);