1 // SPDX-License-Identifier: GPL-2.0-or-later
5 #include <linux/init.h>
6 #include <linux/slab.h>
8 #include <linux/usb/audio.h>
9 #include <linux/usb/audio-v2.h>
10 #include <linux/usb/audio-v3.h>
12 #include <sound/core.h>
13 #include <sound/pcm.h>
24 * parse the audio format type I descriptor
25 * and returns the corresponding pcm format
28 * @fp: audioformat record
29 * @format: the format tag (wFormatTag)
30 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
32 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
33 struct audioformat *fp,
34 u64 format, void *_fmt)
36 int sample_width, sample_bytes;
39 switch (fp->protocol) {
42 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
44 return 0; /* invalid format */
45 sample_width = fmt->bBitResolution;
46 sample_bytes = fmt->bSubframeSize;
47 format = 1ULL << format;
52 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
53 sample_width = fmt->bBitResolution;
54 sample_bytes = fmt->bSubslotSize;
56 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
57 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
58 /* flag potentially raw DSD capable altsettings */
66 struct uac3_as_header_descriptor *as = _fmt;
68 sample_width = as->bBitResolution;
69 sample_bytes = as->bSubslotSize;
71 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
72 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
79 fp->fmt_bits = sample_width;
81 if ((pcm_formats == 0) &&
82 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
83 /* some devices don't define this correctly... */
84 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
85 fp->iface, fp->altsetting);
86 format = 1 << UAC_FORMAT_TYPE_I_PCM;
88 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
89 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
91 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
93 sample_width == 24 && sample_bytes == 2)
95 else if (sample_width > sample_bytes * 8) {
96 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
97 fp->iface, fp->altsetting,
98 sample_width, sample_bytes);
100 /* check the format byte size */
101 switch (sample_bytes) {
103 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
106 if (snd_usb_is_big_endian_format(chip, fp))
107 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
109 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
112 if (snd_usb_is_big_endian_format(chip, fp))
113 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
115 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
118 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
122 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
123 fp->iface, fp->altsetting,
124 sample_width, sample_bytes);
128 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
129 /* Dallas DS4201 workaround: it advertises U8 format, but really
131 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
132 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
134 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
136 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
137 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
139 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
140 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
142 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
143 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
145 if (format & ~0x3f) {
147 "%u:%d : unsupported format bits %#llx\n",
148 fp->iface, fp->altsetting, format);
151 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
156 static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
158 kfree(fp->rate_table);
159 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
165 fp->rates = rate_bits;
166 fp->rate_table[0] = rate;
171 * parse the format descriptor and stores the possible sample rates
172 * on the audioformat table (audio class v1).
175 * @fp: audioformat record
176 * @fmt: the format descriptor
177 * @offset: the start offset of descriptor pointing the rate type
178 * (7 for type I and II, 8 for type II)
180 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
181 unsigned char *fmt, int offset)
183 int nr_rates = fmt[offset];
185 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
187 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
188 fp->iface, fp->altsetting);
194 * build the rate table and bitmap flags
198 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
200 if (fp->rate_table == NULL)
204 fp->rate_min = fp->rate_max = 0;
205 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
206 unsigned int rate = combine_triple(&fmt[idx]);
209 /* C-Media CM6501 mislabels its 96 kHz altsetting */
210 /* Terratec Aureon 7.1 USB C-Media 6206, too */
211 /* Ozone Z90 USB C-Media, too */
212 if (rate == 48000 && nr_rates == 1 &&
213 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
214 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
215 chip->usb_id == USB_ID(0x0d8c, 0x0078) ||
216 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
217 fp->altsetting == 5 && fp->maxpacksize == 392)
219 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
221 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
222 chip->usb_id == USB_ID(0x041e, 0x4068)))
225 fp->rate_table[fp->nr_rates] = rate;
226 if (!fp->rate_min || rate < fp->rate_min)
228 if (!fp->rate_max || rate > fp->rate_max)
230 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
234 hwc_debug("All rates were zero. Skipping format!\n");
238 /* continuous rates */
239 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
240 fp->rate_min = combine_triple(&fmt[offset + 1]);
241 fp->rate_max = combine_triple(&fmt[offset + 4]);
244 /* Jabra Evolve 65 headset */
245 if (chip->usb_id == USB_ID(0x0b0e, 0x030b)) {
246 /* only 48kHz for playback while keeping 16kHz for capture */
247 if (fp->nr_rates != 1)
248 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
256 * Presonus Studio 1810c supports a limited set of sampling
257 * rates per altsetting but reports the full set each time.
258 * If we don't filter out the unsupported rates and attempt
259 * to configure the card, it will hang refusing to do any
260 * further audio I/O until a hard reset is performed.
262 * The list of supported rates per altsetting (set of available
263 * I/O channels) is described in the owner's manual, section 2.2.
265 static bool s1810c_valid_sample_rate(struct audioformat *fp,
268 switch (fp->altsetting) {
270 /* All ADAT ports available */
271 return rate <= 48000;
273 /* Half of ADAT ports available */
274 return (rate == 88200 || rate == 96000);
276 /* Analog I/O only (no S/PDIF nor ADAT) */
277 return rate >= 176400;
285 * Many Focusrite devices supports a limited set of sampling rates per
286 * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
287 * descriptor which has a non-standard bLength = 10.
289 static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
290 struct audioformat *fp,
293 struct usb_interface *iface;
294 struct usb_host_interface *alts;
296 unsigned int max_rate;
298 iface = usb_ifnum_to_if(chip->dev, fp->iface);
302 alts = &iface->altsetting[fp->altset_idx];
303 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
304 NULL, UAC_FORMAT_TYPE);
308 if (fmt[0] == 10) { /* bLength */
309 max_rate = combine_quad(&fmt[6]);
311 /* Validate max rate */
312 if (max_rate != 48000 &&
314 max_rate != 192000 &&
315 max_rate != 384000) {
318 "%u:%d : unexpected max rate: %u\n",
319 fp->iface, fp->altsetting, max_rate);
324 return rate <= max_rate;
331 * Helper function to walk the array of sample rate triplets reported by
332 * the device. The problem is that we need to parse whole array first to
333 * get to know how many sample rates we have to expect.
334 * Then fp->rate_table can be allocated and filled.
336 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
337 struct audioformat *fp, int nr_triplets,
338 const unsigned char *data)
342 fp->rates = fp->rate_min = fp->rate_max = 0;
344 for (i = 0; i < nr_triplets; i++) {
345 int min = combine_quad(&data[2 + 12 * i]);
346 int max = combine_quad(&data[6 + 12 * i]);
347 int res = combine_quad(&data[10 + 12 * i]);
350 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
354 * for ranges with res == 1, we announce a continuous sample
355 * rate range, and this function should return 0 for no further
361 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
365 for (rate = min; rate <= max; rate += res) {
367 /* Filter out invalid rates on Presonus Studio 1810c */
368 if (chip->usb_id == USB_ID(0x0194f, 0x010c) &&
369 !s1810c_valid_sample_rate(fp, rate))
372 /* Filter out invalid rates on Focusrite devices */
373 if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
374 !focusrite_valid_sample_rate(chip, fp, rate))
378 fp->rate_table[nr_rates] = rate;
379 if (!fp->rate_min || rate < fp->rate_min)
381 if (!fp->rate_max || rate > fp->rate_max)
383 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
386 if (nr_rates >= MAX_NR_RATES) {
387 usb_audio_err(chip, "invalid uac2 rates\n");
392 /* avoid endless loop */
401 /* Line6 Helix series and the Rode Rodecaster Pro don't support the
402 * UAC2_CS_RANGE usb function call. Return a static table of known
405 static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
406 struct audioformat *fp)
408 switch (chip->usb_id) {
409 case USB_ID(0x0e41, 0x4241): /* Line6 Helix */
410 case USB_ID(0x0e41, 0x4242): /* Line6 Helix Rack */
411 case USB_ID(0x0e41, 0x4244): /* Line6 Helix LT */
412 case USB_ID(0x0e41, 0x4246): /* Line6 HX-Stomp */
413 case USB_ID(0x0e41, 0x4247): /* Line6 Pod Go */
414 case USB_ID(0x0e41, 0x4248): /* Line6 Helix >= fw 2.82 */
415 case USB_ID(0x0e41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
416 case USB_ID(0x0e41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
417 case USB_ID(0x19f7, 0x0011): /* Rode Rodecaster Pro */
418 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
425 * parse the format descriptor and stores the possible sample rates
426 * on the audioformat table (audio class v2 and v3).
428 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
429 struct audioformat *fp)
431 struct usb_device *dev = chip->dev;
432 unsigned char tmp[2], *data;
433 int nr_triplets, data_size, ret = 0, ret_l6;
434 int clock = snd_usb_clock_find_source(chip, fp, false);
438 "%s(): unable to find clock source (clock %d)\n",
443 /* get the number of sample rates first by only fetching 2 bytes */
444 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
445 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
446 UAC2_CS_CONTROL_SAM_FREQ << 8,
447 snd_usb_ctrl_intf(chip) | (clock << 8),
451 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
452 ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
453 if (ret_l6 == -ENODEV) {
454 /* no line6 device found continue showing the error */
456 "%s(): unable to retrieve number of sample rates (clock %d)\n",
462 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
470 nr_triplets = (tmp[1] << 8) | tmp[0];
471 data_size = 2 + 12 * nr_triplets;
472 data = kzalloc(data_size, GFP_KERNEL);
478 /* now get the full information */
479 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
480 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
481 UAC2_CS_CONTROL_SAM_FREQ << 8,
482 snd_usb_ctrl_intf(chip) | (clock << 8),
487 "%s(): unable to retrieve sample rate range (clock %d)\n",
493 /* Call the triplet parser, and make sure fp->rate_table is NULL.
494 * We just use the return value to know how many sample rates we
495 * will have to deal with. */
496 kfree(fp->rate_table);
497 fp->rate_table = NULL;
498 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
500 if (fp->nr_rates == 0) {
501 /* SNDRV_PCM_RATE_CONTINUOUS */
506 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
507 if (!fp->rate_table) {
512 /* Call the triplet parser again, but this time, fp->rate_table is
513 * allocated, so the rates will be stored */
514 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
523 * parse the format type I and III descriptors
525 static int parse_audio_format_i(struct snd_usb_audio *chip,
526 struct audioformat *fp, u64 format,
529 snd_pcm_format_t pcm_format;
530 unsigned int fmt_type;
533 switch (fp->protocol) {
536 case UAC_VERSION_2: {
537 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
539 fmt_type = fmt->bFormatType;
542 case UAC_VERSION_3: {
543 /* fp->fmt_type is already set in this case */
544 fmt_type = fp->fmt_type;
549 if (fmt_type == UAC_FORMAT_TYPE_III) {
550 /* FIXME: the format type is really IECxxx
551 * but we give normal PCM format to get the existing
554 switch (chip->usb_id) {
556 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
557 if (chip->setup == 0x00 &&
559 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
561 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
564 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
566 fp->formats = pcm_format_to_bits(pcm_format);
568 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
573 /* gather possible sample rates */
574 /* audio class v1 reports possible sample rates as part of the
575 * proprietary class specific descriptor.
576 * audio class v2 uses class specific EP0 range requests for that.
578 switch (fp->protocol) {
580 case UAC_VERSION_1: {
581 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
583 fp->channels = fmt->bNrChannels;
584 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
588 case UAC_VERSION_3: {
589 /* fp->channels is already set in this case */
590 ret = parse_audio_format_rates_v2v3(chip, fp);
595 if (fp->channels < 1) {
597 "%u:%d : invalid channels %d\n",
598 fp->iface, fp->altsetting, fp->channels);
606 * parse the format type II descriptor
608 static int parse_audio_format_ii(struct snd_usb_audio *chip,
609 struct audioformat *fp,
610 u64 format, void *_fmt)
612 int brate, framesize, ret;
615 case UAC_FORMAT_TYPE_II_AC3:
616 /* FIXME: there is no AC3 format defined yet */
617 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
618 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
620 case UAC_FORMAT_TYPE_II_MPEG:
621 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
625 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
626 fp->iface, fp->altsetting, format);
627 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
633 switch (fp->protocol) {
635 case UAC_VERSION_1: {
636 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
637 brate = le16_to_cpu(fmt->wMaxBitRate);
638 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
639 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
640 fp->frame_size = framesize;
641 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
644 case UAC_VERSION_2: {
645 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
646 brate = le16_to_cpu(fmt->wMaxBitRate);
647 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
648 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
649 fp->frame_size = framesize;
650 ret = parse_audio_format_rates_v2v3(chip, fp);
658 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
659 struct audioformat *fp, u64 format,
660 struct uac_format_type_i_continuous_descriptor *fmt,
665 switch (fmt->bFormatType) {
666 case UAC_FORMAT_TYPE_I:
667 case UAC_FORMAT_TYPE_III:
668 err = parse_audio_format_i(chip, fp, format, fmt);
670 case UAC_FORMAT_TYPE_II:
671 err = parse_audio_format_ii(chip, fp, format, fmt);
675 "%u:%d : format type %d is not supported yet\n",
676 fp->iface, fp->altsetting,
680 fp->fmt_type = fmt->bFormatType;
684 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
685 /* extigy apparently supports sample rates other than 48k
686 * but not in ordinary way. so we enable only 48k atm.
688 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
689 chip->usb_id == USB_ID(0x041e, 0x3020) ||
690 chip->usb_id == USB_ID(0x041e, 0x3061)) {
691 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
692 fp->rates != SNDRV_PCM_RATE_48000 &&
693 fp->rates != SNDRV_PCM_RATE_96000)
700 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
701 struct audioformat *fp,
702 struct uac3_as_header_descriptor *as,
705 u64 format = le64_to_cpu(as->bmFormats);
709 * Type I format bits are D0..D6
710 * This test works because type IV is not supported
713 fp->fmt_type = UAC_FORMAT_TYPE_I;
715 fp->fmt_type = UAC_FORMAT_TYPE_III;
717 err = parse_audio_format_i(chip, fp, format, as);