28ee1ce3971a7fd063fdfc0f80a8f73696bb9b4b
[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 static int parse_uac_endpoint_attributes(struct snd_usb_audio *chip,
153                                          struct usb_host_interface *alts,
154                                          int protocol, int iface_no)
155 {
156         /* parsed with a v1 header here. that's ok as we only look at the
157          * header first which is the same for both versions */
158         struct uac_iso_endpoint_descriptor *csep;
159         struct usb_interface_descriptor *altsd = get_iface_desc(alts);
160         int attributes = 0;
161
162         csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
163
164         /* Creamware Noah has this descriptor after the 2nd endpoint */
165         if (!csep && altsd->bNumEndpoints >= 2)
166                 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
167
168         if (!csep || csep->bLength < 7 ||
169             csep->bDescriptorSubtype != UAC_EP_GENERAL) {
170                 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
171                            " class specific endpoint descriptor\n",
172                            chip->dev->devnum, iface_no,
173                            altsd->bAlternateSetting);
174                 return 0;
175         }
176
177         if (protocol == UAC_VERSION_1) {
178                 attributes = csep->bmAttributes;
179         } else {
180                 struct uac2_iso_endpoint_descriptor *csep2 =
181                         (struct uac2_iso_endpoint_descriptor *) csep;
182
183                 attributes = csep->bmAttributes & UAC_EP_CS_ATTR_FILL_MAX;
184
185                 /* emulate the endpoint attributes of a v1 device */
186                 if (csep2->bmControls & UAC2_CONTROL_PITCH)
187                         attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
188         }
189
190         return attributes;
191 }
192
193 int snd_usb_parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no)
194 {
195         struct usb_device *dev;
196         struct usb_interface *iface;
197         struct usb_host_interface *alts;
198         struct usb_interface_descriptor *altsd;
199         int i, altno, err, stream;
200         int format = 0, num_channels = 0;
201         struct audioformat *fp = NULL;
202         int num, protocol;
203         struct uac_format_type_i_continuous_descriptor *fmt;
204
205         dev = chip->dev;
206
207         /* parse the interface's altsettings */
208         iface = usb_ifnum_to_if(dev, iface_no);
209
210         num = iface->num_altsetting;
211
212         /*
213          * Dallas DS4201 workaround: It presents 5 altsettings, but the last
214          * one misses syncpipe, and does not produce any sound.
215          */
216         if (chip->usb_id == USB_ID(0x04fa, 0x4201))
217                 num = 4;
218
219         for (i = 0; i < num; i++) {
220                 alts = &iface->altsetting[i];
221                 altsd = get_iface_desc(alts);
222                 protocol = altsd->bInterfaceProtocol;
223                 /* skip invalid one */
224                 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
225                      altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
226                     (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING &&
227                      altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
228                     altsd->bNumEndpoints < 1 ||
229                     le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
230                         continue;
231                 /* must be isochronous */
232                 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
233                     USB_ENDPOINT_XFER_ISOC)
234                         continue;
235                 /* check direction */
236                 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
237                         SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
238                 altno = altsd->bAlternateSetting;
239
240                 if (snd_usb_apply_interface_quirk(chip, iface_no, altno))
241                         continue;
242
243                 /* get audio formats */
244                 switch (protocol) {
245                 case UAC_VERSION_1: {
246                         struct uac_as_header_descriptor_v1 *as =
247                                 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
248
249                         if (!as) {
250                                 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
251                                            dev->devnum, iface_no, altno);
252                                 continue;
253                         }
254
255                         if (as->bLength < sizeof(*as)) {
256                                 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
257                                            dev->devnum, iface_no, altno);
258                                 continue;
259                         }
260
261                         format = le16_to_cpu(as->wFormatTag); /* remember the format value */
262                         break;
263                 }
264
265                 case UAC_VERSION_2: {
266                         struct uac_as_header_descriptor_v2 *as =
267                                 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
268
269                         if (!as) {
270                                 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
271                                            dev->devnum, iface_no, altno);
272                                 continue;
273                         }
274
275                         if (as->bLength < sizeof(*as)) {
276                                 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
277                                            dev->devnum, iface_no, altno);
278                                 continue;
279                         }
280
281                         num_channels = as->bNrChannels;
282                         format = le32_to_cpu(as->bmFormats);
283
284                         break;
285                 }
286
287                 default:
288                         snd_printk(KERN_ERR "%d:%u:%d : unknown interface protocol %04x\n",
289                                    dev->devnum, iface_no, altno, protocol);
290                         continue;
291                 }
292
293                 /* get format type */
294                 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_FORMAT_TYPE);
295                 if (!fmt) {
296                         snd_printk(KERN_ERR "%d:%u:%d : no UAC_FORMAT_TYPE desc\n",
297                                    dev->devnum, iface_no, altno);
298                         continue;
299                 }
300                 if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8)) ||
301                     ((protocol == UAC_VERSION_2) && (fmt->bLength != 6))) {
302                         snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
303                                    dev->devnum, iface_no, altno);
304                         continue;
305                 }
306
307                 /*
308                  * Blue Microphones workaround: The last altsetting is identical
309                  * with the previous one, except for a larger packet size, but
310                  * is actually a mislabeled two-channel setting; ignore it.
311                  */
312                 if (fmt->bNrChannels == 1 &&
313                     fmt->bSubframeSize == 2 &&
314                     altno == 2 && num == 3 &&
315                     fp && fp->altsetting == 1 && fp->channels == 1 &&
316                     fp->formats == SNDRV_PCM_FMTBIT_S16_LE &&
317                     protocol == UAC_VERSION_1 &&
318                     le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
319                                                         fp->maxpacksize * 2)
320                         continue;
321
322                 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
323                 if (! fp) {
324                         snd_printk(KERN_ERR "cannot malloc\n");
325                         return -ENOMEM;
326                 }
327
328                 fp->iface = iface_no;
329                 fp->altsetting = altno;
330                 fp->altset_idx = i;
331                 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
332                 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
333                 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
334                 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
335                 /* num_channels is only set for v2 interfaces */
336                 fp->channels = num_channels;
337                 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
338                         fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
339                                         * (fp->maxpacksize & 0x7ff);
340                 fp->attributes = parse_uac_endpoint_attributes(chip, alts, protocol, iface_no);
341
342                 /* some quirks for attributes here */
343
344                 switch (chip->usb_id) {
345                 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
346                         /* Optoplay sets the sample rate attribute although
347                          * it seems not supporting it in fact.
348                          */
349                         fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
350                         break;
351                 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
352                 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
353                 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra 8 */
354                 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
355                         /* doesn't set the sample rate attribute, but supports it */
356                         fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
357                         break;
358                 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
359                 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
360                                                 an older model 77d:223) */
361                 /*
362                  * plantronics headset and Griffin iMic have set adaptive-in
363                  * although it's really not...
364                  */
365                         fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
366                         if (stream == SNDRV_PCM_STREAM_PLAYBACK)
367                                 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
368                         else
369                                 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
370                         break;
371                 }
372
373                 /* ok, let's parse further... */
374                 if (snd_usb_parse_audio_format(chip, fp, format, fmt, stream, alts) < 0) {
375                         kfree(fp->rate_table);
376                         kfree(fp);
377                         continue;
378                 }
379
380                 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint %#x\n", dev->devnum, iface_no, altno, fp->endpoint);
381                 err = snd_usb_add_audio_endpoint(chip, stream, fp);
382                 if (err < 0) {
383                         kfree(fp->rate_table);
384                         kfree(fp);
385                         return err;
386                 }
387                 /* try to set the interface... */
388                 usb_set_interface(chip->dev, iface_no, altno);
389                 snd_usb_init_pitch(chip, iface_no, alts, fp);
390                 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max);
391         }
392         return 0;
393 }
394