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