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