1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * (Tentative) USB Audio Driver for ALSA
5 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
7 * Many codes borrowed from audio.c by
8 * Alan Cox (alan@lxorguk.ukuu.org.uk)
9 * Thomas Sailer (sailer@ife.ee.ethz.ch)
11 * Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com>
15 * - the linked URBs would be preferred but not used so far because of
16 * the instability of unlinking.
17 * - type II is not supported properly. there is no device which supports
18 * this type *correctly*. SB extigy looks as if it supports, but it's
19 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
23 #include <linux/bitops.h>
24 #include <linux/init.h>
25 #include <linux/list.h>
26 #include <linux/slab.h>
27 #include <linux/string.h>
28 #include <linux/ctype.h>
29 #include <linux/usb.h>
30 #include <linux/moduleparam.h>
31 #include <linux/mutex.h>
32 #include <linux/usb/audio.h>
33 #include <linux/usb/audio-v2.h>
34 #include <linux/usb/audio-v3.h>
35 #include <linux/module.h>
37 #include <sound/control.h>
38 #include <sound/core.h>
39 #include <sound/info.h>
40 #include <sound/pcm.h>
41 #include <sound/pcm_params.h>
42 #include <sound/initval.h>
59 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
60 MODULE_DESCRIPTION("USB Audio");
61 MODULE_LICENSE("GPL");
62 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
65 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
66 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
67 static bool enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;/* Enable this card */
68 /* Vendor/product IDs for this card */
69 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
70 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
71 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card */
72 static bool ignore_ctl_error
;
73 static bool autoclock
= true;
74 static char *quirk_alias
[SNDRV_CARDS
];
75 static char *delayed_register
[SNDRV_CARDS
];
77 bool snd_usb_use_vmalloc
= true;
78 bool snd_usb_skip_validation
;
80 module_param_array(index
, int, NULL
, 0444);
81 MODULE_PARM_DESC(index
, "Index value for the USB audio adapter.");
82 module_param_array(id
, charp
, NULL
, 0444);
83 MODULE_PARM_DESC(id
, "ID string for the USB audio adapter.");
84 module_param_array(enable
, bool, NULL
, 0444);
85 MODULE_PARM_DESC(enable
, "Enable USB audio adapter.");
86 module_param_array(vid
, int, NULL
, 0444);
87 MODULE_PARM_DESC(vid
, "Vendor ID for the USB audio device.");
88 module_param_array(pid
, int, NULL
, 0444);
89 MODULE_PARM_DESC(pid
, "Product ID for the USB audio device.");
90 module_param_array(device_setup
, int, NULL
, 0444);
91 MODULE_PARM_DESC(device_setup
, "Specific device setup (if needed).");
92 module_param(ignore_ctl_error
, bool, 0444);
93 MODULE_PARM_DESC(ignore_ctl_error
,
94 "Ignore errors from USB controller for mixer interfaces.");
95 module_param(autoclock
, bool, 0444);
96 MODULE_PARM_DESC(autoclock
, "Enable auto-clock selection for UAC2 devices (default: yes).");
97 module_param_array(quirk_alias
, charp
, NULL
, 0444);
98 MODULE_PARM_DESC(quirk_alias
, "Quirk aliases, e.g. 0123abcd:5678beef.");
99 module_param_array(delayed_register
, charp
, NULL
, 0444);
100 MODULE_PARM_DESC(delayed_register
, "Quirk for delayed registration, given by id:iface, e.g. 0123abcd:4.");
101 module_param_named(use_vmalloc
, snd_usb_use_vmalloc
, bool, 0444);
102 MODULE_PARM_DESC(use_vmalloc
, "Use vmalloc for PCM intermediate buffers (default: yes).");
103 module_param_named(skip_validation
, snd_usb_skip_validation
, bool, 0444);
104 MODULE_PARM_DESC(skip_validation
, "Skip unit descriptor validation (default: no).");
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 usb_audio_disconnect()
119 static void snd_usb_stream_disconnect(struct snd_usb_stream
*as
)
122 struct snd_usb_substream
*subs
;
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
,
181 "%u:%d: cannot create sequencer device\n",
185 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
190 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
191 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
192 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
) {
194 "%u:%d: skipping non-supported interface %d\n",
195 ctrlif
, interface
, altsd
->bInterfaceClass
);
196 /* skip non-supported classes */
200 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
201 dev_err(&dev
->dev
, "low speed audio streaming not supported\n");
205 if (! snd_usb_parse_audio_interface(chip
, interface
)) {
206 usb_set_interface(dev
, interface
, 0); /* reset the current interface */
207 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
;
223 /* find audiocontrol interface */
224 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
225 altsd
= get_iface_desc(host_iface
);
226 protocol
= altsd
->bInterfaceProtocol
;
231 "unknown interface protocol %#02x, assuming v1\n",
235 case UAC_VERSION_1
: {
236 struct uac1_ac_header_descriptor
*h1
;
239 h1
= snd_usb_find_csint_desc(host_iface
->extra
,
240 host_iface
->extralen
,
242 if (!h1
|| h1
->bLength
< sizeof(*h1
)) {
243 dev_err(&dev
->dev
, "cannot find UAC_HEADER\n");
247 rest_bytes
= (void *)(host_iface
->extra
+
248 host_iface
->extralen
) - (void *)h1
;
250 /* just to be sure -- this shouldn't hit at all */
251 if (rest_bytes
<= 0) {
252 dev_err(&dev
->dev
, "invalid control header\n");
256 if (rest_bytes
< sizeof(*h1
)) {
257 dev_err(&dev
->dev
, "too short v1 buffer descriptor\n");
261 if (!h1
->bInCollection
) {
262 dev_info(&dev
->dev
, "skipping empty audio interface (v1)\n");
266 if (rest_bytes
< h1
->bLength
) {
267 dev_err(&dev
->dev
, "invalid buffer length (v1)\n");
271 if (h1
->bLength
< sizeof(*h1
) + h1
->bInCollection
) {
272 dev_err(&dev
->dev
, "invalid UAC_HEADER (v1)\n");
276 for (i
= 0; i
< h1
->bInCollection
; i
++)
277 snd_usb_create_stream(chip
, ctrlif
, h1
->baInterfaceNr
[i
]);
283 case UAC_VERSION_3
: {
284 struct usb_interface_assoc_descriptor
*assoc
=
285 usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
289 * Firmware writers cannot count to three. So to find
290 * the IAD on the NuForce UDH-100, also check the next
293 struct usb_interface
*iface
=
294 usb_ifnum_to_if(dev
, ctrlif
+ 1);
297 iface
->intf_assoc
->bFunctionClass
== USB_CLASS_AUDIO
&&
298 iface
->intf_assoc
->bFunctionProtocol
== UAC_VERSION_2
)
299 assoc
= iface
->intf_assoc
;
303 dev_err(&dev
->dev
, "Audio class v2/v3 interfaces need an interface association\n");
307 if (protocol
== UAC_VERSION_3
) {
308 int badd
= assoc
->bFunctionSubClass
;
310 if (badd
!= UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0
&&
311 (badd
< UAC3_FUNCTION_SUBCLASS_GENERIC_IO
||
312 badd
> UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE
)) {
314 "Unsupported UAC3 BADD profile\n");
318 chip
->badd_profile
= badd
;
321 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
322 int intf
= assoc
->bFirstInterface
+ i
;
325 snd_usb_create_stream(chip
, ctrlif
, intf
);
336 * Profile name preset table
338 struct usb_audio_device_name
{
340 const char *vendor_name
;
341 const char *product_name
;
342 const char *profile_name
; /* override card->longname */
345 #define PROFILE_NAME(vid, pid, vendor, product, profile) \
346 { .id = USB_ID(vid, pid), .vendor_name = (vendor), \
347 .product_name = (product), .profile_name = (profile) }
348 #define DEVICE_NAME(vid, pid, vendor, product) \
349 PROFILE_NAME(vid, pid, vendor, product, NULL)
351 /* vendor/product and profile name presets, sorted in device id order */
352 static const struct usb_audio_device_name usb_audio_names
[] = {
353 /* HP Thunderbolt Dock Audio Headset */
354 PROFILE_NAME(0x03f0, 0x0269, "HP", "Thunderbolt Dock Audio Headset",
355 "HP-Thunderbolt-Dock-Audio-Headset"),
356 /* HP Thunderbolt Dock Audio Module */
357 PROFILE_NAME(0x03f0, 0x0567, "HP", "Thunderbolt Dock Audio Module",
358 "HP-Thunderbolt-Dock-Audio-Module"),
360 /* Two entries for Gigabyte TRX40 Aorus Master:
361 * TRX40 Aorus Master has two USB-audio devices, one for the front
362 * headphone with ESS SABRE9218 DAC chip, while another for the rest
363 * I/O (the rear panel and the front mic) with Realtek ALC1220-VB.
364 * Here we provide two distinct names for making UCM profiles easier.
366 PROFILE_NAME(0x0414, 0xa000, "Gigabyte", "Aorus Master Front Headphone",
367 "Gigabyte-Aorus-Master-Front-Headphone"),
368 PROFILE_NAME(0x0414, 0xa001, "Gigabyte", "Aorus Master Main Audio",
369 "Gigabyte-Aorus-Master-Main-Audio"),
371 /* Gigabyte TRX40 Aorus Pro WiFi */
372 PROFILE_NAME(0x0414, 0xa002,
373 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
375 /* Creative/E-Mu devices */
376 DEVICE_NAME(0x041e, 0x3010, "Creative Labs", "Sound Blaster MP3+"),
377 /* Creative/Toshiba Multimedia Center SB-0500 */
378 DEVICE_NAME(0x041e, 0x3048, "Toshiba", "SB-0500"),
380 DEVICE_NAME(0x046d, 0x0990, "Logitech, Inc.", "QuickCam Pro 9000"),
383 PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
385 PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
387 DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
390 * The original product_name is "USB Sound Device", however this name
391 * is also used by the CM106 based cards, so make it unique.
393 DEVICE_NAME(0x0d8c, 0x0102, NULL
, "ICUSBAUDIO7D"),
394 DEVICE_NAME(0x0d8c, 0x0103, NULL
, "Audio Advantage MicroII"),
396 /* MSI TRX40 Creator */
397 PROFILE_NAME(0x0db0, 0x0d64,
398 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
400 PROFILE_NAME(0x0db0, 0x543d,
401 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
403 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
404 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
405 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
407 /* aka. Serato Scratch Live DJ Box */
408 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
410 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
411 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
412 "Lenovo-ThinkStation-P620-Rear"),
413 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
414 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
415 "Lenovo-ThinkStation-P620-Main"),
417 /* Asrock TRX40 Creator */
418 PROFILE_NAME(0x26ce, 0x0a01,
419 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
424 static const struct usb_audio_device_name
*
425 lookup_device_name(u32 id
)
427 static const struct usb_audio_device_name
*p
;
429 for (p
= usb_audio_names
; p
->id
; p
++)
436 * free the chip instance
438 * here we have to do not much, since pcm and controls are already freed
442 static void snd_usb_audio_free(struct snd_card
*card
)
444 struct snd_usb_audio
*chip
= card
->private_data
;
445 struct snd_usb_endpoint
*ep
, *n
;
447 list_for_each_entry_safe(ep
, n
, &chip
->ep_list
, list
)
448 snd_usb_endpoint_free(ep
);
450 mutex_destroy(&chip
->mutex
);
451 if (!atomic_read(&chip
->shutdown
))
452 dev_set_drvdata(&chip
->dev
->dev
, NULL
);
455 static void usb_audio_make_shortname(struct usb_device
*dev
,
456 struct snd_usb_audio
*chip
,
457 const struct snd_usb_audio_quirk
*quirk
)
459 struct snd_card
*card
= chip
->card
;
460 const struct usb_audio_device_name
*preset
;
461 const char *s
= NULL
;
463 preset
= lookup_device_name(chip
->usb_id
);
464 if (preset
&& preset
->product_name
)
465 s
= preset
->product_name
;
466 else if (quirk
&& quirk
->product_name
)
467 s
= quirk
->product_name
;
469 strlcpy(card
->shortname
, s
, sizeof(card
->shortname
));
473 /* retrieve the device string as shortname */
474 if (!dev
->descriptor
.iProduct
||
475 usb_string(dev
, dev
->descriptor
.iProduct
,
476 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
477 /* no name available from anywhere, so use ID */
478 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
479 USB_ID_VENDOR(chip
->usb_id
),
480 USB_ID_PRODUCT(chip
->usb_id
));
483 strim(card
->shortname
);
486 static void usb_audio_make_longname(struct usb_device
*dev
,
487 struct snd_usb_audio
*chip
,
488 const struct snd_usb_audio_quirk
*quirk
)
490 struct snd_card
*card
= chip
->card
;
491 const struct usb_audio_device_name
*preset
;
492 const char *s
= NULL
;
495 preset
= lookup_device_name(chip
->usb_id
);
497 /* shortcut - if any pre-defined string is given, use it */
498 if (preset
&& preset
->profile_name
)
499 s
= preset
->profile_name
;
501 strlcpy(card
->longname
, s
, sizeof(card
->longname
));
505 if (preset
&& preset
->vendor_name
)
506 s
= preset
->vendor_name
;
507 else if (quirk
&& quirk
->vendor_name
)
508 s
= quirk
->vendor_name
;
510 len
= strlcpy(card
->longname
, s
, sizeof(card
->longname
));
512 /* retrieve the vendor and device strings as longname */
513 if (dev
->descriptor
.iManufacturer
)
514 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
515 card
->longname
, sizeof(card
->longname
));
518 /* we don't really care if there isn't any vendor string */
521 strim(card
->longname
);
523 strlcat(card
->longname
, " ", sizeof(card
->longname
));
526 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
528 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
530 if (len
< sizeof(card
->longname
))
531 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
533 switch (snd_usb_get_speed(dev
)) {
535 strlcat(card
->longname
, ", low speed", sizeof(card
->longname
));
538 strlcat(card
->longname
, ", full speed", sizeof(card
->longname
));
541 strlcat(card
->longname
, ", high speed", sizeof(card
->longname
));
543 case USB_SPEED_SUPER
:
544 strlcat(card
->longname
, ", super speed", sizeof(card
->longname
));
546 case USB_SPEED_SUPER_PLUS
:
547 strlcat(card
->longname
, ", super speed plus", sizeof(card
->longname
));
555 * create a chip instance and set its names.
557 static int snd_usb_audio_create(struct usb_interface
*intf
,
558 struct usb_device
*dev
, int idx
,
559 const struct snd_usb_audio_quirk
*quirk
,
561 struct snd_usb_audio
**rchip
)
563 struct snd_card
*card
;
564 struct snd_usb_audio
*chip
;
570 switch (snd_usb_get_speed(dev
)) {
574 case USB_SPEED_WIRELESS
:
575 case USB_SPEED_SUPER
:
576 case USB_SPEED_SUPER_PLUS
:
579 dev_err(&dev
->dev
, "unknown device speed %d\n", snd_usb_get_speed(dev
));
583 err
= snd_card_new(&intf
->dev
, index
[idx
], id
[idx
], THIS_MODULE
,
584 sizeof(*chip
), &card
);
586 dev_err(&dev
->dev
, "cannot create card instance %d\n", idx
);
590 chip
= card
->private_data
;
591 mutex_init(&chip
->mutex
);
592 init_waitqueue_head(&chip
->shutdown_wait
);
596 chip
->setup
= device_setup
[idx
];
597 chip
->autoclock
= autoclock
;
598 atomic_set(&chip
->active
, 1); /* avoid autopm during probing */
599 atomic_set(&chip
->usage_count
, 0);
600 atomic_set(&chip
->shutdown
, 0);
602 chip
->usb_id
= usb_id
;
603 INIT_LIST_HEAD(&chip
->pcm_list
);
604 INIT_LIST_HEAD(&chip
->ep_list
);
605 INIT_LIST_HEAD(&chip
->midi_list
);
606 INIT_LIST_HEAD(&chip
->mixer_list
);
608 card
->private_free
= snd_usb_audio_free
;
610 strcpy(card
->driver
, "USB-Audio");
611 sprintf(component
, "USB%04x:%04x",
612 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
613 snd_component_add(card
, component
);
615 usb_audio_make_shortname(dev
, chip
, quirk
);
616 usb_audio_make_longname(dev
, chip
, quirk
);
618 snd_usb_audio_create_proc(chip
);
624 /* look for a matching quirk alias id */
625 static bool get_alias_id(struct usb_device
*dev
, unsigned int *id
)
628 unsigned int src
, dst
;
630 for (i
= 0; i
< ARRAY_SIZE(quirk_alias
); i
++) {
631 if (!quirk_alias
[i
] ||
632 sscanf(quirk_alias
[i
], "%x:%x", &src
, &dst
) != 2 ||
636 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
637 USB_ID_VENDOR(*id
), USB_ID_PRODUCT(*id
),
638 USB_ID_VENDOR(dst
), USB_ID_PRODUCT(dst
));
646 static bool check_delayed_register_option(struct snd_usb_audio
*chip
, int iface
)
649 unsigned int id
, inum
;
651 for (i
= 0; i
< ARRAY_SIZE(delayed_register
); i
++) {
652 if (delayed_register
[i
] &&
653 sscanf(delayed_register
[i
], "%x:%x", &id
, &inum
) == 2 &&
655 return inum
!= iface
;
661 static const struct usb_device_id usb_audio_ids
[]; /* defined below */
663 /* look for the corresponding quirk */
664 static const struct snd_usb_audio_quirk
*
665 get_alias_quirk(struct usb_device
*dev
, unsigned int id
)
667 const struct usb_device_id
*p
;
669 for (p
= usb_audio_ids
; p
->match_flags
; p
++) {
670 /* FIXME: this checks only vendor:product pair in the list */
671 if ((p
->match_flags
& USB_DEVICE_ID_MATCH_DEVICE
) ==
672 USB_DEVICE_ID_MATCH_DEVICE
&&
673 p
->idVendor
== USB_ID_VENDOR(id
) &&
674 p
->idProduct
== USB_ID_PRODUCT(id
))
675 return (const struct snd_usb_audio_quirk
*)p
->driver_info
;
682 * probe the active usb device
684 * note that this can be called multiple times per a device, when it
685 * includes multiple audio control interfaces.
687 * thus we check the usb device pointer and creates the card instance
688 * only at the first time. the successive calls of this function will
689 * append the pcm interface to the corresponding card.
691 static int usb_audio_probe(struct usb_interface
*intf
,
692 const struct usb_device_id
*usb_id
)
694 struct usb_device
*dev
= interface_to_usbdev(intf
);
695 const struct snd_usb_audio_quirk
*quirk
=
696 (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
697 struct snd_usb_audio
*chip
;
699 struct usb_host_interface
*alts
;
703 alts
= &intf
->altsetting
[0];
704 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
705 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
706 le16_to_cpu(dev
->descriptor
.idProduct
));
707 if (get_alias_id(dev
, &id
))
708 quirk
= get_alias_quirk(dev
, id
);
709 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
712 err
= snd_usb_apply_boot_quirk(dev
, intf
, quirk
, id
);
717 * found a config. now register to ALSA
720 /* check whether it's already registered */
722 mutex_lock(®ister_mutex
);
723 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
724 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
725 if (atomic_read(&usb_chip
[i
]->shutdown
)) {
726 dev_err(&dev
->dev
, "USB device is in the shutdown state, cannot create a card instance\n");
731 atomic_inc(&chip
->active
); /* avoid autopm */
736 err
= snd_usb_apply_boot_quirk_once(dev
, intf
, quirk
, id
);
741 * now look for an empty slot and create a new card instance
743 for (i
= 0; i
< SNDRV_CARDS
; i
++)
745 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
746 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
748 err
= snd_usb_audio_create(intf
, dev
, i
, quirk
,
753 } else if (vid
[i
] != -1 || pid
[i
] != -1) {
755 "device (%04x:%04x) is disabled\n",
763 dev_err(&dev
->dev
, "no available usb audio device\n");
769 if (chip
->num_interfaces
>= MAX_CARD_INTERFACES
) {
770 dev_info(&dev
->dev
, "Too many interfaces assigned to the single USB-audio card\n");
775 dev_set_drvdata(&dev
->dev
, chip
);
778 * For devices with more than one control interface, we assume the
779 * first contains the audio controls. We might need a more specific
780 * check here in the future.
782 if (!chip
->ctrl_intf
)
783 chip
->ctrl_intf
= alts
;
785 chip
->txfr_quirk
= 0;
786 err
= 1; /* continue */
787 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
788 /* need some special handlings */
789 err
= snd_usb_create_quirk(chip
, intf
, &usb_audio_driver
, quirk
);
795 /* create normal USB audio interfaces */
796 err
= snd_usb_create_streams(chip
, ifnum
);
799 err
= snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
);
804 if (chip
->need_delayed_register
) {
806 "Found post-registration device assignment: %08x:%02x\n",
807 chip
->usb_id
, ifnum
);
808 chip
->need_delayed_register
= false; /* clear again */
811 /* we are allowed to call snd_card_register() many times, but first
812 * check to see if a device needs to skip it or do anything special
814 if (!snd_usb_registration_quirk(chip
, ifnum
) &&
815 !check_delayed_register_option(chip
, ifnum
)) {
816 err
= snd_card_register(chip
->card
);
821 if (quirk
&& quirk
->shares_media_device
) {
822 /* don't want to fail when snd_media_device_create() fails */
823 snd_media_device_create(chip
, intf
);
826 usb_chip
[chip
->index
] = chip
;
827 chip
->intf
[chip
->num_interfaces
] = intf
;
828 chip
->num_interfaces
++;
829 usb_set_intfdata(intf
, chip
);
830 atomic_dec(&chip
->active
);
831 mutex_unlock(®ister_mutex
);
836 /* chip->active is inside the chip->card object,
837 * decrement before memory is possibly returned.
839 atomic_dec(&chip
->active
);
840 if (!chip
->num_interfaces
)
841 snd_card_free(chip
->card
);
843 mutex_unlock(®ister_mutex
);
848 * we need to take care of counter, since disconnection can be called also
849 * many times as well as usb_audio_probe().
851 static void usb_audio_disconnect(struct usb_interface
*intf
)
853 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
854 struct snd_card
*card
;
857 if (chip
== (void *)-1L)
862 mutex_lock(®ister_mutex
);
863 if (atomic_inc_return(&chip
->shutdown
) == 1) {
864 struct snd_usb_stream
*as
;
865 struct snd_usb_endpoint
*ep
;
866 struct usb_mixer_interface
*mixer
;
868 /* wait until all pending tasks done;
869 * they are protected by snd_usb_lock_shutdown()
871 wait_event(chip
->shutdown_wait
,
872 !atomic_read(&chip
->usage_count
));
873 snd_card_disconnect(card
);
874 /* release the pcm resources */
875 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
876 snd_usb_stream_disconnect(as
);
878 /* release the endpoint resources */
879 list_for_each_entry(ep
, &chip
->ep_list
, list
) {
880 snd_usb_endpoint_release(ep
);
882 /* release the midi resources */
883 list_for_each(p
, &chip
->midi_list
) {
884 snd_usbmidi_disconnect(p
);
887 * Nice to check quirk && quirk->shares_media_device and
888 * then call the snd_media_device_delete(). Don't have
889 * access to the quirk here. snd_media_device_delete()
890 * accesses mixer_list
892 snd_media_device_delete(chip
);
894 /* release mixer resources */
895 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
896 snd_usb_mixer_disconnect(mixer
);
900 chip
->num_interfaces
--;
901 if (chip
->num_interfaces
<= 0) {
902 usb_chip
[chip
->index
] = NULL
;
903 mutex_unlock(®ister_mutex
);
904 snd_card_free_when_closed(card
);
906 mutex_unlock(®ister_mutex
);
910 /* lock the shutdown (disconnect) task and autoresume */
911 int snd_usb_lock_shutdown(struct snd_usb_audio
*chip
)
915 atomic_inc(&chip
->usage_count
);
916 if (atomic_read(&chip
->shutdown
)) {
920 err
= snd_usb_autoresume(chip
);
926 if (atomic_dec_and_test(&chip
->usage_count
))
927 wake_up(&chip
->shutdown_wait
);
931 /* autosuspend and unlock the shutdown */
932 void snd_usb_unlock_shutdown(struct snd_usb_audio
*chip
)
934 snd_usb_autosuspend(chip
);
935 if (atomic_dec_and_test(&chip
->usage_count
))
936 wake_up(&chip
->shutdown_wait
);
941 int snd_usb_autoresume(struct snd_usb_audio
*chip
)
945 if (atomic_read(&chip
->shutdown
))
947 if (atomic_inc_return(&chip
->active
) != 1)
950 for (i
= 0; i
< chip
->num_interfaces
; i
++) {
951 err
= usb_autopm_get_interface(chip
->intf
[i
]);
955 usb_autopm_put_interface(chip
->intf
[i
]);
956 atomic_dec(&chip
->active
);
963 void snd_usb_autosuspend(struct snd_usb_audio
*chip
)
967 if (atomic_read(&chip
->shutdown
))
969 if (!atomic_dec_and_test(&chip
->active
))
972 for (i
= 0; i
< chip
->num_interfaces
; i
++)
973 usb_autopm_put_interface(chip
->intf
[i
]);
976 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
978 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
979 struct snd_usb_stream
*as
;
980 struct usb_mixer_interface
*mixer
;
983 if (chip
== (void *)-1L)
986 if (!chip
->num_suspended_intf
++) {
987 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
988 snd_usb_pcm_suspend(as
);
989 as
->substream
[0].need_setup_ep
=
990 as
->substream
[1].need_setup_ep
= true;
992 list_for_each(p
, &chip
->midi_list
)
993 snd_usbmidi_suspend(p
);
994 list_for_each_entry(mixer
, &chip
->mixer_list
, list
)
995 snd_usb_mixer_suspend(mixer
);
998 if (!PMSG_IS_AUTO(message
) && !chip
->system_suspend
) {
999 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
1000 chip
->system_suspend
= chip
->num_suspended_intf
;
1006 static int __usb_audio_resume(struct usb_interface
*intf
, bool reset_resume
)
1008 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
1009 struct snd_usb_stream
*as
;
1010 struct usb_mixer_interface
*mixer
;
1011 struct list_head
*p
;
1014 if (chip
== (void *)-1L)
1017 atomic_inc(&chip
->active
); /* avoid autopm */
1018 if (chip
->num_suspended_intf
> 1)
1021 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
1022 err
= snd_usb_pcm_resume(as
);
1028 * ALSA leaves material resumption to user space
1029 * we just notify and restart the mixers
1031 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
1032 err
= snd_usb_mixer_resume(mixer
, reset_resume
);
1037 list_for_each(p
, &chip
->midi_list
) {
1038 snd_usbmidi_resume(p
);
1042 if (chip
->num_suspended_intf
== chip
->system_suspend
) {
1043 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
1044 chip
->system_suspend
= 0;
1046 chip
->num_suspended_intf
--;
1049 atomic_dec(&chip
->active
); /* allow autopm after this point */
1053 static int usb_audio_resume(struct usb_interface
*intf
)
1055 return __usb_audio_resume(intf
, false);
1058 static int usb_audio_reset_resume(struct usb_interface
*intf
)
1060 return __usb_audio_resume(intf
, true);
1063 #define usb_audio_suspend NULL
1064 #define usb_audio_resume NULL
1065 #define usb_audio_reset_resume NULL
1066 #endif /* CONFIG_PM */
1068 static const struct usb_device_id usb_audio_ids
[] = {
1069 #include "quirks-table.h"
1070 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
1071 .bInterfaceClass
= USB_CLASS_AUDIO
,
1072 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
1073 { } /* Terminating entry */
1075 MODULE_DEVICE_TABLE(usb
, usb_audio_ids
);
1078 * entry point for linux usb interface
1081 static struct usb_driver usb_audio_driver
= {
1082 .name
= "snd-usb-audio",
1083 .probe
= usb_audio_probe
,
1084 .disconnect
= usb_audio_disconnect
,
1085 .suspend
= usb_audio_suspend
,
1086 .resume
= usb_audio_resume
,
1087 .reset_resume
= usb_audio_reset_resume
,
1088 .id_table
= usb_audio_ids
,
1089 .supports_autosuspend
= 1,
1092 module_usb_driver(usb_audio_driver
);