2 * (Tentative) USB Audio Driver for ALSA
4 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
6 * Many codes borrowed from audio.c by
7 * Alan Cox (alan@lxorguk.ukuu.org.uk)
8 * Thomas Sailer (sailer@ife.ee.ethz.ch)
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 * - the linked URBs would be preferred but not used so far because of
29 * the instability of unlinking.
30 * - type II is not supported properly. there is no device which supports
31 * this type *correctly*. SB extigy looks as if it supports, but it's
32 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
36 #include <linux/bitops.h>
37 #include <linux/init.h>
38 #include <linux/list.h>
39 #include <linux/slab.h>
40 #include <linux/string.h>
41 #include <linux/ctype.h>
42 #include <linux/usb.h>
43 #include <linux/moduleparam.h>
44 #include <linux/mutex.h>
45 #include <linux/usb/audio.h>
46 #include <linux/usb/audio-v2.h>
47 #include <linux/module.h>
49 #include <sound/control.h>
50 #include <sound/core.h>
51 #include <sound/info.h>
52 #include <sound/pcm.h>
53 #include <sound/pcm_params.h>
54 #include <sound/initval.h>
71 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
72 MODULE_DESCRIPTION("USB Audio");
73 MODULE_LICENSE("GPL");
74 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
77 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
78 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
79 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
80 /* Vendor/product IDs for this card */
81 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
82 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
83 static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
84 static bool ignore_ctl_error;
85 static bool autoclock = true;
87 module_param_array(index, int, NULL, 0444);
88 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
89 module_param_array(id, charp, NULL, 0444);
90 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
91 module_param_array(enable, bool, NULL, 0444);
92 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
93 module_param_array(vid, int, NULL, 0444);
94 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
95 module_param_array(pid, int, NULL, 0444);
96 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
97 module_param_array(device_setup, int, NULL, 0444);
98 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
99 module_param(ignore_ctl_error, bool, 0444);
100 MODULE_PARM_DESC(ignore_ctl_error,
101 "Ignore errors from USB controller for mixer interfaces.");
102 module_param(autoclock, bool, 0444);
103 MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
106 * we keep the snd_usb_audio_t instances by ourselves for merging
107 * the all interfaces on the same card as one sound device.
110 static DEFINE_MUTEX(register_mutex);
111 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
112 static struct usb_driver usb_audio_driver;
116 * called from usb_audio_disconnect()
118 static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
121 struct snd_usb_substream *subs;
123 for (idx = 0; idx < 2; idx++) {
124 subs = &as->substream[idx];
125 if (!subs->num_formats)
127 subs->interface = -1;
128 subs->data_endpoint = NULL;
129 subs->sync_endpoint = NULL;
133 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
135 struct usb_device *dev = chip->dev;
136 struct usb_host_interface *alts;
137 struct usb_interface_descriptor *altsd;
138 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
141 dev_err(&dev->dev, "%u:%d : does not exist\n",
146 alts = &iface->altsetting[0];
147 altsd = get_iface_desc(alts);
150 * Android with both accessory and audio interfaces enabled gets the
151 * interface numbers wrong.
153 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
154 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
156 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
157 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
159 iface = usb_ifnum_to_if(dev, interface);
162 alts = &iface->altsetting[0];
163 altsd = get_iface_desc(alts);
166 if (usb_interface_claimed(iface)) {
167 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
172 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
173 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
174 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
175 int err = snd_usbmidi_create(chip->card, iface,
176 &chip->midi_list, NULL);
179 "%u:%d: cannot create sequencer device\n",
183 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
188 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
189 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
190 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
192 "%u:%d: skipping non-supported interface %d\n",
193 ctrlif, interface, altsd->bInterfaceClass);
194 /* skip non-supported classes */
198 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
199 dev_err(&dev->dev, "low speed audio streaming not supported\n");
203 if (! snd_usb_parse_audio_interface(chip, interface)) {
204 usb_set_interface(dev, interface, 0); /* reset the current interface */
205 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
213 * parse audio control descriptor and create pcm/midi streams
215 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
217 struct usb_device *dev = chip->dev;
218 struct usb_host_interface *host_iface;
219 struct usb_interface_descriptor *altsd;
220 void *control_header;
223 /* find audiocontrol interface */
224 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
225 control_header = snd_usb_find_csint_desc(host_iface->extra,
226 host_iface->extralen,
228 altsd = get_iface_desc(host_iface);
229 protocol = altsd->bInterfaceProtocol;
231 if (!control_header) {
232 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
239 "unknown interface protocol %#02x, assuming v1\n",
243 case UAC_VERSION_1: {
244 struct uac1_ac_header_descriptor *h1 = control_header;
246 if (!h1->bInCollection) {
247 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
251 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
252 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
256 for (i = 0; i < h1->bInCollection; i++)
257 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
262 case UAC_VERSION_2: {
263 struct usb_interface_assoc_descriptor *assoc =
264 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
268 * Firmware writers cannot count to three. So to find
269 * the IAD on the NuForce UDH-100, also check the next
272 struct usb_interface *iface =
273 usb_ifnum_to_if(dev, ctrlif + 1);
276 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
277 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
278 assoc = iface->intf_assoc;
282 dev_err(&dev->dev, "Audio class v2 interfaces need an interface association\n");
286 for (i = 0; i < assoc->bInterfaceCount; i++) {
287 int intf = assoc->bFirstInterface + i;
290 snd_usb_create_stream(chip, ctrlif, intf);
301 * free the chip instance
303 * here we have to do not much, since pcm and controls are already freed
307 static int snd_usb_audio_free(struct snd_usb_audio *chip)
309 struct snd_usb_endpoint *ep, *n;
311 list_for_each_entry_safe(ep, n, &chip->ep_list, list)
312 snd_usb_endpoint_free(ep);
314 mutex_destroy(&chip->mutex);
319 static int snd_usb_audio_dev_free(struct snd_device *device)
321 struct snd_usb_audio *chip = device->device_data;
322 return snd_usb_audio_free(chip);
326 * create a chip instance and set its names.
328 static int snd_usb_audio_create(struct usb_interface *intf,
329 struct usb_device *dev, int idx,
330 const struct snd_usb_audio_quirk *quirk,
331 struct snd_usb_audio **rchip)
333 struct snd_card *card;
334 struct snd_usb_audio *chip;
337 static struct snd_device_ops ops = {
338 .dev_free = snd_usb_audio_dev_free,
343 switch (snd_usb_get_speed(dev)) {
347 case USB_SPEED_WIRELESS:
348 case USB_SPEED_SUPER:
351 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
355 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
358 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
362 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
368 mutex_init(&chip->mutex);
369 init_waitqueue_head(&chip->shutdown_wait);
373 chip->setup = device_setup[idx];
374 chip->autoclock = autoclock;
375 atomic_set(&chip->active, 1); /* avoid autopm during probing */
376 atomic_set(&chip->usage_count, 0);
377 atomic_set(&chip->shutdown, 0);
379 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
380 le16_to_cpu(dev->descriptor.idProduct));
381 INIT_LIST_HEAD(&chip->pcm_list);
382 INIT_LIST_HEAD(&chip->ep_list);
383 INIT_LIST_HEAD(&chip->midi_list);
384 INIT_LIST_HEAD(&chip->mixer_list);
386 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
387 snd_usb_audio_free(chip);
392 strcpy(card->driver, "USB-Audio");
393 sprintf(component, "USB%04x:%04x",
394 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
395 snd_component_add(card, component);
397 /* retrieve the device string as shortname */
398 if (quirk && quirk->product_name && *quirk->product_name) {
399 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
401 if (!dev->descriptor.iProduct ||
402 usb_string(dev, dev->descriptor.iProduct,
403 card->shortname, sizeof(card->shortname)) <= 0) {
404 /* no name available from anywhere, so use ID */
405 sprintf(card->shortname, "USB Device %#04x:%#04x",
406 USB_ID_VENDOR(chip->usb_id),
407 USB_ID_PRODUCT(chip->usb_id));
410 strim(card->shortname);
412 /* retrieve the vendor and device strings as longname */
413 if (quirk && quirk->vendor_name && *quirk->vendor_name) {
414 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
416 if (dev->descriptor.iManufacturer)
417 len = usb_string(dev, dev->descriptor.iManufacturer,
418 card->longname, sizeof(card->longname));
421 /* we don't really care if there isn't any vendor string */
424 strim(card->longname);
426 strlcat(card->longname, " ", sizeof(card->longname));
429 strlcat(card->longname, card->shortname, sizeof(card->longname));
431 len = strlcat(card->longname, " at ", sizeof(card->longname));
433 if (len < sizeof(card->longname))
434 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
436 switch (snd_usb_get_speed(dev)) {
438 strlcat(card->longname, ", low speed", sizeof(card->longname));
441 strlcat(card->longname, ", full speed", sizeof(card->longname));
444 strlcat(card->longname, ", high speed", sizeof(card->longname));
446 case USB_SPEED_SUPER:
447 strlcat(card->longname, ", super speed", sizeof(card->longname));
453 snd_usb_audio_create_proc(chip);
460 * probe the active usb device
462 * note that this can be called multiple times per a device, when it
463 * includes multiple audio control interfaces.
465 * thus we check the usb device pointer and creates the card instance
466 * only at the first time. the successive calls of this function will
467 * append the pcm interface to the corresponding card.
469 static int usb_audio_probe(struct usb_interface *intf,
470 const struct usb_device_id *usb_id)
472 struct usb_device *dev = interface_to_usbdev(intf);
473 const struct snd_usb_audio_quirk *quirk =
474 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
475 struct snd_usb_audio *chip;
477 struct usb_host_interface *alts;
481 alts = &intf->altsetting[0];
482 ifnum = get_iface_desc(alts)->bInterfaceNumber;
483 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
484 le16_to_cpu(dev->descriptor.idProduct));
485 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
488 err = snd_usb_apply_boot_quirk(dev, intf, quirk);
493 * found a config. now register to ALSA
496 /* check whether it's already registered */
498 mutex_lock(®ister_mutex);
499 for (i = 0; i < SNDRV_CARDS; i++) {
500 if (usb_chip[i] && usb_chip[i]->dev == dev) {
501 if (atomic_read(&usb_chip[i]->shutdown)) {
502 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
507 atomic_inc(&chip->active); /* avoid autopm */
513 * now look for an empty slot and create a new card instance
515 for (i = 0; i < SNDRV_CARDS; i++)
516 if (enable[i] && ! usb_chip[i] &&
517 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
518 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
519 err = snd_usb_audio_create(intf, dev, i, quirk,
523 chip->pm_intf = intf;
527 dev_err(&dev->dev, "no available usb audio device\n");
534 * For devices with more than one control interface, we assume the
535 * first contains the audio controls. We might need a more specific
536 * check here in the future.
538 if (!chip->ctrl_intf)
539 chip->ctrl_intf = alts;
541 chip->txfr_quirk = 0;
542 err = 1; /* continue */
543 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
544 /* need some special handlings */
545 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
551 /* create normal USB audio interfaces */
552 err = snd_usb_create_streams(chip, ifnum);
555 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
560 /* we are allowed to call snd_card_register() many times */
561 err = snd_card_register(chip->card);
565 if (quirk->media_device) {
566 /* don't want to fail when media_snd_device_create() fails */
567 media_snd_device_create(chip, intf);
570 usb_chip[chip->index] = chip;
571 chip->num_interfaces++;
572 usb_set_intfdata(intf, chip);
573 atomic_dec(&chip->active);
574 mutex_unlock(®ister_mutex);
579 if (!chip->num_interfaces)
580 snd_card_free(chip->card);
581 atomic_dec(&chip->active);
583 mutex_unlock(®ister_mutex);
588 * we need to take care of counter, since disconnection can be called also
589 * many times as well as usb_audio_probe().
591 static void usb_audio_disconnect(struct usb_interface *intf)
593 struct snd_usb_audio *chip = usb_get_intfdata(intf);
594 struct snd_card *card;
597 if (chip == (void *)-1L)
602 mutex_lock(®ister_mutex);
603 if (atomic_inc_return(&chip->shutdown) == 1) {
604 struct snd_usb_stream *as;
605 struct snd_usb_endpoint *ep;
606 struct usb_mixer_interface *mixer;
608 /* wait until all pending tasks done;
609 * they are protected by snd_usb_lock_shutdown()
611 wait_event(chip->shutdown_wait,
612 !atomic_read(&chip->usage_count));
613 snd_card_disconnect(card);
614 /* release the pcm resources */
615 list_for_each_entry(as, &chip->pcm_list, list) {
616 snd_usb_stream_disconnect(as);
618 /* release the endpoint resources */
619 list_for_each_entry(ep, &chip->ep_list, list) {
620 snd_usb_endpoint_release(ep);
622 /* release the midi resources */
623 list_for_each(p, &chip->midi_list) {
624 snd_usbmidi_disconnect(p);
627 * Nice to check quirk && quirk->media_device
628 * need some special handlings. Doesn't look like
629 * we have access to quirk here
632 media_snd_device_delete(chip);
634 /* release mixer resources */
635 list_for_each_entry(mixer, &chip->mixer_list, list) {
636 snd_usb_mixer_disconnect(mixer);
640 chip->num_interfaces--;
641 if (chip->num_interfaces <= 0) {
642 usb_chip[chip->index] = NULL;
643 mutex_unlock(®ister_mutex);
644 snd_card_free_when_closed(card);
646 mutex_unlock(®ister_mutex);
650 /* lock the shutdown (disconnect) task and autoresume */
651 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
655 atomic_inc(&chip->usage_count);
656 if (atomic_read(&chip->shutdown)) {
660 err = snd_usb_autoresume(chip);
666 if (atomic_dec_and_test(&chip->usage_count))
667 wake_up(&chip->shutdown_wait);
671 /* autosuspend and unlock the shutdown */
672 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
674 snd_usb_autosuspend(chip);
675 if (atomic_dec_and_test(&chip->usage_count))
676 wake_up(&chip->shutdown_wait);
681 int snd_usb_autoresume(struct snd_usb_audio *chip)
683 if (atomic_read(&chip->shutdown))
685 if (atomic_inc_return(&chip->active) == 1)
686 return usb_autopm_get_interface(chip->pm_intf);
690 void snd_usb_autosuspend(struct snd_usb_audio *chip)
692 if (atomic_read(&chip->shutdown))
694 if (atomic_dec_and_test(&chip->active))
695 usb_autopm_put_interface(chip->pm_intf);
698 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
700 struct snd_usb_audio *chip = usb_get_intfdata(intf);
701 struct snd_usb_stream *as;
702 struct usb_mixer_interface *mixer;
705 if (chip == (void *)-1L)
708 chip->autosuspended = !!PMSG_IS_AUTO(message);
709 if (!chip->autosuspended)
710 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
711 if (!chip->num_suspended_intf++) {
712 list_for_each_entry(as, &chip->pcm_list, list) {
713 snd_pcm_suspend_all(as->pcm);
714 as->substream[0].need_setup_ep =
715 as->substream[1].need_setup_ep = true;
717 list_for_each(p, &chip->midi_list)
718 snd_usbmidi_suspend(p);
719 list_for_each_entry(mixer, &chip->mixer_list, list)
720 snd_usb_mixer_suspend(mixer);
726 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
728 struct snd_usb_audio *chip = usb_get_intfdata(intf);
729 struct usb_mixer_interface *mixer;
733 if (chip == (void *)-1L)
735 if (--chip->num_suspended_intf)
738 atomic_inc(&chip->active); /* avoid autopm */
740 * ALSA leaves material resumption to user space
741 * we just notify and restart the mixers
743 list_for_each_entry(mixer, &chip->mixer_list, list) {
744 err = snd_usb_mixer_resume(mixer, reset_resume);
749 list_for_each(p, &chip->midi_list) {
750 snd_usbmidi_resume(p);
753 if (!chip->autosuspended)
754 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
755 chip->autosuspended = 0;
758 atomic_dec(&chip->active); /* allow autopm after this point */
762 static int usb_audio_resume(struct usb_interface *intf)
764 return __usb_audio_resume(intf, false);
767 static int usb_audio_reset_resume(struct usb_interface *intf)
769 return __usb_audio_resume(intf, true);
772 #define usb_audio_suspend NULL
773 #define usb_audio_resume NULL
774 #define usb_audio_reset_resume NULL
775 #endif /* CONFIG_PM */
777 static struct usb_device_id usb_audio_ids [] = {
778 #include "quirks-table.h"
779 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
780 .bInterfaceClass = USB_CLASS_AUDIO,
781 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
782 { } /* Terminating entry */
784 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
787 * entry point for linux usb interface
790 static struct usb_driver usb_audio_driver = {
791 .name = "snd-usb-audio",
792 .probe = usb_audio_probe,
793 .disconnect = usb_audio_disconnect,
794 .suspend = usb_audio_suspend,
795 .resume = usb_audio_resume,
796 .reset_resume = usb_audio_reset_resume,
797 .id_table = usb_audio_ids,
798 .supports_autosuspend = 1,
801 module_usb_driver(usb_audio_driver);