xref: /openbmc/linux/sound/usb/card.c (revision 110e6f26)
1 /*
2  *   (Tentative) USB Audio Driver for ALSA
3  *
4  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
5  *
6  *   Many codes borrowed from audio.c by
7  *	    Alan Cox (alan@lxorguk.ukuu.org.uk)
8  *	    Thomas Sailer (sailer@ife.ee.ethz.ch)
9  *
10  *
11  *   This program is free software; you can redistribute it and/or modify
12  *   it under the terms of the GNU General Public License as published by
13  *   the Free Software Foundation; either version 2 of the License, or
14  *   (at your option) any later version.
15  *
16  *   This program is distributed in the hope that it will be useful,
17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  *   GNU General Public License for more details.
20  *
21  *   You should have received a copy of the GNU General Public License
22  *   along with this program; if not, write to the Free Software
23  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
24  *
25  *
26  *  NOTES:
27  *
28  *   - the linked URBs would be preferred but not used so far because of
29  *     the instability of unlinking.
30  *   - type II is not supported properly.  there is no device which supports
31  *     this type *correctly*.  SB extigy looks as if it supports, but it's
32  *     indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
33  */
34 
35 
36 #include <linux/bitops.h>
37 #include <linux/init.h>
38 #include <linux/list.h>
39 #include <linux/slab.h>
40 #include <linux/string.h>
41 #include <linux/ctype.h>
42 #include <linux/usb.h>
43 #include <linux/moduleparam.h>
44 #include <linux/mutex.h>
45 #include <linux/usb/audio.h>
46 #include <linux/usb/audio-v2.h>
47 #include <linux/module.h>
48 
49 #include <sound/control.h>
50 #include <sound/core.h>
51 #include <sound/info.h>
52 #include <sound/pcm.h>
53 #include <sound/pcm_params.h>
54 #include <sound/initval.h>
55 
56 #include "usbaudio.h"
57 #include "card.h"
58 #include "midi.h"
59 #include "mixer.h"
60 #include "proc.h"
61 #include "quirks.h"
62 #include "endpoint.h"
63 #include "helper.h"
64 #include "debug.h"
65 #include "pcm.h"
66 #include "format.h"
67 #include "power.h"
68 #include "stream.h"
69 
70 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
71 MODULE_DESCRIPTION("USB Audio");
72 MODULE_LICENSE("GPL");
73 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
74 
75 
76 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
77 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
78 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
79 /* Vendor/product IDs for this card */
80 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
81 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
82 static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
83 static bool ignore_ctl_error;
84 static bool autoclock = true;
85 static char *quirk_alias[SNDRV_CARDS];
86 
87 module_param_array(index, int, NULL, 0444);
88 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
89 module_param_array(id, charp, NULL, 0444);
90 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
91 module_param_array(enable, bool, NULL, 0444);
92 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
93 module_param_array(vid, int, NULL, 0444);
94 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
95 module_param_array(pid, int, NULL, 0444);
96 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
97 module_param_array(device_setup, int, NULL, 0444);
98 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
99 module_param(ignore_ctl_error, bool, 0444);
100 MODULE_PARM_DESC(ignore_ctl_error,
101 		 "Ignore errors from USB controller for mixer interfaces.");
102 module_param(autoclock, bool, 0444);
103 MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
104 module_param_array(quirk_alias, charp, NULL, 0444);
105 MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");
106 
107 /*
108  * we keep the snd_usb_audio_t instances by ourselves for merging
109  * the all interfaces on the same card as one sound device.
110  */
111 
112 static DEFINE_MUTEX(register_mutex);
113 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
114 static struct usb_driver usb_audio_driver;
115 
116 /*
117  * disconnect streams
118  * called from usb_audio_disconnect()
119  */
120 static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
121 {
122 	int idx;
123 	struct snd_usb_substream *subs;
124 
125 	for (idx = 0; idx < 2; idx++) {
126 		subs = &as->substream[idx];
127 		if (!subs->num_formats)
128 			continue;
129 		subs->interface = -1;
130 		subs->data_endpoint = NULL;
131 		subs->sync_endpoint = NULL;
132 	}
133 }
134 
135 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
136 {
137 	struct usb_device *dev = chip->dev;
138 	struct usb_host_interface *alts;
139 	struct usb_interface_descriptor *altsd;
140 	struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
141 
142 	if (!iface) {
143 		dev_err(&dev->dev, "%u:%d : does not exist\n",
144 			ctrlif, interface);
145 		return -EINVAL;
146 	}
147 
148 	alts = &iface->altsetting[0];
149 	altsd = get_iface_desc(alts);
150 
151 	/*
152 	 * Android with both accessory and audio interfaces enabled gets the
153 	 * interface numbers wrong.
154 	 */
155 	if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
156 	     chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
157 	    interface == 0 &&
158 	    altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
159 	    altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
160 		interface = 2;
161 		iface = usb_ifnum_to_if(dev, interface);
162 		if (!iface)
163 			return -EINVAL;
164 		alts = &iface->altsetting[0];
165 		altsd = get_iface_desc(alts);
166 	}
167 
168 	if (usb_interface_claimed(iface)) {
169 		dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
170 			ctrlif, interface);
171 		return -EINVAL;
172 	}
173 
174 	if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
175 	     altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
176 	    altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
177 		int err = __snd_usbmidi_create(chip->card, iface,
178 					     &chip->midi_list, NULL,
179 					     chip->usb_id);
180 		if (err < 0) {
181 			dev_err(&dev->dev,
182 				"%u:%d: cannot create sequencer device\n",
183 				ctrlif, interface);
184 			return -EINVAL;
185 		}
186 		usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
187 
188 		return 0;
189 	}
190 
191 	if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
192 	     altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
193 	    altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
194 		dev_dbg(&dev->dev,
195 			"%u:%d: skipping non-supported interface %d\n",
196 			ctrlif, interface, altsd->bInterfaceClass);
197 		/* skip non-supported classes */
198 		return -EINVAL;
199 	}
200 
201 	if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
202 		dev_err(&dev->dev, "low speed audio streaming not supported\n");
203 		return -EINVAL;
204 	}
205 
206 	if (! snd_usb_parse_audio_interface(chip, interface)) {
207 		usb_set_interface(dev, interface, 0); /* reset the current interface */
208 		usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
209 		return -EINVAL;
210 	}
211 
212 	return 0;
213 }
214 
215 /*
216  * parse audio control descriptor and create pcm/midi streams
217  */
218 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
219 {
220 	struct usb_device *dev = chip->dev;
221 	struct usb_host_interface *host_iface;
222 	struct usb_interface_descriptor *altsd;
223 	void *control_header;
224 	int i, protocol;
225 
226 	/* find audiocontrol interface */
227 	host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
228 	control_header = snd_usb_find_csint_desc(host_iface->extra,
229 						 host_iface->extralen,
230 						 NULL, UAC_HEADER);
231 	altsd = get_iface_desc(host_iface);
232 	protocol = altsd->bInterfaceProtocol;
233 
234 	if (!control_header) {
235 		dev_err(&dev->dev, "cannot find UAC_HEADER\n");
236 		return -EINVAL;
237 	}
238 
239 	switch (protocol) {
240 	default:
241 		dev_warn(&dev->dev,
242 			 "unknown interface protocol %#02x, assuming v1\n",
243 			 protocol);
244 		/* fall through */
245 
246 	case UAC_VERSION_1: {
247 		struct uac1_ac_header_descriptor *h1 = control_header;
248 
249 		if (!h1->bInCollection) {
250 			dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
251 			return -EINVAL;
252 		}
253 
254 		if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
255 			dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
256 			return -EINVAL;
257 		}
258 
259 		for (i = 0; i < h1->bInCollection; i++)
260 			snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
261 
262 		break;
263 	}
264 
265 	case UAC_VERSION_2: {
266 		struct usb_interface_assoc_descriptor *assoc =
267 			usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
268 
269 		if (!assoc) {
270 			/*
271 			 * Firmware writers cannot count to three.  So to find
272 			 * the IAD on the NuForce UDH-100, also check the next
273 			 * interface.
274 			 */
275 			struct usb_interface *iface =
276 				usb_ifnum_to_if(dev, ctrlif + 1);
277 			if (iface &&
278 			    iface->intf_assoc &&
279 			    iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
280 			    iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
281 				assoc = iface->intf_assoc;
282 		}
283 
284 		if (!assoc) {
285 			dev_err(&dev->dev, "Audio class v2 interfaces need an interface association\n");
286 			return -EINVAL;
287 		}
288 
289 		for (i = 0; i < assoc->bInterfaceCount; i++) {
290 			int intf = assoc->bFirstInterface + i;
291 
292 			if (intf != ctrlif)
293 				snd_usb_create_stream(chip, ctrlif, intf);
294 		}
295 
296 		break;
297 	}
298 	}
299 
300 	return 0;
301 }
302 
303 /*
304  * free the chip instance
305  *
306  * here we have to do not much, since pcm and controls are already freed
307  *
308  */
309 
310 static int snd_usb_audio_free(struct snd_usb_audio *chip)
311 {
312 	struct snd_usb_endpoint *ep, *n;
313 
314 	list_for_each_entry_safe(ep, n, &chip->ep_list, list)
315 		snd_usb_endpoint_free(ep);
316 
317 	mutex_destroy(&chip->mutex);
318 	dev_set_drvdata(&chip->dev->dev, NULL);
319 	kfree(chip);
320 	return 0;
321 }
322 
323 static int snd_usb_audio_dev_free(struct snd_device *device)
324 {
325 	struct snd_usb_audio *chip = device->device_data;
326 	return snd_usb_audio_free(chip);
327 }
328 
329 /*
330  * create a chip instance and set its names.
331  */
332 static int snd_usb_audio_create(struct usb_interface *intf,
333 				struct usb_device *dev, int idx,
334 				const struct snd_usb_audio_quirk *quirk,
335 				struct snd_usb_audio **rchip)
336 {
337 	struct snd_card *card;
338 	struct snd_usb_audio *chip;
339 	int err, len;
340 	char component[14];
341 	static struct snd_device_ops ops = {
342 		.dev_free =	snd_usb_audio_dev_free,
343 	};
344 
345 	*rchip = NULL;
346 
347 	switch (snd_usb_get_speed(dev)) {
348 	case USB_SPEED_LOW:
349 	case USB_SPEED_FULL:
350 	case USB_SPEED_HIGH:
351 	case USB_SPEED_WIRELESS:
352 	case USB_SPEED_SUPER:
353 		break;
354 	default:
355 		dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
356 		return -ENXIO;
357 	}
358 
359 	err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
360 			   0, &card);
361 	if (err < 0) {
362 		dev_err(&dev->dev, "cannot create card instance %d\n", idx);
363 		return err;
364 	}
365 
366 	chip = kzalloc(sizeof(*chip), GFP_KERNEL);
367 	if (! chip) {
368 		snd_card_free(card);
369 		return -ENOMEM;
370 	}
371 
372 	mutex_init(&chip->mutex);
373 	init_waitqueue_head(&chip->shutdown_wait);
374 	chip->index = idx;
375 	chip->dev = dev;
376 	chip->card = card;
377 	chip->setup = device_setup[idx];
378 	chip->autoclock = autoclock;
379 	atomic_set(&chip->active, 1); /* avoid autopm during probing */
380 	atomic_set(&chip->usage_count, 0);
381 	atomic_set(&chip->shutdown, 0);
382 
383 	chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
384 			      le16_to_cpu(dev->descriptor.idProduct));
385 	INIT_LIST_HEAD(&chip->pcm_list);
386 	INIT_LIST_HEAD(&chip->ep_list);
387 	INIT_LIST_HEAD(&chip->midi_list);
388 	INIT_LIST_HEAD(&chip->mixer_list);
389 
390 	if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
391 		snd_usb_audio_free(chip);
392 		snd_card_free(card);
393 		return err;
394 	}
395 
396 	strcpy(card->driver, "USB-Audio");
397 	sprintf(component, "USB%04x:%04x",
398 		USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
399 	snd_component_add(card, component);
400 
401 	/* retrieve the device string as shortname */
402 	if (quirk && quirk->product_name && *quirk->product_name) {
403 		strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
404 	} else {
405 		if (!dev->descriptor.iProduct ||
406 		    usb_string(dev, dev->descriptor.iProduct,
407 		    card->shortname, sizeof(card->shortname)) <= 0) {
408 			/* no name available from anywhere, so use ID */
409 			sprintf(card->shortname, "USB Device %#04x:%#04x",
410 				USB_ID_VENDOR(chip->usb_id),
411 				USB_ID_PRODUCT(chip->usb_id));
412 		}
413 	}
414 	strim(card->shortname);
415 
416 	/* retrieve the vendor and device strings as longname */
417 	if (quirk && quirk->vendor_name && *quirk->vendor_name) {
418 		len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
419 	} else {
420 		if (dev->descriptor.iManufacturer)
421 			len = usb_string(dev, dev->descriptor.iManufacturer,
422 					 card->longname, sizeof(card->longname));
423 		else
424 			len = 0;
425 		/* we don't really care if there isn't any vendor string */
426 	}
427 	if (len > 0) {
428 		strim(card->longname);
429 		if (*card->longname)
430 			strlcat(card->longname, " ", sizeof(card->longname));
431 	}
432 
433 	strlcat(card->longname, card->shortname, sizeof(card->longname));
434 
435 	len = strlcat(card->longname, " at ", sizeof(card->longname));
436 
437 	if (len < sizeof(card->longname))
438 		usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
439 
440 	switch (snd_usb_get_speed(dev)) {
441 	case USB_SPEED_LOW:
442 		strlcat(card->longname, ", low speed", sizeof(card->longname));
443 		break;
444 	case USB_SPEED_FULL:
445 		strlcat(card->longname, ", full speed", sizeof(card->longname));
446 		break;
447 	case USB_SPEED_HIGH:
448 		strlcat(card->longname, ", high speed", sizeof(card->longname));
449 		break;
450 	case USB_SPEED_SUPER:
451 		strlcat(card->longname, ", super speed", sizeof(card->longname));
452 		break;
453 	default:
454 		break;
455 	}
456 
457 	snd_usb_audio_create_proc(chip);
458 
459 	*rchip = chip;
460 	return 0;
461 }
462 
463 /* look for a matching quirk alias id */
464 static bool get_alias_id(struct usb_device *dev, unsigned int *id)
465 {
466 	int i;
467 	unsigned int src, dst;
468 
469 	for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
470 		if (!quirk_alias[i] ||
471 		    sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
472 		    src != *id)
473 			continue;
474 		dev_info(&dev->dev,
475 			 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
476 			 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
477 			 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
478 		*id = dst;
479 		return true;
480 	}
481 
482 	return false;
483 }
484 
485 static struct usb_device_id usb_audio_ids[]; /* defined below */
486 
487 /* look for the corresponding quirk */
488 static const struct snd_usb_audio_quirk *
489 get_alias_quirk(struct usb_device *dev, unsigned int id)
490 {
491 	const struct usb_device_id *p;
492 
493 	for (p = usb_audio_ids; p->match_flags; p++) {
494 		/* FIXME: this checks only vendor:product pair in the list */
495 		if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
496 		    USB_DEVICE_ID_MATCH_DEVICE &&
497 		    p->idVendor == USB_ID_VENDOR(id) &&
498 		    p->idProduct == USB_ID_PRODUCT(id))
499 			return (const struct snd_usb_audio_quirk *)p->driver_info;
500 	}
501 
502 	return NULL;
503 }
504 
505 /*
506  * probe the active usb device
507  *
508  * note that this can be called multiple times per a device, when it
509  * includes multiple audio control interfaces.
510  *
511  * thus we check the usb device pointer and creates the card instance
512  * only at the first time.  the successive calls of this function will
513  * append the pcm interface to the corresponding card.
514  */
515 static int usb_audio_probe(struct usb_interface *intf,
516 			   const struct usb_device_id *usb_id)
517 {
518 	struct usb_device *dev = interface_to_usbdev(intf);
519 	const struct snd_usb_audio_quirk *quirk =
520 		(const struct snd_usb_audio_quirk *)usb_id->driver_info;
521 	struct snd_usb_audio *chip;
522 	int i, err;
523 	struct usb_host_interface *alts;
524 	int ifnum;
525 	u32 id;
526 
527 	alts = &intf->altsetting[0];
528 	ifnum = get_iface_desc(alts)->bInterfaceNumber;
529 	id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
530 		    le16_to_cpu(dev->descriptor.idProduct));
531 	if (get_alias_id(dev, &id))
532 		quirk = get_alias_quirk(dev, id);
533 	if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
534 		return -ENXIO;
535 
536 	err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
537 	if (err < 0)
538 		return err;
539 
540 	/*
541 	 * found a config.  now register to ALSA
542 	 */
543 
544 	/* check whether it's already registered */
545 	chip = NULL;
546 	mutex_lock(&register_mutex);
547 	for (i = 0; i < SNDRV_CARDS; i++) {
548 		if (usb_chip[i] && usb_chip[i]->dev == dev) {
549 			if (atomic_read(&usb_chip[i]->shutdown)) {
550 				dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
551 				err = -EIO;
552 				goto __error;
553 			}
554 			chip = usb_chip[i];
555 			dev_set_drvdata(&dev->dev, chip);
556 			atomic_inc(&chip->active); /* avoid autopm */
557 			break;
558 		}
559 	}
560 	if (! chip) {
561 		/* it's a fresh one.
562 		 * now look for an empty slot and create a new card instance
563 		 */
564 		for (i = 0; i < SNDRV_CARDS; i++)
565 			if (enable[i] && ! usb_chip[i] &&
566 			    (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
567 			    (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
568 				err = snd_usb_audio_create(intf, dev, i, quirk,
569 							   &chip);
570 				if (err < 0)
571 					goto __error;
572 				chip->pm_intf = intf;
573 				break;
574 			}
575 		if (!chip) {
576 			dev_err(&dev->dev, "no available usb audio device\n");
577 			err = -ENODEV;
578 			goto __error;
579 		}
580 	}
581 
582 	/*
583 	 * For devices with more than one control interface, we assume the
584 	 * first contains the audio controls. We might need a more specific
585 	 * check here in the future.
586 	 */
587 	if (!chip->ctrl_intf)
588 		chip->ctrl_intf = alts;
589 
590 	chip->txfr_quirk = 0;
591 	err = 1; /* continue */
592 	if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
593 		/* need some special handlings */
594 		err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
595 		if (err < 0)
596 			goto __error;
597 	}
598 
599 	if (err > 0) {
600 		/* create normal USB audio interfaces */
601 		err = snd_usb_create_streams(chip, ifnum);
602 		if (err < 0)
603 			goto __error;
604 		err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
605 		if (err < 0)
606 			goto __error;
607 	}
608 
609 	/* we are allowed to call snd_card_register() many times */
610 	err = snd_card_register(chip->card);
611 	if (err < 0)
612 		goto __error;
613 
614 	usb_chip[chip->index] = chip;
615 	chip->num_interfaces++;
616 	usb_set_intfdata(intf, chip);
617 	atomic_dec(&chip->active);
618 	mutex_unlock(&register_mutex);
619 	return 0;
620 
621  __error:
622 	if (chip) {
623 		if (!chip->num_interfaces)
624 			snd_card_free(chip->card);
625 		atomic_dec(&chip->active);
626 	}
627 	mutex_unlock(&register_mutex);
628 	return err;
629 }
630 
631 /*
632  * we need to take care of counter, since disconnection can be called also
633  * many times as well as usb_audio_probe().
634  */
635 static void usb_audio_disconnect(struct usb_interface *intf)
636 {
637 	struct snd_usb_audio *chip = usb_get_intfdata(intf);
638 	struct snd_card *card;
639 	struct list_head *p;
640 
641 	if (chip == (void *)-1L)
642 		return;
643 
644 	card = chip->card;
645 
646 	mutex_lock(&register_mutex);
647 	if (atomic_inc_return(&chip->shutdown) == 1) {
648 		struct snd_usb_stream *as;
649 		struct snd_usb_endpoint *ep;
650 		struct usb_mixer_interface *mixer;
651 
652 		/* wait until all pending tasks done;
653 		 * they are protected by snd_usb_lock_shutdown()
654 		 */
655 		wait_event(chip->shutdown_wait,
656 			   !atomic_read(&chip->usage_count));
657 		snd_card_disconnect(card);
658 		/* release the pcm resources */
659 		list_for_each_entry(as, &chip->pcm_list, list) {
660 			snd_usb_stream_disconnect(as);
661 		}
662 		/* release the endpoint resources */
663 		list_for_each_entry(ep, &chip->ep_list, list) {
664 			snd_usb_endpoint_release(ep);
665 		}
666 		/* release the midi resources */
667 		list_for_each(p, &chip->midi_list) {
668 			snd_usbmidi_disconnect(p);
669 		}
670 		/* release mixer resources */
671 		list_for_each_entry(mixer, &chip->mixer_list, list) {
672 			snd_usb_mixer_disconnect(mixer);
673 		}
674 	}
675 
676 	chip->num_interfaces--;
677 	if (chip->num_interfaces <= 0) {
678 		usb_chip[chip->index] = NULL;
679 		mutex_unlock(&register_mutex);
680 		snd_card_free_when_closed(card);
681 	} else {
682 		mutex_unlock(&register_mutex);
683 	}
684 }
685 
686 /* lock the shutdown (disconnect) task and autoresume */
687 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
688 {
689 	int err;
690 
691 	atomic_inc(&chip->usage_count);
692 	if (atomic_read(&chip->shutdown)) {
693 		err = -EIO;
694 		goto error;
695 	}
696 	err = snd_usb_autoresume(chip);
697 	if (err < 0)
698 		goto error;
699 	return 0;
700 
701  error:
702 	if (atomic_dec_and_test(&chip->usage_count))
703 		wake_up(&chip->shutdown_wait);
704 	return err;
705 }
706 
707 /* autosuspend and unlock the shutdown */
708 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
709 {
710 	snd_usb_autosuspend(chip);
711 	if (atomic_dec_and_test(&chip->usage_count))
712 		wake_up(&chip->shutdown_wait);
713 }
714 
715 #ifdef CONFIG_PM
716 
717 int snd_usb_autoresume(struct snd_usb_audio *chip)
718 {
719 	if (atomic_read(&chip->shutdown))
720 		return -EIO;
721 	if (atomic_inc_return(&chip->active) == 1)
722 		return usb_autopm_get_interface(chip->pm_intf);
723 	return 0;
724 }
725 
726 void snd_usb_autosuspend(struct snd_usb_audio *chip)
727 {
728 	if (atomic_read(&chip->shutdown))
729 		return;
730 	if (atomic_dec_and_test(&chip->active))
731 		usb_autopm_put_interface(chip->pm_intf);
732 }
733 
734 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
735 {
736 	struct snd_usb_audio *chip = usb_get_intfdata(intf);
737 	struct snd_usb_stream *as;
738 	struct usb_mixer_interface *mixer;
739 	struct list_head *p;
740 
741 	if (chip == (void *)-1L)
742 		return 0;
743 
744 	chip->autosuspended = !!PMSG_IS_AUTO(message);
745 	if (!chip->autosuspended)
746 		snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
747 	if (!chip->num_suspended_intf++) {
748 		list_for_each_entry(as, &chip->pcm_list, list) {
749 			snd_pcm_suspend_all(as->pcm);
750 			as->substream[0].need_setup_ep =
751 				as->substream[1].need_setup_ep = true;
752 		}
753 		list_for_each(p, &chip->midi_list)
754 			snd_usbmidi_suspend(p);
755 		list_for_each_entry(mixer, &chip->mixer_list, list)
756 			snd_usb_mixer_suspend(mixer);
757 	}
758 
759 	return 0;
760 }
761 
762 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
763 {
764 	struct snd_usb_audio *chip = usb_get_intfdata(intf);
765 	struct usb_mixer_interface *mixer;
766 	struct list_head *p;
767 	int err = 0;
768 
769 	if (chip == (void *)-1L)
770 		return 0;
771 	if (--chip->num_suspended_intf)
772 		return 0;
773 
774 	atomic_inc(&chip->active); /* avoid autopm */
775 	/*
776 	 * ALSA leaves material resumption to user space
777 	 * we just notify and restart the mixers
778 	 */
779 	list_for_each_entry(mixer, &chip->mixer_list, list) {
780 		err = snd_usb_mixer_resume(mixer, reset_resume);
781 		if (err < 0)
782 			goto err_out;
783 	}
784 
785 	list_for_each(p, &chip->midi_list) {
786 		snd_usbmidi_resume(p);
787 	}
788 
789 	if (!chip->autosuspended)
790 		snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
791 	chip->autosuspended = 0;
792 
793 err_out:
794 	atomic_dec(&chip->active); /* allow autopm after this point */
795 	return err;
796 }
797 
798 static int usb_audio_resume(struct usb_interface *intf)
799 {
800 	return __usb_audio_resume(intf, false);
801 }
802 
803 static int usb_audio_reset_resume(struct usb_interface *intf)
804 {
805 	return __usb_audio_resume(intf, true);
806 }
807 #else
808 #define usb_audio_suspend	NULL
809 #define usb_audio_resume	NULL
810 #define usb_audio_reset_resume	NULL
811 #endif		/* CONFIG_PM */
812 
813 static struct usb_device_id usb_audio_ids [] = {
814 #include "quirks-table.h"
815     { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
816       .bInterfaceClass = USB_CLASS_AUDIO,
817       .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
818     { }						/* Terminating entry */
819 };
820 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
821 
822 /*
823  * entry point for linux usb interface
824  */
825 
826 static struct usb_driver usb_audio_driver = {
827 	.name =		"snd-usb-audio",
828 	.probe =	usb_audio_probe,
829 	.disconnect =	usb_audio_disconnect,
830 	.suspend =	usb_audio_suspend,
831 	.resume =	usb_audio_resume,
832 	.reset_resume =	usb_audio_reset_resume,
833 	.id_table =	usb_audio_ids,
834 	.supports_autosuspend = 1,
835 };
836 
837 module_usb_driver(usb_audio_driver);
838