Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
e5779998 DM |
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 | * | |
9a2fe9b8 | 11 | * Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com> |
e5779998 | 12 | * |
e5779998 DM |
13 | * NOTES: |
14 | * | |
e5779998 DM |
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> | |
3ffc1222 | 28 | #include <linux/ctype.h> |
e5779998 DM |
29 | #include <linux/usb.h> |
30 | #include <linux/moduleparam.h> | |
31 | #include <linux/mutex.h> | |
32 | #include <linux/usb/audio.h> | |
7e847894 | 33 | #include <linux/usb/audio-v2.h> |
9a2fe9b8 | 34 | #include <linux/usb/audio-v3.h> |
da155d5b | 35 | #include <linux/module.h> |
e5779998 | 36 | |
9e38658f | 37 | #include <sound/control.h> |
e5779998 DM |
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" | |
f0b5e634 | 47 | #include "mixer.h" |
e5779998 DM |
48 | #include "proc.h" |
49 | #include "quirks.h" | |
50 | #include "endpoint.h" | |
51 | #include "helper.h" | |
52 | #include "debug.h" | |
53 | #include "pcm.h" | |
e5779998 | 54 | #include "format.h" |
88a8516a | 55 | #include "power.h" |
e8e8babf | 56 | #include "stream.h" |
66354f18 | 57 | #include "media.h" |
e5779998 DM |
58 | |
59 | MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>"); | |
60 | MODULE_DESCRIPTION("USB Audio"); | |
61 | MODULE_LICENSE("GPL"); | |
62 | MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}"); | |
63 | ||
64 | ||
65 | static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */ | |
66 | static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */ | |
a67ff6a5 | 67 | static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */ |
e5779998 DM |
68 | /* Vendor/product IDs for this card */ |
69 | static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; | |
70 | static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 }; | |
e5779998 | 71 | static int device_setup[SNDRV_CARDS]; /* device parameter for this card */ |
a67ff6a5 | 72 | static bool ignore_ctl_error; |
ef02e29b | 73 | static bool autoclock = true; |
e2703363 | 74 | static char *quirk_alias[SNDRV_CARDS]; |
e5779998 | 75 | |
f274baa4 TI |
76 | bool snd_usb_use_vmalloc = true; |
77 | ||
e5779998 DM |
78 | module_param_array(index, int, NULL, 0444); |
79 | MODULE_PARM_DESC(index, "Index value for the USB audio adapter."); | |
80 | module_param_array(id, charp, NULL, 0444); | |
81 | MODULE_PARM_DESC(id, "ID string for the USB audio adapter."); | |
82 | module_param_array(enable, bool, NULL, 0444); | |
83 | MODULE_PARM_DESC(enable, "Enable USB audio adapter."); | |
84 | module_param_array(vid, int, NULL, 0444); | |
85 | MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device."); | |
86 | module_param_array(pid, int, NULL, 0444); | |
87 | MODULE_PARM_DESC(pid, "Product ID for the USB audio device."); | |
e5779998 DM |
88 | module_param_array(device_setup, int, NULL, 0444); |
89 | MODULE_PARM_DESC(device_setup, "Specific device setup (if needed)."); | |
90 | module_param(ignore_ctl_error, bool, 0444); | |
91 | MODULE_PARM_DESC(ignore_ctl_error, | |
92 | "Ignore errors from USB controller for mixer interfaces."); | |
ef02e29b EZ |
93 | module_param(autoclock, bool, 0444); |
94 | MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes)."); | |
e2703363 TI |
95 | module_param_array(quirk_alias, charp, NULL, 0444); |
96 | MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef."); | |
f274baa4 TI |
97 | module_param_named(use_vmalloc, snd_usb_use_vmalloc, bool, 0444); |
98 | MODULE_PARM_DESC(use_vmalloc, "Use vmalloc for PCM intermediate buffers (default: yes)."); | |
e5779998 DM |
99 | |
100 | /* | |
101 | * we keep the snd_usb_audio_t instances by ourselves for merging | |
102 | * the all interfaces on the same card as one sound device. | |
103 | */ | |
104 | ||
105 | static DEFINE_MUTEX(register_mutex); | |
106 | static struct snd_usb_audio *usb_chip[SNDRV_CARDS]; | |
107 | static struct usb_driver usb_audio_driver; | |
108 | ||
109 | /* | |
110 | * disconnect streams | |
4c8c3a4f | 111 | * called from usb_audio_disconnect() |
e5779998 | 112 | */ |
a6cece9d | 113 | static void snd_usb_stream_disconnect(struct snd_usb_stream *as) |
e5779998 DM |
114 | { |
115 | int idx; | |
e5779998 DM |
116 | struct snd_usb_substream *subs; |
117 | ||
e5779998 DM |
118 | for (idx = 0; idx < 2; idx++) { |
119 | subs = &as->substream[idx]; | |
120 | if (!subs->num_formats) | |
76195fb0 | 121 | continue; |
e5779998 | 122 | subs->interface = -1; |
edcd3633 DM |
123 | subs->data_endpoint = NULL; |
124 | subs->sync_endpoint = NULL; | |
e5779998 DM |
125 | } |
126 | } | |
127 | ||
128 | static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface) | |
129 | { | |
130 | struct usb_device *dev = chip->dev; | |
131 | struct usb_host_interface *alts; | |
132 | struct usb_interface_descriptor *altsd; | |
133 | struct usb_interface *iface = usb_ifnum_to_if(dev, interface); | |
134 | ||
135 | if (!iface) { | |
0ba41d91 TI |
136 | dev_err(&dev->dev, "%u:%d : does not exist\n", |
137 | ctrlif, interface); | |
e5779998 DM |
138 | return -EINVAL; |
139 | } | |
140 | ||
342cda29 CL |
141 | alts = &iface->altsetting[0]; |
142 | altsd = get_iface_desc(alts); | |
143 | ||
144 | /* | |
145 | * Android with both accessory and audio interfaces enabled gets the | |
146 | * interface numbers wrong. | |
147 | */ | |
148 | if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) || | |
149 | chip->usb_id == USB_ID(0x18d1, 0x2d05)) && | |
150 | interface == 0 && | |
151 | altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC && | |
152 | altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) { | |
153 | interface = 2; | |
154 | iface = usb_ifnum_to_if(dev, interface); | |
155 | if (!iface) | |
156 | return -EINVAL; | |
157 | alts = &iface->altsetting[0]; | |
158 | altsd = get_iface_desc(alts); | |
159 | } | |
160 | ||
e5779998 | 161 | if (usb_interface_claimed(iface)) { |
0ba41d91 TI |
162 | dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n", |
163 | ctrlif, interface); | |
e5779998 DM |
164 | return -EINVAL; |
165 | } | |
166 | ||
e5779998 DM |
167 | if ((altsd->bInterfaceClass == USB_CLASS_AUDIO || |
168 | altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) && | |
169 | altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) { | |
79289e24 TI |
170 | int err = __snd_usbmidi_create(chip->card, iface, |
171 | &chip->midi_list, NULL, | |
172 | chip->usb_id); | |
e5779998 | 173 | if (err < 0) { |
0ba41d91 TI |
174 | dev_err(&dev->dev, |
175 | "%u:%d: cannot create sequencer device\n", | |
176 | ctrlif, interface); | |
e5779998 DM |
177 | return -EINVAL; |
178 | } | |
179 | usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L); | |
180 | ||
181 | return 0; | |
182 | } | |
183 | ||
184 | if ((altsd->bInterfaceClass != USB_CLASS_AUDIO && | |
185 | altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) || | |
186 | altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) { | |
0ba41d91 TI |
187 | dev_dbg(&dev->dev, |
188 | "%u:%d: skipping non-supported interface %d\n", | |
189 | ctrlif, interface, altsd->bInterfaceClass); | |
e5779998 DM |
190 | /* skip non-supported classes */ |
191 | return -EINVAL; | |
192 | } | |
193 | ||
194 | if (snd_usb_get_speed(dev) == USB_SPEED_LOW) { | |
0ba41d91 | 195 | dev_err(&dev->dev, "low speed audio streaming not supported\n"); |
e5779998 DM |
196 | return -EINVAL; |
197 | } | |
198 | ||
e8e8babf | 199 | if (! snd_usb_parse_audio_interface(chip, interface)) { |
e5779998 DM |
200 | usb_set_interface(dev, interface, 0); /* reset the current interface */ |
201 | usb_driver_claim_interface(&usb_audio_driver, iface, (void *)-1L); | |
e5779998 DM |
202 | } |
203 | ||
204 | return 0; | |
205 | } | |
206 | ||
207 | /* | |
208 | * parse audio control descriptor and create pcm/midi streams | |
209 | */ | |
210 | static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif) | |
211 | { | |
212 | struct usb_device *dev = chip->dev; | |
213 | struct usb_host_interface *host_iface; | |
214 | struct usb_interface_descriptor *altsd; | |
e5779998 DM |
215 | int i, protocol; |
216 | ||
217 | /* find audiocontrol interface */ | |
218 | host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0]; | |
e5779998 DM |
219 | altsd = get_iface_desc(host_iface); |
220 | protocol = altsd->bInterfaceProtocol; | |
221 | ||
e5779998 | 222 | switch (protocol) { |
a2acad82 | 223 | default: |
0ba41d91 TI |
224 | dev_warn(&dev->dev, |
225 | "unknown interface protocol %#02x, assuming v1\n", | |
226 | protocol); | |
a2acad82 CL |
227 | /* fall through */ |
228 | ||
e5779998 | 229 | case UAC_VERSION_1: { |
3763f618 JS |
230 | struct uac1_ac_header_descriptor *h1; |
231 | int rest_bytes; | |
232 | ||
233 | h1 = snd_usb_find_csint_desc(host_iface->extra, | |
234 | host_iface->extralen, | |
235 | NULL, UAC_HEADER); | |
3e96d728 | 236 | if (!h1 || h1->bLength < sizeof(*h1)) { |
3763f618 JS |
237 | dev_err(&dev->dev, "cannot find UAC_HEADER\n"); |
238 | return -EINVAL; | |
239 | } | |
240 | ||
241 | rest_bytes = (void *)(host_iface->extra + | |
242 | host_iface->extralen) - (void *)h1; | |
243 | ||
244 | /* just to be sure -- this shouldn't hit at all */ | |
245 | if (rest_bytes <= 0) { | |
246 | dev_err(&dev->dev, "invalid control header\n"); | |
247 | return -EINVAL; | |
248 | } | |
e5779998 | 249 | |
bfc81a8b TI |
250 | if (rest_bytes < sizeof(*h1)) { |
251 | dev_err(&dev->dev, "too short v1 buffer descriptor\n"); | |
252 | return -EINVAL; | |
253 | } | |
254 | ||
e5779998 | 255 | if (!h1->bInCollection) { |
0ba41d91 | 256 | dev_info(&dev->dev, "skipping empty audio interface (v1)\n"); |
e5779998 DM |
257 | return -EINVAL; |
258 | } | |
259 | ||
bfc81a8b TI |
260 | if (rest_bytes < h1->bLength) { |
261 | dev_err(&dev->dev, "invalid buffer length (v1)\n"); | |
262 | return -EINVAL; | |
263 | } | |
264 | ||
e5779998 | 265 | if (h1->bLength < sizeof(*h1) + h1->bInCollection) { |
0ba41d91 | 266 | dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n"); |
e5779998 DM |
267 | return -EINVAL; |
268 | } | |
269 | ||
270 | for (i = 0; i < h1->bInCollection; i++) | |
271 | snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]); | |
272 | ||
273 | break; | |
274 | } | |
275 | ||
9a2fe9b8 RB |
276 | case UAC_VERSION_2: |
277 | case UAC_VERSION_3: { | |
e5779998 DM |
278 | struct usb_interface_assoc_descriptor *assoc = |
279 | usb_ifnum_to_if(dev, ctrlif)->intf_assoc; | |
280 | ||
281a6ac0 CL |
281 | if (!assoc) { |
282 | /* | |
283 | * Firmware writers cannot count to three. So to find | |
284 | * the IAD on the NuForce UDH-100, also check the next | |
285 | * interface. | |
286 | */ | |
287 | struct usb_interface *iface = | |
288 | usb_ifnum_to_if(dev, ctrlif + 1); | |
289 | if (iface && | |
290 | iface->intf_assoc && | |
291 | iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO && | |
292 | iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2) | |
293 | assoc = iface->intf_assoc; | |
294 | } | |
295 | ||
e5779998 | 296 | if (!assoc) { |
9a2fe9b8 | 297 | dev_err(&dev->dev, "Audio class v2/v3 interfaces need an interface association\n"); |
e5779998 DM |
298 | return -EINVAL; |
299 | } | |
300 | ||
17156f23 RB |
301 | if (protocol == UAC_VERSION_3) { |
302 | int badd = assoc->bFunctionSubClass; | |
303 | ||
304 | if (badd != UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0 && | |
305 | (badd < UAC3_FUNCTION_SUBCLASS_GENERIC_IO || | |
306 | badd > UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE)) { | |
307 | dev_err(&dev->dev, | |
308 | "Unsupported UAC3 BADD profile\n"); | |
309 | return -EINVAL; | |
310 | } | |
311 | ||
312 | chip->badd_profile = badd; | |
313 | } | |
314 | ||
e5779998 DM |
315 | for (i = 0; i < assoc->bInterfaceCount; i++) { |
316 | int intf = assoc->bFirstInterface + i; | |
317 | ||
318 | if (intf != ctrlif) | |
319 | snd_usb_create_stream(chip, ctrlif, intf); | |
320 | } | |
321 | ||
322 | break; | |
323 | } | |
e5779998 DM |
324 | } |
325 | ||
326 | return 0; | |
327 | } | |
328 | ||
329 | /* | |
330 | * free the chip instance | |
331 | * | |
332 | * here we have to do not much, since pcm and controls are already freed | |
333 | * | |
334 | */ | |
335 | ||
011ae2bf | 336 | static void snd_usb_audio_free(struct snd_card *card) |
e5779998 | 337 | { |
011ae2bf | 338 | struct snd_usb_audio *chip = card->private_data; |
a6cece9d | 339 | struct snd_usb_endpoint *ep, *n; |
92a586bd | 340 | |
a6cece9d TI |
341 | list_for_each_entry_safe(ep, n, &chip->ep_list, list) |
342 | snd_usb_endpoint_free(ep); | |
92a586bd | 343 | |
596580d0 | 344 | mutex_destroy(&chip->mutex); |
6ff1a253 TI |
345 | if (!atomic_read(&chip->shutdown)) |
346 | dev_set_drvdata(&chip->dev->dev, NULL); | |
e5779998 DM |
347 | } |
348 | ||
07eca5fc TI |
349 | static void usb_audio_make_shortname(struct usb_device *dev, |
350 | struct snd_usb_audio *chip, | |
351 | const struct snd_usb_audio_quirk *quirk) | |
352 | { | |
353 | struct snd_card *card = chip->card; | |
354 | ||
355 | if (quirk && quirk->product_name && *quirk->product_name) { | |
356 | strlcpy(card->shortname, quirk->product_name, | |
357 | sizeof(card->shortname)); | |
358 | return; | |
359 | } | |
360 | ||
361 | /* retrieve the device string as shortname */ | |
362 | if (!dev->descriptor.iProduct || | |
363 | usb_string(dev, dev->descriptor.iProduct, | |
364 | card->shortname, sizeof(card->shortname)) <= 0) { | |
365 | /* no name available from anywhere, so use ID */ | |
366 | sprintf(card->shortname, "USB Device %#04x:%#04x", | |
367 | USB_ID_VENDOR(chip->usb_id), | |
368 | USB_ID_PRODUCT(chip->usb_id)); | |
369 | } | |
370 | ||
371 | strim(card->shortname); | |
372 | } | |
373 | ||
374 | static void usb_audio_make_longname(struct usb_device *dev, | |
375 | struct snd_usb_audio *chip, | |
376 | const struct snd_usb_audio_quirk *quirk) | |
377 | { | |
378 | struct snd_card *card = chip->card; | |
379 | int len; | |
380 | ||
381 | /* shortcut - if any pre-defined string is given, use it */ | |
382 | if (quirk && quirk->profile_name && *quirk->profile_name) { | |
383 | strlcpy(card->longname, quirk->profile_name, | |
384 | sizeof(card->longname)); | |
385 | return; | |
386 | } | |
387 | ||
388 | if (quirk && quirk->vendor_name && *quirk->vendor_name) { | |
389 | len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname)); | |
390 | } else { | |
391 | /* retrieve the vendor and device strings as longname */ | |
392 | if (dev->descriptor.iManufacturer) | |
393 | len = usb_string(dev, dev->descriptor.iManufacturer, | |
394 | card->longname, sizeof(card->longname)); | |
395 | else | |
396 | len = 0; | |
397 | /* we don't really care if there isn't any vendor string */ | |
398 | } | |
399 | if (len > 0) { | |
400 | strim(card->longname); | |
401 | if (*card->longname) | |
402 | strlcat(card->longname, " ", sizeof(card->longname)); | |
403 | } | |
404 | ||
405 | strlcat(card->longname, card->shortname, sizeof(card->longname)); | |
406 | ||
407 | len = strlcat(card->longname, " at ", sizeof(card->longname)); | |
408 | ||
409 | if (len < sizeof(card->longname)) | |
410 | usb_make_path(dev, card->longname + len, sizeof(card->longname) - len); | |
411 | ||
412 | switch (snd_usb_get_speed(dev)) { | |
413 | case USB_SPEED_LOW: | |
414 | strlcat(card->longname, ", low speed", sizeof(card->longname)); | |
415 | break; | |
416 | case USB_SPEED_FULL: | |
417 | strlcat(card->longname, ", full speed", sizeof(card->longname)); | |
418 | break; | |
419 | case USB_SPEED_HIGH: | |
420 | strlcat(card->longname, ", high speed", sizeof(card->longname)); | |
421 | break; | |
422 | case USB_SPEED_SUPER: | |
423 | strlcat(card->longname, ", super speed", sizeof(card->longname)); | |
424 | break; | |
425 | case USB_SPEED_SUPER_PLUS: | |
426 | strlcat(card->longname, ", super speed plus", sizeof(card->longname)); | |
427 | break; | |
428 | default: | |
429 | break; | |
430 | } | |
431 | } | |
432 | ||
e5779998 DM |
433 | /* |
434 | * create a chip instance and set its names. | |
435 | */ | |
874b8d42 TI |
436 | static int snd_usb_audio_create(struct usb_interface *intf, |
437 | struct usb_device *dev, int idx, | |
e5779998 | 438 | const struct snd_usb_audio_quirk *quirk, |
03a1f48e | 439 | unsigned int usb_id, |
e5779998 DM |
440 | struct snd_usb_audio **rchip) |
441 | { | |
442 | struct snd_card *card; | |
443 | struct snd_usb_audio *chip; | |
07eca5fc | 444 | int err; |
e5779998 | 445 | char component[14]; |
e5779998 DM |
446 | |
447 | *rchip = NULL; | |
448 | ||
4f4e8f69 PZ |
449 | switch (snd_usb_get_speed(dev)) { |
450 | case USB_SPEED_LOW: | |
451 | case USB_SPEED_FULL: | |
452 | case USB_SPEED_HIGH: | |
df3774c5 | 453 | case USB_SPEED_WIRELESS: |
4f4e8f69 | 454 | case USB_SPEED_SUPER: |
748a1ccc | 455 | case USB_SPEED_SUPER_PLUS: |
4f4e8f69 PZ |
456 | break; |
457 | default: | |
0ba41d91 | 458 | dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev)); |
e5779998 DM |
459 | return -ENXIO; |
460 | } | |
461 | ||
874b8d42 | 462 | err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE, |
011ae2bf | 463 | sizeof(*chip), &card); |
e5779998 | 464 | if (err < 0) { |
0ba41d91 | 465 | dev_err(&dev->dev, "cannot create card instance %d\n", idx); |
e5779998 DM |
466 | return err; |
467 | } | |
468 | ||
011ae2bf | 469 | chip = card->private_data; |
596580d0 | 470 | mutex_init(&chip->mutex); |
47ab1545 | 471 | init_waitqueue_head(&chip->shutdown_wait); |
e5779998 DM |
472 | chip->index = idx; |
473 | chip->dev = dev; | |
474 | chip->card = card; | |
475 | chip->setup = device_setup[idx]; | |
ef02e29b | 476 | chip->autoclock = autoclock; |
a6da499b | 477 | atomic_set(&chip->active, 1); /* avoid autopm during probing */ |
47ab1545 TI |
478 | atomic_set(&chip->usage_count, 0); |
479 | atomic_set(&chip->shutdown, 0); | |
e5779998 | 480 | |
03a1f48e | 481 | chip->usb_id = usb_id; |
e5779998 | 482 | INIT_LIST_HEAD(&chip->pcm_list); |
edcd3633 | 483 | INIT_LIST_HEAD(&chip->ep_list); |
e5779998 DM |
484 | INIT_LIST_HEAD(&chip->midi_list); |
485 | INIT_LIST_HEAD(&chip->mixer_list); | |
486 | ||
011ae2bf | 487 | card->private_free = snd_usb_audio_free; |
e5779998 DM |
488 | |
489 | strcpy(card->driver, "USB-Audio"); | |
490 | sprintf(component, "USB%04x:%04x", | |
491 | USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id)); | |
492 | snd_component_add(card, component); | |
493 | ||
07eca5fc TI |
494 | usb_audio_make_shortname(dev, chip, quirk); |
495 | usb_audio_make_longname(dev, chip, quirk); | |
e5779998 DM |
496 | |
497 | snd_usb_audio_create_proc(chip); | |
498 | ||
499 | *rchip = chip; | |
500 | return 0; | |
501 | } | |
502 | ||
e2703363 TI |
503 | /* look for a matching quirk alias id */ |
504 | static bool get_alias_id(struct usb_device *dev, unsigned int *id) | |
505 | { | |
506 | int i; | |
507 | unsigned int src, dst; | |
508 | ||
509 | for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) { | |
510 | if (!quirk_alias[i] || | |
511 | sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 || | |
512 | src != *id) | |
513 | continue; | |
514 | dev_info(&dev->dev, | |
515 | "device (%04x:%04x): applying quirk alias %04x:%04x\n", | |
516 | USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id), | |
517 | USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst)); | |
518 | *id = dst; | |
519 | return true; | |
520 | } | |
521 | ||
522 | return false; | |
523 | } | |
524 | ||
8824ae2d | 525 | static const struct usb_device_id usb_audio_ids[]; /* defined below */ |
e2703363 TI |
526 | |
527 | /* look for the corresponding quirk */ | |
528 | static const struct snd_usb_audio_quirk * | |
529 | get_alias_quirk(struct usb_device *dev, unsigned int id) | |
530 | { | |
531 | const struct usb_device_id *p; | |
532 | ||
533 | for (p = usb_audio_ids; p->match_flags; p++) { | |
534 | /* FIXME: this checks only vendor:product pair in the list */ | |
535 | if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) == | |
536 | USB_DEVICE_ID_MATCH_DEVICE && | |
537 | p->idVendor == USB_ID_VENDOR(id) && | |
538 | p->idProduct == USB_ID_PRODUCT(id)) | |
539 | return (const struct snd_usb_audio_quirk *)p->driver_info; | |
540 | } | |
541 | ||
542 | return NULL; | |
543 | } | |
544 | ||
e5779998 DM |
545 | /* |
546 | * probe the active usb device | |
547 | * | |
548 | * note that this can be called multiple times per a device, when it | |
549 | * includes multiple audio control interfaces. | |
550 | * | |
551 | * thus we check the usb device pointer and creates the card instance | |
552 | * only at the first time. the successive calls of this function will | |
553 | * append the pcm interface to the corresponding card. | |
554 | */ | |
4c8c3a4f TI |
555 | static int usb_audio_probe(struct usb_interface *intf, |
556 | const struct usb_device_id *usb_id) | |
e5779998 | 557 | { |
4c8c3a4f TI |
558 | struct usb_device *dev = interface_to_usbdev(intf); |
559 | const struct snd_usb_audio_quirk *quirk = | |
560 | (const struct snd_usb_audio_quirk *)usb_id->driver_info; | |
e5779998 | 561 | struct snd_usb_audio *chip; |
4c8c3a4f | 562 | int i, err; |
e5779998 DM |
563 | struct usb_host_interface *alts; |
564 | int ifnum; | |
565 | u32 id; | |
566 | ||
567 | alts = &intf->altsetting[0]; | |
568 | ifnum = get_iface_desc(alts)->bInterfaceNumber; | |
569 | id = USB_ID(le16_to_cpu(dev->descriptor.idVendor), | |
570 | le16_to_cpu(dev->descriptor.idProduct)); | |
e2703363 TI |
571 | if (get_alias_id(dev, &id)) |
572 | quirk = get_alias_quirk(dev, id); | |
e5779998 | 573 | if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum) |
4c8c3a4f | 574 | return -ENXIO; |
e5779998 | 575 | |
79289e24 | 576 | err = snd_usb_apply_boot_quirk(dev, intf, quirk, id); |
4c8c3a4f TI |
577 | if (err < 0) |
578 | return err; | |
e5779998 DM |
579 | |
580 | /* | |
581 | * found a config. now register to ALSA | |
582 | */ | |
583 | ||
584 | /* check whether it's already registered */ | |
585 | chip = NULL; | |
586 | mutex_lock(®ister_mutex); | |
587 | for (i = 0; i < SNDRV_CARDS; i++) { | |
588 | if (usb_chip[i] && usb_chip[i]->dev == dev) { | |
47ab1545 | 589 | if (atomic_read(&usb_chip[i]->shutdown)) { |
0ba41d91 | 590 | dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n"); |
4c8c3a4f | 591 | err = -EIO; |
e5779998 DM |
592 | goto __error; |
593 | } | |
594 | chip = usb_chip[i]; | |
a6da499b | 595 | atomic_inc(&chip->active); /* avoid autopm */ |
e5779998 DM |
596 | break; |
597 | } | |
598 | } | |
599 | if (! chip) { | |
600 | /* it's a fresh one. | |
601 | * now look for an empty slot and create a new card instance | |
602 | */ | |
603 | for (i = 0; i < SNDRV_CARDS; i++) | |
108884e6 | 604 | if (!usb_chip[i] && |
e5779998 DM |
605 | (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) && |
606 | (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) { | |
108884e6 TN |
607 | if (enable[i]) { |
608 | err = snd_usb_audio_create(intf, dev, i, quirk, | |
609 | id, &chip); | |
610 | if (err < 0) | |
611 | goto __error; | |
612 | chip->pm_intf = intf; | |
613 | break; | |
614 | } else if (vid[i] != -1 || pid[i] != -1) { | |
615 | dev_info(&dev->dev, | |
616 | "device (%04x:%04x) is disabled\n", | |
617 | USB_ID_VENDOR(id), | |
618 | USB_ID_PRODUCT(id)); | |
619 | err = -ENOENT; | |
e5779998 | 620 | goto __error; |
108884e6 | 621 | } |
e5779998 DM |
622 | } |
623 | if (!chip) { | |
0ba41d91 | 624 | dev_err(&dev->dev, "no available usb audio device\n"); |
4c8c3a4f | 625 | err = -ENODEV; |
e5779998 DM |
626 | goto __error; |
627 | } | |
628 | } | |
76df5296 | 629 | dev_set_drvdata(&dev->dev, chip); |
e5779998 | 630 | |
7b6717e1 DM |
631 | /* |
632 | * For devices with more than one control interface, we assume the | |
633 | * first contains the audio controls. We might need a more specific | |
634 | * check here in the future. | |
635 | */ | |
636 | if (!chip->ctrl_intf) | |
637 | chip->ctrl_intf = alts; | |
79f920fb | 638 | |
5875c2cb DM |
639 | chip->txfr_quirk = 0; |
640 | err = 1; /* continue */ | |
641 | if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) { | |
642 | /* need some special handlings */ | |
4c8c3a4f TI |
643 | err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk); |
644 | if (err < 0) | |
5875c2cb DM |
645 | goto __error; |
646 | } | |
647 | ||
e5779998 DM |
648 | if (err > 0) { |
649 | /* create normal USB audio interfaces */ | |
4c8c3a4f TI |
650 | err = snd_usb_create_streams(chip, ifnum); |
651 | if (err < 0) | |
652 | goto __error; | |
653 | err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error); | |
654 | if (err < 0) | |
e5779998 | 655 | goto __error; |
e5779998 DM |
656 | } |
657 | ||
658 | /* we are allowed to call snd_card_register() many times */ | |
4c8c3a4f TI |
659 | err = snd_card_register(chip->card); |
660 | if (err < 0) | |
e5779998 | 661 | goto __error; |
e5779998 | 662 | |
66354f18 SK |
663 | if (quirk && quirk->shares_media_device) { |
664 | /* don't want to fail when snd_media_device_create() fails */ | |
665 | snd_media_device_create(chip, intf); | |
666 | } | |
667 | ||
e5779998 DM |
668 | usb_chip[chip->index] = chip; |
669 | chip->num_interfaces++; | |
4c8c3a4f | 670 | usb_set_intfdata(intf, chip); |
a6da499b | 671 | atomic_dec(&chip->active); |
e5779998 | 672 | mutex_unlock(®ister_mutex); |
4c8c3a4f | 673 | return 0; |
e5779998 DM |
674 | |
675 | __error: | |
61a6a108 | 676 | if (chip) { |
5f8cf712 HP |
677 | /* chip->active is inside the chip->card object, |
678 | * decrement before memory is possibly returned. | |
679 | */ | |
680 | atomic_dec(&chip->active); | |
61a6a108 TP |
681 | if (!chip->num_interfaces) |
682 | snd_card_free(chip->card); | |
61a6a108 | 683 | } |
e5779998 | 684 | mutex_unlock(®ister_mutex); |
4c8c3a4f | 685 | return err; |
e5779998 DM |
686 | } |
687 | ||
688 | /* | |
689 | * we need to take care of counter, since disconnection can be called also | |
690 | * many times as well as usb_audio_probe(). | |
691 | */ | |
4c8c3a4f | 692 | static void usb_audio_disconnect(struct usb_interface *intf) |
e5779998 | 693 | { |
4c8c3a4f | 694 | struct snd_usb_audio *chip = usb_get_intfdata(intf); |
e5779998 | 695 | struct snd_card *card; |
92a586bd | 696 | struct list_head *p; |
e5779998 | 697 | |
81b85b6b | 698 | if (chip == (void *)-1L) |
e5779998 DM |
699 | return; |
700 | ||
e5779998 | 701 | card = chip->card; |
10e44239 TI |
702 | |
703 | mutex_lock(®ister_mutex); | |
47ab1545 | 704 | if (atomic_inc_return(&chip->shutdown) == 1) { |
a6cece9d | 705 | struct snd_usb_stream *as; |
92a586bd | 706 | struct snd_usb_endpoint *ep; |
a6cece9d | 707 | struct usb_mixer_interface *mixer; |
92a586bd | 708 | |
47ab1545 TI |
709 | /* wait until all pending tasks done; |
710 | * they are protected by snd_usb_lock_shutdown() | |
711 | */ | |
712 | wait_event(chip->shutdown_wait, | |
713 | !atomic_read(&chip->usage_count)); | |
e5779998 DM |
714 | snd_card_disconnect(card); |
715 | /* release the pcm resources */ | |
a6cece9d TI |
716 | list_for_each_entry(as, &chip->pcm_list, list) { |
717 | snd_usb_stream_disconnect(as); | |
e5779998 | 718 | } |
edcd3633 | 719 | /* release the endpoint resources */ |
92a586bd TI |
720 | list_for_each_entry(ep, &chip->ep_list, list) { |
721 | snd_usb_endpoint_release(ep); | |
edcd3633 | 722 | } |
e5779998 DM |
723 | /* release the midi resources */ |
724 | list_for_each(p, &chip->midi_list) { | |
725 | snd_usbmidi_disconnect(p); | |
726 | } | |
66354f18 SK |
727 | /* |
728 | * Nice to check quirk && quirk->shares_media_device and | |
729 | * then call the snd_media_device_delete(). Don't have | |
730 | * access to the quirk here. snd_media_device_delete() | |
731 | * accesses mixer_list | |
732 | */ | |
733 | snd_media_device_delete(chip); | |
734 | ||
e5779998 | 735 | /* release mixer resources */ |
a6cece9d TI |
736 | list_for_each_entry(mixer, &chip->mixer_list, list) { |
737 | snd_usb_mixer_disconnect(mixer); | |
e5779998 | 738 | } |
0725dda2 TI |
739 | } |
740 | ||
741 | chip->num_interfaces--; | |
742 | if (chip->num_interfaces <= 0) { | |
e5779998 DM |
743 | usb_chip[chip->index] = NULL; |
744 | mutex_unlock(®ister_mutex); | |
745 | snd_card_free_when_closed(card); | |
746 | } else { | |
747 | mutex_unlock(®ister_mutex); | |
748 | } | |
749 | } | |
750 | ||
47ab1545 TI |
751 | /* lock the shutdown (disconnect) task and autoresume */ |
752 | int snd_usb_lock_shutdown(struct snd_usb_audio *chip) | |
88a8516a | 753 | { |
47ab1545 | 754 | int err; |
88a8516a | 755 | |
47ab1545 TI |
756 | atomic_inc(&chip->usage_count); |
757 | if (atomic_read(&chip->shutdown)) { | |
758 | err = -EIO; | |
759 | goto error; | |
760 | } | |
761 | err = snd_usb_autoresume(chip); | |
762 | if (err < 0) | |
763 | goto error; | |
764 | return 0; | |
88a8516a | 765 | |
47ab1545 TI |
766 | error: |
767 | if (atomic_dec_and_test(&chip->usage_count)) | |
768 | wake_up(&chip->shutdown_wait); | |
88a8516a ON |
769 | return err; |
770 | } | |
771 | ||
47ab1545 TI |
772 | /* autosuspend and unlock the shutdown */ |
773 | void snd_usb_unlock_shutdown(struct snd_usb_audio *chip) | |
774 | { | |
775 | snd_usb_autosuspend(chip); | |
776 | if (atomic_dec_and_test(&chip->usage_count)) | |
777 | wake_up(&chip->shutdown_wait); | |
778 | } | |
779 | ||
780 | #ifdef CONFIG_PM | |
781 | ||
782 | int snd_usb_autoresume(struct snd_usb_audio *chip) | |
783 | { | |
784 | if (atomic_read(&chip->shutdown)) | |
785 | return -EIO; | |
47ab1545 TI |
786 | if (atomic_inc_return(&chip->active) == 1) |
787 | return usb_autopm_get_interface(chip->pm_intf); | |
788 | return 0; | |
789 | } | |
790 | ||
88a8516a ON |
791 | void snd_usb_autosuspend(struct snd_usb_audio *chip) |
792 | { | |
5c06d68b TI |
793 | if (atomic_read(&chip->shutdown)) |
794 | return; | |
47ab1545 | 795 | if (atomic_dec_and_test(&chip->active)) |
88a8516a ON |
796 | usb_autopm_put_interface(chip->pm_intf); |
797 | } | |
798 | ||
e5779998 DM |
799 | static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message) |
800 | { | |
801 | struct snd_usb_audio *chip = usb_get_intfdata(intf); | |
e5779998 | 802 | struct snd_usb_stream *as; |
edf7de31 | 803 | struct usb_mixer_interface *mixer; |
f7881e5e | 804 | struct list_head *p; |
e5779998 DM |
805 | |
806 | if (chip == (void *)-1L) | |
807 | return 0; | |
808 | ||
0662292a TI |
809 | chip->autosuspended = !!PMSG_IS_AUTO(message); |
810 | if (!chip->autosuspended) | |
88a8516a | 811 | snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot); |
0662292a TI |
812 | if (!chip->num_suspended_intf++) { |
813 | list_for_each_entry(as, &chip->pcm_list, list) { | |
3f59aa11 | 814 | snd_usb_pcm_suspend(as); |
0662292a TI |
815 | as->substream[0].need_setup_ep = |
816 | as->substream[1].need_setup_ep = true; | |
aa53f986 | 817 | } |
0662292a TI |
818 | list_for_each(p, &chip->midi_list) |
819 | snd_usbmidi_suspend(p); | |
1c53e725 TI |
820 | list_for_each_entry(mixer, &chip->mixer_list, list) |
821 | snd_usb_mixer_suspend(mixer); | |
0662292a | 822 | } |
88a8516a | 823 | |
e5779998 DM |
824 | return 0; |
825 | } | |
826 | ||
400362f1 | 827 | static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume) |
e5779998 DM |
828 | { |
829 | struct snd_usb_audio *chip = usb_get_intfdata(intf); | |
3f59aa11 | 830 | struct snd_usb_stream *as; |
edf7de31 | 831 | struct usb_mixer_interface *mixer; |
f7881e5e | 832 | struct list_head *p; |
88a8516a | 833 | int err = 0; |
e5779998 DM |
834 | |
835 | if (chip == (void *)-1L) | |
836 | return 0; | |
837 | if (--chip->num_suspended_intf) | |
838 | return 0; | |
1ee23fe0 | 839 | |
47ab1545 | 840 | atomic_inc(&chip->active); /* avoid autopm */ |
3f59aa11 JS |
841 | |
842 | list_for_each_entry(as, &chip->pcm_list, list) { | |
843 | err = snd_usb_pcm_resume(as); | |
844 | if (err < 0) | |
845 | goto err_out; | |
846 | } | |
847 | ||
e5779998 DM |
848 | /* |
849 | * ALSA leaves material resumption to user space | |
edf7de31 | 850 | * we just notify and restart the mixers |
e5779998 | 851 | */ |
88a8516a | 852 | list_for_each_entry(mixer, &chip->mixer_list, list) { |
400362f1 | 853 | err = snd_usb_mixer_resume(mixer, reset_resume); |
88a8516a ON |
854 | if (err < 0) |
855 | goto err_out; | |
856 | } | |
e5779998 | 857 | |
f7881e5e AG |
858 | list_for_each(p, &chip->midi_list) { |
859 | snd_usbmidi_resume(p); | |
860 | } | |
861 | ||
88a8516a ON |
862 | if (!chip->autosuspended) |
863 | snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0); | |
864 | chip->autosuspended = 0; | |
e5779998 | 865 | |
88a8516a | 866 | err_out: |
47ab1545 | 867 | atomic_dec(&chip->active); /* allow autopm after this point */ |
88a8516a | 868 | return err; |
e5779998 | 869 | } |
400362f1 TI |
870 | |
871 | static int usb_audio_resume(struct usb_interface *intf) | |
872 | { | |
873 | return __usb_audio_resume(intf, false); | |
874 | } | |
875 | ||
876 | static int usb_audio_reset_resume(struct usb_interface *intf) | |
877 | { | |
878 | return __usb_audio_resume(intf, true); | |
879 | } | |
6407d474 RD |
880 | #else |
881 | #define usb_audio_suspend NULL | |
882 | #define usb_audio_resume NULL | |
400362f1 | 883 | #define usb_audio_reset_resume NULL |
e5779998 DM |
884 | #endif /* CONFIG_PM */ |
885 | ||
8824ae2d | 886 | static const struct usb_device_id usb_audio_ids [] = { |
e5779998 DM |
887 | #include "quirks-table.h" |
888 | { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS), | |
889 | .bInterfaceClass = USB_CLASS_AUDIO, | |
890 | .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL }, | |
891 | { } /* Terminating entry */ | |
892 | }; | |
f9d35435 | 893 | MODULE_DEVICE_TABLE(usb, usb_audio_ids); |
e5779998 DM |
894 | |
895 | /* | |
896 | * entry point for linux usb interface | |
897 | */ | |
898 | ||
899 | static struct usb_driver usb_audio_driver = { | |
900 | .name = "snd-usb-audio", | |
901 | .probe = usb_audio_probe, | |
902 | .disconnect = usb_audio_disconnect, | |
903 | .suspend = usb_audio_suspend, | |
904 | .resume = usb_audio_resume, | |
400362f1 | 905 | .reset_resume = usb_audio_reset_resume, |
e5779998 | 906 | .id_table = usb_audio_ids, |
88a8516a | 907 | .supports_autosuspend = 1, |
e5779998 DM |
908 | }; |
909 | ||
6b5a7c66 | 910 | module_usb_driver(usb_audio_driver); |