1// SPDX-License-Identifier: GPL-2.0-or-later
  2/*
  3 *   (Tentative) USB Audio Driver for ALSA
  4 *
  5 *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
  6 *
  7 *   Many codes borrowed from audio.c by
  8 *	    Alan Cox (alan@lxorguk.ukuu.org.uk)
  9 *	    Thomas Sailer (sailer@ife.ee.ethz.ch)
 10 *
 11 *   Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com>
 12 *
 13 *  NOTES:
 14 *
 15 *   - the linked URBs would be preferred but not used so far because of
 16 *     the instability of unlinking.
 17 *   - type II is not supported properly.  there is no device which supports
 18 *     this type *correctly*.  SB extigy looks as if it supports, but it's
 19 *     indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
 20 */
 21
 22
 23#include <linux/bitops.h>
 24#include <linux/init.h>
 25#include <linux/list.h>
 26#include <linux/slab.h>
 27#include <linux/string.h>
 28#include <linux/ctype.h>
 29#include <linux/usb.h>
 30#include <linux/moduleparam.h>
 31#include <linux/mutex.h>
 32#include <linux/usb/audio.h>
 33#include <linux/usb/audio-v2.h>
 34#include <linux/usb/audio-v3.h>
 35#include <linux/module.h>
 36
 37#include <sound/control.h>
 38#include <sound/core.h>
 39#include <sound/info.h>
 40#include <sound/pcm.h>
 41#include <sound/pcm_params.h>
 42#include <sound/initval.h>
 43
 44#include "usbaudio.h"
 45#include "card.h"
 46#include "midi.h"
 47#include "mixer.h"
 48#include "proc.h"
 49#include "quirks.h"
 50#include "endpoint.h"
 51#include "helper.h"
 52#include "debug.h"
 53#include "pcm.h"
 54#include "format.h"
 55#include "power.h"
 56#include "stream.h"
 57#include "media.h"
 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 */
 67static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
 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 };
 71static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
 72static bool ignore_ctl_error;
 73static bool autoclock = true;
 74static char *quirk_alias[SNDRV_CARDS];
 75static char *delayed_register[SNDRV_CARDS];
 76
 77bool snd_usb_use_vmalloc = true;
 78bool snd_usb_skip_validation;
 79
 80module_param_array(index, int, NULL, 0444);
 81MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
 82module_param_array(id, charp, NULL, 0444);
 83MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
 84module_param_array(enable, bool, NULL, 0444);
 85MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
 86module_param_array(vid, int, NULL, 0444);
 87MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
 88module_param_array(pid, int, NULL, 0444);
 89MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
 90module_param_array(device_setup, int, NULL, 0444);
 91MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
 92module_param(ignore_ctl_error, bool, 0444);
 93MODULE_PARM_DESC(ignore_ctl_error,
 94		 "Ignore errors from USB controller for mixer interfaces.");
 95module_param(autoclock, bool, 0444);
 96MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
 97module_param_array(quirk_alias, charp, NULL, 0444);
 98MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");
 99module_param_array(delayed_register, charp, NULL, 0444);
