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 "midi2.h"
48 #include "mixer.h"
49 #include "proc.h"
50 #include "quirks.h"
51 #include "endpoint.h"
52 #include "helper.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
63 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
64 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
65 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
66 /* Vendor/product IDs for this card */
67 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
68 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
69 static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
70 static bool ignore_ctl_error;
71 static bool autoclock = true;
72 static bool lowlatency = true;
73 static char *quirk_alias[SNDRV_CARDS];
74 static char *delayed_register[SNDRV_CARDS];
75 static bool implicit_fb[SNDRV_CARDS];
76 static unsigned int quirk_flags[SNDRV_CARDS];
77
78 bool snd_usb_use_vmalloc = true;
79 bool snd_usb_skip_validation;
80
81 module_param_array(index, int, NULL, 0444);
82 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
83 module_param_array(id, charp, NULL, 0444);
84 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
85 module_param_array(enable, bool, NULL, 0444);
86 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
87 module_param_array(vid, int, NULL, 0444);
88 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
89 module_param_array(pid, int, NULL, 0444);
90 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
91 module_param_array(device_setup, int, NULL, 0444);
92 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
93 module_param(ignore_ctl_error, bool, 0444);
94 MODULE_PARM_DESC(ignore_ctl_error,
95 "Ignore errors from USB controller for mixer interfaces.");
96 module_param(autoclock, bool, 0444);
97 MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
98 module_param(lowlatency, bool, 0444);
99 MODULE_PARM_DESC(lowlatency, "Enable low latency playback (default: yes).");
100 module_param_array(quirk_alias, charp, NULL, 0444);
101 MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");
102 module_param_array(delayed_register, charp, NULL, 0444);
103 MODULE_PARM_DESC(delayed_register, "Quirk for delayed registration, given by id:iface, e.g. 0123abcd:4.");
104 module_param_array(implicit_fb, bool, NULL, 0444);
105 MODULE_PARM_DESC(implicit_fb, "Apply generic implicit feedback sync mode.");
106 module_param_array(quirk_flags, uint, NULL, 0444);
107 MODULE_PARM_DESC(quirk_flags, "Driver quirk bit flags.");
108 module_param_named(use_vmalloc, snd_usb_use_vmalloc, bool, 0444);
109 MODULE_PARM_DESC(use_vmalloc, "Use vmalloc for PCM intermediate buffers (default: yes).");
110 module_param_named(skip_validation, snd_usb_skip_validation, bool, 0444);
111 MODULE_PARM_DESC(skip_validation, "Skip unit descriptor validation (default: no).");
112
113 /*
114 * we keep the snd_usb_audio_t instances by ourselves for merging
115 * the all interfaces on the same card as one sound device.
116 */
117
118 static DEFINE_MUTEX(register_mutex);
119 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
120 static struct usb_driver usb_audio_driver;
121
122 /*
123 * disconnect streams
124 * called from usb_audio_disconnect()
125 */
snd_usb_stream_disconnect(struct snd_usb_stream * as)126 static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
127 {
128 int idx;
129 struct snd_usb_substream *subs;
130
131 for (idx = 0; idx < 2; idx++) {
132 subs = &as->substream[idx];
133 if (!subs->num_formats)
134 continue;
135 subs->data_endpoint = NULL;
136 subs->sync_endpoint = NULL;
137 }
138 }
139
snd_usb_create_stream(struct snd_usb_audio * chip,int ctrlif,int interface)140 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
141 {
142 struct usb_device *dev = chip->dev;
143 struct usb_host_interface *alts;
144 struct usb_interface_descriptor *altsd;
145 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
146
147 if (!iface) {
148 dev_err(&dev->dev, "%u:%d : does not exist\n",
149 ctrlif, interface);
150 return -EINVAL;
151 }
152
153 alts = &iface->altsetting[0];
154 altsd = get_iface_desc(alts);
155
156 /*
157 * Android with both accessory and audio interfaces enabled gets the
158 * interface numbers wrong.
159 */
160 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
161 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
162 interface == 0 &&
163 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
164 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
165 interface = 2;
166 iface = usb_ifnum_to_if(dev, interface);
167 if (!iface)
168 return -EINVAL;
169 alts = &iface->altsetting[0];
170 altsd = get_iface_desc(alts);
171 }
172
173 if (usb_interface_claimed(iface)) {
174 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
175 ctrlif, interface);
176 return -EINVAL;
177 }
178
179 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
180 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
181 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
182 int err = snd_usb_midi_v2_create(chip, iface, 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 */
snd_usb_create_streams(struct snd_usb_audio * chip,int ctrlif)221 static 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 */
343 struct 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 */
357 static 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 /* Dock/Stand for HP Engage Go */
429 PROFILE_NAME(0x103c, 0x830a, "HP", "HP Engage Go Dock",
430 "HP-Engage-Go-Dock"),
431
432 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */
433 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),
434 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),
435
436 /* aka. Serato Scratch Live DJ Box */
437 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),
438
439 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */
440 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",
441 "Lenovo-ThinkStation-P620-Rear"),
442 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */
443 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",
444 "Lenovo-ThinkStation-P620-Main"),
445
446 /* Asrock TRX40 Creator */
447 PROFILE_NAME(0x26ce, 0x0a01,
448 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),
449
450 DEVICE_NAME(0x2040, 0x7200, "Hauppauge", "HVR-950Q"),
451 DEVICE_NAME(0x2040, 0x7201, "Hauppauge", "HVR-950Q-MXL"),
452 DEVICE_NAME(0x2040, 0x7210, "Hauppauge", "HVR-950Q"),
453 DEVICE_NAME(0x2040, 0x7211, "Hauppauge", "HVR-950Q-MXL"),
454 DEVICE_NAME(0x2040, 0x7213, "Hauppauge", "HVR-950Q"),
455 DEVICE_NAME(0x2040, 0x7217, "Hauppauge", "HVR-950Q"),
456 DEVICE_NAME(0x2040, 0x721b, "Hauppauge", "HVR-950Q"),
457 DEVICE_NAME(0x2040, 0x721e, "Hauppauge", "HVR-950Q"),
458 DEVICE_NAME(0x2040, 0x721f, "Hauppauge", "HVR-950Q"),
459 DEVICE_NAME(0x2040, 0x7240, "Hauppauge", "HVR-850"),
460 DEVICE_NAME(0x2040, 0x7260, "Hauppauge", "HVR-950Q"),
461 DEVICE_NAME(0x2040, 0x7270, "Hauppauge", "HVR-950Q"),
462 DEVICE_NAME(0x2040, 0x7280, "Hauppauge", "HVR-950Q"),
463 DEVICE_NAME(0x2040, 0x7281, "Hauppauge", "HVR-950Q-MXL"),
464 DEVICE_NAME(0x2040, 0x8200, "Hauppauge", "Woodbury"),
465
466 { } /* terminator */
467 };
468
469 static const struct usb_audio_device_name *
lookup_device_name(u32 id)470 lookup_device_name(u32 id)
471 {
472 static const struct usb_audio_device_name *p;
473
474 for (p = usb_audio_names; p->id; p++)
475 if (p->id == id)
476 return p;
477 return NULL;
478 }
479
480 /*
481 * free the chip instance
482 *
483 * here we have to do not much, since pcm and controls are already freed
484 *
485 */
486
snd_usb_audio_free(struct snd_card * card)487 static void snd_usb_audio_free(struct snd_card *card)
488 {
489 struct snd_usb_audio *chip = card->private_data;
490
491 snd_usb_endpoint_free_all(chip);
492 snd_usb_midi_v2_free_all(chip);
493
494 mutex_destroy(&chip->mutex);
495 if (!atomic_read(&chip->shutdown))
496 dev_set_drvdata(&chip->dev->dev, NULL);
497 }
498
usb_audio_make_shortname(struct usb_device * dev,struct snd_usb_audio * chip,const struct snd_usb_audio_quirk * quirk)499 static void usb_audio_make_shortname(struct usb_device *dev,
500 struct snd_usb_audio *chip,
501 const struct snd_usb_audio_quirk *quirk)
502 {
503 struct snd_card *card = chip->card;
504 const struct usb_audio_device_name *preset;
505 const char *s = NULL;
506
507 preset = lookup_device_name(chip->usb_id);
508 if (preset && preset->product_name)
509 s = preset->product_name;
510 else if (quirk && quirk->product_name)
511 s = quirk->product_name;
512 if (s && *s) {
513 strscpy(card->shortname, s, sizeof(card->shortname));
514 return;
515 }
516
517 /* retrieve the device string as shortname */
518 if (!dev->descriptor.iProduct ||
519 usb_string(dev, dev->descriptor.iProduct,
520 card->shortname, sizeof(card->shortname)) <= 0) {
521 /* no name available from anywhere, so use ID */
522 sprintf(card->shortname, "USB Device %#04x:%#04x",
523 USB_ID_VENDOR(chip->usb_id),
524 USB_ID_PRODUCT(chip->usb_id));
525 }
526
527 strim(card->shortname);
528 }
529
usb_audio_make_longname(struct usb_device * dev,struct snd_usb_audio * chip,const struct snd_usb_audio_quirk * quirk)530 static void usb_audio_make_longname(struct usb_device *dev,
531 struct snd_usb_audio *chip,
532 const struct snd_usb_audio_quirk *quirk)
533 {
534 struct snd_card *card = chip->card;
535 const struct usb_audio_device_name *preset;
536 const char *s = NULL;
537 int len;
538
539 preset = lookup_device_name(chip->usb_id);
540
541 /* shortcut - if any pre-defined string is given, use it */
542 if (preset && preset->profile_name)
543 s = preset->profile_name;
544 if (s && *s) {
545 strscpy(card->longname, s, sizeof(card->longname));
546 return;
547 }
548
549 if (preset && preset->vendor_name)
550 s = preset->vendor_name;
551 else if (quirk && quirk->vendor_name)
552 s = quirk->vendor_name;
553 *card->longname = 0;
554 if (s && *s) {
555 strscpy(card->longname, s, sizeof(card->longname));
556 } else {
557 /* retrieve the vendor and device strings as longname */
558 if (dev->descriptor.iManufacturer)
559 usb_string(dev, dev->descriptor.iManufacturer,
560 card->longname, sizeof(card->longname));
561 /* we don't really care if there isn't any vendor string */
562 }
563 if (*card->longname) {
564 strim(card->longname);
565 if (*card->longname)
566 strlcat(card->longname, " ", sizeof(card->longname));
567 }
568
569 strlcat(card->longname, card->shortname, sizeof(card->longname));
570
571 len = strlcat(card->longname, " at ", sizeof(card->longname));
572
573 if (len < sizeof(card->longname))
574 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
575
576 switch (snd_usb_get_speed(dev)) {
577 case USB_SPEED_LOW:
578 strlcat(card->longname, ", low speed", sizeof(card->longname));
579 break;
580 case USB_SPEED_FULL:
581 strlcat(card->longname, ", full speed", sizeof(card->longname));
582 break;
583 case USB_SPEED_HIGH:
584 strlcat(card->longname, ", high speed", sizeof(card->longname));
585 break;
586 case USB_SPEED_SUPER:
587 strlcat(card->longname, ", super speed", sizeof(card->longname));
588 break;
589 case USB_SPEED_SUPER_PLUS:
590 strlcat(card->longname, ", super speed plus", sizeof(card->longname));
591 break;
592 default:
593 break;
594 }
595 }
596
597 /*
598 * create a chip instance and set its names.
599 */
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)600 static int snd_usb_audio_create(struct usb_interface *intf,
601 struct usb_device *dev, int idx,
602 const struct snd_usb_audio_quirk *quirk,
603 unsigned int usb_id,
604 struct snd_usb_audio **rchip)
605 {
606 struct snd_card *card;
607 struct snd_usb_audio *chip;
608 int err;
609 char component[14];
610
611 *rchip = NULL;
612
613 switch (snd_usb_get_speed(dev)) {
614 case USB_SPEED_LOW:
615 case USB_SPEED_FULL:
616 case USB_SPEED_HIGH:
617 case USB_SPEED_SUPER:
618 case USB_SPEED_SUPER_PLUS:
619 break;
620 default:
621 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
622 return -ENXIO;
623 }
624
625 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
626 sizeof(*chip), &card);
627 if (err < 0) {
628 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
629 return err;
630 }
631
632 chip = card->private_data;
633 mutex_init(&chip->mutex);
634 init_waitqueue_head(&chip->shutdown_wait);
635 chip->index = idx;
636 chip->dev = dev;
637 chip->card = card;
638 chip->setup = device_setup[idx];
639 chip->generic_implicit_fb = implicit_fb[idx];
640 chip->autoclock = autoclock;
641 chip->lowlatency = lowlatency;
642 atomic_set(&chip->active, 1); /* avoid autopm during probing */
643 atomic_set(&chip->usage_count, 0);
644 atomic_set(&chip->shutdown, 0);
645
646 chip->usb_id = usb_id;
647 INIT_LIST_HEAD(&chip->pcm_list);
648 INIT_LIST_HEAD(&chip->ep_list);
649 INIT_LIST_HEAD(&chip->iface_ref_list);
650 INIT_LIST_HEAD(&chip->clock_ref_list);
651 INIT_LIST_HEAD(&chip->midi_list);
652 INIT_LIST_HEAD(&chip->midi_v2_list);
653 INIT_LIST_HEAD(&chip->mixer_list);
654
655 if (quirk_flags[idx])
656 chip->quirk_flags = quirk_flags[idx];
657 else
658 snd_usb_init_quirk_flags(chip);
659
660 card->private_free = snd_usb_audio_free;
661
662 strcpy(card->driver, "USB-Audio");
663 sprintf(component, "USB%04x:%04x",
664 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
665 snd_component_add(card, component);
666
667 usb_audio_make_shortname(dev, chip, quirk);
668 usb_audio_make_longname(dev, chip, quirk);
669
670 snd_usb_audio_create_proc(chip);
671
672 *rchip = chip;
673 return 0;
674 }
675
676 /* look for a matching quirk alias id */
get_alias_id(struct usb_device * dev,unsigned int * id)677 static bool get_alias_id(struct usb_device *dev, unsigned int *id)
678 {
679 int i;
680 unsigned int src, dst;
681
682 for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
683 if (!quirk_alias[i] ||
684 sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
685 src != *id)
686 continue;
687 dev_info(&dev->dev,
688 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
689 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
690 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
691 *id = dst;
692 return true;
693 }
694
695 return false;
696 }
697
check_delayed_register_option(struct snd_usb_audio * chip)698 static int check_delayed_register_option(struct snd_usb_audio *chip)
699 {
700 int i;
701 unsigned int id, inum;
702
703 for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {
704 if (delayed_register[i] &&
705 sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&
706 id == chip->usb_id)
707 return inum;
708 }
709
710 return -1;
711 }
712
713 static const struct usb_device_id usb_audio_ids[]; /* defined below */
714
715 /* look for the last interface that matches with our ids and remember it */
find_last_interface(struct snd_usb_audio * chip)716 static void find_last_interface(struct snd_usb_audio *chip)
717 {
718 struct usb_host_config *config = chip->dev->actconfig;
719 struct usb_interface *intf;
720 int i;
721
722 if (!config)
723 return;
724 for (i = 0; i < config->desc.bNumInterfaces; i++) {
725 intf = config->interface[i];
726 if (usb_match_id(intf, usb_audio_ids))
727 chip->last_iface = intf->altsetting[0].desc.bInterfaceNumber;
728 }
729 usb_audio_dbg(chip, "Found last interface = %d\n", chip->last_iface);
730 }
731
732 /* look for the corresponding quirk */
733 static const struct snd_usb_audio_quirk *
get_alias_quirk(struct usb_device * dev,unsigned int id)734 get_alias_quirk(struct usb_device *dev, unsigned int id)
735 {
736 const struct usb_device_id *p;
737
738 for (p = usb_audio_ids; p->match_flags; p++) {
739 /* FIXME: this checks only vendor:product pair in the list */
740 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
741 USB_DEVICE_ID_MATCH_DEVICE &&
742 p->idVendor == USB_ID_VENDOR(id) &&
743 p->idProduct == USB_ID_PRODUCT(id))
744 return (const struct snd_usb_audio_quirk *)p->driver_info;
745 }
746
747 return NULL;
748 }
749
750 /* register card if we reach to the last interface or to the specified
751 * one given via option
752 */
try_to_register_card(struct snd_usb_audio * chip,int ifnum)753 static int try_to_register_card(struct snd_usb_audio *chip, int ifnum)
754 {
755 if (check_delayed_register_option(chip) == ifnum ||
756 chip->last_iface == ifnum ||
757 usb_interface_claimed(usb_ifnum_to_if(chip->dev, chip->last_iface)))
758 return snd_card_register(chip->card);
759 return 0;
760 }
761
762 /*
763 * probe the active usb device
764 *
765 * note that this can be called multiple times per a device, when it
766 * includes multiple audio control interfaces.
767 *
768 * thus we check the usb device pointer and creates the card instance
769 * only at the first time. the successive calls of this function will
770 * append the pcm interface to the corresponding card.
771 */
usb_audio_probe(struct usb_interface * intf,const struct usb_device_id * usb_id)772 static int usb_audio_probe(struct usb_interface *intf,
773 const struct usb_device_id *usb_id)
774 {
775 struct usb_device *dev = interface_to_usbdev(intf);
776 const struct snd_usb_audio_quirk *quirk =
777 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
778 struct snd_usb_audio *chip;
779 int i, err;
780 struct usb_host_interface *alts;
781 int ifnum;
782 u32 id;
783
784 alts = &intf->altsetting[0];
785 ifnum = get_iface_desc(alts)->bInterfaceNumber;
786 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
787 le16_to_cpu(dev->descriptor.idProduct));
788 if (get_alias_id(dev, &id))
789 quirk = get_alias_quirk(dev, id);
790 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
791 return -ENXIO;
792 if (quirk && quirk->ifnum == QUIRK_NODEV_INTERFACE)
793 return -ENODEV;
794
795 err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
796 if (err < 0)
797 return err;
798
799 /*
800 * found a config. now register to ALSA
801 */
802
803 /* check whether it's already registered */
804 chip = NULL;
805 mutex_lock(®ister_mutex);
806 for (i = 0; i < SNDRV_CARDS; i++) {
807 if (usb_chip[i] && usb_chip[i]->dev == dev) {
808 if (atomic_read(&usb_chip[i]->shutdown)) {
809 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
810 err = -EIO;
811 goto __error;
812 }
813 chip = usb_chip[i];
814 atomic_inc(&chip->active); /* avoid autopm */
815 break;
816 }
817 }
818 if (! chip) {
819 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
820 if (err < 0)
821 goto __error;
822
823 /* it's a fresh one.
824 * now look for an empty slot and create a new card instance
825 */
826 for (i = 0; i < SNDRV_CARDS; i++)
827 if (!usb_chip[i] &&
828 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
829 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
830 if (enable[i]) {
831 err = snd_usb_audio_create(intf, dev, i, quirk,
832 id, &chip);
833 if (err < 0)
834 goto __error;
835 break;
836 } else if (vid[i] != -1 || pid[i] != -1) {
837 dev_info(&dev->dev,
838 "device (%04x:%04x) is disabled\n",
839 USB_ID_VENDOR(id),
840 USB_ID_PRODUCT(id));
841 err = -ENOENT;
842 goto __error;
843 }
844 }
845 if (!chip) {
846 dev_err(&dev->dev, "no available usb audio device\n");
847 err = -ENODEV;
848 goto __error;
849 }
850 find_last_interface(chip);
851 }
852
853 if (chip->num_interfaces >= MAX_CARD_INTERFACES) {
854 dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");
855 err = -EINVAL;
856 goto __error;
857 }
858
859 dev_set_drvdata(&dev->dev, chip);
860
861 if (ignore_ctl_error)
862 chip->quirk_flags |= QUIRK_FLAG_IGNORE_CTL_ERROR;
863
864 if (chip->quirk_flags & QUIRK_FLAG_DISABLE_AUTOSUSPEND)
865 usb_disable_autosuspend(interface_to_usbdev(intf));
866
867 /*
868 * For devices with more than one control interface, we assume the
869 * first contains the audio controls. We might need a more specific
870 * check here in the future.
871 */
872 if (!chip->ctrl_intf)
873 chip->ctrl_intf = alts;
874
875 err = 1; /* continue */
876 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
877 /* need some special handlings */
878 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
879 if (err < 0)
880 goto __error;
881 }
882
883 if (err > 0) {
884 /* create normal USB audio interfaces */
885 err = snd_usb_create_streams(chip, ifnum);
886 if (err < 0)
887 goto __error;
888 err = snd_usb_create_mixer(chip, ifnum);
889 if (err < 0)
890 goto __error;
891 }
892
893 if (chip->need_delayed_register) {
894 dev_info(&dev->dev,
895 "Found post-registration device assignment: %08x:%02x\n",
896 chip->usb_id, ifnum);
897 chip->need_delayed_register = false; /* clear again */
898 }
899
900 err = try_to_register_card(chip, ifnum);
901 if (err < 0)
902 goto __error_no_register;
903
904 if (chip->quirk_flags & QUIRK_FLAG_SHARE_MEDIA_DEVICE) {
905 /* don't want to fail when snd_media_device_create() fails */
906 snd_media_device_create(chip, intf);
907 }
908
909 if (quirk)
910 chip->quirk_type = quirk->type;
911
912 usb_chip[chip->index] = chip;
913 chip->intf[chip->num_interfaces] = intf;
914 chip->num_interfaces++;
915 usb_set_intfdata(intf, chip);
916 atomic_dec(&chip->active);
917 mutex_unlock(®ister_mutex);
918 return 0;
919
920 __error:
921 /* in the case of error in secondary interface, still try to register */
922 if (chip)
923 try_to_register_card(chip, ifnum);
924
925 __error_no_register:
926 if (chip) {
927 /* chip->active is inside the chip->card object,
928 * decrement before memory is possibly returned.
929 */
930 atomic_dec(&chip->active);
931 if (!chip->num_interfaces)
932 snd_card_free(chip->card);
933 }
934 mutex_unlock(®ister_mutex);
935 return err;
936 }
937
938 /*
939 * we need to take care of counter, since disconnection can be called also
940 * many times as well as usb_audio_probe().
941 */
usb_audio_disconnect(struct usb_interface * intf)942 static void usb_audio_disconnect(struct usb_interface *intf)
943 {
944 struct snd_usb_audio *chip = usb_get_intfdata(intf);
945 struct snd_card *card;
946 struct list_head *p;
947
948 if (chip == USB_AUDIO_IFACE_UNUSED)
949 return;
950
951 card = chip->card;
952
953 mutex_lock(®ister_mutex);
954 if (atomic_inc_return(&chip->shutdown) == 1) {
955 struct snd_usb_stream *as;
956 struct snd_usb_endpoint *ep;
957 struct usb_mixer_interface *mixer;
958
959 /* wait until all pending tasks done;
960 * they are protected by snd_usb_lock_shutdown()
961 */
962 wait_event(chip->shutdown_wait,
963 !atomic_read(&chip->usage_count));
964 snd_card_disconnect(card);
965 /* release the pcm resources */
966 list_for_each_entry(as, &chip->pcm_list, list) {
967 snd_usb_stream_disconnect(as);
968 }
969 /* release the endpoint resources */
970 list_for_each_entry(ep, &chip->ep_list, list) {
971 snd_usb_endpoint_release(ep);
972 }
973 /* release the midi resources */
974 list_for_each(p, &chip->midi_list) {
975 snd_usbmidi_disconnect(p);
976 }
977 snd_usb_midi_v2_disconnect_all(chip);
978 /*
979 * Nice to check quirk && quirk->shares_media_device and
980 * then call the snd_media_device_delete(). Don't have
981 * access to the quirk here. snd_media_device_delete()
982 * accesses mixer_list
983 */
984 snd_media_device_delete(chip);
985
986 /* release mixer resources */
987 list_for_each_entry(mixer, &chip->mixer_list, list) {
988 snd_usb_mixer_disconnect(mixer);
989 }
990 }
991
992 if (chip->quirk_flags & QUIRK_FLAG_DISABLE_AUTOSUSPEND)
993 usb_enable_autosuspend(interface_to_usbdev(intf));
994
995 chip->num_interfaces--;
996 if (chip->num_interfaces <= 0) {
997 usb_chip[chip->index] = NULL;
998 mutex_unlock(®ister_mutex);
999 snd_card_free_when_closed(card);
1000 } else {
1001 mutex_unlock(®ister_mutex);
1002 }
1003 }
1004
1005 /* lock the shutdown (disconnect) task and autoresume */
snd_usb_lock_shutdown(struct snd_usb_audio * chip)1006 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
1007 {
1008 int err;
1009
1010 atomic_inc(&chip->usage_count);
1011 if (atomic_read(&chip->shutdown)) {
1012 err = -EIO;
1013 goto error;
1014 }
1015 err = snd_usb_autoresume(chip);
1016 if (err < 0)
1017 goto error;
1018 return 0;
1019
1020 error:
1021 if (atomic_dec_and_test(&chip->usage_count))
1022 wake_up(&chip->shutdown_wait);
1023 return err;
1024 }
1025
1026 /* autosuspend and unlock the shutdown */
snd_usb_unlock_shutdown(struct snd_usb_audio * chip)1027 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
1028 {
1029 snd_usb_autosuspend(chip);
1030 if (atomic_dec_and_test(&chip->usage_count))
1031 wake_up(&chip->shutdown_wait);
1032 }
1033
snd_usb_autoresume(struct snd_usb_audio * chip)1034 int snd_usb_autoresume(struct snd_usb_audio *chip)
1035 {
1036 int i, err;
1037
1038 if (atomic_read(&chip->shutdown))
1039 return -EIO;
1040 if (atomic_inc_return(&chip->active) != 1)
1041 return 0;
1042
1043 for (i = 0; i < chip->num_interfaces; i++) {
1044 err = usb_autopm_get_interface(chip->intf[i]);
1045 if (err < 0) {
1046 /* rollback */
1047 while (--i >= 0)
1048 usb_autopm_put_interface(chip->intf[i]);
1049 atomic_dec(&chip->active);
1050 return err;
1051 }
1052 }
1053 return 0;
1054 }
1055
snd_usb_autosuspend(struct snd_usb_audio * chip)1056 void snd_usb_autosuspend(struct snd_usb_audio *chip)
1057 {
1058 int i;
1059
1060 if (atomic_read(&chip->shutdown))
1061 return;
1062 if (!atomic_dec_and_test(&chip->active))
1063 return;
1064
1065 for (i = 0; i < chip->num_interfaces; i++)
1066 usb_autopm_put_interface(chip->intf[i]);
1067 }
1068
usb_audio_suspend(struct usb_interface * intf,pm_message_t message)1069 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
1070 {
1071 struct snd_usb_audio *chip = usb_get_intfdata(intf);
1072 struct snd_usb_stream *as;
1073 struct snd_usb_endpoint *ep;
1074 struct usb_mixer_interface *mixer;
1075 struct list_head *p;
1076
1077 if (chip == USB_AUDIO_IFACE_UNUSED)
1078 return 0;
1079
1080 if (!chip->num_suspended_intf++) {
1081 list_for_each_entry(as, &chip->pcm_list, list)
1082 snd_usb_pcm_suspend(as);
1083 list_for_each_entry(ep, &chip->ep_list, list)
1084 snd_usb_endpoint_suspend(ep);
1085 list_for_each(p, &chip->midi_list)
1086 snd_usbmidi_suspend(p);
1087 list_for_each_entry(mixer, &chip->mixer_list, list)
1088 snd_usb_mixer_suspend(mixer);
1089 snd_usb_midi_v2_suspend_all(chip);
1090 }
1091
1092 if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
1093 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
1094 chip->system_suspend = chip->num_suspended_intf;
1095 }
1096
1097 return 0;
1098 }
1099
usb_audio_resume(struct usb_interface * intf)1100 static int usb_audio_resume(struct usb_interface *intf)
1101 {
1102 struct snd_usb_audio *chip = usb_get_intfdata(intf);
1103 struct snd_usb_stream *as;
1104 struct usb_mixer_interface *mixer;
1105 struct list_head *p;
1106 int err = 0;
1107
1108 if (chip == USB_AUDIO_IFACE_UNUSED)
1109 return 0;
1110
1111 atomic_inc(&chip->active); /* avoid autopm */
1112 if (chip->num_suspended_intf > 1)
1113 goto out;
1114
1115 list_for_each_entry(as, &chip->pcm_list, list) {
1116 err = snd_usb_pcm_resume(as);
1117 if (err < 0)
1118 goto err_out;
1119 }
1120
1121 /*
1122 * ALSA leaves material resumption to user space
1123 * we just notify and restart the mixers
1124 */
1125 list_for_each_entry(mixer, &chip->mixer_list, list) {
1126 err = snd_usb_mixer_resume(mixer);
1127 if (err < 0)
1128 goto err_out;
1129 }
1130
1131 list_for_each(p, &chip->midi_list) {
1132 snd_usbmidi_resume(p);
1133 }
1134
1135 snd_usb_midi_v2_resume_all(chip);
1136
1137 out:
1138 if (chip->num_suspended_intf == chip->system_suspend) {
1139 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
1140 chip->system_suspend = 0;
1141 }
1142 chip->num_suspended_intf--;
1143
1144 err_out:
1145 atomic_dec(&chip->active); /* allow autopm after this point */
1146 return err;
1147 }
1148
1149 static const struct usb_device_id usb_audio_ids [] = {
1150 #include "quirks-table.h"
1151 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
1152 .bInterfaceClass = USB_CLASS_AUDIO,
1153 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
1154 { } /* Terminating entry */
1155 };
1156 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
1157
1158 /*
1159 * entry point for linux usb interface
1160 */
1161
1162 static struct usb_driver usb_audio_driver = {
1163 .name = "snd-usb-audio",
1164 .probe = usb_audio_probe,
1165 .disconnect = usb_audio_disconnect,
1166 .suspend = usb_audio_suspend,
1167 .resume = usb_audio_resume,
1168 .reset_resume = usb_audio_resume,
1169 .id_table = usb_audio_ids,
1170 .supports_autosuspend = 1,
1171 };
1172
1173 module_usb_driver(usb_audio_driver);
1174