Loading...
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(®ister_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(®ister_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(®ister_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(®ister_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(®ister_mutex);
789 snd_card_free_when_closed(card);
790 } else {
791 mutex_unlock(®ister_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);
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 * - async unlink should be used for avoiding the sleep inside lock.
29 * 2.4.22 usb-uhci seems buggy for async unlinking and results in
30 * oops. in such a cse, pass async_unlink=0 option.
31 * - the linked URBs would be preferred but not used so far because of
32 * the instability of unlinking.
33 * - type II is not supported properly. there is no device which supports
34 * this type *correctly*. SB extigy looks as if it supports, but it's
35 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).
36 */
37
38
39#include <linux/bitops.h>
40#include <linux/init.h>
41#include <linux/list.h>
42#include <linux/slab.h>
43#include <linux/string.h>
44#include <linux/ctype.h>
45#include <linux/usb.h>
46#include <linux/moduleparam.h>
47#include <linux/mutex.h>
48#include <linux/usb/audio.h>
49#include <linux/usb/audio-v2.h>
50#include <linux/module.h>
51
52#include <sound/control.h>
53#include <sound/core.h>
54#include <sound/info.h>
55#include <sound/pcm.h>
56#include <sound/pcm_params.h>
57#include <sound/initval.h>
58
59#include "usbaudio.h"
60#include "card.h"
61#include "midi.h"
62#include "mixer.h"
63#include "proc.h"
64#include "quirks.h"
65#include "endpoint.h"
66#include "helper.h"
67#include "debug.h"
68#include "pcm.h"
69#include "format.h"
70#include "power.h"
71#include "stream.h"
72
73MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
74MODULE_DESCRIPTION("USB Audio");
75MODULE_LICENSE("GPL");
76MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
77
78
79static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
80static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
81static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
82/* Vendor/product IDs for this card */
83static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
84static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
85static int nrpacks = 8; /* max. number of packets per urb */
86static bool async_unlink = 1;
87static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
88static bool ignore_ctl_error;
89
90module_param_array(index, int, NULL, 0444);
91MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
92module_param_array(id, charp, NULL, 0444);
93MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
94module_param_array(enable, bool, NULL, 0444);
95MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
96module_param_array(vid, int, NULL, 0444);
97MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
98module_param_array(pid, int, NULL, 0444);
99MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
100module_param(nrpacks, int, 0644);
101MODULE_PARM_DESC(nrpacks, "Max. number of packets per URB.");
102module_param(async_unlink, bool, 0444);
103MODULE_PARM_DESC(async_unlink, "Use async unlink mode.");
104module_param_array(device_setup, int, NULL, 0444);
105MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
106module_param(ignore_ctl_error, bool, 0444);
107MODULE_PARM_DESC(ignore_ctl_error,
108 "Ignore errors from USB controller for mixer interfaces.");
109
110/*
111 * we keep the snd_usb_audio_t instances by ourselves for merging
112 * the all interfaces on the same card as one sound device.
113 */
114
115static DEFINE_MUTEX(register_mutex);
116static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
117static struct usb_driver usb_audio_driver;
118
119/*
120 * disconnect streams
121 * called from snd_usb_audio_disconnect()
122 */
123static void snd_usb_stream_disconnect(struct list_head *head)
124{
125 int idx;
126 struct snd_usb_stream *as;
127 struct snd_usb_substream *subs;
128
129 as = list_entry(head, struct snd_usb_stream, list);
130 for (idx = 0; idx < 2; idx++) {
131 subs = &as->substream[idx];
132 if (!subs->num_formats)
133 continue;
134 subs->interface = -1;
135 subs->data_endpoint = NULL;
136 subs->sync_endpoint = NULL;
137 }
138}
139
140static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
141{
142 struct usb_device *dev = chip->dev;
143 struct usb_host_interface *alts;
144 struct usb_interface_descriptor *altsd;
145 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
146
147 if (!iface) {
148 snd_printk(KERN_ERR "%d:%u:%d : does not exist\n",
149 dev->devnum, ctrlif, interface);
150 return -EINVAL;
151 }
152
153 if (usb_interface_claimed(iface)) {
154 snd_printdd(KERN_INFO "%d:%d:%d: skipping, already claimed\n",
155 dev->devnum, ctrlif, interface);
156 return -EINVAL;
157 }
158
159 alts = &iface->altsetting[0];
160 altsd = get_iface_desc(alts);
161 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
162 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
163 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
164 int err = snd_usbmidi_create(chip->card, iface,
165 &chip->midi_list, NULL);
166 if (err < 0) {
167 snd_printk(KERN_ERR "%d:%u:%d: cannot create sequencer device\n",
168 dev->devnum, ctrlif, interface);
169 return -EINVAL;
170 }
171 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
172
173 return 0;
174 }
175
176 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
177 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
178 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
179 snd_printdd(KERN_ERR "%d:%u:%d: skipping non-supported interface %d\n",
180 dev->devnum, ctrlif, interface, altsd->bInterfaceClass);
181 /* skip non-supported classes */
182 return -EINVAL;
183 }
184
185 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
186 snd_printk(KERN_ERR "low speed audio streaming not supported\n");
187 return -EINVAL;
188 }
189
190 if (! snd_usb_parse_audio_interface(chip, interface)) {
191 usb_set_interface(dev, interface, 0); /* reset the current interface */
192 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
193 return -EINVAL;
194 }
195
196 return 0;
197}
198
199/*
200 * parse audio control descriptor and create pcm/midi streams
201 */
202static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
203{
204 struct usb_device *dev = chip->dev;
205 struct usb_host_interface *host_iface;
206 struct usb_interface_descriptor *altsd;
207 void *control_header;
208 int i, protocol;
209
210 /* find audiocontrol interface */
211 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
212 control_header = snd_usb_find_csint_desc(host_iface->extra,
213 host_iface->extralen,
214 NULL, UAC_HEADER);
215 altsd = get_iface_desc(host_iface);
216 protocol = altsd->bInterfaceProtocol;
217
218 if (!control_header) {
219 snd_printk(KERN_ERR "cannot find UAC_HEADER\n");
220 return -EINVAL;
221 }
222
223 switch (protocol) {
224 default:
225 snd_printdd(KERN_WARNING "unknown interface protocol %#02x, assuming v1\n",
226 protocol);
227 /* fall through */
228
229 case UAC_VERSION_1: {
230 struct uac1_ac_header_descriptor *h1 = control_header;
231
232 if (!h1->bInCollection) {
233 snd_printk(KERN_INFO "skipping empty audio interface (v1)\n");
234 return -EINVAL;
235 }
236
237 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
238 snd_printk(KERN_ERR "invalid UAC_HEADER (v1)\n");
239 return -EINVAL;
240 }
241
242 for (i = 0; i < h1->bInCollection; i++)
243 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
244
245 break;
246 }
247
248 case UAC_VERSION_2: {
249 struct usb_interface_assoc_descriptor *assoc =
250 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
251
252 if (!assoc) {
253 snd_printk(KERN_ERR "Audio class v2 interfaces need an interface association\n");
254 return -EINVAL;
255 }
256
257 for (i = 0; i < assoc->bInterfaceCount; i++) {
258 int intf = assoc->bFirstInterface + i;
259
260 if (intf != ctrlif)
261 snd_usb_create_stream(chip, ctrlif, intf);
262 }
263
264 break;
265 }
266 }
267
268 return 0;
269}
270
271/*
272 * free the chip instance
273 *
274 * here we have to do not much, since pcm and controls are already freed
275 *
276 */
277
278static int snd_usb_audio_free(struct snd_usb_audio *chip)
279{
280 mutex_destroy(&chip->mutex);
281 kfree(chip);
282 return 0;
283}
284
285static int snd_usb_audio_dev_free(struct snd_device *device)
286{
287 struct snd_usb_audio *chip = device->device_data;
288 return snd_usb_audio_free(chip);
289}
290
291static void remove_trailing_spaces(char *str)
292{
293 char *p;
294
295 if (!*str)
296 return;
297 for (p = str + strlen(str) - 1; p >= str && isspace(*p); p--)
298 *p = 0;
299}
300
301/*
302 * create a chip instance and set its names.
303 */
304static int snd_usb_audio_create(struct usb_device *dev, int idx,
305 const struct snd_usb_audio_quirk *quirk,
306 struct snd_usb_audio **rchip)
307{
308 struct snd_card *card;
309 struct snd_usb_audio *chip;
310 int err, len;
311 char component[14];
312 static struct snd_device_ops ops = {
313 .dev_free = snd_usb_audio_dev_free,
314 };
315
316 *rchip = NULL;
317
318 switch (snd_usb_get_speed(dev)) {
319 case USB_SPEED_LOW:
320 case USB_SPEED_FULL:
321 case USB_SPEED_HIGH:
322 case USB_SPEED_SUPER:
323 break;
324 default:
325 snd_printk(KERN_ERR "unknown device speed %d\n", snd_usb_get_speed(dev));
326 return -ENXIO;
327 }
328
329 err = snd_card_create(index[idx], id[idx], THIS_MODULE, 0, &card);
330 if (err < 0) {
331 snd_printk(KERN_ERR "cannot create card instance %d\n", idx);
332 return err;
333 }
334
335 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
336 if (! chip) {
337 snd_card_free(card);
338 return -ENOMEM;
339 }
340
341 mutex_init(&chip->mutex);
342 mutex_init(&chip->shutdown_mutex);
343 chip->index = idx;
344 chip->dev = dev;
345 chip->card = card;
346 chip->setup = device_setup[idx];
347 chip->nrpacks = nrpacks;
348 chip->async_unlink = async_unlink;
349 chip->probing = 1;
350
351 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
352 le16_to_cpu(dev->descriptor.idProduct));
353 INIT_LIST_HEAD(&chip->pcm_list);
354 INIT_LIST_HEAD(&chip->ep_list);
355 INIT_LIST_HEAD(&chip->midi_list);
356 INIT_LIST_HEAD(&chip->mixer_list);
357
358 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
359 snd_usb_audio_free(chip);
360 snd_card_free(card);
361 return err;
362 }
363
364 strcpy(card->driver, "USB-Audio");
365 sprintf(component, "USB%04x:%04x",
366 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
367 snd_component_add(card, component);
368
369 /* retrieve the device string as shortname */
370 if (quirk && quirk->product_name && *quirk->product_name) {
371 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
372 } else {
373 if (!dev->descriptor.iProduct ||
374 usb_string(dev, dev->descriptor.iProduct,
375 card->shortname, sizeof(card->shortname)) <= 0) {
376 /* no name available from anywhere, so use ID */
377 sprintf(card->shortname, "USB Device %#04x:%#04x",
378 USB_ID_VENDOR(chip->usb_id),
379 USB_ID_PRODUCT(chip->usb_id));
380 }
381 }
382 remove_trailing_spaces(card->shortname);
383
384 /* retrieve the vendor and device strings as longname */
385 if (quirk && quirk->vendor_name && *quirk->vendor_name) {
386 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
387 } else {
388 if (dev->descriptor.iManufacturer)
389 len = usb_string(dev, dev->descriptor.iManufacturer,
390 card->longname, sizeof(card->longname));
391 else
392 len = 0;
393 /* we don't really care if there isn't any vendor string */
394 }
395 if (len > 0) {
396 remove_trailing_spaces(card->longname);
397 if (*card->longname)
398 strlcat(card->longname, " ", sizeof(card->longname));
399 }
400
401 strlcat(card->longname, card->shortname, sizeof(card->longname));
402
403 len = strlcat(card->longname, " at ", sizeof(card->longname));
404
405 if (len < sizeof(card->longname))
406 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
407
408 switch (snd_usb_get_speed(dev)) {
409 case USB_SPEED_LOW:
410 strlcat(card->longname, ", low speed", sizeof(card->longname));
411 break;
412 case USB_SPEED_FULL:
413 strlcat(card->longname, ", full speed", sizeof(card->longname));
414 break;
415 case USB_SPEED_HIGH:
416 strlcat(card->longname, ", high speed", sizeof(card->longname));
417 break;
418 case USB_SPEED_SUPER:
419 strlcat(card->longname, ", super speed", sizeof(card->longname));
420 break;
421 default:
422 break;
423 }
424
425 snd_usb_audio_create_proc(chip);
426
427 *rchip = chip;
428 return 0;
429}
430
431/*
432 * probe the active usb device
433 *
434 * note that this can be called multiple times per a device, when it
435 * includes multiple audio control interfaces.
436 *
437 * thus we check the usb device pointer and creates the card instance
438 * only at the first time. the successive calls of this function will
439 * append the pcm interface to the corresponding card.
440 */
441static struct snd_usb_audio *
442snd_usb_audio_probe(struct usb_device *dev,
443 struct usb_interface *intf,
444 const struct usb_device_id *usb_id)
445{
446 const struct snd_usb_audio_quirk *quirk = (const struct snd_usb_audio_quirk *)usb_id->driver_info;
447 int i, err;
448 struct snd_usb_audio *chip;
449 struct usb_host_interface *alts;
450 int ifnum;
451 u32 id;
452
453 alts = &intf->altsetting[0];
454 ifnum = get_iface_desc(alts)->bInterfaceNumber;
455 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
456 le16_to_cpu(dev->descriptor.idProduct));
457 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
458 goto __err_val;
459
460 if (snd_usb_apply_boot_quirk(dev, intf, quirk) < 0)
461 goto __err_val;
462
463 /*
464 * found a config. now register to ALSA
465 */
466
467 /* check whether it's already registered */
468 chip = NULL;
469 mutex_lock(®ister_mutex);
470 for (i = 0; i < SNDRV_CARDS; i++) {
471 if (usb_chip[i] && usb_chip[i]->dev == dev) {
472 if (usb_chip[i]->shutdown) {
473 snd_printk(KERN_ERR "USB device is in the shutdown state, cannot create a card instance\n");
474 goto __error;
475 }
476 chip = usb_chip[i];
477 chip->probing = 1;
478 break;
479 }
480 }
481 if (! chip) {
482 /* it's a fresh one.
483 * now look for an empty slot and create a new card instance
484 */
485 for (i = 0; i < SNDRV_CARDS; i++)
486 if (enable[i] && ! usb_chip[i] &&
487 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
488 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
489 if (snd_usb_audio_create(dev, i, quirk, &chip) < 0) {
490 goto __error;
491 }
492 snd_card_set_dev(chip->card, &intf->dev);
493 chip->pm_intf = intf;
494 break;
495 }
496 if (!chip) {
497 printk(KERN_ERR "no available usb audio device\n");
498 goto __error;
499 }
500 }
501
502 /*
503 * For devices with more than one control interface, we assume the
504 * first contains the audio controls. We might need a more specific
505 * check here in the future.
506 */
507 if (!chip->ctrl_intf)
508 chip->ctrl_intf = alts;
509
510 chip->txfr_quirk = 0;
511 err = 1; /* continue */
512 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
513 /* need some special handlings */
514 if ((err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk)) < 0)
515 goto __error;
516 }
517
518 if (err > 0) {
519 /* create normal USB audio interfaces */
520 if (snd_usb_create_streams(chip, ifnum) < 0 ||
521 snd_usb_create_mixer(chip, ifnum, ignore_ctl_error) < 0) {
522 goto __error;
523 }
524 }
525
526 /* we are allowed to call snd_card_register() many times */
527 if (snd_card_register(chip->card) < 0) {
528 goto __error;
529 }
530
531 usb_chip[chip->index] = chip;
532 chip->num_interfaces++;
533 chip->probing = 0;
534 mutex_unlock(®ister_mutex);
535 return chip;
536
537 __error:
538 if (chip) {
539 if (!chip->num_interfaces)
540 snd_card_free(chip->card);
541 chip->probing = 0;
542 }
543 mutex_unlock(®ister_mutex);
544 __err_val:
545 return NULL;
546}
547
548/*
549 * we need to take care of counter, since disconnection can be called also
550 * many times as well as usb_audio_probe().
551 */
552static void snd_usb_audio_disconnect(struct usb_device *dev,
553 struct snd_usb_audio *chip)
554{
555 struct snd_card *card;
556 struct list_head *p, *n;
557
558 if (chip == (void *)-1L)
559 return;
560
561 card = chip->card;
562 mutex_lock(®ister_mutex);
563 mutex_lock(&chip->shutdown_mutex);
564 chip->shutdown = 1;
565 chip->num_interfaces--;
566 if (chip->num_interfaces <= 0) {
567 snd_card_disconnect(card);
568 /* release the pcm resources */
569 list_for_each(p, &chip->pcm_list) {
570 snd_usb_stream_disconnect(p);
571 }
572 /* release the endpoint resources */
573 list_for_each_safe(p, n, &chip->ep_list) {
574 snd_usb_endpoint_free(p);
575 }
576 /* release the midi resources */
577 list_for_each(p, &chip->midi_list) {
578 snd_usbmidi_disconnect(p);
579 }
580 /* release mixer resources */
581 list_for_each(p, &chip->mixer_list) {
582 snd_usb_mixer_disconnect(p);
583 }
584 usb_chip[chip->index] = NULL;
585 mutex_unlock(&chip->shutdown_mutex);
586 mutex_unlock(®ister_mutex);
587 snd_card_free_when_closed(card);
588 } else {
589 mutex_unlock(&chip->shutdown_mutex);
590 mutex_unlock(®ister_mutex);
591 }
592}
593
594/*
595 * new 2.5 USB kernel API
596 */
597static int usb_audio_probe(struct usb_interface *intf,
598 const struct usb_device_id *id)
599{
600 struct snd_usb_audio *chip;
601 chip = snd_usb_audio_probe(interface_to_usbdev(intf), intf, id);
602 if (chip) {
603 usb_set_intfdata(intf, chip);
604 return 0;
605 } else
606 return -EIO;
607}
608
609static void usb_audio_disconnect(struct usb_interface *intf)
610{
611 snd_usb_audio_disconnect(interface_to_usbdev(intf),
612 usb_get_intfdata(intf));
613}
614
615#ifdef CONFIG_PM
616
617int snd_usb_autoresume(struct snd_usb_audio *chip)
618{
619 int err = -ENODEV;
620
621 if (!chip->shutdown && !chip->probing)
622 err = usb_autopm_get_interface(chip->pm_intf);
623
624 return err;
625}
626
627void snd_usb_autosuspend(struct snd_usb_audio *chip)
628{
629 if (!chip->shutdown && !chip->probing)
630 usb_autopm_put_interface(chip->pm_intf);
631}
632
633static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
634{
635 struct snd_usb_audio *chip = usb_get_intfdata(intf);
636 struct list_head *p;
637 struct snd_usb_stream *as;
638 struct usb_mixer_interface *mixer;
639
640 if (chip == (void *)-1L)
641 return 0;
642
643 if (!PMSG_IS_AUTO(message)) {
644 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
645 if (!chip->num_suspended_intf++) {
646 list_for_each(p, &chip->pcm_list) {
647 as = list_entry(p, struct snd_usb_stream, list);
648 snd_pcm_suspend_all(as->pcm);
649 }
650 }
651 } else {
652 /*
653 * otherwise we keep the rest of the system in the dark
654 * to keep this transparent
655 */
656 if (!chip->num_suspended_intf++)
657 chip->autosuspended = 1;
658 }
659
660 list_for_each_entry(mixer, &chip->mixer_list, list)
661 snd_usb_mixer_inactivate(mixer);
662
663 return 0;
664}
665
666static int usb_audio_resume(struct usb_interface *intf)
667{
668 struct snd_usb_audio *chip = usb_get_intfdata(intf);
669 struct usb_mixer_interface *mixer;
670 int err = 0;
671
672 if (chip == (void *)-1L)
673 return 0;
674 if (--chip->num_suspended_intf)
675 return 0;
676 /*
677 * ALSA leaves material resumption to user space
678 * we just notify and restart the mixers
679 */
680 list_for_each_entry(mixer, &chip->mixer_list, list) {
681 err = snd_usb_mixer_activate(mixer);
682 if (err < 0)
683 goto err_out;
684 }
685
686 if (!chip->autosuspended)
687 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
688 chip->autosuspended = 0;
689
690err_out:
691 return err;
692}
693#else
694#define usb_audio_suspend NULL
695#define usb_audio_resume NULL
696#endif /* CONFIG_PM */
697
698static struct usb_device_id usb_audio_ids [] = {
699#include "quirks-table.h"
700 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
701 .bInterfaceClass = USB_CLASS_AUDIO,
702 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
703 { } /* Terminating entry */
704};
705
706MODULE_DEVICE_TABLE (usb, usb_audio_ids);
707
708/*
709 * entry point for linux usb interface
710 */
711
712static struct usb_driver usb_audio_driver = {
713 .name = "snd-usb-audio",
714 .probe = usb_audio_probe,
715 .disconnect = usb_audio_disconnect,
716 .suspend = usb_audio_suspend,
717 .resume = usb_audio_resume,
718 .id_table = usb_audio_ids,
719 .supports_autosuspend = 1,
720};
721
722static int __init snd_usb_audio_init(void)
723{
724 if (nrpacks < 1 || nrpacks > MAX_PACKS) {
725 printk(KERN_WARNING "invalid nrpacks value.\n");
726 return -EINVAL;
727 }
728 return usb_register(&usb_audio_driver);
729}
730
731static void __exit snd_usb_audio_cleanup(void)
732{
733 usb_deregister(&usb_audio_driver);
734}
735
736module_init(snd_usb_audio_init);
737module_exit(snd_usb_audio_cleanup);