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 device_setup
[SNDRV_CARDS
]; /* device parameter for this card */
83 static bool ignore_ctl_error
;
84 static bool autoclock
= true;
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_array(device_setup
, int, NULL
, 0444);
97 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
98 module_param(ignore_ctl_error
, bool, 0444);
99 MODULE_PARM_DESC(ignore_ctl_error
,
100 "Ignore errors from USB controller for mixer interfaces.");
101 module_param(autoclock
, bool, 0444);
102 MODULE_PARM_DESC(autoclock
, "Enable auto-clock selection for UAC2 devices (default: yes).");
105 * we keep the snd_usb_audio_t instances by ourselves for merging
106 * the all interfaces on the same card as one sound device.
109 static DEFINE_MUTEX(register_mutex
);
110 static struct snd_usb_audio
*usb_chip
[SNDRV_CARDS
];
111 static struct usb_driver usb_audio_driver
;
115 * called from snd_usb_audio_disconnect()
117 static void snd_usb_stream_disconnect(struct list_head
*head
)
120 struct snd_usb_stream
*as
;
121 struct snd_usb_substream
*subs
;
123 as
= list_entry(head
, struct snd_usb_stream
, list
);
124 for (idx
= 0; idx
< 2; idx
++) {
125 subs
= &as
->substream
[idx
];
126 if (!subs
->num_formats
)
128 subs
->interface
= -1;
129 subs
->data_endpoint
= NULL
;
130 subs
->sync_endpoint
= NULL
;
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 dev_err(&dev
->dev
, "%u:%d : does not exist\n",
147 alts
= &iface
->altsetting
[0];
148 altsd
= get_iface_desc(alts
);
151 * Android with both accessory and audio interfaces enabled gets the
152 * interface numbers wrong.
154 if ((chip
->usb_id
== USB_ID(0x18d1, 0x2d04) ||
155 chip
->usb_id
== USB_ID(0x18d1, 0x2d05)) &&
157 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
&&
158 altsd
->bInterfaceSubClass
== USB_SUBCLASS_VENDOR_SPEC
) {
160 iface
= usb_ifnum_to_if(dev
, interface
);
163 alts
= &iface
->altsetting
[0];
164 altsd
= get_iface_desc(alts
);
167 if (usb_interface_claimed(iface
)) {
168 dev_dbg(&dev
->dev
, "%d:%d: skipping, already claimed\n",
173 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
174 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
175 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDISTREAMING
) {
176 int err
= snd_usbmidi_create(chip
->card
, iface
,
177 &chip
->midi_list
, NULL
);
180 "%u:%d: cannot create sequencer device\n",
184 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
189 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
190 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
191 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
) {
193 "%u:%d: skipping non-supported interface %d\n",
194 ctrlif
, interface
, altsd
->bInterfaceClass
);
195 /* skip non-supported classes */
199 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
200 dev_err(&dev
->dev
, "low speed audio streaming not supported\n");
204 if (! snd_usb_parse_audio_interface(chip
, interface
)) {
205 usb_set_interface(dev
, interface
, 0); /* reset the current interface */
206 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
214 * parse audio control descriptor and create pcm/midi streams
216 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
218 struct usb_device
*dev
= chip
->dev
;
219 struct usb_host_interface
*host_iface
;
220 struct usb_interface_descriptor
*altsd
;
221 void *control_header
;
224 /* find audiocontrol interface */
225 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
226 control_header
= snd_usb_find_csint_desc(host_iface
->extra
,
227 host_iface
->extralen
,
229 altsd
= get_iface_desc(host_iface
);
230 protocol
= altsd
->bInterfaceProtocol
;
232 if (!control_header
) {
233 dev_err(&dev
->dev
, "cannot find UAC_HEADER\n");
240 "unknown interface protocol %#02x, assuming v1\n",
244 case UAC_VERSION_1
: {
245 struct uac1_ac_header_descriptor
*h1
= control_header
;
247 if (!h1
->bInCollection
) {
248 dev_info(&dev
->dev
, "skipping empty audio interface (v1)\n");
252 if (h1
->bLength
< sizeof(*h1
) + h1
->bInCollection
) {
253 dev_err(&dev
->dev
, "invalid UAC_HEADER (v1)\n");
257 for (i
= 0; i
< h1
->bInCollection
; i
++)
258 snd_usb_create_stream(chip
, ctrlif
, h1
->baInterfaceNr
[i
]);
263 case UAC_VERSION_2
: {
264 struct usb_interface_assoc_descriptor
*assoc
=
265 usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
269 * Firmware writers cannot count to three. So to find
270 * the IAD on the NuForce UDH-100, also check the next
273 struct usb_interface
*iface
=
274 usb_ifnum_to_if(dev
, ctrlif
+ 1);
277 iface
->intf_assoc
->bFunctionClass
== USB_CLASS_AUDIO
&&
278 iface
->intf_assoc
->bFunctionProtocol
== UAC_VERSION_2
)
279 assoc
= iface
->intf_assoc
;
283 dev_err(&dev
->dev
, "Audio class v2 interfaces need an interface association\n");
287 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
288 int intf
= assoc
->bFirstInterface
+ i
;
291 snd_usb_create_stream(chip
, ctrlif
, intf
);
302 * free the chip instance
304 * here we have to do not much, since pcm and controls are already freed
308 static int snd_usb_audio_free(struct snd_usb_audio
*chip
)
310 struct list_head
*p
, *n
;
312 list_for_each_safe(p
, n
, &chip
->ep_list
)
313 snd_usb_endpoint_free(p
);
315 mutex_destroy(&chip
->mutex
);
320 static int snd_usb_audio_dev_free(struct snd_device
*device
)
322 struct snd_usb_audio
*chip
= device
->device_data
;
323 return snd_usb_audio_free(chip
);
326 static void remove_trailing_spaces(char *str
)
332 for (p
= str
+ strlen(str
) - 1; p
>= str
&& isspace(*p
); p
--)
337 * create a chip instance and set its names.
339 static int snd_usb_audio_create(struct usb_interface
*intf
,
340 struct usb_device
*dev
, int idx
,
341 const struct snd_usb_audio_quirk
*quirk
,
342 struct snd_usb_audio
**rchip
)
344 struct snd_card
*card
;
345 struct snd_usb_audio
*chip
;
348 static struct snd_device_ops ops
= {
349 .dev_free
= snd_usb_audio_dev_free
,
354 switch (snd_usb_get_speed(dev
)) {
358 case USB_SPEED_WIRELESS
:
359 case USB_SPEED_SUPER
:
362 dev_err(&dev
->dev
, "unknown device speed %d\n", snd_usb_get_speed(dev
));
366 err
= snd_card_new(&intf
->dev
, index
[idx
], id
[idx
], THIS_MODULE
,
369 dev_err(&dev
->dev
, "cannot create card instance %d\n", idx
);
373 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
379 mutex_init(&chip
->mutex
);
380 init_rwsem(&chip
->shutdown_rwsem
);
384 chip
->setup
= device_setup
[idx
];
385 chip
->autoclock
= autoclock
;
388 chip
->usb_id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
389 le16_to_cpu(dev
->descriptor
.idProduct
));
390 INIT_LIST_HEAD(&chip
->pcm_list
);
391 INIT_LIST_HEAD(&chip
->ep_list
);
392 INIT_LIST_HEAD(&chip
->midi_list
);
393 INIT_LIST_HEAD(&chip
->mixer_list
);
395 if ((err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, chip
, &ops
)) < 0) {
396 snd_usb_audio_free(chip
);
401 strcpy(card
->driver
, "USB-Audio");
402 sprintf(component
, "USB%04x:%04x",
403 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
404 snd_component_add(card
, component
);
406 /* retrieve the device string as shortname */
407 if (quirk
&& quirk
->product_name
&& *quirk
->product_name
) {
408 strlcpy(card
->shortname
, quirk
->product_name
, sizeof(card
->shortname
));
410 if (!dev
->descriptor
.iProduct
||
411 usb_string(dev
, dev
->descriptor
.iProduct
,
412 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
413 /* no name available from anywhere, so use ID */
414 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
415 USB_ID_VENDOR(chip
->usb_id
),
416 USB_ID_PRODUCT(chip
->usb_id
));
419 remove_trailing_spaces(card
->shortname
);
421 /* retrieve the vendor and device strings as longname */
422 if (quirk
&& quirk
->vendor_name
&& *quirk
->vendor_name
) {
423 len
= strlcpy(card
->longname
, quirk
->vendor_name
, sizeof(card
->longname
));
425 if (dev
->descriptor
.iManufacturer
)
426 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
427 card
->longname
, sizeof(card
->longname
));
430 /* we don't really care if there isn't any vendor string */
433 remove_trailing_spaces(card
->longname
);
435 strlcat(card
->longname
, " ", sizeof(card
->longname
));
438 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
440 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
442 if (len
< sizeof(card
->longname
))
443 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
445 switch (snd_usb_get_speed(dev
)) {
447 strlcat(card
->longname
, ", low speed", sizeof(card
->longname
));
450 strlcat(card
->longname
, ", full speed", sizeof(card
->longname
));
453 strlcat(card
->longname
, ", high speed", sizeof(card
->longname
));
455 case USB_SPEED_SUPER
:
456 strlcat(card
->longname
, ", super speed", sizeof(card
->longname
));
462 snd_usb_audio_create_proc(chip
);
469 * probe the active usb device
471 * note that this can be called multiple times per a device, when it
472 * includes multiple audio control interfaces.
474 * thus we check the usb device pointer and creates the card instance
475 * only at the first time. the successive calls of this function will
476 * append the pcm interface to the corresponding card.
478 static struct snd_usb_audio
*
479 snd_usb_audio_probe(struct usb_device
*dev
,
480 struct usb_interface
*intf
,
481 const struct usb_device_id
*usb_id
)
483 const struct snd_usb_audio_quirk
*quirk
= (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
485 struct snd_usb_audio
*chip
;
486 struct usb_host_interface
*alts
;
490 alts
= &intf
->altsetting
[0];
491 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
492 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
493 le16_to_cpu(dev
->descriptor
.idProduct
));
494 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
497 if (snd_usb_apply_boot_quirk(dev
, intf
, quirk
) < 0)
501 * found a config. now register to ALSA
504 /* check whether it's already registered */
506 mutex_lock(®ister_mutex
);
507 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
508 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
509 if (usb_chip
[i
]->shutdown
) {
510 dev_err(&dev
->dev
, "USB device is in the shutdown state, cannot create a card instance\n");
520 * now look for an empty slot and create a new card instance
522 for (i
= 0; i
< SNDRV_CARDS
; i
++)
523 if (enable
[i
] && ! usb_chip
[i
] &&
524 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
525 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
526 if (snd_usb_audio_create(intf
, dev
, i
, quirk
,
530 chip
->pm_intf
= intf
;
534 dev_err(&dev
->dev
, "no available usb audio device\n");
540 * For devices with more than one control interface, we assume the
541 * first contains the audio controls. We might need a more specific
542 * check here in the future.
544 if (!chip
->ctrl_intf
)
545 chip
->ctrl_intf
= alts
;
547 chip
->txfr_quirk
= 0;
548 err
= 1; /* continue */
549 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
550 /* need some special handlings */
551 if ((err
= snd_usb_create_quirk(chip
, intf
, &usb_audio_driver
, quirk
)) < 0)
556 /* create normal USB audio interfaces */
557 if (snd_usb_create_streams(chip
, ifnum
) < 0 ||
558 snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
) < 0) {
563 /* we are allowed to call snd_card_register() many times */
564 if (snd_card_register(chip
->card
) < 0) {
568 usb_chip
[chip
->index
] = chip
;
569 chip
->num_interfaces
++;
571 mutex_unlock(®ister_mutex
);
576 if (!chip
->num_interfaces
)
577 snd_card_free(chip
->card
);
580 mutex_unlock(®ister_mutex
);
586 * we need to take care of counter, since disconnection can be called also
587 * many times as well as usb_audio_probe().
589 static void snd_usb_audio_disconnect(struct usb_device
*dev
,
590 struct snd_usb_audio
*chip
)
592 struct snd_card
*card
;
596 if (chip
== (void *)-1L)
600 down_write(&chip
->shutdown_rwsem
);
601 was_shutdown
= chip
->shutdown
;
603 up_write(&chip
->shutdown_rwsem
);
605 mutex_lock(®ister_mutex
);
607 struct snd_usb_endpoint
*ep
;
609 snd_card_disconnect(card
);
610 /* release the pcm resources */
611 list_for_each(p
, &chip
->pcm_list
) {
612 snd_usb_stream_disconnect(p
);
614 /* release the endpoint resources */
615 list_for_each_entry(ep
, &chip
->ep_list
, list
) {
616 snd_usb_endpoint_release(ep
);
618 /* release the midi resources */
619 list_for_each(p
, &chip
->midi_list
) {
620 snd_usbmidi_disconnect(p
);
622 /* release mixer resources */
623 list_for_each(p
, &chip
->mixer_list
) {
624 snd_usb_mixer_disconnect(p
);
628 chip
->num_interfaces
--;
629 if (chip
->num_interfaces
<= 0) {
630 usb_chip
[chip
->index
] = NULL
;
631 mutex_unlock(®ister_mutex
);
632 snd_card_free_when_closed(card
);
634 mutex_unlock(®ister_mutex
);
639 * new 2.5 USB kernel API
641 static int usb_audio_probe(struct usb_interface
*intf
,
642 const struct usb_device_id
*id
)
644 struct snd_usb_audio
*chip
;
645 chip
= snd_usb_audio_probe(interface_to_usbdev(intf
), intf
, id
);
647 usb_set_intfdata(intf
, chip
);
653 static void usb_audio_disconnect(struct usb_interface
*intf
)
655 snd_usb_audio_disconnect(interface_to_usbdev(intf
),
656 usb_get_intfdata(intf
));
661 int snd_usb_autoresume(struct snd_usb_audio
*chip
)
665 down_read(&chip
->shutdown_rwsem
);
666 if (chip
->probing
&& chip
->in_pm
)
668 else if (!chip
->shutdown
)
669 err
= usb_autopm_get_interface(chip
->pm_intf
);
670 up_read(&chip
->shutdown_rwsem
);
675 void snd_usb_autosuspend(struct snd_usb_audio
*chip
)
677 down_read(&chip
->shutdown_rwsem
);
678 if (!chip
->shutdown
&& !chip
->probing
&& !chip
->in_pm
)
679 usb_autopm_put_interface(chip
->pm_intf
);
680 up_read(&chip
->shutdown_rwsem
);
683 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
685 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
686 struct snd_usb_stream
*as
;
687 struct usb_mixer_interface
*mixer
;
690 if (chip
== (void *)-1L)
693 if (!PMSG_IS_AUTO(message
)) {
694 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
695 if (!chip
->num_suspended_intf
++) {
696 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
697 snd_pcm_suspend_all(as
->pcm
);
698 as
->substream
[0].need_setup_ep
=
699 as
->substream
[1].need_setup_ep
= true;
701 list_for_each(p
, &chip
->midi_list
) {
702 snd_usbmidi_suspend(p
);
707 * otherwise we keep the rest of the system in the dark
708 * to keep this transparent
710 if (!chip
->num_suspended_intf
++)
711 chip
->autosuspended
= 1;
714 if (chip
->num_suspended_intf
== 1)
715 list_for_each_entry(mixer
, &chip
->mixer_list
, list
)
716 snd_usb_mixer_suspend(mixer
);
721 static int __usb_audio_resume(struct usb_interface
*intf
, bool reset_resume
)
723 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
724 struct usb_mixer_interface
*mixer
;
728 if (chip
== (void *)-1L)
730 if (--chip
->num_suspended_intf
)
735 * ALSA leaves material resumption to user space
736 * we just notify and restart the mixers
738 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
739 err
= snd_usb_mixer_resume(mixer
, reset_resume
);
744 list_for_each(p
, &chip
->midi_list
) {
745 snd_usbmidi_resume(p
);
748 if (!chip
->autosuspended
)
749 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
750 chip
->autosuspended
= 0;
757 static int usb_audio_resume(struct usb_interface
*intf
)
759 return __usb_audio_resume(intf
, false);
762 static int usb_audio_reset_resume(struct usb_interface
*intf
)
764 return __usb_audio_resume(intf
, true);
767 #define usb_audio_suspend NULL
768 #define usb_audio_resume NULL
769 #define usb_audio_reset_resume NULL
770 #endif /* CONFIG_PM */
772 static struct usb_device_id usb_audio_ids
[] = {
773 #include "quirks-table.h"
774 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
775 .bInterfaceClass
= USB_CLASS_AUDIO
,
776 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
777 { } /* Terminating entry */
779 MODULE_DEVICE_TABLE(usb
, usb_audio_ids
);
782 * entry point for linux usb interface
785 static struct usb_driver usb_audio_driver
= {
786 .name
= "snd-usb-audio",
787 .probe
= usb_audio_probe
,
788 .disconnect
= usb_audio_disconnect
,
789 .suspend
= usb_audio_suspend
,
790 .resume
= usb_audio_resume
,
791 .reset_resume
= usb_audio_reset_resume
,
792 .id_table
= usb_audio_ids
,
793 .supports_autosuspend
= 1,
796 module_usb_driver(usb_audio_driver
);