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;
45 "%u:%d: invalid format type 0x%llx is detected, processed as PCM\n",
46 fp->iface, fp->altsetting, format);
47 format = UAC_FORMAT_TYPE_I_PCM;
49 sample_width = fmt->bBitResolution;
50 sample_bytes = fmt->bSubframeSize;
51 format = 1ULL << format;
56 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
57 sample_width = fmt->bBitResolution;
58 sample_bytes = fmt->bSubslotSize;
60 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
61 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
62 /* flag potentially raw DSD capable altsettings */
70 struct uac3_as_header_descriptor *as = _fmt;
72 sample_width = as->bBitResolution;
73 sample_bytes = as->bSubslotSize;
75 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
76 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
83 fp->fmt_bits = sample_width;
85 if ((pcm_formats == 0) &&
86 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
87 /* some devices don't define this correctly... */
88 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
89 fp->iface, fp->altsetting);
90 format = 1 << UAC_FORMAT_TYPE_I_PCM;
92 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
93 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
95 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
97 sample_width == 24 && sample_bytes == 2)
99 else if (sample_width > sample_bytes * 8) {
100 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
101 fp->iface, fp->altsetting,
102 sample_width, sample_bytes);
104 /* check the format byte size */
105 switch (sample_bytes) {
107 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
110 if (snd_usb_is_big_endian_format(chip, fp))
111 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
113 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
116 if (snd_usb_is_big_endian_format(chip, fp))
117 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
119 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
122 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
126 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
127 fp->iface, fp->altsetting,
128 sample_width, sample_bytes);
132 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
133 /* Dallas DS4201 workaround: it advertises U8 format, but really
135 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
136 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
138 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
140 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
141 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
143 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
144 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
146 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
147 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
149 if (format & ~0x3f) {
151 "%u:%d : unsupported format bits %#llx\n",
152 fp->iface, fp->altsetting, format);
155 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
162 * parse the format descriptor and stores the possible sample rates
163 * on the audioformat table (audio class v1).
166 * @fp: audioformat record
167 * @fmt: the format descriptor
168 * @offset: the start offset of descriptor pointing the rate type
169 * (7 for type I and II, 8 for type II)
171 static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
172 unsigned char *fmt, int offset)
174 int nr_rates = fmt[offset];
176 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
178 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
179 fp->iface, fp->altsetting);
185 * build the rate table and bitmap flags
189 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
191 if (fp->rate_table == NULL)
195 fp->rate_min = fp->rate_max = 0;
196 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
197 unsigned int rate = combine_triple(&fmt[idx]);
200 /* C-Media CM6501 mislabels its 96 kHz altsetting */
201 /* Terratec Aureon 7.1 USB C-Media 6206, too */
202 /* Ozone Z90 USB C-Media, too */
203 if (rate == 48000 && nr_rates == 1 &&
204 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
205 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
206 chip->usb_id == USB_ID(0x0d8c, 0x0078) ||
207 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
208 fp->altsetting == 5 && fp->maxpacksize == 392)
210 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
212 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
213 chip->usb_id == USB_ID(0x041e, 0x4068)))
216 fp->rate_table[fp->nr_rates] = rate;
217 if (!fp->rate_min || rate < fp->rate_min)
219 if (!fp->rate_max || rate > fp->rate_max)
221 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
225 hwc_debug("All rates were zero. Skipping format!\n");
229 /* continuous rates */
230 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
231 fp->rate_min = combine_triple(&fmt[offset + 1]);
232 fp->rate_max = combine_triple(&fmt[offset + 4]);
238 * Many Focusrite devices supports a limited set of sampling rates per
239 * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
240 * descriptor which has a non-standard bLength = 10.
242 static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
243 struct audioformat *fp,
246 struct usb_interface *iface;
247 struct usb_host_interface *alts;
249 unsigned int max_rate;
251 iface = usb_ifnum_to_if(chip->dev, fp->iface);
255 alts = &iface->altsetting[fp->altset_idx];
256 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
257 NULL, UAC_FORMAT_TYPE);
261 if (fmt[0] == 10) { /* bLength */
262 max_rate = combine_quad(&fmt[6]);
264 /* Validate max rate */
265 if (max_rate != 48000 &&
267 max_rate != 192000 &&
268 max_rate != 384000) {
271 "%u:%d : unexpected max rate: %u\n",
272 fp->iface, fp->altsetting, max_rate);
277 return rate <= max_rate;
284 * Helper function to walk the array of sample rate triplets reported by
285 * the device. The problem is that we need to parse whole array first to
286 * get to know how many sample rates we have to expect.
287 * Then fp->rate_table can be allocated and filled.
289 static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
290 struct audioformat *fp, int nr_triplets,
291 const unsigned char *data)
295 fp->rates = fp->rate_min = fp->rate_max = 0;
297 for (i = 0; i < nr_triplets; i++) {
298 int min = combine_quad(&data[2 + 12 * i]);
299 int max = combine_quad(&data[6 + 12 * i]);
300 int res = combine_quad(&data[10 + 12 * i]);
303 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
307 * for ranges with res == 1, we announce a continuous sample
308 * rate range, and this function should return 0 for no further
314 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
318 for (rate = min; rate <= max; rate += res) {
319 /* Filter out invalid rates on Focusrite devices */
320 if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
321 !focusrite_valid_sample_rate(chip, fp, rate))
325 fp->rate_table[nr_rates] = rate;
326 if (!fp->rate_min || rate < fp->rate_min)
328 if (!fp->rate_max || rate > fp->rate_max)
330 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
333 if (nr_rates >= MAX_NR_RATES) {
334 usb_audio_err(chip, "invalid uac2 rates\n");
339 /* avoid endless loop */
348 /* Line6 Helix series don't support the UAC2_CS_RANGE usb function
349 * call. Return a static table of known clock rates.
351 static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
352 struct audioformat *fp)
354 switch (chip->usb_id) {
355 case USB_ID(0x0E41, 0x4241): /* Line6 Helix */
356 case USB_ID(0x0E41, 0x4242): /* Line6 Helix Rack */
357 case USB_ID(0x0E41, 0x4244): /* Line6 Helix LT */
358 case USB_ID(0x0E41, 0x4246): /* Line6 HX-Stomp */
359 case USB_ID(0x0E41, 0x4248): /* Line6 Helix >= fw 2.82 */
360 case USB_ID(0x0E41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
361 case USB_ID(0x0E41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
362 /* supported rates: 48Khz */
363 kfree(fp->rate_table);
364 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
368 fp->rate_min = 48000;
369 fp->rate_max = 48000;
370 fp->rates = SNDRV_PCM_RATE_48000;
371 fp->rate_table[0] = 48000;
379 * parse the format descriptor and stores the possible sample rates
380 * on the audioformat table (audio class v2 and v3).
382 static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
383 struct audioformat *fp)
385 struct usb_device *dev = chip->dev;
386 unsigned char tmp[2], *data;
387 int nr_triplets, data_size, ret = 0, ret_l6;
388 int clock = snd_usb_clock_find_source(chip, fp, false);
392 "%s(): unable to find clock source (clock %d)\n",
397 /* get the number of sample rates first by only fetching 2 bytes */
398 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
399 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
400 UAC2_CS_CONTROL_SAM_FREQ << 8,
401 snd_usb_ctrl_intf(chip) | (clock << 8),
405 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
406 ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
407 if (ret_l6 == -ENODEV) {
408 /* no line6 device found continue showing the error */
410 "%s(): unable to retrieve number of sample rates (clock %d)\n",
416 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
424 nr_triplets = (tmp[1] << 8) | tmp[0];
425 data_size = 2 + 12 * nr_triplets;
426 data = kzalloc(data_size, GFP_KERNEL);
432 /* now get the full information */
433 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
434 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
435 UAC2_CS_CONTROL_SAM_FREQ << 8,
436 snd_usb_ctrl_intf(chip) | (clock << 8),
441 "%s(): unable to retrieve sample rate range (clock %d)\n",
447 /* Call the triplet parser, and make sure fp->rate_table is NULL.
448 * We just use the return value to know how many sample rates we
449 * will have to deal with. */
450 kfree(fp->rate_table);
451 fp->rate_table = NULL;
452 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
454 if (fp->nr_rates == 0) {
455 /* SNDRV_PCM_RATE_CONTINUOUS */
460 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
461 if (!fp->rate_table) {
466 /* Call the triplet parser again, but this time, fp->rate_table is
467 * allocated, so the rates will be stored */
468 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
477 * parse the format type I and III descriptors
479 static int parse_audio_format_i(struct snd_usb_audio *chip,
480 struct audioformat *fp, u64 format,
483 snd_pcm_format_t pcm_format;
484 unsigned int fmt_type;
487 switch (fp->protocol) {
490 case UAC_VERSION_2: {
491 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
493 fmt_type = fmt->bFormatType;
496 case UAC_VERSION_3: {
497 /* fp->fmt_type is already set in this case */
498 fmt_type = fp->fmt_type;
503 if (fmt_type == UAC_FORMAT_TYPE_III) {
504 /* FIXME: the format type is really IECxxx
505 * but we give normal PCM format to get the existing
508 switch (chip->usb_id) {
510 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
511 if (chip->setup == 0x00 &&
513 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
515 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
518 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
520 fp->formats = pcm_format_to_bits(pcm_format);
522 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
527 /* gather possible sample rates */
528 /* audio class v1 reports possible sample rates as part of the
529 * proprietary class specific descriptor.
530 * audio class v2 uses class specific EP0 range requests for that.
532 switch (fp->protocol) {
534 case UAC_VERSION_1: {
535 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
537 fp->channels = fmt->bNrChannels;
538 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
542 case UAC_VERSION_3: {
543 /* fp->channels is already set in this case */
544 ret = parse_audio_format_rates_v2v3(chip, fp);
549 if (fp->channels < 1) {
551 "%u:%d : invalid channels %d\n",
552 fp->iface, fp->altsetting, fp->channels);
560 * parse the format type II descriptor
562 static int parse_audio_format_ii(struct snd_usb_audio *chip,
563 struct audioformat *fp,
564 u64 format, void *_fmt)
566 int brate, framesize, ret;
569 case UAC_FORMAT_TYPE_II_AC3:
570 /* FIXME: there is no AC3 format defined yet */
571 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
572 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
574 case UAC_FORMAT_TYPE_II_MPEG:
575 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
579 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
580 fp->iface, fp->altsetting, format);
581 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
587 switch (fp->protocol) {
589 case UAC_VERSION_1: {
590 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
591 brate = le16_to_cpu(fmt->wMaxBitRate);
592 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
593 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
594 fp->frame_size = framesize;
595 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
598 case UAC_VERSION_2: {
599 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
600 brate = le16_to_cpu(fmt->wMaxBitRate);
601 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
602 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
603 fp->frame_size = framesize;
604 ret = parse_audio_format_rates_v2v3(chip, fp);
612 int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
613 struct audioformat *fp, u64 format,
614 struct uac_format_type_i_continuous_descriptor *fmt,
619 switch (fmt->bFormatType) {
620 case UAC_FORMAT_TYPE_I:
621 case UAC_FORMAT_TYPE_III:
622 err = parse_audio_format_i(chip, fp, format, fmt);
624 case UAC_FORMAT_TYPE_II:
625 err = parse_audio_format_ii(chip, fp, format, fmt);
629 "%u:%d : format type %d is not supported yet\n",
630 fp->iface, fp->altsetting,
634 fp->fmt_type = fmt->bFormatType;
638 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
639 /* extigy apparently supports sample rates other than 48k
640 * but not in ordinary way. so we enable only 48k atm.
642 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
643 chip->usb_id == USB_ID(0x041e, 0x3020) ||
644 chip->usb_id == USB_ID(0x041e, 0x3061)) {
645 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
646 fp->rates != SNDRV_PCM_RATE_48000 &&
647 fp->rates != SNDRV_PCM_RATE_96000)
654 int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
655 struct audioformat *fp,
656 struct uac3_as_header_descriptor *as,
659 u64 format = le64_to_cpu(as->bmFormats);
663 * Type I format bits are D0..D6
664 * This test works because type IV is not supported
667 fp->fmt_type = UAC_FORMAT_TYPE_I;
669 fp->fmt_type = UAC_FORMAT_TYPE_III;
671 err = parse_audio_format_i(chip, fp, format, as);