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 nrpacks
= 8; /* max. number of packets per urb */
83 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card */
84 static bool ignore_ctl_error
;
85 static bool autoclock
= true;
87 module_param_array(index
, int, NULL
, 0444);
88 MODULE_PARM_DESC(index
, "Index value for the USB audio adapter.");
89 module_param_array(id
, charp
, NULL
, 0444);
90 MODULE_PARM_DESC(id
, "ID string for the USB audio adapter.");
91 module_param_array(enable
, bool, NULL
, 0444);
92 MODULE_PARM_DESC(enable
, "Enable USB audio adapter.");
93 module_param_array(vid
, int, NULL
, 0444);
94 MODULE_PARM_DESC(vid
, "Vendor ID for the USB audio device.");
95 module_param_array(pid
, int, NULL
, 0444);
96 MODULE_PARM_DESC(pid
, "Product ID for the USB audio device.");
97 module_param(nrpacks
, int, 0644);
98 MODULE_PARM_DESC(nrpacks
, "Max. number of packets per URB.");
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.");
104 module_param(autoclock
, bool, 0444);
105 MODULE_PARM_DESC(autoclock
, "Enable auto-clock selection for UAC2 devices (default: yes).");
108 * we keep the snd_usb_audio_t instances by ourselves for merging
109 * the all interfaces on the same card as one sound device.
112 static DEFINE_MUTEX(register_mutex
);
113 static struct snd_usb_audio
*usb_chip
[SNDRV_CARDS
];
114 static struct usb_driver usb_audio_driver
;
118 * called from snd_usb_audio_disconnect()
120 static void snd_usb_stream_disconnect(struct list_head
*head
)
123 struct snd_usb_stream
*as
;
124 struct snd_usb_substream
*subs
;
126 as
= list_entry(head
, struct snd_usb_stream
, list
);
127 for (idx
= 0; idx
< 2; idx
++) {
128 subs
= &as
->substream
[idx
];
129 if (!subs
->num_formats
)
131 subs
->interface
= -1;
132 subs
->data_endpoint
= NULL
;
133 subs
->sync_endpoint
= NULL
;
137 static int snd_usb_create_stream(struct snd_usb_audio
*chip
, int ctrlif
, int interface
)
139 struct usb_device
*dev
= chip
->dev
;
140 struct usb_host_interface
*alts
;
141 struct usb_interface_descriptor
*altsd
;
142 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, interface
);
145 snd_printk(KERN_ERR
"%d:%u:%d : does not exist\n",
146 dev
->devnum
, ctrlif
, interface
);
150 if (usb_interface_claimed(iface
)) {
151 snd_printdd(KERN_INFO
"%d:%d:%d: skipping, already claimed\n",
152 dev
->devnum
, ctrlif
, interface
);
156 alts
= &iface
->altsetting
[0];
157 altsd
= get_iface_desc(alts
);
158 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
159 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
160 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDISTREAMING
) {
161 int err
= snd_usbmidi_create(chip
->card
, iface
,
162 &chip
->midi_list
, NULL
);
164 snd_printk(KERN_ERR
"%d:%u:%d: cannot create sequencer device\n",
165 dev
->devnum
, ctrlif
, interface
);
168 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
173 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
174 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
175 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
) {
176 snd_printdd(KERN_ERR
"%d:%u:%d: skipping non-supported interface %d\n",
177 dev
->devnum
, ctrlif
, interface
, altsd
->bInterfaceClass
);
178 /* skip non-supported classes */
182 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
183 snd_printk(KERN_ERR
"low speed audio streaming not supported\n");
187 if (! snd_usb_parse_audio_interface(chip
, interface
)) {
188 usb_set_interface(dev
, interface
, 0); /* reset the current interface */
189 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
197 * parse audio control descriptor and create pcm/midi streams
199 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
201 struct usb_device
*dev
= chip
->dev
;
202 struct usb_host_interface
*host_iface
;
203 struct usb_interface_descriptor
*altsd
;
204 void *control_header
;
207 /* find audiocontrol interface */
208 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
209 control_header
= snd_usb_find_csint_desc(host_iface
->extra
,
210 host_iface
->extralen
,
212 altsd
= get_iface_desc(host_iface
);
213 protocol
= altsd
->bInterfaceProtocol
;
215 if (!control_header
) {
216 snd_printk(KERN_ERR
"cannot find UAC_HEADER\n");
222 snd_printdd(KERN_WARNING
"unknown interface protocol %#02x, assuming v1\n",
226 case UAC_VERSION_1
: {
227 struct uac1_ac_header_descriptor
*h1
= control_header
;
229 if (!h1
->bInCollection
) {
230 snd_printk(KERN_INFO
"skipping empty audio interface (v1)\n");
234 if (h1
->bLength
< sizeof(*h1
) + h1
->bInCollection
) {
235 snd_printk(KERN_ERR
"invalid UAC_HEADER (v1)\n");
239 for (i
= 0; i
< h1
->bInCollection
; i
++)
240 snd_usb_create_stream(chip
, ctrlif
, h1
->baInterfaceNr
[i
]);
245 case UAC_VERSION_2
: {
246 struct usb_interface_assoc_descriptor
*assoc
=
247 usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
251 * Firmware writers cannot count to three. So to find
252 * the IAD on the NuForce UDH-100, also check the next
255 struct usb_interface
*iface
=
256 usb_ifnum_to_if(dev
, ctrlif
+ 1);
259 iface
->intf_assoc
->bFunctionClass
== USB_CLASS_AUDIO
&&
260 iface
->intf_assoc
->bFunctionProtocol
== UAC_VERSION_2
)
261 assoc
= iface
->intf_assoc
;
265 snd_printk(KERN_ERR
"Audio class v2 interfaces need an interface association\n");
269 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
270 int intf
= assoc
->bFirstInterface
+ i
;
273 snd_usb_create_stream(chip
, ctrlif
, intf
);
284 * free the chip instance
286 * here we have to do not much, since pcm and controls are already freed
290 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
292 mutex_destroy(&chip
->mutex
);
297 static int snd_usb_audio_dev_free(struct snd_device
*device
)
299 struct snd_usb_audio
*chip
= device
->device_data
;
300 return snd_usb_audio_free(chip
);
303 static void remove_trailing_spaces(char *str
)
309 for (p
= str
+ strlen(str
) - 1; p
>= str
&& isspace(*p
); p
--)
314 * create a chip instance and set its names.
316 static int snd_usb_audio_create(struct usb_device
*dev
, int idx
,
317 const struct snd_usb_audio_quirk
*quirk
,
318 struct snd_usb_audio
**rchip
)
320 struct snd_card
*card
;
321 struct snd_usb_audio
*chip
;
324 static struct snd_device_ops ops
= {
325 .dev_free
= snd_usb_audio_dev_free
,
330 switch (snd_usb_get_speed(dev
)) {
334 case USB_SPEED_SUPER
:
337 snd_printk(KERN_ERR
"unknown device speed %d\n", snd_usb_get_speed(dev
));
341 err
= snd_card_create(index
[idx
], id
[idx
], THIS_MODULE
, 0, &card
);
343 snd_printk(KERN_ERR
"cannot create card instance %d\n", idx
);
347 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
353 mutex_init(&chip
->mutex
);
354 init_rwsem(&chip
->shutdown_rwsem
);
358 chip
->setup
= device_setup
[idx
];
359 chip
->nrpacks
= nrpacks
;
360 chip
->autoclock
= autoclock
;
363 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
364 le16_to_cpu(dev
->descriptor
.idProduct
));
365 INIT_LIST_HEAD(&chip
->pcm_list
);
366 INIT_LIST_HEAD(&chip
->ep_list
);
367 INIT_LIST_HEAD(&chip
->midi_list
);
368 INIT_LIST_HEAD(&chip
->mixer_list
);
370 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
371 snd_usb_audio_free(chip
);
376 strcpy(card
->driver
, "USB-Audio");
377 sprintf(component
, "USB%04x:%04x",
378 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
379 snd_component_add(card
, component
);
381 /* retrieve the device string as shortname */
382 if (quirk
&& quirk
->product_name
&& *quirk
->product_name
) {
383 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
385 if (!dev
->descriptor
.iProduct
||
386 usb_string(dev
, dev
->descriptor
.iProduct
,
387 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
388 /* no name available from anywhere, so use ID */
389 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
390 USB_ID_VENDOR(chip
->usb_id
),
391 USB_ID_PRODUCT(chip
->usb_id
));
394 remove_trailing_spaces(card
->shortname
);
396 /* retrieve the vendor and device strings as longname */
397 if (quirk
&& quirk
->vendor_name
&& *quirk
->vendor_name
) {
398 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
400 if (dev
->descriptor
.iManufacturer
)
401 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
402 card
->longname
, sizeof(card
->longname
));
405 /* we don't really care if there isn't any vendor string */
408 remove_trailing_spaces(card
->longname
);
410 strlcat(card
->longname
, " ", sizeof(card
->longname
));
413 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
415 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
417 if (len
< sizeof(card
->longname
))
418 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
420 switch (snd_usb_get_speed(dev
)) {
422 strlcat(card
->longname
, ", low speed", sizeof(card
->longname
));
425 strlcat(card
->longname
, ", full speed", sizeof(card
->longname
));
428 strlcat(card
->longname
, ", high speed", sizeof(card
->longname
));
430 case USB_SPEED_SUPER
:
431 strlcat(card
->longname
, ", super speed", sizeof(card
->longname
));
437 snd_usb_audio_create_proc(chip
);
444 * probe the active usb device
446 * note that this can be called multiple times per a device, when it
447 * includes multiple audio control interfaces.
449 * thus we check the usb device pointer and creates the card instance
450 * only at the first time. the successive calls of this function will
451 * append the pcm interface to the corresponding card.
453 static struct snd_usb_audio
*
454 snd_usb_audio_probe(struct usb_device
*dev
,
455 struct usb_interface
*intf
,
456 const struct usb_device_id
*usb_id
)
458 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
460 struct snd_usb_audio
*chip
;
461 struct usb_host_interface
*alts
;
465 alts
= &intf
->altsetting
[0];
466 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
467 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
468 le16_to_cpu(dev
->descriptor
.idProduct
));
469 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
472 if (snd_usb_apply_boot_quirk(dev
, intf
, quirk
) < 0)
476 * found a config. now register to ALSA
479 /* check whether it's already registered */
481 mutex_lock(®ister_mutex
);
482 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
483 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
484 if (usb_chip
[i
]->shutdown
) {
485 snd_printk(KERN_ERR
"USB device is in the shutdown state, cannot create a card instance\n");
495 * now look for an empty slot and create a new card instance
497 for (i
= 0; i
< SNDRV_CARDS
; i
++)
498 if (enable
[i
] && ! usb_chip
[i
] &&
499 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
500 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
501 if (snd_usb_audio_create(dev
, i
, quirk
, &chip
) < 0) {
504 snd_card_set_dev(chip
->card
, &intf
->dev
);
505 chip
->pm_intf
= intf
;
509 printk(KERN_ERR
"no available usb audio device\n");
515 * For devices with more than one control interface, we assume the
516 * first contains the audio controls. We might need a more specific
517 * check here in the future.
519 if (!chip
->ctrl_intf
)
520 chip
->ctrl_intf
= alts
;
522 chip
->txfr_quirk
= 0;
523 err
= 1; /* continue */
524 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
525 /* need some special handlings */
526 if ((err
= snd_usb_create_quirk(chip
, intf
, &usb_audio_driver
, quirk
)) < 0)
531 /* create normal USB audio interfaces */
532 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
533 snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
) < 0) {
538 /* we are allowed to call snd_card_register() many times */
539 if (snd_card_register(chip
->card
) < 0) {
543 usb_chip
[chip
->index
] = chip
;
544 chip
->num_interfaces
++;
546 mutex_unlock(®ister_mutex
);
551 if (!chip
->num_interfaces
)
552 snd_card_free(chip
->card
);
555 mutex_unlock(®ister_mutex
);
561 * we need to take care of counter, since disconnection can be called also
562 * many times as well as usb_audio_probe().
564 static void snd_usb_audio_disconnect(struct usb_device
*dev
,
565 struct snd_usb_audio
*chip
)
567 struct snd_card
*card
;
568 struct list_head
*p
, *n
;
570 if (chip
== (void *)-1L)
574 down_write(&chip
->shutdown_rwsem
);
576 up_write(&chip
->shutdown_rwsem
);
578 mutex_lock(®ister_mutex
);
579 chip
->num_interfaces
--;
580 if (chip
->num_interfaces
<= 0) {
581 snd_card_disconnect(card
);
582 /* release the pcm resources */
583 list_for_each(p
, &chip
->pcm_list
) {
584 snd_usb_stream_disconnect(p
);
586 /* release the endpoint resources */
587 list_for_each_safe(p
, n
, &chip
->ep_list
) {
588 snd_usb_endpoint_free(p
);
590 /* release the midi resources */
591 list_for_each(p
, &chip
->midi_list
) {
592 snd_usbmidi_disconnect(p
);
594 /* release mixer resources */
595 list_for_each(p
, &chip
->mixer_list
) {
596 snd_usb_mixer_disconnect(p
);
598 usb_chip
[chip
->index
] = NULL
;
599 mutex_unlock(®ister_mutex
);
600 snd_card_free_when_closed(card
);
602 mutex_unlock(®ister_mutex
);
607 * new 2.5 USB kernel API
609 static int usb_audio_probe(struct usb_interface
*intf
,
610 const struct usb_device_id
*id
)
612 struct snd_usb_audio
*chip
;
613 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
615 usb_set_intfdata(intf
, chip
);
621 static void usb_audio_disconnect(struct usb_interface
*intf
)
623 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
624 usb_get_intfdata(intf
));
629 int snd_usb_autoresume(struct snd_usb_audio
*chip
)
633 down_read(&chip
->shutdown_rwsem
);
634 if (!chip
->shutdown
&& !chip
->probing
)
635 err
= usb_autopm_get_interface(chip
->pm_intf
);
636 up_read(&chip
->shutdown_rwsem
);
641 void snd_usb_autosuspend(struct snd_usb_audio
*chip
)
643 down_read(&chip
->shutdown_rwsem
);
644 if (!chip
->shutdown
&& !chip
->probing
)
645 usb_autopm_put_interface(chip
->pm_intf
);
646 up_read(&chip
->shutdown_rwsem
);
649 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
651 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
652 struct snd_usb_stream
*as
;
653 struct usb_mixer_interface
*mixer
;
655 if (chip
== (void *)-1L)
658 if (!PMSG_IS_AUTO(message
)) {
659 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
660 if (!chip
->num_suspended_intf
++) {
661 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
662 snd_pcm_suspend_all(as
->pcm
);
663 as
->substream
[0].need_setup_ep
=
664 as
->substream
[1].need_setup_ep
= true;
669 * otherwise we keep the rest of the system in the dark
670 * to keep this transparent
672 if (!chip
->num_suspended_intf
++)
673 chip
->autosuspended
= 1;
676 list_for_each_entry(mixer
, &chip
->mixer_list
, list
)
677 snd_usb_mixer_inactivate(mixer
);
682 static int usb_audio_resume(struct usb_interface
*intf
)
684 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
685 struct usb_mixer_interface
*mixer
;
688 if (chip
== (void *)-1L)
690 if (--chip
->num_suspended_intf
)
693 * ALSA leaves material resumption to user space
694 * we just notify and restart the mixers
696 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
697 err
= snd_usb_mixer_activate(mixer
);
702 if (!chip
->autosuspended
)
703 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
704 chip
->autosuspended
= 0;
710 #define usb_audio_suspend NULL
711 #define usb_audio_resume NULL
712 #endif /* CONFIG_PM */
714 static struct usb_device_id usb_audio_ids
[] = {
715 #include "quirks-table.h"
716 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
717 .bInterfaceClass
= USB_CLASS_AUDIO
,
718 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
719 { } /* Terminating entry */
721 MODULE_DEVICE_TABLE(usb
, usb_audio_ids
);
724 * entry point for linux usb interface
727 static struct usb_driver usb_audio_driver
= {
728 .name
= "snd-usb-audio",
729 .probe
= usb_audio_probe
,
730 .disconnect
= usb_audio_disconnect
,
731 .suspend
= usb_audio_suspend
,
732 .resume
= usb_audio_resume
,
733 .id_table
= usb_audio_ids
,
734 .supports_autosuspend
= 1,
737 static int __init
snd_usb_audio_init(void)
739 if (nrpacks
< 1 || nrpacks
> MAX_PACKS
) {
740 printk(KERN_WARNING
"invalid nrpacks value.\n");
743 return usb_register(&usb_audio_driver
);
746 static void __exit
snd_usb_audio_cleanup(void)
748 usb_deregister(&usb_audio_driver
);
751 module_init(snd_usb_audio_init
);
752 module_exit(snd_usb_audio_cleanup
);