ALSA: firewire-digi00x: prevent potential use after free
[linux-2.6-block.git] / sound / usb / format.c
CommitLineData
1a59d1b8 1// SPDX-License-Identifier: GPL-2.0-or-later
e5779998 2/*
e5779998
DM
3 */
4
5#include <linux/init.h>
36db0456 6#include <linux/slab.h>
e5779998
DM
7#include <linux/usb.h>
8#include <linux/usb/audio.h>
7e847894 9#include <linux/usb/audio-v2.h>
9a2fe9b8 10#include <linux/usb/audio-v3.h>
e5779998
DM
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"
79f920fb 19#include "clock.h"
ee95cb61 20#include "format.h"
e5779998
DM
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)
9a2fe9b8 29 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
e5779998 30 */
29088fef 31static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
e5779998 32 struct audioformat *fp,
9a2fe9b8 33 u64 format, void *_fmt)
e5779998 34{
e5779998 35 int sample_width, sample_bytes;
717bfb5f 36 u64 pcm_formats = 0;
e5779998 37
8f898e92 38 switch (fp->protocol) {
a2acad82
CL
39 case UAC_VERSION_1:
40 default: {
e5779998 41 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
fa4e7a6f
TI
42 if (format >= 64) {
43 usb_audio_info(chip,
44 "%u:%d: invalid format type 0x%llx is detected, processed as PCM\n",
45 fp->iface, fp->altsetting, format);
46 format = UAC_FORMAT_TYPE_I_PCM;
47 }
e5779998
DM
48 sample_width = fmt->bBitResolution;
49 sample_bytes = fmt->bSubframeSize;
b44d419b 50 format = 1ULL << format;
e5779998
DM
51 break;
52 }
53
54 case UAC_VERSION_2: {
55 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
56 sample_width = fmt->bBitResolution;
57 sample_bytes = fmt->bSubslotSize;
717bfb5f 58
3a572d94 59 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
717bfb5f 60 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
3a572d94
JL
61 /* flag potentially raw DSD capable altsettings */
62 fp->dsd_raw = true;
63 }
717bfb5f 64
29088fef 65 format <<= 1;
e5779998
DM
66 break;
67 }
9a2fe9b8
RB
68 case UAC_VERSION_3: {
69 struct uac3_as_header_descriptor *as = _fmt;
70
71 sample_width = as->bBitResolution;
72 sample_bytes = as->bSubslotSize;
73
74 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
75 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
76
77 format <<= 1;
78 break;
79 }
e5779998
DM
80 }
81
c7a13264
JL
82 fp->fmt_bits = sample_width;
83
717bfb5f
DM
84 if ((pcm_formats == 0) &&
85 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
29088fef 86 /* some devices don't define this correctly... */
0ba41d91
TI
87 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
88 fp->iface, fp->altsetting);
29088fef
CL
89 format = 1 << UAC_FORMAT_TYPE_I_PCM;
90 }
91 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
6d1f2f60
TH
92 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
93 /* Edirol SD-90 */
94 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
95 /* Roland SC-D70 */
061b869e
CL
96 sample_width == 24 && sample_bytes == 2)
97 sample_bytes = 3;
98 else if (sample_width > sample_bytes * 8) {
0ba41d91
TI
99 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
100 fp->iface, fp->altsetting,
101 sample_width, sample_bytes);
e5779998
DM
102 }
103 /* check the format byte size */
104 switch (sample_bytes) {
105 case 1:
29088fef 106 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
e5779998
DM
107 break;
108 case 2:
109 if (snd_usb_is_big_endian_format(chip, fp))
29088fef 110 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
e5779998 111 else
29088fef 112 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
e5779998
DM
113 break;
114 case 3:
115 if (snd_usb_is_big_endian_format(chip, fp))
29088fef 116 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
e5779998 117 else
29088fef 118 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
e5779998
DM
119 break;
120 case 4:
29088fef 121 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
e5779998
DM
122 break;
123 default:
0ba41d91
TI
124 usb_audio_info(chip,
125 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
126 fp->iface, fp->altsetting,
127 sample_width, sample_bytes);
e5779998
DM
128 break;
129 }
29088fef
CL
130 }
131 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
e5779998
DM
132 /* Dallas DS4201 workaround: it advertises U8 format, but really
133 supports S8. */
134 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
29088fef
CL
135 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
136 else
137 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
138 }
139 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
140 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
141 }
142 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
143 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
144 }
145 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
146 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
147 }
148 if (format & ~0x3f) {
0ba41d91 149 usb_audio_info(chip,
9a2fe9b8 150 "%u:%d : unsupported format bits %#llx\n",
0ba41d91 151 fp->iface, fp->altsetting, format);
e5779998 152 }
126825e7
DM
153
154 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
155
29088fef 156 return pcm_formats;
e5779998
DM
157}
158
74f73476
TI
159static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
160{
161 kfree(fp->rate_table);
162 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
163 if (!fp->rate_table)
164 return -ENOMEM;
165 fp->nr_rates = 1;
166 fp->rate_min = rate;
167 fp->rate_max = rate;
168 fp->rates = rate_bits;
169 fp->rate_table[0] = rate;
170 return 0;
171}
e5779998 172
13ee0336
TI
173/* set up rate_min, rate_max and rates from the rate table */
174static void set_rate_table_min_max(struct audioformat *fp)
175{
176 unsigned int rate;
177 int i;
178
179 fp->rate_min = INT_MAX;
180 fp->rate_max = 0;
181 fp->rates = 0;
182 for (i = 0; i < fp->nr_rates; i++) {
183 rate = fp->rate_table[i];
184 fp->rate_min = min(fp->rate_min, rate);
185 fp->rate_max = max(fp->rate_max, rate);
186 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
187 }
188}
189
e5779998
DM
190/*
191 * parse the format descriptor and stores the possible sample rates
192 * on the audioformat table (audio class v1).
193 *
194 * @dev: usb device
195 * @fp: audioformat record
196 * @fmt: the format descriptor
197 * @offset: the start offset of descriptor pointing the rate type
198 * (7 for type I and II, 8 for type II)
199 */
200static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
201 unsigned char *fmt, int offset)
202{
203 int nr_rates = fmt[offset];
204
205 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
0ba41d91
TI
206 usb_audio_err(chip,
207 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
208 fp->iface, fp->altsetting);
8ad10dc6 209 return -EINVAL;
e5779998
DM
210 }
211
212 if (nr_rates) {
213 /*
214 * build the rate table and bitmap flags
215 */
216 int r, idx;
217
6da2ec56
KC
218 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
219 GFP_KERNEL);
1bc00f32 220 if (fp->rate_table == NULL)
8ad10dc6 221 return -ENOMEM;
e5779998
DM
222
223 fp->nr_rates = 0;
e5779998
DM
224 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
225 unsigned int rate = combine_triple(&fmt[idx]);
226 if (!rate)
227 continue;
228 /* C-Media CM6501 mislabels its 96 kHz altsetting */
8129e79e 229 /* Terratec Aureon 7.1 USB C-Media 6206, too */
aecc19ec 230 /* Ozone Z90 USB C-Media, too */
e5779998
DM
231 if (rate == 48000 && nr_rates == 1 &&
232 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
8129e79e 233 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
aecc19ec 234 chip->usb_id == USB_ID(0x0d8c, 0x0078) ||
8129e79e 235 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
e5779998
DM
236 fp->altsetting == 5 && fp->maxpacksize == 392)
237 rate = 96000;
8c4b79cf
PH
238 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
239 if (rate == 16000 &&
240 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
241 chip->usb_id == USB_ID(0x041e, 0x4068)))
e5779998
DM
242 rate = 8000;
243
13ee0336 244 fp->rate_table[fp->nr_rates++] = rate;
e5779998
DM
245 }
246 if (!fp->nr_rates) {
7ec827b9
TI
247 usb_audio_info(chip,
248 "%u:%d: All rates were zero\n",
249 fp->iface, fp->altsetting);
8ad10dc6 250 return -EINVAL;
e5779998 251 }
13ee0336 252 set_rate_table_min_max(fp);
e5779998
DM
253 } else {
254 /* continuous rates */
255 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
256 fp->rate_min = combine_triple(&fmt[offset + 1]);
257 fp->rate_max = combine_triple(&fmt[offset + 4]);
258 }
74f73476
TI
259
260 /* Jabra Evolve 65 headset */
261 if (chip->usb_id == USB_ID(0x0b0e, 0x030b)) {
262 /* only 48kHz for playback while keeping 16kHz for capture */
263 if (fp->nr_rates != 1)
264 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
265 }
266
e5779998
DM
267 return 0;
268}
269
8dc5efe3
NK
270
271/*
272 * Presonus Studio 1810c supports a limited set of sampling
273 * rates per altsetting but reports the full set each time.
274 * If we don't filter out the unsupported rates and attempt
275 * to configure the card, it will hang refusing to do any
276 * further audio I/O until a hard reset is performed.
277 *
278 * The list of supported rates per altsetting (set of available
279 * I/O channels) is described in the owner's manual, section 2.2.
280 */
281static bool s1810c_valid_sample_rate(struct audioformat *fp,
282 unsigned int rate)
283{
284 switch (fp->altsetting) {
285 case 1:
286 /* All ADAT ports available */
287 return rate <= 48000;
288 case 2:
289 /* Half of ADAT ports available */
290 return (rate == 88200 || rate == 96000);
291 case 3:
292 /* Analog I/O only (no S/PDIF nor ADAT) */
293 return rate >= 176400;
294 default:
295 return false;
296 }
297 return false;
298}
299
1c826792
AT
300/*
301 * Many Focusrite devices supports a limited set of sampling rates per
302 * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
303 * descriptor which has a non-standard bLength = 10.
304 */
305static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
306 struct audioformat *fp,
307 unsigned int rate)
308{
309 struct usb_interface *iface;
310 struct usb_host_interface *alts;
311 unsigned char *fmt;
312 unsigned int max_rate;
313
314 iface = usb_ifnum_to_if(chip->dev, fp->iface);
315 if (!iface)
316 return true;
317
318 alts = &iface->altsetting[fp->altset_idx];
319 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
320 NULL, UAC_FORMAT_TYPE);
321 if (!fmt)
322 return true;
323
324 if (fmt[0] == 10) { /* bLength */
325 max_rate = combine_quad(&fmt[6]);
326
327 /* Validate max rate */
328 if (max_rate != 48000 &&
329 max_rate != 96000 &&
330 max_rate != 192000 &&
331 max_rate != 384000) {
332
333 usb_audio_info(chip,
334 "%u:%d : unexpected max rate: %u\n",
335 fp->iface, fp->altsetting, max_rate);
336
337 return true;
338 }
339
340 return rate <= max_rate;
341 }
342
343 return true;
344}
345
67c10366
DM
346/*
347 * Helper function to walk the array of sample rate triplets reported by
348 * the device. The problem is that we need to parse whole array first to
349 * get to know how many sample rates we have to expect.
350 * Then fp->rate_table can be allocated and filled.
351 */
0ba41d91
TI
352static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
353 struct audioformat *fp, int nr_triplets,
67c10366
DM
354 const unsigned char *data)
355{
356 int i, nr_rates = 0;
357
67c10366
DM
358 for (i = 0; i < nr_triplets; i++) {
359 int min = combine_quad(&data[2 + 12 * i]);
360 int max = combine_quad(&data[6 + 12 * i]);
361 int res = combine_quad(&data[10 + 12 * i]);
4fa0e81b 362 unsigned int rate;
67c10366
DM
363
364 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
365 continue;
366
367 /*
368 * for ranges with res == 1, we announce a continuous sample
369 * rate range, and this function should return 0 for no further
370 * parsing.
371 */
372 if (res == 1) {
373 fp->rate_min = min;
374 fp->rate_max = max;
375 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
376 return 0;
377 }
378
379 for (rate = min; rate <= max; rate += res) {
8dc5efe3
NK
380
381 /* Filter out invalid rates on Presonus Studio 1810c */
1e583aef 382 if (chip->usb_id == USB_ID(0x194f, 0x010c) &&
8dc5efe3
NK
383 !s1810c_valid_sample_rate(fp, rate))
384 goto skip_rate;
385
1c826792
AT
386 /* Filter out invalid rates on Focusrite devices */
387 if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
388 !focusrite_valid_sample_rate(chip, fp, rate))
389 goto skip_rate;
390
67c10366
DM
391 if (fp->rate_table)
392 fp->rate_table[nr_rates] = rate;
67c10366 393 nr_rates++;
8866f405 394 if (nr_rates >= MAX_NR_RATES) {
0ba41d91 395 usb_audio_err(chip, "invalid uac2 rates\n");
4fa0e81b
XW
396 break;
397 }
67c10366 398
8dc5efe3 399skip_rate:
67c10366
DM
400 /* avoid endless loop */
401 if (res == 0)
402 break;
403 }
404 }
405
406 return nr_rates;
407}
408
8abf41dc
CS
409/* Line6 Helix series and the Rode Rodecaster Pro don't support the
410 * UAC2_CS_RANGE usb function call. Return a static table of known
411 * clock rates.
d4bd3053
NL
412 */
413static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
414 struct audioformat *fp)
415{
416 switch (chip->usb_id) {
8be03a71
TI
417 case USB_ID(0x0e41, 0x4241): /* Line6 Helix */
418 case USB_ID(0x0e41, 0x4242): /* Line6 Helix Rack */
419 case USB_ID(0x0e41, 0x4244): /* Line6 Helix LT */
420 case USB_ID(0x0e41, 0x4246): /* Line6 HX-Stomp */
8f27b689 421 case USB_ID(0x0e41, 0x4253): /* Line6 HX-Stomp XL */
7da4c510 422 case USB_ID(0x0e41, 0x4247): /* Line6 Pod Go */
9b132f27
TI
423 case USB_ID(0x0e41, 0x4248): /* Line6 Helix >= fw 2.82 */
424 case USB_ID(0x0e41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
425 case USB_ID(0x0e41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
8abf41dc 426 case USB_ID(0x19f7, 0x0011): /* Rode Rodecaster Pro */
74f73476 427 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
d4bd3053
NL
428 }
429
430 return -ENODEV;
431}
432
93db51d0
TI
433/* check whether the given altsetting is supported for the already set rate */
434static bool check_valid_altsetting_v2v3(struct snd_usb_audio *chip, int iface,
435 int altsetting)
436{
437 struct usb_device *dev = chip->dev;
438 __le64 raw_data = 0;
439 u64 data;
440 int err;
441
442 /* we assume 64bit is enough for any altsettings */
443 if (snd_BUG_ON(altsetting >= 64 - 8))
444 return false;
445
51cb8e20 446 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
93db51d0
TI
447 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
448 UAC2_AS_VAL_ALT_SETTINGS << 8,
449 iface, &raw_data, sizeof(raw_data));
450 if (err < 0)
451 return false;
452
453 data = le64_to_cpu(raw_data);
454 /* first byte contains the bitmap size */
455 if ((data & 0xff) * 8 < altsetting)
456 return false;
457 if (data & (1ULL << (altsetting + 8)))
458 return true;
459
460 return false;
461}
462
463/*
464 * Validate each sample rate with the altsetting
465 * Rebuild the rate table if only partial values are valid
466 */
467static int validate_sample_rate_table_v2v3(struct snd_usb_audio *chip,
468 struct audioformat *fp,
469 int clock)
470{
471 struct usb_device *dev = chip->dev;
472 unsigned int *table;
473 unsigned int nr_rates;
93db51d0
TI
474 int i, err;
475
fe773b87
TI
476 /* performing the rate verification may lead to unexpected USB bus
477 * behavior afterwards by some unknown reason. Do this only for the
478 * known devices.
479 */
8bfe17ad 480 if (!(chip->quirk_flags & QUIRK_FLAG_VALIDATE_RATES))
fe773b87 481 return 0; /* don't perform the validation as default */
fe773b87 482
93db51d0
TI
483 table = kcalloc(fp->nr_rates, sizeof(*table), GFP_KERNEL);
484 if (!table)
485 return -ENOMEM;
486
487 /* clear the interface altsetting at first */
488 usb_set_interface(dev, fp->iface, 0);
489
490 nr_rates = 0;
491 for (i = 0; i < fp->nr_rates; i++) {
492 err = snd_usb_set_sample_rate_v2v3(chip, fp, clock,
493 fp->rate_table[i]);
494 if (err < 0)
495 continue;
496
13ee0336 497 if (check_valid_altsetting_v2v3(chip, fp->iface, fp->altsetting))
93db51d0 498 table[nr_rates++] = fp->rate_table[i];
93db51d0
TI
499 }
500
501 if (!nr_rates) {
502 usb_audio_dbg(chip,
503 "No valid sample rate available for %d:%d, assuming a firmware bug\n",
504 fp->iface, fp->altsetting);
505 nr_rates = fp->nr_rates; /* continue as is */
506 }
507
508 if (fp->nr_rates == nr_rates) {
509 kfree(table);
510 return 0;
511 }
512
513 kfree(fp->rate_table);
514 fp->rate_table = table;
515 fp->nr_rates = nr_rates;
93db51d0
TI
516 return 0;
517}
518
e5779998
DM
519/*
520 * parse the format descriptor and stores the possible sample rates
9a2fe9b8 521 * on the audioformat table (audio class v2 and v3).
e5779998 522 */
9a2fe9b8 523static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
3d8d4dcf 524 struct audioformat *fp)
e5779998
DM
525{
526 struct usb_device *dev = chip->dev;
527 unsigned char tmp[2], *data;
d4bd3053 528 int nr_triplets, data_size, ret = 0, ret_l6;
9f35a312 529 int clock = snd_usb_clock_find_source(chip, fp, false);
e5779998 530
d07140ba 531 if (clock < 0) {
0ba41d91
TI
532 dev_err(&dev->dev,
533 "%s(): unable to find clock source (clock %d)\n",
d07140ba
DM
534 __func__, clock);
535 goto err;
536 }
537
e5779998
DM
538 /* get the number of sample rates first by only fetching 2 bytes */
539 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
540 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
11bcbc44
DM
541 UAC2_CS_CONTROL_SAM_FREQ << 8,
542 snd_usb_ctrl_intf(chip) | (clock << 8),
17d900c4 543 tmp, sizeof(tmp));
e5779998
DM
544
545 if (ret < 0) {
d4bd3053
NL
546 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
547 ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
548 if (ret_l6 == -ENODEV) {
549 /* no line6 device found continue showing the error */
550 dev_err(&dev->dev,
551 "%s(): unable to retrieve number of sample rates (clock %d)\n",
552 __func__, clock);
553 goto err;
554 }
555 if (ret_l6 == 0) {
556 dev_info(&dev->dev,
557 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
79f920fb 558 __func__, clock);
d4bd3053
NL
559 return 0;
560 }
561 ret = ret_l6;
e5779998
DM
562 goto err;
563 }
564
67c10366
DM
565 nr_triplets = (tmp[1] << 8) | tmp[0];
566 data_size = 2 + 12 * nr_triplets;
e5779998
DM
567 data = kzalloc(data_size, GFP_KERNEL);
568 if (!data) {
569 ret = -ENOMEM;
570 goto err;
571 }
572
573 /* now get the full information */
574 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
79f920fb 575 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
11bcbc44
DM
576 UAC2_CS_CONTROL_SAM_FREQ << 8,
577 snd_usb_ctrl_intf(chip) | (clock << 8),
17d900c4 578 data, data_size);
e5779998
DM
579
580 if (ret < 0) {
0ba41d91
TI
581 dev_err(&dev->dev,
582 "%s(): unable to retrieve sample rate range (clock %d)\n",
79f920fb 583 __func__, clock);
e5779998
DM
584 ret = -EINVAL;
585 goto err_free;
586 }
587
67c10366
DM
588 /* Call the triplet parser, and make sure fp->rate_table is NULL.
589 * We just use the return value to know how many sample rates we
590 * will have to deal with. */
591 kfree(fp->rate_table);
592 fp->rate_table = NULL;
0ba41d91 593 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
67c10366
DM
594
595 if (fp->nr_rates == 0) {
596 /* SNDRV_PCM_RATE_CONTINUOUS */
597 ret = 0;
598 goto err_free;
599 }
600
6da2ec56 601 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
e5779998
DM
602 if (!fp->rate_table) {
603 ret = -ENOMEM;
604 goto err_free;
605 }
606
67c10366
DM
607 /* Call the triplet parser again, but this time, fp->rate_table is
608 * allocated, so the rates will be stored */
0ba41d91 609 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
e5779998 610
93db51d0 611 ret = validate_sample_rate_table_v2v3(chip, fp, clock);
13ee0336
TI
612 if (ret < 0)
613 goto err_free;
614
615 set_rate_table_min_max(fp);
93db51d0 616
e5779998
DM
617err_free:
618 kfree(data);
619err:
620 return ret;
621}
622
623/*
624 * parse the format type I and III descriptors
625 */
626static int parse_audio_format_i(struct snd_usb_audio *chip,
9a2fe9b8
RB
627 struct audioformat *fp, u64 format,
628 void *_fmt)
e5779998 629{
74c34ca1 630 snd_pcm_format_t pcm_format;
9a2fe9b8 631 unsigned int fmt_type;
74c34ca1 632 int ret;
e5779998 633
9a2fe9b8
RB
634 switch (fp->protocol) {
635 default:
636 case UAC_VERSION_1:
637 case UAC_VERSION_2: {
638 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
639
640 fmt_type = fmt->bFormatType;
641 break;
642 }
643 case UAC_VERSION_3: {
644 /* fp->fmt_type is already set in this case */
645 fmt_type = fp->fmt_type;
646 break;
647 }
648 }
649
650 if (fmt_type == UAC_FORMAT_TYPE_III) {
e5779998
DM
651 /* FIXME: the format type is really IECxxx
652 * but we give normal PCM format to get the existing
653 * apps working...
654 */
655 switch (chip->usb_id) {
656
657 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
658 if (chip->setup == 0x00 &&
659 fp->altsetting == 6)
660 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
661 else
662 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
663 break;
664 default:
665 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
666 }
74c34ca1 667 fp->formats = pcm_format_to_bits(pcm_format);
e5779998 668 } else {
9a2fe9b8 669 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
29088fef 670 if (!fp->formats)
8ad10dc6 671 return -EINVAL;
e5779998
DM
672 }
673
e5779998
DM
674 /* gather possible sample rates */
675 /* audio class v1 reports possible sample rates as part of the
676 * proprietary class specific descriptor.
677 * audio class v2 uses class specific EP0 range requests for that.
678 */
8f898e92 679 switch (fp->protocol) {
a2acad82 680 default:
9a2fe9b8
RB
681 case UAC_VERSION_1: {
682 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
683
e5779998 684 fp->channels = fmt->bNrChannels;
74754f97 685 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
e5779998 686 break;
9a2fe9b8 687 }
e5779998 688 case UAC_VERSION_2:
9a2fe9b8 689 case UAC_VERSION_3: {
e5779998 690 /* fp->channels is already set in this case */
9a2fe9b8 691 ret = parse_audio_format_rates_v2v3(chip, fp);
e5779998
DM
692 break;
693 }
9a2fe9b8 694 }
e5779998
DM
695
696 if (fp->channels < 1) {
0ba41d91
TI
697 usb_audio_err(chip,
698 "%u:%d : invalid channels %d\n",
699 fp->iface, fp->altsetting, fp->channels);
8ad10dc6 700 return -EINVAL;
e5779998
DM
701 }
702
703 return ret;
704}
705
706/*
707 * parse the format type II descriptor
708 */
709static int parse_audio_format_ii(struct snd_usb_audio *chip,
710 struct audioformat *fp,
9a2fe9b8 711 u64 format, void *_fmt)
e5779998
DM
712{
713 int brate, framesize, ret;
e5779998
DM
714
715 switch (format) {
716 case UAC_FORMAT_TYPE_II_AC3:
717 /* FIXME: there is no AC3 format defined yet */
015eb0b0
CL
718 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
719 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
e5779998
DM
720 break;
721 case UAC_FORMAT_TYPE_II_MPEG:
015eb0b0 722 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
e5779998
DM
723 break;
724 default:
0ba41d91 725 usb_audio_info(chip,
9a2fe9b8 726 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
0ba41d91 727 fp->iface, fp->altsetting, format);
015eb0b0 728 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
e5779998
DM
729 break;
730 }
731
732 fp->channels = 1;
733
8f898e92 734 switch (fp->protocol) {
a2acad82 735 default:
e5779998
DM
736 case UAC_VERSION_1: {
737 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
738 brate = le16_to_cpu(fmt->wMaxBitRate);
739 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
0ba41d91 740 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
e5779998
DM
741 fp->frame_size = framesize;
742 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
743 break;
744 }
745 case UAC_VERSION_2: {
746 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
747 brate = le16_to_cpu(fmt->wMaxBitRate);
748 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
0ba41d91 749 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
e5779998 750 fp->frame_size = framesize;
9a2fe9b8 751 ret = parse_audio_format_rates_v2v3(chip, fp);
e5779998
DM
752 break;
753 }
754 }
755
756 return ret;
757}
758
2fcdb06d 759int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
9a2fe9b8 760 struct audioformat *fp, u64 format,
2fcdb06d 761 struct uac_format_type_i_continuous_descriptor *fmt,
8f898e92 762 int stream)
e5779998
DM
763{
764 int err;
765
74754f97 766 switch (fmt->bFormatType) {
e5779998
DM
767 case UAC_FORMAT_TYPE_I:
768 case UAC_FORMAT_TYPE_III:
8f898e92 769 err = parse_audio_format_i(chip, fp, format, fmt);
e5779998
DM
770 break;
771 case UAC_FORMAT_TYPE_II:
8f898e92 772 err = parse_audio_format_ii(chip, fp, format, fmt);
e5779998
DM
773 break;
774 default:
0ba41d91
TI
775 usb_audio_info(chip,
776 "%u:%d : format type %d is not supported yet\n",
777 fp->iface, fp->altsetting,
778 fmt->bFormatType);
8d091242 779 return -ENOTSUPP;
e5779998 780 }
74754f97 781 fp->fmt_type = fmt->bFormatType;
e5779998
DM
782 if (err < 0)
783 return err;
784#if 1
785 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
786 /* extigy apparently supports sample rates other than 48k
787 * but not in ordinary way. so we enable only 48k atm.
788 */
789 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
790 chip->usb_id == USB_ID(0x041e, 0x3020) ||
791 chip->usb_id == USB_ID(0x041e, 0x3061)) {
74754f97 792 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
e5779998
DM
793 fp->rates != SNDRV_PCM_RATE_48000 &&
794 fp->rates != SNDRV_PCM_RATE_96000)
8d091242 795 return -ENOTSUPP;
e5779998
DM
796 }
797#endif
798 return 0;
799}
800
9a2fe9b8
RB
801int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
802 struct audioformat *fp,
803 struct uac3_as_header_descriptor *as,
804 int stream)
805{
806 u64 format = le64_to_cpu(as->bmFormats);
807 int err;
808
809 /*
810 * Type I format bits are D0..D6
811 * This test works because type IV is not supported
812 */
813 if (format & 0x7f)
814 fp->fmt_type = UAC_FORMAT_TYPE_I;
815 else
816 fp->fmt_type = UAC_FORMAT_TYPE_III;
817
818 err = parse_audio_format_i(chip, fp, format, as);
819 if (err < 0)
820 return err;
821
822 return 0;
823}