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>
48 #include <linux/usb/audio-v2.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>
69 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
70 MODULE_DESCRIPTION("USB Audio");
71 MODULE_LICENSE("GPL");
72 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
75 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
76 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
77 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;/* Enable this card */
78 /* Vendor/product IDs for this card */
79 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
80 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
81 static int nrpacks
= 8; /* max. number of packets per urb */
82 static int async_unlink
= 1;
83 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card */
84 static int ignore_ctl_error
;
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(nrpacks
, int, 0644);
97 MODULE_PARM_DESC(nrpacks
, "Max. number of packets per URB.");
98 module_param(async_unlink
, bool, 0444);
99 MODULE_PARM_DESC(async_unlink
, "Use async unlink mode.");
100 module_param_array(device_setup
, int, NULL
, 0444);
101 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
102 module_param(ignore_ctl_error
, bool, 0444);
103 MODULE_PARM_DESC(ignore_ctl_error
,
104 "Ignore errors from USB controller for mixer interfaces.");
107 * we keep the snd_usb_audio_t instances by ourselves for merging
108 * the all interfaces on the same card as one sound device.
111 static DEFINE_MUTEX(register_mutex
);
112 static struct snd_usb_audio
*usb_chip
[SNDRV_CARDS
];
113 static struct usb_driver usb_audio_driver
;
117 * called from snd_usb_audio_disconnect()
119 static void snd_usb_stream_disconnect(struct list_head
*head
)
122 struct snd_usb_stream
*as
;
123 struct snd_usb_substream
*subs
;
125 as
= list_entry(head
, struct snd_usb_stream
, list
);
126 for (idx
= 0; idx
< 2; idx
++) {
127 subs
= &as
->substream
[idx
];
128 if (!subs
->num_formats
)
130 snd_usb_release_substream_urbs(subs
, 1);
131 subs
->interface
= -1;
135 static int snd_usb_create_stream(struct snd_usb_audio
*chip
, int ctrlif
, int interface
)
137 struct usb_device
*dev
= chip
->dev
;
138 struct usb_host_interface
*alts
;
139 struct usb_interface_descriptor
*altsd
;
140 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, interface
);
143 snd_printk(KERN_ERR
"%d:%u:%d : does not exist\n",
144 dev
->devnum
, ctrlif
, interface
);
148 if (usb_interface_claimed(iface
)) {
149 snd_printdd(KERN_INFO
"%d:%d:%d: skipping, already claimed\n",
150 dev
->devnum
, ctrlif
, interface
);
154 alts
= &iface
->altsetting
[0];
155 altsd
= get_iface_desc(alts
);
156 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
157 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
158 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDISTREAMING
) {
159 int err
= snd_usbmidi_create(chip
->card
, iface
,
160 &chip
->midi_list
, NULL
);
162 snd_printk(KERN_ERR
"%d:%u:%d: cannot create sequencer device\n",
163 dev
->devnum
, ctrlif
, interface
);
166 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
171 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
172 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
173 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
) {
174 snd_printdd(KERN_ERR
"%d:%u:%d: skipping non-supported interface %d\n",
175 dev
->devnum
, ctrlif
, interface
, altsd
->bInterfaceClass
);
176 /* skip non-supported classes */
180 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
181 snd_printk(KERN_ERR
"low speed audio streaming not supported\n");
185 if (! snd_usb_parse_audio_endpoints(chip
, interface
)) {
186 usb_set_interface(dev
, interface
, 0); /* reset the current interface */
187 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
195 * parse audio control descriptor and create pcm/midi streams
197 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
199 struct usb_device
*dev
= chip
->dev
;
200 struct usb_host_interface
*host_iface
;
201 struct usb_interface_descriptor
*altsd
;
202 void *control_header
;
205 /* find audiocontrol interface */
206 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
207 control_header
= snd_usb_find_csint_desc(host_iface
->extra
,
208 host_iface
->extralen
,
210 altsd
= get_iface_desc(host_iface
);
211 protocol
= altsd
->bInterfaceProtocol
;
213 if (!control_header
) {
214 snd_printk(KERN_ERR
"cannot find UAC_HEADER\n");
219 case UAC_VERSION_1
: {
220 struct uac_ac_header_descriptor_v1
*h1
= control_header
;
222 if (!h1
->bInCollection
) {
223 snd_printk(KERN_INFO
"skipping empty audio interface (v1)\n");
227 if (h1
->bLength
< sizeof(*h1
) + h1
->bInCollection
) {
228 snd_printk(KERN_ERR
"invalid UAC_HEADER (v1)\n");
232 for (i
= 0; i
< h1
->bInCollection
; i
++)
233 snd_usb_create_stream(chip
, ctrlif
, h1
->baInterfaceNr
[i
]);
238 case UAC_VERSION_2
: {
239 struct uac_clock_source_descriptor
*cs
;
240 struct usb_interface_assoc_descriptor
*assoc
=
241 usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
244 snd_printk(KERN_ERR
"Audio class v2 interfaces need an interface association\n");
248 /* FIXME: for now, we expect there is at least one clock source
249 * descriptor and we always take the first one.
250 * We should properly support devices with multiple clock sources,
251 * clock selectors and sample rate conversion units. */
253 cs
= snd_usb_find_csint_desc(host_iface
->extra
, host_iface
->extralen
,
254 NULL
, UAC2_CLOCK_SOURCE
);
257 snd_printk(KERN_ERR
"CLOCK_SOURCE descriptor not found\n");
261 chip
->clock_id
= cs
->bClockID
;
263 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
264 int intf
= assoc
->bFirstInterface
+ i
;
267 snd_usb_create_stream(chip
, ctrlif
, intf
);
274 snd_printk(KERN_ERR
"unknown protocol version 0x%02x\n", protocol
);
282 * free the chip instance
284 * here we have to do not much, since pcm and controls are already freed
288 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
294 static int snd_usb_audio_dev_free(struct snd_device
*device
)
296 struct snd_usb_audio
*chip
= device
->device_data
;
297 return snd_usb_audio_free(chip
);
302 * create a chip instance and set its names.
304 static int snd_usb_audio_create(struct usb_device
*dev
, int idx
,
305 const struct snd_usb_audio_quirk
*quirk
,
306 struct snd_usb_audio
**rchip
)
308 struct snd_card
*card
;
309 struct snd_usb_audio
*chip
;
312 static struct snd_device_ops ops
= {
313 .dev_free
= snd_usb_audio_dev_free
,
318 if (snd_usb_get_speed(dev
) != USB_SPEED_LOW
&&
319 snd_usb_get_speed(dev
) != USB_SPEED_FULL
&&
320 snd_usb_get_speed(dev
) != USB_SPEED_HIGH
) {
321 snd_printk(KERN_ERR
"unknown device speed %d\n", snd_usb_get_speed(dev
));
325 err
= snd_card_create(index
[idx
], id
[idx
], THIS_MODULE
, 0, &card
);
327 snd_printk(KERN_ERR
"cannot create card instance %d\n", idx
);
331 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
340 chip
->setup
= device_setup
[idx
];
341 chip
->nrpacks
= nrpacks
;
342 chip
->async_unlink
= async_unlink
;
344 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
345 le16_to_cpu(dev
->descriptor
.idProduct
));
346 INIT_LIST_HEAD(&chip
->pcm_list
);
347 INIT_LIST_HEAD(&chip
->midi_list
);
348 INIT_LIST_HEAD(&chip
->mixer_list
);
350 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
351 snd_usb_audio_free(chip
);
356 strcpy(card
->driver
, "USB-Audio");
357 sprintf(component
, "USB%04x:%04x",
358 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
359 snd_component_add(card
, component
);
361 /* retrieve the device string as shortname */
362 if (quirk
&& quirk
->product_name
) {
363 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
365 if (!dev
->descriptor
.iProduct
||
366 usb_string(dev
, dev
->descriptor
.iProduct
,
367 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
368 /* no name available from anywhere, so use ID */
369 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
370 USB_ID_VENDOR(chip
->usb_id
),
371 USB_ID_PRODUCT(chip
->usb_id
));
375 /* retrieve the vendor and device strings as longname */
376 if (quirk
&& quirk
->vendor_name
) {
377 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
379 if (dev
->descriptor
.iManufacturer
)
380 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
381 card
->longname
, sizeof(card
->longname
));
384 /* we don't really care if there isn't any vendor string */
387 strlcat(card
->longname
, " ", sizeof(card
->longname
));
389 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
391 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
393 if (len
< sizeof(card
->longname
))
394 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
396 strlcat(card
->longname
,
397 snd_usb_get_speed(dev
) == USB_SPEED_LOW
? ", low speed" :
398 snd_usb_get_speed(dev
) == USB_SPEED_FULL
? ", full speed" :
400 sizeof(card
->longname
));
402 snd_usb_audio_create_proc(chip
);
409 * probe the active usb device
411 * note that this can be called multiple times per a device, when it
412 * includes multiple audio control interfaces.
414 * thus we check the usb device pointer and creates the card instance
415 * only at the first time. the successive calls of this function will
416 * append the pcm interface to the corresponding card.
418 static void *snd_usb_audio_probe(struct usb_device
*dev
,
419 struct usb_interface
*intf
,
420 const struct usb_device_id
*usb_id
)
422 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
424 struct snd_usb_audio
*chip
;
425 struct usb_host_interface
*alts
;
429 alts
= &intf
->altsetting
[0];
430 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
431 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
432 le16_to_cpu(dev
->descriptor
.idProduct
));
433 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
436 if (snd_usb_apply_boot_quirk(dev
, intf
, quirk
) < 0)
440 * found a config. now register to ALSA
443 /* check whether it's already registered */
445 mutex_lock(®ister_mutex
);
446 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
447 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
448 if (usb_chip
[i
]->shutdown
) {
449 snd_printk(KERN_ERR
"USB device is in the shutdown state, cannot create a card instance\n");
458 * now look for an empty slot and create a new card instance
460 for (i
= 0; i
< SNDRV_CARDS
; i
++)
461 if (enable
[i
] && ! usb_chip
[i
] &&
462 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
463 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
464 if (snd_usb_audio_create(dev
, i
, quirk
, &chip
) < 0) {
467 snd_card_set_dev(chip
->card
, &intf
->dev
);
471 printk(KERN_ERR
"no available usb audio device\n");
476 chip
->txfr_quirk
= 0;
477 err
= 1; /* continue */
478 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
479 /* need some special handlings */
480 if ((err
= snd_usb_create_quirk(chip
, intf
, &usb_audio_driver
, quirk
)) < 0)
485 /* create normal USB audio interfaces */
486 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
487 snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
) < 0) {
492 /* we are allowed to call snd_card_register() many times */
493 if (snd_card_register(chip
->card
) < 0) {
497 usb_chip
[chip
->index
] = chip
;
498 chip
->num_interfaces
++;
499 mutex_unlock(®ister_mutex
);
503 if (chip
&& !chip
->num_interfaces
)
504 snd_card_free(chip
->card
);
505 mutex_unlock(®ister_mutex
);
511 * we need to take care of counter, since disconnection can be called also
512 * many times as well as usb_audio_probe().
514 static void snd_usb_audio_disconnect(struct usb_device
*dev
, void *ptr
)
516 struct snd_usb_audio
*chip
;
517 struct snd_card
*card
;
520 if (ptr
== (void *)-1L)
525 mutex_lock(®ister_mutex
);
527 chip
->num_interfaces
--;
528 if (chip
->num_interfaces
<= 0) {
529 snd_card_disconnect(card
);
530 /* release the pcm resources */
531 list_for_each(p
, &chip
->pcm_list
) {
532 snd_usb_stream_disconnect(p
);
534 /* release the midi resources */
535 list_for_each(p
, &chip
->midi_list
) {
536 snd_usbmidi_disconnect(p
);
538 /* release mixer resources */
539 list_for_each(p
, &chip
->mixer_list
) {
540 snd_usb_mixer_disconnect(p
);
542 usb_chip
[chip
->index
] = NULL
;
543 mutex_unlock(®ister_mutex
);
544 snd_card_free_when_closed(card
);
546 mutex_unlock(®ister_mutex
);
551 * new 2.5 USB kernel API
553 static int usb_audio_probe(struct usb_interface
*intf
,
554 const struct usb_device_id
*id
)
557 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
559 usb_set_intfdata(intf
, chip
);
565 static void usb_audio_disconnect(struct usb_interface
*intf
)
567 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
568 usb_get_intfdata(intf
));
572 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
574 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
576 struct snd_usb_stream
*as
;
578 if (chip
== (void *)-1L)
581 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
582 if (!chip
->num_suspended_intf
++) {
583 list_for_each(p
, &chip
->pcm_list
) {
584 as
= list_entry(p
, struct snd_usb_stream
, list
);
585 snd_pcm_suspend_all(as
->pcm
);
592 static int usb_audio_resume(struct usb_interface
*intf
)
594 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
596 if (chip
== (void *)-1L)
598 if (--chip
->num_suspended_intf
)
601 * ALSA leaves material resumption to user space
605 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
610 #define usb_audio_suspend NULL
611 #define usb_audio_resume NULL
612 #endif /* CONFIG_PM */
614 static struct usb_device_id usb_audio_ids
[] = {
615 #include "quirks-table.h"
616 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
617 .bInterfaceClass
= USB_CLASS_AUDIO
,
618 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
619 { } /* Terminating entry */
622 MODULE_DEVICE_TABLE (usb
, usb_audio_ids
);
625 * entry point for linux usb interface
628 static struct usb_driver usb_audio_driver
= {
629 .name
= "snd-usb-audio",
630 .probe
= usb_audio_probe
,
631 .disconnect
= usb_audio_disconnect
,
632 .suspend
= usb_audio_suspend
,
633 .resume
= usb_audio_resume
,
634 .id_table
= usb_audio_ids
,
637 static int __init
snd_usb_audio_init(void)
639 if (nrpacks
< 1 || nrpacks
> MAX_PACKS
) {
640 printk(KERN_WARNING
"invalid nrpacks value.\n");
643 return usb_register(&usb_audio_driver
);
646 static void __exit
snd_usb_audio_cleanup(void)
648 usb_deregister(&usb_audio_driver
);
651 module_init(snd_usb_audio_init
);
652 module_exit(snd_usb_audio_cleanup
);