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 * - async unlink should be used for avoiding the sleep inside lock.
29 * 2.4.22 usb-uhci seems buggy for async unlinking and results in
30 * oops. in such a cse, pass async_unlink=0 option.
31 * - the linked URBs would be preferred but not used so far because of
32 * the instability of unlinking.
33 * - type II is not supported properly. there is no device which supports
34 * this type *correctly*. SB extigy looks as if it supports, but it's
35 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
39 #include <linux/bitops.h>
40 #include <linux/init.h>
41 #include <linux/list.h>
42 #include <linux/slab.h>
43 #include <linux/string.h>
44 #include <linux/ctype.h>
45 #include <linux/usb.h>
46 #include <linux/moduleparam.h>
47 #include <linux/mutex.h>
48 #include <linux/usb/audio.h>
49 #include <linux/usb/audio-v2.h>
50 #include <linux/module.h>
52 #include <sound/control.h>
53 #include <sound/core.h>
54 #include <sound/info.h>
55 #include <sound/pcm.h>
56 #include <sound/pcm_params.h>
57 #include <sound/initval.h>
73 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
74 MODULE_DESCRIPTION("USB Audio");
75 MODULE_LICENSE("GPL");
76 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
79 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
80 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
81 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
82 /* Vendor/product IDs for this card */
83 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
84 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
85 static int nrpacks = 8; /* max. number of packets per urb */
86 static int async_unlink = 1;
87 static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
88 static int ignore_ctl_error;
90 module_param_array(index, int, NULL, 0444);
91 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
92 module_param_array(id, charp, NULL, 0444);
93 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
94 module_param_array(enable, bool, NULL, 0444);
95 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
96 module_param_array(vid, int, NULL, 0444);
97 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
98 module_param_array(pid, int, NULL, 0444);
99 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
100 module_param(nrpacks, int, 0644);
101 MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
102 module_param(async_unlink, bool, 0444);
103 MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
104 module_param_array(device_setup, int, NULL, 0444);
105 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
106 module_param(ignore_ctl_error, bool, 0444);
107 MODULE_PARM_DESC(ignore_ctl_error,
108 "Ignore errors from USB controller for mixer interfaces.");
111 * we keep the snd_usb_audio_t instances by ourselves for merging
112 * the all interfaces on the same card as one sound device.
115 static DEFINE_MUTEX(register_mutex);
116 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
117 static struct usb_driver usb_audio_driver;
121 * called from snd_usb_audio_disconnect()
123 static void snd_usb_stream_disconnect(struct list_head *head)
126 struct snd_usb_stream *as;
127 struct snd_usb_substream *subs;
129 as = list_entry(head, struct snd_usb_stream, list);
130 for (idx = 0; idx < 2; idx++) {
131 subs = &as->substream[idx];
132 if (!subs->num_formats)
134 snd_usb_release_substream_urbs(subs, 1);
135 subs->interface = -1;
139 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
141 struct usb_device *dev = chip->dev;
142 struct usb_host_interface *alts;
143 struct usb_interface_descriptor *altsd;
144 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
147 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
148 dev->devnum, ctrlif, interface);
152 alts = &iface->altsetting[0];
153 altsd = get_iface_desc(alts);
156 * Android with both accessory and audio interfaces enabled gets the
157 * interface numbers wrong.
159 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
160 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
162 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
163 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
165 iface = usb_ifnum_to_if(dev, interface);
168 alts = &iface->altsetting[0];
169 altsd = get_iface_desc(alts);
172 if (usb_interface_claimed(iface)) {
173 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n",
174 dev->devnum, ctrlif, interface);
178 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
179 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
180 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
181 int err = snd_usbmidi_create(chip->card, iface,
182 &chip->midi_list, NULL);
184 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n",
185 dev->devnum, ctrlif, interface);
188 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
193 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
194 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
195 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
196 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n",
197 dev->devnum, ctrlif, interface, altsd->bInterfaceClass);
198 /* skip non-supported classes */
202 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
203 snd_printk(KERN_ERR "low speed audio streaming not supported\n");
207 if (! snd_usb_parse_audio_interface(chip, interface)) {
208 usb_set_interface(dev, interface, 0); /* reset the current interface */
209 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
217 * parse audio control descriptor and create pcm/midi streams
219 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
221 struct usb_device *dev = chip->dev;
222 struct usb_host_interface *host_iface;
223 struct usb_interface_descriptor *altsd;
224 void *control_header;
227 /* find audiocontrol interface */
228 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
229 control_header = snd_usb_find_csint_desc(host_iface->extra,
230 host_iface->extralen,
232 altsd = get_iface_desc(host_iface);
233 protocol = altsd->bInterfaceProtocol;
235 if (!control_header) {
236 snd_printk(KERN_ERR "cannot find UAC_HEADER\n");
242 snd_printdd(KERN_WARNING "unknown interface protocol %#02x, assuming v1\n",
246 case UAC_VERSION_1: {
247 struct uac1_ac_header_descriptor *h1 = control_header;
249 if (!h1->bInCollection) {
250 snd_printk(KERN_INFO "skipping empty audio interface (v1)\n");
254 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
255 snd_printk(KERN_ERR "invalid UAC_HEADER (v1)\n");
259 for (i = 0; i < h1->bInCollection; i++)
260 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
265 case UAC_VERSION_2: {
266 struct usb_interface_assoc_descriptor *assoc =
267 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
270 snd_printk(KERN_ERR "Audio class v2 interfaces need an interface association\n");
274 for (i = 0; i < assoc->bInterfaceCount; i++) {
275 int intf = assoc->bFirstInterface + i;
278 snd_usb_create_stream(chip, ctrlif, intf);
289 * free the chip instance
291 * here we have to do not much, since pcm and controls are already freed
295 static int snd_usb_audio_free(struct snd_usb_audio *chip)
301 static int snd_usb_audio_dev_free(struct snd_device *device)
303 struct snd_usb_audio *chip = device->device_data;
304 return snd_usb_audio_free(chip);
307 static void remove_trailing_spaces(char *str)
313 for (p = str + strlen(str) - 1; p >= str && isspace(*p); p--)
318 * create a chip instance and set its names.
320 static int snd_usb_audio_create(struct usb_device *dev, int idx,
321 const struct snd_usb_audio_quirk *quirk,
322 struct snd_usb_audio **rchip)
324 struct snd_card *card;
325 struct snd_usb_audio *chip;
328 static struct snd_device_ops ops = {
329 .dev_free = snd_usb_audio_dev_free,
334 switch (snd_usb_get_speed(dev)) {
338 case USB_SPEED_SUPER:
341 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
345 err = snd_card_create(index[idx], id[idx], THIS_MODULE, 0, &card);
347 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
351 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
357 init_rwsem(&chip->shutdown_rwsem);
361 chip->setup = device_setup[idx];
362 chip->nrpacks = nrpacks;
363 chip->async_unlink = async_unlink;
366 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
367 le16_to_cpu(dev->descriptor.idProduct));
368 INIT_LIST_HEAD(&chip->pcm_list);
369 INIT_LIST_HEAD(&chip->midi_list);
370 INIT_LIST_HEAD(&chip->mixer_list);
372 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
373 snd_usb_audio_free(chip);
378 strcpy(card->driver, "USB-Audio");
379 sprintf(component, "USB%04x:%04x",
380 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
381 snd_component_add(card, component);
383 /* retrieve the device string as shortname */
384 if (quirk && quirk->product_name && *quirk->product_name) {
385 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
387 if (!dev->descriptor.iProduct ||
388 usb_string(dev, dev->descriptor.iProduct,
389 card->shortname, sizeof(card->shortname)) <= 0) {
390 /* no name available from anywhere, so use ID */
391 sprintf(card->shortname, "USB Device %#04x:%#04x",
392 USB_ID_VENDOR(chip->usb_id),
393 USB_ID_PRODUCT(chip->usb_id));
396 remove_trailing_spaces(card->shortname);
398 /* retrieve the vendor and device strings as longname */
399 if (quirk && quirk->vendor_name && *quirk->vendor_name) {
400 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
402 if (dev->descriptor.iManufacturer)
403 len = usb_string(dev, dev->descriptor.iManufacturer,
404 card->longname, sizeof(card->longname));
407 /* we don't really care if there isn't any vendor string */
410 remove_trailing_spaces(card->longname);
412 strlcat(card->longname, " ", sizeof(card->longname));
415 strlcat(card->longname, card->shortname, sizeof(card->longname));
417 len = strlcat(card->longname, " at ", sizeof(card->longname));
419 if (len < sizeof(card->longname))
420 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
422 switch (snd_usb_get_speed(dev)) {
424 strlcat(card->longname, ", low speed", sizeof(card->longname));
427 strlcat(card->longname, ", full speed", sizeof(card->longname));
430 strlcat(card->longname, ", high speed", sizeof(card->longname));
432 case USB_SPEED_SUPER:
433 strlcat(card->longname, ", super speed", sizeof(card->longname));
439 snd_usb_audio_create_proc(chip);
446 * probe the active usb device
448 * note that this can be called multiple times per a device, when it
449 * includes multiple audio control interfaces.
451 * thus we check the usb device pointer and creates the card instance
452 * only at the first time. the successive calls of this function will
453 * append the pcm interface to the corresponding card.
455 static struct snd_usb_audio *
456 snd_usb_audio_probe(struct usb_device *dev,
457 struct usb_interface *intf,
458 const struct usb_device_id *usb_id)
460 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
462 struct snd_usb_audio *chip;
463 struct usb_host_interface *alts;
467 alts = &intf->altsetting[0];
468 ifnum = get_iface_desc(alts)->bInterfaceNumber;
469 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
470 le16_to_cpu(dev->descriptor.idProduct));
471 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
474 if (snd_usb_apply_boot_quirk(dev, intf, quirk) < 0)
478 * found a config. now register to ALSA
481 /* check whether it's already registered */
483 mutex_lock(®ister_mutex);
484 for (i = 0; i < SNDRV_CARDS; i++) {
485 if (usb_chip[i] && usb_chip[i]->dev == dev) {
486 if (usb_chip[i]->shutdown) {
487 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
497 * now look for an empty slot and create a new card instance
499 for (i = 0; i < SNDRV_CARDS; i++)
500 if (enable[i] && ! usb_chip[i] &&
501 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
502 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
503 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
506 snd_card_set_dev(chip->card, &intf->dev);
507 chip->pm_intf = intf;
511 printk(KERN_ERR "no available usb audio device\n");
517 * For devices with more than one control interface, we assume the
518 * first contains the audio controls. We might need a more specific
519 * check here in the future.
521 if (!chip->ctrl_intf)
522 chip->ctrl_intf = alts;
524 chip->txfr_quirk = 0;
525 err = 1; /* continue */
526 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
527 /* need some special handlings */
528 if ((err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk)) < 0)
533 /* create normal USB audio interfaces */
534 if (snd_usb_create_streams(chip, ifnum) < 0 ||
535 snd_usb_create_mixer(chip, ifnum, ignore_ctl_error) < 0) {
540 /* we are allowed to call snd_card_register() many times */
541 if (snd_card_register(chip->card) < 0) {
545 usb_chip[chip->index] = chip;
546 chip->num_interfaces++;
548 mutex_unlock(®ister_mutex);
553 if (!chip->num_interfaces)
554 snd_card_free(chip->card);
557 mutex_unlock(®ister_mutex);
563 * we need to take care of counter, since disconnection can be called also
564 * many times as well as usb_audio_probe().
566 static void snd_usb_audio_disconnect(struct usb_device *dev,
567 struct snd_usb_audio *chip)
569 struct snd_card *card;
573 if (chip == (void *)-1L)
577 down_write(&chip->shutdown_rwsem);
578 was_shutdown = chip->shutdown;
580 up_write(&chip->shutdown_rwsem);
582 mutex_lock(®ister_mutex);
584 snd_card_disconnect(card);
585 /* release the pcm resources */
586 list_for_each(p, &chip->pcm_list) {
587 snd_usb_stream_disconnect(p);
589 /* release the midi resources */
590 list_for_each(p, &chip->midi_list) {
591 snd_usbmidi_disconnect(p);
593 /* release mixer resources */
594 list_for_each(p, &chip->mixer_list) {
595 snd_usb_mixer_disconnect(p);
599 chip->num_interfaces--;
600 if (chip->num_interfaces <= 0) {
601 usb_chip[chip->index] = NULL;
602 mutex_unlock(®ister_mutex);
603 snd_card_free_when_closed(card);
605 mutex_unlock(®ister_mutex);
610 * new 2.5 USB kernel API
612 static int usb_audio_probe(struct usb_interface *intf,
613 const struct usb_device_id *id)
615 struct snd_usb_audio *chip;
616 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
618 usb_set_intfdata(intf, chip);
624 static void usb_audio_disconnect(struct usb_interface *intf)
626 snd_usb_audio_disconnect(interface_to_usbdev(intf),
627 usb_get_intfdata(intf));
632 int snd_usb_autoresume(struct snd_usb_audio *chip)
636 down_read(&chip->shutdown_rwsem);
639 else if (!chip->shutdown)
640 err = usb_autopm_get_interface(chip->pm_intf);
641 up_read(&chip->shutdown_rwsem);
646 void snd_usb_autosuspend(struct snd_usb_audio *chip)
648 down_read(&chip->shutdown_rwsem);
649 if (!chip->shutdown && !chip->probing)
650 usb_autopm_put_interface(chip->pm_intf);
651 up_read(&chip->shutdown_rwsem);
654 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
656 struct snd_usb_audio *chip = usb_get_intfdata(intf);
658 struct snd_usb_stream *as;
659 struct usb_mixer_interface *mixer;
661 if (chip == (void *)-1L)
664 if (!PMSG_IS_AUTO(message)) {
665 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
666 if (!chip->num_suspended_intf++) {
667 list_for_each(p, &chip->pcm_list) {
668 as = list_entry(p, struct snd_usb_stream, list);
669 snd_pcm_suspend_all(as->pcm);
674 * otherwise we keep the rest of the system in the dark
675 * to keep this transparent
677 if (!chip->num_suspended_intf++)
678 chip->autosuspended = 1;
681 list_for_each_entry(mixer, &chip->mixer_list, list)
682 snd_usb_mixer_inactivate(mixer);
687 static int usb_audio_resume(struct usb_interface *intf)
689 struct snd_usb_audio *chip = usb_get_intfdata(intf);
690 struct usb_mixer_interface *mixer;
693 if (chip == (void *)-1L)
695 if (--chip->num_suspended_intf)
698 * ALSA leaves material resumption to user space
699 * we just notify and restart the mixers
701 list_for_each_entry(mixer, &chip->mixer_list, list) {
702 err = snd_usb_mixer_activate(mixer);
707 if (!chip->autosuspended)
708 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
709 chip->autosuspended = 0;
715 #define usb_audio_suspend NULL
716 #define usb_audio_resume NULL
717 #endif /* CONFIG_PM */
719 static struct usb_device_id usb_audio_ids [] = {
720 #include "quirks-table.h"
721 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
722 .bInterfaceClass = USB_CLASS_AUDIO,
723 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
724 { } /* Terminating entry */
727 MODULE_DEVICE_TABLE (usb, usb_audio_ids);
730 * entry point for linux usb interface
733 static struct usb_driver usb_audio_driver = {
734 .name = "snd-usb-audio",
735 .probe = usb_audio_probe,
736 .disconnect = usb_audio_disconnect,
737 .suspend = usb_audio_suspend,
738 .resume = usb_audio_resume,
739 .id_table = usb_audio_ids,
740 .supports_autosuspend = 1,
743 static int __init snd_usb_audio_init(void)
745 if (nrpacks < 1 || nrpacks > MAX_PACKS) {
746 printk(KERN_WARNING "invalid nrpacks value.\n");
749 return usb_register(&usb_audio_driver);
752 static void __exit snd_usb_audio_cleanup(void)
754 usb_deregister(&usb_audio_driver);
757 module_init(snd_usb_audio_init);
758 module_exit(snd_usb_audio_cleanup);