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 Strix */
383 PROFILE_NAME(0x0b05, 0x1917,
384 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
385 /* ASUS PRIME TRX40 PRO-S */
386 PROFILE_NAME(0x0b05, 0x1918,
387 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
388
389 /* Dell WD15 Dock */
390 PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),
391 /* Dell WD19 Dock */
392 PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),
393
394 DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),
395
396 /*
397 * The original product_name is "USB Sound Device", however this name
398 * is also used by the CM106 based cards, so make it unique.
399 */
400 DEVICE_NAME(0x0d8c, 0x0102, NULL, "ICUSBAUDIO7D"),
401 DEVICE_NAME(0x0d8c, 0x0103, NULL, "Audio Advantage MicroII"),
402
403 /* MSI TRX40 Creator */
404 PROFILE_NAME(0x0db0, 0x0d64,
405 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
406 /* MSI TRX40 */
407 PROFILE_NAME(0x0db0, 0x543d,
408 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
409
410 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
411 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
412 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
413
414 /* aka. Serato Scratch Live DJ Box */
415 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
416
417 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
418 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
419 "Lenovo-ThinkStation-P620-Rear"),
420 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
421 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
422 "Lenovo-ThinkStation-P620-Main"),
423
424 /* Asrock TRX40 Creator */
425 PROFILE_NAME(0x26ce, 0x0a01,
426 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
427
428 { } /* terminator */
429 };
430
431 static const struct usb_audio_device_name *
lookup_device_name(u32 id)432 lookup_device_name(u32 id)
433 {
434 static const struct usb_audio_device_name *p;
435
436 for (p = usb_audio_names; p->id; p++)
437 if (p->id == id)
438 return p;
439 return NULL;
440 }
441
442 /*
443 * free the chip instance
444 *
445 * here we have to do not much, since pcm and controls are already freed
446 *
447 */
448
snd_usb_audio_free(struct snd_card * card)449 static void snd_usb_audio_free(struct snd_card *card)
450 {
451 struct snd_usb_audio *chip = card->private_data;
452 struct snd_usb_endpoint *ep, *n;
453
454 list_for_each_entry_safe(ep, n, &chip->ep_list, list)
455 snd_usb_endpoint_free(ep);
456
457 mutex_destroy(&chip->mutex);
458 if (!atomic_read(&chip->shutdown))
459 dev_set_drvdata(&chip->dev->dev, NULL);
460 }
461
usb_audio_make_shortname(struct usb_device * dev,struct snd_usb_audio * chip,const struct snd_usb_audio_quirk * quirk)462 static 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 strlcpy(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
usb_audio_make_longname(struct usb_device * dev,struct snd_usb_audio * chip,const struct snd_usb_audio_quirk * quirk)493 static 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 strlcpy(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 if (s && *s) {
517 len = strlcpy(card->longname, s, sizeof(card->longname));
518 } else {
519 /* retrieve the vendor and device strings as longname */
520 if (dev->descriptor.iManufacturer)
521 len = usb_string(dev, dev->descriptor.iManufacturer,
522 card->longname, sizeof(card->longname));
523 else
524 len = 0;
525 /* we don't really care if there isn't any vendor string */
526 }
527 if (len > 0) {
528 strim(card->longname);
529 if (*card->longname)
530 strlcat(card->longname, " ", sizeof(card->longname));
531 }
532
533 strlcat(card->longname, card->shortname, sizeof(card->longname));
534
535 len = strlcat(card->longname, " at ", sizeof(card->longname));
536
537 if (len < sizeof(card->longname))
538 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
539
540 switch (snd_usb_get_speed(dev)) {
541 case USB_SPEED_LOW:
542 strlcat(card->longname, ", low speed", sizeof(card->longname));
543 break;
544 case USB_SPEED_FULL:
545 strlcat(card->longname, ", full speed", sizeof(card->longname));
546 break;
547 case USB_SPEED_HIGH:
548 strlcat(card->longname, ", high speed", sizeof(card->longname));
549 break;
550 case USB_SPEED_SUPER:
551 strlcat(card->longname, ", super speed", sizeof(card->longname));
552 break;
553 case USB_SPEED_SUPER_PLUS:
554 strlcat(card->longname, ", super speed plus", sizeof(card->longname));
555 break;
556 default:
557 break;
558 }
559 }
560
561 /*
562 * create a chip instance and set its names.
563 */
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)564 static int snd_usb_audio_create(struct usb_interface *intf,
565 struct usb_device *dev, int idx,
566 const struct snd_usb_audio_quirk *quirk,
567 unsigned int usb_id,
568 struct snd_usb_audio **rchip)
569 {
570 struct snd_card *card;
571 struct snd_usb_audio *chip;
572 int err;
573 char component[14];
574
575 *rchip = NULL;
576
577 switch (snd_usb_get_speed(dev)) {
578 case USB_SPEED_LOW:
579 case USB_SPEED_FULL:
580 case USB_SPEED_HIGH:
581 case USB_SPEED_WIRELESS:
582 case USB_SPEED_SUPER:
583 case USB_SPEED_SUPER_PLUS:
584 break;
585 default:
586 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
587 return -ENXIO;
588 }
589
590 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
591 sizeof(*chip), &card);
592 if (err < 0) {
593 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
594 return err;
595 }
596
597 chip = card->private_data;
598 mutex_init(&chip->mutex);
599 init_waitqueue_head(&chip->shutdown_wait);
600 chip->index = idx;
601 chip->dev = dev;
602 chip->card = card;
603 chip->setup = device_setup[idx];
604 chip->autoclock = autoclock;
605 atomic_set(&chip->active, 1); /* avoid autopm during probing */
606 atomic_set(&chip->usage_count, 0);
607 atomic_set(&chip->shutdown, 0);
608
609 chip->usb_id = usb_id;
610 INIT_LIST_HEAD(&chip->pcm_list);
611 INIT_LIST_HEAD(&chip->ep_list);
612 INIT_LIST_HEAD(&chip->midi_list);
613 INIT_LIST_HEAD(&chip->mixer_list);
614
615 card->private_free = snd_usb_audio_free;
616
617 strcpy(card->driver, "USB-Audio");
618 sprintf(component, "USB%04x:%04x",
619 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
620 snd_component_add(card, component);
621
622 usb_audio_make_shortname(dev, chip, quirk);
623 usb_audio_make_longname(dev, chip, quirk);
624
625 snd_usb_audio_create_proc(chip);
626
627 *rchip = chip;
628 return 0;
629 }
630
631 /* look for a matching quirk alias id */
get_alias_id(struct usb_device * dev,unsigned int * id)632 static bool get_alias_id(struct usb_device *dev, unsigned int *id)
633 {
634 int i;
635 unsigned int src, dst;
636
637 for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
638 if (!quirk_alias[i] ||
639 sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
640 src != *id)
641 continue;
642 dev_info(&dev->dev,
643 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
644 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
645 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
646 *id = dst;
647 return true;
648 }
649
650 return false;
651 }
652
check_delayed_register_option(struct snd_usb_audio * chip,int iface)653 static bool check_delayed_register_option(struct snd_usb_audio *chip, int iface)
654 {
655 int i;
656 unsigned int id, inum;
657
658 for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {
659 if (delayed_register[i] &&
660 sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&
661 id == chip->usb_id)
662 return inum != iface;
663 }
664
665 return false;
666 }
667
668 static const struct usb_device_id usb_audio_ids[]; /* defined below */
669
670 /* look for the corresponding quirk */
671 static const struct snd_usb_audio_quirk *
get_alias_quirk(struct usb_device * dev,unsigned int id)672 get_alias_quirk(struct usb_device *dev, unsigned int id)
673 {
674 const struct usb_device_id *p;
675
676 for (p = usb_audio_ids; p->match_flags; p++) {
677 /* FIXME: this checks only vendor:product pair in the list */
678 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
679 USB_DEVICE_ID_MATCH_DEVICE &&
680 p->idVendor == USB_ID_VENDOR(id) &&
681 p->idProduct == USB_ID_PRODUCT(id))
682 return (const struct snd_usb_audio_quirk *)p->driver_info;
683 }
684
685 return NULL;
686 }
687
688 /*
689 * probe the active usb device
690 *
691 * note that this can be called multiple times per a device, when it
692 * includes multiple audio control interfaces.
693 *
694 * thus we check the usb device pointer and creates the card instance
695 * only at the first time. the successive calls of this function will
696 * append the pcm interface to the corresponding card.
697 */
usb_audio_probe(struct usb_interface * intf,const struct usb_device_id * usb_id)698 static int usb_audio_probe(struct usb_interface *intf,
699 const struct usb_device_id *usb_id)
700 {
701 struct usb_device *dev = interface_to_usbdev(intf);
702 const struct snd_usb_audio_quirk *quirk =
703 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
704 struct snd_usb_audio *chip;
705 int i, err;
706 struct usb_host_interface *alts;
707 int ifnum;
708 u32 id;
709
710 alts = &intf->altsetting[0];
711 ifnum = get_iface_desc(alts)->bInterfaceNumber;
712 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
713 le16_to_cpu(dev->descriptor.idProduct));
714 if (get_alias_id(dev, &id))
715 quirk = get_alias_quirk(dev, id);
716 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
717 return -ENXIO;
718
719 err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
720 if (err < 0)
721 return err;
722
723 /*
724 * found a config. now register to ALSA
725 */
726
727 /* check whether it's already registered */
728 chip = NULL;
729 mutex_lock(®ister_mutex);
730 for (i = 0; i < SNDRV_CARDS; i++) {
731 if (usb_chip[i] && usb_chip[i]->dev == dev) {
732 if (atomic_read(&usb_chip[i]->shutdown)) {
733 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
734 err = -EIO;
735 goto __error;
736 }
737 chip = usb_chip[i];
738 atomic_inc(&chip->active); /* avoid autopm */
739 break;
740 }
741 }
742 if (! chip) {
743 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
744 if (err < 0)
745 goto __error;
746
747 /* it's a fresh one.
748 * now look for an empty slot and create a new card instance
749 */
750 for (i = 0; i < SNDRV_CARDS; i++)
751 if (!usb_chip[i] &&
752 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
753 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
754 if (enable[i]) {
755 err = snd_usb_audio_create(intf, dev, i, quirk,
756 id, &chip);
757 if (err < 0)
758 goto __error;
759 break;
760 } else if (vid[i] != -1 || pid[i] != -1) {
761 dev_info(&dev->dev,
762 "device (%04x:%04x) is disabled\n",
763 USB_ID_VENDOR(id),
764 USB_ID_PRODUCT(id));
765 err = -ENOENT;
766 goto __error;
767 }
768 }
769 if (!chip) {
770 dev_err(&dev->dev, "no available usb audio device\n");
771 err = -ENODEV;
772 goto __error;
773 }
774 }
775
776 if (chip->num_interfaces >= MAX_CARD_INTERFACES) {
777 dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");
778 err = -EINVAL;
779 goto __error;
780 }
781
782 dev_set_drvdata(&dev->dev, chip);
783
784 /*
785 * For devices with more than one control interface, we assume the
786 * first contains the audio controls. We might need a more specific
787 * check here in the future.
788 */
789 if (!chip->ctrl_intf)
790 chip->ctrl_intf = alts;
791
792 chip->txfr_quirk = 0;
793 err = 1; /* continue */
794 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
795 /* need some special handlings */
796 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
797 if (err < 0)
798 goto __error;
799 }
800
801 if (err > 0) {
802 /* create normal USB audio interfaces */
803 err = snd_usb_create_streams(chip, ifnum);
804 if (err < 0)
805 goto __error;
806 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
807 if (err < 0)
808 goto __error;
809 }
810
811 if (chip->need_delayed_register) {
812 dev_info(&dev->dev,
813 "Found post-registration device assignment: %08x:%02x\n",
814 chip->usb_id, ifnum);
815 chip->need_delayed_register = false; /* clear again */
816 }
817
818 /* we are allowed to call snd_card_register() many times, but first
819 * check to see if a device needs to skip it or do anything special
820 */
821 if (!snd_usb_registration_quirk(chip, ifnum) &&
822 !check_delayed_register_option(chip, ifnum)) {
823 err = snd_card_register(chip->card);
824 if (err < 0)
825 goto __error;
826 }
827
828 if (quirk && quirk->shares_media_device) {
829 /* don't want to fail when snd_media_device_create() fails */
830 snd_media_device_create(chip, intf);
831 }
832
833 if (quirk)
834 chip->quirk_type = quirk->type;
835
836 usb_chip[chip->index] = chip;
837 chip->intf[chip->num_interfaces] = intf;
838 chip->num_interfaces++;
839 usb_set_intfdata(intf, chip);
840 atomic_dec(&chip->active);
841 mutex_unlock(®ister_mutex);
842 return 0;
843
844 __error:
845 if (chip) {
846 /* chip->active is inside the chip->card object,
847 * decrement before memory is possibly returned.
848 */
849 atomic_dec(&chip->active);
850 if (!chip->num_interfaces)
851 snd_card_free(chip->card);
852 }
853 mutex_unlock(®ister_mutex);
854 return err;
855 }
856
857 /*
858 * we need to take care of counter, since disconnection can be called also
859 * many times as well as usb_audio_probe().
860 */
usb_audio_disconnect(struct usb_interface * intf)861 static void usb_audio_disconnect(struct usb_interface *intf)
862 {
863 struct snd_usb_audio *chip = usb_get_intfdata(intf);
864 struct snd_card *card;
865 struct list_head *p;
866
867 if (chip == USB_AUDIO_IFACE_UNUSED)
868 return;
869
870 card = chip->card;
871
872 mutex_lock(®ister_mutex);
873 if (atomic_inc_return(&chip->shutdown) == 1) {
874 struct snd_usb_stream *as;
875 struct snd_usb_endpoint *ep;
876 struct usb_mixer_interface *mixer;
877
878 /* wait until all pending tasks done;
879 * they are protected by snd_usb_lock_shutdown()
880 */
881 wait_event(chip->shutdown_wait,
882 !atomic_read(&chip->usage_count));
883 snd_card_disconnect(card);
884 /* release the pcm resources */
885 list_for_each_entry(as, &chip->pcm_list, list) {
886 snd_usb_stream_disconnect(as);
887 }
888 /* release the endpoint resources */
889 list_for_each_entry(ep, &chip->ep_list, list) {
890 snd_usb_endpoint_release(ep);
891 }
892 /* release the midi resources */
893 list_for_each(p, &chip->midi_list) {
894 snd_usbmidi_disconnect(p);
895 }
896 /*
897 * Nice to check quirk && quirk->shares_media_device and
898 * then call the snd_media_device_delete(). Don't have
899 * access to the quirk here. snd_media_device_delete()
900 * accesses mixer_list
901 */
902 snd_media_device_delete(chip);
903
904 /* release mixer resources */
905 list_for_each_entry(mixer, &chip->mixer_list, list) {
906 snd_usb_mixer_disconnect(mixer);
907 }
908 }
909
910 if (chip->quirk_type == QUIRK_SETUP_DISABLE_AUTOSUSPEND)
911 usb_enable_autosuspend(interface_to_usbdev(intf));
912
913 chip->num_interfaces--;
914 if (chip->num_interfaces <= 0) {
915 usb_chip[chip->index] = NULL;
916 mutex_unlock(®ister_mutex);
917 snd_card_free_when_closed(card);
918 } else {
919 mutex_unlock(®ister_mutex);
920 }
921 }
922
923 /* lock the shutdown (disconnect) task and autoresume */
snd_usb_lock_shutdown(struct snd_usb_audio * chip)924 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
925 {
926 int err;
927
928 atomic_inc(&chip->usage_count);
929 if (atomic_read(&chip->shutdown)) {
930 err = -EIO;
931 goto error;
932 }
933 err = snd_usb_autoresume(chip);
934 if (err < 0)
935 goto error;
936 return 0;
937
938 error:
939 if (atomic_dec_and_test(&chip->usage_count))
940 wake_up(&chip->shutdown_wait);
941 return err;
942 }
943
944 /* autosuspend and unlock the shutdown */
snd_usb_unlock_shutdown(struct snd_usb_audio * chip)945 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
946 {
947 snd_usb_autosuspend(chip);
948 if (atomic_dec_and_test(&chip->usage_count))
949 wake_up(&chip->shutdown_wait);
950 }
951
952 #ifdef CONFIG_PM
953
snd_usb_autoresume(struct snd_usb_audio * chip)954 int snd_usb_autoresume(struct snd_usb_audio *chip)
955 {
956 int i, err;
957
958 if (atomic_read(&chip->shutdown))
959 return -EIO;
960 if (atomic_inc_return(&chip->active) != 1)
961 return 0;
962
963 for (i = 0; i < chip->num_interfaces; i++) {
964 err = usb_autopm_get_interface(chip->intf[i]);
965 if (err < 0) {
966 /* rollback */
967 while (--i >= 0)
968 usb_autopm_put_interface(chip->intf[i]);
969 atomic_dec(&chip->active);
970 return err;
971 }
972 }
973 return 0;
974 }
975
snd_usb_autosuspend(struct snd_usb_audio * chip)976 void snd_usb_autosuspend(struct snd_usb_audio *chip)
977 {
978 int i;
979
980 if (atomic_read(&chip->shutdown))
981 return;
982 if (!atomic_dec_and_test(&chip->active))
983 return;
984
985 for (i = 0; i < chip->num_interfaces; i++)
986 usb_autopm_put_interface(chip->intf[i]);
987 }
988
usb_audio_suspend(struct usb_interface * intf,pm_message_t message)989 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
990 {
991 struct snd_usb_audio *chip = usb_get_intfdata(intf);
992 struct snd_usb_stream *as;
993 struct usb_mixer_interface *mixer;
994 struct list_head *p;
995
996 if (chip == USB_AUDIO_IFACE_UNUSED)
997 return 0;
998
999 if (!chip->num_suspended_intf++) {
1000 list_for_each_entry(as, &chip->pcm_list, list) {
1001 snd_usb_pcm_suspend(as);
1002 as->substream[0].need_setup_ep =
1003 as->substream[1].need_setup_ep = true;
1004 }
1005 list_for_each(p, &chip->midi_list)
1006 snd_usbmidi_suspend(p);
1007 list_for_each_entry(mixer, &chip->mixer_list, list)
1008 snd_usb_mixer_suspend(mixer);
1009 }
1010
1011 if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
1012 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
1013 chip->system_suspend = chip->num_suspended_intf;
1014 }
1015
1016 return 0;
1017 }
1018
__usb_audio_resume(struct usb_interface * intf,bool reset_resume)1019 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
1020 {
1021 struct snd_usb_audio *chip = usb_get_intfdata(intf);
1022 struct snd_usb_stream *as;
1023 struct usb_mixer_interface *mixer;
1024 struct list_head *p;
1025 int err = 0;
1026
1027 if (chip == USB_AUDIO_IFACE_UNUSED)
1028 return 0;
1029
1030 atomic_inc(&chip->active); /* avoid autopm */
1031 if (chip->num_suspended_intf > 1)
1032 goto out;
1033
1034 list_for_each_entry(as, &chip->pcm_list, list) {
1035 err = snd_usb_pcm_resume(as);
1036 if (err < 0)
1037 goto err_out;
1038 }
1039
1040 /*
1041 * ALSA leaves material resumption to user space
1042 * we just notify and restart the mixers
1043 */
1044 list_for_each_entry(mixer, &chip->mixer_list, list) {
1045 err = snd_usb_mixer_resume(mixer, reset_resume);
1046 if (err < 0)
1047 goto err_out;
1048 }
1049
1050 list_for_each(p, &chip->midi_list) {
1051 snd_usbmidi_resume(p);
1052 }
1053
1054 out:
1055 if (chip->num_suspended_intf == chip->system_suspend) {
1056 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
1057 chip->system_suspend = 0;
1058 }
1059 chip->num_suspended_intf--;
1060
1061 err_out:
1062 atomic_dec(&chip->active); /* allow autopm after this point */
1063 return err;
1064 }
1065
usb_audio_resume(struct usb_interface * intf)1066 static int usb_audio_resume(struct usb_interface *intf)
1067 {
1068 return __usb_audio_resume(intf, false);
1069 }
1070
usb_audio_reset_resume(struct usb_interface * intf)1071 static int usb_audio_reset_resume(struct usb_interface *intf)
1072 {
1073 return __usb_audio_resume(intf, true);
1074 }
1075 #else
1076 #define usb_audio_suspend NULL
1077 #define usb_audio_resume NULL
1078 #define usb_audio_reset_resume NULL
1079 #endif /* CONFIG_PM */
1080
1081 static const struct usb_device_id usb_audio_ids [] = {
1082 #include "quirks-table.h"
1083 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1084 .bInterfaceClass = USB_CLASS_AUDIO,
1085 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
1086 { } /* Terminating entry */
1087 };
1088 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
1089
1090 /*
1091 * entry point for linux usb interface
1092 */
1093
1094 static struct usb_driver usb_audio_driver = {
1095 .name = "snd-usb-audio",
1096 .probe = usb_audio_probe,
1097 .disconnect = usb_audio_disconnect,
1098 .suspend = usb_audio_suspend,
1099 .resume = usb_audio_resume,
1100 .reset_resume = usb_audio_reset_resume,
1101 .id_table = usb_audio_ids,
1102 .supports_autosuspend = 1,
1103 };
1104
1105 module_usb_driver(usb_audio_driver);
1106