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 snd_usb_audio_disconnect()
117 static void snd_usb_stream_disconnect(struct list_head *head)
120 struct snd_usb_stream *as;
121 struct snd_usb_substream *subs;
123 as = list_entry(head, struct snd_usb_stream, list);
124 for (idx = 0; idx < 2; idx++) {
125 subs = &as->substream[idx];
126 if (!subs->num_formats)
128 subs->interface = -1;
129 subs->data_endpoint = NULL;
130 subs->sync_endpoint = NULL;
134 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
136 struct usb_device *dev = chip->dev;
137 struct usb_host_interface *alts;
138 struct usb_interface_descriptor *altsd;
139 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
142 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
143 dev->devnum, ctrlif, interface);
147 alts = &iface->altsetting[0];
148 altsd = get_iface_desc(alts);
151 * Android with both accessory and audio interfaces enabled gets the
152 * interface numbers wrong.
154 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
155 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
157 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
158 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
160 iface = usb_ifnum_to_if(dev, interface);
163 alts = &iface->altsetting[0];
164 altsd = get_iface_desc(alts);
167 if (usb_interface_claimed(iface)) {
168 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n",
169 dev->devnum, ctrlif, interface);
173 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
174 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
175 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
176 int err = snd_usbmidi_create(chip->card, iface,
177 &chip->midi_list, NULL);
179 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n",
180 dev->devnum, ctrlif, interface);
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) {
191 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n",
192 dev->devnum, ctrlif, interface, altsd->bInterfaceClass);
193 /* skip non-supported classes */
197 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
198 snd_printk(KERN_ERR "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);
212 * parse audio control descriptor and create pcm/midi streams
214 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
216 struct usb_device *dev = chip->dev;
217 struct usb_host_interface *host_iface;
218 struct usb_interface_descriptor *altsd;
219 void *control_header;
222 /* find audiocontrol interface */
223 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
224 control_header = snd_usb_find_csint_desc(host_iface->extra,
225 host_iface->extralen,
227 altsd = get_iface_desc(host_iface);
228 protocol = altsd->bInterfaceProtocol;
230 if (!control_header) {
231 snd_printk(KERN_ERR "cannot find UAC_HEADER\n");
237 snd_printdd(KERN_WARNING "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 snd_printk(KERN_INFO "skipping empty audio interface (v1)\n");
249 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
250 snd_printk(KERN_ERR "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 snd_printk(KERN_ERR "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 mutex_destroy(&chip->mutex);
312 static int snd_usb_audio_dev_free(struct snd_device *device)
314 struct snd_usb_audio *chip = device->device_data;
315 return snd_usb_audio_free(chip);
318 static void remove_trailing_spaces(char *str)
324 for (p = str + strlen(str) - 1; p >= str && isspace(*p); p--)
329 * create a chip instance and set its names.
331 static int snd_usb_audio_create(struct usb_device *dev, int idx,
332 const struct snd_usb_audio_quirk *quirk,
333 struct snd_usb_audio **rchip)
335 struct snd_card *card;
336 struct snd_usb_audio *chip;
339 static struct snd_device_ops ops = {
340 .dev_free = snd_usb_audio_dev_free,
345 switch (snd_usb_get_speed(dev)) {
349 case USB_SPEED_SUPER:
352 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
356 err = snd_card_create(index[idx], id[idx], THIS_MODULE, 0, &card);
358 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
362 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
368 mutex_init(&chip->mutex);
369 init_rwsem(&chip->shutdown_rwsem);
373 chip->setup = device_setup[idx];
374 chip->autoclock = autoclock;
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 remove_trailing_spaces(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 remove_trailing_spaces(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 struct snd_usb_audio *
468 snd_usb_audio_probe(struct usb_device *dev,
469 struct usb_interface *intf,
470 const struct usb_device_id *usb_id)
472 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
474 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 if (snd_usb_apply_boot_quirk(dev, intf, quirk) < 0)
490 * found a config. now register to ALSA
493 /* check whether it's already registered */
495 mutex_lock(®ister_mutex);
496 for (i = 0; i < SNDRV_CARDS; i++) {
497 if (usb_chip[i] && usb_chip[i]->dev == dev) {
498 if (usb_chip[i]->shutdown) {
499 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
509 * now look for an empty slot and create a new card instance
511 for (i = 0; i < SNDRV_CARDS; i++)
512 if (enable[i] && ! usb_chip[i] &&
513 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
514 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
515 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
518 snd_card_set_dev(chip->card, &intf->dev);
519 chip->pm_intf = intf;
523 printk(KERN_ERR "no available usb audio device\n");
529 * For devices with more than one control interface, we assume the
530 * first contains the audio controls. We might need a more specific
531 * check here in the future.
533 if (!chip->ctrl_intf)
534 chip->ctrl_intf = alts;
536 chip->txfr_quirk = 0;
537 err = 1; /* continue */
538 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
539 /* need some special handlings */
540 if ((err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk)) < 0)
545 /* create normal USB audio interfaces */
546 if (snd_usb_create_streams(chip, ifnum) < 0 ||
547 snd_usb_create_mixer(chip, ifnum, ignore_ctl_error) < 0) {
552 /* we are allowed to call snd_card_register() many times */
553 if (snd_card_register(chip->card) < 0) {
557 usb_chip[chip->index] = chip;
558 chip->num_interfaces++;
560 mutex_unlock(®ister_mutex);
565 if (!chip->num_interfaces)
566 snd_card_free(chip->card);
569 mutex_unlock(®ister_mutex);
575 * we need to take care of counter, since disconnection can be called also
576 * many times as well as usb_audio_probe().
578 static void snd_usb_audio_disconnect(struct usb_device *dev,
579 struct snd_usb_audio *chip)
581 struct snd_card *card;
582 struct list_head *p, *n;
584 if (chip == (void *)-1L)
588 down_write(&chip->shutdown_rwsem);
590 up_write(&chip->shutdown_rwsem);
592 mutex_lock(®ister_mutex);
593 chip->num_interfaces--;
594 if (chip->num_interfaces <= 0) {
595 snd_card_disconnect(card);
596 /* release the pcm resources */
597 list_for_each(p, &chip->pcm_list) {
598 snd_usb_stream_disconnect(p);
600 /* release the endpoint resources */
601 list_for_each_safe(p, n, &chip->ep_list) {
602 snd_usb_endpoint_free(p);
604 /* release the midi resources */
605 list_for_each(p, &chip->midi_list) {
606 snd_usbmidi_disconnect(p);
608 /* release mixer resources */
609 list_for_each(p, &chip->mixer_list) {
610 snd_usb_mixer_disconnect(p);
612 usb_chip[chip->index] = NULL;
613 mutex_unlock(®ister_mutex);
614 snd_card_free_when_closed(card);
616 mutex_unlock(®ister_mutex);
621 * new 2.5 USB kernel API
623 static int usb_audio_probe(struct usb_interface *intf,
624 const struct usb_device_id *id)
626 struct snd_usb_audio *chip;
627 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
629 usb_set_intfdata(intf, chip);
635 static void usb_audio_disconnect(struct usb_interface *intf)
637 snd_usb_audio_disconnect(interface_to_usbdev(intf),
638 usb_get_intfdata(intf));
643 int snd_usb_autoresume(struct snd_usb_audio *chip)
647 down_read(&chip->shutdown_rwsem);
650 else if (!chip->shutdown)
651 err = usb_autopm_get_interface(chip->pm_intf);
652 up_read(&chip->shutdown_rwsem);
657 void snd_usb_autosuspend(struct snd_usb_audio *chip)
659 down_read(&chip->shutdown_rwsem);
660 if (!chip->shutdown && !chip->probing)
661 usb_autopm_put_interface(chip->pm_intf);
662 up_read(&chip->shutdown_rwsem);
665 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
667 struct snd_usb_audio *chip = usb_get_intfdata(intf);
668 struct snd_usb_stream *as;
669 struct usb_mixer_interface *mixer;
671 if (chip == (void *)-1L)
674 if (!PMSG_IS_AUTO(message)) {
675 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
676 if (!chip->num_suspended_intf++) {
677 list_for_each_entry(as, &chip->pcm_list, list) {
678 snd_pcm_suspend_all(as->pcm);
679 as->substream[0].need_setup_ep =
680 as->substream[1].need_setup_ep = true;
685 * otherwise we keep the rest of the system in the dark
686 * to keep this transparent
688 if (!chip->num_suspended_intf++)
689 chip->autosuspended = 1;
692 list_for_each_entry(mixer, &chip->mixer_list, list)
693 snd_usb_mixer_inactivate(mixer);
698 static int usb_audio_resume(struct usb_interface *intf)
700 struct snd_usb_audio *chip = usb_get_intfdata(intf);
701 struct usb_mixer_interface *mixer;
704 if (chip == (void *)-1L)
706 if (--chip->num_suspended_intf)
709 * ALSA leaves material resumption to user space
710 * we just notify and restart the mixers
712 list_for_each_entry(mixer, &chip->mixer_list, list) {
713 err = snd_usb_mixer_activate(mixer);
718 if (!chip->autosuspended)
719 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
720 chip->autosuspended = 0;
726 #define usb_audio_suspend NULL
727 #define usb_audio_resume NULL
728 #endif /* CONFIG_PM */
730 static struct usb_device_id usb_audio_ids [] = {
731 #include "quirks-table.h"
732 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
733 .bInterfaceClass = USB_CLASS_AUDIO,
734 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
735 { } /* Terminating entry */
737 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
740 * entry point for linux usb interface
743 static struct usb_driver usb_audio_driver = {
744 .name = "snd-usb-audio",
745 .probe = usb_audio_probe,
746 .disconnect = usb_audio_disconnect,
747 .suspend = usb_audio_suspend,
748 .resume = usb_audio_resume,
749 .id_table = usb_audio_ids,
750 .supports_autosuspend = 1,
753 static int __init snd_usb_audio_init(void)
755 return usb_register(&usb_audio_driver);
758 static void __exit snd_usb_audio_cleanup(void)
760 usb_deregister(&usb_audio_driver);
763 module_init(snd_usb_audio_init);
764 module_exit(snd_usb_audio_cleanup);