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/usb.h>
45 #include <linux/moduleparam.h>
46 #include <linux/mutex.h>
47 #include <linux/usb/audio.h>
49 #include <sound/core.h>
50 #include <sound/info.h>
51 #include <sound/pcm.h>
52 #include <sound/pcm_params.h>
53 #include <sound/initval.h>
68 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
69 MODULE_DESCRIPTION("USB Audio");
70 MODULE_LICENSE("GPL");
71 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
74 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
75 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
76 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;/* Enable this card */
77 /* Vendor/product IDs for this card */
78 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
79 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
80 static int nrpacks
= 8; /* max. number of packets per urb */
81 static int async_unlink
= 1;
82 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card */
83 static int ignore_ctl_error
;
85 module_param_array(index
, int, NULL
, 0444);
86 MODULE_PARM_DESC(index
, "Index value for the USB audio adapter.");
87 module_param_array(id
, charp
, NULL
, 0444);
88 MODULE_PARM_DESC(id
, "ID string for the USB audio adapter.");
89 module_param_array(enable
, bool, NULL
, 0444);
90 MODULE_PARM_DESC(enable
, "Enable USB audio adapter.");
91 module_param_array(vid
, int, NULL
, 0444);
92 MODULE_PARM_DESC(vid
, "Vendor ID for the USB audio device.");
93 module_param_array(pid
, int, NULL
, 0444);
94 MODULE_PARM_DESC(pid
, "Product ID for the USB audio device.");
95 module_param(nrpacks
, int, 0644);
96 MODULE_PARM_DESC(nrpacks
, "Max. number of packets per URB.");
97 module_param(async_unlink
, bool, 0444);
98 MODULE_PARM_DESC(async_unlink
, "Use async unlink mode.");
99 module_param_array(device_setup
, int, NULL
, 0444);
100 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
101 module_param(ignore_ctl_error
, bool, 0444);
102 MODULE_PARM_DESC(ignore_ctl_error
,
103 "Ignore errors from USB controller for mixer interfaces.");
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 snd_usb_audio_disconnect()
118 static void snd_usb_stream_disconnect(struct list_head
*head
)
121 struct snd_usb_stream
*as
;
122 struct snd_usb_substream
*subs
;
124 as
= list_entry(head
, struct snd_usb_stream
, list
);
125 for (idx
= 0; idx
< 2; idx
++) {
126 subs
= &as
->substream
[idx
];
127 if (!subs
->num_formats
)
129 snd_usb_release_substream_urbs(subs
, 1);
130 subs
->interface
= -1;
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 if (usb_interface_claimed(iface
)) {
148 snd_printdd(KERN_INFO
"%d:%d:%d: skipping, already claimed\n",
149 dev
->devnum
, ctrlif
, interface
);
153 alts
= &iface
->altsetting
[0];
154 altsd
= get_iface_desc(alts
);
155 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
156 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
157 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDISTREAMING
) {
158 int err
= snd_usbmidi_create(chip
->card
, iface
,
159 &chip
->midi_list
, NULL
);
161 snd_printk(KERN_ERR
"%d:%u:%d: cannot create sequencer device\n",
162 dev
->devnum
, ctrlif
, interface
);
165 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
170 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
171 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
172 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
) {
173 snd_printdd(KERN_ERR
"%d:%u:%d: skipping non-supported interface %d\n",
174 dev
->devnum
, ctrlif
, interface
, altsd
->bInterfaceClass
);
175 /* skip non-supported classes */
179 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
180 snd_printk(KERN_ERR
"low speed audio streaming not supported\n");
184 if (! snd_usb_parse_audio_endpoints(chip
, interface
)) {
185 usb_set_interface(dev
, interface
, 0); /* reset the current interface */
186 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
194 * parse audio control descriptor and create pcm/midi streams
196 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
198 struct usb_device
*dev
= chip
->dev
;
199 struct usb_host_interface
*host_iface
;
200 struct usb_interface_descriptor
*altsd
;
201 void *control_header
;
204 /* find audiocontrol interface */
205 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
206 control_header
= snd_usb_find_csint_desc(host_iface
->extra
,
207 host_iface
->extralen
,
209 altsd
= get_iface_desc(host_iface
);
210 protocol
= altsd
->bInterfaceProtocol
;
212 if (!control_header
) {
213 snd_printk(KERN_ERR
"cannot find UAC_HEADER\n");
218 case UAC_VERSION_1
: {
219 struct uac_ac_header_descriptor_v1
*h1
= control_header
;
221 if (!h1
->bInCollection
) {
222 snd_printk(KERN_INFO
"skipping empty audio interface (v1)\n");
226 if (h1
->bLength
< sizeof(*h1
) + h1
->bInCollection
) {
227 snd_printk(KERN_ERR
"invalid UAC_HEADER (v1)\n");
231 for (i
= 0; i
< h1
->bInCollection
; i
++)
232 snd_usb_create_stream(chip
, ctrlif
, h1
->baInterfaceNr
[i
]);
237 case UAC_VERSION_2
: {
238 struct uac_clock_source_descriptor
*cs
;
239 struct usb_interface_assoc_descriptor
*assoc
=
240 usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
243 snd_printk(KERN_ERR
"Audio class v2 interfaces need an interface association\n");
247 /* FIXME: for now, we expect there is at least one clock source
248 * descriptor and we always take the first one.
249 * We should properly support devices with multiple clock sources,
250 * clock selectors and sample rate conversion units. */
252 cs
= snd_usb_find_csint_desc(host_iface
->extra
, host_iface
->extralen
,
253 NULL
, UAC_CLOCK_SOURCE
);
256 snd_printk(KERN_ERR
"CLOCK_SOURCE descriptor not found\n");
260 chip
->clock_id
= cs
->bClockID
;
262 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
263 int intf
= assoc
->bFirstInterface
+ i
;
266 snd_usb_create_stream(chip
, ctrlif
, intf
);
273 snd_printk(KERN_ERR
"unknown protocol version 0x%02x\n", protocol
);
281 * free the chip instance
283 * here we have to do not much, since pcm and controls are already freed
287 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
293 static int snd_usb_audio_dev_free(struct snd_device
*device
)
295 struct snd_usb_audio
*chip
= device
->device_data
;
296 return snd_usb_audio_free(chip
);
301 * create a chip instance and set its names.
303 static int snd_usb_audio_create(struct usb_device
*dev
, int idx
,
304 const struct snd_usb_audio_quirk
*quirk
,
305 struct snd_usb_audio
**rchip
)
307 struct snd_card
*card
;
308 struct snd_usb_audio
*chip
;
311 static struct snd_device_ops ops
= {
312 .dev_free
= snd_usb_audio_dev_free
,
317 if (snd_usb_get_speed(dev
) != USB_SPEED_LOW
&&
318 snd_usb_get_speed(dev
) != USB_SPEED_FULL
&&
319 snd_usb_get_speed(dev
) != USB_SPEED_HIGH
) {
320 snd_printk(KERN_ERR
"unknown device speed %d\n", snd_usb_get_speed(dev
));
324 err
= snd_card_create(index
[idx
], id
[idx
], THIS_MODULE
, 0, &card
);
326 snd_printk(KERN_ERR
"cannot create card instance %d\n", idx
);
330 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
339 chip
->setup
= device_setup
[idx
];
340 chip
->nrpacks
= nrpacks
;
341 chip
->async_unlink
= async_unlink
;
343 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
344 le16_to_cpu(dev
->descriptor
.idProduct
));
345 INIT_LIST_HEAD(&chip
->pcm_list
);
346 INIT_LIST_HEAD(&chip
->midi_list
);
347 INIT_LIST_HEAD(&chip
->mixer_list
);
349 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
350 snd_usb_audio_free(chip
);
355 strcpy(card
->driver
, "USB-Audio");
356 sprintf(component
, "USB%04x:%04x",
357 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
358 snd_component_add(card
, component
);
360 /* retrieve the device string as shortname */
361 if (quirk
&& quirk
->product_name
) {
362 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
364 if (!dev
->descriptor
.iProduct
||
365 usb_string(dev
, dev
->descriptor
.iProduct
,
366 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
367 /* no name available from anywhere, so use ID */
368 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
369 USB_ID_VENDOR(chip
->usb_id
),
370 USB_ID_PRODUCT(chip
->usb_id
));
374 /* retrieve the vendor and device strings as longname */
375 if (quirk
&& quirk
->vendor_name
) {
376 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
378 if (dev
->descriptor
.iManufacturer
)
379 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
380 card
->longname
, sizeof(card
->longname
));
383 /* we don't really care if there isn't any vendor string */
386 strlcat(card
->longname
, " ", sizeof(card
->longname
));
388 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
390 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
392 if (len
< sizeof(card
->longname
))
393 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
395 strlcat(card
->longname
,
396 snd_usb_get_speed(dev
) == USB_SPEED_LOW
? ", low speed" :
397 snd_usb_get_speed(dev
) == USB_SPEED_FULL
? ", full speed" :
399 sizeof(card
->longname
));
401 snd_usb_audio_create_proc(chip
);
408 * probe the active usb device
410 * note that this can be called multiple times per a device, when it
411 * includes multiple audio control interfaces.
413 * thus we check the usb device pointer and creates the card instance
414 * only at the first time. the successive calls of this function will
415 * append the pcm interface to the corresponding card.
417 static void *snd_usb_audio_probe(struct usb_device
*dev
,
418 struct usb_interface
*intf
,
419 const struct usb_device_id
*usb_id
)
421 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
423 struct snd_usb_audio
*chip
;
424 struct usb_host_interface
*alts
;
428 alts
= &intf
->altsetting
[0];
429 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
430 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
431 le16_to_cpu(dev
->descriptor
.idProduct
));
432 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
435 if (snd_usb_apply_boot_quirk(dev
, intf
, quirk
) < 0)
439 * found a config. now register to ALSA
442 /* check whether it's already registered */
444 mutex_lock(®ister_mutex
);
445 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
446 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
447 if (usb_chip
[i
]->shutdown
) {
448 snd_printk(KERN_ERR
"USB device is in the shutdown state, cannot create a card instance\n");
457 * now look for an empty slot and create a new card instance
459 for (i
= 0; i
< SNDRV_CARDS
; i
++)
460 if (enable
[i
] && ! usb_chip
[i
] &&
461 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
462 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
463 if (snd_usb_audio_create(dev
, i
, quirk
, &chip
) < 0) {
466 snd_card_set_dev(chip
->card
, &intf
->dev
);
470 printk(KERN_ERR
"no available usb audio device\n");
475 chip
->txfr_quirk
= 0;
476 err
= 1; /* continue */
477 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
478 /* need some special handlings */
479 if ((err
= snd_usb_create_quirk(chip
, intf
, &usb_audio_driver
, quirk
)) < 0)
484 /* create normal USB audio interfaces */
485 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
486 snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
) < 0) {
491 /* we are allowed to call snd_card_register() many times */
492 if (snd_card_register(chip
->card
) < 0) {
496 usb_chip
[chip
->index
] = chip
;
497 chip
->num_interfaces
++;
498 mutex_unlock(®ister_mutex
);
502 if (chip
&& !chip
->num_interfaces
)
503 snd_card_free(chip
->card
);
504 mutex_unlock(®ister_mutex
);
510 * we need to take care of counter, since disconnection can be called also
511 * many times as well as usb_audio_probe().
513 static void snd_usb_audio_disconnect(struct usb_device
*dev
, void *ptr
)
515 struct snd_usb_audio
*chip
;
516 struct snd_card
*card
;
519 if (ptr
== (void *)-1L)
524 mutex_lock(®ister_mutex
);
526 chip
->num_interfaces
--;
527 if (chip
->num_interfaces
<= 0) {
528 snd_card_disconnect(card
);
529 /* release the pcm resources */
530 list_for_each(p
, &chip
->pcm_list
) {
531 snd_usb_stream_disconnect(p
);
533 /* release the midi resources */
534 list_for_each(p
, &chip
->midi_list
) {
535 snd_usbmidi_disconnect(p
);
537 /* release mixer resources */
538 list_for_each(p
, &chip
->mixer_list
) {
539 snd_usb_mixer_disconnect(p
);
541 usb_chip
[chip
->index
] = NULL
;
542 mutex_unlock(®ister_mutex
);
543 snd_card_free_when_closed(card
);
545 mutex_unlock(®ister_mutex
);
550 * new 2.5 USB kernel API
552 static int usb_audio_probe(struct usb_interface
*intf
,
553 const struct usb_device_id
*id
)
556 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
558 usb_set_intfdata(intf
, chip
);
564 static void usb_audio_disconnect(struct usb_interface
*intf
)
566 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
567 usb_get_intfdata(intf
));
571 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
573 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
575 struct snd_usb_stream
*as
;
577 if (chip
== (void *)-1L)
580 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
581 if (!chip
->num_suspended_intf
++) {
582 list_for_each(p
, &chip
->pcm_list
) {
583 as
= list_entry(p
, struct snd_usb_stream
, list
);
584 snd_pcm_suspend_all(as
->pcm
);
591 static int usb_audio_resume(struct usb_interface
*intf
)
593 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
595 if (chip
== (void *)-1L)
597 if (--chip
->num_suspended_intf
)
600 * ALSA leaves material resumption to user space
604 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
608 #endif /* CONFIG_PM */
610 static struct usb_device_id usb_audio_ids
[] = {
611 #include "quirks-table.h"
612 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
613 .bInterfaceClass
= USB_CLASS_AUDIO
,
614 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
615 { } /* Terminating entry */
618 MODULE_DEVICE_TABLE (usb
, usb_audio_ids
);
621 * entry point for linux usb interface
624 static struct usb_driver usb_audio_driver
= {
625 .name
= "snd-usb-audio",
626 .probe
= usb_audio_probe
,
627 .disconnect
= usb_audio_disconnect
,
628 .suspend
= usb_audio_suspend
,
629 .resume
= usb_audio_resume
,
630 .id_table
= usb_audio_ids
,
633 static int __init
snd_usb_audio_init(void)
635 if (nrpacks
< 1 || nrpacks
> MAX_PACKS
) {
636 printk(KERN_WARNING
"invalid nrpacks value.\n");
639 return usb_register(&usb_audio_driver
);
642 static void __exit
snd_usb_audio_cleanup(void)
644 usb_deregister(&usb_audio_driver
);
647 module_init(snd_usb_audio_init
);
648 module_exit(snd_usb_audio_cleanup
);