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