Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * (Tentative) USB Audio Driver for ALSA
4 *
5 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
6 *
7 * Many codes borrowed from audio.c by
8 * Alan Cox (alan@lxorguk.ukuu.org.uk)
9 * Thomas Sailer (sailer@ife.ee.ethz.ch)
10 *
11 * Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com>
12 *
13 * NOTES:
14 *
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).
20 */
21
22
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>
36
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>
43
44#include "usbaudio.h"
45#include "card.h"
46#include "midi.h"
47#include "mixer.h"
48#include "proc.h"
49#include "quirks.h"
50#include "endpoint.h"
51#include "helper.h"
52#include "pcm.h"
53#include "format.h"
54#include "power.h"
55#include "stream.h"
56#include "media.h"
57
58MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
59MODULE_DESCRIPTION("USB Audio");
60MODULE_LICENSE("GPL");
61
62static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
63static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
64static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
65/* Vendor/product IDs for this card */
66static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
67static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
68static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
69static bool ignore_ctl_error;
70static bool autoclock = true;
71static bool lowlatency = true;
72static char *quirk_alias[SNDRV_CARDS];
73static char *delayed_register[SNDRV_CARDS];
74static bool implicit_fb[SNDRV_CARDS];
75static unsigned int quirk_flags[SNDRV_CARDS];
76
77bool snd_usb_use_vmalloc = true;
78bool snd_usb_skip_validation;
79
80module_param_array(index, int, NULL, 0444);
81MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
82module_param_array(id, charp, NULL, 0444);
83MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
84module_param_array(enable, bool, NULL, 0444);
85MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
86module_param_array(vid, int, NULL, 0444);
87MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
88module_param_array(pid, int, NULL, 0444);
89MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
90module_param_array(device_setup, int, NULL, 0444);
91MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
92module_param(ignore_ctl_error, bool, 0444);
93MODULE_PARM_DESC(ignore_ctl_error,
94 "Ignore errors from USB controller for mixer interfaces.");
95module_param(autoclock, bool, 0444);
96MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
97module_param(lowlatency, bool, 0444);
98MODULE_PARM_DESC(lowlatency, "Enable low latency playback (default: yes).");
99module_param_array(quirk_alias, charp, NULL, 0444);
100MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");
101module_param_array(delayed_register, charp, NULL, 0444);
102MODULE_PARM_DESC(delayed_register, "Quirk for delayed registration, given by id:iface, e.g. 0123abcd:4.");
103module_param_array(implicit_fb, bool, NULL, 0444);
104MODULE_PARM_DESC(implicit_fb, "Apply generic implicit feedback sync mode.");
105module_param_array(quirk_flags, uint, NULL, 0444);
106MODULE_PARM_DESC(quirk_flags, "Driver quirk bit flags.");
107module_param_named(use_vmalloc, snd_usb_use_vmalloc, bool, 0444);
108MODULE_PARM_DESC(use_vmalloc, "Use vmalloc for PCM intermediate buffers (default: yes).");
109module_param_named(skip_validation, snd_usb_skip_validation, bool, 0444);
110MODULE_PARM_DESC(skip_validation, "Skip unit descriptor validation (default: no).");
111
112/*
113 * we keep the snd_usb_audio_t instances by ourselves for merging
114 * the all interfaces on the same card as one sound device.
115 */
116
117static DEFINE_MUTEX(register_mutex);
118static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
119static struct usb_driver usb_audio_driver;
120
121/*
122 * disconnect streams
123 * called from usb_audio_disconnect()
124 */
125static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
126{
127 int idx;
128 struct snd_usb_substream *subs;
129
130 for (idx = 0; idx < 2; idx++) {
131 subs = &as->substream[idx];
132 if (!subs->num_formats)
133 continue;
134 subs->data_endpoint = NULL;
135 subs->sync_endpoint = NULL;
136 }
137}
138
139static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
140{
141 struct usb_device *dev = chip->dev;
142 struct usb_host_interface *alts;
143 struct usb_interface_descriptor *altsd;
144 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
145
146 if (!iface) {
147 dev_err(&dev->dev, "%u:%d : does not exist\n",
148 ctrlif, interface);
149 return -EINVAL;
150 }
151
152 alts = &iface->altsetting[0];
153 altsd = get_iface_desc(alts);
154
155 /*
156 * Android with both accessory and audio interfaces enabled gets the
157 * interface numbers wrong.
158 */
159 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
160 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
161 interface == 0 &&
162 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
163 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
164 interface = 2;
165 iface = usb_ifnum_to_if(dev, interface);
166 if (!iface)
167 return -EINVAL;
168 alts = &iface->altsetting[0];
169 altsd = get_iface_desc(alts);
170 }
171
172 if (usb_interface_claimed(iface)) {
173 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
174 ctrlif, interface);
175 return -EINVAL;
176 }
177
178 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
179 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
180 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
181 int err = __snd_usbmidi_create(chip->card, iface,
182 &chip->midi_list, NULL,
183 chip->usb_id);
184 if (err < 0) {
185 dev_err(&dev->dev,
186 "%u:%d: cannot create sequencer device\n",
187 ctrlif, interface);
188 return -EINVAL;
189 }
190 return usb_driver_claim_interface(&usb_audio_driver, iface,
191 USB_AUDIO_IFACE_UNUSED);
192 }
193
194 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
195 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
196 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
197 dev_dbg(&dev->dev,
198 "%u:%d: skipping non-supported interface %d\n",
199 ctrlif, interface, altsd->bInterfaceClass);
200 /* skip non-supported classes */
201 return -EINVAL;
202 }
203
204 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
205 dev_err(&dev->dev, "low speed audio streaming not supported\n");
206 return -EINVAL;
207 }
208
209 if (! snd_usb_parse_audio_interface(chip, interface)) {
210 usb_set_interface(dev, interface, 0); /* reset the current interface */
211 return usb_driver_claim_interface(&usb_audio_driver, iface,
212 USB_AUDIO_IFACE_UNUSED);
213 }
214
215 return 0;
216}
217
218/*
219 * parse audio control descriptor and create pcm/midi streams
220 */
221static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
222{
223 struct usb_device *dev = chip->dev;
224 struct usb_host_interface *host_iface;
225 struct usb_interface_descriptor *altsd;
226 int i, protocol;
227
228 /* find audiocontrol interface */
229 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
230 altsd = get_iface_desc(host_iface);
231 protocol = altsd->bInterfaceProtocol;
232
233 switch (protocol) {
234 default:
235 dev_warn(&dev->dev,
236 "unknown interface protocol %#02x, assuming v1\n",
237 protocol);
238 fallthrough;
239
240 case UAC_VERSION_1: {
241 struct uac1_ac_header_descriptor *h1;
242 int rest_bytes;
243
244 h1 = snd_usb_find_csint_desc(host_iface->extra,
245 host_iface->extralen,
246 NULL, UAC_HEADER);
247 if (!h1 || h1->bLength < sizeof(*h1)) {
248 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
249 return -EINVAL;
250 }
251
252 rest_bytes = (void *)(host_iface->extra +
253 host_iface->extralen) - (void *)h1;
254
255 /* just to be sure -- this shouldn't hit at all */
256 if (rest_bytes <= 0) {
257 dev_err(&dev->dev, "invalid control header\n");
258 return -EINVAL;
259 }
260
261 if (rest_bytes < sizeof(*h1)) {
262 dev_err(&dev->dev, "too short v1 buffer descriptor\n");
263 return -EINVAL;
264 }
265
266 if (!h1->bInCollection) {
267 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
268 return -EINVAL;
269 }
270
271 if (rest_bytes < h1->bLength) {
272 dev_err(&dev->dev, "invalid buffer length (v1)\n");
273 return -EINVAL;
274 }
275
276 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
277 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
278 return -EINVAL;
279 }
280
281 for (i = 0; i < h1->bInCollection; i++)
282 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
283
284 break;
285 }
286
287 case UAC_VERSION_2:
288 case UAC_VERSION_3: {
289 struct usb_interface_assoc_descriptor *assoc =
290 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
291
292 if (!assoc) {
293 /*
294 * Firmware writers cannot count to three. So to find
295 * the IAD on the NuForce UDH-100, also check the next
296 * interface.
297 */
298 struct usb_interface *iface =
299 usb_ifnum_to_if(dev, ctrlif + 1);
300 if (iface &&
301 iface->intf_assoc &&
302 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
303 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
304 assoc = iface->intf_assoc;
305 }
306
307 if (!assoc) {
308 dev_err(&dev->dev, "Audio class v2/v3 interfaces need an interface association\n");
309 return -EINVAL;
310 }
311
312 if (protocol == UAC_VERSION_3) {
313 int badd = assoc->bFunctionSubClass;
314
315 if (badd != UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0 &&
316 (badd < UAC3_FUNCTION_SUBCLASS_GENERIC_IO ||
317 badd > UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE)) {
318 dev_err(&dev->dev,
319 "Unsupported UAC3 BADD profile\n");
320 return -EINVAL;
321 }
322
323 chip->badd_profile = badd;
324 }
325
326 for (i = 0; i < assoc->bInterfaceCount; i++) {
327 int intf = assoc->bFirstInterface + i;
328
329 if (intf != ctrlif)
330 snd_usb_create_stream(chip, ctrlif, intf);
331 }
332
333 break;
334 }
335 }
336
337 return 0;
338}
339
340/*
341 * Profile name preset table
342 */
343struct usb_audio_device_name {
344 u32 id;
345 const char *vendor_name;
346 const char *product_name;
347 const char *profile_name; /* override card->longname */
348};
349
350#define PROFILE_NAME(vid, pid, vendor, product, profile) \
351 { .id = USB_ID(vid, pid), .vendor_name = (vendor), \
352 .product_name = (product), .profile_name = (profile) }
353#define DEVICE_NAME(vid, pid, vendor, product) \
354 PROFILE_NAME(vid, pid, vendor, product, NULL)
355
356/* vendor/product and profile name presets, sorted in device id order */
357static const struct usb_audio_device_name usb_audio_names[] = {
358 /* HP Thunderbolt Dock Audio Headset */
359 PROFILE_NAME(0x03f0, 0x0269, "HP", "Thunderbolt Dock Audio Headset",
360 "HP-Thunderbolt-Dock-Audio-Headset"),
361 /* HP Thunderbolt Dock Audio Module */
362 PROFILE_NAME(0x03f0, 0x0567, "HP", "Thunderbolt Dock Audio Module",
363 "HP-Thunderbolt-Dock-Audio-Module"),
364
365 /* Two entries for Gigabyte TRX40 Aorus Master:
366 * TRX40 Aorus Master has two USB-audio devices, one for the front
367 * headphone with ESS SABRE9218 DAC chip, while another for the rest
368 * I/O (the rear panel and the front mic) with Realtek ALC1220-VB.
369 * Here we provide two distinct names for making UCM profiles easier.
370 */
371 PROFILE_NAME(0x0414, 0xa000, "Gigabyte", "Aorus Master Front Headphone",
372 "Gigabyte-Aorus-Master-Front-Headphone"),
373 PROFILE_NAME(0x0414, 0xa001, "Gigabyte", "Aorus Master Main Audio",
374 "Gigabyte-Aorus-Master-Main-Audio"),
375
376 /* Gigabyte TRX40 Aorus Pro WiFi */
377 PROFILE_NAME(0x0414, 0xa002,
378 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
379
380 /* Creative/E-Mu devices */
381 DEVICE_NAME(0x041e, 0x3010, "Creative Labs", "Sound Blaster MP3+"),
382 /* Creative/Toshiba Multimedia Center SB-0500 */
383 DEVICE_NAME(0x041e, 0x3048, "Toshiba", "SB-0500"),
384
385 DEVICE_NAME(0x046d, 0x0990, "Logitech, Inc.", "QuickCam Pro 9000"),
386
387 DEVICE_NAME(0x05e1, 0x0408, "Syntek", "STK1160"),
388 DEVICE_NAME(0x05e1, 0x0480, "Hauppauge", "Woodbury"),
389
390 /* ASUS ROG Zenith II: this machine has also two devices, one for
391 * the front headphone and another for the rest
392 */
393 PROFILE_NAME(0x0b05, 0x1915, "ASUS", "Zenith II Front Headphone",
394 "Zenith-II-Front-Headphone"),
395 PROFILE_NAME(0x0b05, 0x1916, "ASUS", "Zenith II Main Audio",
396 "Zenith-II-Main-Audio"),
397
398 /* ASUS ROG Strix */
399 PROFILE_NAME(0x0b05, 0x1917,
400 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
401 /* ASUS PRIME TRX40 PRO-S */
402 PROFILE_NAME(0x0b05, 0x1918,
403 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
404
405 /* Dell WD15 Dock */
406 PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
407 /* Dell WD19 Dock */
408 PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
409
410 DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
411
412 /*
413 * The original product_name is "USB Sound Device", however this name
414 * is also used by the CM106 based cards, so make it unique.
415 */
416 DEVICE_NAME(0x0d8c, 0x0102, NULL, "ICUSBAUDIO7D"),
417 DEVICE_NAME(0x0d8c, 0x0103, NULL, "Audio Advantage MicroII"),
418
419 /* MSI TRX40 Creator */
420 PROFILE_NAME(0x0db0, 0x0d64,
421 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
422 /* MSI TRX40 */
423 PROFILE_NAME(0x0db0, 0x543d,
424 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
425
426 DEVICE_NAME(0x0fd9, 0x0008, "Hauppauge", "HVR-950Q"),
427
428 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
429 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
430 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
431
432 /* aka. Serato Scratch Live DJ Box */
433 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
434
435 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
436 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
437 "Lenovo-ThinkStation-P620-Rear"),
438 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
439 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
440 "Lenovo-ThinkStation-P620-Main"),
441
442 /* Asrock TRX40 Creator */
443 PROFILE_NAME(0x26ce, 0x0a01,
444 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
445
446 DEVICE_NAME(0x2040, 0x7200, "Hauppauge", "HVR-950Q"),
447 DEVICE_NAME(0x2040, 0x7201, "Hauppauge", "HVR-950Q-MXL"),
448 DEVICE_NAME(0x2040, 0x7210, "Hauppauge", "HVR-950Q"),
449 DEVICE_NAME(0x2040, 0x7211, "Hauppauge", "HVR-950Q-MXL"),
450 DEVICE_NAME(0x2040, 0x7213, "Hauppauge", "HVR-950Q"),
451 DEVICE_NAME(0x2040, 0x7217, "Hauppauge", "HVR-950Q"),
452 DEVICE_NAME(0x2040, 0x721b, "Hauppauge", "HVR-950Q"),
453 DEVICE_NAME(0x2040, 0x721e, "Hauppauge", "HVR-950Q"),
454 DEVICE_NAME(0x2040, 0x721f, "Hauppauge", "HVR-950Q"),
455 DEVICE_NAME(0x2040, 0x7240, "Hauppauge", "HVR-850"),
456 DEVICE_NAME(0x2040, 0x7260, "Hauppauge", "HVR-950Q"),
457 DEVICE_NAME(0x2040, 0x7270, "Hauppauge", "HVR-950Q"),
458 DEVICE_NAME(0x2040, 0x7280, "Hauppauge", "HVR-950Q"),
459 DEVICE_NAME(0x2040, 0x7281, "Hauppauge", "HVR-950Q-MXL"),
460 DEVICE_NAME(0x2040, 0x8200, "Hauppauge", "Woodbury"),
461
462 { } /* terminator */
463};
464
465static const struct usb_audio_device_name *
466lookup_device_name(u32 id)
467{
468 static const struct usb_audio_device_name *p;
469
470 for (p = usb_audio_names; p->id; p++)
471 if (p->id == id)
472 return p;
473 return NULL;
474}
475
476/*
477 * free the chip instance
478 *
479 * here we have to do not much, since pcm and controls are already freed
480 *
481 */
482
483static void snd_usb_audio_free(struct snd_card *card)
484{
485 struct snd_usb_audio *chip = card->private_data;
486
487 snd_usb_endpoint_free_all(chip);
488
489 mutex_destroy(&chip->mutex);
490 if (!atomic_read(&chip->shutdown))
491 dev_set_drvdata(&chip->dev->dev, NULL);
492}
493
494static void usb_audio_make_shortname(struct usb_device *dev,
495 struct snd_usb_audio *chip,
496 const struct snd_usb_audio_quirk *quirk)
497{
498 struct snd_card *card = chip->card;
499 const struct usb_audio_device_name *preset;
500 const char *s = NULL;
501
502 preset = lookup_device_name(chip->usb_id);
503 if (preset && preset->product_name)
504 s = preset->product_name;
505 else if (quirk && quirk->product_name)
506 s = quirk->product_name;
507 if (s && *s) {
508 strscpy(card->shortname, s, sizeof(card->shortname));
509 return;
510 }
511
512 /* retrieve the device string as shortname */
513 if (!dev->descriptor.iProduct ||
514 usb_string(dev, dev->descriptor.iProduct,
515 card->shortname, sizeof(card->shortname)) <= 0) {
516 /* no name available from anywhere, so use ID */
517 sprintf(card->shortname, "USB Device %#04x:%#04x",
518 USB_ID_VENDOR(chip->usb_id),
519 USB_ID_PRODUCT(chip->usb_id));
520 }
521
522 strim(card->shortname);
523}
524
525static void usb_audio_make_longname(struct usb_device *dev,
526 struct snd_usb_audio *chip,
527 const struct snd_usb_audio_quirk *quirk)
528{
529 struct snd_card *card = chip->card;
530 const struct usb_audio_device_name *preset;
531 const char *s = NULL;
532 int len;
533
534 preset = lookup_device_name(chip->usb_id);
535
536 /* shortcut - if any pre-defined string is given, use it */
537 if (preset && preset->profile_name)
538 s = preset->profile_name;
539 if (s && *s) {
540 strscpy(card->longname, s, sizeof(card->longname));
541 return;
542 }
543
544 if (preset && preset->vendor_name)
545 s = preset->vendor_name;
546 else if (quirk && quirk->vendor_name)
547 s = quirk->vendor_name;
548 *card->longname = 0;
549 if (s && *s) {
550 strscpy(card->longname, s, sizeof(card->longname));
551 } else {
552 /* retrieve the vendor and device strings as longname */
553 if (dev->descriptor.iManufacturer)
554 usb_string(dev, dev->descriptor.iManufacturer,
555 card->longname, sizeof(card->longname));
556 /* we don't really care if there isn't any vendor string */
557 }
558 if (*card->longname) {
559 strim(card->longname);
560 if (*card->longname)
561 strlcat(card->longname, " ", sizeof(card->longname));
562 }
563
564 strlcat(card->longname, card->shortname, sizeof(card->longname));
565
566 len = strlcat(card->longname, " at ", sizeof(card->longname));
567
568 if (len < sizeof(card->longname))
569 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
570
571 switch (snd_usb_get_speed(dev)) {
572 case USB_SPEED_LOW:
573 strlcat(card->longname, ", low speed", sizeof(card->longname));
574 break;
575 case USB_SPEED_FULL:
576 strlcat(card->longname, ", full speed", sizeof(card->longname));
577 break;
578 case USB_SPEED_HIGH:
579 strlcat(card->longname, ", high speed", sizeof(card->longname));
580 break;
581 case USB_SPEED_SUPER:
582 strlcat(card->longname, ", super speed", sizeof(card->longname));
583 break;
584 case USB_SPEED_SUPER_PLUS:
585 strlcat(card->longname, ", super speed plus", sizeof(card->longname));
586 break;
587 default:
588 break;
589 }
590}
591
592/*
593 * create a chip instance and set its names.
594 */
595static int snd_usb_audio_create(struct usb_interface *intf,
596 struct usb_device *dev, int idx,
597 const struct snd_usb_audio_quirk *quirk,
598 unsigned int usb_id,
599 struct snd_usb_audio **rchip)
600{
601 struct snd_card *card;
602 struct snd_usb_audio *chip;
603 int err;
604 char component[14];
605
606 *rchip = NULL;
607
608 switch (snd_usb_get_speed(dev)) {
609 case USB_SPEED_LOW:
610 case USB_SPEED_FULL:
611 case USB_SPEED_HIGH:
612 case USB_SPEED_WIRELESS:
613 case USB_SPEED_SUPER:
614 case USB_SPEED_SUPER_PLUS:
615 break;
616 default:
617 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
618 return -ENXIO;
619 }
620
621 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
622 sizeof(*chip), &card);
623 if (err < 0) {
624 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
625 return err;
626 }
627
628 chip = card->private_data;
629 mutex_init(&chip->mutex);
630 init_waitqueue_head(&chip->shutdown_wait);
631 chip->index = idx;
632 chip->dev = dev;
633 chip->card = card;
634 chip->setup = device_setup[idx];
635 chip->generic_implicit_fb = implicit_fb[idx];
636 chip->autoclock = autoclock;
637 chip->lowlatency = lowlatency;
638 atomic_set(&chip->active, 1); /* avoid autopm during probing */
639 atomic_set(&chip->usage_count, 0);
640 atomic_set(&chip->shutdown, 0);
641
642 chip->usb_id = usb_id;
643 INIT_LIST_HEAD(&chip->pcm_list);
644 INIT_LIST_HEAD(&chip->ep_list);
645 INIT_LIST_HEAD(&chip->iface_ref_list);
646 INIT_LIST_HEAD(&chip->clock_ref_list);
647 INIT_LIST_HEAD(&chip->midi_list);
648 INIT_LIST_HEAD(&chip->mixer_list);
649
650 if (quirk_flags[idx])
651 chip->quirk_flags = quirk_flags[idx];
652 else
653 snd_usb_init_quirk_flags(chip);
654
655 card->private_free = snd_usb_audio_free;
656
657 strcpy(card->driver, "USB-Audio");
658 sprintf(component, "USB%04x:%04x",
659 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
660 snd_component_add(card, component);
661
662 usb_audio_make_shortname(dev, chip, quirk);
663 usb_audio_make_longname(dev, chip, quirk);
664
665 snd_usb_audio_create_proc(chip);
666
667 *rchip = chip;
668 return 0;
669}
670
671/* look for a matching quirk alias id */
672static bool get_alias_id(struct usb_device *dev, unsigned int *id)
673{
674 int i;
675 unsigned int src, dst;
676
677 for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
678 if (!quirk_alias[i] ||
679 sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
680 src != *id)
681 continue;
682 dev_info(&dev->dev,
683 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
684 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
685 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
686 *id = dst;
687 return true;
688 }
689
690 return false;
691}
692
693static int check_delayed_register_option(struct snd_usb_audio *chip)
694{
695 int i;
696 unsigned int id, inum;
697
698 for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {
699 if (delayed_register[i] &&
700 sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&
701 id == chip->usb_id)
702 return inum;
703 }
704
705 return -1;
706}
707
708static const struct usb_device_id usb_audio_ids[]; /* defined below */
709
710/* look for the last interface that matches with our ids and remember it */
711static void find_last_interface(struct snd_usb_audio *chip)
712{
713 struct usb_host_config *config = chip->dev->actconfig;
714 struct usb_interface *intf;
715 int i;
716
717 if (!config)
718 return;
719 for (i = 0; i < config->desc.bNumInterfaces; i++) {
720 intf = config->interface[i];
721 if (usb_match_id(intf, usb_audio_ids))
722 chip->last_iface = intf->altsetting[0].desc.bInterfaceNumber;
723 }
724 usb_audio_dbg(chip, "Found last interface = %d\n", chip->last_iface);
725}
726
727/* look for the corresponding quirk */
728static const struct snd_usb_audio_quirk *
729get_alias_quirk(struct usb_device *dev, unsigned int id)
730{
731 const struct usb_device_id *p;
732
733 for (p = usb_audio_ids; p->match_flags; p++) {
734 /* FIXME: this checks only vendor:product pair in the list */
735 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
736 USB_DEVICE_ID_MATCH_DEVICE &&
737 p->idVendor == USB_ID_VENDOR(id) &&
738 p->idProduct == USB_ID_PRODUCT(id))
739 return (const struct snd_usb_audio_quirk *)p->driver_info;
740 }
741
742 return NULL;
743}
744
745/* register card if we reach to the last interface or to the specified
746 * one given via option
747 */
748static int try_to_register_card(struct snd_usb_audio *chip, int ifnum)
749{
750 if (check_delayed_register_option(chip) == ifnum ||
751 chip->last_iface == ifnum ||
752 usb_interface_claimed(usb_ifnum_to_if(chip->dev, chip->last_iface)))
753 return snd_card_register(chip->card);
754 return 0;
755}
756
757/*
758 * probe the active usb device
759 *
760 * note that this can be called multiple times per a device, when it
761 * includes multiple audio control interfaces.
762 *
763 * thus we check the usb device pointer and creates the card instance
764 * only at the first time. the successive calls of this function will
765 * append the pcm interface to the corresponding card.
766 */
767static int usb_audio_probe(struct usb_interface *intf,
768 const struct usb_device_id *usb_id)
769{
770 struct usb_device *dev = interface_to_usbdev(intf);
771 const struct snd_usb_audio_quirk *quirk =
772 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
773 struct snd_usb_audio *chip;
774 int i, err;
775 struct usb_host_interface *alts;
776 int ifnum;
777 u32 id;
778
779 alts = &intf->altsetting[0];
780 ifnum = get_iface_desc(alts)->bInterfaceNumber;
781 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
782 le16_to_cpu(dev->descriptor.idProduct));
783 if (get_alias_id(dev, &id))
784 quirk = get_alias_quirk(dev, id);
785 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
786 return -ENXIO;
787 if (quirk && quirk->ifnum == QUIRK_NODEV_INTERFACE)
788 return -ENODEV;
789
790 err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
791 if (err < 0)
792 return err;
793
794 /*
795 * found a config. now register to ALSA
796 */
797
798 /* check whether it's already registered */
799 chip = NULL;
800 mutex_lock(®ister_mutex);
801 for (i = 0; i < SNDRV_CARDS; i++) {
802 if (usb_chip[i] && usb_chip[i]->dev == dev) {
803 if (atomic_read(&usb_chip[i]->shutdown)) {
804 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
805 err = -EIO;
806 goto __error;
807 }
808 chip = usb_chip[i];
809 atomic_inc(&chip->active); /* avoid autopm */
810 break;
811 }
812 }
813 if (! chip) {
814 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
815 if (err < 0)
816 goto __error;
817
818 /* it's a fresh one.
819 * now look for an empty slot and create a new card instance
820 */
821 for (i = 0; i < SNDRV_CARDS; i++)
822 if (!usb_chip[i] &&
823 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
824 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
825 if (enable[i]) {
826 err = snd_usb_audio_create(intf, dev, i, quirk,
827 id, &chip);
828 if (err < 0)
829 goto __error;
830 break;
831 } else if (vid[i] != -1 || pid[i] != -1) {
832 dev_info(&dev->dev,
833 "device (%04x:%04x) is disabled\n",
834 USB_ID_VENDOR(id),
835 USB_ID_PRODUCT(id));
836 err = -ENOENT;
837 goto __error;
838 }
839 }
840 if (!chip) {
841 dev_err(&dev->dev, "no available usb audio device\n");
842 err = -ENODEV;
843 goto __error;
844 }
845 find_last_interface(chip);
846 }
847
848 if (chip->num_interfaces >= MAX_CARD_INTERFACES) {
849 dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");
850 err = -EINVAL;
851 goto __error;
852 }
853
854 dev_set_drvdata(&dev->dev, chip);
855
856 if (ignore_ctl_error)
857 chip->quirk_flags |= QUIRK_FLAG_IGNORE_CTL_ERROR;
858
859 if (chip->quirk_flags & QUIRK_FLAG_DISABLE_AUTOSUSPEND)
860 usb_disable_autosuspend(interface_to_usbdev(intf));
861
862 /*
863 * For devices with more than one control interface, we assume the
864 * first contains the audio controls. We might need a more specific
865 * check here in the future.
866 */
867 if (!chip->ctrl_intf)
868 chip->ctrl_intf = alts;
869
870 err = 1; /* continue */
871 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
872 /* need some special handlings */
873 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
874 if (err < 0)
875 goto __error;
876 }
877
878 if (err > 0) {
879 /* create normal USB audio interfaces */
880 err = snd_usb_create_streams(chip, ifnum);
881 if (err < 0)
882 goto __error;
883 err = snd_usb_create_mixer(chip, ifnum);
884 if (err < 0)
885 goto __error;
886 }
887
888 if (chip->need_delayed_register) {
889 dev_info(&dev->dev,
890 "Found post-registration device assignment: %08x:%02x\n",
891 chip->usb_id, ifnum);
892 chip->need_delayed_register = false; /* clear again */
893 }
894
895 err = try_to_register_card(chip, ifnum);
896 if (err < 0)
897 goto __error_no_register;
898
899 if (chip->quirk_flags & QUIRK_FLAG_SHARE_MEDIA_DEVICE) {
900 /* don't want to fail when snd_media_device_create() fails */
901 snd_media_device_create(chip, intf);
902 }
903
904 if (quirk)
905 chip->quirk_type = quirk->type;
906
907 usb_chip[chip->index] = chip;
908 chip->intf[chip->num_interfaces] = intf;
909 chip->num_interfaces++;
910 usb_set_intfdata(intf, chip);
911 atomic_dec(&chip->active);
912 mutex_unlock(®ister_mutex);
913 return 0;
914
915 __error:
916 /* in the case of error in secondary interface, still try to register */
917 if (chip)
918 try_to_register_card(chip, ifnum);
919
920 __error_no_register:
921 if (chip) {
922 /* chip->active is inside the chip->card object,
923 * decrement before memory is possibly returned.
924 */
925 atomic_dec(&chip->active);
926 if (!chip->num_interfaces)
927 snd_card_free(chip->card);
928 }
929 mutex_unlock(®ister_mutex);
930 return err;
931}
932
933/*
934 * we need to take care of counter, since disconnection can be called also
935 * many times as well as usb_audio_probe().
936 */
937static void usb_audio_disconnect(struct usb_interface *intf)
938{
939 struct snd_usb_audio *chip = usb_get_intfdata(intf);
940 struct snd_card *card;
941 struct list_head *p;
942
943 if (chip == USB_AUDIO_IFACE_UNUSED)
944 return;
945
946 card = chip->card;
947
948 mutex_lock(®ister_mutex);
949 if (atomic_inc_return(&chip->shutdown) == 1) {
950 struct snd_usb_stream *as;
951 struct snd_usb_endpoint *ep;
952 struct usb_mixer_interface *mixer;
953
954 /* wait until all pending tasks done;
955 * they are protected by snd_usb_lock_shutdown()
956 */
957 wait_event(chip->shutdown_wait,
958 !atomic_read(&chip->usage_count));
959 snd_card_disconnect(card);
960 /* release the pcm resources */
961 list_for_each_entry(as, &chip->pcm_list, list) {
962 snd_usb_stream_disconnect(as);
963 }
964 /* release the endpoint resources */
965 list_for_each_entry(ep, &chip->ep_list, list) {
966 snd_usb_endpoint_release(ep);
967 }
968 /* release the midi resources */
969 list_for_each(p, &chip->midi_list) {
970 snd_usbmidi_disconnect(p);
971 }
972 /*
973 * Nice to check quirk && quirk->shares_media_device and
974 * then call the snd_media_device_delete(). Don't have
975 * access to the quirk here. snd_media_device_delete()
976 * accesses mixer_list
977 */
978 snd_media_device_delete(chip);
979
980 /* release mixer resources */
981 list_for_each_entry(mixer, &chip->mixer_list, list) {
982 snd_usb_mixer_disconnect(mixer);
983 }
984 }
985
986 if (chip->quirk_flags & QUIRK_FLAG_DISABLE_AUTOSUSPEND)
987 usb_enable_autosuspend(interface_to_usbdev(intf));
988
989 chip->num_interfaces--;
990 if (chip->num_interfaces <= 0) {
991 usb_chip[chip->index] = NULL;
992 mutex_unlock(®ister_mutex);
993 snd_card_free_when_closed(card);
994 } else {
995 mutex_unlock(®ister_mutex);
996 }
997}
998
999/* lock the shutdown (disconnect) task and autoresume */
1000int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
1001{
1002 int err;
1003
1004 atomic_inc(&chip->usage_count);
1005 if (atomic_read(&chip->shutdown)) {
1006 err = -EIO;
1007 goto error;
1008 }
1009 err = snd_usb_autoresume(chip);
1010 if (err < 0)
1011 goto error;
1012 return 0;
1013
1014 error:
1015 if (atomic_dec_and_test(&chip->usage_count))
1016 wake_up(&chip->shutdown_wait);
1017 return err;
1018}
1019
1020/* autosuspend and unlock the shutdown */
1021void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
1022{
1023 snd_usb_autosuspend(chip);
1024 if (atomic_dec_and_test(&chip->usage_count))
1025 wake_up(&chip->shutdown_wait);
1026}
1027
1028int snd_usb_autoresume(struct snd_usb_audio *chip)
1029{
1030 int i, err;
1031
1032 if (atomic_read(&chip->shutdown))
1033 return -EIO;
1034 if (atomic_inc_return(&chip->active) != 1)
1035 return 0;
1036
1037 for (i = 0; i < chip->num_interfaces; i++) {
1038 err = usb_autopm_get_interface(chip->intf[i]);
1039 if (err < 0) {
1040 /* rollback */
1041 while (--i >= 0)
1042 usb_autopm_put_interface(chip->intf[i]);
1043 atomic_dec(&chip->active);
1044 return err;
1045 }
1046 }
1047 return 0;
1048}
1049
1050void snd_usb_autosuspend(struct snd_usb_audio *chip)
1051{
1052 int i;
1053
1054 if (atomic_read(&chip->shutdown))
1055 return;
1056 if (!atomic_dec_and_test(&chip->active))
1057 return;
1058
1059 for (i = 0; i < chip->num_interfaces; i++)
1060 usb_autopm_put_interface(chip->intf[i]);
1061}
1062
1063static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
1064{
1065 struct snd_usb_audio *chip = usb_get_intfdata(intf);
1066 struct snd_usb_stream *as;
1067 struct snd_usb_endpoint *ep;
1068 struct usb_mixer_interface *mixer;
1069 struct list_head *p;
1070
1071 if (chip == USB_AUDIO_IFACE_UNUSED)
1072 return 0;
1073
1074 if (!chip->num_suspended_intf++) {
1075 list_for_each_entry(as, &chip->pcm_list, list)
1076 snd_usb_pcm_suspend(as);
1077 list_for_each_entry(ep, &chip->ep_list, list)
1078 snd_usb_endpoint_suspend(ep);
1079 list_for_each(p, &chip->midi_list)
1080 snd_usbmidi_suspend(p);
1081 list_for_each_entry(mixer, &chip->mixer_list, list)
1082 snd_usb_mixer_suspend(mixer);
1083 }
1084
1085 if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
1086 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
1087 chip->system_suspend = chip->num_suspended_intf;
1088 }
1089
1090 return 0;
1091}
1092
1093static int usb_audio_resume(struct usb_interface *intf)
1094{
1095 struct snd_usb_audio *chip = usb_get_intfdata(intf);
1096 struct snd_usb_stream *as;
1097 struct usb_mixer_interface *mixer;
1098 struct list_head *p;
1099 int err = 0;
1100
1101 if (chip == USB_AUDIO_IFACE_UNUSED)
1102 return 0;
1103
1104 atomic_inc(&chip->active); /* avoid autopm */
1105 if (chip->num_suspended_intf > 1)
1106 goto out;
1107
1108 list_for_each_entry(as, &chip->pcm_list, list) {
1109 err = snd_usb_pcm_resume(as);
1110 if (err < 0)
1111 goto err_out;
1112 }
1113
1114 /*
1115 * ALSA leaves material resumption to user space
1116 * we just notify and restart the mixers
1117 */
1118 list_for_each_entry(mixer, &chip->mixer_list, list) {
1119 err = snd_usb_mixer_resume(mixer);
1120 if (err < 0)
1121 goto err_out;
1122 }
1123
1124 list_for_each(p, &chip->midi_list) {
1125 snd_usbmidi_resume(p);
1126 }
1127
1128 out:
1129 if (chip->num_suspended_intf == chip->system_suspend) {
1130 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
1131 chip->system_suspend = 0;
1132 }
1133 chip->num_suspended_intf--;
1134
1135err_out:
1136 atomic_dec(&chip->active); /* allow autopm after this point */
1137 return err;
1138}
1139
1140static const struct usb_device_id usb_audio_ids [] = {
1141#include "quirks-table.h"
1142 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1143 .bInterfaceClass = USB_CLASS_AUDIO,
1144 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
1145 { } /* Terminating entry */
1146};
1147MODULE_DEVICE_TABLE(usb, usb_audio_ids);
1148
1149/*
1150 * entry point for linux usb interface
1151 */
1152
1153static struct usb_driver usb_audio_driver = {
1154 .name = "snd-usb-audio",
1155 .probe = usb_audio_probe,
1156 .disconnect = usb_audio_disconnect,
1157 .suspend = usb_audio_suspend,
1158 .resume = usb_audio_resume,
1159 .reset_resume = usb_audio_resume,
1160 .id_table = usb_audio_ids,
1161 .supports_autosuspend = 1,
1162};
1163
1164module_usb_driver(usb_audio_driver);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * (Tentative) USB Audio Driver for ALSA
4 *
5 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
6 *
7 * Many codes borrowed from audio.c by
8 * Alan Cox (alan@lxorguk.ukuu.org.uk)
9 * Thomas Sailer (sailer@ife.ee.ethz.ch)
10 *
11 * Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com>
12 *
13 * NOTES:
14 *
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).
20 */
21
22
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>
36
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>
43
44#include "usbaudio.h"
45#include "card.h"
46#include "midi.h"
47#include "mixer.h"
48#include "proc.h"
49#include "quirks.h"
50#include "endpoint.h"
51#include "helper.h"
52#include "pcm.h"
53#include "format.h"
54#include "power.h"
55#include "stream.h"
56#include "media.h"
57
58MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
59MODULE_DESCRIPTION("USB Audio");
60MODULE_LICENSE("GPL");
61
62static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
63static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
64static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
65/* Vendor/product IDs for this card */
66static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
67static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
68static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
69static bool ignore_ctl_error;
70static bool autoclock = true;
71static bool lowlatency = true;
72static char *quirk_alias[SNDRV_CARDS];
73static char *delayed_register[SNDRV_CARDS];
74static bool implicit_fb[SNDRV_CARDS];
75
76bool snd_usb_use_vmalloc = true;
77bool snd_usb_skip_validation;
78
79module_param_array(index, int, NULL, 0444);
80MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
81module_param_array(id, charp, NULL, 0444);
82MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
83module_param_array(enable, bool, NULL, 0444);
84MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
85module_param_array(vid, int, NULL, 0444);
86MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
87module_param_array(pid, int, NULL, 0444);
88MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
89module_param_array(device_setup, int, NULL, 0444);
90MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
91module_param(ignore_ctl_error, bool, 0444);
92MODULE_PARM_DESC(ignore_ctl_error,
93 "Ignore errors from USB controller for mixer interfaces.");
94module_param(autoclock, bool, 0444);
95MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
96module_param(lowlatency, bool, 0444);
97MODULE_PARM_DESC(lowlatency, "Enable low latency playback (default: yes).");
98module_param_array(quirk_alias, charp, NULL, 0444);
99MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");
100module_param_array(delayed_register, charp, NULL, 0444);
101MODULE_PARM_DESC(delayed_register, "Quirk for delayed registration, given by id:iface, e.g. 0123abcd:4.");
102module_param_array(implicit_fb, bool, NULL, 0444);
103MODULE_PARM_DESC(implicit_fb, "Apply generic implicit feedback sync mode.");
104module_param_named(use_vmalloc, snd_usb_use_vmalloc, bool, 0444);
105MODULE_PARM_DESC(use_vmalloc, "Use vmalloc for PCM intermediate buffers (default: yes).");
106module_param_named(skip_validation, snd_usb_skip_validation, bool, 0444);
107MODULE_PARM_DESC(skip_validation, "Skip unit descriptor validation (default: no).");
108
109/*
110 * we keep the snd_usb_audio_t instances by ourselves for merging
111 * the all interfaces on the same card as one sound device.
112 */
113
114static DEFINE_MUTEX(register_mutex);
115static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
116static struct usb_driver usb_audio_driver;
117
118/*
119 * disconnect streams
120 * called from usb_audio_disconnect()
121 */
122static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
123{
124 int idx;
125 struct snd_usb_substream *subs;
126
127 for (idx = 0; idx < 2; idx++) {
128 subs = &as->substream[idx];
129 if (!subs->num_formats)
130 continue;
131 subs->data_endpoint = NULL;
132 subs->sync_endpoint = NULL;
133 }
134}
135
136static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
137{
138 struct usb_device *dev = chip->dev;
139 struct usb_host_interface *alts;
140 struct usb_interface_descriptor *altsd;
141 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
142
143 if (!iface) {
144 dev_err(&dev->dev, "%u:%d : does not exist\n",
145 ctrlif, interface);
146 return -EINVAL;
147 }
148
149 alts = &iface->altsetting[0];
150 altsd = get_iface_desc(alts);
151
152 /*
153 * Android with both accessory and audio interfaces enabled gets the
154 * interface numbers wrong.
155 */
156 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
157 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
158 interface == 0 &&
159 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
160 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
161 interface = 2;
162 iface = usb_ifnum_to_if(dev, interface);
163 if (!iface)
164 return -EINVAL;
165 alts = &iface->altsetting[0];
166 altsd = get_iface_desc(alts);
167 }
168
169 if (usb_interface_claimed(iface)) {
170 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
171 ctrlif, interface);
172 return -EINVAL;
173 }
174
175 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
176 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
177 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
178 int err = __snd_usbmidi_create(chip->card, iface,
179 &chip->midi_list, NULL,
180 chip->usb_id);
181 if (err < 0) {
182 dev_err(&dev->dev,
183 "%u:%d: cannot create sequencer device\n",
184 ctrlif, interface);
185 return -EINVAL;
186 }
187 return usb_driver_claim_interface(&usb_audio_driver, iface,
188 USB_AUDIO_IFACE_UNUSED);
189 }
190
191 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
192 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
193 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
194 dev_dbg(&dev->dev,
195 "%u:%d: skipping non-supported interface %d\n",
196 ctrlif, interface, altsd->bInterfaceClass);
197 /* skip non-supported classes */
198 return -EINVAL;
199 }
200
201 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
202 dev_err(&dev->dev, "low speed audio streaming not supported\n");
203 return -EINVAL;
204 }
205
206 if (! snd_usb_parse_audio_interface(chip, interface)) {
207 usb_set_interface(dev, interface, 0); /* reset the current interface */
208 return usb_driver_claim_interface(&usb_audio_driver, iface,
209 USB_AUDIO_IFACE_UNUSED);
210 }
211
212 return 0;
213}
214
215/*
216 * parse audio control descriptor and create pcm/midi streams
217 */
218static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
219{
220 struct usb_device *dev = chip->dev;
221 struct usb_host_interface *host_iface;
222 struct usb_interface_descriptor *altsd;
223 int i, protocol;
224
225 /* find audiocontrol interface */
226 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
227 altsd = get_iface_desc(host_iface);
228 protocol = altsd->bInterfaceProtocol;
229
230 switch (protocol) {
231 default:
232 dev_warn(&dev->dev,
233 "unknown interface protocol %#02x, assuming v1\n",
234 protocol);
235 fallthrough;
236
237 case UAC_VERSION_1: {
238 struct uac1_ac_header_descriptor *h1;
239 int rest_bytes;
240
241 h1 = snd_usb_find_csint_desc(host_iface->extra,
242 host_iface->extralen,
243 NULL, UAC_HEADER);
244 if (!h1 || h1->bLength < sizeof(*h1)) {
245 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
246 return -EINVAL;
247 }
248
249 rest_bytes = (void *)(host_iface->extra +
250 host_iface->extralen) - (void *)h1;
251
252 /* just to be sure -- this shouldn't hit at all */
253 if (rest_bytes <= 0) {
254 dev_err(&dev->dev, "invalid control header\n");
255 return -EINVAL;
256 }
257
258 if (rest_bytes < sizeof(*h1)) {
259 dev_err(&dev->dev, "too short v1 buffer descriptor\n");
260 return -EINVAL;
261 }
262
263 if (!h1->bInCollection) {
264 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
265 return -EINVAL;
266 }
267
268 if (rest_bytes < h1->bLength) {
269 dev_err(&dev->dev, "invalid buffer length (v1)\n");
270 return -EINVAL;
271 }
272
273 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
274 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
275 return -EINVAL;
276 }
277
278 for (i = 0; i < h1->bInCollection; i++)
279 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
280
281 break;
282 }
283
284 case UAC_VERSION_2:
285 case UAC_VERSION_3: {
286 struct usb_interface_assoc_descriptor *assoc =
287 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
288
289 if (!assoc) {
290 /*
291 * Firmware writers cannot count to three. So to find
292 * the IAD on the NuForce UDH-100, also check the next
293 * interface.
294 */
295 struct usb_interface *iface =
296 usb_ifnum_to_if(dev, ctrlif + 1);
297 if (iface &&
298 iface->intf_assoc &&
299 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
300 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
301 assoc = iface->intf_assoc;
302 }
303
304 if (!assoc) {
305 dev_err(&dev->dev, "Audio class v2/v3 interfaces need an interface association\n");
306 return -EINVAL;
307 }
308
309 if (protocol == UAC_VERSION_3) {
310 int badd = assoc->bFunctionSubClass;
311
312 if (badd != UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0 &&
313 (badd < UAC3_FUNCTION_SUBCLASS_GENERIC_IO ||
314 badd > UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE)) {
315 dev_err(&dev->dev,
316 "Unsupported UAC3 BADD profile\n");
317 return -EINVAL;
318 }
319
320 chip->badd_profile = badd;
321 }
322
323 for (i = 0; i < assoc->bInterfaceCount; i++) {
324 int intf = assoc->bFirstInterface + i;
325
326 if (intf != ctrlif)
327 snd_usb_create_stream(chip, ctrlif, intf);
328 }
329
330 break;
331 }
332 }
333
334 return 0;
335}
336
337/*
338 * Profile name preset table
339 */
340struct usb_audio_device_name {
341 u32 id;
342 const char *vendor_name;
343 const char *product_name;
344 const char *profile_name; /* override card->longname */
345};
346
347#define PROFILE_NAME(vid, pid, vendor, product, profile) \
348 { .id = USB_ID(vid, pid), .vendor_name = (vendor), \
349 .product_name = (product), .profile_name = (profile) }
350#define DEVICE_NAME(vid, pid, vendor, product) \
351 PROFILE_NAME(vid, pid, vendor, product, NULL)
352
353/* vendor/product and profile name presets, sorted in device id order */
354static const struct usb_audio_device_name usb_audio_names[] = {
355 /* HP Thunderbolt Dock Audio Headset */
356 PROFILE_NAME(0x03f0, 0x0269, "HP", "Thunderbolt Dock Audio Headset",
357 "HP-Thunderbolt-Dock-Audio-Headset"),
358 /* HP Thunderbolt Dock Audio Module */
359 PROFILE_NAME(0x03f0, 0x0567, "HP", "Thunderbolt Dock Audio Module",
360 "HP-Thunderbolt-Dock-Audio-Module"),
361
362 /* Two entries for Gigabyte TRX40 Aorus Master:
363 * TRX40 Aorus Master has two USB-audio devices, one for the front
364 * headphone with ESS SABRE9218 DAC chip, while another for the rest
365 * I/O (the rear panel and the front mic) with Realtek ALC1220-VB.
366 * Here we provide two distinct names for making UCM profiles easier.
367 */
368 PROFILE_NAME(0x0414, 0xa000, "Gigabyte", "Aorus Master Front Headphone",
369 "Gigabyte-Aorus-Master-Front-Headphone"),
370 PROFILE_NAME(0x0414, 0xa001, "Gigabyte", "Aorus Master Main Audio",
371 "Gigabyte-Aorus-Master-Main-Audio"),
372
373 /* Gigabyte TRX40 Aorus Pro WiFi */
374 PROFILE_NAME(0x0414, 0xa002,
375 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
376
377 /* Creative/E-Mu devices */
378 DEVICE_NAME(0x041e, 0x3010, "Creative Labs", "Sound Blaster MP3+"),
379 /* Creative/Toshiba Multimedia Center SB-0500 */
380 DEVICE_NAME(0x041e, 0x3048, "Toshiba", "SB-0500"),
381
382 DEVICE_NAME(0x046d, 0x0990, "Logitech, Inc.", "QuickCam Pro 9000"),
383
384 /* ASUS ROG Strix */
385 PROFILE_NAME(0x0b05, 0x1917,
386 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
387 /* ASUS PRIME TRX40 PRO-S */
388 PROFILE_NAME(0x0b05, 0x1918,
389 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
390
391 /* Dell WD15 Dock */
392 PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
393 /* Dell WD19 Dock */
394 PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
395
396 DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
397
398 /*
399 * The original product_name is "USB Sound Device", however this name
400 * is also used by the CM106 based cards, so make it unique.
401 */
402 DEVICE_NAME(0x0d8c, 0x0102, NULL, "ICUSBAUDIO7D"),
403 DEVICE_NAME(0x0d8c, 0x0103, NULL, "Audio Advantage MicroII"),
404
405 /* MSI TRX40 Creator */
406 PROFILE_NAME(0x0db0, 0x0d64,
407 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
408 /* MSI TRX40 */
409 PROFILE_NAME(0x0db0, 0x543d,
410 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
411
412 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
413 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
414 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
415
416 /* aka. Serato Scratch Live DJ Box */
417 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
418
419 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
420 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
421 "Lenovo-ThinkStation-P620-Rear"),
422 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
423 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
424 "Lenovo-ThinkStation-P620-Main"),
425
426 /* Asrock TRX40 Creator */
427 PROFILE_NAME(0x26ce, 0x0a01,
428 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
429
430 { } /* terminator */
431};
432
433static const struct usb_audio_device_name *
434lookup_device_name(u32 id)
435{
436 static const struct usb_audio_device_name *p;
437
438 for (p = usb_audio_names; p->id; p++)
439 if (p->id == id)
440 return p;
441 return NULL;
442}
443
444/*
445 * free the chip instance
446 *
447 * here we have to do not much, since pcm and controls are already freed
448 *
449 */
450
451static void snd_usb_audio_free(struct snd_card *card)
452{
453 struct snd_usb_audio *chip = card->private_data;
454
455 snd_usb_endpoint_free_all(chip);
456
457 mutex_destroy(&chip->mutex);
458 if (!atomic_read(&chip->shutdown))
459 dev_set_drvdata(&chip->dev->dev, NULL);
460}
461
462static void usb_audio_make_shortname(struct usb_device *dev,
463 struct snd_usb_audio *chip,
464 const struct snd_usb_audio_quirk *quirk)
465{
466 struct snd_card *card = chip->card;
467 const struct usb_audio_device_name *preset;
468 const char *s = NULL;
469
470 preset = lookup_device_name(chip->usb_id);
471 if (preset && preset->product_name)
472 s = preset->product_name;
473 else if (quirk && quirk->product_name)
474 s = quirk->product_name;
475 if (s && *s) {
476 strscpy(card->shortname, s, sizeof(card->shortname));
477 return;
478 }
479
480 /* retrieve the device string as shortname */
481 if (!dev->descriptor.iProduct ||
482 usb_string(dev, dev->descriptor.iProduct,
483 card->shortname, sizeof(card->shortname)) <= 0) {
484 /* no name available from anywhere, so use ID */
485 sprintf(card->shortname, "USB Device %#04x:%#04x",
486 USB_ID_VENDOR(chip->usb_id),
487 USB_ID_PRODUCT(chip->usb_id));
488 }
489
490 strim(card->shortname);
491}
492
493static void usb_audio_make_longname(struct usb_device *dev,
494 struct snd_usb_audio *chip,
495 const struct snd_usb_audio_quirk *quirk)
496{
497 struct snd_card *card = chip->card;
498 const struct usb_audio_device_name *preset;
499 const char *s = NULL;
500 int len;
501
502 preset = lookup_device_name(chip->usb_id);
503
504 /* shortcut - if any pre-defined string is given, use it */
505 if (preset && preset->profile_name)
506 s = preset->profile_name;
507 if (s && *s) {
508 strscpy(card->longname, s, sizeof(card->longname));
509 return;
510 }
511
512 if (preset && preset->vendor_name)
513 s = preset->vendor_name;
514 else if (quirk && quirk->vendor_name)
515 s = quirk->vendor_name;
516 *card->longname = 0;
517 if (s && *s) {
518 strscpy(card->longname, s, sizeof(card->longname));
519 } else {
520 /* retrieve the vendor and device strings as longname */
521 if (dev->descriptor.iManufacturer)
522 usb_string(dev, dev->descriptor.iManufacturer,
523 card->longname, sizeof(card->longname));
524 /* we don't really care if there isn't any vendor string */
525 }
526 if (*card->longname) {
527 strim(card->longname);
528 if (*card->longname)
529 strlcat(card->longname, " ", sizeof(card->longname));
530 }
531
532 strlcat(card->longname, card->shortname, sizeof(card->longname));
533
534 len = strlcat(card->longname, " at ", sizeof(card->longname));
535
536 if (len < sizeof(card->longname))
537 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
538
539 switch (snd_usb_get_speed(dev)) {
540 case USB_SPEED_LOW:
541 strlcat(card->longname, ", low speed", sizeof(card->longname));
542 break;
543 case USB_SPEED_FULL:
544 strlcat(card->longname, ", full speed", sizeof(card->longname));
545 break;
546 case USB_SPEED_HIGH:
547 strlcat(card->longname, ", high speed", sizeof(card->longname));
548 break;
549 case USB_SPEED_SUPER:
550 strlcat(card->longname, ", super speed", sizeof(card->longname));
551 break;
552 case USB_SPEED_SUPER_PLUS:
553 strlcat(card->longname, ", super speed plus", sizeof(card->longname));
554 break;
555 default:
556 break;
557 }
558}
559
560/*
561 * create a chip instance and set its names.
562 */
563static int snd_usb_audio_create(struct usb_interface *intf,
564 struct usb_device *dev, int idx,
565 const struct snd_usb_audio_quirk *quirk,
566 unsigned int usb_id,
567 struct snd_usb_audio **rchip)
568{
569 struct snd_card *card;
570 struct snd_usb_audio *chip;
571 int err;
572 char component[14];
573
574 *rchip = NULL;
575
576 switch (snd_usb_get_speed(dev)) {
577 case USB_SPEED_LOW:
578 case USB_SPEED_FULL:
579 case USB_SPEED_HIGH:
580 case USB_SPEED_WIRELESS:
581 case USB_SPEED_SUPER:
582 case USB_SPEED_SUPER_PLUS:
583 break;
584 default:
585 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
586 return -ENXIO;
587 }
588
589 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
590 sizeof(*chip), &card);
591 if (err < 0) {
592 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
593 return err;
594 }
595
596 chip = card->private_data;
597 mutex_init(&chip->mutex);
598 init_waitqueue_head(&chip->shutdown_wait);
599 chip->index = idx;
600 chip->dev = dev;
601 chip->card = card;
602 chip->setup = device_setup[idx];
603 chip->generic_implicit_fb = implicit_fb[idx];
604 chip->autoclock = autoclock;
605 chip->lowlatency = lowlatency;
606 atomic_set(&chip->active, 1); /* avoid autopm during probing */
607 atomic_set(&chip->usage_count, 0);
608 atomic_set(&chip->shutdown, 0);
609
610 chip->usb_id = usb_id;
611 INIT_LIST_HEAD(&chip->pcm_list);
612 INIT_LIST_HEAD(&chip->ep_list);
613 INIT_LIST_HEAD(&chip->iface_ref_list);
614 INIT_LIST_HEAD(&chip->midi_list);
615 INIT_LIST_HEAD(&chip->mixer_list);
616
617 card->private_free = snd_usb_audio_free;
618
619 strcpy(card->driver, "USB-Audio");
620 sprintf(component, "USB%04x:%04x",
621 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
622 snd_component_add(card, component);
623
624 usb_audio_make_shortname(dev, chip, quirk);
625 usb_audio_make_longname(dev, chip, quirk);
626
627 snd_usb_audio_create_proc(chip);
628
629 *rchip = chip;
630 return 0;
631}
632
633/* look for a matching quirk alias id */
634static bool get_alias_id(struct usb_device *dev, unsigned int *id)
635{
636 int i;
637 unsigned int src, dst;
638
639 for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
640 if (!quirk_alias[i] ||
641 sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
642 src != *id)
643 continue;
644 dev_info(&dev->dev,
645 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
646 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
647 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
648 *id = dst;
649 return true;
650 }
651
652 return false;
653}
654
655static bool check_delayed_register_option(struct snd_usb_audio *chip, int iface)
656{
657 int i;
658 unsigned int id, inum;
659
660 for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {
661 if (delayed_register[i] &&
662 sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&
663 id == chip->usb_id)
664 return inum != iface;
665 }
666
667 return false;
668}
669
670static const struct usb_device_id usb_audio_ids[]; /* defined below */
671
672/* look for the corresponding quirk */
673static const struct snd_usb_audio_quirk *
674get_alias_quirk(struct usb_device *dev, unsigned int id)
675{
676 const struct usb_device_id *p;
677
678 for (p = usb_audio_ids; p->match_flags; p++) {
679 /* FIXME: this checks only vendor:product pair in the list */
680 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
681 USB_DEVICE_ID_MATCH_DEVICE &&
682 p->idVendor == USB_ID_VENDOR(id) &&
683 p->idProduct == USB_ID_PRODUCT(id))
684 return (const struct snd_usb_audio_quirk *)p->driver_info;
685 }
686
687 return NULL;
688}
689
690/*
691 * probe the active usb device
692 *
693 * note that this can be called multiple times per a device, when it
694 * includes multiple audio control interfaces.
695 *
696 * thus we check the usb device pointer and creates the card instance
697 * only at the first time. the successive calls of this function will
698 * append the pcm interface to the corresponding card.
699 */
700static int usb_audio_probe(struct usb_interface *intf,
701 const struct usb_device_id *usb_id)
702{
703 struct usb_device *dev = interface_to_usbdev(intf);
704 const struct snd_usb_audio_quirk *quirk =
705 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
706 struct snd_usb_audio *chip;
707 int i, err;
708 struct usb_host_interface *alts;
709 int ifnum;
710 u32 id;
711
712 alts = &intf->altsetting[0];
713 ifnum = get_iface_desc(alts)->bInterfaceNumber;
714 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
715 le16_to_cpu(dev->descriptor.idProduct));
716 if (get_alias_id(dev, &id))
717 quirk = get_alias_quirk(dev, id);
718 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
719 return -ENXIO;
720 if (quirk && quirk->ifnum == QUIRK_NODEV_INTERFACE)
721 return -ENODEV;
722
723 err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
724 if (err < 0)
725 return err;
726
727 /*
728 * found a config. now register to ALSA
729 */
730
731 /* check whether it's already registered */
732 chip = NULL;
733 mutex_lock(®ister_mutex);
734 for (i = 0; i < SNDRV_CARDS; i++) {
735 if (usb_chip[i] && usb_chip[i]->dev == dev) {
736 if (atomic_read(&usb_chip[i]->shutdown)) {
737 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
738 err = -EIO;
739 goto __error;
740 }
741 chip = usb_chip[i];
742 atomic_inc(&chip->active); /* avoid autopm */
743 break;
744 }
745 }
746 if (! chip) {
747 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
748 if (err < 0)
749 goto __error;
750
751 /* it's a fresh one.
752 * now look for an empty slot and create a new card instance
753 */
754 for (i = 0; i < SNDRV_CARDS; i++)
755 if (!usb_chip[i] &&
756 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
757 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
758 if (enable[i]) {
759 err = snd_usb_audio_create(intf, dev, i, quirk,
760 id, &chip);
761 if (err < 0)
762 goto __error;
763 break;
764 } else if (vid[i] != -1 || pid[i] != -1) {
765 dev_info(&dev->dev,
766 "device (%04x:%04x) is disabled\n",
767 USB_ID_VENDOR(id),
768 USB_ID_PRODUCT(id));
769 err = -ENOENT;
770 goto __error;
771 }
772 }
773 if (!chip) {
774 dev_err(&dev->dev, "no available usb audio device\n");
775 err = -ENODEV;
776 goto __error;
777 }
778 }
779
780 if (chip->num_interfaces >= MAX_CARD_INTERFACES) {
781 dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");
782 err = -EINVAL;
783 goto __error;
784 }
785
786 dev_set_drvdata(&dev->dev, chip);
787
788 /*
789 * For devices with more than one control interface, we assume the
790 * first contains the audio controls. We might need a more specific
791 * check here in the future.
792 */
793 if (!chip->ctrl_intf)
794 chip->ctrl_intf = alts;
795
796 chip->txfr_quirk = 0;
797 err = 1; /* continue */
798 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
799 /* need some special handlings */
800 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
801 if (err < 0)
802 goto __error;
803 }
804
805 if (err > 0) {
806 /* create normal USB audio interfaces */
807 err = snd_usb_create_streams(chip, ifnum);
808 if (err < 0)
809 goto __error;
810 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
811 if (err < 0)
812 goto __error;
813 }
814
815 if (chip->need_delayed_register) {
816 dev_info(&dev->dev,
817 "Found post-registration device assignment: %08x:%02x\n",
818 chip->usb_id, ifnum);
819 chip->need_delayed_register = false; /* clear again */
820 }
821
822 /* we are allowed to call snd_card_register() many times, but first
823 * check to see if a device needs to skip it or do anything special
824 */
825 if (!snd_usb_registration_quirk(chip, ifnum) &&
826 !check_delayed_register_option(chip, ifnum)) {
827 err = snd_card_register(chip->card);
828 if (err < 0)
829 goto __error;
830 }
831
832 if (quirk && quirk->shares_media_device) {
833 /* don't want to fail when snd_media_device_create() fails */
834 snd_media_device_create(chip, intf);
835 }
836
837 if (quirk)
838 chip->quirk_type = quirk->type;
839
840 usb_chip[chip->index] = chip;
841 chip->intf[chip->num_interfaces] = intf;
842 chip->num_interfaces++;
843 usb_set_intfdata(intf, chip);
844 atomic_dec(&chip->active);
845 mutex_unlock(®ister_mutex);
846 return 0;
847
848 __error:
849 if (chip) {
850 /* chip->active is inside the chip->card object,
851 * decrement before memory is possibly returned.
852 */
853 atomic_dec(&chip->active);
854 if (!chip->num_interfaces)
855 snd_card_free(chip->card);
856 }
857 mutex_unlock(®ister_mutex);
858 return err;
859}
860
861/*
862 * we need to take care of counter, since disconnection can be called also
863 * many times as well as usb_audio_probe().
864 */
865static void usb_audio_disconnect(struct usb_interface *intf)
866{
867 struct snd_usb_audio *chip = usb_get_intfdata(intf);
868 struct snd_card *card;
869 struct list_head *p;
870
871 if (chip == USB_AUDIO_IFACE_UNUSED)
872 return;
873
874 card = chip->card;
875
876 mutex_lock(®ister_mutex);
877 if (atomic_inc_return(&chip->shutdown) == 1) {
878 struct snd_usb_stream *as;
879 struct snd_usb_endpoint *ep;
880 struct usb_mixer_interface *mixer;
881
882 /* wait until all pending tasks done;
883 * they are protected by snd_usb_lock_shutdown()
884 */
885 wait_event(chip->shutdown_wait,
886 !atomic_read(&chip->usage_count));
887 snd_card_disconnect(card);
888 /* release the pcm resources */
889 list_for_each_entry(as, &chip->pcm_list, list) {
890 snd_usb_stream_disconnect(as);
891 }
892 /* release the endpoint resources */
893 list_for_each_entry(ep, &chip->ep_list, list) {
894 snd_usb_endpoint_release(ep);
895 }
896 /* release the midi resources */
897 list_for_each(p, &chip->midi_list) {
898 snd_usbmidi_disconnect(p);
899 }
900 /*
901 * Nice to check quirk && quirk->shares_media_device and
902 * then call the snd_media_device_delete(). Don't have
903 * access to the quirk here. snd_media_device_delete()
904 * accesses mixer_list
905 */
906 snd_media_device_delete(chip);
907
908 /* release mixer resources */
909 list_for_each_entry(mixer, &chip->mixer_list, list) {
910 snd_usb_mixer_disconnect(mixer);
911 }
912 }
913
914 if (chip->quirk_type == QUIRK_SETUP_DISABLE_AUTOSUSPEND)
915 usb_enable_autosuspend(interface_to_usbdev(intf));
916
917 chip->num_interfaces--;
918 if (chip->num_interfaces <= 0) {
919 usb_chip[chip->index] = NULL;
920 mutex_unlock(®ister_mutex);
921 snd_card_free_when_closed(card);
922 } else {
923 mutex_unlock(®ister_mutex);
924 }
925}
926
927/* lock the shutdown (disconnect) task and autoresume */
928int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
929{
930 int err;
931
932 atomic_inc(&chip->usage_count);
933 if (atomic_read(&chip->shutdown)) {
934 err = -EIO;
935 goto error;
936 }
937 err = snd_usb_autoresume(chip);
938 if (err < 0)
939 goto error;
940 return 0;
941
942 error:
943 if (atomic_dec_and_test(&chip->usage_count))
944 wake_up(&chip->shutdown_wait);
945 return err;
946}
947
948/* autosuspend and unlock the shutdown */
949void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
950{
951 snd_usb_autosuspend(chip);
952 if (atomic_dec_and_test(&chip->usage_count))
953 wake_up(&chip->shutdown_wait);
954}
955
956#ifdef CONFIG_PM
957
958int snd_usb_autoresume(struct snd_usb_audio *chip)
959{
960 int i, err;
961
962 if (atomic_read(&chip->shutdown))
963 return -EIO;
964 if (atomic_inc_return(&chip->active) != 1)
965 return 0;
966
967 for (i = 0; i < chip->num_interfaces; i++) {
968 err = usb_autopm_get_interface(chip->intf[i]);
969 if (err < 0) {
970 /* rollback */
971 while (--i >= 0)
972 usb_autopm_put_interface(chip->intf[i]);
973 atomic_dec(&chip->active);
974 return err;
975 }
976 }
977 return 0;
978}
979
980void snd_usb_autosuspend(struct snd_usb_audio *chip)
981{
982 int i;
983
984 if (atomic_read(&chip->shutdown))
985 return;
986 if (!atomic_dec_and_test(&chip->active))
987 return;
988
989 for (i = 0; i < chip->num_interfaces; i++)
990 usb_autopm_put_interface(chip->intf[i]);
991}
992
993static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
994{
995 struct snd_usb_audio *chip = usb_get_intfdata(intf);
996 struct snd_usb_stream *as;
997 struct snd_usb_endpoint *ep;
998 struct usb_mixer_interface *mixer;
999 struct list_head *p;
1000
1001 if (chip == USB_AUDIO_IFACE_UNUSED)
1002 return 0;
1003
1004 if (!chip->num_suspended_intf++) {
1005 list_for_each_entry(as, &chip->pcm_list, list)
1006 snd_usb_pcm_suspend(as);
1007 list_for_each_entry(ep, &chip->ep_list, list)
1008 snd_usb_endpoint_suspend(ep);
1009 list_for_each(p, &chip->midi_list)
1010 snd_usbmidi_suspend(p);
1011 list_for_each_entry(mixer, &chip->mixer_list, list)
1012 snd_usb_mixer_suspend(mixer);
1013 }
1014
1015 if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
1016 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
1017 chip->system_suspend = chip->num_suspended_intf;
1018 }
1019
1020 return 0;
1021}
1022
1023static int usb_audio_resume(struct usb_interface *intf)
1024{
1025 struct snd_usb_audio *chip = usb_get_intfdata(intf);
1026 struct snd_usb_stream *as;
1027 struct usb_mixer_interface *mixer;
1028 struct list_head *p;
1029 int err = 0;
1030
1031 if (chip == USB_AUDIO_IFACE_UNUSED)
1032 return 0;
1033
1034 atomic_inc(&chip->active); /* avoid autopm */
1035 if (chip->num_suspended_intf > 1)
1036 goto out;
1037
1038 list_for_each_entry(as, &chip->pcm_list, list) {
1039 err = snd_usb_pcm_resume(as);
1040 if (err < 0)
1041 goto err_out;
1042 }
1043
1044 /*
1045 * ALSA leaves material resumption to user space
1046 * we just notify and restart the mixers
1047 */
1048 list_for_each_entry(mixer, &chip->mixer_list, list) {
1049 err = snd_usb_mixer_resume(mixer);
1050 if (err < 0)
1051 goto err_out;
1052 }
1053
1054 list_for_each(p, &chip->midi_list) {
1055 snd_usbmidi_resume(p);
1056 }
1057
1058 out:
1059 if (chip->num_suspended_intf == chip->system_suspend) {
1060 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
1061 chip->system_suspend = 0;
1062 }
1063 chip->num_suspended_intf--;
1064
1065err_out:
1066 atomic_dec(&chip->active); /* allow autopm after this point */
1067 return err;
1068}
1069#else
1070#define usb_audio_suspend NULL
1071#define usb_audio_resume NULL
1072#define usb_audio_resume NULL
1073#endif /* CONFIG_PM */
1074
1075static const struct usb_device_id usb_audio_ids [] = {
1076#include "quirks-table.h"
1077 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1078 .bInterfaceClass = USB_CLASS_AUDIO,
1079 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
1080 { } /* Terminating entry */
1081};
1082MODULE_DEVICE_TABLE(usb, usb_audio_ids);
1083
1084/*
1085 * entry point for linux usb interface
1086 */
1087
1088static struct usb_driver usb_audio_driver = {
1089 .name = "snd-usb-audio",
1090 .probe = usb_audio_probe,
1091 .disconnect = usb_audio_disconnect,
1092 .suspend = usb_audio_suspend,
1093 .resume = usb_audio_resume,
1094 .reset_resume = usb_audio_resume,
1095 .id_table = usb_audio_ids,
1096 .supports_autosuspend = 1,
1097};
1098
1099module_usb_driver(usb_audio_driver);