Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 */
4
5#include <linux/init.h>
6#include <linux/slab.h>
7#include <linux/usb.h>
8#include <linux/usb/audio.h>
9#include <linux/usb/audio-v2.h>
10#include <linux/usb/audio-v3.h>
11
12#include <sound/core.h>
13#include <sound/pcm.h>
14
15#include "usbaudio.h"
16#include "card.h"
17#include "quirks.h"
18#include "helper.h"
19#include "debug.h"
20#include "clock.h"
21#include "format.h"
22
23/*
24 * parse the audio format type I descriptor
25 * and returns the corresponding pcm format
26 *
27 * @dev: usb device
28 * @fp: audioformat record
29 * @format: the format tag (wFormatTag)
30 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
31 */
32static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
33 struct audioformat *fp,
34 u64 format, void *_fmt)
35{
36 int sample_width, sample_bytes;
37 u64 pcm_formats = 0;
38
39 switch (fp->protocol) {
40 case UAC_VERSION_1:
41 default: {
42 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
43 sample_width = fmt->bBitResolution;
44 sample_bytes = fmt->bSubframeSize;
45 format = 1ULL << format;
46 break;
47 }
48
49 case UAC_VERSION_2: {
50 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
51 sample_width = fmt->bBitResolution;
52 sample_bytes = fmt->bSubslotSize;
53
54 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
55 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
56 /* flag potentially raw DSD capable altsettings */
57 fp->dsd_raw = true;
58 }
59
60 format <<= 1;
61 break;
62 }
63 case UAC_VERSION_3: {
64 struct uac3_as_header_descriptor *as = _fmt;
65
66 sample_width = as->bBitResolution;
67 sample_bytes = as->bSubslotSize;
68
69 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
70 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
71
72 format <<= 1;
73 break;
74 }
75 }
76
77 fp->fmt_bits = sample_width;
78
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;
85 }
86 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
87 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
88 /* Edirol SD-90 */
89 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
90 /* Roland SC-D70 */
91 sample_width == 24 && sample_bytes == 2)
92 sample_bytes = 3;
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);
97 }
98 /* check the format byte size */
99 switch (sample_bytes) {
100 case 1:
101 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
102 break;
103 case 2:
104 if (snd_usb_is_big_endian_format(chip, fp))
105 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
106 else
107 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
108 break;
109 case 3:
110 if (snd_usb_is_big_endian_format(chip, fp))
111 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
112 else
113 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
114 break;
115 case 4:
116 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
117 break;
118 default:
119 usb_audio_info(chip,
120 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
121 fp->iface, fp->altsetting,
122 sample_width, sample_bytes);
123 break;
124 }
125 }
126 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
127 /* Dallas DS4201 workaround: it advertises U8 format, but really
128 supports S8. */
129 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
130 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
131 else
132 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
133 }
134 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
135 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
136 }
137 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
138 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
139 }
140 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
141 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
142 }
143 if (format & ~0x3f) {
144 usb_audio_info(chip,
145 "%u:%d : unsupported format bits %#llx\n",
146 fp->iface, fp->altsetting, format);
147 }
148
149 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
150
151 return pcm_formats;
152}
153
154static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
155{
156 kfree(fp->rate_table);
157 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
158 if (!fp->rate_table)
159 return -ENOMEM;
160 fp->nr_rates = 1;
161 fp->rate_min = rate;
162 fp->rate_max = rate;
163 fp->rates = rate_bits;
164 fp->rate_table[0] = rate;
165 return 0;
166}
167
168/*
169 * parse the format descriptor and stores the possible sample rates
170 * on the audioformat table (audio class v1).
171 *
172 * @dev: usb device
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)
177 */
178static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
179 unsigned char *fmt, int offset)
180{
181 int nr_rates = fmt[offset];
182
183 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
184 usb_audio_err(chip,
185 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
186 fp->iface, fp->altsetting);
187 return -EINVAL;
188 }
189
190 if (nr_rates) {
191 /*
192 * build the rate table and bitmap flags
193 */
194 int r, idx;
195
196 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
197 GFP_KERNEL);
198 if (fp->rate_table == NULL)
199 return -ENOMEM;
200
201 fp->nr_rates = 0;
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]);
205 if (!rate)
206 continue;
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)
214 rate = 96000;
215 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
216 if (rate == 16000 &&
217 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
218 chip->usb_id == USB_ID(0x041e, 0x4068)))
219 rate = 8000;
220
221 fp->rate_table[fp->nr_rates] = rate;
222 if (!fp->rate_min || rate < fp->rate_min)
223 fp->rate_min = rate;
224 if (!fp->rate_max || rate > fp->rate_max)
225 fp->rate_max = rate;
226 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
227 fp->nr_rates++;
228 }
229 if (!fp->nr_rates) {
230 hwc_debug("All rates were zero. Skipping format!\n");
231 return -EINVAL;
232 }
233 } else {
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]);
238 }
239
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);
245 }
246
247 return 0;
248}
249
250
251/*
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.
257 *
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.
260 */
261static bool s1810c_valid_sample_rate(struct audioformat *fp,
262 unsigned int rate)
263{
264 switch (fp->altsetting) {
265 case 1:
266 /* All ADAT ports available */
267 return rate <= 48000;
268 case 2:
269 /* Half of ADAT ports available */
270 return (rate == 88200 || rate == 96000);
271 case 3:
272 /* Analog I/O only (no S/PDIF nor ADAT) */
273 return rate >= 176400;
274 default:
275 return false;
276 }
277 return false;
278}
279
280/*
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.
284 */
285static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
286 struct audioformat *fp,
287 unsigned int rate)
288{
289 struct usb_interface *iface;
290 struct usb_host_interface *alts;
291 unsigned char *fmt;
292 unsigned int max_rate;
293
294 iface = usb_ifnum_to_if(chip->dev, fp->iface);
295 if (!iface)
296 return true;
297
298 alts = &iface->altsetting[fp->altset_idx];
299 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
300 NULL, UAC_FORMAT_TYPE);
301 if (!fmt)
302 return true;
303
304 if (fmt[0] == 10) { /* bLength */
305 max_rate = combine_quad(&fmt[6]);
306
307 /* Validate max rate */
308 if (max_rate != 48000 &&
309 max_rate != 96000 &&
310 max_rate != 192000 &&
311 max_rate != 384000) {
312
313 usb_audio_info(chip,
314 "%u:%d : unexpected max rate: %u\n",
315 fp->iface, fp->altsetting, max_rate);
316
317 return true;
318 }
319
320 return rate <= max_rate;
321 }
322
323 return true;
324}
325
326/*
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.
331 */
332static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
333 struct audioformat *fp, int nr_triplets,
334 const unsigned char *data)
335{
336 int i, nr_rates = 0;
337
338 fp->rates = fp->rate_min = fp->rate_max = 0;
339
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]);
344 unsigned int rate;
345
346 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
347 continue;
348
349 /*
350 * for ranges with res == 1, we announce a continuous sample
351 * rate range, and this function should return 0 for no further
352 * parsing.
353 */
354 if (res == 1) {
355 fp->rate_min = min;
356 fp->rate_max = max;
357 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
358 return 0;
359 }
360
361 for (rate = min; rate <= max; rate += res) {
362
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))
366 goto skip_rate;
367
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))
371 goto skip_rate;
372
373 if (fp->rate_table)
374 fp->rate_table[nr_rates] = rate;
375 if (!fp->rate_min || rate < fp->rate_min)
376 fp->rate_min = rate;
377 if (!fp->rate_max || rate > fp->rate_max)
378 fp->rate_max = rate;
379 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
380
381 nr_rates++;
382 if (nr_rates >= MAX_NR_RATES) {
383 usb_audio_err(chip, "invalid uac2 rates\n");
384 break;
385 }
386
387skip_rate:
388 /* avoid endless loop */
389 if (res == 0)
390 break;
391 }
392 }
393
394 return nr_rates;
395}
396
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
399 * clock rates.
400 */
401static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
402 struct audioformat *fp)
403{
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);
414 }
415
416 return -ENODEV;
417}
418
419/*
420 * parse the format descriptor and stores the possible sample rates
421 * on the audioformat table (audio class v2 and v3).
422 */
423static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
424 struct audioformat *fp)
425{
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);
430
431 if (clock < 0) {
432 dev_err(&dev->dev,
433 "%s(): unable to find clock source (clock %d)\n",
434 __func__, clock);
435 goto err;
436 }
437
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),
443 tmp, sizeof(tmp));
444
445 if (ret < 0) {
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 */
450 dev_err(&dev->dev,
451 "%s(): unable to retrieve number of sample rates (clock %d)\n",
452 __func__, clock);
453 goto err;
454 }
455 if (ret_l6 == 0) {
456 dev_info(&dev->dev,
457 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
458 __func__, clock);
459 return 0;
460 }
461 ret = ret_l6;
462 goto err;
463 }
464
465 nr_triplets = (tmp[1] << 8) | tmp[0];
466 data_size = 2 + 12 * nr_triplets;
467 data = kzalloc(data_size, GFP_KERNEL);
468 if (!data) {
469 ret = -ENOMEM;
470 goto err;
471 }
472
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),
478 data, data_size);
479
480 if (ret < 0) {
481 dev_err(&dev->dev,
482 "%s(): unable to retrieve sample rate range (clock %d)\n",
483 __func__, clock);
484 ret = -EINVAL;
485 goto err_free;
486 }
487
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);
494
495 if (fp->nr_rates == 0) {
496 /* SNDRV_PCM_RATE_CONTINUOUS */
497 ret = 0;
498 goto err_free;
499 }
500
501 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
502 if (!fp->rate_table) {
503 ret = -ENOMEM;
504 goto err_free;
505 }
506
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);
510
511err_free:
512 kfree(data);
513err:
514 return ret;
515}
516
517/*
518 * parse the format type I and III descriptors
519 */
520static int parse_audio_format_i(struct snd_usb_audio *chip,
521 struct audioformat *fp, u64 format,
522 void *_fmt)
523{
524 snd_pcm_format_t pcm_format;
525 unsigned int fmt_type;
526 int ret;
527
528 switch (fp->protocol) {
529 default:
530 case UAC_VERSION_1:
531 case UAC_VERSION_2: {
532 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
533
534 fmt_type = fmt->bFormatType;
535 break;
536 }
537 case UAC_VERSION_3: {
538 /* fp->fmt_type is already set in this case */
539 fmt_type = fp->fmt_type;
540 break;
541 }
542 }
543
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
547 * apps working...
548 */
549 switch (chip->usb_id) {
550
551 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
552 if (chip->setup == 0x00 &&
553 fp->altsetting == 6)
554 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
555 else
556 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
557 break;
558 default:
559 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
560 }
561 fp->formats = pcm_format_to_bits(pcm_format);
562 } else {
563 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
564 if (!fp->formats)
565 return -EINVAL;
566 }
567
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.
572 */
573 switch (fp->protocol) {
574 default:
575 case UAC_VERSION_1: {
576 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
577
578 fp->channels = fmt->bNrChannels;
579 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
580 break;
581 }
582 case UAC_VERSION_2:
583 case UAC_VERSION_3: {
584 /* fp->channels is already set in this case */
585 ret = parse_audio_format_rates_v2v3(chip, fp);
586 break;
587 }
588 }
589
590 if (fp->channels < 1) {
591 usb_audio_err(chip,
592 "%u:%d : invalid channels %d\n",
593 fp->iface, fp->altsetting, fp->channels);
594 return -EINVAL;
595 }
596
597 return ret;
598}
599
600/*
601 * parse the format type II descriptor
602 */
603static int parse_audio_format_ii(struct snd_usb_audio *chip,
604 struct audioformat *fp,
605 u64 format, void *_fmt)
606{
607 int brate, framesize, ret;
608
609 switch (format) {
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 */
614 break;
615 case UAC_FORMAT_TYPE_II_MPEG:
616 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
617 break;
618 default:
619 usb_audio_info(chip,
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;
623 break;
624 }
625
626 fp->channels = 1;
627
628 switch (fp->protocol) {
629 default:
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 */
637 break;
638 }
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);
646 break;
647 }
648 }
649
650 return ret;
651}
652
653int 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,
656 int stream)
657{
658 int err;
659
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);
664 break;
665 case UAC_FORMAT_TYPE_II:
666 err = parse_audio_format_ii(chip, fp, format, fmt);
667 break;
668 default:
669 usb_audio_info(chip,
670 "%u:%d : format type %d is not supported yet\n",
671 fp->iface, fp->altsetting,
672 fmt->bFormatType);
673 return -ENOTSUPP;
674 }
675 fp->fmt_type = fmt->bFormatType;
676 if (err < 0)
677 return err;
678#if 1
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.
682 */
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)
689 return -ENOTSUPP;
690 }
691#endif
692 return 0;
693}
694
695int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
696 struct audioformat *fp,
697 struct uac3_as_header_descriptor *as,
698 int stream)
699{
700 u64 format = le64_to_cpu(as->bmFormats);
701 int err;
702
703 /*
704 * Type I format bits are D0..D6
705 * This test works because type IV is not supported
706 */
707 if (format & 0x7f)
708 fp->fmt_type = UAC_FORMAT_TYPE_I;
709 else
710 fp->fmt_type = UAC_FORMAT_TYPE_III;
711
712 err = parse_audio_format_i(chip, fp, format, as);
713 if (err < 0)
714 return err;
715
716 return 0;
717}
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 *
16 */
17
18#include <linux/init.h>
19#include <linux/slab.h>
20#include <linux/usb.h>
21#include <linux/usb/audio.h>
22#include <linux/usb/audio-v2.h>
23
24#include <sound/core.h>
25#include <sound/pcm.h>
26
27#include "usbaudio.h"
28#include "card.h"
29#include "quirks.h"
30#include "helper.h"
31#include "debug.h"
32#include "clock.h"
33#include "format.h"
34
35/*
36 * parse the audio format type I descriptor
37 * and returns the corresponding pcm format
38 *
39 * @dev: usb device
40 * @fp: audioformat record
41 * @format: the format tag (wFormatTag)
42 * @fmt: the format type descriptor
43 */
44static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
45 struct audioformat *fp,
46 unsigned int format, void *_fmt)
47{
48 int sample_width, sample_bytes;
49 u64 pcm_formats = 0;
50
51 switch (fp->protocol) {
52 case UAC_VERSION_1:
53 default: {
54 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
55 sample_width = fmt->bBitResolution;
56 sample_bytes = fmt->bSubframeSize;
57 format = 1 << format;
58 break;
59 }
60
61 case UAC_VERSION_2: {
62 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
63 sample_width = fmt->bBitResolution;
64 sample_bytes = fmt->bSubslotSize;
65
66 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA)
67 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
68
69 format <<= 1;
70 break;
71 }
72 }
73
74 if ((pcm_formats == 0) &&
75 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
76 /* some devices don't define this correctly... */
77 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
78 fp->iface, fp->altsetting);
79 format = 1 << UAC_FORMAT_TYPE_I_PCM;
80 }
81 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
82 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
83 /* Edirol SD-90 */
84 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
85 /* Roland SC-D70 */
86 sample_width == 24 && sample_bytes == 2)
87 sample_bytes = 3;
88 else if (sample_width > sample_bytes * 8) {
89 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
90 fp->iface, fp->altsetting,
91 sample_width, sample_bytes);
92 }
93 /* check the format byte size */
94 switch (sample_bytes) {
95 case 1:
96 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
97 break;
98 case 2:
99 if (snd_usb_is_big_endian_format(chip, fp))
100 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
101 else
102 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
103 break;
104 case 3:
105 if (snd_usb_is_big_endian_format(chip, fp))
106 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
107 else
108 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
109 break;
110 case 4:
111 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
112 break;
113 default:
114 usb_audio_info(chip,
115 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
116 fp->iface, fp->altsetting,
117 sample_width, sample_bytes);
118 break;
119 }
120 }
121 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
122 /* Dallas DS4201 workaround: it advertises U8 format, but really
123 supports S8. */
124 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
125 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
126 else
127 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
128 }
129 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
130 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
131 }
132 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
133 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
134 }
135 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
136 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
137 }
138 if (format & ~0x3f) {
139 usb_audio_info(chip,
140 "%u:%d : unsupported format bits %#x\n",
141 fp->iface, fp->altsetting, format);
142 }
143
144 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
145
146 return pcm_formats;
147}
148
149
150/*
151 * parse the format descriptor and stores the possible sample rates
152 * on the audioformat table (audio class v1).
153 *
154 * @dev: usb device
155 * @fp: audioformat record
156 * @fmt: the format descriptor
157 * @offset: the start offset of descriptor pointing the rate type
158 * (7 for type I and II, 8 for type II)
159 */
160static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
161 unsigned char *fmt, int offset)
162{
163 int nr_rates = fmt[offset];
164
165 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
166 usb_audio_err(chip,
167 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
168 fp->iface, fp->altsetting);
169 return -EINVAL;
170 }
171
172 if (nr_rates) {
173 /*
174 * build the rate table and bitmap flags
175 */
176 int r, idx;
177
178 fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
179 if (fp->rate_table == NULL) {
180 usb_audio_err(chip, "cannot malloc\n");
181 return -ENOMEM;
182 }
183
184 fp->nr_rates = 0;
185 fp->rate_min = fp->rate_max = 0;
186 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
187 unsigned int rate = combine_triple(&fmt[idx]);
188 if (!rate)
189 continue;
190 /* C-Media CM6501 mislabels its 96 kHz altsetting */
191 /* Terratec Aureon 7.1 USB C-Media 6206, too */
192 if (rate == 48000 && nr_rates == 1 &&
193 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
194 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
195 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
196 fp->altsetting == 5 && fp->maxpacksize == 392)
197 rate = 96000;
198 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
199 if (rate == 16000 &&
200 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
201 chip->usb_id == USB_ID(0x041e, 0x4068)))
202 rate = 8000;
203
204 fp->rate_table[fp->nr_rates] = rate;
205 if (!fp->rate_min || rate < fp->rate_min)
206 fp->rate_min = rate;
207 if (!fp->rate_max || rate > fp->rate_max)
208 fp->rate_max = rate;
209 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
210 fp->nr_rates++;
211 }
212 if (!fp->nr_rates) {
213 hwc_debug("All rates were zero. Skipping format!\n");
214 return -EINVAL;
215 }
216 } else {
217 /* continuous rates */
218 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
219 fp->rate_min = combine_triple(&fmt[offset + 1]);
220 fp->rate_max = combine_triple(&fmt[offset + 4]);
221 }
222 return 0;
223}
224
225/*
226 * Helper function to walk the array of sample rate triplets reported by
227 * the device. The problem is that we need to parse whole array first to
228 * get to know how many sample rates we have to expect.
229 * Then fp->rate_table can be allocated and filled.
230 */
231static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
232 struct audioformat *fp, int nr_triplets,
233 const unsigned char *data)
234{
235 int i, nr_rates = 0;
236
237 fp->rates = fp->rate_min = fp->rate_max = 0;
238
239 for (i = 0; i < nr_triplets; i++) {
240 int min = combine_quad(&data[2 + 12 * i]);
241 int max = combine_quad(&data[6 + 12 * i]);
242 int res = combine_quad(&data[10 + 12 * i]);
243 unsigned int rate;
244
245 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
246 continue;
247
248 /*
249 * for ranges with res == 1, we announce a continuous sample
250 * rate range, and this function should return 0 for no further
251 * parsing.
252 */
253 if (res == 1) {
254 fp->rate_min = min;
255 fp->rate_max = max;
256 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
257 return 0;
258 }
259
260 for (rate = min; rate <= max; rate += res) {
261 if (fp->rate_table)
262 fp->rate_table[nr_rates] = rate;
263 if (!fp->rate_min || rate < fp->rate_min)
264 fp->rate_min = rate;
265 if (!fp->rate_max || rate > fp->rate_max)
266 fp->rate_max = rate;
267 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
268
269 nr_rates++;
270 if (nr_rates >= MAX_NR_RATES) {
271 usb_audio_err(chip, "invalid uac2 rates\n");
272 break;
273 }
274
275 /* avoid endless loop */
276 if (res == 0)
277 break;
278 }
279 }
280
281 return nr_rates;
282}
283
284/*
285 * parse the format descriptor and stores the possible sample rates
286 * on the audioformat table (audio class v2).
287 */
288static int parse_audio_format_rates_v2(struct snd_usb_audio *chip,
289 struct audioformat *fp)
290{
291 struct usb_device *dev = chip->dev;
292 unsigned char tmp[2], *data;
293 int nr_triplets, data_size, ret = 0;
294 int clock = snd_usb_clock_find_source(chip, fp->clock, false);
295
296 if (clock < 0) {
297 dev_err(&dev->dev,
298 "%s(): unable to find clock source (clock %d)\n",
299 __func__, clock);
300 goto err;
301 }
302
303 /* get the number of sample rates first by only fetching 2 bytes */
304 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
305 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
306 UAC2_CS_CONTROL_SAM_FREQ << 8,
307 snd_usb_ctrl_intf(chip) | (clock << 8),
308 tmp, sizeof(tmp));
309
310 if (ret < 0) {
311 dev_err(&dev->dev,
312 "%s(): unable to retrieve number of sample rates (clock %d)\n",
313 __func__, clock);
314 goto err;
315 }
316
317 nr_triplets = (tmp[1] << 8) | tmp[0];
318 data_size = 2 + 12 * nr_triplets;
319 data = kzalloc(data_size, GFP_KERNEL);
320 if (!data) {
321 ret = -ENOMEM;
322 goto err;
323 }
324
325 /* now get the full information */
326 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
327 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
328 UAC2_CS_CONTROL_SAM_FREQ << 8,
329 snd_usb_ctrl_intf(chip) | (clock << 8),
330 data, data_size);
331
332 if (ret < 0) {
333 dev_err(&dev->dev,
334 "%s(): unable to retrieve sample rate range (clock %d)\n",
335 __func__, clock);
336 ret = -EINVAL;
337 goto err_free;
338 }
339
340 /* Call the triplet parser, and make sure fp->rate_table is NULL.
341 * We just use the return value to know how many sample rates we
342 * will have to deal with. */
343 kfree(fp->rate_table);
344 fp->rate_table = NULL;
345 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
346
347 if (fp->nr_rates == 0) {
348 /* SNDRV_PCM_RATE_CONTINUOUS */
349 ret = 0;
350 goto err_free;
351 }
352
353 fp->rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
354 if (!fp->rate_table) {
355 ret = -ENOMEM;
356 goto err_free;
357 }
358
359 /* Call the triplet parser again, but this time, fp->rate_table is
360 * allocated, so the rates will be stored */
361 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
362
363err_free:
364 kfree(data);
365err:
366 return ret;
367}
368
369/*
370 * parse the format type I and III descriptors
371 */
372static int parse_audio_format_i(struct snd_usb_audio *chip,
373 struct audioformat *fp, unsigned int format,
374 struct uac_format_type_i_continuous_descriptor *fmt)
375{
376 snd_pcm_format_t pcm_format;
377 int ret;
378
379 if (fmt->bFormatType == UAC_FORMAT_TYPE_III) {
380 /* FIXME: the format type is really IECxxx
381 * but we give normal PCM format to get the existing
382 * apps working...
383 */
384 switch (chip->usb_id) {
385
386 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
387 if (chip->setup == 0x00 &&
388 fp->altsetting == 6)
389 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
390 else
391 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
392 break;
393 default:
394 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
395 }
396 fp->formats = pcm_format_to_bits(pcm_format);
397 } else {
398 fp->formats = parse_audio_format_i_type(chip, fp, format, fmt);
399 if (!fp->formats)
400 return -EINVAL;
401 }
402
403 /* gather possible sample rates */
404 /* audio class v1 reports possible sample rates as part of the
405 * proprietary class specific descriptor.
406 * audio class v2 uses class specific EP0 range requests for that.
407 */
408 switch (fp->protocol) {
409 default:
410 case UAC_VERSION_1:
411 fp->channels = fmt->bNrChannels;
412 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
413 break;
414 case UAC_VERSION_2:
415 /* fp->channels is already set in this case */
416 ret = parse_audio_format_rates_v2(chip, fp);
417 break;
418 }
419
420 if (fp->channels < 1) {
421 usb_audio_err(chip,
422 "%u:%d : invalid channels %d\n",
423 fp->iface, fp->altsetting, fp->channels);
424 return -EINVAL;
425 }
426
427 return ret;
428}
429
430/*
431 * parse the format type II descriptor
432 */
433static int parse_audio_format_ii(struct snd_usb_audio *chip,
434 struct audioformat *fp,
435 int format, void *_fmt)
436{
437 int brate, framesize, ret;
438
439 switch (format) {
440 case UAC_FORMAT_TYPE_II_AC3:
441 /* FIXME: there is no AC3 format defined yet */
442 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
443 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
444 break;
445 case UAC_FORMAT_TYPE_II_MPEG:
446 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
447 break;
448 default:
449 usb_audio_info(chip,
450 "%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
451 fp->iface, fp->altsetting, format);
452 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
453 break;
454 }
455
456 fp->channels = 1;
457
458 switch (fp->protocol) {
459 default:
460 case UAC_VERSION_1: {
461 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
462 brate = le16_to_cpu(fmt->wMaxBitRate);
463 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
464 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
465 fp->frame_size = framesize;
466 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
467 break;
468 }
469 case UAC_VERSION_2: {
470 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
471 brate = le16_to_cpu(fmt->wMaxBitRate);
472 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
473 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
474 fp->frame_size = framesize;
475 ret = parse_audio_format_rates_v2(chip, fp);
476 break;
477 }
478 }
479
480 return ret;
481}
482
483int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
484 struct audioformat *fp, unsigned int format,
485 struct uac_format_type_i_continuous_descriptor *fmt,
486 int stream)
487{
488 int err;
489
490 switch (fmt->bFormatType) {
491 case UAC_FORMAT_TYPE_I:
492 case UAC_FORMAT_TYPE_III:
493 err = parse_audio_format_i(chip, fp, format, fmt);
494 break;
495 case UAC_FORMAT_TYPE_II:
496 err = parse_audio_format_ii(chip, fp, format, fmt);
497 break;
498 default:
499 usb_audio_info(chip,
500 "%u:%d : format type %d is not supported yet\n",
501 fp->iface, fp->altsetting,
502 fmt->bFormatType);
503 return -ENOTSUPP;
504 }
505 fp->fmt_type = fmt->bFormatType;
506 if (err < 0)
507 return err;
508#if 1
509 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
510 /* extigy apparently supports sample rates other than 48k
511 * but not in ordinary way. so we enable only 48k atm.
512 */
513 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
514 chip->usb_id == USB_ID(0x041e, 0x3020) ||
515 chip->usb_id == USB_ID(0x041e, 0x3061)) {
516 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
517 fp->rates != SNDRV_PCM_RATE_48000 &&
518 fp->rates != SNDRV_PCM_RATE_96000)
519 return -ENOTSUPP;
520 }
521#endif
522 return 0;
523}
524