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>
51 #include <sound/control.h>
52 #include <sound/core.h>
53 #include <sound/info.h>
54 #include <sound/pcm.h>
55 #include <sound/pcm_params.h>
56 #include <sound/initval.h>
72 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
73 MODULE_DESCRIPTION("USB Audio");
74 MODULE_LICENSE("GPL");
75 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
78 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
79 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
80 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;/* Enable this card */
81 /* Vendor/product IDs for this card */
82 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
83 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
84 static int nrpacks
= 8; /* max. number of packets per urb */
85 static int async_unlink
= 1;
86 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card */
87 static int ignore_ctl_error
;
89 module_param_array(index
, int, NULL
, 0444);
90 MODULE_PARM_DESC(index
, "Index value for the USB audio adapter.");
91 module_param_array(id
, charp
, NULL
, 0444);
92 MODULE_PARM_DESC(id
, "ID string for the USB audio adapter.");
93 module_param_array(enable
, bool, NULL
, 0444);
94 MODULE_PARM_DESC(enable
, "Enable USB audio adapter.");
95 module_param_array(vid
, int, NULL
, 0444);
96 MODULE_PARM_DESC(vid
, "Vendor ID for the USB audio device.");
97 module_param_array(pid
, int, NULL
, 0444);
98 MODULE_PARM_DESC(pid
, "Product ID for the USB audio device.");
99 module_param(nrpacks
, int, 0644);
100 MODULE_PARM_DESC(nrpacks
, "Max. number of packets per URB.");
101 module_param(async_unlink
, bool, 0444);
102 MODULE_PARM_DESC(async_unlink
, "Use async unlink mode.");
103 module_param_array(device_setup
, int, NULL
, 0444);
104 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
105 module_param(ignore_ctl_error
, bool, 0444);
106 MODULE_PARM_DESC(ignore_ctl_error
,
107 "Ignore errors from USB controller for mixer interfaces.");
110 * we keep the snd_usb_audio_t instances by ourselves for merging
111 * the all interfaces on the same card as one sound device.
114 static DEFINE_MUTEX(register_mutex
);
115 static struct snd_usb_audio
*usb_chip
[SNDRV_CARDS
];
116 static struct usb_driver usb_audio_driver
;
120 * called from snd_usb_audio_disconnect()
122 static void snd_usb_stream_disconnect(struct list_head
*head
)
125 struct snd_usb_stream
*as
;
126 struct snd_usb_substream
*subs
;
128 as
= list_entry(head
, struct snd_usb_stream
, list
);
129 for (idx
= 0; idx
< 2; idx
++) {
130 subs
= &as
->substream
[idx
];
131 if (!subs
->num_formats
)
133 snd_usb_release_substream_urbs(subs
, 1);
134 subs
->interface
= -1;
138 static int snd_usb_create_stream(struct snd_usb_audio
*chip
, int ctrlif
, int interface
)
140 struct usb_device
*dev
= chip
->dev
;
141 struct usb_host_interface
*alts
;
142 struct usb_interface_descriptor
*altsd
;
143 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, interface
);
146 snd_printk(KERN_ERR
"%d:%u:%d : does not exist\n",
147 dev
->devnum
, ctrlif
, interface
);
151 if (usb_interface_claimed(iface
)) {
152 snd_printdd(KERN_INFO
"%d:%d:%d: skipping, already claimed\n",
153 dev
->devnum
, ctrlif
, interface
);
157 alts
= &iface
->altsetting
[0];
158 altsd
= get_iface_desc(alts
);
159 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
160 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
161 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDISTREAMING
) {
162 int err
= snd_usbmidi_create(chip
->card
, iface
,
163 &chip
->midi_list
, NULL
);
165 snd_printk(KERN_ERR
"%d:%u:%d: cannot create sequencer device\n",
166 dev
->devnum
, ctrlif
, interface
);
169 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
174 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
175 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
176 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
) {
177 snd_printdd(KERN_ERR
"%d:%u:%d: skipping non-supported interface %d\n",
178 dev
->devnum
, ctrlif
, interface
, altsd
->bInterfaceClass
);
179 /* skip non-supported classes */
183 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
184 snd_printk(KERN_ERR
"low speed audio streaming not supported\n");
188 if (! snd_usb_parse_audio_endpoints(chip
, interface
)) {
189 usb_set_interface(dev
, interface
, 0); /* reset the current interface */
190 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
198 * parse audio control descriptor and create pcm/midi streams
200 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
202 struct usb_device
*dev
= chip
->dev
;
203 struct usb_host_interface
*host_iface
;
204 struct usb_interface_descriptor
*altsd
;
205 void *control_header
;
208 /* find audiocontrol interface */
209 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
210 control_header
= snd_usb_find_csint_desc(host_iface
->extra
,
211 host_iface
->extralen
,
213 altsd
= get_iface_desc(host_iface
);
214 protocol
= altsd
->bInterfaceProtocol
;
216 if (!control_header
) {
217 snd_printk(KERN_ERR
"cannot find UAC_HEADER\n");
223 snd_printdd(KERN_WARNING
"unknown interface protocol %#02x, assuming v1\n",
227 case UAC_VERSION_1
: {
228 struct uac1_ac_header_descriptor
*h1
= control_header
;
230 if (!h1
->bInCollection
) {
231 snd_printk(KERN_INFO
"skipping empty audio interface (v1)\n");
235 if (h1
->bLength
< sizeof(*h1
) + h1
->bInCollection
) {
236 snd_printk(KERN_ERR
"invalid UAC_HEADER (v1)\n");
240 for (i
= 0; i
< h1
->bInCollection
; i
++)
241 snd_usb_create_stream(chip
, ctrlif
, h1
->baInterfaceNr
[i
]);
246 case UAC_VERSION_2
: {
247 struct usb_interface_assoc_descriptor
*assoc
=
248 usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
251 snd_printk(KERN_ERR
"Audio class v2 interfaces need an interface association\n");
255 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
256 int intf
= assoc
->bFirstInterface
+ i
;
259 snd_usb_create_stream(chip
, ctrlif
, intf
);
270 * free the chip instance
272 * here we have to do not much, since pcm and controls are already freed
276 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
282 static int snd_usb_audio_dev_free(struct snd_device
*device
)
284 struct snd_usb_audio
*chip
= device
->device_data
;
285 return snd_usb_audio_free(chip
);
288 static void remove_trailing_spaces(char *str
)
294 for (p
= str
+ strlen(str
) - 1; p
>= str
&& isspace(*p
); p
--)
299 * create a chip instance and set its names.
301 static int snd_usb_audio_create(struct usb_device
*dev
, int idx
,
302 const struct snd_usb_audio_quirk
*quirk
,
303 struct snd_usb_audio
**rchip
)
305 struct snd_card
*card
;
306 struct snd_usb_audio
*chip
;
309 static struct snd_device_ops ops
= {
310 .dev_free
= snd_usb_audio_dev_free
,
315 switch (snd_usb_get_speed(dev
)) {
319 case USB_SPEED_SUPER
:
322 snd_printk(KERN_ERR
"unknown device speed %d\n", snd_usb_get_speed(dev
));
326 err
= snd_card_create(index
[idx
], id
[idx
], THIS_MODULE
, 0, &card
);
328 snd_printk(KERN_ERR
"cannot create card instance %d\n", idx
);
332 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
338 mutex_init(&chip
->shutdown_mutex
);
342 chip
->setup
= device_setup
[idx
];
343 chip
->nrpacks
= nrpacks
;
344 chip
->async_unlink
= async_unlink
;
347 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
348 le16_to_cpu(dev
->descriptor
.idProduct
));
349 INIT_LIST_HEAD(&chip
->pcm_list
);
350 INIT_LIST_HEAD(&chip
->midi_list
);
351 INIT_LIST_HEAD(&chip
->mixer_list
);
353 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
354 snd_usb_audio_free(chip
);
359 strcpy(card
->driver
, "USB-Audio");
360 sprintf(component
, "USB%04x:%04x",
361 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
362 snd_component_add(card
, component
);
364 /* retrieve the device string as shortname */
365 if (quirk
&& quirk
->product_name
&& *quirk
->product_name
) {
366 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
368 if (!dev
->descriptor
.iProduct
||
369 usb_string(dev
, dev
->descriptor
.iProduct
,
370 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
371 /* no name available from anywhere, so use ID */
372 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
373 USB_ID_VENDOR(chip
->usb_id
),
374 USB_ID_PRODUCT(chip
->usb_id
));
377 remove_trailing_spaces(card
->shortname
);
379 /* retrieve the vendor and device strings as longname */
380 if (quirk
&& quirk
->vendor_name
&& *quirk
->vendor_name
) {
381 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
383 if (dev
->descriptor
.iManufacturer
)
384 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
385 card
->longname
, sizeof(card
->longname
));
388 /* we don't really care if there isn't any vendor string */
391 remove_trailing_spaces(card
->longname
);
393 strlcat(card
->longname
, " ", sizeof(card
->longname
));
396 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
398 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
400 if (len
< sizeof(card
->longname
))
401 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
403 switch (snd_usb_get_speed(dev
)) {
405 strlcat(card
->longname
, ", low speed", sizeof(card
->longname
));
408 strlcat(card
->longname
, ", full speed", sizeof(card
->longname
));
411 strlcat(card
->longname
, ", high speed", sizeof(card
->longname
));
413 case USB_SPEED_SUPER
:
414 strlcat(card
->longname
, ", super speed", sizeof(card
->longname
));
420 snd_usb_audio_create_proc(chip
);
427 * probe the active usb device
429 * note that this can be called multiple times per a device, when it
430 * includes multiple audio control interfaces.
432 * thus we check the usb device pointer and creates the card instance
433 * only at the first time. the successive calls of this function will
434 * append the pcm interface to the corresponding card.
436 static void *snd_usb_audio_probe(struct usb_device
*dev
,
437 struct usb_interface
*intf
,
438 const struct usb_device_id
*usb_id
)
440 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
442 struct snd_usb_audio
*chip
;
443 struct usb_host_interface
*alts
;
447 alts
= &intf
->altsetting
[0];
448 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
449 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
450 le16_to_cpu(dev
->descriptor
.idProduct
));
451 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
454 if (snd_usb_apply_boot_quirk(dev
, intf
, quirk
) < 0)
458 * found a config. now register to ALSA
461 /* check whether it's already registered */
463 mutex_lock(®ister_mutex
);
464 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
465 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
466 if (usb_chip
[i
]->shutdown
) {
467 snd_printk(KERN_ERR
"USB device is in the shutdown state, cannot create a card instance\n");
477 * now look for an empty slot and create a new card instance
479 for (i
= 0; i
< SNDRV_CARDS
; i
++)
480 if (enable
[i
] && ! usb_chip
[i
] &&
481 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
482 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
483 if (snd_usb_audio_create(dev
, i
, quirk
, &chip
) < 0) {
486 snd_card_set_dev(chip
->card
, &intf
->dev
);
487 chip
->pm_intf
= intf
;
491 printk(KERN_ERR
"no available usb audio device\n");
497 * For devices with more than one control interface, we assume the
498 * first contains the audio controls. We might need a more specific
499 * check here in the future.
501 if (!chip
->ctrl_intf
)
502 chip
->ctrl_intf
= alts
;
504 chip
->txfr_quirk
= 0;
505 err
= 1; /* continue */
506 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
507 /* need some special handlings */
508 if ((err
= snd_usb_create_quirk(chip
, intf
, &usb_audio_driver
, quirk
)) < 0)
513 /* create normal USB audio interfaces */
514 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
515 snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
) < 0) {
520 /* we are allowed to call snd_card_register() many times */
521 if (snd_card_register(chip
->card
) < 0) {
525 usb_chip
[chip
->index
] = chip
;
526 chip
->num_interfaces
++;
528 mutex_unlock(®ister_mutex
);
532 if (chip
&& !chip
->num_interfaces
)
533 snd_card_free(chip
->card
);
534 mutex_unlock(®ister_mutex
);
540 * we need to take care of counter, since disconnection can be called also
541 * many times as well as usb_audio_probe().
543 static void snd_usb_audio_disconnect(struct usb_device
*dev
, void *ptr
)
545 struct snd_usb_audio
*chip
;
546 struct snd_card
*card
;
549 if (ptr
== (void *)-1L)
554 mutex_lock(®ister_mutex
);
555 mutex_lock(&chip
->shutdown_mutex
);
557 chip
->num_interfaces
--;
558 if (chip
->num_interfaces
<= 0) {
559 snd_card_disconnect(card
);
560 /* release the pcm resources */
561 list_for_each(p
, &chip
->pcm_list
) {
562 snd_usb_stream_disconnect(p
);
564 /* release the midi resources */
565 list_for_each(p
, &chip
->midi_list
) {
566 snd_usbmidi_disconnect(p
);
568 /* release mixer resources */
569 list_for_each(p
, &chip
->mixer_list
) {
570 snd_usb_mixer_disconnect(p
);
572 usb_chip
[chip
->index
] = NULL
;
573 mutex_unlock(&chip
->shutdown_mutex
);
574 mutex_unlock(®ister_mutex
);
575 snd_card_free_when_closed(card
);
577 mutex_unlock(&chip
->shutdown_mutex
);
578 mutex_unlock(®ister_mutex
);
583 * new 2.5 USB kernel API
585 static int usb_audio_probe(struct usb_interface
*intf
,
586 const struct usb_device_id
*id
)
589 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
591 usb_set_intfdata(intf
, chip
);
597 static void usb_audio_disconnect(struct usb_interface
*intf
)
599 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
600 usb_get_intfdata(intf
));
605 int snd_usb_autoresume(struct snd_usb_audio
*chip
)
609 if (!chip
->shutdown
&& !chip
->probing
)
610 err
= usb_autopm_get_interface(chip
->pm_intf
);
615 void snd_usb_autosuspend(struct snd_usb_audio
*chip
)
617 if (!chip
->shutdown
&& !chip
->probing
)
618 usb_autopm_put_interface(chip
->pm_intf
);
621 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
623 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
625 struct snd_usb_stream
*as
;
626 struct usb_mixer_interface
*mixer
;
628 if (chip
== (void *)-1L)
631 if (!(message
.event
& PM_EVENT_AUTO
)) {
632 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
633 if (!chip
->num_suspended_intf
++) {
634 list_for_each(p
, &chip
->pcm_list
) {
635 as
= list_entry(p
, struct snd_usb_stream
, list
);
636 snd_pcm_suspend_all(as
->pcm
);
641 * otherwise we keep the rest of the system in the dark
642 * to keep this transparent
644 if (!chip
->num_suspended_intf
++)
645 chip
->autosuspended
= 1;
648 list_for_each_entry(mixer
, &chip
->mixer_list
, list
)
649 snd_usb_mixer_inactivate(mixer
);
654 static int usb_audio_resume(struct usb_interface
*intf
)
656 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
657 struct usb_mixer_interface
*mixer
;
660 if (chip
== (void *)-1L)
662 if (--chip
->num_suspended_intf
)
665 * ALSA leaves material resumption to user space
666 * we just notify and restart the mixers
668 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
669 err
= snd_usb_mixer_activate(mixer
);
674 if (!chip
->autosuspended
)
675 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
676 chip
->autosuspended
= 0;
682 #define usb_audio_suspend NULL
683 #define usb_audio_resume NULL
684 #endif /* CONFIG_PM */
686 static struct usb_device_id usb_audio_ids
[] = {
687 #include "quirks-table.h"
688 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
689 .bInterfaceClass
= USB_CLASS_AUDIO
,
690 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
691 { } /* Terminating entry */
694 MODULE_DEVICE_TABLE (usb
, usb_audio_ids
);
697 * entry point for linux usb interface
700 static struct usb_driver usb_audio_driver
= {
701 .name
= "snd-usb-audio",
702 .probe
= usb_audio_probe
,
703 .disconnect
= usb_audio_disconnect
,
704 .suspend
= usb_audio_suspend
,
705 .resume
= usb_audio_resume
,
706 .id_table
= usb_audio_ids
,
707 .supports_autosuspend
= 1,
710 static int __init
snd_usb_audio_init(void)
712 if (nrpacks
< 1 || nrpacks
> MAX_PACKS
) {
713 printk(KERN_WARNING
"invalid nrpacks value.\n");
716 return usb_register(&usb_audio_driver
);
719 static void __exit
snd_usb_audio_cleanup(void)
721 usb_deregister(&usb_audio_driver
);
724 module_init(snd_usb_audio_init
);
725 module_exit(snd_usb_audio_cleanup
);