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