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