xref: /openbmc/linux/sound/usb/card.c (revision 6774def6)
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 
86 module_param_array(index, int, NULL, 0444);
87 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
88 module_param_array(id, charp, NULL, 0444);
89 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
90 module_param_array(enable, bool, NULL, 0444);
91 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
92 module_param_array(vid, int, NULL, 0444);
93 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
94 module_param_array(pid, int, NULL, 0444);
95 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
96 module_param_array(device_setup, int, NULL, 0444);
97 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
98 module_param(ignore_ctl_error, bool, 0444);
99 MODULE_PARM_DESC(ignore_ctl_error,
100 		 "Ignore errors from USB controller for mixer interfaces.");
101 module_param(autoclock, bool, 0444);
102 MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
103 
104 /*
105  * we keep the snd_usb_audio_t instances by ourselves for merging
106  * the all interfaces on the same card as one sound device.
107  */
108 
109 static DEFINE_MUTEX(register_mutex);
110 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
111 static struct usb_driver usb_audio_driver;
112 
113 /*
114  * disconnect streams
115  * called from snd_usb_audio_disconnect()
116  */
117 static void snd_usb_stream_disconnect(struct list_head *head)
118 {
119 	int idx;
120 	struct snd_usb_stream *as;
121 	struct snd_usb_substream *subs;
122 
123 	as = list_entry(head, struct snd_usb_stream, list);
124 	for (idx = 0; idx < 2; idx++) {
125 		subs = &as->substream[idx];
126 		if (!subs->num_formats)
127 			continue;
128 		subs->interface = -1;
129 		subs->data_endpoint = NULL;
130 		subs->sync_endpoint = NULL;
131 	}
132 }
133 
134 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
135 {
136 	struct usb_device *dev = chip->dev;
137 	struct usb_host_interface *alts;
138 	struct usb_interface_descriptor *altsd;
139 	struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
140 
141 	if (!iface) {
142 		dev_err(&dev->dev, "%u:%d : does not exist\n",
143 			ctrlif, interface);
144 		return -EINVAL;
145 	}
146 
147 	alts = &iface->altsetting[0];
148 	altsd = get_iface_desc(alts);
149 
150 	/*
151 	 * Android with both accessory and audio interfaces enabled gets the
152 	 * interface numbers wrong.
153 	 */
154 	if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
155 	     chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
156 	    interface == 0 &&
157 	    altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
158 	    altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
159 		interface = 2;
160 		iface = usb_ifnum_to_if(dev, interface);
161 		if (!iface)
162 			return -EINVAL;
163 		alts = &iface->altsetting[0];
164 		altsd = get_iface_desc(alts);
165 	}
166 
167 	if (usb_interface_claimed(iface)) {
168 		dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
169 			ctrlif, interface);
170 		return -EINVAL;
171 	}
172 
173 	if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
174 	     altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
175 	    altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
176 		int err = snd_usbmidi_create(chip->card, iface,
177 					     &chip->midi_list, NULL);
178 		if (err < 0) {
179 			dev_err(&dev->dev,
180 				"%u:%d: cannot create sequencer device\n",
181 				ctrlif, interface);
182 			return -EINVAL;
183 		}
184 		usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
185 
186 		return 0;
187 	}
188 
189 	if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
190 	     altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
191 	    altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
192 		dev_dbg(&dev->dev,
193 			"%u:%d: skipping non-supported interface %d\n",
194 			ctrlif, interface, altsd->bInterfaceClass);
195 		/* skip non-supported classes */
196 		return -EINVAL;
197 	}
198 
199 	if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
200 		dev_err(&dev->dev, "low speed audio streaming not supported\n");
201 		return -EINVAL;
202 	}
203 
204 	if (! snd_usb_parse_audio_interface(chip, interface)) {
205 		usb_set_interface(dev, interface, 0); /* reset the current interface */
206 		usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
207 		return -EINVAL;
208 	}
209 
210 	return 0;
211 }
212 
213 /*
214  * parse audio control descriptor and create pcm/midi streams
215  */
216 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
217 {
218 	struct usb_device *dev = chip->dev;
219 	struct usb_host_interface *host_iface;
220 	struct usb_interface_descriptor *altsd;
221 	void *control_header;
222 	int i, protocol;
223 
224 	/* find audiocontrol interface */
225 	host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
226 	control_header = snd_usb_find_csint_desc(host_iface->extra,
227 						 host_iface->extralen,
228 						 NULL, UAC_HEADER);
229 	altsd = get_iface_desc(host_iface);
230 	protocol = altsd->bInterfaceProtocol;
231 
232 	if (!control_header) {
233 		dev_err(&dev->dev, "cannot find UAC_HEADER\n");
234 		return -EINVAL;
235 	}
236 
237 	switch (protocol) {
238 	default:
239 		dev_warn(&dev->dev,
240 			 "unknown interface protocol %#02x, assuming v1\n",
241 			 protocol);
242 		/* fall through */
243 
244 	case UAC_VERSION_1: {
245 		struct uac1_ac_header_descriptor *h1 = control_header;
246 
247 		if (!h1->bInCollection) {
248 			dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
249 			return -EINVAL;
250 		}
251 
252 		if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
253 			dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
254 			return -EINVAL;
255 		}
256 
257 		for (i = 0; i < h1->bInCollection; i++)
258 			snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
259 
260 		break;
261 	}
262 
263 	case UAC_VERSION_2: {
264 		struct usb_interface_assoc_descriptor *assoc =
265 			usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
266 
267 		if (!assoc) {
268 			/*
269 			 * Firmware writers cannot count to three.  So to find
270 			 * the IAD on the NuForce UDH-100, also check the next
271 			 * interface.
272 			 */
273 			struct usb_interface *iface =
274 				usb_ifnum_to_if(dev, ctrlif + 1);
275 			if (iface &&
276 			    iface->intf_assoc &&
277 			    iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
278 			    iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
279 				assoc = iface->intf_assoc;
280 		}
281 
282 		if (!assoc) {
283 			dev_err(&dev->dev, "Audio class v2 interfaces need an interface association\n");
284 			return -EINVAL;
285 		}
286 
287 		for (i = 0; i < assoc->bInterfaceCount; i++) {
288 			int intf = assoc->bFirstInterface + i;
289 
290 			if (intf != ctrlif)
291 				snd_usb_create_stream(chip, ctrlif, intf);
292 		}
293 
294 		break;
295 	}
296 	}
297 
298 	return 0;
299 }
300 
301 /*
302  * free the chip instance
303  *
304  * here we have to do not much, since pcm and controls are already freed
305  *
306  */
307 
308 static int snd_usb_audio_free(struct snd_usb_audio *chip)
309 {
310 	struct list_head *p, *n;
311 
312 	list_for_each_safe(p, n, &chip->ep_list)
313 		snd_usb_endpoint_free(p);
314 
315 	mutex_destroy(&chip->mutex);
316 	kfree(chip);
317 	return 0;
318 }
319 
320 static int snd_usb_audio_dev_free(struct snd_device *device)
321 {
322 	struct snd_usb_audio *chip = device->device_data;
323 	return snd_usb_audio_free(chip);
324 }
325 
326 static void remove_trailing_spaces(char *str)
327 {
328 	char *p;
329 
330 	if (!*str)
331 		return;
332 	for (p = str + strlen(str) - 1; p >= str && isspace(*p); p--)
333 		*p = 0;
334 }
335 
336 /*
337  * create a chip instance and set its names.
338  */
339 static int snd_usb_audio_create(struct usb_interface *intf,
340 				struct usb_device *dev, int idx,
341 				const struct snd_usb_audio_quirk *quirk,
342 				struct snd_usb_audio **rchip)
343 {
344 	struct snd_card *card;
345 	struct snd_usb_audio *chip;
346 	int err, len;
347 	char component[14];
348 	static struct snd_device_ops ops = {
349 		.dev_free =	snd_usb_audio_dev_free,
350 	};
351 
352 	*rchip = NULL;
353 
354 	switch (snd_usb_get_speed(dev)) {
355 	case USB_SPEED_LOW:
356 	case USB_SPEED_FULL:
357 	case USB_SPEED_HIGH:
358 	case USB_SPEED_WIRELESS:
359 	case USB_SPEED_SUPER:
360 		break;
361 	default:
362 		dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
363 		return -ENXIO;
364 	}
365 
366 	err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
367 			   0, &card);
368 	if (err < 0) {
369 		dev_err(&dev->dev, "cannot create card instance %d\n", idx);
370 		return err;
371 	}
372 
373 	chip = kzalloc(sizeof(*chip), GFP_KERNEL);
374 	if (! chip) {
375 		snd_card_free(card);
376 		return -ENOMEM;
377 	}
378 
379 	mutex_init(&chip->mutex);
380 	init_rwsem(&chip->shutdown_rwsem);
381 	chip->index = idx;
382 	chip->dev = dev;
383 	chip->card = card;
384 	chip->setup = device_setup[idx];
385 	chip->autoclock = autoclock;
386 	chip->probing = 1;
387 
388 	chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
389 			      le16_to_cpu(dev->descriptor.idProduct));
390 	INIT_LIST_HEAD(&chip->pcm_list);
391 	INIT_LIST_HEAD(&chip->ep_list);
392 	INIT_LIST_HEAD(&chip->midi_list);
393 	INIT_LIST_HEAD(&chip->mixer_list);
394 
395 	if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
396 		snd_usb_audio_free(chip);
397 		snd_card_free(card);
398 		return err;
399 	}
400 
401 	strcpy(card->driver, "USB-Audio");
402 	sprintf(component, "USB%04x:%04x",
403 		USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
404 	snd_component_add(card, component);
405 
406 	/* retrieve the device string as shortname */
407 	if (quirk && quirk->product_name && *quirk->product_name) {
408 		strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
409 	} else {
410 		if (!dev->descriptor.iProduct ||
411 		    usb_string(dev, dev->descriptor.iProduct,
412 		    card->shortname, sizeof(card->shortname)) <= 0) {
413 			/* no name available from anywhere, so use ID */
414 			sprintf(card->shortname, "USB Device %#04x:%#04x",
415 				USB_ID_VENDOR(chip->usb_id),
416 				USB_ID_PRODUCT(chip->usb_id));
417 		}
418 	}
419 	remove_trailing_spaces(card->shortname);
420 
421 	/* retrieve the vendor and device strings as longname */
422 	if (quirk && quirk->vendor_name && *quirk->vendor_name) {
423 		len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
424 	} else {
425 		if (dev->descriptor.iManufacturer)
426 			len = usb_string(dev, dev->descriptor.iManufacturer,
427 					 card->longname, sizeof(card->longname));
428 		else
429 			len = 0;
430 		/* we don't really care if there isn't any vendor string */
431 	}
432 	if (len > 0) {
433 		remove_trailing_spaces(card->longname);
434 		if (*card->longname)
435 			strlcat(card->longname, " ", sizeof(card->longname));
436 	}
437 
438 	strlcat(card->longname, card->shortname, sizeof(card->longname));
439 
440 	len = strlcat(card->longname, " at ", sizeof(card->longname));
441 
442 	if (len < sizeof(card->longname))
443 		usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
444 
445 	switch (snd_usb_get_speed(dev)) {
446 	case USB_SPEED_LOW:
447 		strlcat(card->longname, ", low speed", sizeof(card->longname));
448 		break;
449 	case USB_SPEED_FULL:
450 		strlcat(card->longname, ", full speed", sizeof(card->longname));
451 		break;
452 	case USB_SPEED_HIGH:
453 		strlcat(card->longname, ", high speed", sizeof(card->longname));
454 		break;
455 	case USB_SPEED_SUPER:
456 		strlcat(card->longname, ", super speed", sizeof(card->longname));
457 		break;
458 	default:
459 		break;
460 	}
461 
462 	snd_usb_audio_create_proc(chip);
463 
464 	*rchip = chip;
465 	return 0;
466 }
467 
468 /*
469  * probe the active usb device
470  *
471  * note that this can be called multiple times per a device, when it
472  * includes multiple audio control interfaces.
473  *
474  * thus we check the usb device pointer and creates the card instance
475  * only at the first time.  the successive calls of this function will
476  * append the pcm interface to the corresponding card.
477  */
478 static struct snd_usb_audio *
479 snd_usb_audio_probe(struct usb_device *dev,
480 		    struct usb_interface *intf,
481 		    const struct usb_device_id *usb_id)
482 {
483 	const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
484 	int i, err;
485 	struct snd_usb_audio *chip;
486 	struct usb_host_interface *alts;
487 	int ifnum;
488 	u32 id;
489 
490 	alts = &intf->altsetting[0];
491 	ifnum = get_iface_desc(alts)->bInterfaceNumber;
492 	id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
493 		    le16_to_cpu(dev->descriptor.idProduct));
494 	if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
495 		goto __err_val;
496 
497 	if (snd_usb_apply_boot_quirk(dev, intf, quirk) < 0)
498 		goto __err_val;
499 
500 	/*
501 	 * found a config.  now register to ALSA
502 	 */
503 
504 	/* check whether it's already registered */
505 	chip = NULL;
506 	mutex_lock(&register_mutex);
507 	for (i = 0; i < SNDRV_CARDS; i++) {
508 		if (usb_chip[i] && usb_chip[i]->dev == dev) {
509 			if (usb_chip[i]->shutdown) {
510 				dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
511 				goto __error;
512 			}
513 			chip = usb_chip[i];
514 			chip->probing = 1;
515 			break;
516 		}
517 	}
518 	if (! chip) {
519 		/* it's a fresh one.
520 		 * now look for an empty slot and create a new card instance
521 		 */
522 		for (i = 0; i < SNDRV_CARDS; i++)
523 			if (enable[i] && ! usb_chip[i] &&
524 			    (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
525 			    (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
526 				if (snd_usb_audio_create(intf, dev, i, quirk,
527 							 &chip) < 0) {
528 					goto __error;
529 				}
530 				chip->pm_intf = intf;
531 				break;
532 			}
533 		if (!chip) {
534 			dev_err(&dev->dev, "no available usb audio device\n");
535 			goto __error;
536 		}
537 	}
538 
539 	/*
540 	 * For devices with more than one control interface, we assume the
541 	 * first contains the audio controls. We might need a more specific
542 	 * check here in the future.
543 	 */
544 	if (!chip->ctrl_intf)
545 		chip->ctrl_intf = alts;
546 
547 	chip->txfr_quirk = 0;
548 	err = 1; /* continue */
549 	if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
550 		/* need some special handlings */
551 		if ((err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk)) < 0)
552 			goto __error;
553 	}
554 
555 	if (err > 0) {
556 		/* create normal USB audio interfaces */
557 		if (snd_usb_create_streams(chip, ifnum) < 0 ||
558 		    snd_usb_create_mixer(chip, ifnum, ignore_ctl_error) < 0) {
559 			goto __error;
560 		}
561 	}
562 
563 	/* we are allowed to call snd_card_register() many times */
564 	if (snd_card_register(chip->card) < 0) {
565 		goto __error;
566 	}
567 
568 	usb_chip[chip->index] = chip;
569 	chip->num_interfaces++;
570 	chip->probing = 0;
571 	mutex_unlock(&register_mutex);
572 	return chip;
573 
574  __error:
575 	if (chip) {
576 		if (!chip->num_interfaces)
577 			snd_card_free(chip->card);
578 		chip->probing = 0;
579 	}
580 	mutex_unlock(&register_mutex);
581  __err_val:
582 	return NULL;
583 }
584 
585 /*
586  * we need to take care of counter, since disconnection can be called also
587  * many times as well as usb_audio_probe().
588  */
589 static void snd_usb_audio_disconnect(struct usb_device *dev,
590 				     struct snd_usb_audio *chip)
591 {
592 	struct snd_card *card;
593 	struct list_head *p;
594 	bool was_shutdown;
595 
596 	if (chip == (void *)-1L)
597 		return;
598 
599 	card = chip->card;
600 	down_write(&chip->shutdown_rwsem);
601 	was_shutdown = chip->shutdown;
602 	chip->shutdown = 1;
603 	up_write(&chip->shutdown_rwsem);
604 
605 	mutex_lock(&register_mutex);
606 	if (!was_shutdown) {
607 		struct snd_usb_endpoint *ep;
608 
609 		snd_card_disconnect(card);
610 		/* release the pcm resources */
611 		list_for_each(p, &chip->pcm_list) {
612 			snd_usb_stream_disconnect(p);
613 		}
614 		/* release the endpoint resources */
615 		list_for_each_entry(ep, &chip->ep_list, list) {
616 			snd_usb_endpoint_release(ep);
617 		}
618 		/* release the midi resources */
619 		list_for_each(p, &chip->midi_list) {
620 			snd_usbmidi_disconnect(p);
621 		}
622 		/* release mixer resources */
623 		list_for_each(p, &chip->mixer_list) {
624 			snd_usb_mixer_disconnect(p);
625 		}
626 	}
627 
628 	chip->num_interfaces--;
629 	if (chip->num_interfaces <= 0) {
630 		usb_chip[chip->index] = NULL;
631 		mutex_unlock(&register_mutex);
632 		snd_card_free_when_closed(card);
633 	} else {
634 		mutex_unlock(&register_mutex);
635 	}
636 }
637 
638 /*
639  * new 2.5 USB kernel API
640  */
641 static int usb_audio_probe(struct usb_interface *intf,
642 			   const struct usb_device_id *id)
643 {
644 	struct snd_usb_audio *chip;
645 	chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
646 	if (chip) {
647 		usb_set_intfdata(intf, chip);
648 		return 0;
649 	} else
650 		return -EIO;
651 }
652 
653 static void usb_audio_disconnect(struct usb_interface *intf)
654 {
655 	snd_usb_audio_disconnect(interface_to_usbdev(intf),
656 				 usb_get_intfdata(intf));
657 }
658 
659 #ifdef CONFIG_PM
660 
661 int snd_usb_autoresume(struct snd_usb_audio *chip)
662 {
663 	int err = -ENODEV;
664 
665 	down_read(&chip->shutdown_rwsem);
666 	if (chip->probing && chip->in_pm)
667 		err = 0;
668 	else if (!chip->shutdown)
669 		err = usb_autopm_get_interface(chip->pm_intf);
670 	up_read(&chip->shutdown_rwsem);
671 
672 	return err;
673 }
674 
675 void snd_usb_autosuspend(struct snd_usb_audio *chip)
676 {
677 	down_read(&chip->shutdown_rwsem);
678 	if (!chip->shutdown && !chip->probing && !chip->in_pm)
679 		usb_autopm_put_interface(chip->pm_intf);
680 	up_read(&chip->shutdown_rwsem);
681 }
682 
683 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
684 {
685 	struct snd_usb_audio *chip = usb_get_intfdata(intf);
686 	struct snd_usb_stream *as;
687 	struct usb_mixer_interface *mixer;
688 	struct list_head *p;
689 
690 	if (chip == (void *)-1L)
691 		return 0;
692 
693 	if (!PMSG_IS_AUTO(message)) {
694 		snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
695 		if (!chip->num_suspended_intf++) {
696 			list_for_each_entry(as, &chip->pcm_list, list) {
697 				snd_pcm_suspend_all(as->pcm);
698 				as->substream[0].need_setup_ep =
699 					as->substream[1].need_setup_ep = true;
700 			}
701 			list_for_each(p, &chip->midi_list) {
702 				snd_usbmidi_suspend(p);
703 			}
704 		}
705 	} else {
706 		/*
707 		 * otherwise we keep the rest of the system in the dark
708 		 * to keep this transparent
709 		 */
710 		if (!chip->num_suspended_intf++)
711 			chip->autosuspended = 1;
712 	}
713 
714 	if (chip->num_suspended_intf == 1)
715 		list_for_each_entry(mixer, &chip->mixer_list, list)
716 			snd_usb_mixer_suspend(mixer);
717 
718 	return 0;
719 }
720 
721 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
722 {
723 	struct snd_usb_audio *chip = usb_get_intfdata(intf);
724 	struct usb_mixer_interface *mixer;
725 	struct list_head *p;
726 	int err = 0;
727 
728 	if (chip == (void *)-1L)
729 		return 0;
730 	if (--chip->num_suspended_intf)
731 		return 0;
732 
733 	chip->in_pm = 1;
734 	/*
735 	 * ALSA leaves material resumption to user space
736 	 * we just notify and restart the mixers
737 	 */
738 	list_for_each_entry(mixer, &chip->mixer_list, list) {
739 		err = snd_usb_mixer_resume(mixer, reset_resume);
740 		if (err < 0)
741 			goto err_out;
742 	}
743 
744 	list_for_each(p, &chip->midi_list) {
745 		snd_usbmidi_resume(p);
746 	}
747 
748 	if (!chip->autosuspended)
749 		snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
750 	chip->autosuspended = 0;
751 
752 err_out:
753 	chip->in_pm = 0;
754 	return err;
755 }
756 
757 static int usb_audio_resume(struct usb_interface *intf)
758 {
759 	return __usb_audio_resume(intf, false);
760 }
761 
762 static int usb_audio_reset_resume(struct usb_interface *intf)
763 {
764 	return __usb_audio_resume(intf, true);
765 }
766 #else
767 #define usb_audio_suspend	NULL
768 #define usb_audio_resume	NULL
769 #define usb_audio_reset_resume	NULL
770 #endif		/* CONFIG_PM */
771 
772 static struct usb_device_id usb_audio_ids [] = {
773 #include "quirks-table.h"
774     { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
775       .bInterfaceClass = USB_CLASS_AUDIO,
776       .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
777     { }						/* Terminating entry */
778 };
779 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
780 
781 /*
782  * entry point for linux usb interface
783  */
784 
785 static struct usb_driver usb_audio_driver = {
786 	.name =		"snd-usb-audio",
787 	.probe =	usb_audio_probe,
788 	.disconnect =	usb_audio_disconnect,
789 	.suspend =	usb_audio_suspend,
790 	.resume =	usb_audio_resume,
791 	.reset_resume =	usb_audio_reset_resume,
792 	.id_table =	usb_audio_ids,
793 	.supports_autosuspend = 1,
794 };
795 
796 module_usb_driver(usb_audio_driver);
797