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>
35 * parse the audio format type I descriptor
36 * and returns the corresponding pcm format
39 * @fp: audioformat record
40 * @format: the format tag (wFormatTag)
41 * @fmt: the format type descriptor
43 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
44 struct audioformat *fp,
45 int format, void *_fmt,
48 int sample_width, sample_bytes;
54 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
55 sample_width = fmt->bBitResolution;
56 sample_bytes = fmt->bSubframeSize;
62 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
63 sample_width = fmt->bBitResolution;
64 sample_bytes = fmt->bSubslotSize;
72 if (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED)) {
73 /* some devices don't define this correctly... */
74 snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
75 chip->dev->devnum, fp->iface, fp->altsetting);
76 format = 1 << UAC_FORMAT_TYPE_I_PCM;
78 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
79 if (chip->usb_id == USB_ID(0x0582, 0x0016) /* Edirol SD-90 */ &&
80 sample_width == 24 && sample_bytes == 2)
82 else if (sample_width > sample_bytes * 8) {
83 snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
84 chip->dev->devnum, fp->iface, fp->altsetting,
85 sample_width, sample_bytes);
87 /* check the format byte size */
88 switch (sample_bytes) {
90 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
93 if (snd_usb_is_big_endian_format(chip, fp))
94 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
96 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
99 if (snd_usb_is_big_endian_format(chip, fp))
100 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
102 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
105 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
108 snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
109 chip->dev->devnum, fp->iface, fp->altsetting,
110 sample_width, sample_bytes);
114 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
115 /* Dallas DS4201 workaround: it advertises U8 format, but really
117 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
118 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
120 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
122 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
123 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
125 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
126 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
128 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
129 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
131 if (format & ~0x3f) {
132 snd_printk(KERN_INFO "%d:%u:%d : unsupported format bits %#x\n",
133 chip->dev->devnum, fp->iface, fp->altsetting, format);
140 * parse the format descriptor and stores the possible sample rates
141 * on the audioformat table (audio class v1).
144 * @fp: audioformat record
145 * @fmt: the format descriptor
146 * @offset: the start offset of descriptor pointing the rate type
147 * (7 for type I and II, 8 for type II)
149 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
150 unsigned char *fmt, int offset)
152 int nr_rates = fmt[offset];
154 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
155 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
156 chip->dev->devnum, fp->iface, fp->altsetting);
162 * build the rate table and bitmap flags
166 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
167 if (fp->rate_table == NULL) {
168 snd_printk(KERN_ERR "cannot malloc\n");
173 fp->rate_min = fp->rate_max = 0;
174 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
175 unsigned int rate = combine_triple(&fmt[idx]);
178 /* C-Media CM6501 mislabels its 96 kHz altsetting */
179 if (rate == 48000 && nr_rates == 1 &&
180 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
181 chip->usb_id == USB_ID(0x0d8c, 0x0102)) &&
182 fp->altsetting == 5 && fp->maxpacksize == 392)
184 /* Creative VF0470 Live Cam reports 16 kHz instead of 8kHz */
185 if (rate == 16000 && chip->usb_id == USB_ID(0x041e, 0x4068))
188 fp->rate_table[fp->nr_rates] = rate;
189 if (!fp->rate_min || rate < fp->rate_min)
191 if (!fp->rate_max || rate > fp->rate_max)
193 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
197 hwc_debug("All rates were zero. Skipping format!\n");
201 /* continuous rates */
202 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
203 fp->rate_min = combine_triple(&fmt[offset + 1]);
204 fp->rate_max = combine_triple(&fmt[offset + 4]);
210 * Helper function to walk the array of sample rate triplets reported by
211 * the device. The problem is that we need to parse whole array first to
212 * get to know how many sample rates we have to expect.
213 * Then fp->rate_table can be allocated and filled.
215 static int parse_uac2_sample_rate_range(struct audioformat *fp, int nr_triplets,
216 const unsigned char *data)
220 fp->rates = fp->rate_min = fp->rate_max = 0;
222 for (i = 0; i < nr_triplets; i++) {
223 int min = combine_quad(&data[2 + 12 * i]);
224 int max = combine_quad(&data[6 + 12 * i]);
225 int res = combine_quad(&data[10 + 12 * i]);
228 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
232 * for ranges with res == 1, we announce a continuous sample
233 * rate range, and this function should return 0 for no further
239 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
243 for (rate = min; rate <= max; rate += res) {
245 fp->rate_table[nr_rates] = rate;
246 if (!fp->rate_min || rate < fp->rate_min)
248 if (!fp->rate_max || rate > fp->rate_max)
250 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
254 /* avoid endless loop */
264 * parse the format descriptor and stores the possible sample rates
265 * on the audioformat table (audio class v2).
267 static int parse_audio_format_rates_v2(struct snd_usb_audio *chip,
268 struct audioformat *fp)
270 struct usb_device *dev = chip->dev;
271 unsigned char tmp[2], *data;
272 int nr_triplets, data_size, ret = 0;
273 int clock = snd_usb_clock_find_source(chip, fp->clock);
276 snd_printk(KERN_ERR "%s(): unable to find clock source (clock %d)\n",
281 /* get the number of sample rates first by only fetching 2 bytes */
282 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
283 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
284 UAC2_CS_CONTROL_SAM_FREQ << 8,
285 snd_usb_ctrl_intf(chip) | (clock << 8),
286 tmp, sizeof(tmp), 1000);
289 snd_printk(KERN_ERR "%s(): unable to retrieve number of sample rates (clock %d)\n",
294 nr_triplets = (tmp[1] << 8) | tmp[0];
295 data_size = 2 + 12 * nr_triplets;
296 data = kzalloc(data_size, GFP_KERNEL);
302 /* now get the full information */
303 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
304 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
305 UAC2_CS_CONTROL_SAM_FREQ << 8,
306 snd_usb_ctrl_intf(chip) | (clock << 8),
307 data, data_size, 1000);
310 snd_printk(KERN_ERR "%s(): unable to retrieve sample rate range (clock %d)\n",
316 /* Call the triplet parser, and make sure fp->rate_table is NULL.
317 * We just use the return value to know how many sample rates we
318 * will have to deal with. */
319 kfree(fp->rate_table);
320 fp->rate_table = NULL;
321 fp->nr_rates = parse_uac2_sample_rate_range(fp, nr_triplets, data);
323 if (fp->nr_rates == 0) {
324 /* SNDRV_PCM_RATE_CONTINUOUS */
329 fp->rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
330 if (!fp->rate_table) {
335 /* Call the triplet parser again, but this time, fp->rate_table is
336 * allocated, so the rates will be stored */
337 parse_uac2_sample_rate_range(fp, nr_triplets, data);
346 * parse the format type I and III descriptors
348 static int parse_audio_format_i(struct snd_usb_audio *chip,
349 struct audioformat *fp, int format,
350 struct uac_format_type_i_continuous_descriptor *fmt,
351 struct usb_host_interface *iface)
353 struct usb_interface_descriptor *altsd = get_iface_desc(iface);
354 int protocol = altsd->bInterfaceProtocol;
357 if (fmt->bFormatType == UAC_FORMAT_TYPE_III) {
358 /* FIXME: the format type is really IECxxx
359 * but we give normal PCM format to get the existing
362 switch (chip->usb_id) {
364 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
365 if (chip->setup == 0x00 &&
367 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
369 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
372 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
374 fp->formats = 1uLL << pcm_format;
376 fp->formats = parse_audio_format_i_type(chip, fp, format,
382 /* gather possible sample rates */
383 /* audio class v1 reports possible sample rates as part of the
384 * proprietary class specific descriptor.
385 * audio class v2 uses class specific EP0 range requests for that.
389 snd_printdd(KERN_WARNING "%d:%u:%d : invalid protocol version %d, assuming v1\n",
390 chip->dev->devnum, fp->iface, fp->altsetting, protocol);
393 fp->channels = fmt->bNrChannels;
394 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
397 /* fp->channels is already set in this case */
398 ret = parse_audio_format_rates_v2(chip, fp);
402 if (fp->channels < 1) {
403 snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
404 chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
412 * parse the format type II descriptor
414 static int parse_audio_format_ii(struct snd_usb_audio *chip,
415 struct audioformat *fp,
416 int format, void *_fmt,
417 struct usb_host_interface *iface)
419 int brate, framesize, ret;
420 struct usb_interface_descriptor *altsd = get_iface_desc(iface);
421 int protocol = altsd->bInterfaceProtocol;
424 case UAC_FORMAT_TYPE_II_AC3:
425 /* FIXME: there is no AC3 format defined yet */
426 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
427 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
429 case UAC_FORMAT_TYPE_II_MPEG:
430 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
433 snd_printd(KERN_INFO "%d:%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
434 chip->dev->devnum, fp->iface, fp->altsetting, format);
435 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
443 snd_printdd(KERN_WARNING "%d:%u:%d : invalid protocol version %d, assuming v1\n",
444 chip->dev->devnum, fp->iface, fp->altsetting, protocol);
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 */
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);
469 int snd_usb_parse_audio_format(struct snd_usb_audio *chip, struct audioformat *fp,
470 int format, struct uac_format_type_i_continuous_descriptor *fmt,
471 int stream, struct usb_host_interface *iface)
475 switch (fmt->bFormatType) {
476 case UAC_FORMAT_TYPE_I:
477 case UAC_FORMAT_TYPE_III:
478 err = parse_audio_format_i(chip, fp, format, fmt, iface);
480 case UAC_FORMAT_TYPE_II:
481 err = parse_audio_format_ii(chip, fp, format, fmt, iface);
484 snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
485 chip->dev->devnum, fp->iface, fp->altsetting,
489 fp->fmt_type = fmt->bFormatType;
493 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
494 /* extigy apparently supports sample rates other than 48k
495 * but not in ordinary way. so we enable only 48k atm.
497 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
498 chip->usb_id == USB_ID(0x041e, 0x3020) ||
499 chip->usb_id == USB_ID(0x041e, 0x3061)) {
500 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
501 fp->rates != SNDRV_PCM_RATE_48000 &&
502 fp->rates != SNDRV_PCM_RATE_96000)