]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - sound/usb/card.c
Merge branch 'pm-qos'
[mirror_ubuntu-jammy-kernel.git] / sound / usb / card.c
CommitLineData
1a59d1b8 1// SPDX-License-Identifier: GPL-2.0-or-later
e5779998
DM
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 *
9a2fe9b8 11 * Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com>
e5779998 12 *
e5779998
DM
13 * NOTES:
14 *
e5779998
DM
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>
3ffc1222 28#include <linux/ctype.h>
e5779998
DM
29#include <linux/usb.h>
30#include <linux/moduleparam.h>
31#include <linux/mutex.h>
32#include <linux/usb/audio.h>
7e847894 33#include <linux/usb/audio-v2.h>
9a2fe9b8 34#include <linux/usb/audio-v3.h>
da155d5b 35#include <linux/module.h>
e5779998 36
9e38658f 37#include <sound/control.h>
e5779998
DM
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"
f0b5e634 47#include "mixer.h"
e5779998
DM
48#include "proc.h"
49#include "quirks.h"
50#include "endpoint.h"
51#include "helper.h"
52#include "debug.h"
53#include "pcm.h"
e5779998 54#include "format.h"
88a8516a 55#include "power.h"
e8e8babf 56#include "stream.h"
66354f18 57#include "media.h"
e5779998
DM
58
59MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
60MODULE_DESCRIPTION("USB Audio");
61MODULE_LICENSE("GPL");
62MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
63
64
65static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
66static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
a67ff6a5 67static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
e5779998
DM
68/* Vendor/product IDs for this card */
69static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
70static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
e5779998 71static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
a67ff6a5 72static bool ignore_ctl_error;
ef02e29b 73static bool autoclock = true;
e2703363 74static char *quirk_alias[SNDRV_CARDS];
e5779998 75
f274baa4 76bool snd_usb_use_vmalloc = true;
f35ef592 77bool snd_usb_skip_validation;
f274baa4 78
e5779998
DM
79module_param_array(index, int, NULL, 0444);
80MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
81module_param_array(id, charp, NULL, 0444);
82MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
83module_param_array(enable, bool, NULL, 0444);
84MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
85module_param_array(vid, int, NULL, 0444);
86MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
87module_param_array(pid, int, NULL, 0444);
88MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
e5779998
DM
89module_param_array(device_setup, int, NULL, 0444);
90MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
91module_param(ignore_ctl_error, bool, 0444);
92MODULE_PARM_DESC(ignore_ctl_error,
93 "Ignore errors from USB controller for mixer interfaces.");
ef02e29b
EZ
94module_param(autoclock, bool, 0444);
95MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
e2703363
TI
96module_param_array(quirk_alias, charp, NULL, 0444);
97MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");
f274baa4
TI
98module_param_named(use_vmalloc, snd_usb_use_vmalloc, bool, 0444);
99MODULE_PARM_DESC(use_vmalloc, "Use vmalloc for PCM intermediate buffers (default: yes).");
f35ef592
TI
100module_param_named(skip_validation, snd_usb_skip_validation, bool, 0444);
101MODULE_PARM_DESC(skip_validation, "Skip unit descriptor validation (default: no).");
e5779998
DM
102
103/*
104 * we keep the snd_usb_audio_t instances by ourselves for merging
105 * the all interfaces on the same card as one sound device.
106 */
107
108static DEFINE_MUTEX(register_mutex);
109static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
110static struct usb_driver usb_audio_driver;
111
112/*
113 * disconnect streams
4c8c3a4f 114 * called from usb_audio_disconnect()
e5779998 115 */
a6cece9d 116static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
e5779998
DM
117{
118 int idx;
e5779998
DM
119 struct snd_usb_substream *subs;
120
e5779998
DM
121 for (idx = 0; idx < 2; idx++) {
122 subs = &as->substream[idx];
123 if (!subs->num_formats)
76195fb0 124 continue;
e5779998 125 subs->interface = -1;
edcd3633
DM
126 subs->data_endpoint = NULL;
127 subs->sync_endpoint = NULL;
e5779998
DM
128 }
129}
130
131static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
132{
133 struct usb_device *dev = chip->dev;
134 struct usb_host_interface *alts;
135 struct usb_interface_descriptor *altsd;
136 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
137
138 if (!iface) {
0ba41d91
TI
139 dev_err(&dev->dev, "%u:%d : does not exist\n",
140 ctrlif, interface);
e5779998
DM
141 return -EINVAL;
142 }
143
342cda29
CL
144 alts = &iface->altsetting[0];
145 altsd = get_iface_desc(alts);
146
147 /*
148 * Android with both accessory and audio interfaces enabled gets the
149 * interface numbers wrong.
150 */
151 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
152 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
153 interface == 0 &&
154 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
155 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
156 interface = 2;
157 iface = usb_ifnum_to_if(dev, interface);
158 if (!iface)
159 return -EINVAL;
160 alts = &iface->altsetting[0];
161 altsd = get_iface_desc(alts);
162 }
163
e5779998 164 if (usb_interface_claimed(iface)) {
0ba41d91
TI
165 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
166 ctrlif, interface);
e5779998
DM
167 return -EINVAL;
168 }
169
e5779998
DM
170 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
171 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
172 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
79289e24
TI
173 int err = __snd_usbmidi_create(chip->card, iface,
174 &chip->midi_list, NULL,
175 chip->usb_id);
e5779998 176 if (err < 0) {
0ba41d91
TI
177 dev_err(&dev->dev,
178 "%u:%d: cannot create sequencer device\n",
179 ctrlif, interface);
e5779998
DM
180 return -EINVAL;
181 }
182 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
183
184 return 0;
185 }
186
187 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
188 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
189 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
0ba41d91
TI
190 dev_dbg(&dev->dev,
191 "%u:%d: skipping non-supported interface %d\n",
192 ctrlif, interface, altsd->bInterfaceClass);
e5779998
DM
193 /* skip non-supported classes */
194 return -EINVAL;
195 }
196
197 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
0ba41d91 198 dev_err(&dev->dev, "low speed audio streaming not supported\n");
e5779998
DM
199 return -EINVAL;
200 }
201
e8e8babf 202 if (! snd_usb_parse_audio_interface(chip, interface)) {
e5779998
DM
203 usb_set_interface(dev, interface, 0); /* reset the current interface */
204 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
e5779998
DM
205 }
206
207 return 0;
208}
209
210/*
211 * parse audio control descriptor and create pcm/midi streams
212 */
213static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
214{
215 struct usb_device *dev = chip->dev;
216 struct usb_host_interface *host_iface;
217 struct usb_interface_descriptor *altsd;
e5779998
DM
218 int i, protocol;
219
220 /* find audiocontrol interface */
221 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
e5779998
DM
222 altsd = get_iface_desc(host_iface);
223 protocol = altsd->bInterfaceProtocol;
224
e5779998 225 switch (protocol) {
a2acad82 226 default:
0ba41d91
TI
227 dev_warn(&dev->dev,
228 "unknown interface protocol %#02x, assuming v1\n",
229 protocol);
a2acad82
CL
230 /* fall through */
231
e5779998 232 case UAC_VERSION_1: {
3763f618
JS
233 struct uac1_ac_header_descriptor *h1;
234 int rest_bytes;
235
236 h1 = snd_usb_find_csint_desc(host_iface->extra,
237 host_iface->extralen,
238 NULL, UAC_HEADER);
3e96d728 239 if (!h1 || h1->bLength < sizeof(*h1)) {
3763f618
JS
240 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
241 return -EINVAL;
242 }
243
244 rest_bytes = (void *)(host_iface->extra +
245 host_iface->extralen) - (void *)h1;
246
247 /* just to be sure -- this shouldn't hit at all */
248 if (rest_bytes <= 0) {
249 dev_err(&dev->dev, "invalid control header\n");
250 return -EINVAL;
251 }
e5779998 252
bfc81a8b
TI
253 if (rest_bytes < sizeof(*h1)) {
254 dev_err(&dev->dev, "too short v1 buffer descriptor\n");
255 return -EINVAL;
256 }
257
e5779998 258 if (!h1->bInCollection) {
0ba41d91 259 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
e5779998
DM
260 return -EINVAL;
261 }
262
bfc81a8b
TI
263 if (rest_bytes < h1->bLength) {
264 dev_err(&dev->dev, "invalid buffer length (v1)\n");
265 return -EINVAL;
266 }
267
e5779998 268 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
0ba41d91 269 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
e5779998
DM
270 return -EINVAL;
271 }
272
273 for (i = 0; i < h1->bInCollection; i++)
274 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
275
276 break;
277 }
278
9a2fe9b8
RB
279 case UAC_VERSION_2:
280 case UAC_VERSION_3: {
e5779998
DM
281 struct usb_interface_assoc_descriptor *assoc =
282 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
283
281a6ac0
CL
284 if (!assoc) {
285 /*
286 * Firmware writers cannot count to three. So to find
287 * the IAD on the NuForce UDH-100, also check the next
288 * interface.
289 */
290 struct usb_interface *iface =
291 usb_ifnum_to_if(dev, ctrlif + 1);
292 if (iface &&
293 iface->intf_assoc &&
294 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
295 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
296 assoc = iface->intf_assoc;
297 }
298
e5779998 299 if (!assoc) {
9a2fe9b8 300 dev_err(&dev->dev, "Audio class v2/v3 interfaces need an interface association\n");
e5779998
DM
301 return -EINVAL;
302 }
303
17156f23
RB
304 if (protocol == UAC_VERSION_3) {
305 int badd = assoc->bFunctionSubClass;
306
307 if (badd != UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0 &&
308 (badd < UAC3_FUNCTION_SUBCLASS_GENERIC_IO ||
309 badd > UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE)) {
310 dev_err(&dev->dev,
311 "Unsupported UAC3 BADD profile\n");
312 return -EINVAL;
313 }
314
315 chip->badd_profile = badd;
316 }
317
e5779998
DM
318 for (i = 0; i < assoc->bInterfaceCount; i++) {
319 int intf = assoc->bFirstInterface + i;
320
321 if (intf != ctrlif)
322 snd_usb_create_stream(chip, ctrlif, intf);
323 }
324
325 break;
326 }
e5779998
DM
327 }
328
329 return 0;
330}
331
332/*
333 * free the chip instance
334 *
335 * here we have to do not much, since pcm and controls are already freed
336 *
337 */
338
011ae2bf 339static void snd_usb_audio_free(struct snd_card *card)
e5779998 340{
011ae2bf 341 struct snd_usb_audio *chip = card->private_data;
a6cece9d 342 struct snd_usb_endpoint *ep, *n;
92a586bd 343
a6cece9d
TI
344 list_for_each_entry_safe(ep, n, &chip->ep_list, list)
345 snd_usb_endpoint_free(ep);
92a586bd 346
596580d0 347 mutex_destroy(&chip->mutex);
6ff1a253
TI
348 if (!atomic_read(&chip->shutdown))
349 dev_set_drvdata(&chip->dev->dev, NULL);
e5779998
DM
350}
351
07eca5fc
TI
352static void usb_audio_make_shortname(struct usb_device *dev,
353 struct snd_usb_audio *chip,
354 const struct snd_usb_audio_quirk *quirk)
355{
356 struct snd_card *card = chip->card;
357
358 if (quirk && quirk->product_name && *quirk->product_name) {
359 strlcpy(card->shortname, quirk->product_name,
360 sizeof(card->shortname));
361 return;
362 }
363
364 /* retrieve the device string as shortname */
365 if (!dev->descriptor.iProduct ||
366 usb_string(dev, dev->descriptor.iProduct,
367 card->shortname, sizeof(card->shortname)) <= 0) {
368 /* no name available from anywhere, so use ID */
369 sprintf(card->shortname, "USB Device %#04x:%#04x",
370 USB_ID_VENDOR(chip->usb_id),
371 USB_ID_PRODUCT(chip->usb_id));
372 }
373
374 strim(card->shortname);
375}
376
377static void usb_audio_make_longname(struct usb_device *dev,
378 struct snd_usb_audio *chip,
379 const struct snd_usb_audio_quirk *quirk)
380{
381 struct snd_card *card = chip->card;
382 int len;
383
384 /* shortcut - if any pre-defined string is given, use it */
385 if (quirk && quirk->profile_name && *quirk->profile_name) {
386 strlcpy(card->longname, quirk->profile_name,
387 sizeof(card->longname));
388 return;
389 }
390
391 if (quirk && quirk->vendor_name && *quirk->vendor_name) {
392 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
393 } else {
394 /* retrieve the vendor and device strings as longname */
395 if (dev->descriptor.iManufacturer)
396 len = usb_string(dev, dev->descriptor.iManufacturer,
397 card->longname, sizeof(card->longname));
398 else
399 len = 0;
400 /* we don't really care if there isn't any vendor string */
401 }
402 if (len > 0) {
403 strim(card->longname);
404 if (*card->longname)
405 strlcat(card->longname, " ", sizeof(card->longname));
406 }
407
408 strlcat(card->longname, card->shortname, sizeof(card->longname));
409
410 len = strlcat(card->longname, " at ", sizeof(card->longname));
411
412 if (len < sizeof(card->longname))
413 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
414
415 switch (snd_usb_get_speed(dev)) {
416 case USB_SPEED_LOW:
417 strlcat(card->longname, ", low speed", sizeof(card->longname));
418 break;
419 case USB_SPEED_FULL:
420 strlcat(card->longname, ", full speed", sizeof(card->longname));
421 break;
422 case USB_SPEED_HIGH:
423 strlcat(card->longname, ", high speed", sizeof(card->longname));
424 break;
425 case USB_SPEED_SUPER:
426 strlcat(card->longname, ", super speed", sizeof(card->longname));
427 break;
428 case USB_SPEED_SUPER_PLUS:
429 strlcat(card->longname, ", super speed plus", sizeof(card->longname));
430 break;
431 default:
432 break;
433 }
434}
435
e5779998
DM
436/*
437 * create a chip instance and set its names.
438 */
874b8d42
TI
439static int snd_usb_audio_create(struct usb_interface *intf,
440 struct usb_device *dev, int idx,
e5779998 441 const struct snd_usb_audio_quirk *quirk,
03a1f48e 442 unsigned int usb_id,
e5779998
DM
443 struct snd_usb_audio **rchip)
444{
445 struct snd_card *card;
446 struct snd_usb_audio *chip;
07eca5fc 447 int err;
e5779998 448 char component[14];
e5779998
DM
449
450 *rchip = NULL;
451
4f4e8f69
PZ
452 switch (snd_usb_get_speed(dev)) {
453 case USB_SPEED_LOW:
454 case USB_SPEED_FULL:
455 case USB_SPEED_HIGH:
df3774c5 456 case USB_SPEED_WIRELESS:
4f4e8f69 457 case USB_SPEED_SUPER:
748a1ccc 458 case USB_SPEED_SUPER_PLUS:
4f4e8f69
PZ
459 break;
460 default:
0ba41d91 461 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
e5779998
DM
462 return -ENXIO;
463 }
464
874b8d42 465 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
011ae2bf 466 sizeof(*chip), &card);
e5779998 467 if (err < 0) {
0ba41d91 468 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
e5779998
DM
469 return err;
470 }
471
011ae2bf 472 chip = card->private_data;
596580d0 473 mutex_init(&chip->mutex);
47ab1545 474 init_waitqueue_head(&chip->shutdown_wait);
e5779998
DM
475 chip->index = idx;
476 chip->dev = dev;
477 chip->card = card;
478 chip->setup = device_setup[idx];
ef02e29b 479 chip->autoclock = autoclock;
a6da499b 480 atomic_set(&chip->active, 1); /* avoid autopm during probing */
47ab1545
TI
481 atomic_set(&chip->usage_count, 0);
482 atomic_set(&chip->shutdown, 0);
e5779998 483
03a1f48e 484 chip->usb_id = usb_id;
e5779998 485 INIT_LIST_HEAD(&chip->pcm_list);
edcd3633 486 INIT_LIST_HEAD(&chip->ep_list);
e5779998
DM
487 INIT_LIST_HEAD(&chip->midi_list);
488 INIT_LIST_HEAD(&chip->mixer_list);
489
011ae2bf 490 card->private_free = snd_usb_audio_free;
e5779998
DM
491
492 strcpy(card->driver, "USB-Audio");
493 sprintf(component, "USB%04x:%04x",
494 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
495 snd_component_add(card, component);
496
07eca5fc
TI
497 usb_audio_make_shortname(dev, chip, quirk);
498 usb_audio_make_longname(dev, chip, quirk);
e5779998
DM
499
500 snd_usb_audio_create_proc(chip);
501
502 *rchip = chip;
503 return 0;
504}
505
e2703363
TI
506/* look for a matching quirk alias id */
507static bool get_alias_id(struct usb_device *dev, unsigned int *id)
508{
509 int i;
510 unsigned int src, dst;
511
512 for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
513 if (!quirk_alias[i] ||
514 sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
515 src != *id)
516 continue;
517 dev_info(&dev->dev,
518 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
519 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
520 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
521 *id = dst;
522 return true;
523 }
524
525 return false;
526}
527
8824ae2d 528static const struct usb_device_id usb_audio_ids[]; /* defined below */
e2703363
TI
529
530/* look for the corresponding quirk */
531static const struct snd_usb_audio_quirk *
532get_alias_quirk(struct usb_device *dev, unsigned int id)
533{
534 const struct usb_device_id *p;
535
536 for (p = usb_audio_ids; p->match_flags; p++) {
537 /* FIXME: this checks only vendor:product pair in the list */
538 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
539 USB_DEVICE_ID_MATCH_DEVICE &&
540 p->idVendor == USB_ID_VENDOR(id) &&
541 p->idProduct == USB_ID_PRODUCT(id))
542 return (const struct snd_usb_audio_quirk *)p->driver_info;
543 }
544
545 return NULL;
546}
547
e5779998
DM
548/*
549 * probe the active usb device
550 *
551 * note that this can be called multiple times per a device, when it
552 * includes multiple audio control interfaces.
553 *
554 * thus we check the usb device pointer and creates the card instance
555 * only at the first time. the successive calls of this function will
556 * append the pcm interface to the corresponding card.
557 */
4c8c3a4f
TI
558static int usb_audio_probe(struct usb_interface *intf,
559 const struct usb_device_id *usb_id)
e5779998 560{
4c8c3a4f
TI
561 struct usb_device *dev = interface_to_usbdev(intf);
562 const struct snd_usb_audio_quirk *quirk =
563 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
e5779998 564 struct snd_usb_audio *chip;
4c8c3a4f 565 int i, err;
e5779998
DM
566 struct usb_host_interface *alts;
567 int ifnum;
568 u32 id;
569
570 alts = &intf->altsetting[0];
571 ifnum = get_iface_desc(alts)->bInterfaceNumber;
572 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
573 le16_to_cpu(dev->descriptor.idProduct));
e2703363
TI
574 if (get_alias_id(dev, &id))
575 quirk = get_alias_quirk(dev, id);
e5779998 576 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
4c8c3a4f 577 return -ENXIO;
e5779998 578
79289e24 579 err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
4c8c3a4f
TI
580 if (err < 0)
581 return err;
e5779998
DM
582
583 /*
584 * found a config. now register to ALSA
585 */
586
587 /* check whether it's already registered */
588 chip = NULL;
589 mutex_lock(&register_mutex);
590 for (i = 0; i < SNDRV_CARDS; i++) {
591 if (usb_chip[i] && usb_chip[i]->dev == dev) {
47ab1545 592 if (atomic_read(&usb_chip[i]->shutdown)) {
0ba41d91 593 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
4c8c3a4f 594 err = -EIO;
e5779998
DM
595 goto __error;
596 }
597 chip = usb_chip[i];
a6da499b 598 atomic_inc(&chip->active); /* avoid autopm */
e5779998
DM
599 break;
600 }
601 }
602 if (! chip) {
73ac9f5e
AT
603 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
604 if (err < 0)
a3afa299 605 goto __error;
73ac9f5e 606
e5779998
DM
607 /* it's a fresh one.
608 * now look for an empty slot and create a new card instance
609 */
610 for (i = 0; i < SNDRV_CARDS; i++)
108884e6 611 if (!usb_chip[i] &&
e5779998
DM
612 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
613 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
108884e6
TN
614 if (enable[i]) {
615 err = snd_usb_audio_create(intf, dev, i, quirk,
616 id, &chip);
617 if (err < 0)
618 goto __error;
619 chip->pm_intf = intf;
620 break;
621 } else if (vid[i] != -1 || pid[i] != -1) {
622 dev_info(&dev->dev,
623 "device (%04x:%04x) is disabled\n",
624 USB_ID_VENDOR(id),
625 USB_ID_PRODUCT(id));
626 err = -ENOENT;
e5779998 627 goto __error;
108884e6 628 }
e5779998
DM
629 }
630 if (!chip) {
0ba41d91 631 dev_err(&dev->dev, "no available usb audio device\n");
4c8c3a4f 632 err = -ENODEV;
e5779998
DM
633 goto __error;
634 }
635 }
76df5296 636 dev_set_drvdata(&dev->dev, chip);
e5779998 637
7b6717e1
DM
638 /*
639 * For devices with more than one control interface, we assume the
640 * first contains the audio controls. We might need a more specific
641 * check here in the future.
642 */
643 if (!chip->ctrl_intf)
644 chip->ctrl_intf = alts;
79f920fb 645
5875c2cb
DM
646 chip->txfr_quirk = 0;
647 err = 1; /* continue */
648 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
649 /* need some special handlings */
4c8c3a4f
TI
650 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
651 if (err < 0)
5875c2cb
DM
652 goto __error;
653 }
654
e5779998
DM
655 if (err > 0) {
656 /* create normal USB audio interfaces */
4c8c3a4f
TI
657 err = snd_usb_create_streams(chip, ifnum);
658 if (err < 0)
659 goto __error;
660 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
661 if (err < 0)
e5779998 662 goto __error;
e5779998
DM
663 }
664
665 /* we are allowed to call snd_card_register() many times */
4c8c3a4f
TI
666 err = snd_card_register(chip->card);
667 if (err < 0)
e5779998 668 goto __error;
e5779998 669
66354f18
SK
670 if (quirk && quirk->shares_media_device) {
671 /* don't want to fail when snd_media_device_create() fails */
672 snd_media_device_create(chip, intf);
673 }
674
e5779998
DM
675 usb_chip[chip->index] = chip;
676 chip->num_interfaces++;
4c8c3a4f 677 usb_set_intfdata(intf, chip);
a6da499b 678 atomic_dec(&chip->active);
e5779998 679 mutex_unlock(&register_mutex);
4c8c3a4f 680 return 0;
e5779998
DM
681
682 __error:
61a6a108 683 if (chip) {
5f8cf712
HP
684 /* chip->active is inside the chip->card object,
685 * decrement before memory is possibly returned.
686 */
687 atomic_dec(&chip->active);
61a6a108
TP
688 if (!chip->num_interfaces)
689 snd_card_free(chip->card);
61a6a108 690 }
e5779998 691 mutex_unlock(&register_mutex);
4c8c3a4f 692 return err;
e5779998
DM
693}
694
695/*
696 * we need to take care of counter, since disconnection can be called also
697 * many times as well as usb_audio_probe().
698 */
4c8c3a4f 699static void usb_audio_disconnect(struct usb_interface *intf)
e5779998 700{
4c8c3a4f 701 struct snd_usb_audio *chip = usb_get_intfdata(intf);
e5779998 702 struct snd_card *card;
92a586bd 703 struct list_head *p;
e5779998 704
81b85b6b 705 if (chip == (void *)-1L)
e5779998
DM
706 return;
707
e5779998 708 card = chip->card;
10e44239
TI
709
710 mutex_lock(&register_mutex);
47ab1545 711 if (atomic_inc_return(&chip->shutdown) == 1) {
a6cece9d 712 struct snd_usb_stream *as;
92a586bd 713 struct snd_usb_endpoint *ep;
a6cece9d 714 struct usb_mixer_interface *mixer;
92a586bd 715
47ab1545
TI
716 /* wait until all pending tasks done;
717 * they are protected by snd_usb_lock_shutdown()
718 */
719 wait_event(chip->shutdown_wait,
720 !atomic_read(&chip->usage_count));
e5779998
DM
721 snd_card_disconnect(card);
722 /* release the pcm resources */
a6cece9d
TI
723 list_for_each_entry(as, &chip->pcm_list, list) {
724 snd_usb_stream_disconnect(as);
e5779998 725 }
edcd3633 726 /* release the endpoint resources */
92a586bd
TI
727 list_for_each_entry(ep, &chip->ep_list, list) {
728 snd_usb_endpoint_release(ep);
edcd3633 729 }
e5779998
DM
730 /* release the midi resources */
731 list_for_each(p, &chip->midi_list) {
732 snd_usbmidi_disconnect(p);
733 }
66354f18
SK
734 /*
735 * Nice to check quirk && quirk->shares_media_device and
736 * then call the snd_media_device_delete(). Don't have
737 * access to the quirk here. snd_media_device_delete()
738 * accesses mixer_list
739 */
740 snd_media_device_delete(chip);
741
e5779998 742 /* release mixer resources */
a6cece9d
TI
743 list_for_each_entry(mixer, &chip->mixer_list, list) {
744 snd_usb_mixer_disconnect(mixer);
e5779998 745 }
0725dda2
TI
746 }
747
748 chip->num_interfaces--;
749 if (chip->num_interfaces <= 0) {
e5779998
DM
750 usb_chip[chip->index] = NULL;
751 mutex_unlock(&register_mutex);
752 snd_card_free_when_closed(card);
753 } else {
754 mutex_unlock(&register_mutex);
755 }
756}
757
47ab1545
TI
758/* lock the shutdown (disconnect) task and autoresume */
759int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
88a8516a 760{
47ab1545 761 int err;
88a8516a 762
47ab1545
TI
763 atomic_inc(&chip->usage_count);
764 if (atomic_read(&chip->shutdown)) {
765 err = -EIO;
766 goto error;
767 }
768 err = snd_usb_autoresume(chip);
769 if (err < 0)
770 goto error;
771 return 0;
88a8516a 772
47ab1545
TI
773 error:
774 if (atomic_dec_and_test(&chip->usage_count))
775 wake_up(&chip->shutdown_wait);
88a8516a
ON
776 return err;
777}
778
47ab1545
TI
779/* autosuspend and unlock the shutdown */
780void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
781{
782 snd_usb_autosuspend(chip);
783 if (atomic_dec_and_test(&chip->usage_count))
784 wake_up(&chip->shutdown_wait);
785}
786
787#ifdef CONFIG_PM
788
789int snd_usb_autoresume(struct snd_usb_audio *chip)
790{
791 if (atomic_read(&chip->shutdown))
792 return -EIO;
47ab1545
TI
793 if (atomic_inc_return(&chip->active) == 1)
794 return usb_autopm_get_interface(chip->pm_intf);
795 return 0;
796}
797
88a8516a
ON
798void snd_usb_autosuspend(struct snd_usb_audio *chip)
799{
5c06d68b
TI
800 if (atomic_read(&chip->shutdown))
801 return;
47ab1545 802 if (atomic_dec_and_test(&chip->active))
88a8516a
ON
803 usb_autopm_put_interface(chip->pm_intf);
804}
805
e5779998
DM
806static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
807{
808 struct snd_usb_audio *chip = usb_get_intfdata(intf);
e5779998 809 struct snd_usb_stream *as;
edf7de31 810 struct usb_mixer_interface *mixer;
f7881e5e 811 struct list_head *p;
e5779998
DM
812
813 if (chip == (void *)-1L)
814 return 0;
815
0662292a
TI
816 chip->autosuspended = !!PMSG_IS_AUTO(message);
817 if (!chip->autosuspended)
88a8516a 818 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
0662292a
TI
819 if (!chip->num_suspended_intf++) {
820 list_for_each_entry(as, &chip->pcm_list, list) {
3f59aa11 821 snd_usb_pcm_suspend(as);
0662292a
TI
822 as->substream[0].need_setup_ep =
823 as->substream[1].need_setup_ep = true;
aa53f986 824 }
0662292a
TI
825 list_for_each(p, &chip->midi_list)
826 snd_usbmidi_suspend(p);
1c53e725
TI
827 list_for_each_entry(mixer, &chip->mixer_list, list)
828 snd_usb_mixer_suspend(mixer);
0662292a 829 }
88a8516a 830
e5779998
DM
831 return 0;
832}
833
400362f1 834static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
e5779998
DM
835{
836 struct snd_usb_audio *chip = usb_get_intfdata(intf);
3f59aa11 837 struct snd_usb_stream *as;
edf7de31 838 struct usb_mixer_interface *mixer;
f7881e5e 839 struct list_head *p;
88a8516a 840 int err = 0;
e5779998
DM
841
842 if (chip == (void *)-1L)
843 return 0;
844 if (--chip->num_suspended_intf)
845 return 0;
1ee23fe0 846
47ab1545 847 atomic_inc(&chip->active); /* avoid autopm */
3f59aa11
JS
848
849 list_for_each_entry(as, &chip->pcm_list, list) {
850 err = snd_usb_pcm_resume(as);
851 if (err < 0)
852 goto err_out;
853 }
854
e5779998
DM
855 /*
856 * ALSA leaves material resumption to user space
edf7de31 857 * we just notify and restart the mixers
e5779998 858 */
88a8516a 859 list_for_each_entry(mixer, &chip->mixer_list, list) {
400362f1 860 err = snd_usb_mixer_resume(mixer, reset_resume);
88a8516a
ON
861 if (err < 0)
862 goto err_out;
863 }
e5779998 864
f7881e5e
AG
865 list_for_each(p, &chip->midi_list) {
866 snd_usbmidi_resume(p);
867 }
868
88a8516a
ON
869 if (!chip->autosuspended)
870 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
871 chip->autosuspended = 0;
e5779998 872
88a8516a 873err_out:
47ab1545 874 atomic_dec(&chip->active); /* allow autopm after this point */
88a8516a 875 return err;
e5779998 876}
400362f1
TI
877
878static int usb_audio_resume(struct usb_interface *intf)
879{
880 return __usb_audio_resume(intf, false);
881}
882
883static int usb_audio_reset_resume(struct usb_interface *intf)
884{
885 return __usb_audio_resume(intf, true);
886}
6407d474
RD
887#else
888#define usb_audio_suspend NULL
889#define usb_audio_resume NULL
400362f1 890#define usb_audio_reset_resume NULL
e5779998
DM
891#endif /* CONFIG_PM */
892
8824ae2d 893static const struct usb_device_id usb_audio_ids [] = {
e5779998
DM
894#include "quirks-table.h"
895 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
896 .bInterfaceClass = USB_CLASS_AUDIO,
897 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
898 { } /* Terminating entry */
899};
f9d35435 900MODULE_DEVICE_TABLE(usb, usb_audio_ids);
e5779998
DM
901
902/*
903 * entry point for linux usb interface
904 */
905
906static struct usb_driver usb_audio_driver = {
907 .name = "snd-usb-audio",
908 .probe = usb_audio_probe,
909 .disconnect = usb_audio_disconnect,
910 .suspend = usb_audio_suspend,
911 .resume = usb_audio_resume,
400362f1 912 .reset_resume = usb_audio_reset_resume,
e5779998 913 .id_table = usb_audio_ids,
88a8516a 914 .supports_autosuspend = 1,
e5779998
DM
915};
916
6b5a7c66 917module_usb_driver(usb_audio_driver);