100MODULE_PARM_DESC(delayed_register, "Quirk for delayed registration, given by id:iface, e.g. 0123abcd:4.");
101module_param_named(use_vmalloc, snd_usb_use_vmalloc, bool, 0444);
102MODULE_PARM_DESC(use_vmalloc, "Use vmalloc for PCM intermediate buffers (default: yes).");
103module_param_named(skip_validation, snd_usb_skip_validation, bool, 0444);
104MODULE_PARM_DESC(skip_validation, "Skip unit descriptor validation (default: no).");
105
106/*
107 * we keep the snd_usb_audio_t instances by ourselves for merging
108 * the all interfaces on the same card as one sound device.
109 */
110
111static DEFINE_MUTEX(register_mutex);
112static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
113static struct usb_driver usb_audio_driver;
114
115/*
116 * disconnect streams
117 * called from usb_audio_disconnect()
118 */
119static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
120{
121	int idx;
122	struct snd_usb_substream *subs;
123
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
134static 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					     chip->usb_id);
179		if (err < 0) {
180			dev_err(&dev->dev,
181				"%u:%d: cannot create sequencer device\n",
182				ctrlif, interface);
183			return -EINVAL;
184		}
185		usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
186
187		return 0;
188	}
189
190	if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
191	     altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
192	    altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
193		dev_dbg(&dev->dev,
194			"%u:%d: skipping non-supported interface %d\n",
195			ctrlif, interface, altsd->bInterfaceClass);
196		/* skip non-supported classes */
197		return -EINVAL;
198	}
199
200	if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
201		dev_err(&dev->dev, "low speed audio streaming not supported\n");
202		return -EINVAL;
203	}
204
205	if (! snd_usb_parse_audio_interface(chip, interface)) {
206		usb_set_interface(dev, interface, 0); /* reset the current interface */
207		usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
208	}
209
210	return 0;
211}
212
213/*
214 * parse audio control descriptor and create pcm/midi streams
215 */
216static 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	int i, protocol;
222
223	/* find audiocontrol interface */
224	host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
225	altsd = get_iface_desc(host_iface);
226	protocol = altsd->bInterfaceProtocol;
227
228	switch (protocol) {
229	default:
230		dev_warn(&dev->dev,
231			 "unknown interface protocol %#02x, assuming v1\n",
232			 protocol);
233		fallthrough;
234
235	case UAC_VERSION_1: {
236		struct uac1_ac_header_descriptor *h1;
237		int rest_bytes;
238
239		h1 = snd_usb_find_csint_desc(host_iface->extra,
240							 host_iface->extralen,
241							 NULL, UAC_HEADER);
242		if (!h1 || h1->bLength < sizeof(*h1)) {
243			dev_err(&dev->dev, "cannot find UAC_HEADER\n");
244			return -EINVAL;
245		}
246
247		rest_bytes = (void *)(host_iface->extra +
248				host_iface->extralen) - (void *)h1;
249
250		/* just to be sure -- this shouldn't hit at all */
251		if (rest_bytes <= 0) {
252			dev_err(&dev->dev, "invalid control header\n");
253			return -EINVAL;
254		}
255
256		if (rest_bytes < sizeof(*h1)) {
257			dev_err(&dev->dev, "too short v1 buffer descriptor\n");
258			return -EINVAL;
259		}
260
261		if (!h1->bInCollection) {
262			dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
263			return -EINVAL;
264		}
265
266		if (rest_bytes < h1->bLength) {
267			dev_err(&dev->dev, "invalid buffer length (v1)\n");
268			return -EINVAL;
269		}
270
271		if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
272			dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
273			return -EINVAL;
274		}
275
276		for (i = 0; i < h1->bInCollection; i++)
277			snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
278
279		break;
280	}
281
282	case UAC_VERSION_2:
283	case UAC_VERSION_3: {
284		struct usb_interface_assoc_descriptor *assoc =
285			usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
286
287		if (!assoc) {
288			/*
289			 * Firmware writers cannot count to three.  So to find
290			 * the IAD on the NuForce UDH-100, also check the next
291			 * interface.
292			 */
293			struct usb_interface *iface =
294				usb_ifnum_to_if(dev, ctrlif + 1);
295			if (iface &&
296			    iface->intf_assoc &&
297			    iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
298			    iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
299				assoc = iface->intf_assoc;
300		}
301
302		if (!assoc) {
303			dev_err(&dev->dev, "Audio class v2/v3 interfaces need an interface association\n");
304			return -EINVAL;
305		}
306
307		if (protocol == UAC_VERSION_3) {
308			int badd = assoc->bFunctionSubClass;
309
310			if (badd != UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0 &&
311			    (badd < UAC3_FUNCTION_SUBCLASS_GENERIC_IO ||
312			     badd > UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE)) {
313				dev_err(&dev->dev,
314					"Unsupported UAC3 BADD profile\n");
315				return -EINVAL;
316			}
317
318			chip->badd_profile = badd;
319		}
320
321		for (i = 0; i < assoc->bInterfaceCount; i++) {
322			int intf = assoc->bFirstInterface + i;
323
324			if (intf != ctrlif)
325				snd_usb_create_stream(chip, ctrlif, intf);
326		}
327
328		break;
329	}
330	}
331
332	return 0;
333}
334
335/*
336 * free the chip instance
337 *
338 * here we have to do not much, since pcm and controls are already freed
339 *
340 */
341
342static void snd_usb_audio_free(struct snd_card *card)
343{
344	struct snd_usb_audio *chip = card->private_data;
345	struct snd_usb_endpoint *ep, *n;
346
347	list_for_each_entry_safe(ep, n, &chip->ep_list, list)
348		snd_usb_endpoint_free(ep);
349
350	mutex_destroy(&chip->mutex);
351	if (!atomic_read(&chip->shutdown))
352		dev_set_drvdata(&chip->dev->dev, NULL);
353}
354
355static void usb_audio_make_shortname(struct usb_device *dev,
356				     struct snd_usb_audio *chip,
357				     const struct snd_usb_audio_quirk *quirk)
358{
359	struct snd_card *card = chip->card;
360
361	if (quirk && quirk->product_name && *quirk->product_name) {
362		strlcpy(card->shortname, quirk->product_name,
363			sizeof(card->shortname));
364		return;
365	}
366
367	/* retrieve the device string as shortname */
368	if (!dev->descriptor.iProduct ||
369	    usb_string(dev, dev->descriptor.iProduct,
370		       card->shortname, sizeof(card->shortname)) <= 0) {
371		/* no name available from anywhere, so use ID */
372		sprintf(card->shortname, "USB Device %#04x:%#04x",
373			USB_ID_VENDOR(chip->usb_id),
374			USB_ID_PRODUCT(chip->usb_id));
375	}
376
377	strim(card->shortname);
378}
379
380static void usb_audio_make_longname(struct usb_device *dev,
381				    struct snd_usb_audio *chip,
382				    const struct snd_usb_audio_quirk *quirk)
383{
384	struct snd_card *card = chip->card;
385	int len;
386
387	/* shortcut - if any pre-defined string is given, use it */
388	if (quirk && quirk->profile_name && *quirk->profile_name) {
389		strlcpy(card->longname, quirk->profile_name,
390			sizeof(card->longname));
391		return;
392	}
393
394	if (quirk && quirk->vendor_name && *quirk->vendor_name) {
395		len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
396	} else {
397		/* retrieve the vendor and device strings as longname */
398		if (dev->descriptor.iManufacturer)
399			len = usb_string(dev, dev->descriptor.iManufacturer,
400					 card->longname, sizeof(card->longname));
401		else
402			len = 0;
403		/* we don't really care if there isn't any vendor string */
404	}
405	if (len > 0) {
406		strim(card->longname);
407		if (*card->longname)
408			strlcat(card->longname, " ", sizeof(card->longname));
409	}
410
411	strlcat(card->longname, card->shortname, sizeof(card->longname));
412
413	len = strlcat(card->longname, " at ", sizeof(card->longname));
414
415	if (len < sizeof(card->longname))
416		usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
417
418	switch (snd_usb_get_speed(dev)) {
419	case USB_SPEED_LOW:
420		strlcat(card->longname, ", low speed", sizeof(card->longname));
421		break;
422	case USB_SPEED_FULL:
423		strlcat(card->longname, ", full speed", sizeof(card->longname));
424		break;
425	case USB_SPEED_HIGH:
426		strlcat(card->longname, ", high speed", sizeof(card->longname));
427		break;
428	case USB_SPEED_SUPER:
429		strlcat(card->longname, ", super speed", sizeof(card->longname));
430		break;
431	case USB_SPEED_SUPER_PLUS:
432		strlcat(card->longname, ", super speed plus", sizeof(card->longname));
433		break;
434	default:
435		break;
436	}
437}
438
439/*
440 * create a chip instance and set its names.
441 */
442static int snd_usb_audio_create(struct usb_interface *intf,
443				struct usb_device *dev, int idx,
444				const struct snd_usb_audio_quirk *quirk,
445				unsigned int usb_id,
446				struct snd_usb_audio **rchip)
447{
448	struct snd_card *card;
449	struct snd_usb_audio *chip;
450	int err;
451	char component[14];
452
453	*rchip = NULL;
454
455	switch (snd_usb_get_speed(dev)) {
456	case USB_SPEED_LOW:
457	case USB_SPEED_FULL:
458	case USB_SPEED_HIGH:
459	case USB_SPEED_WIRELESS:
460	case USB_SPEED_SUPER:
461	case USB_SPEED_SUPER_PLUS:
462		break;
463	default:
464		dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
465		return -ENXIO;
466	}
467
468	err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
469			   sizeof(*chip), &card);
470	if (err < 0) {
471		dev_err(&dev->dev, "cannot create card instance %d\n", idx);
472		return err;
473	}
474
475	chip = card->private_data;
476	mutex_init(&chip->mutex);
477	init_waitqueue_head(&chip->shutdown_wait);
478	chip->index = idx;
479	chip->dev = dev;
480	chip->card = card;
481	chip->setup = device_setup[idx];
482	chip->autoclock = autoclock;
483	atomic_set(&chip->active, 1); /* avoid autopm during probing */
484	atomic_set(&chip->usage_count, 0);
485	atomic_set(&chip->shutdown, 0);
486
487	chip->usb_id = usb_id;
488	INIT_LIST_HEAD(&chip->pcm_list);
489	INIT_LIST_HEAD(&chip->ep_list);
490	INIT_LIST_HEAD(&chip->midi_list);
491	INIT_LIST_HEAD(&chip->mixer_list);
492
493	card->private_free = snd_usb_audio_free;
494
495	strcpy(card->driver, "USB-Audio");
496	sprintf(component, "USB%04x:%04x",
497		USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
498	snd_component_add(card, component);
499
500	usb_audio_make_shortname(dev, chip, quirk);
501	usb_audio_make_longname(dev, chip, quirk);
502
503	snd_usb_audio_create_proc(chip);
504
505	*rchip = chip;
506	return 0;
507}
508
509/* look for a matching quirk alias id */
510static bool get_alias_id(struct usb_device *dev, unsigned int *id)
511{
512	int i;
513	unsigned int src, dst;
514
515	for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
516		if (!quirk_alias[i] ||
517		    sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
518		    src != *id)
519			continue;
520		dev_info(&dev->dev,
521			 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
522			 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
523			 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
524		*id = dst;
525		return true;
526	}
527
528	return false;
529}
530
531static bool check_delayed_register_option(struct snd_usb_audio *chip, int iface)
532{
533	int i;
534	unsigned int id, inum;
535
536	for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {
537		if (delayed_register[i] &&
538		    sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&
539		    id == chip->usb_id)
540			return inum != iface;
541	}
542
543	return false;
544}
545
546static const struct usb_device_id usb_audio_ids[]; /* defined below */
547
548/* look for the corresponding quirk */
549static const struct snd_usb_audio_quirk *
550get_alias_quirk(struct usb_device *dev, unsigned int id)
551{
552	const struct usb_device_id *p;
553
554	for (p = usb_audio_ids; p->match_flags; p++) {
555		/* FIXME: this checks only vendor:product pair in the list */
556		if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
557		    USB_DEVICE_ID_MATCH_DEVICE &&
558		    p->idVendor == USB_ID_VENDOR(id) &&
559		    p->idProduct == USB_ID_PRODUCT(id))
560			return (const struct snd_usb_audio_quirk *)p->driver_info;
561	}
562
563	return NULL;
564}
565
566/*
567 * probe the active usb device
568 *
569 * note that this can be called multiple times per a device, when it
570 * includes multiple audio control interfaces.
571 *
572 * thus we check the usb device pointer and creates the card instance
573 * only at the first time.  the successive calls of this function will
574 * append the pcm interface to the corresponding card.
575 */
576static int usb_audio_probe(struct usb_interface *intf,
577			   const struct usb_device_id *usb_id)
578{
579	struct usb_device *dev = interface_to_usbdev(intf);
580	const struct snd_usb_audio_quirk *quirk =
581		(const struct snd_usb_audio_quirk *)usb_id->driver_info;
582	struct snd_usb_audio *chip;
583	int i, err;
584	struct usb_host_interface *alts;
585	int ifnum;
586	u32 id;
587
588	alts = &intf->altsetting[0];
589	ifnum = get_iface_desc(alts)->bInterfaceNumber;
590	id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
591		    le16_to_cpu(dev->descriptor.idProduct));
592	if (get_alias_id(dev, &id))
593		quirk = get_alias_quirk(dev, id);
594	if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
595		return -ENXIO;
596
597	err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
598	if (err < 0)
599		return err;
600
601	/*
602	 * found a config.  now register to ALSA
603	 */
604
605	/* check whether it's already registered */
606	chip = NULL;
607	mutex_lock(&register_mutex);
608	for (i = 0; i < SNDRV_CARDS; i++) {
609		if (usb_chip[i] && usb_chip[i]->dev == dev) {
610			if (atomic_read(&usb_chip[i]->shutdown)) {
611				dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
612				err = -EIO;
613				goto __error;
614			}
615			chip = usb_chip[i];
616			atomic_inc(&chip->active); /* avoid autopm */
617			break;
618		}
619	}
620	if (! chip) {
621		err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);
622		if (err < 0)
623			goto __error;
624
625		/* it's a fresh one.
626		 * now look for an empty slot and create a new card instance
627		 */
628		for (i = 0; i < SNDRV_CARDS; i++)
629			if (!usb_chip[i] &&
630			    (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
631			    (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
632				if (enable[i]) {
633					err = snd_usb_audio_create(intf, dev, i, quirk,
634								   id, &chip);
635					if (err < 0)
636						goto __error;
 
637					break;
638				} else if (vid[i] != -1 || pid[i] != -1) {
639					dev_info(&dev->dev,
640						 "device (%04x:%04x) is disabled\n",
641						 USB_ID_VENDOR(id),
642						 USB_ID_PRODUCT(id));
643					err = -ENOENT;
644					goto __error;
645				}
646			}
647		if (!chip) {
648			dev_err(&dev->dev, "no available usb audio device\n");
649			err = -ENODEV;
650			goto __error;
651		}
652	}
653
654	if (chip->num_interfaces >= MAX_CARD_INTERFACES) {
655		dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");
656		err = -EINVAL;
657		goto __error;
658	}
659
660	dev_set_drvdata(&dev->dev, chip);
661
662	/*
663	 * For devices with more than one control interface, we assume the
664	 * first contains the audio controls. We might need a more specific
665	 * check here in the future.
666	 */
667	if (!chip->ctrl_intf)
668		chip->ctrl_intf = alts;
669
670	chip->txfr_quirk = 0;
671	err = 1; /* continue */
672	if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
673		/* need some special handlings */
674		err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
675		if (err < 0)
676			goto __error;
677	}
678
679	if (err > 0) {
680		/* create normal USB audio interfaces */
681		err = snd_usb_create_streams(chip, ifnum);
682		if (err < 0)
683			goto __error;
684		err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
685		if (err < 0)
686			goto __error;
687	}
688
689	if (chip->need_delayed_register) {
690		dev_info(&dev->dev,
691			 "Found post-registration device assignment: %08x:%02x\n",
692			 chip->usb_id, ifnum);
693		chip->need_delayed_register = false; /* clear again */
694	}
695
696	/* we are allowed to call snd_card_register() many times, but first
697	 * check to see if a device needs to skip it or do anything special
698	 */
699	if (!snd_usb_registration_quirk(chip, ifnum) &&
700	    !check_delayed_register_option(chip, ifnum)) {
701		err = snd_card_register(chip->card);
702		if (err < 0)
703			goto __error;
704	}
705
706	if (quirk && quirk->shares_media_device) {
707		/* don't want to fail when snd_media_device_create() fails */
708		snd_media_device_create(chip, intf);
709	}
710
711	usb_chip[chip->index] = chip;
712	chip->intf[chip->num_interfaces] = intf;
713	chip->num_interfaces++;
714	usb_set_intfdata(intf, chip);
715	atomic_dec(&chip->active);
716	mutex_unlock(&register_mutex);
717	return 0;
718
719 __error:
720	if (chip) {
721		/* chip->active is inside the chip->card object,
722		 * decrement before memory is possibly returned.
723		 */
724		atomic_dec(&chip->active);
725		if (!chip->num_interfaces)
726			snd_card_free(chip->card);
727	}
728	mutex_unlock(&register_mutex);
729	return err;
730}
731
732/*
733 * we need to take care of counter, since disconnection can be called also
734 * many times as well as usb_audio_probe().
735 */
736static void usb_audio_disconnect(struct usb_interface *intf)
737{
738	struct snd_usb_audio *chip = usb_get_intfdata(intf);
739	struct snd_card *card;
740	struct list_head *p;
741
742	if (chip == (void *)-1L)
743		return;
744
745	card = chip->card;
746
747	mutex_lock(&register_mutex);
748	if (atomic_inc_return(&chip->shutdown) == 1) {
749		struct snd_usb_stream *as;
750		struct snd_usb_endpoint *ep;
751		struct usb_mixer_interface *mixer;
752
753		/* wait until all pending tasks done;
754		 * they are protected by snd_usb_lock_shutdown()
755		 */
756		wait_event(chip->shutdown_wait,
757			   !atomic_read(&chip->usage_count));
758		snd_card_disconnect(card);
759		/* release the pcm resources */
760		list_for_each_entry(as, &chip->pcm_list, list) {
761			snd_usb_stream_disconnect(as);
762		}
763		/* release the endpoint resources */
764		list_for_each_entry(ep, &chip->ep_list, list) {
765			snd_usb_endpoint_release(ep);
766		}
767		/* release the midi resources */
768		list_for_each(p, &chip->midi_list) {
769			snd_usbmidi_disconnect(p);
770		}
771		/*
772		 * Nice to check quirk && quirk->shares_media_device and
773		 * then call the snd_media_device_delete(). Don't have
774		 * access to the quirk here. snd_media_device_delete()
775		 * accesses mixer_list
776		 */
777		snd_media_device_delete(chip);
778
779		/* release mixer resources */
780		list_for_each_entry(mixer, &chip->mixer_list, list) {
781			snd_usb_mixer_disconnect(mixer);
782		}
783	}
784
785	chip->num_interfaces--;
786	if (chip->num_interfaces <= 0) {
787		usb_chip[chip->index] = NULL;
788		mutex_unlock(&register_mutex);
789		snd_card_free_when_closed(card);
790	} else {
791		mutex_unlock(&register_mutex);
792	}
793}
794
795/* lock the shutdown (disconnect) task and autoresume */
796int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
797{
798	int err;
799
800	atomic_inc(&chip->usage_count);
801	if (atomic_read(&chip->shutdown)) {
802		err = -EIO;
803		goto error;
804	}
805	err = snd_usb_autoresume(chip);
806	if (err < 0)
807		goto error;
808	return 0;
809
810 error:
811	if (atomic_dec_and_test(&chip->usage_count))
812		wake_up(&chip->shutdown_wait);
813	return err;
814}
815
816/* autosuspend and unlock the shutdown */
817void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
818{
819	snd_usb_autosuspend(chip);
820	if (atomic_dec_and_test(&chip->usage_count))
821		wake_up(&chip->shutdown_wait);
822}
823
824#ifdef CONFIG_PM
825
826int snd_usb_autoresume(struct snd_usb_audio *chip)
827{
828	int i, err;
829
830	if (atomic_read(&chip->shutdown))
831		return -EIO;
832	if (atomic_inc_return(&chip->active) != 1)
833		return 0;
834
835	for (i = 0; i < chip->num_interfaces; i++) {
836		err = usb_autopm_get_interface(chip->intf[i]);
837		if (err < 0) {
838			/* rollback */
839			while (--i >= 0)
840				usb_autopm_put_interface(chip->intf[i]);
841			atomic_dec(&chip->active);
842			return err;
843		}
844	}
845	return 0;
846}
847
848void snd_usb_autosuspend(struct snd_usb_audio *chip)
849{
850	int i;
851
852	if (atomic_read(&chip->shutdown))
853		return;
854	if (!atomic_dec_and_test(&chip->active))
855		return;
856
857	for (i = 0; i < chip->num_interfaces; i++)
858		usb_autopm_put_interface(chip->intf[i]);
859}
860
861static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
862{
863	struct snd_usb_audio *chip = usb_get_intfdata(intf);
864	struct snd_usb_stream *as;
865	struct usb_mixer_interface *mixer;
866	struct list_head *p;
867
868	if (chip == (void *)-1L)
869		return 0;
870
 
 
 
871	if (!chip->num_suspended_intf++) {
872		list_for_each_entry(as, &chip->pcm_list, list) {
873			snd_usb_pcm_suspend(as);
874			as->substream[0].need_setup_ep =
875				as->substream[1].need_setup_ep = true;
876		}
877		list_for_each(p, &chip->midi_list)
878			snd_usbmidi_suspend(p);
879		list_for_each_entry(mixer, &chip->mixer_list, list)
880			snd_usb_mixer_suspend(mixer);
881	}
882
883	if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
884		snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
885		chip->system_suspend = chip->num_suspended_intf;
886	}
887
888	return 0;
889}
890
891static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
892{
893	struct snd_usb_audio *chip = usb_get_intfdata(intf);
894	struct snd_usb_stream *as;
895	struct usb_mixer_interface *mixer;
896	struct list_head *p;
897	int err = 0;
898
899	if (chip == (void *)-1L)
900		return 0;
 
 
901
902	atomic_inc(&chip->active); /* avoid autopm */
903	if (chip->num_suspended_intf > 1)
904		goto out;
905
906	list_for_each_entry(as, &chip->pcm_list, list) {
907		err = snd_usb_pcm_resume(as);
908		if (err < 0)
909			goto err_out;
910	}
911
912	/*
913	 * ALSA leaves material resumption to user space
914	 * we just notify and restart the mixers
915	 */
916	list_for_each_entry(mixer, &chip->mixer_list, list) {
917		err = snd_usb_mixer_resume(mixer, reset_resume);
918		if (err < 0)
919			goto err_out;
920	}
921
922	list_for_each(p, &chip->midi_list) {
923		snd_usbmidi_resume(p);
924	}
925
926 out:
927	if (chip->num_suspended_intf == chip->system_suspend) {
928		snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
929		chip->system_suspend = 0;
930	}
931	chip->num_suspended_intf--;
932
933err_out:
934	atomic_dec(&chip->active); /* allow autopm after this point */
935	return err;
936}
937
938static int usb_audio_resume(struct usb_interface *intf)
939{
940	return __usb_audio_resume(intf, false);
941}
942
943static int usb_audio_reset_resume(struct usb_interface *intf)
944{
945	return __usb_audio_resume(intf, true);
946}
947#else
948#define usb_audio_suspend	NULL
949#define usb_audio_resume	NULL
950#define usb_audio_reset_resume	NULL
951#endif		/* CONFIG_PM */
952
953static const struct usb_device_id usb_audio_ids [] = {
954#include "quirks-table.h"
955    { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
956      .bInterfaceClass = USB_CLASS_AUDIO,
957      .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
958    { }						/* Terminating entry */
959};
960MODULE_DEVICE_TABLE(usb, usb_audio_ids);
961
962/*
963 * entry point for linux usb interface
964 */
965
966static struct usb_driver usb_audio_driver = {
967	.name =		"snd-usb-audio",
968	.probe =	usb_audio_probe,
969	.disconnect =	usb_audio_disconnect,
970	.suspend =	usb_audio_suspend,
971	.resume =	usb_audio_resume,
972	.reset_resume =	usb_audio_reset_resume,
973	.id_table =	usb_audio_ids,
974	.supports_autosuspend = 1,
975};
976
977module_usb_driver(usb_audio_driver);