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);
158 * parse the format descriptor and stores the possible sample rates
159 * on the audioformat table (audio class v1).
162 * @fp: audioformat record
163 * @fmt: the format descriptor
164 * @offset: the start offset of descriptor pointing the rate type
165 * (7 for type I and II, 8 for type II)
167 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
168 unsigned char *fmt, int offset)
170 int nr_rates = fmt[offset];
172 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
174 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
175 fp->iface, fp->altsetting);
181 * build the rate table and bitmap flags
185 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
187 if (fp->rate_table == NULL)
191 fp->rate_min = fp->rate_max = 0;
192 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
193 unsigned int rate = combine_triple(&fmt[idx]);
196 /* C-Media CM6501 mislabels its 96 kHz altsetting */
197 /* Terratec Aureon 7.1 USB C-Media 6206, too */
198 /* Ozone Z90 USB C-Media, too */
199 if (rate == 48000 && nr_rates == 1 &&
200 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
201 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
202 chip->usb_id == USB_ID(0x0d8c, 0x0078) ||
203 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
204 fp->altsetting == 5 && fp->maxpacksize == 392)
206 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
208 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
209 chip->usb_id == USB_ID(0x041e, 0x4068)))
212 fp->rate_table[fp->nr_rates] = rate;
213 if (!fp->rate_min || rate < fp->rate_min)
215 if (!fp->rate_max || rate > fp->rate_max)
217 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
221 hwc_debug("All rates were zero. Skipping format!\n");
225 /* continuous rates */
226 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
227 fp->rate_min = combine_triple(&fmt[offset + 1]);
228 fp->rate_max = combine_triple(&fmt[offset + 4]);
234 * Many Focusrite devices supports a limited set of sampling rates per
235 * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
236 * descriptor which has a non-standard bLength = 10.
238 static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
239 struct audioformat *fp,
242 struct usb_interface *iface;
243 struct usb_host_interface *alts;
245 unsigned int max_rate;
247 iface = usb_ifnum_to_if(chip->dev, fp->iface);
251 alts = &iface->altsetting[fp->altset_idx];
252 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
253 NULL, UAC_FORMAT_TYPE);
257 if (fmt[0] == 10) { /* bLength */
258 max_rate = combine_quad(&fmt[6]);
260 /* Validate max rate */
261 if (max_rate != 48000 &&
263 max_rate != 192000 &&
264 max_rate != 384000) {
267 "%u:%d : unexpected max rate: %u\n",
268 fp->iface, fp->altsetting, max_rate);
273 return rate <= max_rate;
280 * Helper function to walk the array of sample rate triplets reported by
281 * the device. The problem is that we need to parse whole array first to
282 * get to know how many sample rates we have to expect.
283 * Then fp->rate_table can be allocated and filled.
285 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
286 struct audioformat *fp, int nr_triplets,
287 const unsigned char *data)
291 fp->rates = fp->rate_min = fp->rate_max = 0;
293 for (i = 0; i < nr_triplets; i++) {
294 int min = combine_quad(&data[2 + 12 * i]);
295 int max = combine_quad(&data[6 + 12 * i]);
296 int res = combine_quad(&data[10 + 12 * i]);
299 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
303 * for ranges with res == 1, we announce a continuous sample
304 * rate range, and this function should return 0 for no further
310 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
314 for (rate = min; rate <= max; rate += res) {
315 /* Filter out invalid rates on Focusrite devices */
316 if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
317 !focusrite_valid_sample_rate(chip, fp, rate))
321 fp->rate_table[nr_rates] = rate;
322 if (!fp->rate_min || rate < fp->rate_min)
324 if (!fp->rate_max || rate > fp->rate_max)
326 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
329 if (nr_rates >= MAX_NR_RATES) {
330 usb_audio_err(chip, "invalid uac2 rates\n");
335 /* avoid endless loop */
344 /* Line6 Helix series don't support the UAC2_CS_RANGE usb function
345 * call. Return a static table of known clock rates.
347 static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
348 struct audioformat *fp)
350 switch (chip->usb_id) {
351 case USB_ID(0x0E41, 0x4241): /* Line6 Helix */
352 case USB_ID(0x0E41, 0x4242): /* Line6 Helix Rack */
353 case USB_ID(0x0E41, 0x4244): /* Line6 Helix LT */
354 case USB_ID(0x0E41, 0x4246): /* Line6 HX-Stomp */
355 case USB_ID(0x0E41, 0x4248): /* Line6 Helix >= fw 2.82 */
356 case USB_ID(0x0E41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
357 case USB_ID(0x0E41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
358 /* supported rates: 48Khz */
359 kfree(fp->rate_table);
360 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
364 fp->rate_min = 48000;
365 fp->rate_max = 48000;
366 fp->rates = SNDRV_PCM_RATE_48000;
367 fp->rate_table[0] = 48000;
375 * parse the format descriptor and stores the possible sample rates
376 * on the audioformat table (audio class v2 and v3).
378 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
379 struct audioformat *fp)
381 struct usb_device *dev = chip->dev;
382 unsigned char tmp[2], *data;
383 int nr_triplets, data_size, ret = 0, ret_l6;
384 int clock = snd_usb_clock_find_source(chip, fp, false);
388 "%s(): unable to find clock source (clock %d)\n",
393 /* get the number of sample rates first by only fetching 2 bytes */
394 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
395 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
396 UAC2_CS_CONTROL_SAM_FREQ << 8,
397 snd_usb_ctrl_intf(chip) | (clock << 8),
401 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
402 ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
403 if (ret_l6 == -ENODEV) {
404 /* no line6 device found continue showing the error */
406 "%s(): unable to retrieve number of sample rates (clock %d)\n",
412 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
420 nr_triplets = (tmp[1] << 8) | tmp[0];
421 data_size = 2 + 12 * nr_triplets;
422 data = kzalloc(data_size, GFP_KERNEL);
428 /* now get the full information */
429 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
430 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
431 UAC2_CS_CONTROL_SAM_FREQ << 8,
432 snd_usb_ctrl_intf(chip) | (clock << 8),
437 "%s(): unable to retrieve sample rate range (clock %d)\n",
443 /* Call the triplet parser, and make sure fp->rate_table is NULL.
444 * We just use the return value to know how many sample rates we
445 * will have to deal with. */
446 kfree(fp->rate_table);
447 fp->rate_table = NULL;
448 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
450 if (fp->nr_rates == 0) {
451 /* SNDRV_PCM_RATE_CONTINUOUS */
456 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
457 if (!fp->rate_table) {
462 /* Call the triplet parser again, but this time, fp->rate_table is
463 * allocated, so the rates will be stored */
464 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
473 * parse the format type I and III descriptors
475 static int parse_audio_format_i(struct snd_usb_audio *chip,
476 struct audioformat *fp, u64 format,
479 snd_pcm_format_t pcm_format;
480 unsigned int fmt_type;
483 switch (fp->protocol) {
486 case UAC_VERSION_2: {
487 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
489 fmt_type = fmt->bFormatType;
492 case UAC_VERSION_3: {
493 /* fp->fmt_type is already set in this case */
494 fmt_type = fp->fmt_type;
499 if (fmt_type == UAC_FORMAT_TYPE_III) {
500 /* FIXME: the format type is really IECxxx
501 * but we give normal PCM format to get the existing
504 switch (chip->usb_id) {
506 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
507 if (chip->setup == 0x00 &&
509 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
511 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
514 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
516 fp->formats = pcm_format_to_bits(pcm_format);
518 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
523 /* gather possible sample rates */
524 /* audio class v1 reports possible sample rates as part of the
525 * proprietary class specific descriptor.
526 * audio class v2 uses class specific EP0 range requests for that.
528 switch (fp->protocol) {
530 case UAC_VERSION_1: {
531 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
533 fp->channels = fmt->bNrChannels;
534 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
538 case UAC_VERSION_3: {
539 /* fp->channels is already set in this case */
540 ret = parse_audio_format_rates_v2v3(chip, fp);
545 if (fp->channels < 1) {
547 "%u:%d : invalid channels %d\n",
548 fp->iface, fp->altsetting, fp->channels);
556 * parse the format type II descriptor
558 static int parse_audio_format_ii(struct snd_usb_audio *chip,
559 struct audioformat *fp,
560 u64 format, void *_fmt)
562 int brate, framesize, ret;
565 case UAC_FORMAT_TYPE_II_AC3:
566 /* FIXME: there is no AC3 format defined yet */
567 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
568 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
570 case UAC_FORMAT_TYPE_II_MPEG:
571 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
575 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
576 fp->iface, fp->altsetting, format);
577 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
583 switch (fp->protocol) {
585 case UAC_VERSION_1: {
586 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
587 brate = le16_to_cpu(fmt->wMaxBitRate);
588 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
589 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
590 fp->frame_size = framesize;
591 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
594 case UAC_VERSION_2: {
595 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
596 brate = le16_to_cpu(fmt->wMaxBitRate);
597 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
598 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
599 fp->frame_size = framesize;
600 ret = parse_audio_format_rates_v2v3(chip, fp);
608 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
609 struct audioformat *fp, u64 format,
610 struct uac_format_type_i_continuous_descriptor *fmt,
615 switch (fmt->bFormatType) {
616 case UAC_FORMAT_TYPE_I:
617 case UAC_FORMAT_TYPE_III:
618 err = parse_audio_format_i(chip, fp, format, fmt);
620 case UAC_FORMAT_TYPE_II:
621 err = parse_audio_format_ii(chip, fp, format, fmt);
625 "%u:%d : format type %d is not supported yet\n",
626 fp->iface, fp->altsetting,
630 fp->fmt_type = fmt->bFormatType;
634 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
635 /* extigy apparently supports sample rates other than 48k
636 * but not in ordinary way. so we enable only 48k atm.
638 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
639 chip->usb_id == USB_ID(0x041e, 0x3020) ||
640 chip->usb_id == USB_ID(0x041e, 0x3061)) {
641 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
642 fp->rates != SNDRV_PCM_RATE_48000 &&
643 fp->rates != SNDRV_PCM_RATE_96000)
650 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
651 struct audioformat *fp,
652 struct uac3_as_header_descriptor *as,
655 u64 format = le64_to_cpu(as->bmFormats);
659 * Type I format bits are D0..D6
660 * This test works because type IV is not supported
663 fp->fmt_type = UAC_FORMAT_TYPE_I;
665 fp->fmt_type = UAC_FORMAT_TYPE_III;
667 err = parse_audio_format_i(chip, fp, format, as);