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;
58 "%u:%d: invalid format type 0x%llx is detected, processed as PCM\n",
59 fp->iface, fp->altsetting, format);
60 format = UAC_FORMAT_TYPE_I_PCM;
62 sample_width = fmt->bBitResolution;
63 sample_bytes = fmt->bSubframeSize;
64 format = 1ULL << format;
69 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
70 sample_width = fmt->bBitResolution;
71 sample_bytes = fmt->bSubslotSize;
73 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
74 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
75 /* flag potentially raw DSD capable altsettings */
83 struct uac3_as_header_descriptor *as = _fmt;
85 sample_width = as->bBitResolution;
86 sample_bytes = as->bSubslotSize;
88 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
89 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
96 if ((pcm_formats == 0) &&
97 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
98 /* some devices don't define this correctly... */
99 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
100 fp->iface, fp->altsetting);
101 format = 1 << UAC_FORMAT_TYPE_I_PCM;
103 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
104 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
106 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
108 sample_width == 24 && sample_bytes == 2)
110 else if (sample_width > sample_bytes * 8) {
111 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
112 fp->iface, fp->altsetting,
113 sample_width, sample_bytes);
115 /* check the format byte size */
116 switch (sample_bytes) {
118 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
121 if (snd_usb_is_big_endian_format(chip, fp))
122 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
124 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
127 if (snd_usb_is_big_endian_format(chip, fp))
128 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
130 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
133 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
137 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
138 fp->iface, fp->altsetting,
139 sample_width, sample_bytes);
143 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
144 /* Dallas DS4201 workaround: it advertises U8 format, but really
146 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
147 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
149 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
151 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
152 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
154 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
155 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
157 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
158 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
160 if (format & ~0x3f) {
162 "%u:%d : unsupported format bits %#llx\n",
163 fp->iface, fp->altsetting, format);
166 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
173 * parse the format descriptor and stores the possible sample rates
174 * on the audioformat table (audio class v1).
177 * @fp: audioformat record
178 * @fmt: the format descriptor
179 * @offset: the start offset of descriptor pointing the rate type
180 * (7 for type I and II, 8 for type II)
182 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
183 unsigned char *fmt, int offset)
185 int nr_rates = fmt[offset];
187 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
189 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
190 fp->iface, fp->altsetting);
196 * build the rate table and bitmap flags
200 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
202 if (fp->rate_table == NULL)
206 fp->rate_min = fp->rate_max = 0;
207 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
208 unsigned int rate = combine_triple(&fmt[idx]);
211 /* C-Media CM6501 mislabels its 96 kHz altsetting */
212 /* Terratec Aureon 7.1 USB C-Media 6206, too */
213 /* Ozone Z90 USB C-Media, too */
214 if (rate == 48000 && nr_rates == 1 &&
215 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
216 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
217 chip->usb_id == USB_ID(0x0d8c, 0x0078) ||
218 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
219 fp->altsetting == 5 && fp->maxpacksize == 392)
221 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
223 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
224 chip->usb_id == USB_ID(0x041e, 0x4068)))
227 fp->rate_table[fp->nr_rates] = rate;
228 if (!fp->rate_min || rate < fp->rate_min)
230 if (!fp->rate_max || rate > fp->rate_max)
232 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
236 hwc_debug("All rates were zero. Skipping format!\n");
240 /* continuous rates */
241 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
242 fp->rate_min = combine_triple(&fmt[offset + 1]);
243 fp->rate_max = combine_triple(&fmt[offset + 4]);
249 * Many Focusrite devices supports a limited set of sampling rates per
250 * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
251 * descriptor which has a non-standard bLength = 10.
253 static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
254 struct audioformat *fp,
257 struct usb_interface *iface;
258 struct usb_host_interface *alts;
260 unsigned int max_rate;
262 iface = usb_ifnum_to_if(chip->dev, fp->iface);
266 alts = &iface->altsetting[fp->altset_idx];
267 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
268 NULL, UAC_FORMAT_TYPE);
272 if (fmt[0] == 10) { /* bLength */
273 max_rate = combine_quad(&fmt[6]);
275 /* Validate max rate */
276 if (max_rate != 48000 &&
278 max_rate != 192000 &&
279 max_rate != 384000) {
282 "%u:%d : unexpected max rate: %u\n",
283 fp->iface, fp->altsetting, max_rate);
288 return rate <= max_rate;
295 * Helper function to walk the array of sample rate triplets reported by
296 * the device. The problem is that we need to parse whole array first to
297 * get to know how many sample rates we have to expect.
298 * Then fp->rate_table can be allocated and filled.
300 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
301 struct audioformat *fp, int nr_triplets,
302 const unsigned char *data)
306 fp->rates = fp->rate_min = fp->rate_max = 0;
308 for (i = 0; i < nr_triplets; i++) {
309 int min = combine_quad(&data[2 + 12 * i]);
310 int max = combine_quad(&data[6 + 12 * i]);
311 int res = combine_quad(&data[10 + 12 * i]);
314 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
318 * for ranges with res == 1, we announce a continuous sample
319 * rate range, and this function should return 0 for no further
325 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
329 for (rate = min; rate <= max; rate += res) {
330 /* Filter out invalid rates on Focusrite devices */
331 if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
332 !focusrite_valid_sample_rate(chip, fp, rate))
336 fp->rate_table[nr_rates] = rate;
337 if (!fp->rate_min || rate < fp->rate_min)
339 if (!fp->rate_max || rate > fp->rate_max)
341 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
344 if (nr_rates >= MAX_NR_RATES) {
345 usb_audio_err(chip, "invalid uac2 rates\n");
350 /* avoid endless loop */
360 * parse the format descriptor and stores the possible sample rates
361 * on the audioformat table (audio class v2 and v3).
363 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
364 struct audioformat *fp)
366 struct usb_device *dev = chip->dev;
367 unsigned char tmp[2], *data;
368 int nr_triplets, data_size, ret = 0;
369 int clock = snd_usb_clock_find_source(chip, fp, false);
373 "%s(): unable to find clock source (clock %d)\n",
378 /* get the number of sample rates first by only fetching 2 bytes */
379 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
380 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
381 UAC2_CS_CONTROL_SAM_FREQ << 8,
382 snd_usb_ctrl_intf(chip) | (clock << 8),
387 "%s(): unable to retrieve number of sample rates (clock %d)\n",
392 nr_triplets = (tmp[1] << 8) | tmp[0];
393 data_size = 2 + 12 * nr_triplets;
394 data = kzalloc(data_size, GFP_KERNEL);
400 /* now get the full information */
401 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
402 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
403 UAC2_CS_CONTROL_SAM_FREQ << 8,
404 snd_usb_ctrl_intf(chip) | (clock << 8),
409 "%s(): unable to retrieve sample rate range (clock %d)\n",
415 /* Call the triplet parser, and make sure fp->rate_table is NULL.
416 * We just use the return value to know how many sample rates we
417 * will have to deal with. */
418 kfree(fp->rate_table);
419 fp->rate_table = NULL;
420 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
422 if (fp->nr_rates == 0) {
423 /* SNDRV_PCM_RATE_CONTINUOUS */
428 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
429 if (!fp->rate_table) {
434 /* Call the triplet parser again, but this time, fp->rate_table is
435 * allocated, so the rates will be stored */
436 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
445 * parse the format type I and III descriptors
447 static int parse_audio_format_i(struct snd_usb_audio *chip,
448 struct audioformat *fp, u64 format,
451 snd_pcm_format_t pcm_format;
452 unsigned int fmt_type;
455 switch (fp->protocol) {
458 case UAC_VERSION_2: {
459 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
461 fmt_type = fmt->bFormatType;
464 case UAC_VERSION_3: {
465 /* fp->fmt_type is already set in this case */
466 fmt_type = fp->fmt_type;
471 if (fmt_type == UAC_FORMAT_TYPE_III) {
472 /* FIXME: the format type is really IECxxx
473 * but we give normal PCM format to get the existing
476 switch (chip->usb_id) {
478 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
479 if (chip->setup == 0x00 &&
481 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
483 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
486 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
488 fp->formats = pcm_format_to_bits(pcm_format);
490 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
495 /* gather possible sample rates */
496 /* audio class v1 reports possible sample rates as part of the
497 * proprietary class specific descriptor.
498 * audio class v2 uses class specific EP0 range requests for that.
500 switch (fp->protocol) {
502 case UAC_VERSION_1: {
503 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
505 fp->channels = fmt->bNrChannels;
506 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
510 case UAC_VERSION_3: {
511 /* fp->channels is already set in this case */
512 ret = parse_audio_format_rates_v2v3(chip, fp);
517 if (fp->channels < 1) {
519 "%u:%d : invalid channels %d\n",
520 fp->iface, fp->altsetting, fp->channels);
528 * parse the format type II descriptor
530 static int parse_audio_format_ii(struct snd_usb_audio *chip,
531 struct audioformat *fp,
532 u64 format, void *_fmt)
534 int brate, framesize, ret;
537 case UAC_FORMAT_TYPE_II_AC3:
538 /* FIXME: there is no AC3 format defined yet */
539 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
540 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
542 case UAC_FORMAT_TYPE_II_MPEG:
543 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
547 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
548 fp->iface, fp->altsetting, format);
549 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
555 switch (fp->protocol) {
557 case UAC_VERSION_1: {
558 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
559 brate = le16_to_cpu(fmt->wMaxBitRate);
560 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
561 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
562 fp->frame_size = framesize;
563 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
566 case UAC_VERSION_2: {
567 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
568 brate = le16_to_cpu(fmt->wMaxBitRate);
569 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
570 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
571 fp->frame_size = framesize;
572 ret = parse_audio_format_rates_v2v3(chip, fp);
580 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
581 struct audioformat *fp, u64 format,
582 struct uac_format_type_i_continuous_descriptor *fmt,
587 switch (fmt->bFormatType) {
588 case UAC_FORMAT_TYPE_I:
589 case UAC_FORMAT_TYPE_III:
590 err = parse_audio_format_i(chip, fp, format, fmt);
592 case UAC_FORMAT_TYPE_II:
593 err = parse_audio_format_ii(chip, fp, format, fmt);
597 "%u:%d : format type %d is not supported yet\n",
598 fp->iface, fp->altsetting,
602 fp->fmt_type = fmt->bFormatType;
606 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
607 /* extigy apparently supports sample rates other than 48k
608 * but not in ordinary way. so we enable only 48k atm.
610 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
611 chip->usb_id == USB_ID(0x041e, 0x3020) ||
612 chip->usb_id == USB_ID(0x041e, 0x3061)) {
613 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
614 fp->rates != SNDRV_PCM_RATE_48000 &&
615 fp->rates != SNDRV_PCM_RATE_96000)
622 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
623 struct audioformat *fp,
624 struct uac3_as_header_descriptor *as,
627 u64 format = le64_to_cpu(as->bmFormats);
631 * Type I format bits are D0..D6
632 * This test works because type IV is not supported
635 fp->fmt_type = UAC_FORMAT_TYPE_I;
637 fp->fmt_type = UAC_FORMAT_TYPE_III;
639 err = parse_audio_format_i(chip, fp, format, as);