ASoC: wm8962: Allow VMID time to fully ramp
[linux-2.6.git] / sound / usb / stream.c
1 /*
2  *   This program is free software; you can redistribute it and/or modify
3  *   it under the terms of the GNU General Public License as published by
4  *   the Free Software Foundation; either version 2 of the License, or
5  *   (at your option) any later version.
6  *
7  *   This program is distributed in the hope that it will be useful,
8  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
9  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  *   GNU General Public License for more details.
11  *
12  *   You should have received a copy of the GNU General Public License
13  *   along with this program; if not, write to the Free Software
14  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
15  */
16
17
18 #include <linux/init.h>
19 #include <linux/slab.h>
20 #include <linux/usb.h>
21 #include <linux/usb/audio.h>
22 #include <linux/usb/audio-v2.h>
23
24 #include <sound/core.h>
25 #include <sound/pcm.h>
26
27 #include "usbaudio.h"
28 #include "card.h"
29 #include "proc.h"
30 #include "quirks.h"
31 #include "endpoint.h"
32 #include "pcm.h"
33 #include "helper.h"
34 #include "format.h"
35 #include "clock.h"
36 #include "stream.h"
37
38 /*
39  * free a substream
40  */
41 static void free_substream(struct snd_usb_substream *subs)
42 {
43         struct list_head *p, *n;
44
45         if (!subs->num_formats)
46                 return; /* not initialized */
47         list_for_each_safe(p, n, &subs->fmt_list) {
48                 struct audioformat *fp = list_entry(p, struct audioformat, list);
49                 kfree(fp->rate_table);
50                 kfree(fp);
51         }
52         kfree(subs->rate_list.list);
53 }
54
55
56 /*
57  * free a usb stream instance
58  */
59 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
60 {
61         free_substream(&stream->substream[0]);
62         free_substream(&stream->substream[1]);
63         list_del(&stream->list);
64         kfree(stream);
65 }
66
67 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
68 {
69         struct snd_usb_stream *stream = pcm->private_data;
70         if (stream) {
71                 stream->pcm = NULL;
72                 snd_usb_audio_stream_free(stream);
73         }
74 }
75
76
77 /*
78  * add this endpoint to the chip instance.
79  * if a stream with the same endpoint already exists, append to it.
80  * if not, create a new pcm stream.
81  */
82 int snd_usb_add_audio_stream(struct snd_usb_audio *chip,
83                              int stream,
84                              struct audioformat *fp)
85 {
86         struct list_head *p;
87         struct snd_usb_stream *as;
88         struct snd_usb_substream *subs;
89         struct snd_pcm *pcm;
90         int err;
91
92         list_for_each(p, &chip->pcm_list) {
93                 as = list_entry(p, struct snd_usb_stream, list);
94                 if (as->fmt_type != fp->fmt_type)
95                         continue;
96                 subs = &as->substream[stream];
97                 if (!subs->endpoint)
98                         continue;
99                 if (subs->endpoint == fp->endpoint) {
100                         list_add_tail(&fp->list, &subs->fmt_list);
101                         subs->num_formats++;
102                         subs->formats |= fp->formats;
103                         return 0;
104                 }
105         }
106         /* look for an empty stream */
107         list_for_each(p, &chip->pcm_list) {
108                 as = list_entry(p, struct snd_usb_stream, list);
109                 if (as->fmt_type != fp->fmt_type)
110                         continue;
111                 subs = &as->substream[stream];
112                 if (subs->endpoint)
113                         continue;
114                 err = snd_pcm_new_stream(as->pcm, stream, 1);
115                 if (err < 0)
116                         return err;
117                 snd_usb_init_substream(as, stream, fp);
118                 return 0;
119         }
120
121         /* create a new pcm */
122         as = kzalloc(sizeof(*as), GFP_KERNEL);
123         if (!as)
124                 return -ENOMEM;
125         as->pcm_index = chip->pcm_devs;
126         as->chip = chip;
127         as->fmt_type = fp->fmt_type;
128         err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
129                           stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
130                           stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
131                           &pcm);
132         if (err < 0) {
133                 kfree(as);
134                 return err;
135         }
136         as->pcm = pcm;
137         pcm->private_data = as;
138         pcm->private_free = snd_usb_audio_pcm_free;
139         pcm->info_flags = 0;
140         if (chip->pcm_devs > 0)
141                 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
142         else
143                 strcpy(pcm->name, "USB Audio");
144
145         snd_usb_init_substream(as, stream, fp);
146
147         list_add(&as->list, &chip->pcm_list);
148         chip->pcm_devs++;
149
150         snd_usb_proc_pcm_format_add(as);
151
152         return 0;
153 }
154
155 static int parse_uac_endpoint_attributes(struct snd_usb_audio *chip,
156                                          struct usb_host_interface *alts,
157                                          int protocol, int iface_no)
158 {
159         /* parsed with a v1 header here. that's ok as we only look at the
160          * header first which is the same for both versions */
161         struct uac_iso_endpoint_descriptor *csep;
162         struct usb_interface_descriptor *altsd = get_iface_desc(alts);
163         int attributes = 0;
164
165         csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
166
167         /* Creamware Noah has this descriptor after the 2nd endpoint */
168         if (!csep && altsd->bNumEndpoints >= 2)
169                 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
170
171         if (!csep || csep->bLength < 7 ||
172             csep->bDescriptorSubtype != UAC_EP_GENERAL) {
173                 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
174                            " class specific endpoint descriptor\n",
175                            chip->dev->devnum, iface_no,
176                            altsd->bAlternateSetting);
177                 return 0;
178         }
179
180         if (protocol == UAC_VERSION_1) {
181                 attributes = csep->bmAttributes;
182         } else {
183                 struct uac2_iso_endpoint_descriptor *csep2 =
184                         (struct uac2_iso_endpoint_descriptor *) csep;
185
186                 attributes = csep->bmAttributes & UAC_EP_CS_ATTR_FILL_MAX;
187
188                 /* emulate the endpoint attributes of a v1 device */
189                 if (csep2->bmControls & UAC2_CONTROL_PITCH)
190                         attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
191         }
192
193         return attributes;
194 }
195
196 static struct uac2_input_terminal_descriptor *
197         snd_usb_find_input_terminal_descriptor(struct usb_host_interface *ctrl_iface,
198                                                int terminal_id)
199 {
200         struct uac2_input_terminal_descriptor *term = NULL;
201
202         while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
203                                                ctrl_iface->extralen,
204                                                term, UAC_INPUT_TERMINAL))) {
205                 if (term->bTerminalID == terminal_id)
206                         return term;
207         }
208
209         return NULL;
210 }
211
212 static struct uac2_output_terminal_descriptor *
213         snd_usb_find_output_terminal_descriptor(struct usb_host_interface *ctrl_iface,
214                                                 int terminal_id)
215 {
216         struct uac2_output_terminal_descriptor *term = NULL;
217
218         while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
219                                                ctrl_iface->extralen,
220                                                term, UAC_OUTPUT_TERMINAL))) {
221                 if (term->bTerminalID == terminal_id)
222                         return term;
223         }
224
225         return NULL;
226 }
227
228 int snd_usb_parse_audio_interface(struct snd_usb_audio *chip, int iface_no)
229 {
230         struct usb_device *dev;
231         struct usb_interface *iface;
232         struct usb_host_interface *alts;
233         struct usb_interface_descriptor *altsd;
234         int i, altno, err, stream;
235         int format = 0, num_channels = 0;
236         struct audioformat *fp = NULL;
237         int num, protocol, clock = 0;
238         struct uac_format_type_i_continuous_descriptor *fmt;
239
240         dev = chip->dev;
241
242         /* parse the interface's altsettings */
243         iface = usb_ifnum_to_if(dev, iface_no);
244
245         num = iface->num_altsetting;
246
247         /*
248          * Dallas DS4201 workaround: It presents 5 altsettings, but the last
249          * one misses syncpipe, and does not produce any sound.
250          */
251         if (chip->usb_id == USB_ID(0x04fa, 0x4201))
252                 num = 4;
253
254         for (i = 0; i < num; i++) {
255                 alts = &iface->altsetting[i];
256                 altsd = get_iface_desc(alts);
257                 protocol = altsd->bInterfaceProtocol;
258                 /* skip invalid one */
259                 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
260                      altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
261                     (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING &&
262                      altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
263                     altsd->bNumEndpoints < 1 ||
264                     le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
265                         continue;
266                 /* must be isochronous */
267                 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
268                     USB_ENDPOINT_XFER_ISOC)
269                         continue;
270                 /* check direction */
271                 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
272                         SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
273                 altno = altsd->bAlternateSetting;
274
275                 if (snd_usb_apply_interface_quirk(chip, iface_no, altno))
276                         continue;
277
278                 /* get audio formats */
279                 switch (protocol) {
280                 default:
281                         snd_printdd(KERN_WARNING "%d:%u:%d: unknown interface protocol %#02x, assuming v1\n",
282                                     dev->devnum, iface_no, altno, protocol);
283                         protocol = UAC_VERSION_1;
284                         /* fall through */
285
286                 case UAC_VERSION_1: {
287                         struct uac1_as_header_descriptor *as =
288                                 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
289
290                         if (!as) {
291                                 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
292                                            dev->devnum, iface_no, altno);
293                                 continue;
294                         }
295
296                         if (as->bLength < sizeof(*as)) {
297                                 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
298                                            dev->devnum, iface_no, altno);
299                                 continue;
300                         }
301
302                         format = le16_to_cpu(as->wFormatTag); /* remember the format value */
303                         break;
304                 }
305
306                 case UAC_VERSION_2: {
307                         struct uac2_input_terminal_descriptor *input_term;
308                         struct uac2_output_terminal_descriptor *output_term;
309                         struct uac2_as_header_descriptor *as =
310                                 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
311
312                         if (!as) {
313                                 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
314                                            dev->devnum, iface_no, altno);
315                                 continue;
316                         }
317
318                         if (as->bLength < sizeof(*as)) {
319                                 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
320                                            dev->devnum, iface_no, altno);
321                                 continue;
322                         }
323
324                         num_channels = as->bNrChannels;
325                         format = le32_to_cpu(as->bmFormats);
326
327                         /* lookup the terminal associated to this interface
328                          * to extract the clock */
329                         input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
330                                                                             as->bTerminalLink);
331                         if (input_term) {
332                                 clock = input_term->bCSourceID;
333                                 break;
334                         }
335
336                         output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf,
337                                                                               as->bTerminalLink);
338                         if (output_term) {
339                                 clock = output_term->bCSourceID;
340                                 break;
341                         }
342
343                         snd_printk(KERN_ERR "%d:%u:%d : bogus bTerminalLink %d\n",
344                                    dev->devnum, iface_no, altno, as->bTerminalLink);
345                         continue;
346                 }
347                 }
348
349                 /* get format type */
350                 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_FORMAT_TYPE);
351                 if (!fmt) {
352                         snd_printk(KERN_ERR "%d:%u:%d : no UAC_FORMAT_TYPE desc\n",
353                                    dev->devnum, iface_no, altno);
354                         continue;
355                 }
356                 if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8)) ||
357                     ((protocol == UAC_VERSION_2) && (fmt->bLength < 6))) {
358                         snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
359                                    dev->devnum, iface_no, altno);
360                         continue;
361                 }
362
363                 /*
364                  * Blue Microphones workaround: The last altsetting is identical
365                  * with the previous one, except for a larger packet size, but
366                  * is actually a mislabeled two-channel setting; ignore it.
367                  */
368                 if (fmt->bNrChannels == 1 &&
369                     fmt->bSubframeSize == 2 &&
370                     altno == 2 && num == 3 &&
371                     fp && fp->altsetting == 1 && fp->channels == 1 &&
372                     fp->formats == SNDRV_PCM_FMTBIT_S16_LE &&
373                     protocol == UAC_VERSION_1 &&
374                     le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
375                                                         fp->maxpacksize * 2)
376                         continue;
377
378                 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
379                 if (! fp) {
380                         snd_printk(KERN_ERR "cannot malloc\n");
381                         return -ENOMEM;
382                 }
383
384                 fp->iface = iface_no;
385                 fp->altsetting = altno;
386                 fp->altset_idx = i;
387                 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
388                 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
389                 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
390                 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
391                 /* num_channels is only set for v2 interfaces */
392                 fp->channels = num_channels;
393                 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
394                         fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
395                                         * (fp->maxpacksize & 0x7ff);
396                 fp->attributes = parse_uac_endpoint_attributes(chip, alts, protocol, iface_no);
397                 fp->clock = clock;
398
399                 /* some quirks for attributes here */
400
401                 switch (chip->usb_id) {
402                 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
403                         /* Optoplay sets the sample rate attribute although
404                          * it seems not supporting it in fact.
405                          */
406                         fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
407                         break;
408                 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
409                 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
410                         /* doesn't set the sample rate attribute, but supports it */
411                         fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
412                         break;
413                 case USB_ID(0x0763, 0x2001):  /* M-Audio Quattro USB */
414                 case USB_ID(0x0763, 0x2012):  /* M-Audio Fast Track Pro USB */
415                 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
416                 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
417                                                 an older model 77d:223) */
418                 /*
419                  * plantronics headset and Griffin iMic have set adaptive-in
420                  * although it's really not...
421                  */
422                         fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
423                         if (stream == SNDRV_PCM_STREAM_PLAYBACK)
424                                 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
425                         else
426                                 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
427                         break;
428                 }
429
430                 /* ok, let's parse further... */
431                 if (snd_usb_parse_audio_format(chip, fp, format, fmt, stream, alts) < 0) {
432                         kfree(fp->rate_table);
433                         kfree(fp);
434                         fp = NULL;
435                         continue;
436                 }
437
438                 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint %#x\n", dev->devnum, iface_no, altno, fp->endpoint);
439                 err = snd_usb_add_audio_stream(chip, stream, fp);
440                 if (err < 0) {
441                         kfree(fp->rate_table);
442                         kfree(fp);
443                         return err;
444                 }
445                 /* try to set the interface... */
446                 usb_set_interface(chip->dev, iface_no, altno);
447                 snd_usb_init_pitch(chip, iface_no, alts, fp);
448                 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max);
449         }
450         return 0;
451 }
452