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