x86/xen: resume timer irqs early
[linux/fpc-iii.git] / sound / usb / format.c
blob3525231c6b97325dcbb400ae0c7f9e021555ad8b
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.
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.
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
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>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
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 #include "format.h"
36 * parse the audio format type I descriptor
37 * and returns the corresponding pcm format
39 * @dev: usb device
40 * @fp: audioformat record
41 * @format: the format tag (wFormatTag)
42 * @fmt: the format type descriptor
44 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
45 struct audioformat *fp,
46 unsigned int format, void *_fmt)
48 int sample_width, sample_bytes;
49 u64 pcm_formats = 0;
51 switch (fp->protocol) {
52 case UAC_VERSION_1:
53 default: {
54 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
55 sample_width = fmt->bBitResolution;
56 sample_bytes = fmt->bSubframeSize;
57 format = 1 << format;
58 break;
61 case UAC_VERSION_2: {
62 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
63 sample_width = fmt->bBitResolution;
64 sample_bytes = fmt->bSubslotSize;
66 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA)
67 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
69 format <<= 1;
70 break;
74 if ((pcm_formats == 0) &&
75 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
76 /* some devices don't define this correctly... */
77 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
78 chip->dev->devnum, fp->iface, fp->altsetting);
79 format = 1 << UAC_FORMAT_TYPE_I_PCM;
81 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
82 if (chip->usb_id == USB_ID(0x0582, 0x0016) /* Edirol SD-90 */ &&
83 sample_width == 24 && sample_bytes == 2)
84 sample_bytes = 3;
85 else if (sample_width > sample_bytes * 8) {
86 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
87 chip->dev->devnum, fp->iface, fp->altsetting,
88 sample_width, sample_bytes);
90 /* check the format byte size */
91 switch (sample_bytes) {
92 case 1:
93 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
94 break;
95 case 2:
96 if (snd_usb_is_big_endian_format(chip, fp))
97 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
98 else
99 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
100 break;
101 case 3:
102 if (snd_usb_is_big_endian_format(chip, fp))
103 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
104 else
105 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
106 break;
107 case 4:
108 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
109 break;
110 default:
111 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
112 chip->dev->devnum, fp->iface, fp->altsetting,
113 sample_width, sample_bytes);
114 break;
117 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
118 /* Dallas DS4201 workaround: it advertises U8 format, but really
119 supports S8. */
120 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
121 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
122 else
123 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
125 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
126 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
128 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
129 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
131 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
132 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
134 if (format & ~0x3f) {
135 snd_printk(KERN_INFO "%d:%u:%d : unsupported format bits %#x\n",
136 chip->dev->devnum, fp->iface, fp->altsetting, format);
139 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
141 return pcm_formats;
146 * parse the format descriptor and stores the possible sample rates
147 * on the audioformat table (audio class v1).
149 * @dev: usb device
150 * @fp: audioformat record
151 * @fmt: the format descriptor
152 * @offset: the start offset of descriptor pointing the rate type
153 * (7 for type I and II, 8 for type II)
155 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
156 unsigned char *fmt, int offset)
158 int nr_rates = fmt[offset];
160 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
161 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
162 chip->dev->devnum, fp->iface, fp->altsetting);
163 return -EINVAL;
166 if (nr_rates) {
168 * build the rate table and bitmap flags
170 int r, idx;
172 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
173 if (fp->rate_table == NULL) {
174 snd_printk(KERN_ERR "cannot malloc\n");
175 return -ENOMEM;
178 fp->nr_rates = 0;
179 fp->rate_min = fp->rate_max = 0;
180 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
181 unsigned int rate = combine_triple(&fmt[idx]);
182 if (!rate)
183 continue;
184 /* C-Media CM6501 mislabels its 96 kHz altsetting */
185 /* Terratec Aureon 7.1 USB C-Media 6206, too */
186 if (rate == 48000 && nr_rates == 1 &&
187 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
188 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
189 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
190 fp->altsetting == 5 && fp->maxpacksize == 392)
191 rate = 96000;
192 /* Creative VF0470 Live Cam reports 16 kHz instead of 8kHz */
193 if (rate == 16000 && chip->usb_id == USB_ID(0x041e, 0x4068))
194 rate = 8000;
196 fp->rate_table[fp->nr_rates] = rate;
197 if (!fp->rate_min || rate < fp->rate_min)
198 fp->rate_min = rate;
199 if (!fp->rate_max || rate > fp->rate_max)
200 fp->rate_max = rate;
201 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
202 fp->nr_rates++;
204 if (!fp->nr_rates) {
205 hwc_debug("All rates were zero. Skipping format!\n");
206 return -EINVAL;
208 } else {
209 /* continuous rates */
210 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
211 fp->rate_min = combine_triple(&fmt[offset + 1]);
212 fp->rate_max = combine_triple(&fmt[offset + 4]);
214 return 0;
218 * Helper function to walk the array of sample rate triplets reported by
219 * the device. The problem is that we need to parse whole array first to
220 * get to know how many sample rates we have to expect.
221 * Then fp->rate_table can be allocated and filled.
223 static int parse_uac2_sample_rate_range(struct audioformat *fp, int nr_triplets,
224 const unsigned char *data)
226 int i, nr_rates = 0;
228 fp->rates = fp->rate_min = fp->rate_max = 0;
230 for (i = 0; i < nr_triplets; i++) {
231 int min = combine_quad(&data[2 + 12 * i]);
232 int max = combine_quad(&data[6 + 12 * i]);
233 int res = combine_quad(&data[10 + 12 * i]);
234 unsigned int rate;
236 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
237 continue;
240 * for ranges with res == 1, we announce a continuous sample
241 * rate range, and this function should return 0 for no further
242 * parsing.
244 if (res == 1) {
245 fp->rate_min = min;
246 fp->rate_max = max;
247 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
248 return 0;
251 for (rate = min; rate <= max; rate += res) {
252 if (fp->rate_table)
253 fp->rate_table[nr_rates] = rate;
254 if (!fp->rate_min || rate < fp->rate_min)
255 fp->rate_min = rate;
256 if (!fp->rate_max || rate > fp->rate_max)
257 fp->rate_max = rate;
258 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
260 nr_rates++;
261 if (nr_rates >= MAX_NR_RATES) {
262 snd_printk(KERN_ERR "invalid uac2 rates\n");
263 break;
266 /* avoid endless loop */
267 if (res == 0)
268 break;
272 return nr_rates;
276 * parse the format descriptor and stores the possible sample rates
277 * on the audioformat table (audio class v2).
279 static int parse_audio_format_rates_v2(struct snd_usb_audio *chip,
280 struct audioformat *fp)
282 struct usb_device *dev = chip->dev;
283 unsigned char tmp[2], *data;
284 int nr_triplets, data_size, ret = 0;
285 int clock = snd_usb_clock_find_source(chip, fp->clock, false);
287 if (clock < 0) {
288 snd_printk(KERN_ERR "%s(): unable to find clock source (clock %d)\n",
289 __func__, clock);
290 goto err;
293 /* get the number of sample rates first by only fetching 2 bytes */
294 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
295 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
296 UAC2_CS_CONTROL_SAM_FREQ << 8,
297 snd_usb_ctrl_intf(chip) | (clock << 8),
298 tmp, sizeof(tmp));
300 if (ret < 0) {
301 snd_printk(KERN_ERR "%s(): unable to retrieve number of sample rates (clock %d)\n",
302 __func__, clock);
303 goto err;
306 nr_triplets = (tmp[1] << 8) | tmp[0];
307 data_size = 2 + 12 * nr_triplets;
308 data = kzalloc(data_size, GFP_KERNEL);
309 if (!data) {
310 ret = -ENOMEM;
311 goto err;
314 /* now get the full information */
315 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
316 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
317 UAC2_CS_CONTROL_SAM_FREQ << 8,
318 snd_usb_ctrl_intf(chip) | (clock << 8),
319 data, data_size);
321 if (ret < 0) {
322 snd_printk(KERN_ERR "%s(): unable to retrieve sample rate range (clock %d)\n",
323 __func__, clock);
324 ret = -EINVAL;
325 goto err_free;
328 /* Call the triplet parser, and make sure fp->rate_table is NULL.
329 * We just use the return value to know how many sample rates we
330 * will have to deal with. */
331 kfree(fp->rate_table);
332 fp->rate_table = NULL;
333 fp->nr_rates = parse_uac2_sample_rate_range(fp, nr_triplets, data);
335 if (fp->nr_rates == 0) {
336 /* SNDRV_PCM_RATE_CONTINUOUS */
337 ret = 0;
338 goto err_free;
341 fp->rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
342 if (!fp->rate_table) {
343 ret = -ENOMEM;
344 goto err_free;
347 /* Call the triplet parser again, but this time, fp->rate_table is
348 * allocated, so the rates will be stored */
349 parse_uac2_sample_rate_range(fp, nr_triplets, data);
351 err_free:
352 kfree(data);
353 err:
354 return ret;
358 * parse the format type I and III descriptors
360 static int parse_audio_format_i(struct snd_usb_audio *chip,
361 struct audioformat *fp, unsigned int format,
362 struct uac_format_type_i_continuous_descriptor *fmt)
364 snd_pcm_format_t pcm_format;
365 int ret;
367 if (fmt->bFormatType == UAC_FORMAT_TYPE_III) {
368 /* FIXME: the format type is really IECxxx
369 * but we give normal PCM format to get the existing
370 * apps working...
372 switch (chip->usb_id) {
374 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
375 if (chip->setup == 0x00 &&
376 fp->altsetting == 6)
377 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
378 else
379 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
380 break;
381 default:
382 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
384 fp->formats = pcm_format_to_bits(pcm_format);
385 } else {
386 fp->formats = parse_audio_format_i_type(chip, fp, format, fmt);
387 if (!fp->formats)
388 return -EINVAL;
391 /* gather possible sample rates */
392 /* audio class v1 reports possible sample rates as part of the
393 * proprietary class specific descriptor.
394 * audio class v2 uses class specific EP0 range requests for that.
396 switch (fp->protocol) {
397 default:
398 case UAC_VERSION_1:
399 fp->channels = fmt->bNrChannels;
400 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
401 break;
402 case UAC_VERSION_2:
403 /* fp->channels is already set in this case */
404 ret = parse_audio_format_rates_v2(chip, fp);
405 break;
408 if (fp->channels < 1) {
409 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
410 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
411 return -EINVAL;
414 return ret;
418 * parse the format type II descriptor
420 static int parse_audio_format_ii(struct snd_usb_audio *chip,
421 struct audioformat *fp,
422 int format, void *_fmt)
424 int brate, framesize, ret;
426 switch (format) {
427 case UAC_FORMAT_TYPE_II_AC3:
428 /* FIXME: there is no AC3 format defined yet */
429 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
430 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
431 break;
432 case UAC_FORMAT_TYPE_II_MPEG:
433 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
434 break;
435 default:
436 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
437 chip->dev->devnum, fp->iface, fp->altsetting, format);
438 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
439 break;
442 fp->channels = 1;
444 switch (fp->protocol) {
445 default:
446 case UAC_VERSION_1: {
447 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
448 brate = le16_to_cpu(fmt->wMaxBitRate);
449 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
450 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
451 fp->frame_size = framesize;
452 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
453 break;
455 case UAC_VERSION_2: {
456 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
457 brate = le16_to_cpu(fmt->wMaxBitRate);
458 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
459 snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
460 fp->frame_size = framesize;
461 ret = parse_audio_format_rates_v2(chip, fp);
462 break;
466 return ret;
469 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
470 struct audioformat *fp, unsigned int format,
471 struct uac_format_type_i_continuous_descriptor *fmt,
472 int stream)
474 int err;
476 switch (fmt->bFormatType) {
477 case UAC_FORMAT_TYPE_I:
478 case UAC_FORMAT_TYPE_III:
479 err = parse_audio_format_i(chip, fp, format, fmt);
480 break;
481 case UAC_FORMAT_TYPE_II:
482 err = parse_audio_format_ii(chip, fp, format, fmt);
483 break;
484 default:
485 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
486 chip->dev->devnum, fp->iface, fp->altsetting,
487 fmt->bFormatType);
488 return -ENOTSUPP;
490 fp->fmt_type = fmt->bFormatType;
491 if (err < 0)
492 return err;
493 #if 1
494 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
495 /* extigy apparently supports sample rates other than 48k
496 * but not in ordinary way. so we enable only 48k atm.
498 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
499 chip->usb_id == USB_ID(0x041e, 0x3020) ||
500 chip->usb_id == USB_ID(0x041e, 0x3061)) {
501 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
502 fp->rates != SNDRV_PCM_RATE_48000 &&
503 fp->rates != SNDRV_PCM_RATE_96000)
504 return -ENOTSUPP;
506 #endif
507 return 0;