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 "clock.h"
20#include "format.h"
21
22/*
23 * parse the audio format type I descriptor
24 * and returns the corresponding pcm format
25 *
26 * @dev: usb device
27 * @fp: audioformat record
28 * @format: the format tag (wFormatTag)
29 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
30 */
31static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
32 struct audioformat *fp,
33 u64 format, void *_fmt)
34{
35 int sample_width, sample_bytes;
36 u64 pcm_formats = 0;
37
38 switch (fp->protocol) {
39 case UAC_VERSION_1:
40 default: {
41 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
42 if (format >= 64)
43 return 0; /* invalid format */
44 sample_width = fmt->bBitResolution;
45 sample_bytes = fmt->bSubframeSize;
46 format = 1ULL << format;
47 break;
48 }
49
50 case UAC_VERSION_2: {
51 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
52 sample_width = fmt->bBitResolution;
53 sample_bytes = fmt->bSubslotSize;
54
55 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
56 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
57 /* flag potentially raw DSD capable altsettings */
58 fp->dsd_raw = true;
59 }
60
61 format <<= 1;
62 break;
63 }
64 case UAC_VERSION_3: {
65 struct uac3_as_header_descriptor *as = _fmt;
66
67 sample_width = as->bBitResolution;
68 sample_bytes = as->bSubslotSize;
69
70 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
71 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
72
73 format <<= 1;
74 break;
75 }
76 }
77
78 fp->fmt_bits = sample_width;
79
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;
86 }
87 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
88 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
89 /* Edirol SD-90 */
90 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
91 /* Roland SC-D70 */
92 sample_width == 24 && sample_bytes == 2)
93 sample_bytes = 3;
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);
98 }
99 /* check the format byte size */
100 switch (sample_bytes) {
101 case 1:
102 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
103 break;
104 case 2:
105 if (snd_usb_is_big_endian_format(chip, fp))
106 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
107 else
108 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
109 break;
110 case 3:
111 if (snd_usb_is_big_endian_format(chip, fp))
112 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
113 else
114 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
115 break;
116 case 4:
117 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
118 break;
119 default:
120 usb_audio_info(chip,
121 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
122 fp->iface, fp->altsetting,
123 sample_width, sample_bytes);
124 break;
125 }
126 }
127 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
128 /* Dallas DS4201 workaround: it advertises U8 format, but really
129 supports S8. */
130 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
131 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
132 else
133 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
134 }
135 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
136 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
137 }
138 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
139 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
140 }
141 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
142 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
143 }
144 if (format & ~0x3f) {
145 usb_audio_info(chip,
146 "%u:%d : unsupported format bits %#llx\n",
147 fp->iface, fp->altsetting, format);
148 }
149
150 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
151
152 return pcm_formats;
153}
154
155static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
156{
157 kfree(fp->rate_table);
158 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
159 if (!fp->rate_table)
160 return -ENOMEM;
161 fp->nr_rates = 1;
162 fp->rate_min = rate;
163 fp->rate_max = rate;
164 fp->rates = rate_bits;
165 fp->rate_table[0] = rate;
166 return 0;
167}
168
169/* set up rate_min, rate_max and rates from the rate table */
170static void set_rate_table_min_max(struct audioformat *fp)
171{
172 unsigned int rate;
173 int i;
174
175 fp->rate_min = INT_MAX;
176 fp->rate_max = 0;
177 fp->rates = 0;
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);
183 }
184}
185
186/*
187 * parse the format descriptor and stores the possible sample rates
188 * on the audioformat table (audio class v1).
189 *
190 * @dev: usb device
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)
195 */
196static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
197 unsigned char *fmt, int offset)
198{
199 int nr_rates = fmt[offset];
200
201 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
202 usb_audio_err(chip,
203 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
204 fp->iface, fp->altsetting);
205 return -EINVAL;
206 }
207
208 if (nr_rates) {
209 /*
210 * build the rate table and bitmap flags
211 */
212 int r, idx;
213
214 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
215 GFP_KERNEL);
216 if (fp->rate_table == NULL)
217 return -ENOMEM;
218
219 fp->nr_rates = 0;
220 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
221 unsigned int rate = combine_triple(&fmt[idx]);
222 if (!rate)
223 continue;
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)
233 rate = 96000;
234 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
235 if (rate == 16000 &&
236 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
237 chip->usb_id == USB_ID(0x041e, 0x4068)))
238 rate = 8000;
239
240 fp->rate_table[fp->nr_rates++] = rate;
241 }
242 if (!fp->nr_rates) {
243 usb_audio_info(chip,
244 "%u:%d: All rates were zero\n",
245 fp->iface, fp->altsetting);
246 return -EINVAL;
247 }
248 set_rate_table_min_max(fp);
249 } else {
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]);
254 }
255
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);
261 }
262
263 return 0;
264}
265
266
267/*
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.
273 *
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.
276 */
277static bool s1810c_valid_sample_rate(struct audioformat *fp,
278 unsigned int rate)
279{
280 switch (fp->altsetting) {
281 case 1:
282 /* All ADAT ports available */
283 return rate <= 48000;
284 case 2:
285 /* Half of ADAT ports available */
286 return (rate == 88200 || rate == 96000);
287 case 3:
288 /* Analog I/O only (no S/PDIF nor ADAT) */
289 return rate >= 176400;
290 default:
291 return false;
292 }
293 return false;
294}
295
296/*
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.
300 */
301static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
302 struct audioformat *fp,
303 unsigned int rate)
304{
305 struct usb_interface *iface;
306 struct usb_host_interface *alts;
307 unsigned char *fmt;
308 unsigned int max_rate;
309
310 iface = usb_ifnum_to_if(chip->dev, fp->iface);
311 if (!iface)
312 return true;
313
314 alts = &iface->altsetting[fp->altset_idx];
315 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
316 NULL, UAC_FORMAT_TYPE);
317 if (!fmt)
318 return true;
319
320 if (fmt[0] == 10) { /* bLength */
321 max_rate = combine_quad(&fmt[6]);
322
323 /* Validate max rate */
324 if (max_rate != 48000 &&
325 max_rate != 96000 &&
326 max_rate != 192000 &&
327 max_rate != 384000) {
328
329 usb_audio_info(chip,
330 "%u:%d : unexpected max rate: %u\n",
331 fp->iface, fp->altsetting, max_rate);
332
333 return true;
334 }
335
336 return rate <= max_rate;
337 }
338
339 return true;
340}
341
342/*
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.
347 */
348static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
349 struct audioformat *fp, int nr_triplets,
350 const unsigned char *data)
351{
352 int i, nr_rates = 0;
353
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]);
358 unsigned int rate;
359
360 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
361 continue;
362
363 /*
364 * for ranges with res == 1, we announce a continuous sample
365 * rate range, and this function should return 0 for no further
366 * parsing.
367 */
368 if (res == 1) {
369 fp->rate_min = min;
370 fp->rate_max = max;
371 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
372 return 0;
373 }
374
375 for (rate = min; rate <= max; rate += res) {
376
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))
380 goto skip_rate;
381
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))
385 goto skip_rate;
386
387 if (fp->rate_table)
388 fp->rate_table[nr_rates] = rate;
389 nr_rates++;
390 if (nr_rates >= MAX_NR_RATES) {
391 usb_audio_err(chip, "invalid uac2 rates\n");
392 break;
393 }
394
395skip_rate:
396 /* avoid endless loop */
397 if (res == 0)
398 break;
399 }
400 }
401
402 return nr_rates;
403}
404
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
407 * clock rates.
408 */
409static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
410 struct audioformat *fp)
411{
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);
423 }
424
425 return -ENODEV;
426}
427
428/* check whether the given altsetting is supported for the already set rate */
429static bool check_valid_altsetting_v2v3(struct snd_usb_audio *chip, int iface,
430 int altsetting)
431{
432 struct usb_device *dev = chip->dev;
433 __le64 raw_data = 0;
434 u64 data;
435 int err;
436
437 /* we assume 64bit is enough for any altsettings */
438 if (snd_BUG_ON(altsetting >= 64 - 8))
439 return false;
440
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));
445 if (err < 0)
446 return false;
447
448 data = le64_to_cpu(raw_data);
449 /* first byte contains the bitmap size */
450 if ((data & 0xff) * 8 < altsetting)
451 return false;
452 if (data & (1ULL << (altsetting + 8)))
453 return true;
454
455 return false;
456}
457
458/*
459 * Validate each sample rate with the altsetting
460 * Rebuild the rate table if only partial values are valid
461 */
462static int validate_sample_rate_table_v2v3(struct snd_usb_audio *chip,
463 struct audioformat *fp,
464 int clock)
465{
466 struct usb_device *dev = chip->dev;
467 unsigned int *table;
468 unsigned int nr_rates;
469 int i, err;
470
471 /* performing the rate verification may lead to unexpected USB bus
472 * behavior afterwards by some unknown reason. Do this only for the
473 * known devices.
474 */
475 switch (USB_ID_VENDOR(chip->usb_id)) {
476 case 0x07fd: /* MOTU */
477 break;
478 default:
479 return 0; /* don't perform the validation as default */
480 }
481
482 table = kcalloc(fp->nr_rates, sizeof(*table), GFP_KERNEL);
483 if (!table)
484 return -ENOMEM;
485
486 /* clear the interface altsetting at first */
487 usb_set_interface(dev, fp->iface, 0);
488
489 nr_rates = 0;
490 for (i = 0; i < fp->nr_rates; i++) {
491 err = snd_usb_set_sample_rate_v2v3(chip, fp, clock,
492 fp->rate_table[i]);
493 if (err < 0)
494 continue;
495
496 if (check_valid_altsetting_v2v3(chip, fp->iface, fp->altsetting))
497 table[nr_rates++] = fp->rate_table[i];
498 }
499
500 if (!nr_rates) {
501 usb_audio_dbg(chip,
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 */
505 }
506
507 if (fp->nr_rates == nr_rates) {
508 kfree(table);
509 return 0;
510 }
511
512 kfree(fp->rate_table);
513 fp->rate_table = table;
514 fp->nr_rates = nr_rates;
515 return 0;
516}
517
518/*
519 * parse the format descriptor and stores the possible sample rates
520 * on the audioformat table (audio class v2 and v3).
521 */
522static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
523 struct audioformat *fp)
524{
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);
529
530 if (clock < 0) {
531 dev_err(&dev->dev,
532 "%s(): unable to find clock source (clock %d)\n",
533 __func__, clock);
534 goto err;
535 }
536
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),
542 tmp, sizeof(tmp));
543
544 if (ret < 0) {
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 */
549 dev_err(&dev->dev,
550 "%s(): unable to retrieve number of sample rates (clock %d)\n",
551 __func__, clock);
552 goto err;
553 }
554 if (ret_l6 == 0) {
555 dev_info(&dev->dev,
556 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
557 __func__, clock);
558 return 0;
559 }
560 ret = ret_l6;
561 goto err;
562 }
563
564 nr_triplets = (tmp[1] << 8) | tmp[0];
565 data_size = 2 + 12 * nr_triplets;
566 data = kzalloc(data_size, GFP_KERNEL);
567 if (!data) {
568 ret = -ENOMEM;
569 goto err;
570 }
571
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),
577 data, data_size);
578
579 if (ret < 0) {
580 dev_err(&dev->dev,
581 "%s(): unable to retrieve sample rate range (clock %d)\n",
582 __func__, clock);
583 ret = -EINVAL;
584 goto err_free;
585 }
586
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);
593
594 if (fp->nr_rates == 0) {
595 /* SNDRV_PCM_RATE_CONTINUOUS */
596 ret = 0;
597 goto err_free;
598 }
599
600 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
601 if (!fp->rate_table) {
602 ret = -ENOMEM;
603 goto err_free;
604 }
605
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);
609
610 ret = validate_sample_rate_table_v2v3(chip, fp, clock);
611 if (ret < 0)
612 goto err_free;
613
614 set_rate_table_min_max(fp);
615
616err_free:
617 kfree(data);
618err:
619 return ret;
620}
621
622/*
623 * parse the format type I and III descriptors
624 */
625static int parse_audio_format_i(struct snd_usb_audio *chip,
626 struct audioformat *fp, u64 format,
627 void *_fmt)
628{
629 snd_pcm_format_t pcm_format;
630 unsigned int fmt_type;
631 int ret;
632
633 switch (fp->protocol) {
634 default:
635 case UAC_VERSION_1:
636 case UAC_VERSION_2: {
637 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
638
639 fmt_type = fmt->bFormatType;
640 break;
641 }
642 case UAC_VERSION_3: {
643 /* fp->fmt_type is already set in this case */
644 fmt_type = fp->fmt_type;
645 break;
646 }
647 }
648
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
652 * apps working...
653 */
654 switch (chip->usb_id) {
655
656 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
657 if (chip->setup == 0x00 &&
658 fp->altsetting == 6)
659 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
660 else
661 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
662 break;
663 default:
664 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
665 }
666 fp->formats = pcm_format_to_bits(pcm_format);
667 } else {
668 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
669 if (!fp->formats)
670 return -EINVAL;
671 }
672
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.
677 */
678 switch (fp->protocol) {
679 default:
680 case UAC_VERSION_1: {
681 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
682
683 fp->channels = fmt->bNrChannels;
684 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
685 break;
686 }
687 case UAC_VERSION_2:
688 case UAC_VERSION_3: {
689 /* fp->channels is already set in this case */
690 ret = parse_audio_format_rates_v2v3(chip, fp);
691 break;
692 }
693 }
694
695 if (fp->channels < 1) {
696 usb_audio_err(chip,
697 "%u:%d : invalid channels %d\n",
698 fp->iface, fp->altsetting, fp->channels);
699 return -EINVAL;
700 }
701
702 return ret;
703}
704
705/*
706 * parse the format type II descriptor
707 */
708static int parse_audio_format_ii(struct snd_usb_audio *chip,
709 struct audioformat *fp,
710 u64 format, void *_fmt)
711{
712 int brate, framesize, ret;
713
714 switch (format) {
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 */
719 break;
720 case UAC_FORMAT_TYPE_II_MPEG:
721 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
722 break;
723 default:
724 usb_audio_info(chip,
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;
728 break;
729 }
730
731 fp->channels = 1;
732
733 switch (fp->protocol) {
734 default:
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 */
742 break;
743 }
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);
751 break;
752 }
753 }
754
755 return ret;
756}
757
758int 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,
761 int stream)
762{
763 int err;
764
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);
769 break;
770 case UAC_FORMAT_TYPE_II:
771 err = parse_audio_format_ii(chip, fp, format, fmt);
772 break;
773 default:
774 usb_audio_info(chip,
775 "%u:%d : format type %d is not supported yet\n",
776 fp->iface, fp->altsetting,
777 fmt->bFormatType);
778 return -ENOTSUPP;
779 }
780 fp->fmt_type = fmt->bFormatType;
781 if (err < 0)
782 return err;
783#if 1
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.
787 */
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)
794 return -ENOTSUPP;
795 }
796#endif
797 return 0;
798}
799
800int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
801 struct audioformat *fp,
802 struct uac3_as_header_descriptor *as,
803 int stream)
804{
805 u64 format = le64_to_cpu(as->bmFormats);
806 int err;
807
808 /*
809 * Type I format bits are D0..D6
810 * This test works because type IV is not supported
811 */
812 if (format & 0x7f)
813 fp->fmt_type = UAC_FORMAT_TYPE_I;
814 else
815 fp->fmt_type = UAC_FORMAT_TYPE_III;
816
817 err = parse_audio_format_i(chip, fp, format, as);
818 if (err < 0)
819 return err;
820
821 return 0;
822}
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}