GNU Linux-libre 4.4.288-gnu1
[releases.git] / sound / usb / card.c
1 /*
2  *   (Tentative) USB Audio Driver for ALSA
3  *
4  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
5  *
6  *   Many codes borrowed from audio.c by
7  *          Alan Cox (alan@lxorguk.ukuu.org.uk)
8  *          Thomas Sailer (sailer@ife.ee.ethz.ch)
9  *
10  *
11  *   This program is free software; you can redistribute it and/or modify
12  *   it under the terms of the GNU General Public License as published by
13  *   the Free Software Foundation; either version 2 of the License, or
14  *   (at your option) any later version.
15  *
16  *   This program is distributed in the hope that it will be useful,
17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  *   GNU General Public License for more details.
20  *
21  *   You should have received a copy of the GNU General Public License
22  *   along with this program; if not, write to the Free Software
23  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
24  *
25  *
26  *  NOTES:
27  *
28  *   - 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>
41 #include <linux/ctype.h>
42 #include <linux/usb.h>
43 #include <linux/moduleparam.h>
44 #include <linux/mutex.h>
45 #include <linux/usb/audio.h>
46 #include <linux/usb/audio-v2.h>
47 #include <linux/module.h>
48
49 #include <sound/control.h>
50 #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"
59 #include "mixer.h"
60 #include "proc.h"
61 #include "quirks.h"
62 #include "endpoint.h"
63 #include "helper.h"
64 #include "debug.h"
65 #include "pcm.h"
66 #include "format.h"
67 #include "power.h"
68 #include "stream.h"
69
70 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
71 MODULE_DESCRIPTION("USB Audio");
72 MODULE_LICENSE("GPL");
73 MODULE_SUPPORTED_DEVICE("{{Generic,USB Audio}}");
74
75
76 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
77 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
78 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */
79 /* Vendor/product IDs for this card */
80 static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
81 static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };
82 static int device_setup[SNDRV_CARDS]; /* device parameter for this card */
83 static bool ignore_ctl_error;
84 static bool autoclock = true;
85
86 module_param_array(index, int, NULL, 0444);
87 MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");
88 module_param_array(id, charp, NULL, 0444);
89 MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");
90 module_param_array(enable, bool, NULL, 0444);
91 MODULE_PARM_DESC(enable, "Enable USB audio adapter.");
92 module_param_array(vid, int, NULL, 0444);
93 MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");
94 module_param_array(pid, int, NULL, 0444);
95 MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");
96 module_param_array(device_setup, int, NULL, 0444);
97 MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");
98 module_param(ignore_ctl_error, bool, 0444);
99 MODULE_PARM_DESC(ignore_ctl_error,
100                  "Ignore errors from USB controller for mixer interfaces.");
101 module_param(autoclock, bool, 0444);
102 MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");
103
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
109 static DEFINE_MUTEX(register_mutex);
110 static struct snd_usb_audio *usb_chip[SNDRV_CARDS];
111 static struct usb_driver usb_audio_driver;
112
113 /*
114  * disconnect streams
115  * called from usb_audio_disconnect()
116  */
117 static void snd_usb_stream_disconnect(struct snd_usb_stream *as)
118 {
119         int idx;
120         struct snd_usb_substream *subs;
121
122         for (idx = 0; idx < 2; idx++) {
123                 subs = &as->substream[idx];
124                 if (!subs->num_formats)
125                         continue;
126                 subs->interface = -1;
127                 subs->data_endpoint = NULL;
128                 subs->sync_endpoint = NULL;
129         }
130 }
131
132 static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)
133 {
134         struct usb_device *dev = chip->dev;
135         struct usb_host_interface *alts;
136         struct usb_interface_descriptor *altsd;
137         struct usb_interface *iface = usb_ifnum_to_if(dev, interface);
138
139         if (!iface) {
140                 dev_err(&dev->dev, "%u:%d : does not exist\n",
141                         ctrlif, interface);
142                 return -EINVAL;
143         }
144
145         alts = &iface->altsetting[0];
146         altsd = get_iface_desc(alts);
147
148         /*
149          * Android with both accessory and audio interfaces enabled gets the
150          * interface numbers wrong.
151          */
152         if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||
153              chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&
154             interface == 0 &&
155             altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
156             altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {
157                 interface = 2;
158                 iface = usb_ifnum_to_if(dev, interface);
159                 if (!iface)
160                         return -EINVAL;
161                 alts = &iface->altsetting[0];
162                 altsd = get_iface_desc(alts);
163         }
164
165         if (usb_interface_claimed(iface)) {
166                 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",
167                         ctrlif, interface);
168                 return -EINVAL;
169         }
170
171         if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||
172              altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&
173             altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {
174                 int err = snd_usbmidi_create(chip->card, iface,
175                                              &chip->midi_list, NULL);
176                 if (err < 0) {
177                         dev_err(&dev->dev,
178                                 "%u:%d: cannot create sequencer device\n",
179                                 ctrlif, interface);
180                         return -EINVAL;
181                 }
182                 return usb_driver_claim_interface(&usb_audio_driver, iface,
183                                                   USB_AUDIO_IFACE_UNUSED);
184         }
185
186         if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
187              altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
188             altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {
189                 dev_dbg(&dev->dev,
190                         "%u:%d: skipping non-supported interface %d\n",
191                         ctrlif, interface, altsd->bInterfaceClass);
192                 /* skip non-supported classes */
193                 return -EINVAL;
194         }
195
196         if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {
197                 dev_err(&dev->dev, "low speed audio streaming not supported\n");
198                 return -EINVAL;
199         }
200
201         if (! snd_usb_parse_audio_interface(chip, interface)) {
202                 usb_set_interface(dev, interface, 0); /* reset the current interface */
203                 return usb_driver_claim_interface(&usb_audio_driver, iface,
204                                                   USB_AUDIO_IFACE_UNUSED);
205         }
206
207         return 0;
208 }
209
210 /*
211  * parse audio control descriptor and create pcm/midi streams
212  */
213 static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)
214 {
215         struct usb_device *dev = chip->dev;
216         struct usb_host_interface *host_iface;
217         struct usb_interface_descriptor *altsd;
218         void *control_header;
219         int i, protocol;
220         int rest_bytes;
221
222         /* find audiocontrol interface */
223         host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];
224         control_header = snd_usb_find_csint_desc(host_iface->extra,
225                                                  host_iface->extralen,
226                                                  NULL, UAC_HEADER);
227         altsd = get_iface_desc(host_iface);
228         protocol = altsd->bInterfaceProtocol;
229
230         if (!control_header) {
231                 dev_err(&dev->dev, "cannot find UAC_HEADER\n");
232                 return -EINVAL;
233         }
234
235         rest_bytes = (void *)(host_iface->extra + host_iface->extralen) -
236                 control_header;
237
238         /* just to be sure -- this shouldn't hit at all */
239         if (rest_bytes <= 0) {
240                 dev_err(&dev->dev, "invalid control header\n");
241                 return -EINVAL;
242         }
243
244         switch (protocol) {
245         default:
246                 dev_warn(&dev->dev,
247                          "unknown interface protocol %#02x, assuming v1\n",
248                          protocol);
249                 /* fall through */
250
251         case UAC_VERSION_1: {
252                 struct uac1_ac_header_descriptor *h1 = control_header;
253
254                 if (rest_bytes < sizeof(*h1)) {
255                         dev_err(&dev->dev, "too short v1 buffer descriptor\n");
256                         return -EINVAL;
257                 }
258
259                 if (!h1->bInCollection) {
260                         dev_info(&dev->dev, "skipping empty audio interface (v1)\n");
261                         return -EINVAL;
262                 }
263
264                 if (rest_bytes < h1->bLength) {
265                         dev_err(&dev->dev, "invalid buffer length (v1)\n");
266                         return -EINVAL;
267                 }
268
269                 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {
270                         dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");
271                         return -EINVAL;
272                 }
273
274                 for (i = 0; i < h1->bInCollection; i++)
275                         snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);
276
277                 break;
278         }
279
280         case UAC_VERSION_2: {
281                 struct usb_interface_assoc_descriptor *assoc =
282                         usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
283
284                 if (!assoc) {
285                         /*
286                          * Firmware writers cannot count to three.  So to find
287                          * the IAD on the NuForce UDH-100, also check the next
288                          * interface.
289                          */
290                         struct usb_interface *iface =
291                                 usb_ifnum_to_if(dev, ctrlif + 1);
292                         if (iface &&
293                             iface->intf_assoc &&
294                             iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&
295                             iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)
296                                 assoc = iface->intf_assoc;
297                 }
298
299                 if (!assoc) {
300                         dev_err(&dev->dev, "Audio class v2 interfaces need an interface association\n");
301                         return -EINVAL;
302                 }
303
304                 for (i = 0; i < assoc->bInterfaceCount; i++) {
305                         int intf = assoc->bFirstInterface + i;
306
307                         if (intf != ctrlif)
308                                 snd_usb_create_stream(chip, ctrlif, intf);
309                 }
310
311                 break;
312         }
313         }
314
315         return 0;
316 }
317
318 /*
319  * free the chip instance
320  *
321  * here we have to do not much, since pcm and controls are already freed
322  *
323  */
324
325 static int snd_usb_audio_free(struct snd_usb_audio *chip)
326 {
327         struct snd_usb_endpoint *ep, *n;
328
329         list_for_each_entry_safe(ep, n, &chip->ep_list, list)
330                 snd_usb_endpoint_free(ep);
331
332         mutex_destroy(&chip->mutex);
333         kfree(chip);
334         return 0;
335 }
336
337 static int snd_usb_audio_dev_free(struct snd_device *device)
338 {
339         struct snd_usb_audio *chip = device->device_data;
340         return snd_usb_audio_free(chip);
341 }
342
343 /*
344  * create a chip instance and set its names.
345  */
346 static int snd_usb_audio_create(struct usb_interface *intf,
347                                 struct usb_device *dev, int idx,
348                                 const struct snd_usb_audio_quirk *quirk,
349                                 struct snd_usb_audio **rchip)
350 {
351         struct snd_card *card;
352         struct snd_usb_audio *chip;
353         int err, len;
354         char component[14];
355         static struct snd_device_ops ops = {
356                 .dev_free =     snd_usb_audio_dev_free,
357         };
358
359         *rchip = NULL;
360
361         switch (snd_usb_get_speed(dev)) {
362         case USB_SPEED_LOW:
363         case USB_SPEED_FULL:
364         case USB_SPEED_HIGH:
365         case USB_SPEED_WIRELESS:
366         case USB_SPEED_SUPER:
367                 break;
368         default:
369                 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));
370                 return -ENXIO;
371         }
372
373         err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,
374                            0, &card);
375         if (err < 0) {
376                 dev_err(&dev->dev, "cannot create card instance %d\n", idx);
377                 return err;
378         }
379
380         chip = kzalloc(sizeof(*chip), GFP_KERNEL);
381         if (! chip) {
382                 snd_card_free(card);
383                 return -ENOMEM;
384         }
385
386         mutex_init(&chip->mutex);
387         init_waitqueue_head(&chip->shutdown_wait);
388         chip->index = idx;
389         chip->dev = dev;
390         chip->card = card;
391         chip->setup = device_setup[idx];
392         chip->autoclock = autoclock;
393         atomic_set(&chip->active, 1); /* avoid autopm during probing */
394         atomic_set(&chip->usage_count, 0);
395         atomic_set(&chip->shutdown, 0);
396
397         chip->usb_id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
398                               le16_to_cpu(dev->descriptor.idProduct));
399         INIT_LIST_HEAD(&chip->pcm_list);
400         INIT_LIST_HEAD(&chip->ep_list);
401         INIT_LIST_HEAD(&chip->midi_list);
402         INIT_LIST_HEAD(&chip->mixer_list);
403
404         if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
405                 snd_usb_audio_free(chip);
406                 snd_card_free(card);
407                 return err;
408         }
409
410         strcpy(card->driver, "USB-Audio");
411         sprintf(component, "USB%04x:%04x",
412                 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));
413         snd_component_add(card, component);
414
415         /* retrieve the device string as shortname */
416         if (quirk && quirk->product_name && *quirk->product_name) {
417                 strlcpy(card->shortname, quirk->product_name, sizeof(card->shortname));
418         } else {
419                 if (!dev->descriptor.iProduct ||
420                     usb_string(dev, dev->descriptor.iProduct,
421                     card->shortname, sizeof(card->shortname)) <= 0) {
422                         /* no name available from anywhere, so use ID */
423                         sprintf(card->shortname, "USB Device %#04x:%#04x",
424                                 USB_ID_VENDOR(chip->usb_id),
425                                 USB_ID_PRODUCT(chip->usb_id));
426                 }
427         }
428         strim(card->shortname);
429
430         /* retrieve the vendor and device strings as longname */
431         if (quirk && quirk->vendor_name && *quirk->vendor_name) {
432                 len = strlcpy(card->longname, quirk->vendor_name, sizeof(card->longname));
433         } else {
434                 if (dev->descriptor.iManufacturer)
435                         len = usb_string(dev, dev->descriptor.iManufacturer,
436                                          card->longname, sizeof(card->longname));
437                 else
438                         len = 0;
439                 /* we don't really care if there isn't any vendor string */
440         }
441         if (len > 0) {
442                 strim(card->longname);
443                 if (*card->longname)
444                         strlcat(card->longname, " ", sizeof(card->longname));
445         }
446
447         strlcat(card->longname, card->shortname, sizeof(card->longname));
448
449         len = strlcat(card->longname, " at ", sizeof(card->longname));
450
451         if (len < sizeof(card->longname))
452                 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);
453
454         switch (snd_usb_get_speed(dev)) {
455         case USB_SPEED_LOW:
456                 strlcat(card->longname, ", low speed", sizeof(card->longname));
457                 break;
458         case USB_SPEED_FULL:
459                 strlcat(card->longname, ", full speed", sizeof(card->longname));
460                 break;
461         case USB_SPEED_HIGH:
462                 strlcat(card->longname, ", high speed", sizeof(card->longname));
463                 break;
464         case USB_SPEED_SUPER:
465                 strlcat(card->longname, ", super speed", sizeof(card->longname));
466                 break;
467         default:
468                 break;
469         }
470
471         snd_usb_audio_create_proc(chip);
472
473         *rchip = chip;
474         return 0;
475 }
476
477 /*
478  * probe the active usb device
479  *
480  * note that this can be called multiple times per a device, when it
481  * includes multiple audio control interfaces.
482  *
483  * thus we check the usb device pointer and creates the card instance
484  * only at the first time.  the successive calls of this function will
485  * append the pcm interface to the corresponding card.
486  */
487 static int usb_audio_probe(struct usb_interface *intf,
488                            const struct usb_device_id *usb_id)
489 {
490         struct usb_device *dev = interface_to_usbdev(intf);
491         const struct snd_usb_audio_quirk *quirk =
492                 (const struct snd_usb_audio_quirk *)usb_id->driver_info;
493         struct snd_usb_audio *chip;
494         int i, err;
495         struct usb_host_interface *alts;
496         int ifnum;
497         u32 id;
498
499         alts = &intf->altsetting[0];
500         ifnum = get_iface_desc(alts)->bInterfaceNumber;
501         id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),
502                     le16_to_cpu(dev->descriptor.idProduct));
503         if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)
504                 return -ENXIO;
505
506         err = snd_usb_apply_boot_quirk(dev, intf, quirk);
507         if (err < 0)
508                 return err;
509
510         /*
511          * found a config.  now register to ALSA
512          */
513
514         /* check whether it's already registered */
515         chip = NULL;
516         mutex_lock(&register_mutex);
517         for (i = 0; i < SNDRV_CARDS; i++) {
518                 if (usb_chip[i] && usb_chip[i]->dev == dev) {
519                         if (atomic_read(&usb_chip[i]->shutdown)) {
520                                 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");
521                                 err = -EIO;
522                                 goto __error;
523                         }
524                         chip = usb_chip[i];
525                         atomic_inc(&chip->active); /* avoid autopm */
526                         break;
527                 }
528         }
529         if (! chip) {
530                 /* it's a fresh one.
531                  * now look for an empty slot and create a new card instance
532                  */
533                 for (i = 0; i < SNDRV_CARDS; i++)
534                         if (enable[i] && ! usb_chip[i] &&
535                             (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&
536                             (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {
537                                 err = snd_usb_audio_create(intf, dev, i, quirk,
538                                                            &chip);
539                                 if (err < 0)
540                                         goto __error;
541                                 chip->pm_intf = intf;
542                                 break;
543                         }
544                 if (!chip) {
545                         dev_err(&dev->dev, "no available usb audio device\n");
546                         err = -ENODEV;
547                         goto __error;
548                 }
549         }
550
551         /*
552          * For devices with more than one control interface, we assume the
553          * first contains the audio controls. We might need a more specific
554          * check here in the future.
555          */
556         if (!chip->ctrl_intf)
557                 chip->ctrl_intf = alts;
558
559         chip->txfr_quirk = 0;
560         err = 1; /* continue */
561         if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {
562                 /* need some special handlings */
563                 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);
564                 if (err < 0)
565                         goto __error;
566         }
567
568         if (err > 0) {
569                 /* create normal USB audio interfaces */
570                 err = snd_usb_create_streams(chip, ifnum);
571                 if (err < 0)
572                         goto __error;
573                 err = snd_usb_create_mixer(chip, ifnum, ignore_ctl_error);
574                 if (err < 0)
575                         goto __error;
576         }
577
578         /* we are allowed to call snd_card_register() many times */
579         err = snd_card_register(chip->card);
580         if (err < 0)
581                 goto __error;
582
583         usb_chip[chip->index] = chip;
584         chip->num_interfaces++;
585         usb_set_intfdata(intf, chip);
586         atomic_dec(&chip->active);
587         mutex_unlock(&register_mutex);
588         return 0;
589
590  __error:
591         if (chip) {
592                 /* chip->active is inside the chip->card object,
593                  * decrement before memory is possibly returned.
594                  */
595                 atomic_dec(&chip->active);
596                 if (!chip->num_interfaces)
597                         snd_card_free(chip->card);
598         }
599         mutex_unlock(&register_mutex);
600         return err;
601 }
602
603 /*
604  * we need to take care of counter, since disconnection can be called also
605  * many times as well as usb_audio_probe().
606  */
607 static void usb_audio_disconnect(struct usb_interface *intf)
608 {
609         struct snd_usb_audio *chip = usb_get_intfdata(intf);
610         struct snd_card *card;
611         struct list_head *p;
612
613         if (chip == USB_AUDIO_IFACE_UNUSED)
614                 return;
615
616         card = chip->card;
617
618         mutex_lock(&register_mutex);
619         if (atomic_inc_return(&chip->shutdown) == 1) {
620                 struct snd_usb_stream *as;
621                 struct snd_usb_endpoint *ep;
622                 struct usb_mixer_interface *mixer;
623
624                 /* wait until all pending tasks done;
625                  * they are protected by snd_usb_lock_shutdown()
626                  */
627                 wait_event(chip->shutdown_wait,
628                            !atomic_read(&chip->usage_count));
629                 snd_card_disconnect(card);
630                 /* release the pcm resources */
631                 list_for_each_entry(as, &chip->pcm_list, list) {
632                         snd_usb_stream_disconnect(as);
633                 }
634                 /* release the endpoint resources */
635                 list_for_each_entry(ep, &chip->ep_list, list) {
636                         snd_usb_endpoint_release(ep);
637                 }
638                 /* release the midi resources */
639                 list_for_each(p, &chip->midi_list) {
640                         snd_usbmidi_disconnect(p);
641                 }
642                 /* release mixer resources */
643                 list_for_each_entry(mixer, &chip->mixer_list, list) {
644                         snd_usb_mixer_disconnect(mixer);
645                 }
646         }
647
648         chip->num_interfaces--;
649         if (chip->num_interfaces <= 0) {
650                 usb_chip[chip->index] = NULL;
651                 mutex_unlock(&register_mutex);
652                 snd_card_free_when_closed(card);
653         } else {
654                 mutex_unlock(&register_mutex);
655         }
656 }
657
658 /* lock the shutdown (disconnect) task and autoresume */
659 int snd_usb_lock_shutdown(struct snd_usb_audio *chip)
660 {
661         int err;
662
663         atomic_inc(&chip->usage_count);
664         if (atomic_read(&chip->shutdown)) {
665                 err = -EIO;
666                 goto error;
667         }
668         err = snd_usb_autoresume(chip);
669         if (err < 0)
670                 goto error;
671         return 0;
672
673  error:
674         if (atomic_dec_and_test(&chip->usage_count))
675                 wake_up(&chip->shutdown_wait);
676         return err;
677 }
678
679 /* autosuspend and unlock the shutdown */
680 void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)
681 {
682         snd_usb_autosuspend(chip);
683         if (atomic_dec_and_test(&chip->usage_count))
684                 wake_up(&chip->shutdown_wait);
685 }
686
687 #ifdef CONFIG_PM
688
689 int snd_usb_autoresume(struct snd_usb_audio *chip)
690 {
691         if (atomic_read(&chip->shutdown))
692                 return -EIO;
693         if (atomic_inc_return(&chip->active) == 1)
694                 return usb_autopm_get_interface(chip->pm_intf);
695         return 0;
696 }
697
698 void snd_usb_autosuspend(struct snd_usb_audio *chip)
699 {
700         if (atomic_read(&chip->shutdown))
701                 return;
702         if (atomic_dec_and_test(&chip->active))
703                 usb_autopm_put_interface(chip->pm_intf);
704 }
705
706 static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)
707 {
708         struct snd_usb_audio *chip = usb_get_intfdata(intf);
709         struct snd_usb_stream *as;
710         struct usb_mixer_interface *mixer;
711         struct list_head *p;
712
713         if (chip == USB_AUDIO_IFACE_UNUSED)
714                 return 0;
715
716         if (!chip->num_suspended_intf++) {
717                 list_for_each_entry(as, &chip->pcm_list, list) {
718                         snd_pcm_suspend_all(as->pcm);
719                         as->substream[0].need_setup_ep =
720                                 as->substream[1].need_setup_ep = true;
721                 }
722                 list_for_each(p, &chip->midi_list)
723                         snd_usbmidi_suspend(p);
724                 list_for_each_entry(mixer, &chip->mixer_list, list)
725                         snd_usb_mixer_suspend(mixer);
726         }
727
728         if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {
729                 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);
730                 chip->system_suspend = chip->num_suspended_intf;
731         }
732
733         return 0;
734 }
735
736 static int __usb_audio_resume(struct usb_interface *intf, bool reset_resume)
737 {
738         struct snd_usb_audio *chip = usb_get_intfdata(intf);
739         struct usb_mixer_interface *mixer;
740         struct list_head *p;
741         int err = 0;
742
743         if (chip == USB_AUDIO_IFACE_UNUSED)
744                 return 0;
745
746         atomic_inc(&chip->active); /* avoid autopm */
747         if (chip->num_suspended_intf > 1)
748                 goto out;
749
750         /*
751          * ALSA leaves material resumption to user space
752          * we just notify and restart the mixers
753          */
754         list_for_each_entry(mixer, &chip->mixer_list, list) {
755                 err = snd_usb_mixer_resume(mixer, reset_resume);
756                 if (err < 0)
757                         goto err_out;
758         }
759
760         list_for_each(p, &chip->midi_list) {
761                 snd_usbmidi_resume(p);
762         }
763
764  out:
765         if (chip->num_suspended_intf == chip->system_suspend) {
766                 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);
767                 chip->system_suspend = 0;
768         }
769         chip->num_suspended_intf--;
770
771 err_out:
772         atomic_dec(&chip->active); /* allow autopm after this point */
773         return err;
774 }
775
776 static int usb_audio_resume(struct usb_interface *intf)
777 {
778         return __usb_audio_resume(intf, false);
779 }
780
781 static int usb_audio_reset_resume(struct usb_interface *intf)
782 {
783         return __usb_audio_resume(intf, true);
784 }
785 #else
786 #define usb_audio_suspend       NULL
787 #define usb_audio_resume        NULL
788 #define usb_audio_reset_resume  NULL
789 #endif          /* CONFIG_PM */
790
791 static struct usb_device_id usb_audio_ids [] = {
792 #include "quirks-table.h"
793     { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),
794       .bInterfaceClass = USB_CLASS_AUDIO,
795       .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },
796     { }                                         /* Terminating entry */
797 };
798 MODULE_DEVICE_TABLE(usb, usb_audio_ids);
799
800 /*
801  * entry point for linux usb interface
802  */
803
804 static struct usb_driver usb_audio_driver = {
805         .name =         "snd-usb-audio",
806         .probe =        usb_audio_probe,
807         .disconnect =   usb_audio_disconnect,
808         .suspend =      usb_audio_suspend,
809         .resume =       usb_audio_resume,
810         .reset_resume = usb_audio_reset_resume,
811         .id_table =     usb_audio_ids,
812         .supports_autosuspend = 1,
813 };
814
815 module_usb_driver(usb_audio_driver);