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(0x0b05, 0x1917,
384 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
387 PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
389 PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
391 DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
394 * The original product_name is "USB Sound Device", however this name
395 * is also used by the CM106 based cards, so make it unique.
397 DEVICE_NAME(0x0d8c, 0x0102, NULL
, "ICUSBAUDIO7D"),
398 DEVICE_NAME(0x0d8c, 0x0103, NULL
, "Audio Advantage MicroII"),
400 /* MSI TRX40 Creator */
401 PROFILE_NAME(0x0db0, 0x0d64,
402 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
404 PROFILE_NAME(0x0db0, 0x543d,
405 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
407 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
408 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
409 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
411 /* aka. Serato Scratch Live DJ Box */
412 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
414 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
415 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
416 "Lenovo-ThinkStation-P620-Rear"),
417 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
418 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
419 "Lenovo-ThinkStation-P620-Main"),
421 /* Asrock TRX40 Creator */
422 PROFILE_NAME(0x26ce, 0x0a01,
423 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
428 static const struct usb_audio_device_name
*
429 lookup_device_name(u32 id
)
431 static const struct usb_audio_device_name
*p
;
433 for (p
= usb_audio_names
; p
->id
; p
++)
440 * free the chip instance
442 * here we have to do not much, since pcm and controls are already freed
446 static void snd_usb_audio_free(struct snd_card
*card
)
448 struct snd_usb_audio
*chip
= card
->private_data
;
449 struct snd_usb_endpoint
*ep
, *n
;
451 list_for_each_entry_safe(ep
, n
, &chip
->ep_list
, list
)
452 snd_usb_endpoint_free(ep
);
454 mutex_destroy(&chip
->mutex
);
455 if (!atomic_read(&chip
->shutdown
))
456 dev_set_drvdata(&chip
->dev
->dev
, NULL
);
459 static void usb_audio_make_shortname(struct usb_device
*dev
,
460 struct snd_usb_audio
*chip
,
461 const struct snd_usb_audio_quirk
*quirk
)
463 struct snd_card
*card
= chip
->card
;
464 const struct usb_audio_device_name
*preset
;
465 const char *s
= NULL
;
467 preset
= lookup_device_name(chip
->usb_id
);
468 if (preset
&& preset
->product_name
)
469 s
= preset
->product_name
;
470 else if (quirk
&& quirk
->product_name
)
471 s
= quirk
->product_name
;
473 strlcpy(card
->shortname
, s
, sizeof(card
->shortname
));
477 /* retrieve the device string as shortname */
478 if (!dev
->descriptor
.iProduct
||
479 usb_string(dev
, dev
->descriptor
.iProduct
,
480 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
481 /* no name available from anywhere, so use ID */
482 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
483 USB_ID_VENDOR(chip
->usb_id
),
484 USB_ID_PRODUCT(chip
->usb_id
));
487 strim(card
->shortname
);
490 static void usb_audio_make_longname(struct usb_device
*dev
,
491 struct snd_usb_audio
*chip
,
492 const struct snd_usb_audio_quirk
*quirk
)
494 struct snd_card
*card
= chip
->card
;
495 const struct usb_audio_device_name
*preset
;
496 const char *s
= NULL
;
499 preset
= lookup_device_name(chip
->usb_id
);
501 /* shortcut - if any pre-defined string is given, use it */
502 if (preset
&& preset
->profile_name
)
503 s
= preset
->profile_name
;
505 strlcpy(card
->longname
, s
, sizeof(card
->longname
));
509 if (preset
&& preset
->vendor_name
)
510 s
= preset
->vendor_name
;
511 else if (quirk
&& quirk
->vendor_name
)
512 s
= quirk
->vendor_name
;
514 len
= strlcpy(card
->longname
, s
, sizeof(card
->longname
));
516 /* retrieve the vendor and device strings as longname */
517 if (dev
->descriptor
.iManufacturer
)
518 len
= usb_string(dev
, dev
->descriptor
.iManufacturer
,
519 card
->longname
, sizeof(card
->longname
));
522 /* we don't really care if there isn't any vendor string */
525 strim(card
->longname
);
527 strlcat(card
->longname
, " ", sizeof(card
->longname
));
530 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
532 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
534 if (len
< sizeof(card
->longname
))
535 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
537 switch (snd_usb_get_speed(dev
)) {
539 strlcat(card
->longname
, ", low speed", sizeof(card
->longname
));
542 strlcat(card
->longname
, ", full speed", sizeof(card
->longname
));
545 strlcat(card
->longname
, ", high speed", sizeof(card
->longname
));
547 case USB_SPEED_SUPER
:
548 strlcat(card
->longname
, ", super speed", sizeof(card
->longname
));
550 case USB_SPEED_SUPER_PLUS
:
551 strlcat(card
->longname
, ", super speed plus", sizeof(card
->longname
));
559 * create a chip instance and set its names.
561 static int snd_usb_audio_create(struct usb_interface
*intf
,
562 struct usb_device
*dev
, int idx
,
563 const struct snd_usb_audio_quirk
*quirk
,
565 struct snd_usb_audio
**rchip
)
567 struct snd_card
*card
;
568 struct snd_usb_audio
*chip
;
574 switch (snd_usb_get_speed(dev
)) {
578 case USB_SPEED_WIRELESS
:
579 case USB_SPEED_SUPER
:
580 case USB_SPEED_SUPER_PLUS
:
583 dev_err(&dev
->dev
, "unknown device speed %d\n", snd_usb_get_speed(dev
));
587 err
= snd_card_new(&intf
->dev
, index
[idx
], id
[idx
], THIS_MODULE
,
588 sizeof(*chip
), &card
);
590 dev_err(&dev
->dev
, "cannot create card instance %d\n", idx
);
594 chip
= card
->private_data
;
595 mutex_init(&chip
->mutex
);
596 init_waitqueue_head(&chip
->shutdown_wait
);
600 chip
->setup
= device_setup
[idx
];
601 chip
->autoclock
= autoclock
;
602 atomic_set(&chip
->active
, 1); /* avoid autopm during probing */
603 atomic_set(&chip
->usage_count
, 0);
604 atomic_set(&chip
->shutdown
, 0);
606 chip
->usb_id
= usb_id
;
607 INIT_LIST_HEAD(&chip
->pcm_list
);
608 INIT_LIST_HEAD(&chip
->ep_list
);
609 INIT_LIST_HEAD(&chip
->midi_list
);
610 INIT_LIST_HEAD(&chip
->mixer_list
);
612 card
->private_free
= snd_usb_audio_free
;
614 strcpy(card
->driver
, "USB-Audio");
615 sprintf(component
, "USB%04x:%04x",
616 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
617 snd_component_add(card
, component
);
619 usb_audio_make_shortname(dev
, chip
, quirk
);
620 usb_audio_make_longname(dev
, chip
, quirk
);
622 snd_usb_audio_create_proc(chip
);
628 /* look for a matching quirk alias id */
629 static bool get_alias_id(struct usb_device
*dev
, unsigned int *id
)
632 unsigned int src
, dst
;
634 for (i
= 0; i
< ARRAY_SIZE(quirk_alias
); i
++) {
635 if (!quirk_alias
[i
] ||
636 sscanf(quirk_alias
[i
], "%x:%x", &src
, &dst
) != 2 ||
640 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
641 USB_ID_VENDOR(*id
), USB_ID_PRODUCT(*id
),
642 USB_ID_VENDOR(dst
), USB_ID_PRODUCT(dst
));
650 static bool check_delayed_register_option(struct snd_usb_audio
*chip
, int iface
)
653 unsigned int id
, inum
;
655 for (i
= 0; i
< ARRAY_SIZE(delayed_register
); i
++) {
656 if (delayed_register
[i
] &&
657 sscanf(delayed_register
[i
], "%x:%x", &id
, &inum
) == 2 &&
659 return inum
!= iface
;
665 static const struct usb_device_id usb_audio_ids
[]; /* defined below */
667 /* look for the corresponding quirk */
668 static const struct snd_usb_audio_quirk
*
669 get_alias_quirk(struct usb_device
*dev
, unsigned int id
)
671 const struct usb_device_id
*p
;
673 for (p
= usb_audio_ids
; p
->match_flags
; p
++) {
674 /* FIXME: this checks only vendor:product pair in the list */
675 if ((p
->match_flags
& USB_DEVICE_ID_MATCH_DEVICE
) ==
676 USB_DEVICE_ID_MATCH_DEVICE
&&
677 p
->idVendor
== USB_ID_VENDOR(id
) &&
678 p
->idProduct
== USB_ID_PRODUCT(id
))
679 return (const struct snd_usb_audio_quirk
*)p
->driver_info
;
686 * probe the active usb device
688 * note that this can be called multiple times per a device, when it
689 * includes multiple audio control interfaces.
691 * thus we check the usb device pointer and creates the card instance
692 * only at the first time. the successive calls of this function will
693 * append the pcm interface to the corresponding card.
695 static int usb_audio_probe(struct usb_interface
*intf
,
696 const struct usb_device_id
*usb_id
)
698 struct usb_device
*dev
= interface_to_usbdev(intf
);
699 const struct snd_usb_audio_quirk
*quirk
=
700 (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
701 struct snd_usb_audio
*chip
;
703 struct usb_host_interface
*alts
;
707 alts
= &intf
->altsetting
[0];
708 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
709 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
710 le16_to_cpu(dev
->descriptor
.idProduct
));
711 if (get_alias_id(dev
, &id
))
712 quirk
= get_alias_quirk(dev
, id
);
713 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
716 err
= snd_usb_apply_boot_quirk(dev
, intf
, quirk
, id
);
721 * found a config. now register to ALSA
724 /* check whether it's already registered */
726 mutex_lock(®ister_mutex
);
727 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
728 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
729 if (atomic_read(&usb_chip
[i
]->shutdown
)) {
730 dev_err(&dev
->dev
, "USB device is in the shutdown state, cannot create a card instance\n");
735 atomic_inc(&chip
->active
); /* avoid autopm */
740 err
= snd_usb_apply_boot_quirk_once(dev
, intf
, quirk
, id
);
745 * now look for an empty slot and create a new card instance
747 for (i
= 0; i
< SNDRV_CARDS
; i
++)
749 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
750 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
752 err
= snd_usb_audio_create(intf
, dev
, i
, quirk
,
757 } else if (vid
[i
] != -1 || pid
[i
] != -1) {
759 "device (%04x:%04x) is disabled\n",
767 dev_err(&dev
->dev
, "no available usb audio device\n");
773 if (chip
->num_interfaces
>= MAX_CARD_INTERFACES
) {
774 dev_info(&dev
->dev
, "Too many interfaces assigned to the single USB-audio card\n");
779 dev_set_drvdata(&dev
->dev
, chip
);
782 * For devices with more than one control interface, we assume the
783 * first contains the audio controls. We might need a more specific
784 * check here in the future.
786 if (!chip
->ctrl_intf
)
787 chip
->ctrl_intf
= alts
;
789 chip
->txfr_quirk
= 0;
790 err
= 1; /* continue */
791 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
792 /* need some special handlings */
793 err
= snd_usb_create_quirk(chip
, intf
, &usb_audio_driver
, quirk
);
799 /* create normal USB audio interfaces */
800 err
= snd_usb_create_streams(chip
, ifnum
);
803 err
= snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
);
808 if (chip
->need_delayed_register
) {
810 "Found post-registration device assignment: %08x:%02x\n",
811 chip
->usb_id
, ifnum
);
812 chip
->need_delayed_register
= false; /* clear again */
815 /* we are allowed to call snd_card_register() many times, but first
816 * check to see if a device needs to skip it or do anything special
818 if (!snd_usb_registration_quirk(chip
, ifnum
) &&
819 !check_delayed_register_option(chip
, ifnum
)) {
820 err
= snd_card_register(chip
->card
);
825 if (quirk
&& quirk
->shares_media_device
) {
826 /* don't want to fail when snd_media_device_create() fails */
827 snd_media_device_create(chip
, intf
);
830 usb_chip
[chip
->index
] = chip
;
831 chip
->intf
[chip
->num_interfaces
] = intf
;
832 chip
->num_interfaces
++;
833 usb_set_intfdata(intf
, chip
);
834 atomic_dec(&chip
->active
);
835 mutex_unlock(®ister_mutex
);
840 /* chip->active is inside the chip->card object,
841 * decrement before memory is possibly returned.
843 atomic_dec(&chip
->active
);
844 if (!chip
->num_interfaces
)
845 snd_card_free(chip
->card
);
847 mutex_unlock(®ister_mutex
);
852 * we need to take care of counter, since disconnection can be called also
853 * many times as well as usb_audio_probe().
855 static void usb_audio_disconnect(struct usb_interface
*intf
)
857 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
858 struct snd_card
*card
;
861 if (chip
== (void *)-1L)
866 mutex_lock(®ister_mutex
);
867 if (atomic_inc_return(&chip
->shutdown
) == 1) {
868 struct snd_usb_stream
*as
;
869 struct snd_usb_endpoint
*ep
;
870 struct usb_mixer_interface
*mixer
;
872 /* wait until all pending tasks done;
873 * they are protected by snd_usb_lock_shutdown()
875 wait_event(chip
->shutdown_wait
,
876 !atomic_read(&chip
->usage_count
));
877 snd_card_disconnect(card
);
878 /* release the pcm resources */
879 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
880 snd_usb_stream_disconnect(as
);
882 /* release the endpoint resources */
883 list_for_each_entry(ep
, &chip
->ep_list
, list
) {
884 snd_usb_endpoint_release(ep
);
886 /* release the midi resources */
887 list_for_each(p
, &chip
->midi_list
) {
888 snd_usbmidi_disconnect(p
);
891 * Nice to check quirk && quirk->shares_media_device and
892 * then call the snd_media_device_delete(). Don't have
893 * access to the quirk here. snd_media_device_delete()
894 * accesses mixer_list
896 snd_media_device_delete(chip
);
898 /* release mixer resources */
899 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
900 snd_usb_mixer_disconnect(mixer
);
904 chip
->num_interfaces
--;
905 if (chip
->num_interfaces
<= 0) {
906 usb_chip
[chip
->index
] = NULL
;
907 mutex_unlock(®ister_mutex
);
908 snd_card_free_when_closed(card
);
910 mutex_unlock(®ister_mutex
);
914 /* lock the shutdown (disconnect) task and autoresume */
915 int snd_usb_lock_shutdown(struct snd_usb_audio
*chip
)
919 atomic_inc(&chip
->usage_count
);
920 if (atomic_read(&chip
->shutdown
)) {
924 err
= snd_usb_autoresume(chip
);
930 if (atomic_dec_and_test(&chip
->usage_count
))
931 wake_up(&chip
->shutdown_wait
);
935 /* autosuspend and unlock the shutdown */
936 void snd_usb_unlock_shutdown(struct snd_usb_audio
*chip
)
938 snd_usb_autosuspend(chip
);
939 if (atomic_dec_and_test(&chip
->usage_count
))
940 wake_up(&chip
->shutdown_wait
);
945 int snd_usb_autoresume(struct snd_usb_audio
*chip
)
949 if (atomic_read(&chip
->shutdown
))
951 if (atomic_inc_return(&chip
->active
) != 1)
954 for (i
= 0; i
< chip
->num_interfaces
; i
++) {
955 err
= usb_autopm_get_interface(chip
->intf
[i
]);
959 usb_autopm_put_interface(chip
->intf
[i
]);
960 atomic_dec(&chip
->active
);
967 void snd_usb_autosuspend(struct snd_usb_audio
*chip
)
971 if (atomic_read(&chip
->shutdown
))
973 if (!atomic_dec_and_test(&chip
->active
))
976 for (i
= 0; i
< chip
->num_interfaces
; i
++)
977 usb_autopm_put_interface(chip
->intf
[i
]);
980 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
982 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
983 struct snd_usb_stream
*as
;
984 struct usb_mixer_interface
*mixer
;
987 if (chip
== (void *)-1L)
990 if (!chip
->num_suspended_intf
++) {
991 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
992 snd_usb_pcm_suspend(as
);
993 as
->substream
[0].need_setup_ep
=
994 as
->substream
[1].need_setup_ep
= true;
996 list_for_each(p
, &chip
->midi_list
)
997 snd_usbmidi_suspend(p
);
998 list_for_each_entry(mixer
, &chip
->mixer_list
, list
)
999 snd_usb_mixer_suspend(mixer
);
1002 if (!PMSG_IS_AUTO(message
) && !chip
->system_suspend
) {
1003 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
1004 chip
->system_suspend
= chip
->num_suspended_intf
;
1010 static int __usb_audio_resume(struct usb_interface
*intf
, bool reset_resume
)
1012 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
1013 struct snd_usb_stream
*as
;
1014 struct usb_mixer_interface
*mixer
;
1015 struct list_head
*p
;
1018 if (chip
== (void *)-1L)
1021 atomic_inc(&chip
->active
); /* avoid autopm */
1022 if (chip
->num_suspended_intf
> 1)
1025 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
1026 err
= snd_usb_pcm_resume(as
);
1032 * ALSA leaves material resumption to user space
1033 * we just notify and restart the mixers
1035 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
1036 err
= snd_usb_mixer_resume(mixer
, reset_resume
);
1041 list_for_each(p
, &chip
->midi_list
) {
1042 snd_usbmidi_resume(p
);
1046 if (chip
->num_suspended_intf
== chip
->system_suspend
) {
1047 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
1048 chip
->system_suspend
= 0;
1050 chip
->num_suspended_intf
--;
1053 atomic_dec(&chip
->active
); /* allow autopm after this point */
1057 static int usb_audio_resume(struct usb_interface
*intf
)
1059 return __usb_audio_resume(intf
, false);
1062 static int usb_audio_reset_resume(struct usb_interface
*intf
)
1064 return __usb_audio_resume(intf
, true);
1067 #define usb_audio_suspend NULL
1068 #define usb_audio_resume NULL
1069 #define usb_audio_reset_resume NULL
1070 #endif /* CONFIG_PM */
1072 static const struct usb_device_id usb_audio_ids
[] = {
1073 #include "quirks-table.h"
1074 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
1075 .bInterfaceClass
= USB_CLASS_AUDIO
,
1076 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
1077 { } /* Terminating entry */
1079 MODULE_DEVICE_TABLE(usb
, usb_audio_ids
);
1082 * entry point for linux usb interface
1085 static struct usb_driver usb_audio_driver
= {
1086 .name
= "snd-usb-audio",
1087 .probe
= usb_audio_probe
,
1088 .disconnect
= usb_audio_disconnect
,
1089 .suspend
= usb_audio_suspend
,
1090 .resume
= usb_audio_resume
,
1091 .reset_resume
= usb_audio_reset_resume
,
1092 .id_table
= usb_audio_ids
,
1093 .supports_autosuspend
= 1,
1096 module_usb_driver(usb_audio_driver
);