Linux Audio

Check our new training course

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