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 * Helper function to walk the array of sample rate triplets reported by
282 * the device. The problem is that we need to parse whole array first to
283 * get to know how many sample rates we have to expect.
284 * Then fp->rate_table can be allocated and filled.
286 static int parse_uac2_sample_rate_range(struct snd_usb_audio
*chip
,
287 struct audioformat
*fp
, int nr_triplets
,
288 const unsigned char *data
)
292 fp
->rates
= fp
->rate_min
= fp
->rate_max
= 0;
294 for (i
= 0; i
< nr_triplets
; i
++) {
295 int min
= combine_quad(&data
[2 + 12 * i
]);
296 int max
= combine_quad(&data
[6 + 12 * i
]);
297 int res
= combine_quad(&data
[10 + 12 * i
]);
300 if ((max
< 0) || (min
< 0) || (res
< 0) || (max
< min
))
304 * for ranges with res == 1, we announce a continuous sample
305 * rate range, and this function should return 0 for no further
311 fp
->rates
= SNDRV_PCM_RATE_CONTINUOUS
;
315 for (rate
= min
; rate
<= max
; rate
+= res
) {
317 /* Filter out invalid rates on Presonus Studio 1810c */
318 if (chip
->usb_id
== USB_ID(0x0194f, 0x010c) &&
319 !s1810c_valid_sample_rate(fp
, rate
))
323 fp
->rate_table
[nr_rates
] = rate
;
324 if (!fp
->rate_min
|| rate
< fp
->rate_min
)
326 if (!fp
->rate_max
|| rate
> fp
->rate_max
)
328 fp
->rates
|= snd_pcm_rate_to_rate_bit(rate
);
331 if (nr_rates
>= MAX_NR_RATES
) {
332 usb_audio_err(chip
, "invalid uac2 rates\n");
337 /* avoid endless loop */
346 /* Line6 Helix series don't support the UAC2_CS_RANGE usb function
347 * call. Return a static table of known clock rates.
349 static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio
*chip
,
350 struct audioformat
*fp
)
352 switch (chip
->usb_id
) {
353 case USB_ID(0x0e41, 0x4241): /* Line6 Helix */
354 case USB_ID(0x0e41, 0x4242): /* Line6 Helix Rack */
355 case USB_ID(0x0e41, 0x4244): /* Line6 Helix LT */
356 case USB_ID(0x0e41, 0x4246): /* Line6 HX-Stomp */
357 case USB_ID(0x0e41, 0x4248): /* Line6 Helix >= fw 2.82 */
358 case USB_ID(0x0e41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
359 case USB_ID(0x0e41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
360 return set_fixed_rate(fp
, 48000, SNDRV_PCM_RATE_48000
);
367 * parse the format descriptor and stores the possible sample rates
368 * on the audioformat table (audio class v2 and v3).
370 static int parse_audio_format_rates_v2v3(struct snd_usb_audio
*chip
,
371 struct audioformat
*fp
)
373 struct usb_device
*dev
= chip
->dev
;
374 unsigned char tmp
[2], *data
;
375 int nr_triplets
, data_size
, ret
= 0, ret_l6
;
376 int clock
= snd_usb_clock_find_source(chip
, fp
, false);
380 "%s(): unable to find clock source (clock %d)\n",
385 /* get the number of sample rates first by only fetching 2 bytes */
386 ret
= snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), UAC2_CS_RANGE
,
387 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
| USB_DIR_IN
,
388 UAC2_CS_CONTROL_SAM_FREQ
<< 8,
389 snd_usb_ctrl_intf(chip
) | (clock
<< 8),
393 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
394 ret_l6
= line6_parse_audio_format_rates_quirk(chip
, fp
);
395 if (ret_l6
== -ENODEV
) {
396 /* no line6 device found continue showing the error */
398 "%s(): unable to retrieve number of sample rates (clock %d)\n",
404 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
412 nr_triplets
= (tmp
[1] << 8) | tmp
[0];
413 data_size
= 2 + 12 * nr_triplets
;
414 data
= kzalloc(data_size
, GFP_KERNEL
);
420 /* now get the full information */
421 ret
= snd_usb_ctl_msg(dev
, usb_rcvctrlpipe(dev
, 0), UAC2_CS_RANGE
,
422 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
| USB_DIR_IN
,
423 UAC2_CS_CONTROL_SAM_FREQ
<< 8,
424 snd_usb_ctrl_intf(chip
) | (clock
<< 8),
429 "%s(): unable to retrieve sample rate range (clock %d)\n",
435 /* Call the triplet parser, and make sure fp->rate_table is NULL.
436 * We just use the return value to know how many sample rates we
437 * will have to deal with. */
438 kfree(fp
->rate_table
);
439 fp
->rate_table
= NULL
;
440 fp
->nr_rates
= parse_uac2_sample_rate_range(chip
, fp
, nr_triplets
, data
);
442 if (fp
->nr_rates
== 0) {
443 /* SNDRV_PCM_RATE_CONTINUOUS */
448 fp
->rate_table
= kmalloc_array(fp
->nr_rates
, sizeof(int), GFP_KERNEL
);
449 if (!fp
->rate_table
) {
454 /* Call the triplet parser again, but this time, fp->rate_table is
455 * allocated, so the rates will be stored */
456 parse_uac2_sample_rate_range(chip
, fp
, nr_triplets
, data
);
465 * parse the format type I and III descriptors
467 static int parse_audio_format_i(struct snd_usb_audio
*chip
,
468 struct audioformat
*fp
, u64 format
,
471 snd_pcm_format_t pcm_format
;
472 unsigned int fmt_type
;
475 switch (fp
->protocol
) {
478 case UAC_VERSION_2
: {
479 struct uac_format_type_i_continuous_descriptor
*fmt
= _fmt
;
481 fmt_type
= fmt
->bFormatType
;
484 case UAC_VERSION_3
: {
485 /* fp->fmt_type is already set in this case */
486 fmt_type
= fp
->fmt_type
;
491 if (fmt_type
== UAC_FORMAT_TYPE_III
) {
492 /* FIXME: the format type is really IECxxx
493 * but we give normal PCM format to get the existing
496 switch (chip
->usb_id
) {
498 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
499 if (chip
->setup
== 0x00 &&
501 pcm_format
= SNDRV_PCM_FORMAT_S16_BE
;
503 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
506 pcm_format
= SNDRV_PCM_FORMAT_S16_LE
;
508 fp
->formats
= pcm_format_to_bits(pcm_format
);
510 fp
->formats
= parse_audio_format_i_type(chip
, fp
, format
, _fmt
);
515 /* gather possible sample rates */
516 /* audio class v1 reports possible sample rates as part of the
517 * proprietary class specific descriptor.
518 * audio class v2 uses class specific EP0 range requests for that.
520 switch (fp
->protocol
) {
522 case UAC_VERSION_1
: {
523 struct uac_format_type_i_continuous_descriptor
*fmt
= _fmt
;
525 fp
->channels
= fmt
->bNrChannels
;
526 ret
= parse_audio_format_rates_v1(chip
, fp
, (unsigned char *) fmt
, 7);
530 case UAC_VERSION_3
: {
531 /* fp->channels is already set in this case */
532 ret
= parse_audio_format_rates_v2v3(chip
, fp
);
537 if (fp
->channels
< 1) {
539 "%u:%d : invalid channels %d\n",
540 fp
->iface
, fp
->altsetting
, fp
->channels
);
548 * parse the format type II descriptor
550 static int parse_audio_format_ii(struct snd_usb_audio
*chip
,
551 struct audioformat
*fp
,
552 u64 format
, void *_fmt
)
554 int brate
, framesize
, ret
;
557 case UAC_FORMAT_TYPE_II_AC3
:
558 /* FIXME: there is no AC3 format defined yet */
559 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
560 fp
->formats
= SNDRV_PCM_FMTBIT_U8
; /* temporary hack to receive byte streams */
562 case UAC_FORMAT_TYPE_II_MPEG
:
563 fp
->formats
= SNDRV_PCM_FMTBIT_MPEG
;
567 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
568 fp
->iface
, fp
->altsetting
, format
);
569 fp
->formats
= SNDRV_PCM_FMTBIT_MPEG
;
575 switch (fp
->protocol
) {
577 case UAC_VERSION_1
: {
578 struct uac_format_type_ii_discrete_descriptor
*fmt
= _fmt
;
579 brate
= le16_to_cpu(fmt
->wMaxBitRate
);
580 framesize
= le16_to_cpu(fmt
->wSamplesPerFrame
);
581 usb_audio_info(chip
, "found format II with max.bitrate = %d, frame size=%d\n", brate
, framesize
);
582 fp
->frame_size
= framesize
;
583 ret
= parse_audio_format_rates_v1(chip
, fp
, _fmt
, 8); /* fmt[8..] sample rates */
586 case UAC_VERSION_2
: {
587 struct uac_format_type_ii_ext_descriptor
*fmt
= _fmt
;
588 brate
= le16_to_cpu(fmt
->wMaxBitRate
);
589 framesize
= le16_to_cpu(fmt
->wSamplesPerFrame
);
590 usb_audio_info(chip
, "found format II with max.bitrate = %d, frame size=%d\n", brate
, framesize
);
591 fp
->frame_size
= framesize
;
592 ret
= parse_audio_format_rates_v2v3(chip
, fp
);
600 int snd_usb_parse_audio_format(struct snd_usb_audio
*chip
,
601 struct audioformat
*fp
, u64 format
,
602 struct uac_format_type_i_continuous_descriptor
*fmt
,
607 switch (fmt
->bFormatType
) {
608 case UAC_FORMAT_TYPE_I
:
609 case UAC_FORMAT_TYPE_III
:
610 err
= parse_audio_format_i(chip
, fp
, format
, fmt
);
612 case UAC_FORMAT_TYPE_II
:
613 err
= parse_audio_format_ii(chip
, fp
, format
, fmt
);
617 "%u:%d : format type %d is not supported yet\n",
618 fp
->iface
, fp
->altsetting
,
622 fp
->fmt_type
= fmt
->bFormatType
;
626 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
627 /* extigy apparently supports sample rates other than 48k
628 * but not in ordinary way. so we enable only 48k atm.
630 if (chip
->usb_id
== USB_ID(0x041e, 0x3000) ||
631 chip
->usb_id
== USB_ID(0x041e, 0x3020) ||
632 chip
->usb_id
== USB_ID(0x041e, 0x3061)) {
633 if (fmt
->bFormatType
== UAC_FORMAT_TYPE_I
&&
634 fp
->rates
!= SNDRV_PCM_RATE_48000
&&
635 fp
->rates
!= SNDRV_PCM_RATE_96000
)
642 int snd_usb_parse_audio_format_v3(struct snd_usb_audio
*chip
,
643 struct audioformat
*fp
,
644 struct uac3_as_header_descriptor
*as
,
647 u64 format
= le64_to_cpu(as
->bmFormats
);
651 * Type I format bits are D0..D6
652 * This test works because type IV is not supported
655 fp
->fmt_type
= UAC_FORMAT_TYPE_I
;
657 fp
->fmt_type
= UAC_FORMAT_TYPE_III
;
659 err
= parse_audio_format_i(chip
, fp
, format
, as
);