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