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;
43 sample_width = fmt->bBitResolution;
44 sample_bytes = fmt->bSubframeSize;
45 format = 1ULL << format;
50 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
51 sample_width = fmt->bBitResolution;
52 sample_bytes = fmt->bSubslotSize;
54 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
55 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
56 /* flag potentially raw DSD capable altsettings */
64 struct uac3_as_header_descriptor *as = _fmt;
66 sample_width = as->bBitResolution;
67 sample_bytes = as->bSubslotSize;
69 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
70 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
77 fp->fmt_bits = sample_width;
79 if ((pcm_formats == 0) &&
80 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
81 /* some devices don't define this correctly... */
82 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
83 fp->iface, fp->altsetting);
84 format = 1 << UAC_FORMAT_TYPE_I_PCM;
86 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
87 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
89 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
91 sample_width == 24 && sample_bytes == 2)
93 else if (sample_width > sample_bytes * 8) {
94 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
95 fp->iface, fp->altsetting,
96 sample_width, sample_bytes);
98 /* check the format byte size */
99 switch (sample_bytes) {
101 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
104 if (snd_usb_is_big_endian_format(chip, fp))
105 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
107 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
110 if (snd_usb_is_big_endian_format(chip, fp))
111 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
113 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
116 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
120 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
121 fp->iface, fp->altsetting,
122 sample_width, sample_bytes);
126 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
127 /* Dallas DS4201 workaround: it advertises U8 format, but really
129 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
130 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
132 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
134 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
135 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
137 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
138 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
140 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
141 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
143 if (format & ~0x3f) {
145 "%u:%d : unsupported format bits %#llx\n",
146 fp->iface, fp->altsetting, format);
149 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
154 static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
156 kfree(fp->rate_table);
157 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
163 fp->rates = rate_bits;
164 fp->rate_table[0] = rate;
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]);
240 /* Jabra Evolve 65 headset */
241 if (chip->usb_id == USB_ID(0x0b0e, 0x030b)) {
242 /* only 48kHz for playback while keeping 16kHz for capture */
243 if (fp->nr_rates != 1)
244 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
252 * Presonus Studio 1810c supports a limited set of sampling
253 * rates per altsetting but reports the full set each time.
254 * If we don't filter out the unsupported rates and attempt
255 * to configure the card, it will hang refusing to do any
256 * further audio I/O until a hard reset is performed.
258 * The list of supported rates per altsetting (set of available
259 * I/O channels) is described in the owner's manual, section 2.2.
261 static bool s1810c_valid_sample_rate(struct audioformat *fp,
264 switch (fp->altsetting) {
266 /* All ADAT ports available */
267 return rate <= 48000;
269 /* Half of ADAT ports available */
270 return (rate == 88200 || rate == 96000);
272 /* Analog I/O only (no S/PDIF nor ADAT) */
273 return rate >= 176400;
281 * Many Focusrite devices supports a limited set of sampling rates per
282 * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
283 * descriptor which has a non-standard bLength = 10.
285 static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
286 struct audioformat *fp,
289 struct usb_interface *iface;
290 struct usb_host_interface *alts;
292 unsigned int max_rate;
294 iface = usb_ifnum_to_if(chip->dev, fp->iface);
298 alts = &iface->altsetting[fp->altset_idx];
299 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
300 NULL, UAC_FORMAT_TYPE);
304 if (fmt[0] == 10) { /* bLength */
305 max_rate = combine_quad(&fmt[6]);
307 /* Validate max rate */
308 if (max_rate != 48000 &&
310 max_rate != 192000 &&
311 max_rate != 384000) {
314 "%u:%d : unexpected max rate: %u\n",
315 fp->iface, fp->altsetting, max_rate);
320 return rate <= max_rate;
327 * Helper function to walk the array of sample rate triplets reported by
328 * the device. The problem is that we need to parse whole array first to
329 * get to know how many sample rates we have to expect.
330 * Then fp->rate_table can be allocated and filled.
332 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
333 struct audioformat *fp, int nr_triplets,
334 const unsigned char *data)
338 fp->rates = fp->rate_min = fp->rate_max = 0;
340 for (i = 0; i < nr_triplets; i++) {
341 int min = combine_quad(&data[2 + 12 * i]);
342 int max = combine_quad(&data[6 + 12 * i]);
343 int res = combine_quad(&data[10 + 12 * i]);
346 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
350 * for ranges with res == 1, we announce a continuous sample
351 * rate range, and this function should return 0 for no further
357 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
361 for (rate = min; rate <= max; rate += res) {
363 /* Filter out invalid rates on Presonus Studio 1810c */
364 if (chip->usb_id == USB_ID(0x0194f, 0x010c) &&
365 !s1810c_valid_sample_rate(fp, rate))
368 /* Filter out invalid rates on Focusrite devices */
369 if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
370 !focusrite_valid_sample_rate(chip, fp, rate))
374 fp->rate_table[nr_rates] = rate;
375 if (!fp->rate_min || rate < fp->rate_min)
377 if (!fp->rate_max || rate > fp->rate_max)
379 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
382 if (nr_rates >= MAX_NR_RATES) {
383 usb_audio_err(chip, "invalid uac2 rates\n");
388 /* avoid endless loop */
397 /* Line6 Helix series and the Rode Rodecaster Pro don't support the
398 * UAC2_CS_RANGE usb function call. Return a static table of known
401 static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
402 struct audioformat *fp)
404 switch (chip->usb_id) {
405 case USB_ID(0x0e41, 0x4241): /* Line6 Helix */
406 case USB_ID(0x0e41, 0x4242): /* Line6 Helix Rack */
407 case USB_ID(0x0e41, 0x4244): /* Line6 Helix LT */
408 case USB_ID(0x0e41, 0x4246): /* Line6 HX-Stomp */
409 case USB_ID(0x0e41, 0x4248): /* Line6 Helix >= fw 2.82 */
410 case USB_ID(0x0e41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
411 case USB_ID(0x0e41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
412 case USB_ID(0x19f7, 0x0011): /* Rode Rodecaster Pro */
413 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
420 * parse the format descriptor and stores the possible sample rates
421 * on the audioformat table (audio class v2 and v3).
423 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
424 struct audioformat *fp)
426 struct usb_device *dev = chip->dev;
427 unsigned char tmp[2], *data;
428 int nr_triplets, data_size, ret = 0, ret_l6;
429 int clock = snd_usb_clock_find_source(chip, fp, false);
433 "%s(): unable to find clock source (clock %d)\n",
438 /* get the number of sample rates first by only fetching 2 bytes */
439 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
440 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
441 UAC2_CS_CONTROL_SAM_FREQ << 8,
442 snd_usb_ctrl_intf(chip) | (clock << 8),
446 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
447 ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
448 if (ret_l6 == -ENODEV) {
449 /* no line6 device found continue showing the error */
451 "%s(): unable to retrieve number of sample rates (clock %d)\n",
457 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
465 nr_triplets = (tmp[1] << 8) | tmp[0];
466 data_size = 2 + 12 * nr_triplets;
467 data = kzalloc(data_size, GFP_KERNEL);
473 /* now get the full information */
474 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
475 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
476 UAC2_CS_CONTROL_SAM_FREQ << 8,
477 snd_usb_ctrl_intf(chip) | (clock << 8),
482 "%s(): unable to retrieve sample rate range (clock %d)\n",
488 /* Call the triplet parser, and make sure fp->rate_table is NULL.
489 * We just use the return value to know how many sample rates we
490 * will have to deal with. */
491 kfree(fp->rate_table);
492 fp->rate_table = NULL;
493 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
495 if (fp->nr_rates == 0) {
496 /* SNDRV_PCM_RATE_CONTINUOUS */
501 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
502 if (!fp->rate_table) {
507 /* Call the triplet parser again, but this time, fp->rate_table is
508 * allocated, so the rates will be stored */
509 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
518 * parse the format type I and III descriptors
520 static int parse_audio_format_i(struct snd_usb_audio *chip,
521 struct audioformat *fp, u64 format,
524 snd_pcm_format_t pcm_format;
525 unsigned int fmt_type;
528 switch (fp->protocol) {
531 case UAC_VERSION_2: {
532 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
534 fmt_type = fmt->bFormatType;
537 case UAC_VERSION_3: {
538 /* fp->fmt_type is already set in this case */
539 fmt_type = fp->fmt_type;
544 if (fmt_type == UAC_FORMAT_TYPE_III) {
545 /* FIXME: the format type is really IECxxx
546 * but we give normal PCM format to get the existing
549 switch (chip->usb_id) {
551 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
552 if (chip->setup == 0x00 &&
554 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
556 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
559 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
561 fp->formats = pcm_format_to_bits(pcm_format);
563 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
568 /* gather possible sample rates */
569 /* audio class v1 reports possible sample rates as part of the
570 * proprietary class specific descriptor.
571 * audio class v2 uses class specific EP0 range requests for that.
573 switch (fp->protocol) {
575 case UAC_VERSION_1: {
576 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
578 fp->channels = fmt->bNrChannels;
579 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
583 case UAC_VERSION_3: {
584 /* fp->channels is already set in this case */
585 ret = parse_audio_format_rates_v2v3(chip, fp);
590 if (fp->channels < 1) {
592 "%u:%d : invalid channels %d\n",
593 fp->iface, fp->altsetting, fp->channels);
601 * parse the format type II descriptor
603 static int parse_audio_format_ii(struct snd_usb_audio *chip,
604 struct audioformat *fp,
605 u64 format, void *_fmt)
607 int brate, framesize, ret;
610 case UAC_FORMAT_TYPE_II_AC3:
611 /* FIXME: there is no AC3 format defined yet */
612 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
613 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
615 case UAC_FORMAT_TYPE_II_MPEG:
616 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
620 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
621 fp->iface, fp->altsetting, format);
622 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
628 switch (fp->protocol) {
630 case UAC_VERSION_1: {
631 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
632 brate = le16_to_cpu(fmt->wMaxBitRate);
633 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
634 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
635 fp->frame_size = framesize;
636 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
639 case UAC_VERSION_2: {
640 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
641 brate = le16_to_cpu(fmt->wMaxBitRate);
642 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
643 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
644 fp->frame_size = framesize;
645 ret = parse_audio_format_rates_v2v3(chip, fp);
653 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
654 struct audioformat *fp, u64 format,
655 struct uac_format_type_i_continuous_descriptor *fmt,
660 switch (fmt->bFormatType) {
661 case UAC_FORMAT_TYPE_I:
662 case UAC_FORMAT_TYPE_III:
663 err = parse_audio_format_i(chip, fp, format, fmt);
665 case UAC_FORMAT_TYPE_II:
666 err = parse_audio_format_ii(chip, fp, format, fmt);
670 "%u:%d : format type %d is not supported yet\n",
671 fp->iface, fp->altsetting,
675 fp->fmt_type = fmt->bFormatType;
679 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
680 /* extigy apparently supports sample rates other than 48k
681 * but not in ordinary way. so we enable only 48k atm.
683 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
684 chip->usb_id == USB_ID(0x041e, 0x3020) ||
685 chip->usb_id == USB_ID(0x041e, 0x3061)) {
686 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
687 fp->rates != SNDRV_PCM_RATE_48000 &&
688 fp->rates != SNDRV_PCM_RATE_96000)
695 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
696 struct audioformat *fp,
697 struct uac3_as_header_descriptor *as,
700 u64 format = le64_to_cpu(as->bmFormats);
704 * Type I format bits are D0..D6
705 * This test works because type IV is not supported
708 fp->fmt_type = UAC_FORMAT_TYPE_I;
710 fp->fmt_type = UAC_FORMAT_TYPE_III;
712 err = parse_audio_format_i(chip, fp, format, as);