ALSA: usb-audio: parse more format descriptors with structs
[safe/jmp/linux-2.6] / sound / usb / endpoint.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 "urb.h"
33 #include "pcm.h"
34 #include "helper.h"
35 #include "format.h"
36
37 /*
38  * free a substream
39  */
40 static void free_substream(struct snd_usb_substream *subs)
41 {
42         struct list_head *p, *n;
43
44         if (!subs->num_formats)
45                 return; /* not initialized */
46         list_for_each_safe(p, n, &subs->fmt_list) {
47                 struct audioformat *fp = list_entry(p, struct audioformat, list);
48                 kfree(fp->rate_table);
49                 kfree(fp);
50         }
51         kfree(subs->rate_list.list);
52 }
53
54
55 /*
56  * free a usb stream instance
57  */
58 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
59 {
60         free_substream(&stream->substream[0]);
61         free_substream(&stream->substream[1]);
62         list_del(&stream->list);
63         kfree(stream);
64 }
65
66 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
67 {
68         struct snd_usb_stream *stream = pcm->private_data;
69         if (stream) {
70                 stream->pcm = NULL;
71                 snd_usb_audio_stream_free(stream);
72         }
73 }
74
75
76 /*
77  * add this endpoint to the chip instance.
78  * if a stream with the same endpoint already exists, append to it.
79  * if not, create a new pcm stream.
80  */
81 int snd_usb_add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp)
82 {
83         struct list_head *p;
84         struct snd_usb_stream *as;
85         struct snd_usb_substream *subs;
86         struct snd_pcm *pcm;
87         int err;
88
89         list_for_each(p, &chip->pcm_list) {
90                 as = list_entry(p, struct snd_usb_stream, list);
91                 if (as->fmt_type != fp->fmt_type)
92                         continue;
93                 subs = &as->substream[stream];
94                 if (!subs->endpoint)
95                         continue;
96                 if (subs->endpoint == fp->endpoint) {
97                         list_add_tail(&fp->list, &subs->fmt_list);
98                         subs->num_formats++;
99                         subs->formats |= fp->formats;
100                         return 0;
101                 }
102         }
103         /* look for an empty stream */
104         list_for_each(p, &chip->pcm_list) {
105                 as = list_entry(p, struct snd_usb_stream, list);
106                 if (as->fmt_type != fp->fmt_type)
107                         continue;
108                 subs = &as->substream[stream];
109                 if (subs->endpoint)
110                         continue;
111                 err = snd_pcm_new_stream(as->pcm, stream, 1);
112                 if (err < 0)
113                         return err;
114                 snd_usb_init_substream(as, stream, fp);
115                 return 0;
116         }
117
118         /* create a new pcm */
119         as = kzalloc(sizeof(*as), GFP_KERNEL);
120         if (!as)
121                 return -ENOMEM;
122         as->pcm_index = chip->pcm_devs;
123         as->chip = chip;
124         as->fmt_type = fp->fmt_type;
125         err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
126                           stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
127                           stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
128                           &pcm);
129         if (err < 0) {
130                 kfree(as);
131                 return err;
132         }
133         as->pcm = pcm;
134         pcm->private_data = as;
135         pcm->private_free = snd_usb_audio_pcm_free;
136         pcm->info_flags = 0;
137         if (chip->pcm_devs > 0)
138                 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
139         else
140                 strcpy(pcm->name, "USB Audio");
141
142         snd_usb_init_substream(as, stream, fp);
143
144         list_add(&as->list, &chip->pcm_list);
145         chip->pcm_devs++;
146
147         snd_usb_proc_pcm_format_add(as);
148
149         return 0;
150 }
151
152 int snd_usb_parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
153 {
154         struct usb_device *dev;
155         struct usb_interface *iface;
156         struct usb_host_interface *alts;
157         struct usb_interface_descriptor *altsd;
158         int i, altno, err, stream;
159         int format = 0, num_channels = 0;
160         struct audioformat *fp = NULL;
161         unsigned char *csep;
162         int num, protocol;
163         struct uac_format_type_i_continuous_descriptor *fmt;
164
165         dev = chip->dev;
166
167         /* parse the interface's altsettings */
168         iface = usb_ifnum_to_if(dev, iface_no);
169
170         num = iface->num_altsetting;
171
172         /*
173          * Dallas DS4201 workaround: It presents 5 altsettings, but the last
174          * one misses syncpipe, and does not produce any sound.
175          */
176         if (chip->usb_id == USB_ID(0x04fa, 0x4201))
177                 num = 4;
178
179         for (i = 0; i < num; i++) {
180                 alts = &iface->altsetting[i];
181                 altsd = get_iface_desc(alts);
182                 protocol = altsd->bInterfaceProtocol;
183                 /* skip invalid one */
184                 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
185                      altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
186                     (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING &&
187                      altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
188                     altsd->bNumEndpoints < 1 ||
189                     le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
190                         continue;
191                 /* must be isochronous */
192                 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
193                     USB_ENDPOINT_XFER_ISOC)
194                         continue;
195                 /* check direction */
196                 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
197                         SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
198                 altno = altsd->bAlternateSetting;
199
200                 if (snd_usb_apply_interface_quirk(chip, iface_no, altno))
201                         continue;
202
203                 /* get audio formats */
204                 switch (protocol) {
205                 case UAC_VERSION_1: {
206                         struct uac_as_header_descriptor_v1 *as =
207                                 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
208
209                         if (!as) {
210                                 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
211                                            dev->devnum, iface_no, altno);
212                                 continue;
213                         }
214
215                         if (as->bLength < sizeof(*as)) {
216                                 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
217                                            dev->devnum, iface_no, altno);
218                                 continue;
219                         }
220
221                         format = le16_to_cpu(as->wFormatTag); /* remember the format value */
222                         break;
223                 }
224
225                 case UAC_VERSION_2: {
226                         struct uac_as_header_descriptor_v2 *as =
227                                 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
228
229                         if (!as) {
230                                 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
231                                            dev->devnum, iface_no, altno);
232                                 continue;
233                         }
234
235                         if (as->bLength < sizeof(*as)) {
236                                 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
237                                            dev->devnum, iface_no, altno);
238                                 continue;
239                         }
240
241                         num_channels = as->bNrChannels;
242                         format = le32_to_cpu(as->bmFormats);
243
244                         break;
245                 }
246
247                 default:
248                         snd_printk(KERN_ERR "%d:%u:%d : unknown interface protocol %04x\n",
249                                    dev->devnum, iface_no, altno, protocol);
250                         continue;
251                 }
252
253                 /* get format type */
254                 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_FORMAT_TYPE);
255                 if (!fmt) {
256                         snd_printk(KERN_ERR "%d:%u:%d : no UAC_FORMAT_TYPE desc\n",
257                                    dev->devnum, iface_no, altno);
258                         continue;
259                 }
260                 if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8)) ||
261                     ((protocol == UAC_VERSION_2) && (fmt->bLength != 6))) {
262                         snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
263                                    dev->devnum, iface_no, altno);
264                         continue;
265                 }
266
267                 /*
268                  * Blue Microphones workaround: The last altsetting is identical
269                  * with the previous one, except for a larger packet size, but
270                  * is actually a mislabeled two-channel setting; ignore it.
271                  */
272                 if (fmt->bNrChannels == 1 &&
273                     fmt->bSubframeSize == 2 &&
274                     altno == 2 && num == 3 &&
275                     fp && fp->altsetting == 1 && fp->channels == 1 &&
276                     fp->formats == SNDRV_PCM_FMTBIT_S16_LE &&
277                     protocol == UAC_VERSION_1 &&
278                     le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
279                                                         fp->maxpacksize * 2)
280                         continue;
281
282                 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
283                 /* Creamware Noah has this descriptor after the 2nd endpoint */
284                 if (!csep && altsd->bNumEndpoints >= 2)
285                         csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
286                 if (!csep || csep[0] < 7 || csep[2] != UAC_EP_GENERAL) {
287                         snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
288                                    " class specific endpoint descriptor\n",
289                                    dev->devnum, iface_no, altno);
290                         csep = NULL;
291                 }
292
293                 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
294                 if (! fp) {
295                         snd_printk(KERN_ERR "cannot malloc\n");
296                         return -ENOMEM;
297                 }
298
299                 fp->iface = iface_no;
300                 fp->altsetting = altno;
301                 fp->altset_idx = i;
302                 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
303                 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
304                 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
305                 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
306                 /* num_channels is only set for v2 interfaces */
307                 fp->channels = num_channels;
308                 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
309                         fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
310                                         * (fp->maxpacksize & 0x7ff);
311                 fp->attributes = csep ? csep[3] : 0;
312
313                 /* some quirks for attributes here */
314
315                 switch (chip->usb_id) {
316                 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
317                         /* Optoplay sets the sample rate attribute although
318                          * it seems not supporting it in fact.
319                          */
320                         fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
321                         break;
322                 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
323                 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
324                 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra 8 */
325                 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
326                         /* doesn't set the sample rate attribute, but supports it */
327                         fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
328                         break;
329                 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
330                 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
331                                                 an older model 77d:223) */
332                 /*
333                  * plantronics headset and Griffin iMic have set adaptive-in
334                  * although it's really not...
335                  */
336                         fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
337                         if (stream == SNDRV_PCM_STREAM_PLAYBACK)
338                                 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
339                         else
340                                 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
341                         break;
342                 }
343
344                 /* ok, let's parse further... */
345                 if (snd_usb_parse_audio_format(chip, fp, format, fmt, stream, alts) < 0) {
346                         kfree(fp->rate_table);
347                         kfree(fp);
348                         continue;
349                 }
350
351                 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint %#x\n", dev->devnum, iface_no, altno, fp->endpoint);
352                 err = snd_usb_add_audio_endpoint(chip, stream, fp);
353                 if (err < 0) {
354                         kfree(fp->rate_table);
355                         kfree(fp);
356                         return err;
357                 }
358                 /* try to set the interface... */
359                 usb_set_interface(chip->dev, iface_no, altno);
360                 snd_usb_init_pitch(chip, iface_no, alts, fp);
361                 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max);
362         }
363         return 0;
364 }
365