blob: be16bdc53c2a90dc21cbf747f58646394e2ea0f6 [file] [log] [blame]
Daniel Macke5779992010-03-04 19:46:13 +01001/*
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 *
Daniel Macke5779992010-03-04 19:46:13 +010028 * - 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>
Takashi Iwai3ffc1222011-03-21 12:00:00 +010041#include <linux/ctype.h>
Daniel Macke5779992010-03-04 19:46:13 +010042#include <linux/usb.h>
43#include <linux/moduleparam.h>
44#include <linux/mutex.h>
45#include <linux/usb/audio.h>
Daniel Mack7e847892010-03-11 21:13:20 +010046#include <linux/usb/audio-v2.h>
Paul Gortmakerda155d52011-07-15 12:38:28 -040047#include <linux/module.h>
Daniel Macke5779992010-03-04 19:46:13 +010048
Daniel Mack9e386582011-05-25 09:09:01 +020049#include <sound/control.h>
Daniel Macke5779992010-03-04 19:46:13 +010050#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"
Daniel Mackf0b5e632010-03-11 21:13:23 +010059#include "mixer.h"
Daniel Macke5779992010-03-04 19:46:13 +010060#include "proc.h"
61#include "quirks.h"
62#include "endpoint.h"
63#include "helper.h"
64#include "debug.h"
65#include "pcm.h"
Daniel Macke5779992010-03-04 19:46:13 +010066#include "format.h"
Oliver Neukum88a85162011-03-11 14:51:12 +010067#include "power.h"
Daniel Macke8e8bab2011-09-12 18:54:12 +020068#include "stream.h"
Daniel Macke5779992010-03-04 19:46:13 +010069
70MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
71MODULE_DESCRIPTION("USB Audio");
72MODULE_LICENSE("GPL");
73MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
74
75
76static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
77static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
Rusty Russella67ff6a2011-12-15 13:49:36 +103078static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
Daniel Macke5779992010-03-04 19:46:13 +010079/* Vendor/product IDs for this card */
80static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
81static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
Daniel Macke5779992010-03-04 19:46:13 +010082static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
Rusty Russella67ff6a2011-12-15 13:49:36 +103083static bool ignore_ctl_error;
Eldad Zackef02e292013-04-03 23:18:56 +020084static bool autoclock = true;
Daniel Macke5779992010-03-04 19:46:13 +010085
86module_param_array(index, int, NULL, 0444);
87MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
88module_param_array(id, charp, NULL, 0444);
89MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
90module_param_array(enable, bool, NULL, 0444);
91MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
92module_param_array(vid, int, NULL, 0444);
93MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
94module_param_array(pid, int, NULL, 0444);
95MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
Daniel Macke5779992010-03-04 19:46:13 +010096module_param_array(device_setup, int, NULL, 0444);
97MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
98module_param(ignore_ctl_error, bool, 0444);
99MODULE_PARM_DESC(ignore_ctl_error,
100 "Ignore errors from USB controller for mixer interfaces.");
Eldad Zackef02e292013-04-03 23:18:56 +0200101module_param(autoclock, bool, 0444);
102MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
Daniel Macke5779992010-03-04 19:46:13 +0100103
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
109static DEFINE_MUTEX(register_mutex);
110static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
111static struct usb_driver usb_audio_driver;
112
113/*
114 * disconnect streams
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100115 * called from usb_audio_disconnect()
Daniel Macke5779992010-03-04 19:46:13 +0100116 */
117static 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)
Takashi Iwai76195fb2010-09-08 08:27:02 +0200127 continue;
Daniel Macke5779992010-03-04 19:46:13 +0100128 subs->interface = -1;
Daniel Mackedcd3632012-04-12 13:51:12 +0200129 subs->data_endpoint = NULL;
130 subs->sync_endpoint = NULL;
Daniel Macke5779992010-03-04 19:46:13 +0100131 }
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) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100142 dev_err(&dev->dev, "%u:%d : does not exist\n",
143 ctrlif, interface);
Daniel Macke5779992010-03-04 19:46:13 +0100144 return -EINVAL;
145 }
146
Clemens Ladisch342cda292013-06-15 11:21:09 +0200147 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
Daniel Macke5779992010-03-04 19:46:13 +0100167 if (usb_interface_claimed(iface)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100168 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
169 ctrlif, interface);
Daniel Macke5779992010-03-04 19:46:13 +0100170 return -EINVAL;
171 }
172
Daniel Macke5779992010-03-04 19:46:13 +0100173 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) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100179 dev_err(&dev->dev,
180 "%u:%d: cannot create sequencer device\n",
181 ctrlif, interface);
Daniel Macke5779992010-03-04 19:46:13 +0100182 return -EINVAL;
183 }
184 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
185
186 return 0;
187 }
188
189 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
190 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
191 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100192 dev_dbg(&dev->dev,
193 "%u:%d: skipping non-supported interface %d\n",
194 ctrlif, interface, altsd->bInterfaceClass);
Daniel Macke5779992010-03-04 19:46:13 +0100195 /* skip non-supported classes */
196 return -EINVAL;
197 }
198
199 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100200 dev_err(&dev->dev, "low speed audio streaming not supported\n");
Daniel Macke5779992010-03-04 19:46:13 +0100201 return -EINVAL;
202 }
203
Daniel Macke8e8bab2011-09-12 18:54:12 +0200204 if (! snd_usb_parse_audio_interface(chip, interface)) {
Daniel Macke5779992010-03-04 19:46:13 +0100205 usb_set_interface(dev, interface, 0); /* reset the current interface */
206 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
207 return -EINVAL;
208 }
209
210 return 0;
211}
212
213/*
214 * parse audio control descriptor and create pcm/midi streams
215 */
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 void *control_header;
222 int i, protocol;
223
224 /* find audiocontrol interface */
225 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
226 control_header = snd_usb_find_csint_desc(host_iface->extra,
227 host_iface->extralen,
228 NULL, UAC_HEADER);
229 altsd = get_iface_desc(host_iface);
230 protocol = altsd->bInterfaceProtocol;
231
232 if (!control_header) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100233 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
Daniel Macke5779992010-03-04 19:46:13 +0100234 return -EINVAL;
235 }
236
237 switch (protocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +0200238 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100239 dev_warn(&dev->dev,
240 "unknown interface protocol %#02x, assuming v1\n",
241 protocol);
Clemens Ladischa2acad82010-09-03 10:53:11 +0200242 /* fall through */
243
Daniel Macke5779992010-03-04 19:46:13 +0100244 case UAC_VERSION_1: {
Daniel Mack69da9bc2010-06-16 17:57:28 +0200245 struct uac1_ac_header_descriptor *h1 = control_header;
Daniel Macke5779992010-03-04 19:46:13 +0100246
247 if (!h1->bInCollection) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100248 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
Daniel Macke5779992010-03-04 19:46:13 +0100249 return -EINVAL;
250 }
251
252 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100253 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
Daniel Macke5779992010-03-04 19:46:13 +0100254 return -EINVAL;
255 }
256
257 for (i = 0; i < h1->bInCollection; i++)
258 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
259
260 break;
261 }
262
263 case UAC_VERSION_2: {
Daniel Macke5779992010-03-04 19:46:13 +0100264 struct usb_interface_assoc_descriptor *assoc =
265 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
266
267 if (!assoc) {
Clemens Ladisch281a6ac2013-03-11 20:15:34 +0100268 /*
269 * Firmware writers cannot count to three. So to find
270 * the IAD on the NuForce UDH-100, also check the next
271 * interface.
272 */
273 struct usb_interface *iface =
274 usb_ifnum_to_if(dev, ctrlif + 1);
275 if (iface &&
276 iface->intf_assoc &&
277 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
278 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
279 assoc = iface->intf_assoc;
280 }
281
282 if (!assoc) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100283 dev_err(&dev->dev, "Audio class v2 interfaces need an interface association\n");
Daniel Macke5779992010-03-04 19:46:13 +0100284 return -EINVAL;
285 }
286
Daniel Macke5779992010-03-04 19:46:13 +0100287 for (i = 0; i < assoc->bInterfaceCount; i++) {
288 int intf = assoc->bFirstInterface + i;
289
290 if (intf != ctrlif)
291 snd_usb_create_stream(chip, ctrlif, intf);
292 }
293
294 break;
295 }
Daniel Macke5779992010-03-04 19:46:13 +0100296 }
297
298 return 0;
299}
300
301/*
302 * free the chip instance
303 *
304 * here we have to do not much, since pcm and controls are already freed
305 *
306 */
307
308static int snd_usb_audio_free(struct snd_usb_audio *chip)
309{
Takashi Iwai92a586b2014-06-25 14:24:47 +0200310 struct list_head *p, *n;
311
312 list_for_each_safe(p, n, &chip->ep_list)
313 snd_usb_endpoint_free(p);
314
Daniel Mack596580d2012-04-12 13:51:10 +0200315 mutex_destroy(&chip->mutex);
Daniel Macke5779992010-03-04 19:46:13 +0100316 kfree(chip);
317 return 0;
318}
319
320static int snd_usb_audio_dev_free(struct snd_device *device)
321{
322 struct snd_usb_audio *chip = device->device_data;
323 return snd_usb_audio_free(chip);
324}
325
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100326static void remove_trailing_spaces(char *str)
327{
328 char *p;
329
330 if (!*str)
331 return;
332 for (p = str + strlen(str) - 1; p >= str && isspace(*p); p--)
333 *p = 0;
334}
Daniel Macke5779992010-03-04 19:46:13 +0100335
336/*
337 * create a chip instance and set its names.
338 */
Takashi Iwai874b8d42014-01-29 14:22:20 +0100339static int snd_usb_audio_create(struct usb_interface *intf,
340 struct usb_device *dev, int idx,
Daniel Macke5779992010-03-04 19:46:13 +0100341 const struct snd_usb_audio_quirk *quirk,
342 struct snd_usb_audio **rchip)
343{
344 struct snd_card *card;
345 struct snd_usb_audio *chip;
346 int err, len;
347 char component[14];
348 static struct snd_device_ops ops = {
349 .dev_free = snd_usb_audio_dev_free,
350 };
351
352 *rchip = NULL;
353
Paul Zimmerman4f4e8f62010-08-13 12:42:07 -0700354 switch (snd_usb_get_speed(dev)) {
355 case USB_SPEED_LOW:
356 case USB_SPEED_FULL:
357 case USB_SPEED_HIGH:
Thomas Pugliesedf3774c2013-10-01 14:32:15 -0500358 case USB_SPEED_WIRELESS:
Paul Zimmerman4f4e8f62010-08-13 12:42:07 -0700359 case USB_SPEED_SUPER:
360 break;
361 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100362 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
Daniel Macke5779992010-03-04 19:46:13 +0100363 return -ENXIO;
364 }
365
Takashi Iwai874b8d42014-01-29 14:22:20 +0100366 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
367 0, &card);
Daniel Macke5779992010-03-04 19:46:13 +0100368 if (err < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100369 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
Daniel Macke5779992010-03-04 19:46:13 +0100370 return err;
371 }
372
373 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
374 if (! chip) {
375 snd_card_free(card);
376 return -ENOMEM;
377 }
378
Daniel Mack596580d2012-04-12 13:51:10 +0200379 mutex_init(&chip->mutex);
Takashi Iwai34f3c892012-10-15 12:16:02 +0200380 init_rwsem(&chip->shutdown_rwsem);
Daniel Macke5779992010-03-04 19:46:13 +0100381 chip->index = idx;
382 chip->dev = dev;
383 chip->card = card;
384 chip->setup = device_setup[idx];
Eldad Zackef02e292013-04-03 23:18:56 +0200385 chip->autoclock = autoclock;
Oliver Neukum88a85162011-03-11 14:51:12 +0100386 chip->probing = 1;
Daniel Macke5779992010-03-04 19:46:13 +0100387
388 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
389 le16_to_cpu(dev->descriptor.idProduct));
390 INIT_LIST_HEAD(&chip->pcm_list);
Daniel Mackedcd3632012-04-12 13:51:12 +0200391 INIT_LIST_HEAD(&chip->ep_list);
Daniel Macke5779992010-03-04 19:46:13 +0100392 INIT_LIST_HEAD(&chip->midi_list);
393 INIT_LIST_HEAD(&chip->mixer_list);
394
395 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
396 snd_usb_audio_free(chip);
397 snd_card_free(card);
398 return err;
399 }
400
401 strcpy(card->driver, "USB-Audio");
402 sprintf(component, "USB%04x:%04x",
403 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
404 snd_component_add(card, component);
405
406 /* retrieve the device string as shortname */
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100407 if (quirk && quirk->product_name && *quirk->product_name) {
Daniel Macke5779992010-03-04 19:46:13 +0100408 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
409 } else {
410 if (!dev->descriptor.iProduct ||
411 usb_string(dev, dev->descriptor.iProduct,
412 card->shortname, sizeof(card->shortname)) <= 0) {
413 /* no name available from anywhere, so use ID */
414 sprintf(card->shortname, "USB Device %#04x:%#04x",
415 USB_ID_VENDOR(chip->usb_id),
416 USB_ID_PRODUCT(chip->usb_id));
417 }
418 }
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100419 remove_trailing_spaces(card->shortname);
Daniel Macke5779992010-03-04 19:46:13 +0100420
421 /* retrieve the vendor and device strings as longname */
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100422 if (quirk && quirk->vendor_name && *quirk->vendor_name) {
Daniel Macke5779992010-03-04 19:46:13 +0100423 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
424 } else {
425 if (dev->descriptor.iManufacturer)
426 len = usb_string(dev, dev->descriptor.iManufacturer,
427 card->longname, sizeof(card->longname));
428 else
429 len = 0;
430 /* we don't really care if there isn't any vendor string */
431 }
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100432 if (len > 0) {
433 remove_trailing_spaces(card->longname);
434 if (*card->longname)
435 strlcat(card->longname, " ", sizeof(card->longname));
436 }
Daniel Macke5779992010-03-04 19:46:13 +0100437
438 strlcat(card->longname, card->shortname, sizeof(card->longname));
439
440 len = strlcat(card->longname, " at ", sizeof(card->longname));
441
442 if (len < sizeof(card->longname))
443 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
444
Paul Zimmerman4f4e8f62010-08-13 12:42:07 -0700445 switch (snd_usb_get_speed(dev)) {
446 case USB_SPEED_LOW:
447 strlcat(card->longname, ", low speed", sizeof(card->longname));
448 break;
449 case USB_SPEED_FULL:
450 strlcat(card->longname, ", full speed", sizeof(card->longname));
451 break;
452 case USB_SPEED_HIGH:
453 strlcat(card->longname, ", high speed", sizeof(card->longname));
454 break;
455 case USB_SPEED_SUPER:
456 strlcat(card->longname, ", super speed", sizeof(card->longname));
457 break;
458 default:
459 break;
460 }
Daniel Macke5779992010-03-04 19:46:13 +0100461
462 snd_usb_audio_create_proc(chip);
463
464 *rchip = chip;
465 return 0;
466}
467
468/*
469 * probe the active usb device
470 *
471 * note that this can be called multiple times per a device, when it
472 * includes multiple audio control interfaces.
473 *
474 * thus we check the usb device pointer and creates the card instance
475 * only at the first time. the successive calls of this function will
476 * append the pcm interface to the corresponding card.
477 */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100478static int usb_audio_probe(struct usb_interface *intf,
479 const struct usb_device_id *usb_id)
Daniel Macke5779992010-03-04 19:46:13 +0100480{
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100481 struct usb_device *dev = interface_to_usbdev(intf);
482 const struct snd_usb_audio_quirk *quirk =
483 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
Daniel Macke5779992010-03-04 19:46:13 +0100484 struct snd_usb_audio *chip;
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100485 int i, err;
Daniel Macke5779992010-03-04 19:46:13 +0100486 struct usb_host_interface *alts;
487 int ifnum;
488 u32 id;
489
490 alts = &intf->altsetting[0];
491 ifnum = get_iface_desc(alts)->bInterfaceNumber;
492 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
493 le16_to_cpu(dev->descriptor.idProduct));
494 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100495 return -ENXIO;
Daniel Macke5779992010-03-04 19:46:13 +0100496
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100497 err = snd_usb_apply_boot_quirk(dev, intf, quirk);
498 if (err < 0)
499 return err;
Daniel Macke5779992010-03-04 19:46:13 +0100500
501 /*
502 * found a config. now register to ALSA
503 */
504
505 /* check whether it's already registered */
506 chip = NULL;
507 mutex_lock(&register_mutex);
508 for (i = 0; i < SNDRV_CARDS; i++) {
509 if (usb_chip[i] && usb_chip[i]->dev == dev) {
510 if (usb_chip[i]->shutdown) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100511 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100512 err = -EIO;
Daniel Macke5779992010-03-04 19:46:13 +0100513 goto __error;
514 }
515 chip = usb_chip[i];
Oliver Neukum88a85162011-03-11 14:51:12 +0100516 chip->probing = 1;
Daniel Macke5779992010-03-04 19:46:13 +0100517 break;
518 }
519 }
520 if (! chip) {
521 /* it's a fresh one.
522 * now look for an empty slot and create a new card instance
523 */
524 for (i = 0; i < SNDRV_CARDS; i++)
525 if (enable[i] && ! usb_chip[i] &&
526 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
527 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100528 err = snd_usb_audio_create(intf, dev, i, quirk,
529 &chip);
530 if (err < 0)
Daniel Macke5779992010-03-04 19:46:13 +0100531 goto __error;
Oliver Neukum88a85162011-03-11 14:51:12 +0100532 chip->pm_intf = intf;
Daniel Macke5779992010-03-04 19:46:13 +0100533 break;
534 }
535 if (!chip) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100536 dev_err(&dev->dev, "no available usb audio device\n");
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100537 err = -ENODEV;
Daniel Macke5779992010-03-04 19:46:13 +0100538 goto __error;
539 }
540 }
541
Daniel Mack7b6717e2010-09-02 17:13:15 +0800542 /*
543 * For devices with more than one control interface, we assume the
544 * first contains the audio controls. We might need a more specific
545 * check here in the future.
546 */
547 if (!chip->ctrl_intf)
548 chip->ctrl_intf = alts;
Daniel Mack79f920f2010-05-31 14:51:31 +0200549
Daniel Mack5875c2c2011-05-25 09:08:59 +0200550 chip->txfr_quirk = 0;
551 err = 1; /* continue */
552 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
553 /* need some special handlings */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100554 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
555 if (err < 0)
Daniel Mack5875c2c2011-05-25 09:08:59 +0200556 goto __error;
557 }
558
Daniel Macke5779992010-03-04 19:46:13 +0100559 if (err > 0) {
560 /* create normal USB audio interfaces */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100561 err = snd_usb_create_streams(chip, ifnum);
562 if (err < 0)
Daniel Macke5779992010-03-04 19:46:13 +0100563 goto __error;
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100564 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
565 if (err < 0)
566 goto __error;
Daniel Macke5779992010-03-04 19:46:13 +0100567 }
568
569 /* we are allowed to call snd_card_register() many times */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100570 err = snd_card_register(chip->card);
571 if (err < 0)
Daniel Macke5779992010-03-04 19:46:13 +0100572 goto __error;
Daniel Macke5779992010-03-04 19:46:13 +0100573
574 usb_chip[chip->index] = chip;
575 chip->num_interfaces++;
Oliver Neukum88a85162011-03-11 14:51:12 +0100576 chip->probing = 0;
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100577 usb_set_intfdata(intf, chip);
Daniel Macke5779992010-03-04 19:46:13 +0100578 mutex_unlock(&register_mutex);
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100579 return 0;
Daniel Macke5779992010-03-04 19:46:13 +0100580
581 __error:
Thomas Pfaff61a6a102011-09-26 15:43:59 +0200582 if (chip) {
583 if (!chip->num_interfaces)
584 snd_card_free(chip->card);
585 chip->probing = 0;
586 }
Daniel Macke5779992010-03-04 19:46:13 +0100587 mutex_unlock(&register_mutex);
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100588 return err;
Daniel Macke5779992010-03-04 19:46:13 +0100589}
590
591/*
592 * we need to take care of counter, since disconnection can be called also
593 * many times as well as usb_audio_probe().
594 */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100595static void usb_audio_disconnect(struct usb_interface *intf)
Daniel Macke5779992010-03-04 19:46:13 +0100596{
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100597 struct snd_usb_audio *chip = usb_get_intfdata(intf);
Daniel Macke5779992010-03-04 19:46:13 +0100598 struct snd_card *card;
Takashi Iwai92a586b2014-06-25 14:24:47 +0200599 struct list_head *p;
Daniel Macke5779992010-03-04 19:46:13 +0100600
Pavel Roskin81b85b62011-07-06 11:20:13 -0400601 if (chip == (void *)-1L)
Daniel Macke5779992010-03-04 19:46:13 +0100602 return;
603
Daniel Macke5779992010-03-04 19:46:13 +0100604 card = chip->card;
Takashi Iwai34f3c892012-10-15 12:16:02 +0200605 down_write(&chip->shutdown_rwsem);
Daniel Macke5779992010-03-04 19:46:13 +0100606 chip->shutdown = 1;
Takashi Iwai10e44232012-11-13 11:22:48 +0100607 up_write(&chip->shutdown_rwsem);
608
609 mutex_lock(&register_mutex);
Daniel Macke5779992010-03-04 19:46:13 +0100610 chip->num_interfaces--;
611 if (chip->num_interfaces <= 0) {
Takashi Iwai92a586b2014-06-25 14:24:47 +0200612 struct snd_usb_endpoint *ep;
613
Daniel Macke5779992010-03-04 19:46:13 +0100614 snd_card_disconnect(card);
615 /* release the pcm resources */
616 list_for_each(p, &chip->pcm_list) {
617 snd_usb_stream_disconnect(p);
618 }
Daniel Mackedcd3632012-04-12 13:51:12 +0200619 /* release the endpoint resources */
Takashi Iwai92a586b2014-06-25 14:24:47 +0200620 list_for_each_entry(ep, &chip->ep_list, list) {
621 snd_usb_endpoint_release(ep);
Daniel Mackedcd3632012-04-12 13:51:12 +0200622 }
Daniel Macke5779992010-03-04 19:46:13 +0100623 /* release the midi resources */
624 list_for_each(p, &chip->midi_list) {
625 snd_usbmidi_disconnect(p);
626 }
627 /* release mixer resources */
628 list_for_each(p, &chip->mixer_list) {
629 snd_usb_mixer_disconnect(p);
630 }
631 usb_chip[chip->index] = NULL;
632 mutex_unlock(&register_mutex);
633 snd_card_free_when_closed(card);
634 } else {
635 mutex_unlock(&register_mutex);
636 }
637}
638
Daniel Macke5779992010-03-04 19:46:13 +0100639#ifdef CONFIG_PM
Oliver Neukum88a85162011-03-11 14:51:12 +0100640
641int snd_usb_autoresume(struct snd_usb_audio *chip)
642{
643 int err = -ENODEV;
644
Takashi Iwai34f3c892012-10-15 12:16:02 +0200645 down_read(&chip->shutdown_rwsem);
Takashi Iwai1ee23fe2014-05-02 18:17:06 +0200646 if (chip->probing && chip->in_pm)
Takashi Iwai60af3d02013-04-25 07:38:15 +0200647 err = 0;
648 else if (!chip->shutdown)
Oliver Neukum88a85162011-03-11 14:51:12 +0100649 err = usb_autopm_get_interface(chip->pm_intf);
Takashi Iwai34f3c892012-10-15 12:16:02 +0200650 up_read(&chip->shutdown_rwsem);
Oliver Neukum88a85162011-03-11 14:51:12 +0100651
652 return err;
653}
654
655void snd_usb_autosuspend(struct snd_usb_audio *chip)
656{
Takashi Iwai34f3c892012-10-15 12:16:02 +0200657 down_read(&chip->shutdown_rwsem);
Takashi Iwai1ee23fe2014-05-02 18:17:06 +0200658 if (!chip->shutdown && !chip->probing && !chip->in_pm)
Oliver Neukum88a85162011-03-11 14:51:12 +0100659 usb_autopm_put_interface(chip->pm_intf);
Takashi Iwai34f3c892012-10-15 12:16:02 +0200660 up_read(&chip->shutdown_rwsem);
Oliver Neukum88a85162011-03-11 14:51:12 +0100661}
662
Daniel Macke5779992010-03-04 19:46:13 +0100663static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
664{
665 struct snd_usb_audio *chip = usb_get_intfdata(intf);
Daniel Macke5779992010-03-04 19:46:13 +0100666 struct snd_usb_stream *as;
Oliver Neukumedf7de32011-03-11 13:19:43 +0100667 struct usb_mixer_interface *mixer;
Adam Goodef7881e52014-08-05 12:44:50 -0400668 struct list_head *p;
Daniel Macke5779992010-03-04 19:46:13 +0100669
670 if (chip == (void *)-1L)
671 return 0;
672
Alan Stern5b1b0b82011-08-19 23:49:48 +0200673 if (!PMSG_IS_AUTO(message)) {
Oliver Neukum88a85162011-03-11 14:51:12 +0100674 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
675 if (!chip->num_suspended_intf++) {
Eldad Zack88766f02013-04-03 23:18:49 +0200676 list_for_each_entry(as, &chip->pcm_list, list) {
Oliver Neukum88a85162011-03-11 14:51:12 +0100677 snd_pcm_suspend_all(as->pcm);
Takashi Iwai384dc0852012-09-18 14:49:31 +0200678 as->substream[0].need_setup_ep =
679 as->substream[1].need_setup_ep = true;
Oliver Neukum88a85162011-03-11 14:51:12 +0100680 }
Adam Goodef7881e52014-08-05 12:44:50 -0400681 list_for_each(p, &chip->midi_list) {
682 snd_usbmidi_suspend(p);
683 }
Antonio Ospiteaa53f982013-01-29 12:56:30 +0100684 }
Oliver Neukum88a85162011-03-11 14:51:12 +0100685 } else {
686 /*
687 * otherwise we keep the rest of the system in the dark
688 * to keep this transparent
689 */
690 if (!chip->num_suspended_intf++)
691 chip->autosuspended = 1;
Daniel Macke5779992010-03-04 19:46:13 +0100692 }
693
Takashi Iwai1c53e722014-05-02 18:14:42 +0200694 if (chip->num_suspended_intf == 1)
695 list_for_each_entry(mixer, &chip->mixer_list, list)
696 snd_usb_mixer_suspend(mixer);
Oliver Neukum88a85162011-03-11 14:51:12 +0100697
Daniel Macke5779992010-03-04 19:46:13 +0100698 return 0;
699}
700
Takashi Iwai400362f2014-01-20 16:51:16 +0100701static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
Daniel Macke5779992010-03-04 19:46:13 +0100702{
703 struct snd_usb_audio *chip = usb_get_intfdata(intf);
Oliver Neukumedf7de32011-03-11 13:19:43 +0100704 struct usb_mixer_interface *mixer;
Adam Goodef7881e52014-08-05 12:44:50 -0400705 struct list_head *p;
Oliver Neukum88a85162011-03-11 14:51:12 +0100706 int err = 0;
Daniel Macke5779992010-03-04 19:46:13 +0100707
708 if (chip == (void *)-1L)
709 return 0;
710 if (--chip->num_suspended_intf)
711 return 0;
Takashi Iwai1ee23fe2014-05-02 18:17:06 +0200712
713 chip->in_pm = 1;
Daniel Macke5779992010-03-04 19:46:13 +0100714 /*
715 * ALSA leaves material resumption to user space
Oliver Neukumedf7de32011-03-11 13:19:43 +0100716 * we just notify and restart the mixers
Daniel Macke5779992010-03-04 19:46:13 +0100717 */
Oliver Neukum88a85162011-03-11 14:51:12 +0100718 list_for_each_entry(mixer, &chip->mixer_list, list) {
Takashi Iwai400362f2014-01-20 16:51:16 +0100719 err = snd_usb_mixer_resume(mixer, reset_resume);
Oliver Neukum88a85162011-03-11 14:51:12 +0100720 if (err < 0)
721 goto err_out;
722 }
Daniel Macke5779992010-03-04 19:46:13 +0100723
Adam Goodef7881e52014-08-05 12:44:50 -0400724 list_for_each(p, &chip->midi_list) {
725 snd_usbmidi_resume(p);
726 }
727
Oliver Neukum88a85162011-03-11 14:51:12 +0100728 if (!chip->autosuspended)
729 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
730 chip->autosuspended = 0;
Daniel Macke5779992010-03-04 19:46:13 +0100731
Oliver Neukum88a85162011-03-11 14:51:12 +0100732err_out:
Takashi Iwai1ee23fe2014-05-02 18:17:06 +0200733 chip->in_pm = 0;
Oliver Neukum88a85162011-03-11 14:51:12 +0100734 return err;
Daniel Macke5779992010-03-04 19:46:13 +0100735}
Takashi Iwai400362f2014-01-20 16:51:16 +0100736
737static int usb_audio_resume(struct usb_interface *intf)
738{
739 return __usb_audio_resume(intf, false);
740}
741
742static int usb_audio_reset_resume(struct usb_interface *intf)
743{
744 return __usb_audio_resume(intf, true);
745}
Randy Dunlap6407d472010-03-22 08:55:35 -0700746#else
747#define usb_audio_suspend NULL
748#define usb_audio_resume NULL
Takashi Iwai400362f2014-01-20 16:51:16 +0100749#define usb_audio_reset_resume NULL
Daniel Macke5779992010-03-04 19:46:13 +0100750#endif /* CONFIG_PM */
751
752static struct usb_device_id usb_audio_ids [] = {
753#include "quirks-table.h"
754 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
755 .bInterfaceClass = USB_CLASS_AUDIO,
756 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
757 { } /* Terminating entry */
758};
Eldad Zackf9d35432013-04-03 23:18:50 +0200759MODULE_DEVICE_TABLE(usb, usb_audio_ids);
Daniel Macke5779992010-03-04 19:46:13 +0100760
761/*
762 * entry point for linux usb interface
763 */
764
765static struct usb_driver usb_audio_driver = {
766 .name = "snd-usb-audio",
767 .probe = usb_audio_probe,
768 .disconnect = usb_audio_disconnect,
769 .suspend = usb_audio_suspend,
770 .resume = usb_audio_resume,
Takashi Iwai400362f2014-01-20 16:51:16 +0100771 .reset_resume = usb_audio_reset_resume,
Daniel Macke5779992010-03-04 19:46:13 +0100772 .id_table = usb_audio_ids,
Oliver Neukum88a85162011-03-11 14:51:12 +0100773 .supports_autosuspend = 1,
Daniel Macke5779992010-03-04 19:46:13 +0100774};
775
Sachin Kamat6b5a7c62013-10-09 17:22:32 +0530776module_usb_driver(usb_audio_driver);