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>
70 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
71 MODULE_DESCRIPTION("USB Audio");
72 MODULE_LICENSE("GPL");
73 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
76 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
77 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
78 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
79 /* Vendor/product IDs for this card */
80 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
81 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
82 static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
83 static bool ignore_ctl_error;
84 static bool autoclock = true;
86 module_param_array(index, int, NULL, 0444);
87 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
88 module_param_array(id, charp, NULL, 0444);
89 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
90 module_param_array(enable, bool, NULL, 0444);
91 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
92 module_param_array(vid, int, NULL, 0444);
93 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
94 module_param_array(pid, int, NULL, 0444);
95 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
96 module_param_array(device_setup, int, NULL, 0444);
97 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
98 module_param(ignore_ctl_error, bool, 0444);
99 MODULE_PARM_DESC(ignore_ctl_error,
100 "Ignore errors from USB controller for mixer interfaces.");
101 module_param(autoclock, bool, 0444);
102 MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
105 * we keep the snd_usb_audio_t instances by ourselves for merging
106 * the all interfaces on the same card as one sound device.
109 static DEFINE_MUTEX(register_mutex);
110 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
111 static struct usb_driver usb_audio_driver;
115 * called from usb_audio_disconnect()
117 static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
120 struct snd_usb_substream *subs;
122 for (idx = 0; idx < 2; idx++) {
123 subs = &as->substream[idx];
124 if (!subs->num_formats)
126 subs->interface = -1;
127 subs->data_endpoint = NULL;
128 subs->sync_endpoint = NULL;
132 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
134 struct usb_device *dev = chip->dev;
135 struct usb_host_interface *alts;
136 struct usb_interface_descriptor *altsd;
137 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
140 dev_err(&dev->dev, "%u:%d : does not exist\n",
145 alts = &iface->altsetting[0];
146 altsd = get_iface_desc(alts);
149 * Android with both accessory and audio interfaces enabled gets the
150 * interface numbers wrong.
152 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
153 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
155 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
156 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
158 iface = usb_ifnum_to_if(dev, interface);
161 alts = &iface->altsetting[0];
162 altsd = get_iface_desc(alts);
165 if (usb_interface_claimed(iface)) {
166 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
171 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
172 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
173 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
174 int err = snd_usbmidi_create(chip->card, iface,
175 &chip->midi_list, NULL);
178 "%u:%d: cannot create sequencer device\n",
182 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
187 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
188 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
189 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
191 "%u:%d: skipping non-supported interface %d\n",
192 ctrlif, interface, altsd->bInterfaceClass);
193 /* skip non-supported classes */
197 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
198 dev_err(&dev->dev, "low speed audio streaming not supported\n");
202 if (! snd_usb_parse_audio_interface(chip, interface)) {
203 usb_set_interface(dev, interface, 0); /* reset the current interface */
204 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
211 * parse audio control descriptor and create pcm/midi streams
213 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
215 struct usb_device *dev = chip->dev;
216 struct usb_host_interface *host_iface;
217 struct usb_interface_descriptor *altsd;
218 void *control_header;
221 /* find audiocontrol interface */
222 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
223 control_header = snd_usb_find_csint_desc(host_iface->extra,
224 host_iface->extralen,
226 altsd = get_iface_desc(host_iface);
227 protocol = altsd->bInterfaceProtocol;
229 if (!control_header) {
230 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
237 "unknown interface protocol %#02x, assuming v1\n",
241 case UAC_VERSION_1: {
242 struct uac1_ac_header_descriptor *h1 = control_header;
244 if (!h1->bInCollection) {
245 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
249 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
250 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
254 for (i = 0; i < h1->bInCollection; i++)
255 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
260 case UAC_VERSION_2: {
261 struct usb_interface_assoc_descriptor *assoc =
262 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
266 * Firmware writers cannot count to three. So to find
267 * the IAD on the NuForce UDH-100, also check the next
270 struct usb_interface *iface =
271 usb_ifnum_to_if(dev, ctrlif + 1);
274 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
275 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
276 assoc = iface->intf_assoc;
280 dev_err(&dev->dev, "Audio class v2 interfaces need an interface association\n");
284 for (i = 0; i < assoc->bInterfaceCount; i++) {
285 int intf = assoc->bFirstInterface + i;
288 snd_usb_create_stream(chip, ctrlif, intf);
299 * free the chip instance
301 * here we have to do not much, since pcm and controls are already freed
305 static int snd_usb_audio_free(struct snd_usb_audio *chip)
307 struct snd_usb_endpoint *ep, *n;
309 list_for_each_entry_safe(ep, n, &chip->ep_list, list)
310 snd_usb_endpoint_free(ep);
312 mutex_destroy(&chip->mutex);
317 static int snd_usb_audio_dev_free(struct snd_device *device)
319 struct snd_usb_audio *chip = device->device_data;
320 return snd_usb_audio_free(chip);
324 * create a chip instance and set its names.
326 static int snd_usb_audio_create(struct usb_interface *intf,
327 struct usb_device *dev, int idx,
328 const struct snd_usb_audio_quirk *quirk,
329 struct snd_usb_audio **rchip)
331 struct snd_card *card;
332 struct snd_usb_audio *chip;
335 static struct snd_device_ops ops = {
336 .dev_free = snd_usb_audio_dev_free,
341 switch (snd_usb_get_speed(dev)) {
345 case USB_SPEED_WIRELESS:
346 case USB_SPEED_SUPER:
349 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
353 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
356 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
360 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
366 mutex_init(&chip->mutex);
367 init_waitqueue_head(&chip->shutdown_wait);
371 chip->setup = device_setup[idx];
372 chip->autoclock = autoclock;
373 atomic_set(&chip->active, 1); /* avoid autopm during probing */
374 atomic_set(&chip->usage_count, 0);
375 atomic_set(&chip->shutdown, 0);
377 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
378 le16_to_cpu(dev->descriptor.idProduct));
379 INIT_LIST_HEAD(&chip->pcm_list);
380 INIT_LIST_HEAD(&chip->ep_list);
381 INIT_LIST_HEAD(&chip->midi_list);
382 INIT_LIST_HEAD(&chip->mixer_list);
384 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
385 snd_usb_audio_free(chip);
390 strcpy(card->driver, "USB-Audio");
391 sprintf(component, "USB%04x:%04x",
392 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
393 snd_component_add(card, component);
395 /* retrieve the device string as shortname */
396 if (quirk && quirk->product_name && *quirk->product_name) {
397 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
399 if (!dev->descriptor.iProduct ||
400 usb_string(dev, dev->descriptor.iProduct,
401 card->shortname, sizeof(card->shortname)) <= 0) {
402 /* no name available from anywhere, so use ID */
403 sprintf(card->shortname, "USB Device %#04x:%#04x",
404 USB_ID_VENDOR(chip->usb_id),
405 USB_ID_PRODUCT(chip->usb_id));
408 strim(card->shortname);
410 /* retrieve the vendor and device strings as longname */
411 if (quirk && quirk->vendor_name && *quirk->vendor_name) {
412 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
414 if (dev->descriptor.iManufacturer)
415 len = usb_string(dev, dev->descriptor.iManufacturer,
416 card->longname, sizeof(card->longname));
419 /* we don't really care if there isn't any vendor string */
422 strim(card->longname);
424 strlcat(card->longname, " ", sizeof(card->longname));
427 strlcat(card->longname, card->shortname, sizeof(card->longname));
429 len = strlcat(card->longname, " at ", sizeof(card->longname));
431 if (len < sizeof(card->longname))
432 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
434 switch (snd_usb_get_speed(dev)) {
436 strlcat(card->longname, ", low speed", sizeof(card->longname));
439 strlcat(card->longname, ", full speed", sizeof(card->longname));
442 strlcat(card->longname, ", high speed", sizeof(card->longname));
444 case USB_SPEED_SUPER:
445 strlcat(card->longname, ", super speed", sizeof(card->longname));
451 snd_usb_audio_create_proc(chip);
458 * probe the active usb device
460 * note that this can be called multiple times per a device, when it
461 * includes multiple audio control interfaces.
463 * thus we check the usb device pointer and creates the card instance
464 * only at the first time. the successive calls of this function will
465 * append the pcm interface to the corresponding card.
467 static int usb_audio_probe(struct usb_interface *intf,
468 const struct usb_device_id *usb_id)
470 struct usb_device *dev = interface_to_usbdev(intf);
471 const struct snd_usb_audio_quirk *quirk =
472 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
473 struct snd_usb_audio *chip;
475 struct usb_host_interface *alts;
479 alts = &intf->altsetting[0];
480 ifnum = get_iface_desc(alts)->bInterfaceNumber;
481 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
482 le16_to_cpu(dev->descriptor.idProduct));
483 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
486 err = snd_usb_apply_boot_quirk(dev, intf, quirk);
491 * found a config. now register to ALSA
494 /* check whether it's already registered */
496 mutex_lock(®ister_mutex);
497 for (i = 0; i < SNDRV_CARDS; i++) {
498 if (usb_chip[i] && usb_chip[i]->dev == dev) {
499 if (atomic_read(&usb_chip[i]->shutdown)) {
500 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
505 atomic_inc(&chip->active); /* avoid autopm */
511 * now look for an empty slot and create a new card instance
513 for (i = 0; i < SNDRV_CARDS; i++)
514 if (enable[i] && ! usb_chip[i] &&
515 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
516 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
517 err = snd_usb_audio_create(intf, dev, i, quirk,
521 chip->pm_intf = intf;
525 dev_err(&dev->dev, "no available usb audio device\n");
532 * For devices with more than one control interface, we assume the
533 * first contains the audio controls. We might need a more specific
534 * check here in the future.
536 if (!chip->ctrl_intf)
537 chip->ctrl_intf = alts;
539 chip->txfr_quirk = 0;
540 err = 1; /* continue */
541 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
542 /* need some special handlings */
543 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
549 /* create normal USB audio interfaces */
550 err = snd_usb_create_streams(chip, ifnum);
553 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
558 /* we are allowed to call snd_card_register() many times */
559 err = snd_card_register(chip->card);
563 usb_chip[chip->index] = chip;
564 chip->num_interfaces++;
565 usb_set_intfdata(intf, chip);
566 atomic_dec(&chip->active);
567 mutex_unlock(®ister_mutex);
572 if (!chip->num_interfaces)
573 snd_card_free(chip->card);
574 atomic_dec(&chip->active);
576 mutex_unlock(®ister_mutex);
581 * we need to take care of counter, since disconnection can be called also
582 * many times as well as usb_audio_probe().
584 static void usb_audio_disconnect(struct usb_interface *intf)
586 struct snd_usb_audio *chip = usb_get_intfdata(intf);
587 struct snd_card *card;
590 if (chip == (void *)-1L)
595 mutex_lock(®ister_mutex);
596 if (atomic_inc_return(&chip->shutdown) == 1) {
597 struct snd_usb_stream *as;
598 struct snd_usb_endpoint *ep;
599 struct usb_mixer_interface *mixer;
601 /* wait until all pending tasks done;
602 * they are protected by snd_usb_lock_shutdown()
604 wait_event(chip->shutdown_wait,
605 !atomic_read(&chip->usage_count));
606 snd_card_disconnect(card);
607 /* release the pcm resources */
608 list_for_each_entry(as, &chip->pcm_list, list) {
609 snd_usb_stream_disconnect(as);
611 /* release the endpoint resources */
612 list_for_each_entry(ep, &chip->ep_list, list) {
613 snd_usb_endpoint_release(ep);
615 /* release the midi resources */
616 list_for_each(p, &chip->midi_list) {
617 snd_usbmidi_disconnect(p);
619 /* release mixer resources */
620 list_for_each_entry(mixer, &chip->mixer_list, list) {
621 snd_usb_mixer_disconnect(mixer);
625 chip->num_interfaces--;
626 if (chip->num_interfaces <= 0) {
627 usb_chip[chip->index] = NULL;
628 mutex_unlock(®ister_mutex);
629 snd_card_free_when_closed(card);
631 mutex_unlock(®ister_mutex);
635 /* lock the shutdown (disconnect) task and autoresume */
636 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
640 atomic_inc(&chip->usage_count);
641 if (atomic_read(&chip->shutdown)) {
645 err = snd_usb_autoresume(chip);
651 if (atomic_dec_and_test(&chip->usage_count))
652 wake_up(&chip->shutdown_wait);
656 /* autosuspend and unlock the shutdown */
657 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
659 snd_usb_autosuspend(chip);
660 if (atomic_dec_and_test(&chip->usage_count))
661 wake_up(&chip->shutdown_wait);
666 int snd_usb_autoresume(struct snd_usb_audio *chip)
668 if (atomic_read(&chip->shutdown))
670 if (atomic_inc_return(&chip->active) == 1)
671 return usb_autopm_get_interface(chip->pm_intf);
675 void snd_usb_autosuspend(struct snd_usb_audio *chip)
677 if (atomic_read(&chip->shutdown))
679 if (atomic_dec_and_test(&chip->active))
680 usb_autopm_put_interface(chip->pm_intf);
683 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
685 struct snd_usb_audio *chip = usb_get_intfdata(intf);
686 struct snd_usb_stream *as;
687 struct usb_mixer_interface *mixer;
690 if (chip == (void *)-1L)
693 chip->autosuspended = !!PMSG_IS_AUTO(message);
694 if (!chip->autosuspended)
695 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
696 if (!chip->num_suspended_intf++) {
697 list_for_each_entry(as, &chip->pcm_list, list) {
698 snd_pcm_suspend_all(as->pcm);
699 as->substream[0].need_setup_ep =
700 as->substream[1].need_setup_ep = true;
702 list_for_each(p, &chip->midi_list)
703 snd_usbmidi_suspend(p);
704 list_for_each_entry(mixer, &chip->mixer_list, list)
705 snd_usb_mixer_suspend(mixer);
711 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
713 struct snd_usb_audio *chip = usb_get_intfdata(intf);
714 struct usb_mixer_interface *mixer;
718 if (chip == (void *)-1L)
720 if (--chip->num_suspended_intf)
723 atomic_inc(&chip->active); /* avoid autopm */
725 * ALSA leaves material resumption to user space
726 * we just notify and restart the mixers
728 list_for_each_entry(mixer, &chip->mixer_list, list) {
729 err = snd_usb_mixer_resume(mixer, reset_resume);
734 list_for_each(p, &chip->midi_list) {
735 snd_usbmidi_resume(p);
738 if (!chip->autosuspended)
739 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
740 chip->autosuspended = 0;
743 atomic_dec(&chip->active); /* allow autopm after this point */
747 static int usb_audio_resume(struct usb_interface *intf)
749 return __usb_audio_resume(intf, false);
752 static int usb_audio_reset_resume(struct usb_interface *intf)
754 return __usb_audio_resume(intf, true);
757 #define usb_audio_suspend NULL
758 #define usb_audio_resume NULL
759 #define usb_audio_reset_resume NULL
760 #endif /* CONFIG_PM */
762 static struct usb_device_id usb_audio_ids [] = {
763 #include "quirks-table.h"
764 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
765 .bInterfaceClass = USB_CLASS_AUDIO,
766 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
767 { } /* Terminating entry */
769 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
772 * entry point for linux usb interface
775 static struct usb_driver usb_audio_driver = {
776 .name = "snd-usb-audio",
777 .probe = usb_audio_probe,
778 .disconnect = usb_audio_disconnect,
779 .suspend = usb_audio_suspend,
780 .resume = usb_audio_resume,
781 .reset_resume = usb_audio_reset_resume,
782 .id_table = usb_audio_ids,
783 .supports_autosuspend = 1,
786 module_usb_driver(usb_audio_driver);