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>
58 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
59 MODULE_DESCRIPTION("USB Audio");
60 MODULE_LICENSE("GPL");
61 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
64 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
65 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
66 static bool enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
;/* Enable this card */
67 /* Vendor/product IDs for this card */
68 static int vid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
69 static int pid
[SNDRV_CARDS
] = { [0 ... (SNDRV_CARDS
-1)] = -1 };
70 static int device_setup
[SNDRV_CARDS
]; /* device parameter for this card */
71 static bool ignore_ctl_error
;
72 static bool autoclock
= true;
73 static char *quirk_alias
[SNDRV_CARDS
];
74 static char *delayed_register
[SNDRV_CARDS
];
75 static bool implicit_fb
[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_array(implicit_fb
, bool, NULL
, 0444);
102 MODULE_PARM_DESC(implicit_fb
, "Apply generic implicit feedback sync mode.");
103 module_param_named(use_vmalloc
, snd_usb_use_vmalloc
, bool, 0444);
104 MODULE_PARM_DESC(use_vmalloc
, "Use vmalloc for PCM intermediate buffers (default: yes).");
105 module_param_named(skip_validation
, snd_usb_skip_validation
, bool, 0444);
106 MODULE_PARM_DESC(skip_validation
, "Skip unit descriptor validation (default: no).");
109 * we keep the snd_usb_audio_t instances by ourselves for merging
110 * the all interfaces on the same card as one sound device.
113 static DEFINE_MUTEX(register_mutex
);
114 static struct snd_usb_audio
*usb_chip
[SNDRV_CARDS
];
115 static struct usb_driver usb_audio_driver
;
119 * called from usb_audio_disconnect()
121 static void snd_usb_stream_disconnect(struct snd_usb_stream
*as
)
124 struct snd_usb_substream
*subs
;
126 for (idx
= 0; idx
< 2; idx
++) {
127 subs
= &as
->substream
[idx
];
128 if (!subs
->num_formats
)
130 subs
->data_endpoint
= NULL
;
131 subs
->sync_endpoint
= NULL
;
135 static int snd_usb_create_stream(struct snd_usb_audio
*chip
, int ctrlif
, int interface
)
137 struct usb_device
*dev
= chip
->dev
;
138 struct usb_host_interface
*alts
;
139 struct usb_interface_descriptor
*altsd
;
140 struct usb_interface
*iface
= usb_ifnum_to_if(dev
, interface
);
143 dev_err(&dev
->dev
, "%u:%d : does not exist\n",
148 alts
= &iface
->altsetting
[0];
149 altsd
= get_iface_desc(alts
);
152 * Android with both accessory and audio interfaces enabled gets the
153 * interface numbers wrong.
155 if ((chip
->usb_id
== USB_ID(0x18d1, 0x2d04) ||
156 chip
->usb_id
== USB_ID(0x18d1, 0x2d05)) &&
158 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
&&
159 altsd
->bInterfaceSubClass
== USB_SUBCLASS_VENDOR_SPEC
) {
161 iface
= usb_ifnum_to_if(dev
, interface
);
164 alts
= &iface
->altsetting
[0];
165 altsd
= get_iface_desc(alts
);
168 if (usb_interface_claimed(iface
)) {
169 dev_dbg(&dev
->dev
, "%d:%d: skipping, already claimed\n",
174 if ((altsd
->bInterfaceClass
== USB_CLASS_AUDIO
||
175 altsd
->bInterfaceClass
== USB_CLASS_VENDOR_SPEC
) &&
176 altsd
->bInterfaceSubClass
== USB_SUBCLASS_MIDISTREAMING
) {
177 int err
= __snd_usbmidi_create(chip
->card
, iface
,
178 &chip
->midi_list
, NULL
,
182 "%u:%d: cannot create sequencer device\n",
186 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
191 if ((altsd
->bInterfaceClass
!= USB_CLASS_AUDIO
&&
192 altsd
->bInterfaceClass
!= USB_CLASS_VENDOR_SPEC
) ||
193 altsd
->bInterfaceSubClass
!= USB_SUBCLASS_AUDIOSTREAMING
) {
195 "%u:%d: skipping non-supported interface %d\n",
196 ctrlif
, interface
, altsd
->bInterfaceClass
);
197 /* skip non-supported classes */
201 if (snd_usb_get_speed(dev
) == USB_SPEED_LOW
) {
202 dev_err(&dev
->dev
, "low speed audio streaming not supported\n");
206 if (! snd_usb_parse_audio_interface(chip
, interface
)) {
207 usb_set_interface(dev
, interface
, 0); /* reset the current interface */
208 usb_driver_claim_interface(&usb_audio_driver
, iface
, (void *)-1L);
215 * parse audio control descriptor and create pcm/midi streams
217 static int snd_usb_create_streams(struct snd_usb_audio
*chip
, int ctrlif
)
219 struct usb_device
*dev
= chip
->dev
;
220 struct usb_host_interface
*host_iface
;
221 struct usb_interface_descriptor
*altsd
;
224 /* find audiocontrol interface */
225 host_iface
= &usb_ifnum_to_if(dev
, ctrlif
)->altsetting
[0];
226 altsd
= get_iface_desc(host_iface
);
227 protocol
= altsd
->bInterfaceProtocol
;
232 "unknown interface protocol %#02x, assuming v1\n",
236 case UAC_VERSION_1
: {
237 struct uac1_ac_header_descriptor
*h1
;
240 h1
= snd_usb_find_csint_desc(host_iface
->extra
,
241 host_iface
->extralen
,
243 if (!h1
|| h1
->bLength
< sizeof(*h1
)) {
244 dev_err(&dev
->dev
, "cannot find UAC_HEADER\n");
248 rest_bytes
= (void *)(host_iface
->extra
+
249 host_iface
->extralen
) - (void *)h1
;
251 /* just to be sure -- this shouldn't hit at all */
252 if (rest_bytes
<= 0) {
253 dev_err(&dev
->dev
, "invalid control header\n");
257 if (rest_bytes
< sizeof(*h1
)) {
258 dev_err(&dev
->dev
, "too short v1 buffer descriptor\n");
262 if (!h1
->bInCollection
) {
263 dev_info(&dev
->dev
, "skipping empty audio interface (v1)\n");
267 if (rest_bytes
< h1
->bLength
) {
268 dev_err(&dev
->dev
, "invalid buffer length (v1)\n");
272 if (h1
->bLength
< sizeof(*h1
) + h1
->bInCollection
) {
273 dev_err(&dev
->dev
, "invalid UAC_HEADER (v1)\n");
277 for (i
= 0; i
< h1
->bInCollection
; i
++)
278 snd_usb_create_stream(chip
, ctrlif
, h1
->baInterfaceNr
[i
]);
284 case UAC_VERSION_3
: {
285 struct usb_interface_assoc_descriptor
*assoc
=
286 usb_ifnum_to_if(dev
, ctrlif
)->intf_assoc
;
290 * Firmware writers cannot count to three. So to find
291 * the IAD on the NuForce UDH-100, also check the next
294 struct usb_interface
*iface
=
295 usb_ifnum_to_if(dev
, ctrlif
+ 1);
298 iface
->intf_assoc
->bFunctionClass
== USB_CLASS_AUDIO
&&
299 iface
->intf_assoc
->bFunctionProtocol
== UAC_VERSION_2
)
300 assoc
= iface
->intf_assoc
;
304 dev_err(&dev
->dev
, "Audio class v2/v3 interfaces need an interface association\n");
308 if (protocol
== UAC_VERSION_3
) {
309 int badd
= assoc
->bFunctionSubClass
;
311 if (badd
!= UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0
&&
312 (badd
< UAC3_FUNCTION_SUBCLASS_GENERIC_IO
||
313 badd
> UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE
)) {
315 "Unsupported UAC3 BADD profile\n");
319 chip
->badd_profile
= badd
;
322 for (i
= 0; i
< assoc
->bInterfaceCount
; i
++) {
323 int intf
= assoc
->bFirstInterface
+ i
;
326 snd_usb_create_stream(chip
, ctrlif
, intf
);
337 * Profile name preset table
339 struct usb_audio_device_name
{
341 const char *vendor_name
;
342 const char *product_name
;
343 const char *profile_name
; /* override card->longname */
346 #define PROFILE_NAME(vid, pid, vendor, product, profile) \
347 { .id = USB_ID(vid, pid), .vendor_name = (vendor), \
348 .product_name = (product), .profile_name = (profile) }
349 #define DEVICE_NAME(vid, pid, vendor, product) \
350 PROFILE_NAME(vid, pid, vendor, product, NULL)
352 /* vendor/product and profile name presets, sorted in device id order */
353 static const struct usb_audio_device_name usb_audio_names
[] = {
354 /* HP Thunderbolt Dock Audio Headset */
355 PROFILE_NAME(0x03f0, 0x0269, "HP", "Thunderbolt Dock Audio Headset",
356 "HP-Thunderbolt-Dock-Audio-Headset"),
357 /* HP Thunderbolt Dock Audio Module */
358 PROFILE_NAME(0x03f0, 0x0567, "HP", "Thunderbolt Dock Audio Module",
359 "HP-Thunderbolt-Dock-Audio-Module"),
361 /* Two entries for Gigabyte TRX40 Aorus Master:
362 * TRX40 Aorus Master has two USB-audio devices, one for the front
363 * headphone with ESS SABRE9218 DAC chip, while another for the rest
364 * I/O (the rear panel and the front mic) with Realtek ALC1220-VB.
365 * Here we provide two distinct names for making UCM profiles easier.
367 PROFILE_NAME(0x0414, 0xa000, "Gigabyte", "Aorus Master Front Headphone",
368 "Gigabyte-Aorus-Master-Front-Headphone"),
369 PROFILE_NAME(0x0414, 0xa001, "Gigabyte", "Aorus Master Main Audio",
370 "Gigabyte-Aorus-Master-Main-Audio"),
372 /* Gigabyte TRX40 Aorus Pro WiFi */
373 PROFILE_NAME(0x0414, 0xa002,
374 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
376 /* Creative/E-Mu devices */
377 DEVICE_NAME(0x041e, 0x3010, "Creative Labs", "Sound Blaster MP3+"),
378 /* Creative/Toshiba Multimedia Center SB-0500 */
379 DEVICE_NAME(0x041e, 0x3048, "Toshiba", "SB-0500"),
381 DEVICE_NAME(0x046d, 0x0990, "Logitech, Inc.", "QuickCam Pro 9000"),
384 PROFILE_NAME(0x0b05, 0x1917,
385 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
386 /* ASUS PRIME TRX40 PRO-S */
387 PROFILE_NAME(0x0b05, 0x1918,
388 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
391 PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
393 PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
395 DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
398 * The original product_name is "USB Sound Device", however this name
399 * is also used by the CM106 based cards, so make it unique.
401 DEVICE_NAME(0x0d8c, 0x0102, NULL
, "ICUSBAUDIO7D"),
402 DEVICE_NAME(0x0d8c, 0x0103, NULL
, "Audio Advantage MicroII"),
404 /* MSI TRX40 Creator */
405 PROFILE_NAME(0x0db0, 0x0d64,
406 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
408 PROFILE_NAME(0x0db0, 0x543d,
409 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
411 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
412 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
413 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
415 /* aka. Serato Scratch Live DJ Box */
416 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
418 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
419 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
420 "Lenovo-ThinkStation-P620-Rear"),
421 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
422 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
423 "Lenovo-ThinkStation-P620-Main"),
425 /* Asrock TRX40 Creator */
426 PROFILE_NAME(0x26ce, 0x0a01,
427 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
432 static const struct usb_audio_device_name
*
433 lookup_device_name(u32 id
)
435 static const struct usb_audio_device_name
*p
;
437 for (p
= usb_audio_names
; p
->id
; p
++)
444 * free the chip instance
446 * here we have to do not much, since pcm and controls are already freed
450 static void snd_usb_audio_free(struct snd_card
*card
)
452 struct snd_usb_audio
*chip
= card
->private_data
;
454 snd_usb_endpoint_free_all(chip
);
456 mutex_destroy(&chip
->mutex
);
457 if (!atomic_read(&chip
->shutdown
))
458 dev_set_drvdata(&chip
->dev
->dev
, NULL
);
461 static void usb_audio_make_shortname(struct usb_device
*dev
,
462 struct snd_usb_audio
*chip
,
463 const struct snd_usb_audio_quirk
*quirk
)
465 struct snd_card
*card
= chip
->card
;
466 const struct usb_audio_device_name
*preset
;
467 const char *s
= NULL
;
469 preset
= lookup_device_name(chip
->usb_id
);
470 if (preset
&& preset
->product_name
)
471 s
= preset
->product_name
;
472 else if (quirk
&& quirk
->product_name
)
473 s
= quirk
->product_name
;
475 strscpy(card
->shortname
, s
, sizeof(card
->shortname
));
479 /* retrieve the device string as shortname */
480 if (!dev
->descriptor
.iProduct
||
481 usb_string(dev
, dev
->descriptor
.iProduct
,
482 card
->shortname
, sizeof(card
->shortname
)) <= 0) {
483 /* no name available from anywhere, so use ID */
484 sprintf(card
->shortname
, "USB Device %#04x:%#04x",
485 USB_ID_VENDOR(chip
->usb_id
),
486 USB_ID_PRODUCT(chip
->usb_id
));
489 strim(card
->shortname
);
492 static void usb_audio_make_longname(struct usb_device
*dev
,
493 struct snd_usb_audio
*chip
,
494 const struct snd_usb_audio_quirk
*quirk
)
496 struct snd_card
*card
= chip
->card
;
497 const struct usb_audio_device_name
*preset
;
498 const char *s
= NULL
;
501 preset
= lookup_device_name(chip
->usb_id
);
503 /* shortcut - if any pre-defined string is given, use it */
504 if (preset
&& preset
->profile_name
)
505 s
= preset
->profile_name
;
507 strscpy(card
->longname
, s
, sizeof(card
->longname
));
511 if (preset
&& preset
->vendor_name
)
512 s
= preset
->vendor_name
;
513 else if (quirk
&& quirk
->vendor_name
)
514 s
= quirk
->vendor_name
;
517 strscpy(card
->longname
, s
, sizeof(card
->longname
));
519 /* retrieve the vendor and device strings as longname */
520 if (dev
->descriptor
.iManufacturer
)
521 usb_string(dev
, dev
->descriptor
.iManufacturer
,
522 card
->longname
, sizeof(card
->longname
));
523 /* we don't really care if there isn't any vendor string */
525 if (*card
->longname
) {
526 strim(card
->longname
);
528 strlcat(card
->longname
, " ", sizeof(card
->longname
));
531 strlcat(card
->longname
, card
->shortname
, sizeof(card
->longname
));
533 len
= strlcat(card
->longname
, " at ", sizeof(card
->longname
));
535 if (len
< sizeof(card
->longname
))
536 usb_make_path(dev
, card
->longname
+ len
, sizeof(card
->longname
) - len
);
538 switch (snd_usb_get_speed(dev
)) {
540 strlcat(card
->longname
, ", low speed", sizeof(card
->longname
));
543 strlcat(card
->longname
, ", full speed", sizeof(card
->longname
));
546 strlcat(card
->longname
, ", high speed", sizeof(card
->longname
));
548 case USB_SPEED_SUPER
:
549 strlcat(card
->longname
, ", super speed", sizeof(card
->longname
));
551 case USB_SPEED_SUPER_PLUS
:
552 strlcat(card
->longname
, ", super speed plus", sizeof(card
->longname
));
560 * create a chip instance and set its names.
562 static int snd_usb_audio_create(struct usb_interface
*intf
,
563 struct usb_device
*dev
, int idx
,
564 const struct snd_usb_audio_quirk
*quirk
,
566 struct snd_usb_audio
**rchip
)
568 struct snd_card
*card
;
569 struct snd_usb_audio
*chip
;
575 switch (snd_usb_get_speed(dev
)) {
579 case USB_SPEED_WIRELESS
:
580 case USB_SPEED_SUPER
:
581 case USB_SPEED_SUPER_PLUS
:
584 dev_err(&dev
->dev
, "unknown device speed %d\n", snd_usb_get_speed(dev
));
588 err
= snd_card_new(&intf
->dev
, index
[idx
], id
[idx
], THIS_MODULE
,
589 sizeof(*chip
), &card
);
591 dev_err(&dev
->dev
, "cannot create card instance %d\n", idx
);
595 chip
= card
->private_data
;
596 mutex_init(&chip
->mutex
);
597 init_waitqueue_head(&chip
->shutdown_wait
);
601 chip
->setup
= device_setup
[idx
];
602 chip
->generic_implicit_fb
= implicit_fb
[idx
];
603 chip
->autoclock
= autoclock
;
604 atomic_set(&chip
->active
, 1); /* avoid autopm during probing */
605 atomic_set(&chip
->usage_count
, 0);
606 atomic_set(&chip
->shutdown
, 0);
608 chip
->usb_id
= usb_id
;
609 INIT_LIST_HEAD(&chip
->pcm_list
);
610 INIT_LIST_HEAD(&chip
->ep_list
);
611 INIT_LIST_HEAD(&chip
->iface_ref_list
);
612 INIT_LIST_HEAD(&chip
->midi_list
);
613 INIT_LIST_HEAD(&chip
->mixer_list
);
615 card
->private_free
= snd_usb_audio_free
;
617 strcpy(card
->driver
, "USB-Audio");
618 sprintf(component
, "USB%04x:%04x",
619 USB_ID_VENDOR(chip
->usb_id
), USB_ID_PRODUCT(chip
->usb_id
));
620 snd_component_add(card
, component
);
622 usb_audio_make_shortname(dev
, chip
, quirk
);
623 usb_audio_make_longname(dev
, chip
, quirk
);
625 snd_usb_audio_create_proc(chip
);
631 /* look for a matching quirk alias id */
632 static bool get_alias_id(struct usb_device
*dev
, unsigned int *id
)
635 unsigned int src
, dst
;
637 for (i
= 0; i
< ARRAY_SIZE(quirk_alias
); i
++) {
638 if (!quirk_alias
[i
] ||
639 sscanf(quirk_alias
[i
], "%x:%x", &src
, &dst
) != 2 ||
643 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
644 USB_ID_VENDOR(*id
), USB_ID_PRODUCT(*id
),
645 USB_ID_VENDOR(dst
), USB_ID_PRODUCT(dst
));
653 static bool check_delayed_register_option(struct snd_usb_audio
*chip
, int iface
)
656 unsigned int id
, inum
;
658 for (i
= 0; i
< ARRAY_SIZE(delayed_register
); i
++) {
659 if (delayed_register
[i
] &&
660 sscanf(delayed_register
[i
], "%x:%x", &id
, &inum
) == 2 &&
662 return inum
!= iface
;
668 static const struct usb_device_id usb_audio_ids
[]; /* defined below */
670 /* look for the corresponding quirk */
671 static const struct snd_usb_audio_quirk
*
672 get_alias_quirk(struct usb_device
*dev
, unsigned int id
)
674 const struct usb_device_id
*p
;
676 for (p
= usb_audio_ids
; p
->match_flags
; p
++) {
677 /* FIXME: this checks only vendor:product pair in the list */
678 if ((p
->match_flags
& USB_DEVICE_ID_MATCH_DEVICE
) ==
679 USB_DEVICE_ID_MATCH_DEVICE
&&
680 p
->idVendor
== USB_ID_VENDOR(id
) &&
681 p
->idProduct
== USB_ID_PRODUCT(id
))
682 return (const struct snd_usb_audio_quirk
*)p
->driver_info
;
689 * probe the active usb device
691 * note that this can be called multiple times per a device, when it
692 * includes multiple audio control interfaces.
694 * thus we check the usb device pointer and creates the card instance
695 * only at the first time. the successive calls of this function will
696 * append the pcm interface to the corresponding card.
698 static int usb_audio_probe(struct usb_interface
*intf
,
699 const struct usb_device_id
*usb_id
)
701 struct usb_device
*dev
= interface_to_usbdev(intf
);
702 const struct snd_usb_audio_quirk
*quirk
=
703 (const struct snd_usb_audio_quirk
*)usb_id
->driver_info
;
704 struct snd_usb_audio
*chip
;
706 struct usb_host_interface
*alts
;
710 alts
= &intf
->altsetting
[0];
711 ifnum
= get_iface_desc(alts
)->bInterfaceNumber
;
712 id
= USB_ID(le16_to_cpu(dev
->descriptor
.idVendor
),
713 le16_to_cpu(dev
->descriptor
.idProduct
));
714 if (get_alias_id(dev
, &id
))
715 quirk
= get_alias_quirk(dev
, id
);
716 if (quirk
&& quirk
->ifnum
>= 0 && ifnum
!= quirk
->ifnum
)
719 err
= snd_usb_apply_boot_quirk(dev
, intf
, quirk
, id
);
724 * found a config. now register to ALSA
727 /* check whether it's already registered */
729 mutex_lock(®ister_mutex
);
730 for (i
= 0; i
< SNDRV_CARDS
; i
++) {
731 if (usb_chip
[i
] && usb_chip
[i
]->dev
== dev
) {
732 if (atomic_read(&usb_chip
[i
]->shutdown
)) {
733 dev_err(&dev
->dev
, "USB device is in the shutdown state, cannot create a card instance\n");
738 atomic_inc(&chip
->active
); /* avoid autopm */
743 err
= snd_usb_apply_boot_quirk_once(dev
, intf
, quirk
, id
);
748 * now look for an empty slot and create a new card instance
750 for (i
= 0; i
< SNDRV_CARDS
; i
++)
752 (vid
[i
] == -1 || vid
[i
] == USB_ID_VENDOR(id
)) &&
753 (pid
[i
] == -1 || pid
[i
] == USB_ID_PRODUCT(id
))) {
755 err
= snd_usb_audio_create(intf
, dev
, i
, quirk
,
760 } else if (vid
[i
] != -1 || pid
[i
] != -1) {
762 "device (%04x:%04x) is disabled\n",
770 dev_err(&dev
->dev
, "no available usb audio device\n");
776 if (chip
->num_interfaces
>= MAX_CARD_INTERFACES
) {
777 dev_info(&dev
->dev
, "Too many interfaces assigned to the single USB-audio card\n");
782 dev_set_drvdata(&dev
->dev
, chip
);
785 * For devices with more than one control interface, we assume the
786 * first contains the audio controls. We might need a more specific
787 * check here in the future.
789 if (!chip
->ctrl_intf
)
790 chip
->ctrl_intf
= alts
;
792 chip
->txfr_quirk
= 0;
793 err
= 1; /* continue */
794 if (quirk
&& quirk
->ifnum
!= QUIRK_NO_INTERFACE
) {
795 /* need some special handlings */
796 err
= snd_usb_create_quirk(chip
, intf
, &usb_audio_driver
, quirk
);
802 /* create normal USB audio interfaces */
803 err
= snd_usb_create_streams(chip
, ifnum
);
806 err
= snd_usb_create_mixer(chip
, ifnum
, ignore_ctl_error
);
811 if (chip
->need_delayed_register
) {
813 "Found post-registration device assignment: %08x:%02x\n",
814 chip
->usb_id
, ifnum
);
815 chip
->need_delayed_register
= false; /* clear again */
818 /* we are allowed to call snd_card_register() many times, but first
819 * check to see if a device needs to skip it or do anything special
821 if (!snd_usb_registration_quirk(chip
, ifnum
) &&
822 !check_delayed_register_option(chip
, ifnum
)) {
823 err
= snd_card_register(chip
->card
);
828 if (quirk
&& quirk
->shares_media_device
) {
829 /* don't want to fail when snd_media_device_create() fails */
830 snd_media_device_create(chip
, intf
);
834 chip
->quirk_type
= quirk
->type
;
836 usb_chip
[chip
->index
] = chip
;
837 chip
->intf
[chip
->num_interfaces
] = intf
;
838 chip
->num_interfaces
++;
839 usb_set_intfdata(intf
, chip
);
840 atomic_dec(&chip
->active
);
841 mutex_unlock(®ister_mutex
);
846 /* chip->active is inside the chip->card object,
847 * decrement before memory is possibly returned.
849 atomic_dec(&chip
->active
);
850 if (!chip
->num_interfaces
)
851 snd_card_free(chip
->card
);
853 mutex_unlock(®ister_mutex
);
858 * we need to take care of counter, since disconnection can be called also
859 * many times as well as usb_audio_probe().
861 static void usb_audio_disconnect(struct usb_interface
*intf
)
863 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
864 struct snd_card
*card
;
867 if (chip
== (void *)-1L)
872 mutex_lock(®ister_mutex
);
873 if (atomic_inc_return(&chip
->shutdown
) == 1) {
874 struct snd_usb_stream
*as
;
875 struct snd_usb_endpoint
*ep
;
876 struct usb_mixer_interface
*mixer
;
878 /* wait until all pending tasks done;
879 * they are protected by snd_usb_lock_shutdown()
881 wait_event(chip
->shutdown_wait
,
882 !atomic_read(&chip
->usage_count
));
883 snd_card_disconnect(card
);
884 /* release the pcm resources */
885 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
886 snd_usb_stream_disconnect(as
);
888 /* release the endpoint resources */
889 list_for_each_entry(ep
, &chip
->ep_list
, list
) {
890 snd_usb_endpoint_release(ep
);
892 /* release the midi resources */
893 list_for_each(p
, &chip
->midi_list
) {
894 snd_usbmidi_disconnect(p
);
897 * Nice to check quirk && quirk->shares_media_device and
898 * then call the snd_media_device_delete(). Don't have
899 * access to the quirk here. snd_media_device_delete()
900 * accesses mixer_list
902 snd_media_device_delete(chip
);
904 /* release mixer resources */
905 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
906 snd_usb_mixer_disconnect(mixer
);
910 if (chip
->quirk_type
& QUIRK_SETUP_DISABLE_AUTOSUSPEND
)
911 usb_enable_autosuspend(interface_to_usbdev(intf
));
913 chip
->num_interfaces
--;
914 if (chip
->num_interfaces
<= 0) {
915 usb_chip
[chip
->index
] = NULL
;
916 mutex_unlock(®ister_mutex
);
917 snd_card_free_when_closed(card
);
919 mutex_unlock(®ister_mutex
);
923 /* lock the shutdown (disconnect) task and autoresume */
924 int snd_usb_lock_shutdown(struct snd_usb_audio
*chip
)
928 atomic_inc(&chip
->usage_count
);
929 if (atomic_read(&chip
->shutdown
)) {
933 err
= snd_usb_autoresume(chip
);
939 if (atomic_dec_and_test(&chip
->usage_count
))
940 wake_up(&chip
->shutdown_wait
);
944 /* autosuspend and unlock the shutdown */
945 void snd_usb_unlock_shutdown(struct snd_usb_audio
*chip
)
947 snd_usb_autosuspend(chip
);
948 if (atomic_dec_and_test(&chip
->usage_count
))
949 wake_up(&chip
->shutdown_wait
);
954 int snd_usb_autoresume(struct snd_usb_audio
*chip
)
958 if (atomic_read(&chip
->shutdown
))
960 if (atomic_inc_return(&chip
->active
) != 1)
963 for (i
= 0; i
< chip
->num_interfaces
; i
++) {
964 err
= usb_autopm_get_interface(chip
->intf
[i
]);
968 usb_autopm_put_interface(chip
->intf
[i
]);
969 atomic_dec(&chip
->active
);
976 void snd_usb_autosuspend(struct snd_usb_audio
*chip
)
980 if (atomic_read(&chip
->shutdown
))
982 if (!atomic_dec_and_test(&chip
->active
))
985 for (i
= 0; i
< chip
->num_interfaces
; i
++)
986 usb_autopm_put_interface(chip
->intf
[i
]);
989 static int usb_audio_suspend(struct usb_interface
*intf
, pm_message_t message
)
991 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
992 struct snd_usb_stream
*as
;
993 struct snd_usb_endpoint
*ep
;
994 struct usb_mixer_interface
*mixer
;
997 if (chip
== (void *)-1L)
1000 if (!chip
->num_suspended_intf
++) {
1001 list_for_each_entry(as
, &chip
->pcm_list
, list
)
1002 snd_usb_pcm_suspend(as
);
1003 list_for_each_entry(ep
, &chip
->ep_list
, list
)
1004 snd_usb_endpoint_suspend(ep
);
1005 list_for_each(p
, &chip
->midi_list
)
1006 snd_usbmidi_suspend(p
);
1007 list_for_each_entry(mixer
, &chip
->mixer_list
, list
)
1008 snd_usb_mixer_suspend(mixer
);
1011 if (!PMSG_IS_AUTO(message
) && !chip
->system_suspend
) {
1012 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D3hot
);
1013 chip
->system_suspend
= chip
->num_suspended_intf
;
1019 static int __usb_audio_resume(struct usb_interface
*intf
, bool reset_resume
)
1021 struct snd_usb_audio
*chip
= usb_get_intfdata(intf
);
1022 struct snd_usb_stream
*as
;
1023 struct usb_mixer_interface
*mixer
;
1024 struct list_head
*p
;
1027 if (chip
== (void *)-1L)
1030 atomic_inc(&chip
->active
); /* avoid autopm */
1031 if (chip
->num_suspended_intf
> 1)
1034 list_for_each_entry(as
, &chip
->pcm_list
, list
) {
1035 err
= snd_usb_pcm_resume(as
);
1041 * ALSA leaves material resumption to user space
1042 * we just notify and restart the mixers
1044 list_for_each_entry(mixer
, &chip
->mixer_list
, list
) {
1045 err
= snd_usb_mixer_resume(mixer
, reset_resume
);
1050 list_for_each(p
, &chip
->midi_list
) {
1051 snd_usbmidi_resume(p
);
1055 if (chip
->num_suspended_intf
== chip
->system_suspend
) {
1056 snd_power_change_state(chip
->card
, SNDRV_CTL_POWER_D0
);
1057 chip
->system_suspend
= 0;
1059 chip
->num_suspended_intf
--;
1062 atomic_dec(&chip
->active
); /* allow autopm after this point */
1066 static int usb_audio_resume(struct usb_interface
*intf
)
1068 return __usb_audio_resume(intf
, false);
1071 static int usb_audio_reset_resume(struct usb_interface
*intf
)
1073 return __usb_audio_resume(intf
, true);
1076 #define usb_audio_suspend NULL
1077 #define usb_audio_resume NULL
1078 #define usb_audio_reset_resume NULL
1079 #endif /* CONFIG_PM */
1081 static const struct usb_device_id usb_audio_ids
[] = {
1082 #include "quirks-table.h"
1083 { .match_flags
= (USB_DEVICE_ID_MATCH_INT_CLASS
| USB_DEVICE_ID_MATCH_INT_SUBCLASS
),
1084 .bInterfaceClass
= USB_CLASS_AUDIO
,
1085 .bInterfaceSubClass
= USB_SUBCLASS_AUDIOCONTROL
},
1086 { } /* Terminating entry */
1088 MODULE_DEVICE_TABLE(usb
, usb_audio_ids
);
1091 * entry point for linux usb interface
1094 static struct usb_driver usb_audio_driver
= {
1095 .name
= "snd-usb-audio",
1096 .probe
= usb_audio_probe
,
1097 .disconnect
= usb_audio_disconnect
,
1098 .suspend
= usb_audio_suspend
,
1099 .resume
= usb_audio_resume
,
1100 .reset_resume
= usb_audio_reset_resume
,
1101 .id_table
= usb_audio_ids
,
1102 .supports_autosuspend
= 1,
1105 module_usb_driver(usb_audio_driver
);