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>
23 #include <linux/usb/audio-v3.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
37 * parse the audio format type I descriptor
38 * and returns the corresponding pcm format
41 * @fp: audioformat record
42 * @format: the format tag (wFormatTag)
43 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
45 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
46 struct audioformat *fp,
47 u64 format, void *_fmt)
49 int sample_width, sample_bytes;
52 switch (fp->protocol) {
55 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
56 sample_width = fmt->bBitResolution;
57 sample_bytes = fmt->bSubframeSize;
58 format = 1ULL << format;
63 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
64 sample_width = fmt->bBitResolution;
65 sample_bytes = fmt->bSubslotSize;
67 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
68 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
69 /* flag potentially raw DSD capable altsettings */
77 struct uac3_as_header_descriptor *as = _fmt;
79 sample_width = as->bBitResolution;
80 sample_bytes = as->bSubslotSize;
82 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
83 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
90 fp->fmt_bits = sample_width;
92 if ((pcm_formats == 0) &&
93 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
94 /* some devices don't define this correctly... */
95 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
96 fp->iface, fp->altsetting);
97 format = 1 << UAC_FORMAT_TYPE_I_PCM;
99 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
100 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
102 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
104 sample_width == 24 && sample_bytes == 2)
106 else if (sample_width > sample_bytes * 8) {
107 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
108 fp->iface, fp->altsetting,
109 sample_width, sample_bytes);
111 /* check the format byte size */
112 switch (sample_bytes) {
114 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
117 if (snd_usb_is_big_endian_format(chip, fp))
118 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
120 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
123 if (snd_usb_is_big_endian_format(chip, fp))
124 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
126 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
129 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
133 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
134 fp->iface, fp->altsetting,
135 sample_width, sample_bytes);
139 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
140 /* Dallas DS4201 workaround: it advertises U8 format, but really
142 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
143 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
145 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
147 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
148 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
150 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
151 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
153 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
154 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
156 if (format & ~0x3f) {
158 "%u:%d : unsupported format bits %#llx\n",
159 fp->iface, fp->altsetting, format);
162 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
169 * parse the format descriptor and stores the possible sample rates
170 * on the audioformat table (audio class v1).
173 * @fp: audioformat record
174 * @fmt: the format descriptor
175 * @offset: the start offset of descriptor pointing the rate type
176 * (7 for type I and II, 8 for type II)
178 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
179 unsigned char *fmt, int offset)
181 int nr_rates = fmt[offset];
183 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
185 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
186 fp->iface, fp->altsetting);
192 * build the rate table and bitmap flags
196 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
198 if (fp->rate_table == NULL)
202 fp->rate_min = fp->rate_max = 0;
203 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
204 unsigned int rate = combine_triple(&fmt[idx]);
207 /* C-Media CM6501 mislabels its 96 kHz altsetting */
208 /* Terratec Aureon 7.1 USB C-Media 6206, too */
209 if (rate == 48000 && nr_rates == 1 &&
210 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
211 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
212 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
213 fp->altsetting == 5 && fp->maxpacksize == 392)
215 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
217 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
218 chip->usb_id == USB_ID(0x041e, 0x4068)))
221 fp->rate_table[fp->nr_rates] = rate;
222 if (!fp->rate_min || rate < fp->rate_min)
224 if (!fp->rate_max || rate > fp->rate_max)
226 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
230 hwc_debug("All rates were zero. Skipping format!\n");
234 /* continuous rates */
235 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
236 fp->rate_min = combine_triple(&fmt[offset + 1]);
237 fp->rate_max = combine_triple(&fmt[offset + 4]);
243 * Helper function to walk the array of sample rate triplets reported by
244 * the device. The problem is that we need to parse whole array first to
245 * get to know how many sample rates we have to expect.
246 * Then fp->rate_table can be allocated and filled.
248 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
249 struct audioformat *fp, int nr_triplets,
250 const unsigned char *data)
254 fp->rates = fp->rate_min = fp->rate_max = 0;
256 for (i = 0; i < nr_triplets; i++) {
257 int min = combine_quad(&data[2 + 12 * i]);
258 int max = combine_quad(&data[6 + 12 * i]);
259 int res = combine_quad(&data[10 + 12 * i]);
262 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
266 * for ranges with res == 1, we announce a continuous sample
267 * rate range, and this function should return 0 for no further
273 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
277 for (rate = min; rate <= max; rate += res) {
279 fp->rate_table[nr_rates] = rate;
280 if (!fp->rate_min || rate < fp->rate_min)
282 if (!fp->rate_max || rate > fp->rate_max)
284 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
287 if (nr_rates >= MAX_NR_RATES) {
288 usb_audio_err(chip, "invalid uac2 rates\n");
292 /* avoid endless loop */
302 * parse the format descriptor and stores the possible sample rates
303 * on the audioformat table (audio class v2 and v3).
305 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
306 struct audioformat *fp)
308 struct usb_device *dev = chip->dev;
309 unsigned char tmp[2], *data;
310 int nr_triplets, data_size, ret = 0;
311 int clock = snd_usb_clock_find_source(chip, fp->protocol,
316 "%s(): unable to find clock source (clock %d)\n",
321 /* get the number of sample rates first by only fetching 2 bytes */
322 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
323 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
324 UAC2_CS_CONTROL_SAM_FREQ << 8,
325 snd_usb_ctrl_intf(chip) | (clock << 8),
330 "%s(): unable to retrieve number of sample rates (clock %d)\n",
335 nr_triplets = (tmp[1] << 8) | tmp[0];
336 data_size = 2 + 12 * nr_triplets;
337 data = kzalloc(data_size, GFP_KERNEL);
343 /* now get the full information */
344 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
345 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
346 UAC2_CS_CONTROL_SAM_FREQ << 8,
347 snd_usb_ctrl_intf(chip) | (clock << 8),
352 "%s(): unable to retrieve sample rate range (clock %d)\n",
358 /* Call the triplet parser, and make sure fp->rate_table is NULL.
359 * We just use the return value to know how many sample rates we
360 * will have to deal with. */
361 kfree(fp->rate_table);
362 fp->rate_table = NULL;
363 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
365 if (fp->nr_rates == 0) {
366 /* SNDRV_PCM_RATE_CONTINUOUS */
371 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
372 if (!fp->rate_table) {
377 /* Call the triplet parser again, but this time, fp->rate_table is
378 * allocated, so the rates will be stored */
379 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
388 * parse the format type I and III descriptors
390 static int parse_audio_format_i(struct snd_usb_audio *chip,
391 struct audioformat *fp, u64 format,
394 snd_pcm_format_t pcm_format;
395 unsigned int fmt_type;
398 switch (fp->protocol) {
401 case UAC_VERSION_2: {
402 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
404 fmt_type = fmt->bFormatType;
407 case UAC_VERSION_3: {
408 /* fp->fmt_type is already set in this case */
409 fmt_type = fp->fmt_type;
414 if (fmt_type == UAC_FORMAT_TYPE_III) {
415 /* FIXME: the format type is really IECxxx
416 * but we give normal PCM format to get the existing
419 switch (chip->usb_id) {
421 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
422 if (chip->setup == 0x00 &&
424 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
426 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
429 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
431 fp->formats = pcm_format_to_bits(pcm_format);
433 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
438 /* gather possible sample rates */
439 /* audio class v1 reports possible sample rates as part of the
440 * proprietary class specific descriptor.
441 * audio class v2 uses class specific EP0 range requests for that.
443 switch (fp->protocol) {
445 case UAC_VERSION_1: {
446 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
448 fp->channels = fmt->bNrChannels;
449 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
453 case UAC_VERSION_3: {
454 /* fp->channels is already set in this case */
455 ret = parse_audio_format_rates_v2v3(chip, fp);
460 if (fp->channels < 1) {
462 "%u:%d : invalid channels %d\n",
463 fp->iface, fp->altsetting, fp->channels);
471 * parse the format type II descriptor
473 static int parse_audio_format_ii(struct snd_usb_audio *chip,
474 struct audioformat *fp,
475 u64 format, void *_fmt)
477 int brate, framesize, ret;
480 case UAC_FORMAT_TYPE_II_AC3:
481 /* FIXME: there is no AC3 format defined yet */
482 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
483 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
485 case UAC_FORMAT_TYPE_II_MPEG:
486 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
490 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
491 fp->iface, fp->altsetting, format);
492 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
498 switch (fp->protocol) {
500 case UAC_VERSION_1: {
501 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
502 brate = le16_to_cpu(fmt->wMaxBitRate);
503 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
504 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
505 fp->frame_size = framesize;
506 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
509 case UAC_VERSION_2: {
510 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
511 brate = le16_to_cpu(fmt->wMaxBitRate);
512 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
513 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
514 fp->frame_size = framesize;
515 ret = parse_audio_format_rates_v2v3(chip, fp);
523 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
524 struct audioformat *fp, u64 format,
525 struct uac_format_type_i_continuous_descriptor *fmt,
530 switch (fmt->bFormatType) {
531 case UAC_FORMAT_TYPE_I:
532 case UAC_FORMAT_TYPE_III:
533 err = parse_audio_format_i(chip, fp, format, fmt);
535 case UAC_FORMAT_TYPE_II:
536 err = parse_audio_format_ii(chip, fp, format, fmt);
540 "%u:%d : format type %d is not supported yet\n",
541 fp->iface, fp->altsetting,
545 fp->fmt_type = fmt->bFormatType;
549 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
550 /* extigy apparently supports sample rates other than 48k
551 * but not in ordinary way. so we enable only 48k atm.
553 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
554 chip->usb_id == USB_ID(0x041e, 0x3020) ||
555 chip->usb_id == USB_ID(0x041e, 0x3061)) {
556 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
557 fp->rates != SNDRV_PCM_RATE_48000 &&
558 fp->rates != SNDRV_PCM_RATE_96000)
565 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
566 struct audioformat *fp,
567 struct uac3_as_header_descriptor *as,
570 u64 format = le64_to_cpu(as->bmFormats);
574 * Type I format bits are D0..D6
575 * This test works because type IV is not supported
578 fp->fmt_type = UAC_FORMAT_TYPE_I;
580 fp->fmt_type = UAC_FORMAT_TYPE_III;
582 err = parse_audio_format_i(chip, fp, format, as);