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>
23 * parse the audio format type I descriptor
24 * and returns the corresponding pcm format
27 * @fp: audioformat record
28 * @format: the format tag (wFormatTag)
29 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
31 static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
32 struct audioformat *fp,
33 u64 format, void *_fmt)
35 int sample_width, sample_bytes;
38 switch (fp->protocol) {
41 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
43 return 0; /* invalid format */
44 sample_width = fmt->bBitResolution;
45 sample_bytes = fmt->bSubframeSize;
46 format = 1ULL << format;
51 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
52 sample_width = fmt->bBitResolution;
53 sample_bytes = fmt->bSubslotSize;
55 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
56 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
57 /* flag potentially raw DSD capable altsettings */
65 struct uac3_as_header_descriptor *as = _fmt;
67 sample_width = as->bBitResolution;
68 sample_bytes = as->bSubslotSize;
70 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
71 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
78 fp->fmt_bits = sample_width;
80 if ((pcm_formats == 0) &&
81 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
82 /* some devices don't define this correctly... */
83 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
84 fp->iface, fp->altsetting);
85 format = 1 << UAC_FORMAT_TYPE_I_PCM;
87 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
88 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
90 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
92 sample_width == 24 && sample_bytes == 2)
94 else if (sample_width > sample_bytes * 8) {
95 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
96 fp->iface, fp->altsetting,
97 sample_width, sample_bytes);
99 /* check the format byte size */
100 switch (sample_bytes) {
102 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
105 if (snd_usb_is_big_endian_format(chip, fp))
106 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
108 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
111 if (snd_usb_is_big_endian_format(chip, fp))
112 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
114 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
117 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
121 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
122 fp->iface, fp->altsetting,
123 sample_width, sample_bytes);
127 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
128 /* Dallas DS4201 workaround: it advertises U8 format, but really
130 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
131 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
133 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
135 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
136 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
138 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
139 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
141 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
142 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
144 if (format & ~0x3f) {
146 "%u:%d : unsupported format bits %#llx\n",
147 fp->iface, fp->altsetting, format);
150 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
155 static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
157 kfree(fp->rate_table);
158 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
164 fp->rates = rate_bits;
165 fp->rate_table[0] = rate;
169 /* set up rate_min, rate_max and rates from the rate table */
170 static void set_rate_table_min_max(struct audioformat *fp)
175 fp->rate_min = INT_MAX;
178 for (i = 0; i < fp->nr_rates; i++) {
179 rate = fp->rate_table[i];
180 fp->rate_min = min(fp->rate_min, rate);
181 fp->rate_max = max(fp->rate_max, rate);
182 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
187 * parse the format descriptor and stores the possible sample rates
188 * on the audioformat table (audio class v1).
191 * @fp: audioformat record
192 * @fmt: the format descriptor
193 * @offset: the start offset of descriptor pointing the rate type
194 * (7 for type I and II, 8 for type II)
196 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
197 unsigned char *fmt, int offset)
199 int nr_rates = fmt[offset];
201 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
203 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
204 fp->iface, fp->altsetting);
210 * build the rate table and bitmap flags
214 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
216 if (fp->rate_table == NULL)
220 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
221 unsigned int rate = combine_triple(&fmt[idx]);
224 /* C-Media CM6501 mislabels its 96 kHz altsetting */
225 /* Terratec Aureon 7.1 USB C-Media 6206, too */
226 /* Ozone Z90 USB C-Media, too */
227 if (rate == 48000 && nr_rates == 1 &&
228 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
229 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
230 chip->usb_id == USB_ID(0x0d8c, 0x0078) ||
231 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
232 fp->altsetting == 5 && fp->maxpacksize == 392)
234 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
236 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
237 chip->usb_id == USB_ID(0x041e, 0x4068)))
240 fp->rate_table[fp->nr_rates++] = rate;
244 "%u:%d: All rates were zero\n",
245 fp->iface, fp->altsetting);
248 set_rate_table_min_max(fp);
250 /* continuous rates */
251 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
252 fp->rate_min = combine_triple(&fmt[offset + 1]);
253 fp->rate_max = combine_triple(&fmt[offset + 4]);
256 /* Jabra Evolve 65 headset */
257 if (chip->usb_id == USB_ID(0x0b0e, 0x030b)) {
258 /* only 48kHz for playback while keeping 16kHz for capture */
259 if (fp->nr_rates != 1)
260 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
268 * Presonus Studio 1810c supports a limited set of sampling
269 * rates per altsetting but reports the full set each time.
270 * If we don't filter out the unsupported rates and attempt
271 * to configure the card, it will hang refusing to do any
272 * further audio I/O until a hard reset is performed.
274 * The list of supported rates per altsetting (set of available
275 * I/O channels) is described in the owner's manual, section 2.2.
277 static bool s1810c_valid_sample_rate(struct audioformat *fp,
280 switch (fp->altsetting) {
282 /* All ADAT ports available */
283 return rate <= 48000;
285 /* Half of ADAT ports available */
286 return (rate == 88200 || rate == 96000);
288 /* Analog I/O only (no S/PDIF nor ADAT) */
289 return rate >= 176400;
297 * Many Focusrite devices supports a limited set of sampling rates per
298 * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
299 * descriptor which has a non-standard bLength = 10.
301 static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
302 struct audioformat *fp,
305 struct usb_interface *iface;
306 struct usb_host_interface *alts;
308 unsigned int max_rate;
310 iface = usb_ifnum_to_if(chip->dev, fp->iface);
314 alts = &iface->altsetting[fp->altset_idx];
315 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
316 NULL, UAC_FORMAT_TYPE);
320 if (fmt[0] == 10) { /* bLength */
321 max_rate = combine_quad(&fmt[6]);
323 /* Validate max rate */
324 if (max_rate != 48000 &&
326 max_rate != 192000 &&
327 max_rate != 384000) {
330 "%u:%d : unexpected max rate: %u\n",
331 fp->iface, fp->altsetting, max_rate);
336 return rate <= max_rate;
343 * Helper function to walk the array of sample rate triplets reported by
344 * the device. The problem is that we need to parse whole array first to
345 * get to know how many sample rates we have to expect.
346 * Then fp->rate_table can be allocated and filled.
348 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
349 struct audioformat *fp, int nr_triplets,
350 const unsigned char *data)
354 for (i = 0; i < nr_triplets; i++) {
355 int min = combine_quad(&data[2 + 12 * i]);
356 int max = combine_quad(&data[6 + 12 * i]);
357 int res = combine_quad(&data[10 + 12 * i]);
360 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
364 * for ranges with res == 1, we announce a continuous sample
365 * rate range, and this function should return 0 for no further
371 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
375 for (rate = min; rate <= max; rate += res) {
377 /* Filter out invalid rates on Presonus Studio 1810c */
378 if (chip->usb_id == USB_ID(0x0194f, 0x010c) &&
379 !s1810c_valid_sample_rate(fp, rate))
382 /* Filter out invalid rates on Focusrite devices */
383 if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
384 !focusrite_valid_sample_rate(chip, fp, rate))
388 fp->rate_table[nr_rates] = rate;
390 if (nr_rates >= MAX_NR_RATES) {
391 usb_audio_err(chip, "invalid uac2 rates\n");
396 /* avoid endless loop */
405 /* Line6 Helix series and the Rode Rodecaster Pro don't support the
406 * UAC2_CS_RANGE usb function call. Return a static table of known
409 static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
410 struct audioformat *fp)
412 switch (chip->usb_id) {
413 case USB_ID(0x0e41, 0x4241): /* Line6 Helix */
414 case USB_ID(0x0e41, 0x4242): /* Line6 Helix Rack */
415 case USB_ID(0x0e41, 0x4244): /* Line6 Helix LT */
416 case USB_ID(0x0e41, 0x4246): /* Line6 HX-Stomp */
417 case USB_ID(0x0e41, 0x4247): /* Line6 Pod Go */
418 case USB_ID(0x0e41, 0x4248): /* Line6 Helix >= fw 2.82 */
419 case USB_ID(0x0e41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
420 case USB_ID(0x0e41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
421 case USB_ID(0x19f7, 0x0011): /* Rode Rodecaster Pro */
422 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
428 /* check whether the given altsetting is supported for the already set rate */
429 static bool check_valid_altsetting_v2v3(struct snd_usb_audio *chip, int iface,
432 struct usb_device *dev = chip->dev;
437 /* we assume 64bit is enough for any altsettings */
438 if (snd_BUG_ON(altsetting >= 64 - 8))
441 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
442 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
443 UAC2_AS_VAL_ALT_SETTINGS << 8,
444 iface, &raw_data, sizeof(raw_data));
448 data = le64_to_cpu(raw_data);
449 /* first byte contains the bitmap size */
450 if ((data & 0xff) * 8 < altsetting)
452 if (data & (1ULL << (altsetting + 8)))
459 * Validate each sample rate with the altsetting
460 * Rebuild the rate table if only partial values are valid
462 static int validate_sample_rate_table_v2v3(struct snd_usb_audio *chip,
463 struct audioformat *fp,
466 struct usb_device *dev = chip->dev;
468 unsigned int nr_rates;
471 /* performing the rate verification may lead to unexpected USB bus
472 * behavior afterwards by some unknown reason. Do this only for the
475 switch (USB_ID_VENDOR(chip->usb_id)) {
476 case 0x07fd: /* MOTU */
479 return 0; /* don't perform the validation as default */
482 table = kcalloc(fp->nr_rates, sizeof(*table), GFP_KERNEL);
486 /* clear the interface altsetting at first */
487 usb_set_interface(dev, fp->iface, 0);
490 for (i = 0; i < fp->nr_rates; i++) {
491 err = snd_usb_set_sample_rate_v2v3(chip, fp, clock,
496 if (check_valid_altsetting_v2v3(chip, fp->iface, fp->altsetting))
497 table[nr_rates++] = fp->rate_table[i];
502 "No valid sample rate available for %d:%d, assuming a firmware bug\n",
503 fp->iface, fp->altsetting);
504 nr_rates = fp->nr_rates; /* continue as is */
507 if (fp->nr_rates == nr_rates) {
512 kfree(fp->rate_table);
513 fp->rate_table = table;
514 fp->nr_rates = nr_rates;
519 * parse the format descriptor and stores the possible sample rates
520 * on the audioformat table (audio class v2 and v3).
522 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
523 struct audioformat *fp)
525 struct usb_device *dev = chip->dev;
526 unsigned char tmp[2], *data;
527 int nr_triplets, data_size, ret = 0, ret_l6;
528 int clock = snd_usb_clock_find_source(chip, fp, false);
532 "%s(): unable to find clock source (clock %d)\n",
537 /* get the number of sample rates first by only fetching 2 bytes */
538 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
539 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
540 UAC2_CS_CONTROL_SAM_FREQ << 8,
541 snd_usb_ctrl_intf(chip) | (clock << 8),
545 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
546 ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
547 if (ret_l6 == -ENODEV) {
548 /* no line6 device found continue showing the error */
550 "%s(): unable to retrieve number of sample rates (clock %d)\n",
556 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
564 nr_triplets = (tmp[1] << 8) | tmp[0];
565 data_size = 2 + 12 * nr_triplets;
566 data = kzalloc(data_size, GFP_KERNEL);
572 /* now get the full information */
573 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
574 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
575 UAC2_CS_CONTROL_SAM_FREQ << 8,
576 snd_usb_ctrl_intf(chip) | (clock << 8),
581 "%s(): unable to retrieve sample rate range (clock %d)\n",
587 /* Call the triplet parser, and make sure fp->rate_table is NULL.
588 * We just use the return value to know how many sample rates we
589 * will have to deal with. */
590 kfree(fp->rate_table);
591 fp->rate_table = NULL;
592 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
594 if (fp->nr_rates == 0) {
595 /* SNDRV_PCM_RATE_CONTINUOUS */
600 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
601 if (!fp->rate_table) {
606 /* Call the triplet parser again, but this time, fp->rate_table is
607 * allocated, so the rates will be stored */
608 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
610 ret = validate_sample_rate_table_v2v3(chip, fp, clock);
614 set_rate_table_min_max(fp);
623 * parse the format type I and III descriptors
625 static int parse_audio_format_i(struct snd_usb_audio *chip,
626 struct audioformat *fp, u64 format,
629 snd_pcm_format_t pcm_format;
630 unsigned int fmt_type;
633 switch (fp->protocol) {
636 case UAC_VERSION_2: {
637 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
639 fmt_type = fmt->bFormatType;
642 case UAC_VERSION_3: {
643 /* fp->fmt_type is already set in this case */
644 fmt_type = fp->fmt_type;
649 if (fmt_type == UAC_FORMAT_TYPE_III) {
650 /* FIXME: the format type is really IECxxx
651 * but we give normal PCM format to get the existing
654 switch (chip->usb_id) {
656 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
657 if (chip->setup == 0x00 &&
659 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
661 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
664 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
666 fp->formats = pcm_format_to_bits(pcm_format);
668 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
673 /* gather possible sample rates */
674 /* audio class v1 reports possible sample rates as part of the
675 * proprietary class specific descriptor.
676 * audio class v2 uses class specific EP0 range requests for that.
678 switch (fp->protocol) {
680 case UAC_VERSION_1: {
681 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
683 fp->channels = fmt->bNrChannels;
684 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
688 case UAC_VERSION_3: {
689 /* fp->channels is already set in this case */
690 ret = parse_audio_format_rates_v2v3(chip, fp);
695 if (fp->channels < 1) {
697 "%u:%d : invalid channels %d\n",
698 fp->iface, fp->altsetting, fp->channels);
706 * parse the format type II descriptor
708 static int parse_audio_format_ii(struct snd_usb_audio *chip,
709 struct audioformat *fp,
710 u64 format, void *_fmt)
712 int brate, framesize, ret;
715 case UAC_FORMAT_TYPE_II_AC3:
716 /* FIXME: there is no AC3 format defined yet */
717 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
718 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
720 case UAC_FORMAT_TYPE_II_MPEG:
721 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
725 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
726 fp->iface, fp->altsetting, format);
727 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
733 switch (fp->protocol) {
735 case UAC_VERSION_1: {
736 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
737 brate = le16_to_cpu(fmt->wMaxBitRate);
738 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
739 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
740 fp->frame_size = framesize;
741 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
744 case UAC_VERSION_2: {
745 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
746 brate = le16_to_cpu(fmt->wMaxBitRate);
747 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
748 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
749 fp->frame_size = framesize;
750 ret = parse_audio_format_rates_v2v3(chip, fp);
758 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
759 struct audioformat *fp, u64 format,
760 struct uac_format_type_i_continuous_descriptor *fmt,
765 switch (fmt->bFormatType) {
766 case UAC_FORMAT_TYPE_I:
767 case UAC_FORMAT_TYPE_III:
768 err = parse_audio_format_i(chip, fp, format, fmt);
770 case UAC_FORMAT_TYPE_II:
771 err = parse_audio_format_ii(chip, fp, format, fmt);
775 "%u:%d : format type %d is not supported yet\n",
776 fp->iface, fp->altsetting,
780 fp->fmt_type = fmt->bFormatType;
784 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
785 /* extigy apparently supports sample rates other than 48k
786 * but not in ordinary way. so we enable only 48k atm.
788 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
789 chip->usb_id == USB_ID(0x041e, 0x3020) ||
790 chip->usb_id == USB_ID(0x041e, 0x3061)) {
791 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
792 fp->rates != SNDRV_PCM_RATE_48000 &&
793 fp->rates != SNDRV_PCM_RATE_96000)
800 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
801 struct audioformat *fp,
802 struct uac3_as_header_descriptor *as,
805 u64 format = le64_to_cpu(as->bmFormats);
809 * Type I format bits are D0..D6
810 * This test works because type IV is not supported
813 fp->fmt_type = UAC_FORMAT_TYPE_I;
815 fp->fmt_type = UAC_FORMAT_TYPE_III;
817 err = parse_audio_format_i(chip, fp, format, as);