ALSA: usb-audio: add check for faulty clock in parse_audio_format_rates_v2()
[linux-2.6.git] / sound / usb / format.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 "quirks.h"
30 #include "helper.h"
31 #include "debug.h"
32 #include "clock.h"
33
34 /*
35  * parse the audio format type I descriptor
36  * and returns the corresponding pcm format
37  *
38  * @dev: usb device
39  * @fp: audioformat record
40  * @format: the format tag (wFormatTag)
41  * @fmt: the format type descriptor
42  */
43 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
44                                      struct audioformat *fp,
45                                      int format, void *_fmt,
46                                      int protocol)
47 {
48         int sample_width, sample_bytes;
49         u64 pcm_formats;
50
51         switch (protocol) {
52         case UAC_VERSION_1: {
53                 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
54                 sample_width = fmt->bBitResolution;
55                 sample_bytes = fmt->bSubframeSize;
56                 format = 1 << format;
57                 break;
58         }
59
60         case UAC_VERSION_2: {
61                 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
62                 sample_width = fmt->bBitResolution;
63                 sample_bytes = fmt->bSubslotSize;
64                 format <<= 1;
65                 break;
66         }
67
68         default:
69                 return -EINVAL;
70         }
71
72         pcm_formats = 0;
73
74         if (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED)) {
75                 /* some devices don't define this correctly... */
76                 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
77                             chip->dev->devnum, fp->iface, fp->altsetting);
78                 format = 1 << UAC_FORMAT_TYPE_I_PCM;
79         }
80         if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
81                 if (sample_width > sample_bytes * 8) {
82                         snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
83                                    chip->dev->devnum, fp->iface, fp->altsetting,
84                                    sample_width, sample_bytes);
85                 }
86                 /* check the format byte size */
87                 switch (sample_bytes) {
88                 case 1:
89                         pcm_formats |= SNDRV_PCM_FMTBIT_S8;
90                         break;
91                 case 2:
92                         if (snd_usb_is_big_endian_format(chip, fp))
93                                 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
94                         else
95                                 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
96                         break;
97                 case 3:
98                         if (snd_usb_is_big_endian_format(chip, fp))
99                                 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
100                         else
101                                 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
102                         break;
103                 case 4:
104                         pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
105                         break;
106                 default:
107                         snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
108                                    chip->dev->devnum, fp->iface, fp->altsetting,
109                                    sample_width, sample_bytes);
110                         break;
111                 }
112         }
113         if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
114                 /* Dallas DS4201 workaround: it advertises U8 format, but really
115                    supports S8. */
116                 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
117                         pcm_formats |= SNDRV_PCM_FMTBIT_S8;
118                 else
119                         pcm_formats |= SNDRV_PCM_FMTBIT_U8;
120         }
121         if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
122                 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
123         }
124         if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
125                 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
126         }
127         if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
128                 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
129         }
130         if (format & ~0x3f) {
131                 snd_printk(KERN_INFO "%d:%u:%d : unsupported format bits %#x\n",
132                            chip->dev->devnum, fp->iface, fp->altsetting, format);
133         }
134         return pcm_formats;
135 }
136
137
138 /*
139  * parse the format descriptor and stores the possible sample rates
140  * on the audioformat table (audio class v1).
141  *
142  * @dev: usb device
143  * @fp: audioformat record
144  * @fmt: the format descriptor
145  * @offset: the start offset of descriptor pointing the rate type
146  *          (7 for type I and II, 8 for type II)
147  */
148 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
149                                        unsigned char *fmt, int offset)
150 {
151         int nr_rates = fmt[offset];
152
153         if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
154                 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
155                                    chip->dev->devnum, fp->iface, fp->altsetting);
156                 return -1;
157         }
158
159         if (nr_rates) {
160                 /*
161                  * build the rate table and bitmap flags
162                  */
163                 int r, idx;
164
165                 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
166                 if (fp->rate_table == NULL) {
167                         snd_printk(KERN_ERR "cannot malloc\n");
168                         return -1;
169                 }
170
171                 fp->nr_rates = 0;
172                 fp->rate_min = fp->rate_max = 0;
173                 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
174                         unsigned int rate = combine_triple(&fmt[idx]);
175                         if (!rate)
176                                 continue;
177                         /* C-Media CM6501 mislabels its 96 kHz altsetting */
178                         if (rate == 48000 && nr_rates == 1 &&
179                             (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
180                              chip->usb_id == USB_ID(0x0d8c, 0x0102)) &&
181                             fp->altsetting == 5 && fp->maxpacksize == 392)
182                                 rate = 96000;
183                         /* Creative VF0470 Live Cam reports 16 kHz instead of 8kHz */
184                         if (rate == 16000 && chip->usb_id == USB_ID(0x041e, 0x4068))
185                                 rate = 8000;
186
187                         fp->rate_table[fp->nr_rates] = rate;
188                         if (!fp->rate_min || rate < fp->rate_min)
189                                 fp->rate_min = rate;
190                         if (!fp->rate_max || rate > fp->rate_max)
191                                 fp->rate_max = rate;
192                         fp->rates |= snd_pcm_rate_to_rate_bit(rate);
193                         fp->nr_rates++;
194                 }
195                 if (!fp->nr_rates) {
196                         hwc_debug("All rates were zero. Skipping format!\n");
197                         return -1;
198                 }
199         } else {
200                 /* continuous rates */
201                 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
202                 fp->rate_min = combine_triple(&fmt[offset + 1]);
203                 fp->rate_max = combine_triple(&fmt[offset + 4]);
204         }
205         return 0;
206 }
207
208 /*
209  * parse the format descriptor and stores the possible sample rates
210  * on the audioformat table (audio class v2).
211  */
212 static int parse_audio_format_rates_v2(struct snd_usb_audio *chip,
213                                        struct audioformat *fp,
214                                        struct usb_host_interface *iface)
215 {
216         struct usb_device *dev = chip->dev;
217         unsigned char tmp[2], *data;
218         int i, nr_rates, data_size, ret = 0;
219         int clock = snd_usb_clock_find_source(chip, chip->ctrl_intf, fp->clock);
220
221         if (clock < 0) {
222                 snd_printk(KERN_ERR "%s(): unable to find clock source (clock %d)\n",
223                                 __func__, clock);
224                 goto err;
225         }
226
227         /* get the number of sample rates first by only fetching 2 bytes */
228         ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
229                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
230                               UAC2_CS_CONTROL_SAM_FREQ << 8, clock << 8,
231                               tmp, sizeof(tmp), 1000);
232
233         if (ret < 0) {
234                 snd_printk(KERN_ERR "%s(): unable to retrieve number of sample rates (clock %d)\n",
235                                 __func__, clock);
236                 goto err;
237         }
238
239         nr_rates = (tmp[1] << 8) | tmp[0];
240         data_size = 2 + 12 * nr_rates;
241         data = kzalloc(data_size, GFP_KERNEL);
242         if (!data) {
243                 ret = -ENOMEM;
244                 goto err;
245         }
246
247         /* now get the full information */
248         ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
249                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
250                               UAC2_CS_CONTROL_SAM_FREQ << 8, clock << 8,
251                               data, data_size, 1000);
252
253         if (ret < 0) {
254                 snd_printk(KERN_ERR "%s(): unable to retrieve sample rate range (clock %d)\n",
255                                 __func__, clock);
256                 ret = -EINVAL;
257                 goto err_free;
258         }
259
260         fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
261         if (!fp->rate_table) {
262                 ret = -ENOMEM;
263                 goto err_free;
264         }
265
266         fp->nr_rates = 0;
267         fp->rate_min = fp->rate_max = 0;
268
269         for (i = 0; i < nr_rates; i++) {
270                 int rate = combine_quad(&data[2 + 12 * i]);
271
272                 fp->rate_table[fp->nr_rates] = rate;
273                 if (!fp->rate_min || rate < fp->rate_min)
274                         fp->rate_min = rate;
275                 if (!fp->rate_max || rate > fp->rate_max)
276                         fp->rate_max = rate;
277                 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
278                 fp->nr_rates++;
279         }
280
281 err_free:
282         kfree(data);
283 err:
284         return ret;
285 }
286
287 /*
288  * parse the format type I and III descriptors
289  */
290 static int parse_audio_format_i(struct snd_usb_audio *chip,
291                                 struct audioformat *fp, int format,
292                                 struct uac_format_type_i_continuous_descriptor *fmt,
293                                 struct usb_host_interface *iface)
294 {
295         struct usb_interface_descriptor *altsd = get_iface_desc(iface);
296         int protocol = altsd->bInterfaceProtocol;
297         int pcm_format, ret;
298
299         if (fmt->bFormatType == UAC_FORMAT_TYPE_III) {
300                 /* FIXME: the format type is really IECxxx
301                  *        but we give normal PCM format to get the existing
302                  *        apps working...
303                  */
304                 switch (chip->usb_id) {
305
306                 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
307                         if (chip->setup == 0x00 && 
308                             fp->altsetting == 6)
309                                 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
310                         else
311                                 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
312                         break;
313                 default:
314                         pcm_format = SNDRV_PCM_FORMAT_S16_LE;
315                 }
316                 fp->formats = 1uLL << pcm_format;
317         } else {
318                 fp->formats = parse_audio_format_i_type(chip, fp, format,
319                                                         fmt, protocol);
320                 if (!fp->formats)
321                         return -1;
322         }
323
324         /* gather possible sample rates */
325         /* audio class v1 reports possible sample rates as part of the
326          * proprietary class specific descriptor.
327          * audio class v2 uses class specific EP0 range requests for that.
328          */
329         switch (protocol) {
330         case UAC_VERSION_1:
331                 fp->channels = fmt->bNrChannels;
332                 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
333                 break;
334         case UAC_VERSION_2:
335                 /* fp->channels is already set in this case */
336                 ret = parse_audio_format_rates_v2(chip, fp, iface);
337                 break;
338         }
339
340         if (fp->channels < 1) {
341                 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
342                            chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
343                 return -1;
344         }
345
346         return ret;
347 }
348
349 /*
350  * parse the format type II descriptor
351  */
352 static int parse_audio_format_ii(struct snd_usb_audio *chip,
353                                  struct audioformat *fp,
354                                  int format, void *_fmt,
355                                  struct usb_host_interface *iface)
356 {
357         int brate, framesize, ret;
358         struct usb_interface_descriptor *altsd = get_iface_desc(iface);
359         int protocol = altsd->bInterfaceProtocol;
360
361         switch (format) {
362         case UAC_FORMAT_TYPE_II_AC3:
363                 /* FIXME: there is no AC3 format defined yet */
364                 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
365                 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
366                 break;
367         case UAC_FORMAT_TYPE_II_MPEG:
368                 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
369                 break;
370         default:
371                 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag %#x is detected.  processed as MPEG.\n",
372                            chip->dev->devnum, fp->iface, fp->altsetting, format);
373                 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
374                 break;
375         }
376
377         fp->channels = 1;
378
379         switch (protocol) {
380         case UAC_VERSION_1: {
381                 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
382                 brate = le16_to_cpu(fmt->wMaxBitRate);
383                 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
384                 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
385                 fp->frame_size = framesize;
386                 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
387                 break;
388         }
389         case UAC_VERSION_2: {
390                 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
391                 brate = le16_to_cpu(fmt->wMaxBitRate);
392                 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
393                 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
394                 fp->frame_size = framesize;
395                 ret = parse_audio_format_rates_v2(chip, fp, iface);
396                 break;
397         }
398         }
399
400         return ret;
401 }
402
403 int snd_usb_parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
404                                int format, struct uac_format_type_i_continuous_descriptor *fmt,
405                                int stream, struct usb_host_interface *iface)
406 {
407         int err;
408
409         switch (fmt->bFormatType) {
410         case UAC_FORMAT_TYPE_I:
411         case UAC_FORMAT_TYPE_III:
412                 err = parse_audio_format_i(chip, fp, format, fmt, iface);
413                 break;
414         case UAC_FORMAT_TYPE_II:
415                 err = parse_audio_format_ii(chip, fp, format, fmt, iface);
416                 break;
417         default:
418                 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
419                            chip->dev->devnum, fp->iface, fp->altsetting,
420                            fmt->bFormatType);
421                 return -ENOTSUPP;
422         }
423         fp->fmt_type = fmt->bFormatType;
424         if (err < 0)
425                 return err;
426 #if 1
427         /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
428         /* extigy apparently supports sample rates other than 48k
429          * but not in ordinary way.  so we enable only 48k atm.
430          */
431         if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
432             chip->usb_id == USB_ID(0x041e, 0x3020) ||
433             chip->usb_id == USB_ID(0x041e, 0x3061)) {
434                 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
435                     fp->rates != SNDRV_PCM_RATE_48000 &&
436                     fp->rates != SNDRV_PCM_RATE_96000)
437                         return -ENOTSUPP;
438         }
439 #endif
440         return 0;
441 }
442