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