blob: 3fc63583a5372dbec8d09e7ba7cf7399abb54cd1 [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;
Takashi Iwaie2703362016-01-11 14:39:12 +010085static char *quirk_alias[SNDRV_CARDS];
Daniel Macke5779992010-03-04 19:46:13 +010086
87module_param_array(index, int, NULL, 0444);
88MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
89module_param_array(id, charp, NULL, 0444);
90MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
91module_param_array(enable, bool, NULL, 0444);
92MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
93module_param_array(vid, int, NULL, 0444);
94MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
95module_param_array(pid, int, NULL, 0444);
96MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
Daniel Macke5779992010-03-04 19:46:13 +010097module_param_array(device_setup, int, NULL, 0444);
98MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
99module_param(ignore_ctl_error, bool, 0444);
100MODULE_PARM_DESC(ignore_ctl_error,
101 "Ignore errors from USB controller for mixer interfaces.");
Eldad Zackef02e292013-04-03 23:18:56 +0200102module_param(autoclock, bool, 0444);
103MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
Takashi Iwaie2703362016-01-11 14:39:12 +0100104module_param_array(quirk_alias, charp, NULL, 0444);
105MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");
Daniel Macke5779992010-03-04 19:46:13 +0100106
107/*
108 * we keep the snd_usb_audio_t instances by ourselves for merging
109 * the all interfaces on the same card as one sound device.
110 */
111
112static DEFINE_MUTEX(register_mutex);
113static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
114static struct usb_driver usb_audio_driver;
115
116/*
117 * disconnect streams
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100118 * called from usb_audio_disconnect()
Daniel Macke5779992010-03-04 19:46:13 +0100119 */
Takashi Iwaia6cece92014-10-31 11:24:32 +0100120static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
Daniel Macke5779992010-03-04 19:46:13 +0100121{
122 int idx;
Daniel Macke5779992010-03-04 19:46:13 +0100123 struct snd_usb_substream *subs;
124
Daniel Macke5779992010-03-04 19:46:13 +0100125 for (idx = 0; idx < 2; idx++) {
126 subs = &as->substream[idx];
127 if (!subs->num_formats)
Takashi Iwai76195fb2010-09-08 08:27:02 +0200128 continue;
Daniel Macke5779992010-03-04 19:46:13 +0100129 subs->interface = -1;
Daniel Mackedcd3632012-04-12 13:51:12 +0200130 subs->data_endpoint = NULL;
131 subs->sync_endpoint = NULL;
Daniel Macke5779992010-03-04 19:46:13 +0100132 }
133}
134
135static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
136{
137 struct usb_device *dev = chip->dev;
138 struct usb_host_interface *alts;
139 struct usb_interface_descriptor *altsd;
140 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
141
142 if (!iface) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100143 dev_err(&dev->dev, "%u:%d : does not exist\n",
144 ctrlif, interface);
Daniel Macke5779992010-03-04 19:46:13 +0100145 return -EINVAL;
146 }
147
Clemens Ladisch342cda292013-06-15 11:21:09 +0200148 alts = &iface->altsetting[0];
149 altsd = get_iface_desc(alts);
150
151 /*
152 * Android with both accessory and audio interfaces enabled gets the
153 * interface numbers wrong.
154 */
155 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
156 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
157 interface == 0 &&
158 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
159 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
160 interface = 2;
161 iface = usb_ifnum_to_if(dev, interface);
162 if (!iface)
163 return -EINVAL;
164 alts = &iface->altsetting[0];
165 altsd = get_iface_desc(alts);
166 }
167
Daniel Macke5779992010-03-04 19:46:13 +0100168 if (usb_interface_claimed(iface)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100169 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
170 ctrlif, interface);
Daniel Macke5779992010-03-04 19:46:13 +0100171 return -EINVAL;
172 }
173
Daniel Macke5779992010-03-04 19:46:13 +0100174 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
175 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
176 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
Takashi Iwai79289e22016-01-11 11:33:34 +0100177 int err = __snd_usbmidi_create(chip->card, iface,
178 &chip->midi_list, NULL,
179 chip->usb_id);
Daniel Macke5779992010-03-04 19:46:13 +0100180 if (err < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100181 dev_err(&dev->dev,
182 "%u:%d: cannot create sequencer device\n",
183 ctrlif, interface);
Daniel Macke5779992010-03-04 19:46:13 +0100184 return -EINVAL;
185 }
186 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
187
188 return 0;
189 }
190
191 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
192 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
193 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100194 dev_dbg(&dev->dev,
195 "%u:%d: skipping non-supported interface %d\n",
196 ctrlif, interface, altsd->bInterfaceClass);
Daniel Macke5779992010-03-04 19:46:13 +0100197 /* skip non-supported classes */
198 return -EINVAL;
199 }
200
201 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100202 dev_err(&dev->dev, "low speed audio streaming not supported\n");
Daniel Macke5779992010-03-04 19:46:13 +0100203 return -EINVAL;
204 }
205
Daniel Macke8e8bab2011-09-12 18:54:12 +0200206 if (! snd_usb_parse_audio_interface(chip, interface)) {
Daniel Macke5779992010-03-04 19:46:13 +0100207 usb_set_interface(dev, interface, 0); /* reset the current interface */
208 usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L);
209 return -EINVAL;
210 }
211
212 return 0;
213}
214
215/*
216 * parse audio control descriptor and create pcm/midi streams
217 */
218static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
219{
220 struct usb_device *dev = chip->dev;
221 struct usb_host_interface *host_iface;
222 struct usb_interface_descriptor *altsd;
223 void *control_header;
224 int i, protocol;
225
226 /* find audiocontrol interface */
227 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
228 control_header = snd_usb_find_csint_desc(host_iface->extra,
229 host_iface->extralen,
230 NULL, UAC_HEADER);
231 altsd = get_iface_desc(host_iface);
232 protocol = altsd->bInterfaceProtocol;
233
234 if (!control_header) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100235 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
Daniel Macke5779992010-03-04 19:46:13 +0100236 return -EINVAL;
237 }
238
239 switch (protocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +0200240 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100241 dev_warn(&dev->dev,
242 "unknown interface protocol %#02x, assuming v1\n",
243 protocol);
Clemens Ladischa2acad82010-09-03 10:53:11 +0200244 /* fall through */
245
Daniel Macke5779992010-03-04 19:46:13 +0100246 case UAC_VERSION_1: {
Daniel Mack69da9bc2010-06-16 17:57:28 +0200247 struct uac1_ac_header_descriptor *h1 = control_header;
Daniel Macke5779992010-03-04 19:46:13 +0100248
249 if (!h1->bInCollection) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100250 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
Daniel Macke5779992010-03-04 19:46:13 +0100251 return -EINVAL;
252 }
253
254 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100255 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
Daniel Macke5779992010-03-04 19:46:13 +0100256 return -EINVAL;
257 }
258
259 for (i = 0; i < h1->bInCollection; i++)
260 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
261
262 break;
263 }
264
265 case UAC_VERSION_2: {
Daniel Macke5779992010-03-04 19:46:13 +0100266 struct usb_interface_assoc_descriptor *assoc =
267 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
268
269 if (!assoc) {
Clemens Ladisch281a6ac2013-03-11 20:15:34 +0100270 /*
271 * Firmware writers cannot count to three. So to find
272 * the IAD on the NuForce UDH-100, also check the next
273 * interface.
274 */
275 struct usb_interface *iface =
276 usb_ifnum_to_if(dev, ctrlif + 1);
277 if (iface &&
278 iface->intf_assoc &&
279 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
280 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
281 assoc = iface->intf_assoc;
282 }
283
284 if (!assoc) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100285 dev_err(&dev->dev, "Audio class v2 interfaces need an interface association\n");
Daniel Macke5779992010-03-04 19:46:13 +0100286 return -EINVAL;
287 }
288
Daniel Macke5779992010-03-04 19:46:13 +0100289 for (i = 0; i < assoc->bInterfaceCount; i++) {
290 int intf = assoc->bFirstInterface + i;
291
292 if (intf != ctrlif)
293 snd_usb_create_stream(chip, ctrlif, intf);
294 }
295
296 break;
297 }
Daniel Macke5779992010-03-04 19:46:13 +0100298 }
299
300 return 0;
301}
302
303/*
304 * free the chip instance
305 *
306 * here we have to do not much, since pcm and controls are already freed
307 *
308 */
309
310static int snd_usb_audio_free(struct snd_usb_audio *chip)
311{
Takashi Iwaia6cece92014-10-31 11:24:32 +0100312 struct snd_usb_endpoint *ep, *n;
Takashi Iwai92a586b2014-06-25 14:24:47 +0200313
Takashi Iwaia6cece92014-10-31 11:24:32 +0100314 list_for_each_entry_safe(ep, n, &chip->ep_list, list)
315 snd_usb_endpoint_free(ep);
Takashi Iwai92a586b2014-06-25 14:24:47 +0200316
Daniel Mack596580d2012-04-12 13:51:10 +0200317 mutex_destroy(&chip->mutex);
Takashi Iwai79289e22016-01-11 11:33:34 +0100318 dev_set_drvdata(&chip->dev->dev, NULL);
Daniel Macke5779992010-03-04 19:46:13 +0100319 kfree(chip);
320 return 0;
321}
322
323static int snd_usb_audio_dev_free(struct snd_device *device)
324{
325 struct snd_usb_audio *chip = device->device_data;
326 return snd_usb_audio_free(chip);
327}
328
Daniel Macke5779992010-03-04 19:46:13 +0100329/*
330 * create a chip instance and set its names.
331 */
Takashi Iwai874b8d42014-01-29 14:22:20 +0100332static int snd_usb_audio_create(struct usb_interface *intf,
333 struct usb_device *dev, int idx,
Daniel Macke5779992010-03-04 19:46:13 +0100334 const struct snd_usb_audio_quirk *quirk,
335 struct snd_usb_audio **rchip)
336{
337 struct snd_card *card;
338 struct snd_usb_audio *chip;
339 int err, len;
340 char component[14];
341 static struct snd_device_ops ops = {
342 .dev_free = snd_usb_audio_dev_free,
343 };
344
345 *rchip = NULL;
346
Paul Zimmerman4f4e8f62010-08-13 12:42:07 -0700347 switch (snd_usb_get_speed(dev)) {
348 case USB_SPEED_LOW:
349 case USB_SPEED_FULL:
350 case USB_SPEED_HIGH:
Thomas Pugliesedf3774c2013-10-01 14:32:15 -0500351 case USB_SPEED_WIRELESS:
Paul Zimmerman4f4e8f62010-08-13 12:42:07 -0700352 case USB_SPEED_SUPER:
353 break;
354 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100355 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
Daniel Macke5779992010-03-04 19:46:13 +0100356 return -ENXIO;
357 }
358
Takashi Iwai874b8d42014-01-29 14:22:20 +0100359 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
360 0, &card);
Daniel Macke5779992010-03-04 19:46:13 +0100361 if (err < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100362 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
Daniel Macke5779992010-03-04 19:46:13 +0100363 return err;
364 }
365
366 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
367 if (! chip) {
368 snd_card_free(card);
369 return -ENOMEM;
370 }
371
Daniel Mack596580d2012-04-12 13:51:10 +0200372 mutex_init(&chip->mutex);
Takashi Iwai47ab1542015-08-25 16:09:00 +0200373 init_waitqueue_head(&chip->shutdown_wait);
Daniel Macke5779992010-03-04 19:46:13 +0100374 chip->index = idx;
375 chip->dev = dev;
376 chip->card = card;
377 chip->setup = device_setup[idx];
Eldad Zackef02e292013-04-03 23:18:56 +0200378 chip->autoclock = autoclock;
Takashi Iwaia6da4992015-08-26 10:20:59 +0200379 atomic_set(&chip->active, 1); /* avoid autopm during probing */
Takashi Iwai47ab1542015-08-25 16:09:00 +0200380 atomic_set(&chip->usage_count, 0);
381 atomic_set(&chip->shutdown, 0);
Daniel Macke5779992010-03-04 19:46:13 +0100382
383 chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
384 le16_to_cpu(dev->descriptor.idProduct));
385 INIT_LIST_HEAD(&chip->pcm_list);
Daniel Mackedcd3632012-04-12 13:51:12 +0200386 INIT_LIST_HEAD(&chip->ep_list);
Daniel Macke5779992010-03-04 19:46:13 +0100387 INIT_LIST_HEAD(&chip->midi_list);
388 INIT_LIST_HEAD(&chip->mixer_list);
389
390 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
391 snd_usb_audio_free(chip);
392 snd_card_free(card);
393 return err;
394 }
395
396 strcpy(card->driver, "USB-Audio");
397 sprintf(component, "USB%04x:%04x",
398 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
399 snd_component_add(card, component);
400
401 /* retrieve the device string as shortname */
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100402 if (quirk && quirk->product_name && *quirk->product_name) {
Daniel Macke5779992010-03-04 19:46:13 +0100403 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
404 } else {
405 if (!dev->descriptor.iProduct ||
406 usb_string(dev, dev->descriptor.iProduct,
407 card->shortname, sizeof(card->shortname)) <= 0) {
408 /* no name available from anywhere, so use ID */
409 sprintf(card->shortname, "USB Device %#04x:%#04x",
410 USB_ID_VENDOR(chip->usb_id),
411 USB_ID_PRODUCT(chip->usb_id));
412 }
413 }
Takashi Iwaiae366c22014-10-31 11:32:19 +0100414 strim(card->shortname);
Daniel Macke5779992010-03-04 19:46:13 +0100415
416 /* retrieve the vendor and device strings as longname */
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100417 if (quirk && quirk->vendor_name && *quirk->vendor_name) {
Daniel Macke5779992010-03-04 19:46:13 +0100418 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
419 } else {
420 if (dev->descriptor.iManufacturer)
421 len = usb_string(dev, dev->descriptor.iManufacturer,
422 card->longname, sizeof(card->longname));
423 else
424 len = 0;
425 /* we don't really care if there isn't any vendor string */
426 }
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100427 if (len > 0) {
Takashi Iwaiae366c22014-10-31 11:32:19 +0100428 strim(card->longname);
Takashi Iwai3ffc1222011-03-21 12:00:00 +0100429 if (*card->longname)
430 strlcat(card->longname, " ", sizeof(card->longname));
431 }
Daniel Macke5779992010-03-04 19:46:13 +0100432
433 strlcat(card->longname, card->shortname, sizeof(card->longname));
434
435 len = strlcat(card->longname, " at ", sizeof(card->longname));
436
437 if (len < sizeof(card->longname))
438 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
439
Paul Zimmerman4f4e8f62010-08-13 12:42:07 -0700440 switch (snd_usb_get_speed(dev)) {
441 case USB_SPEED_LOW:
442 strlcat(card->longname, ", low speed", sizeof(card->longname));
443 break;
444 case USB_SPEED_FULL:
445 strlcat(card->longname, ", full speed", sizeof(card->longname));
446 break;
447 case USB_SPEED_HIGH:
448 strlcat(card->longname, ", high speed", sizeof(card->longname));
449 break;
450 case USB_SPEED_SUPER:
451 strlcat(card->longname, ", super speed", sizeof(card->longname));
452 break;
453 default:
454 break;
455 }
Daniel Macke5779992010-03-04 19:46:13 +0100456
457 snd_usb_audio_create_proc(chip);
458
459 *rchip = chip;
460 return 0;
461}
462
Takashi Iwaie2703362016-01-11 14:39:12 +0100463/* look for a matching quirk alias id */
464static bool get_alias_id(struct usb_device *dev, unsigned int *id)
465{
466 int i;
467 unsigned int src, dst;
468
469 for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {
470 if (!quirk_alias[i] ||
471 sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||
472 src != *id)
473 continue;
474 dev_info(&dev->dev,
475 "device (%04x:%04x): applying quirk alias %04x:%04x\n",
476 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),
477 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));
478 *id = dst;
479 return true;
480 }
481
482 return false;
483}
484
485static struct usb_device_id usb_audio_ids[]; /* defined below */
486
487/* look for the corresponding quirk */
488static const struct snd_usb_audio_quirk *
489get_alias_quirk(struct usb_device *dev, unsigned int id)
490{
491 const struct usb_device_id *p;
492
493 for (p = usb_audio_ids; p->match_flags; p++) {
494 /* FIXME: this checks only vendor:product pair in the list */
495 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==
496 USB_DEVICE_ID_MATCH_DEVICE &&
497 p->idVendor == USB_ID_VENDOR(id) &&
498 p->idProduct == USB_ID_PRODUCT(id))
499 return (const struct snd_usb_audio_quirk *)p->driver_info;
500 }
501
502 return NULL;
503}
504
Daniel Macke5779992010-03-04 19:46:13 +0100505/*
506 * probe the active usb device
507 *
508 * note that this can be called multiple times per a device, when it
509 * includes multiple audio control interfaces.
510 *
511 * thus we check the usb device pointer and creates the card instance
512 * only at the first time. the successive calls of this function will
513 * append the pcm interface to the corresponding card.
514 */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100515static int usb_audio_probe(struct usb_interface *intf,
516 const struct usb_device_id *usb_id)
Daniel Macke5779992010-03-04 19:46:13 +0100517{
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100518 struct usb_device *dev = interface_to_usbdev(intf);
519 const struct snd_usb_audio_quirk *quirk =
520 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
Daniel Macke5779992010-03-04 19:46:13 +0100521 struct snd_usb_audio *chip;
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100522 int i, err;
Daniel Macke5779992010-03-04 19:46:13 +0100523 struct usb_host_interface *alts;
524 int ifnum;
525 u32 id;
526
527 alts = &intf->altsetting[0];
528 ifnum = get_iface_desc(alts)->bInterfaceNumber;
529 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
530 le16_to_cpu(dev->descriptor.idProduct));
Takashi Iwaie2703362016-01-11 14:39:12 +0100531 if (get_alias_id(dev, &id))
532 quirk = get_alias_quirk(dev, id);
Daniel Macke5779992010-03-04 19:46:13 +0100533 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100534 return -ENXIO;
Daniel Macke5779992010-03-04 19:46:13 +0100535
Takashi Iwai79289e22016-01-11 11:33:34 +0100536 err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100537 if (err < 0)
538 return err;
Daniel Macke5779992010-03-04 19:46:13 +0100539
540 /*
541 * found a config. now register to ALSA
542 */
543
544 /* check whether it's already registered */
545 chip = NULL;
546 mutex_lock(&register_mutex);
547 for (i = 0; i < SNDRV_CARDS; i++) {
548 if (usb_chip[i] && usb_chip[i]->dev == dev) {
Takashi Iwai47ab1542015-08-25 16:09:00 +0200549 if (atomic_read(&usb_chip[i]->shutdown)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100550 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100551 err = -EIO;
Daniel Macke5779992010-03-04 19:46:13 +0100552 goto __error;
553 }
554 chip = usb_chip[i];
Takashi Iwai79289e22016-01-11 11:33:34 +0100555 dev_set_drvdata(&dev->dev, chip);
Takashi Iwaia6da4992015-08-26 10:20:59 +0200556 atomic_inc(&chip->active); /* avoid autopm */
Daniel Macke5779992010-03-04 19:46:13 +0100557 break;
558 }
559 }
560 if (! chip) {
561 /* it's a fresh one.
562 * now look for an empty slot and create a new card instance
563 */
564 for (i = 0; i < SNDRV_CARDS; i++)
565 if (enable[i] && ! usb_chip[i] &&
566 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
567 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100568 err = snd_usb_audio_create(intf, dev, i, quirk,
569 &chip);
570 if (err < 0)
Daniel Macke5779992010-03-04 19:46:13 +0100571 goto __error;
Oliver Neukum88a85162011-03-11 14:51:12 +0100572 chip->pm_intf = intf;
Daniel Macke5779992010-03-04 19:46:13 +0100573 break;
574 }
575 if (!chip) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100576 dev_err(&dev->dev, "no available usb audio device\n");
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100577 err = -ENODEV;
Daniel Macke5779992010-03-04 19:46:13 +0100578 goto __error;
579 }
580 }
581
Daniel Mack7b6717e2010-09-02 17:13:15 +0800582 /*
583 * For devices with more than one control interface, we assume the
584 * first contains the audio controls. We might need a more specific
585 * check here in the future.
586 */
587 if (!chip->ctrl_intf)
588 chip->ctrl_intf = alts;
Daniel Mack79f920f2010-05-31 14:51:31 +0200589
Daniel Mack5875c2c2011-05-25 09:08:59 +0200590 chip->txfr_quirk = 0;
591 err = 1; /* continue */
592 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
593 /* need some special handlings */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100594 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
595 if (err < 0)
Daniel Mack5875c2c2011-05-25 09:08:59 +0200596 goto __error;
597 }
598
Daniel Macke5779992010-03-04 19:46:13 +0100599 if (err > 0) {
600 /* create normal USB audio interfaces */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100601 err = snd_usb_create_streams(chip, ifnum);
602 if (err < 0)
Daniel Macke5779992010-03-04 19:46:13 +0100603 goto __error;
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100604 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
605 if (err < 0)
606 goto __error;
Daniel Macke5779992010-03-04 19:46:13 +0100607 }
608
609 /* we are allowed to call snd_card_register() many times */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100610 err = snd_card_register(chip->card);
611 if (err < 0)
Daniel Macke5779992010-03-04 19:46:13 +0100612 goto __error;
Daniel Macke5779992010-03-04 19:46:13 +0100613
614 usb_chip[chip->index] = chip;
615 chip->num_interfaces++;
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100616 usb_set_intfdata(intf, chip);
Takashi Iwaia6da4992015-08-26 10:20:59 +0200617 atomic_dec(&chip->active);
Daniel Macke5779992010-03-04 19:46:13 +0100618 mutex_unlock(&register_mutex);
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100619 return 0;
Daniel Macke5779992010-03-04 19:46:13 +0100620
621 __error:
Thomas Pfaff61a6a102011-09-26 15:43:59 +0200622 if (chip) {
623 if (!chip->num_interfaces)
624 snd_card_free(chip->card);
Takashi Iwaia6da4992015-08-26 10:20:59 +0200625 atomic_dec(&chip->active);
Thomas Pfaff61a6a102011-09-26 15:43:59 +0200626 }
Daniel Macke5779992010-03-04 19:46:13 +0100627 mutex_unlock(&register_mutex);
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100628 return err;
Daniel Macke5779992010-03-04 19:46:13 +0100629}
630
631/*
632 * we need to take care of counter, since disconnection can be called also
633 * many times as well as usb_audio_probe().
634 */
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100635static void usb_audio_disconnect(struct usb_interface *intf)
Daniel Macke5779992010-03-04 19:46:13 +0100636{
Takashi Iwai4c8c3a42014-10-31 11:00:23 +0100637 struct snd_usb_audio *chip = usb_get_intfdata(intf);
Daniel Macke5779992010-03-04 19:46:13 +0100638 struct snd_card *card;
Takashi Iwai92a586b2014-06-25 14:24:47 +0200639 struct list_head *p;
Daniel Macke5779992010-03-04 19:46:13 +0100640
Pavel Roskin81b85b62011-07-06 11:20:13 -0400641 if (chip == (void *)-1L)
Daniel Macke5779992010-03-04 19:46:13 +0100642 return;
643
Daniel Macke5779992010-03-04 19:46:13 +0100644 card = chip->card;
Takashi Iwai10e44232012-11-13 11:22:48 +0100645
646 mutex_lock(&register_mutex);
Takashi Iwai47ab1542015-08-25 16:09:00 +0200647 if (atomic_inc_return(&chip->shutdown) == 1) {
Takashi Iwaia6cece92014-10-31 11:24:32 +0100648 struct snd_usb_stream *as;
Takashi Iwai92a586b2014-06-25 14:24:47 +0200649 struct snd_usb_endpoint *ep;
Takashi Iwaia6cece92014-10-31 11:24:32 +0100650 struct usb_mixer_interface *mixer;
Takashi Iwai92a586b2014-06-25 14:24:47 +0200651
Takashi Iwai47ab1542015-08-25 16:09:00 +0200652 /* wait until all pending tasks done;
653 * they are protected by snd_usb_lock_shutdown()
654 */
655 wait_event(chip->shutdown_wait,
656 !atomic_read(&chip->usage_count));
Daniel Macke5779992010-03-04 19:46:13 +0100657 snd_card_disconnect(card);
658 /* release the pcm resources */
Takashi Iwaia6cece92014-10-31 11:24:32 +0100659 list_for_each_entry(as, &chip->pcm_list, list) {
660 snd_usb_stream_disconnect(as);
Daniel Macke5779992010-03-04 19:46:13 +0100661 }
Daniel Mackedcd3632012-04-12 13:51:12 +0200662 /* release the endpoint resources */
Takashi Iwai92a586b2014-06-25 14:24:47 +0200663 list_for_each_entry(ep, &chip->ep_list, list) {
664 snd_usb_endpoint_release(ep);
Daniel Mackedcd3632012-04-12 13:51:12 +0200665 }
Daniel Macke5779992010-03-04 19:46:13 +0100666 /* release the midi resources */
667 list_for_each(p, &chip->midi_list) {
668 snd_usbmidi_disconnect(p);
669 }
670 /* release mixer resources */
Takashi Iwaia6cece92014-10-31 11:24:32 +0100671 list_for_each_entry(mixer, &chip->mixer_list, list) {
672 snd_usb_mixer_disconnect(mixer);
Daniel Macke5779992010-03-04 19:46:13 +0100673 }
Takashi Iwai0725dda2014-11-05 15:08:49 +0100674 }
675
676 chip->num_interfaces--;
677 if (chip->num_interfaces <= 0) {
Daniel Macke5779992010-03-04 19:46:13 +0100678 usb_chip[chip->index] = NULL;
679 mutex_unlock(&register_mutex);
680 snd_card_free_when_closed(card);
681 } else {
682 mutex_unlock(&register_mutex);
683 }
684}
685
Takashi Iwai47ab1542015-08-25 16:09:00 +0200686/* lock the shutdown (disconnect) task and autoresume */
687int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
688{
689 int err;
690
691 atomic_inc(&chip->usage_count);
692 if (atomic_read(&chip->shutdown)) {
693 err = -EIO;
694 goto error;
695 }
696 err = snd_usb_autoresume(chip);
697 if (err < 0)
698 goto error;
699 return 0;
700
701 error:
702 if (atomic_dec_and_test(&chip->usage_count))
703 wake_up(&chip->shutdown_wait);
704 return err;
705}
706
707/* autosuspend and unlock the shutdown */
708void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
709{
710 snd_usb_autosuspend(chip);
711 if (atomic_dec_and_test(&chip->usage_count))
712 wake_up(&chip->shutdown_wait);
713}
714
Daniel Macke5779992010-03-04 19:46:13 +0100715#ifdef CONFIG_PM
Oliver Neukum88a85162011-03-11 14:51:12 +0100716
717int snd_usb_autoresume(struct snd_usb_audio *chip)
718{
Takashi Iwai47ab1542015-08-25 16:09:00 +0200719 if (atomic_read(&chip->shutdown))
720 return -EIO;
Takashi Iwai47ab1542015-08-25 16:09:00 +0200721 if (atomic_inc_return(&chip->active) == 1)
722 return usb_autopm_get_interface(chip->pm_intf);
723 return 0;
Oliver Neukum88a85162011-03-11 14:51:12 +0100724}
725
726void snd_usb_autosuspend(struct snd_usb_audio *chip)
727{
Takashi Iwai5c06d682016-01-12 14:03:33 +0100728 if (atomic_read(&chip->shutdown))
729 return;
Takashi Iwai47ab1542015-08-25 16:09:00 +0200730 if (atomic_dec_and_test(&chip->active))
Oliver Neukum88a85162011-03-11 14:51:12 +0100731 usb_autopm_put_interface(chip->pm_intf);
732}
733
Daniel Macke5779992010-03-04 19:46:13 +0100734static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
735{
736 struct snd_usb_audio *chip = usb_get_intfdata(intf);
Daniel Macke5779992010-03-04 19:46:13 +0100737 struct snd_usb_stream *as;
Oliver Neukumedf7de32011-03-11 13:19:43 +0100738 struct usb_mixer_interface *mixer;
Adam Goodef7881e52014-08-05 12:44:50 -0400739 struct list_head *p;
Daniel Macke5779992010-03-04 19:46:13 +0100740
741 if (chip == (void *)-1L)
742 return 0;
743
Takashi Iwai06622922015-08-26 10:23:26 +0200744 chip->autosuspended = !!PMSG_IS_AUTO(message);
745 if (!chip->autosuspended)
Oliver Neukum88a85162011-03-11 14:51:12 +0100746 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
Takashi Iwai06622922015-08-26 10:23:26 +0200747 if (!chip->num_suspended_intf++) {
748 list_for_each_entry(as, &chip->pcm_list, list) {
749 snd_pcm_suspend_all(as->pcm);
750 as->substream[0].need_setup_ep =
751 as->substream[1].need_setup_ep = true;
Antonio Ospiteaa53f982013-01-29 12:56:30 +0100752 }
Takashi Iwai06622922015-08-26 10:23:26 +0200753 list_for_each(p, &chip->midi_list)
754 snd_usbmidi_suspend(p);
Takashi Iwai1c53e722014-05-02 18:14:42 +0200755 list_for_each_entry(mixer, &chip->mixer_list, list)
756 snd_usb_mixer_suspend(mixer);
Takashi Iwai06622922015-08-26 10:23:26 +0200757 }
Oliver Neukum88a85162011-03-11 14:51:12 +0100758
Daniel Macke5779992010-03-04 19:46:13 +0100759 return 0;
760}
761
Takashi Iwai400362f2014-01-20 16:51:16 +0100762static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
Daniel Macke5779992010-03-04 19:46:13 +0100763{
764 struct snd_usb_audio *chip = usb_get_intfdata(intf);
Oliver Neukumedf7de32011-03-11 13:19:43 +0100765 struct usb_mixer_interface *mixer;
Adam Goodef7881e52014-08-05 12:44:50 -0400766 struct list_head *p;
Oliver Neukum88a85162011-03-11 14:51:12 +0100767 int err = 0;
Daniel Macke5779992010-03-04 19:46:13 +0100768
769 if (chip == (void *)-1L)
770 return 0;
771 if (--chip->num_suspended_intf)
772 return 0;
Takashi Iwai1ee23fe2014-05-02 18:17:06 +0200773
Takashi Iwai47ab1542015-08-25 16:09:00 +0200774 atomic_inc(&chip->active); /* avoid autopm */
Daniel Macke5779992010-03-04 19:46:13 +0100775 /*
776 * ALSA leaves material resumption to user space
Oliver Neukumedf7de32011-03-11 13:19:43 +0100777 * we just notify and restart the mixers
Daniel Macke5779992010-03-04 19:46:13 +0100778 */
Oliver Neukum88a85162011-03-11 14:51:12 +0100779 list_for_each_entry(mixer, &chip->mixer_list, list) {
Takashi Iwai400362f2014-01-20 16:51:16 +0100780 err = snd_usb_mixer_resume(mixer, reset_resume);
Oliver Neukum88a85162011-03-11 14:51:12 +0100781 if (err < 0)
782 goto err_out;
783 }
Daniel Macke5779992010-03-04 19:46:13 +0100784
Adam Goodef7881e52014-08-05 12:44:50 -0400785 list_for_each(p, &chip->midi_list) {
786 snd_usbmidi_resume(p);
787 }
788
Oliver Neukum88a85162011-03-11 14:51:12 +0100789 if (!chip->autosuspended)
790 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
791 chip->autosuspended = 0;
Daniel Macke5779992010-03-04 19:46:13 +0100792
Oliver Neukum88a85162011-03-11 14:51:12 +0100793err_out:
Takashi Iwai47ab1542015-08-25 16:09:00 +0200794 atomic_dec(&chip->active); /* allow autopm after this point */
Oliver Neukum88a85162011-03-11 14:51:12 +0100795 return err;
Daniel Macke5779992010-03-04 19:46:13 +0100796}
Takashi Iwai400362f2014-01-20 16:51:16 +0100797
798static int usb_audio_resume(struct usb_interface *intf)
799{
800 return __usb_audio_resume(intf, false);
801}
802
803static int usb_audio_reset_resume(struct usb_interface *intf)
804{
805 return __usb_audio_resume(intf, true);
806}
Randy Dunlap6407d472010-03-22 08:55:35 -0700807#else
808#define usb_audio_suspend NULL
809#define usb_audio_resume NULL
Takashi Iwai400362f2014-01-20 16:51:16 +0100810#define usb_audio_reset_resume NULL
Daniel Macke5779992010-03-04 19:46:13 +0100811#endif /* CONFIG_PM */
812
813static struct usb_device_id usb_audio_ids [] = {
814#include "quirks-table.h"
815 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
816 .bInterfaceClass = USB_CLASS_AUDIO,
817 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
818 { } /* Terminating entry */
819};
Eldad Zackf9d35432013-04-03 23:18:50 +0200820MODULE_DEVICE_TABLE(usb, usb_audio_ids);
Daniel Macke5779992010-03-04 19:46:13 +0100821
822/*
823 * entry point for linux usb interface
824 */
825
826static struct usb_driver usb_audio_driver = {
827 .name = "snd-usb-audio",
828 .probe = usb_audio_probe,
829 .disconnect = usb_audio_disconnect,
830 .suspend = usb_audio_suspend,
831 .resume = usb_audio_resume,
Takashi Iwai400362f2014-01-20 16:51:16 +0100832 .reset_resume = usb_audio_reset_resume,
Daniel Macke5779992010-03-04 19:46:13 +0100833 .id_table = usb_audio_ids,
Oliver Neukum88a85162011-03-11 14:51:12 +0100834 .supports_autosuspend = 1,
Daniel Macke5779992010-03-04 19:46:13 +0100835};
836
Sachin Kamat6b5a7c62013-10-09 17:22:32 +0530837module_usb_driver(usb_audio_driver);