xref: /openbmc/linux/sound/usb/format.c (revision 51cb8e206afd463e66f16869e5ddc95bef107142)
11a59d1b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
2e5779998SDaniel Mack /*
3e5779998SDaniel Mack  */
4e5779998SDaniel Mack 
5e5779998SDaniel Mack #include <linux/init.h>
636db0456SStephen Rothwell #include <linux/slab.h>
7e5779998SDaniel Mack #include <linux/usb.h>
8e5779998SDaniel Mack #include <linux/usb/audio.h>
97e847894SDaniel Mack #include <linux/usb/audio-v2.h>
109a2fe9b8SRuslan Bilovol #include <linux/usb/audio-v3.h>
11e5779998SDaniel Mack 
12e5779998SDaniel Mack #include <sound/core.h>
13e5779998SDaniel Mack #include <sound/pcm.h>
14e5779998SDaniel Mack 
15e5779998SDaniel Mack #include "usbaudio.h"
16e5779998SDaniel Mack #include "card.h"
17e5779998SDaniel Mack #include "quirks.h"
18e5779998SDaniel Mack #include "helper.h"
1979f920fbSDaniel Mack #include "clock.h"
20ee95cb61SDaniel Mack #include "format.h"
21e5779998SDaniel Mack 
22e5779998SDaniel Mack /*
23e5779998SDaniel Mack  * parse the audio format type I descriptor
24e5779998SDaniel Mack  * and returns the corresponding pcm format
25e5779998SDaniel Mack  *
26e5779998SDaniel Mack  * @dev: usb device
27e5779998SDaniel Mack  * @fp: audioformat record
28e5779998SDaniel Mack  * @format: the format tag (wFormatTag)
299a2fe9b8SRuslan Bilovol  * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
30e5779998SDaniel Mack  */
3129088fefSClemens Ladisch static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
32e5779998SDaniel Mack 				     struct audioformat *fp,
339a2fe9b8SRuslan Bilovol 				     u64 format, void *_fmt)
34e5779998SDaniel Mack {
35e5779998SDaniel Mack 	int sample_width, sample_bytes;
36717bfb5fSDaniel Mack 	u64 pcm_formats = 0;
37e5779998SDaniel Mack 
388f898e92SClemens Ladisch 	switch (fp->protocol) {
39a2acad82SClemens Ladisch 	case UAC_VERSION_1:
40a2acad82SClemens Ladisch 	default: {
41e5779998SDaniel Mack 		struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
4243d5ca88STakashi Iwai 		if (format >= 64)
4343d5ca88STakashi Iwai 			return 0; /* invalid format */
44e5779998SDaniel Mack 		sample_width = fmt->bBitResolution;
45e5779998SDaniel Mack 		sample_bytes = fmt->bSubframeSize;
46b44d419bSDan Carpenter 		format = 1ULL << format;
47e5779998SDaniel Mack 		break;
48e5779998SDaniel Mack 	}
49e5779998SDaniel Mack 
50e5779998SDaniel Mack 	case UAC_VERSION_2: {
51e5779998SDaniel Mack 		struct uac_format_type_i_ext_descriptor *fmt = _fmt;
52e5779998SDaniel Mack 		sample_width = fmt->bBitResolution;
53e5779998SDaniel Mack 		sample_bytes = fmt->bSubslotSize;
54717bfb5fSDaniel Mack 
553a572d94SJussi Laako 		if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
56717bfb5fSDaniel Mack 			pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
573a572d94SJussi Laako 			/* flag potentially raw DSD capable altsettings */
583a572d94SJussi Laako 			fp->dsd_raw = true;
593a572d94SJussi Laako 		}
60717bfb5fSDaniel Mack 
6129088fefSClemens Ladisch 		format <<= 1;
62e5779998SDaniel Mack 		break;
63e5779998SDaniel Mack 	}
649a2fe9b8SRuslan Bilovol 	case UAC_VERSION_3: {
659a2fe9b8SRuslan Bilovol 		struct uac3_as_header_descriptor *as = _fmt;
669a2fe9b8SRuslan Bilovol 
679a2fe9b8SRuslan Bilovol 		sample_width = as->bBitResolution;
689a2fe9b8SRuslan Bilovol 		sample_bytes = as->bSubslotSize;
699a2fe9b8SRuslan Bilovol 
709a2fe9b8SRuslan Bilovol 		if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
719a2fe9b8SRuslan Bilovol 			pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
729a2fe9b8SRuslan Bilovol 
739a2fe9b8SRuslan Bilovol 		format <<= 1;
749a2fe9b8SRuslan Bilovol 		break;
759a2fe9b8SRuslan Bilovol 	}
76e5779998SDaniel Mack 	}
77e5779998SDaniel Mack 
78c7a13264SJussi Laako 	fp->fmt_bits = sample_width;
79c7a13264SJussi Laako 
80717bfb5fSDaniel Mack 	if ((pcm_formats == 0) &&
81717bfb5fSDaniel Mack 	    (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
8229088fefSClemens Ladisch 		/* some devices don't define this correctly... */
830ba41d91STakashi Iwai 		usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
840ba41d91STakashi Iwai 			fp->iface, fp->altsetting);
8529088fefSClemens Ladisch 		format = 1 << UAC_FORMAT_TYPE_I_PCM;
8629088fefSClemens Ladisch 	}
8729088fefSClemens Ladisch 	if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
886d1f2f60STakamichi Horikawa 		if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
896d1f2f60STakamichi Horikawa 		     /* Edirol SD-90 */
906d1f2f60STakamichi Horikawa 		     (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
916d1f2f60STakamichi Horikawa 		     /* Roland SC-D70 */
92061b869eSClemens Ladisch 		    sample_width == 24 && sample_bytes == 2)
93061b869eSClemens Ladisch 			sample_bytes = 3;
94061b869eSClemens Ladisch 		else if (sample_width > sample_bytes * 8) {
950ba41d91STakashi Iwai 			usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
960ba41d91STakashi Iwai 				 fp->iface, fp->altsetting,
97e5779998SDaniel Mack 				 sample_width, sample_bytes);
98e5779998SDaniel Mack 		}
99e5779998SDaniel Mack 		/* check the format byte size */
100e5779998SDaniel Mack 		switch (sample_bytes) {
101e5779998SDaniel Mack 		case 1:
10229088fefSClemens Ladisch 			pcm_formats |= SNDRV_PCM_FMTBIT_S8;
103e5779998SDaniel Mack 			break;
104e5779998SDaniel Mack 		case 2:
105e5779998SDaniel Mack 			if (snd_usb_is_big_endian_format(chip, fp))
10629088fefSClemens Ladisch 				pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
107e5779998SDaniel Mack 			else
10829088fefSClemens Ladisch 				pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
109e5779998SDaniel Mack 			break;
110e5779998SDaniel Mack 		case 3:
111e5779998SDaniel Mack 			if (snd_usb_is_big_endian_format(chip, fp))
11229088fefSClemens Ladisch 				pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
113e5779998SDaniel Mack 			else
11429088fefSClemens Ladisch 				pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
115e5779998SDaniel Mack 			break;
116e5779998SDaniel Mack 		case 4:
11729088fefSClemens Ladisch 			pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
118e5779998SDaniel Mack 			break;
119e5779998SDaniel Mack 		default:
1200ba41d91STakashi Iwai 			usb_audio_info(chip,
1210ba41d91STakashi Iwai 				 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
1220ba41d91STakashi Iwai 				 fp->iface, fp->altsetting,
123e5779998SDaniel Mack 				 sample_width, sample_bytes);
124e5779998SDaniel Mack 			break;
125e5779998SDaniel Mack 		}
12629088fefSClemens Ladisch 	}
12729088fefSClemens Ladisch 	if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
128e5779998SDaniel Mack 		/* Dallas DS4201 workaround: it advertises U8 format, but really
129e5779998SDaniel Mack 		   supports S8. */
130e5779998SDaniel Mack 		if (chip->usb_id == USB_ID(0x04fa, 0x4201))
13129088fefSClemens Ladisch 			pcm_formats |= SNDRV_PCM_FMTBIT_S8;
13229088fefSClemens Ladisch 		else
13329088fefSClemens Ladisch 			pcm_formats |= SNDRV_PCM_FMTBIT_U8;
134e5779998SDaniel Mack 	}
13529088fefSClemens Ladisch 	if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
13629088fefSClemens Ladisch 		pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
13729088fefSClemens Ladisch 	}
13829088fefSClemens Ladisch 	if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
13929088fefSClemens Ladisch 		pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
14029088fefSClemens Ladisch 	}
14129088fefSClemens Ladisch 	if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
14229088fefSClemens Ladisch 		pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
14329088fefSClemens Ladisch 	}
14429088fefSClemens Ladisch 	if (format & ~0x3f) {
1450ba41d91STakashi Iwai 		usb_audio_info(chip,
1469a2fe9b8SRuslan Bilovol 			 "%u:%d : unsupported format bits %#llx\n",
1470ba41d91STakashi Iwai 			 fp->iface, fp->altsetting, format);
14829088fefSClemens Ladisch 	}
149126825e7SDaniel Mack 
150126825e7SDaniel Mack 	pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
151126825e7SDaniel Mack 
15229088fefSClemens Ladisch 	return pcm_formats;
153e5779998SDaniel Mack }
154e5779998SDaniel Mack 
15574f73476STakashi Iwai static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
15674f73476STakashi Iwai {
15774f73476STakashi Iwai 	kfree(fp->rate_table);
15874f73476STakashi Iwai 	fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
15974f73476STakashi Iwai 	if (!fp->rate_table)
16074f73476STakashi Iwai 		return -ENOMEM;
16174f73476STakashi Iwai 	fp->nr_rates = 1;
16274f73476STakashi Iwai 	fp->rate_min = rate;
16374f73476STakashi Iwai 	fp->rate_max = rate;
16474f73476STakashi Iwai 	fp->rates = rate_bits;
16574f73476STakashi Iwai 	fp->rate_table[0] = rate;
16674f73476STakashi Iwai 	return 0;
16774f73476STakashi Iwai }
168e5779998SDaniel Mack 
16913ee0336STakashi Iwai /* set up rate_min, rate_max and rates from the rate table */
17013ee0336STakashi Iwai static void set_rate_table_min_max(struct audioformat *fp)
17113ee0336STakashi Iwai {
17213ee0336STakashi Iwai 	unsigned int rate;
17313ee0336STakashi Iwai 	int i;
17413ee0336STakashi Iwai 
17513ee0336STakashi Iwai 	fp->rate_min = INT_MAX;
17613ee0336STakashi Iwai 	fp->rate_max = 0;
17713ee0336STakashi Iwai 	fp->rates = 0;
17813ee0336STakashi Iwai 	for (i = 0; i < fp->nr_rates; i++) {
17913ee0336STakashi Iwai 		rate = fp->rate_table[i];
18013ee0336STakashi Iwai 		fp->rate_min = min(fp->rate_min, rate);
18113ee0336STakashi Iwai 		fp->rate_max = max(fp->rate_max, rate);
18213ee0336STakashi Iwai 		fp->rates |= snd_pcm_rate_to_rate_bit(rate);
18313ee0336STakashi Iwai 	}
18413ee0336STakashi Iwai }
18513ee0336STakashi Iwai 
186e5779998SDaniel Mack /*
187e5779998SDaniel Mack  * parse the format descriptor and stores the possible sample rates
188e5779998SDaniel Mack  * on the audioformat table (audio class v1).
189e5779998SDaniel Mack  *
190e5779998SDaniel Mack  * @dev: usb device
191e5779998SDaniel Mack  * @fp: audioformat record
192e5779998SDaniel Mack  * @fmt: the format descriptor
193e5779998SDaniel Mack  * @offset: the start offset of descriptor pointing the rate type
194e5779998SDaniel Mack  *          (7 for type I and II, 8 for type II)
195e5779998SDaniel Mack  */
196e5779998SDaniel Mack static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
197e5779998SDaniel Mack 				       unsigned char *fmt, int offset)
198e5779998SDaniel Mack {
199e5779998SDaniel Mack 	int nr_rates = fmt[offset];
200e5779998SDaniel Mack 
201e5779998SDaniel Mack 	if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
2020ba41d91STakashi Iwai 		usb_audio_err(chip,
2030ba41d91STakashi Iwai 			"%u:%d : invalid UAC_FORMAT_TYPE desc\n",
2040ba41d91STakashi Iwai 			fp->iface, fp->altsetting);
2058ad10dc6SSachin Kamat 		return -EINVAL;
206e5779998SDaniel Mack 	}
207e5779998SDaniel Mack 
208e5779998SDaniel Mack 	if (nr_rates) {
209e5779998SDaniel Mack 		/*
210e5779998SDaniel Mack 		 * build the rate table and bitmap flags
211e5779998SDaniel Mack 		 */
212e5779998SDaniel Mack 		int r, idx;
213e5779998SDaniel Mack 
2146da2ec56SKees Cook 		fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
2156da2ec56SKees Cook 					       GFP_KERNEL);
2161bc00f32SShawn Lin 		if (fp->rate_table == NULL)
2178ad10dc6SSachin Kamat 			return -ENOMEM;
218e5779998SDaniel Mack 
219e5779998SDaniel Mack 		fp->nr_rates = 0;
220e5779998SDaniel Mack 		for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
221e5779998SDaniel Mack 			unsigned int rate = combine_triple(&fmt[idx]);
222e5779998SDaniel Mack 			if (!rate)
223e5779998SDaniel Mack 				continue;
224e5779998SDaniel Mack 			/* C-Media CM6501 mislabels its 96 kHz altsetting */
2258129e79eSWolfgang Breyha 			/* Terratec Aureon 7.1 USB C-Media 6206, too */
226e5779998SDaniel Mack 			if (rate == 48000 && nr_rates == 1 &&
227e5779998SDaniel Mack 			    (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
2288129e79eSWolfgang Breyha 			     chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
2298129e79eSWolfgang Breyha 			     chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
230e5779998SDaniel Mack 			    fp->altsetting == 5 && fp->maxpacksize == 392)
231e5779998SDaniel Mack 				rate = 96000;
2328c4b79cfSPavel Hofman 			/* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
2338c4b79cfSPavel Hofman 			if (rate == 16000 &&
2348c4b79cfSPavel Hofman 			    (chip->usb_id == USB_ID(0x041e, 0x4064) ||
2358c4b79cfSPavel Hofman 			     chip->usb_id == USB_ID(0x041e, 0x4068)))
236e5779998SDaniel Mack 				rate = 8000;
237e5779998SDaniel Mack 
23813ee0336STakashi Iwai 			fp->rate_table[fp->nr_rates++] = rate;
239e5779998SDaniel Mack 		}
240e5779998SDaniel Mack 		if (!fp->nr_rates) {
2417ec827b9STakashi Iwai 			usb_audio_info(chip,
2427ec827b9STakashi Iwai 				       "%u:%d: All rates were zero\n",
2437ec827b9STakashi Iwai 				       fp->iface, fp->altsetting);
2448ad10dc6SSachin Kamat 			return -EINVAL;
245e5779998SDaniel Mack 		}
24613ee0336STakashi Iwai 		set_rate_table_min_max(fp);
247e5779998SDaniel Mack 	} else {
248e5779998SDaniel Mack 		/* continuous rates */
249e5779998SDaniel Mack 		fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
250e5779998SDaniel Mack 		fp->rate_min = combine_triple(&fmt[offset + 1]);
251e5779998SDaniel Mack 		fp->rate_max = combine_triple(&fmt[offset + 4]);
252e5779998SDaniel Mack 	}
25374f73476STakashi Iwai 
25474f73476STakashi Iwai 	/* Jabra Evolve 65 headset */
25574f73476STakashi Iwai 	if (chip->usb_id == USB_ID(0x0b0e, 0x030b)) {
25674f73476STakashi Iwai 		/* only 48kHz for playback while keeping 16kHz for capture */
25774f73476STakashi Iwai 		if (fp->nr_rates != 1)
25874f73476STakashi Iwai 			return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
25974f73476STakashi Iwai 	}
26074f73476STakashi Iwai 
261e5779998SDaniel Mack 	return 0;
262e5779998SDaniel Mack }
263e5779998SDaniel Mack 
2648dc5efe3SNick Kossifidis 
2658dc5efe3SNick Kossifidis /*
2668dc5efe3SNick Kossifidis  * Presonus Studio 1810c supports a limited set of sampling
2678dc5efe3SNick Kossifidis  * rates per altsetting but reports the full set each time.
2688dc5efe3SNick Kossifidis  * If we don't filter out the unsupported rates and attempt
2698dc5efe3SNick Kossifidis  * to configure the card, it will hang refusing to do any
2708dc5efe3SNick Kossifidis  * further audio I/O until a hard reset is performed.
2718dc5efe3SNick Kossifidis  *
2728dc5efe3SNick Kossifidis  * The list of supported rates per altsetting (set of available
2738dc5efe3SNick Kossifidis  * I/O channels) is described in the owner's manual, section 2.2.
2748dc5efe3SNick Kossifidis  */
2758dc5efe3SNick Kossifidis static bool s1810c_valid_sample_rate(struct audioformat *fp,
2768dc5efe3SNick Kossifidis 				     unsigned int rate)
2778dc5efe3SNick Kossifidis {
2788dc5efe3SNick Kossifidis 	switch (fp->altsetting) {
2798dc5efe3SNick Kossifidis 	case 1:
2808dc5efe3SNick Kossifidis 		/* All ADAT ports available */
2818dc5efe3SNick Kossifidis 		return rate <= 48000;
2828dc5efe3SNick Kossifidis 	case 2:
2838dc5efe3SNick Kossifidis 		/* Half of ADAT ports available */
2848dc5efe3SNick Kossifidis 		return (rate == 88200 || rate == 96000);
2858dc5efe3SNick Kossifidis 	case 3:
2868dc5efe3SNick Kossifidis 		/* Analog I/O only (no S/PDIF nor ADAT) */
2878dc5efe3SNick Kossifidis 		return rate >= 176400;
2888dc5efe3SNick Kossifidis 	default:
2898dc5efe3SNick Kossifidis 		return false;
2908dc5efe3SNick Kossifidis 	}
2918dc5efe3SNick Kossifidis 	return false;
2928dc5efe3SNick Kossifidis }
2938dc5efe3SNick Kossifidis 
294e5779998SDaniel Mack /*
2951c826792SAlexander Tsoy  * Many Focusrite devices supports a limited set of sampling rates per
2961c826792SAlexander Tsoy  * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
2971c826792SAlexander Tsoy  * descriptor which has a non-standard bLength = 10.
2981c826792SAlexander Tsoy  */
2991c826792SAlexander Tsoy static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
3001c826792SAlexander Tsoy 					struct audioformat *fp,
3011c826792SAlexander Tsoy 					unsigned int rate)
3021c826792SAlexander Tsoy {
3031c826792SAlexander Tsoy 	struct usb_interface *iface;
3041c826792SAlexander Tsoy 	struct usb_host_interface *alts;
3051c826792SAlexander Tsoy 	unsigned char *fmt;
3061c826792SAlexander Tsoy 	unsigned int max_rate;
3071c826792SAlexander Tsoy 
3081c826792SAlexander Tsoy 	iface = usb_ifnum_to_if(chip->dev, fp->iface);
3091c826792SAlexander Tsoy 	if (!iface)
3101c826792SAlexander Tsoy 		return true;
3111c826792SAlexander Tsoy 
3121c826792SAlexander Tsoy 	alts = &iface->altsetting[fp->altset_idx];
3131c826792SAlexander Tsoy 	fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
3141c826792SAlexander Tsoy 				      NULL, UAC_FORMAT_TYPE);
3151c826792SAlexander Tsoy 	if (!fmt)
3161c826792SAlexander Tsoy 		return true;
3171c826792SAlexander Tsoy 
3181c826792SAlexander Tsoy 	if (fmt[0] == 10) { /* bLength */
3191c826792SAlexander Tsoy 		max_rate = combine_quad(&fmt[6]);
3201c826792SAlexander Tsoy 
3211c826792SAlexander Tsoy 		/* Validate max rate */
3221c826792SAlexander Tsoy 		if (max_rate != 48000 &&
3231c826792SAlexander Tsoy 		    max_rate != 96000 &&
3241c826792SAlexander Tsoy 		    max_rate != 192000 &&
3251c826792SAlexander Tsoy 		    max_rate != 384000) {
3261c826792SAlexander Tsoy 
3271c826792SAlexander Tsoy 			usb_audio_info(chip,
3281c826792SAlexander Tsoy 				"%u:%d : unexpected max rate: %u\n",
3291c826792SAlexander Tsoy 				fp->iface, fp->altsetting, max_rate);
3301c826792SAlexander Tsoy 
3311c826792SAlexander Tsoy 			return true;
3321c826792SAlexander Tsoy 		}
3331c826792SAlexander Tsoy 
3341c826792SAlexander Tsoy 		return rate <= max_rate;
3351c826792SAlexander Tsoy 	}
3361c826792SAlexander Tsoy 
3371c826792SAlexander Tsoy 	return true;
3381c826792SAlexander Tsoy }
3391c826792SAlexander Tsoy 
3401c826792SAlexander Tsoy /*
34167c10366SDaniel Mack  * Helper function to walk the array of sample rate triplets reported by
34267c10366SDaniel Mack  * the device. The problem is that we need to parse whole array first to
34367c10366SDaniel Mack  * get to know how many sample rates we have to expect.
34467c10366SDaniel Mack  * Then fp->rate_table can be allocated and filled.
34567c10366SDaniel Mack  */
3460ba41d91STakashi Iwai static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
3470ba41d91STakashi Iwai 					struct audioformat *fp, int nr_triplets,
34867c10366SDaniel Mack 					const unsigned char *data)
34967c10366SDaniel Mack {
35067c10366SDaniel Mack 	int i, nr_rates = 0;
35167c10366SDaniel Mack 
35267c10366SDaniel Mack 	for (i = 0; i < nr_triplets; i++) {
35367c10366SDaniel Mack 		int min = combine_quad(&data[2 + 12 * i]);
35467c10366SDaniel Mack 		int max = combine_quad(&data[6 + 12 * i]);
35567c10366SDaniel Mack 		int res = combine_quad(&data[10 + 12 * i]);
3564fa0e81bSXi Wang 		unsigned int rate;
35767c10366SDaniel Mack 
35867c10366SDaniel Mack 		if ((max < 0) || (min < 0) || (res < 0) || (max < min))
35967c10366SDaniel Mack 			continue;
36067c10366SDaniel Mack 
36167c10366SDaniel Mack 		/*
36267c10366SDaniel Mack 		 * for ranges with res == 1, we announce a continuous sample
36367c10366SDaniel Mack 		 * rate range, and this function should return 0 for no further
36467c10366SDaniel Mack 		 * parsing.
36567c10366SDaniel Mack 		 */
36667c10366SDaniel Mack 		if (res == 1) {
36767c10366SDaniel Mack 			fp->rate_min = min;
36867c10366SDaniel Mack 			fp->rate_max = max;
36967c10366SDaniel Mack 			fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
37067c10366SDaniel Mack 			return 0;
37167c10366SDaniel Mack 		}
37267c10366SDaniel Mack 
37367c10366SDaniel Mack 		for (rate = min; rate <= max; rate += res) {
3748dc5efe3SNick Kossifidis 
3758dc5efe3SNick Kossifidis 			/* Filter out invalid rates on Presonus Studio 1810c */
3768dc5efe3SNick Kossifidis 			if (chip->usb_id == USB_ID(0x0194f, 0x010c) &&
3778dc5efe3SNick Kossifidis 			    !s1810c_valid_sample_rate(fp, rate))
3788dc5efe3SNick Kossifidis 				goto skip_rate;
3798dc5efe3SNick Kossifidis 
3801c826792SAlexander Tsoy 			/* Filter out invalid rates on Focusrite devices */
3811c826792SAlexander Tsoy 			if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
3821c826792SAlexander Tsoy 			    !focusrite_valid_sample_rate(chip, fp, rate))
3831c826792SAlexander Tsoy 				goto skip_rate;
3841c826792SAlexander Tsoy 
38567c10366SDaniel Mack 			if (fp->rate_table)
38667c10366SDaniel Mack 				fp->rate_table[nr_rates] = rate;
38767c10366SDaniel Mack 			nr_rates++;
3888866f405SXi Wang 			if (nr_rates >= MAX_NR_RATES) {
3890ba41d91STakashi Iwai 				usb_audio_err(chip, "invalid uac2 rates\n");
3904fa0e81bSXi Wang 				break;
3914fa0e81bSXi Wang 			}
39267c10366SDaniel Mack 
3938dc5efe3SNick Kossifidis skip_rate:
39467c10366SDaniel Mack 			/* avoid endless loop */
39567c10366SDaniel Mack 			if (res == 0)
39667c10366SDaniel Mack 				break;
39767c10366SDaniel Mack 		}
39867c10366SDaniel Mack 	}
39967c10366SDaniel Mack 
40067c10366SDaniel Mack 	return nr_rates;
40167c10366SDaniel Mack }
40267c10366SDaniel Mack 
4038abf41dcSChristopher Swenson /* Line6 Helix series and the Rode Rodecaster Pro don't support the
4048abf41dcSChristopher Swenson  * UAC2_CS_RANGE usb function call. Return a static table of known
4058abf41dcSChristopher Swenson  * clock rates.
406d4bd3053SNicola Lunghi  */
407d4bd3053SNicola Lunghi static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
408d4bd3053SNicola Lunghi 						struct audioformat *fp)
409d4bd3053SNicola Lunghi {
410d4bd3053SNicola Lunghi 	switch (chip->usb_id) {
4118be03a71STakashi Iwai 	case USB_ID(0x0e41, 0x4241): /* Line6 Helix */
4128be03a71STakashi Iwai 	case USB_ID(0x0e41, 0x4242): /* Line6 Helix Rack */
4138be03a71STakashi Iwai 	case USB_ID(0x0e41, 0x4244): /* Line6 Helix LT */
4148be03a71STakashi Iwai 	case USB_ID(0x0e41, 0x4246): /* Line6 HX-Stomp */
4157da4c510SLukasz Halman 	case USB_ID(0x0e41, 0x4247): /* Line6 Pod Go */
4169b132f27STakashi Iwai 	case USB_ID(0x0e41, 0x4248): /* Line6 Helix >= fw 2.82 */
4179b132f27STakashi Iwai 	case USB_ID(0x0e41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
4189b132f27STakashi Iwai 	case USB_ID(0x0e41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
4198abf41dcSChristopher Swenson 	case USB_ID(0x19f7, 0x0011): /* Rode Rodecaster Pro */
42074f73476STakashi Iwai 		return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
421d4bd3053SNicola Lunghi 	}
422d4bd3053SNicola Lunghi 
423d4bd3053SNicola Lunghi 	return -ENODEV;
424d4bd3053SNicola Lunghi }
425d4bd3053SNicola Lunghi 
42693db51d0STakashi Iwai /* check whether the given altsetting is supported for the already set rate */
42793db51d0STakashi Iwai static bool check_valid_altsetting_v2v3(struct snd_usb_audio *chip, int iface,
42893db51d0STakashi Iwai 					int altsetting)
42993db51d0STakashi Iwai {
43093db51d0STakashi Iwai 	struct usb_device *dev = chip->dev;
43193db51d0STakashi Iwai 	__le64 raw_data = 0;
43293db51d0STakashi Iwai 	u64 data;
43393db51d0STakashi Iwai 	int err;
43493db51d0STakashi Iwai 
43593db51d0STakashi Iwai 	/* we assume 64bit is enough for any altsettings */
43693db51d0STakashi Iwai 	if (snd_BUG_ON(altsetting >= 64 - 8))
43793db51d0STakashi Iwai 		return false;
43893db51d0STakashi Iwai 
439*51cb8e20SJohan Hovold 	err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
44093db51d0STakashi Iwai 			      USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
44193db51d0STakashi Iwai 			      UAC2_AS_VAL_ALT_SETTINGS << 8,
44293db51d0STakashi Iwai 			      iface, &raw_data, sizeof(raw_data));
44393db51d0STakashi Iwai 	if (err < 0)
44493db51d0STakashi Iwai 		return false;
44593db51d0STakashi Iwai 
44693db51d0STakashi Iwai 	data = le64_to_cpu(raw_data);
44793db51d0STakashi Iwai 	/* first byte contains the bitmap size */
44893db51d0STakashi Iwai 	if ((data & 0xff) * 8 < altsetting)
44993db51d0STakashi Iwai 		return false;
45093db51d0STakashi Iwai 	if (data & (1ULL << (altsetting + 8)))
45193db51d0STakashi Iwai 		return true;
45293db51d0STakashi Iwai 
45393db51d0STakashi Iwai 	return false;
45493db51d0STakashi Iwai }
45593db51d0STakashi Iwai 
45693db51d0STakashi Iwai /*
45793db51d0STakashi Iwai  * Validate each sample rate with the altsetting
45893db51d0STakashi Iwai  * Rebuild the rate table if only partial values are valid
45993db51d0STakashi Iwai  */
46093db51d0STakashi Iwai static int validate_sample_rate_table_v2v3(struct snd_usb_audio *chip,
46193db51d0STakashi Iwai 					   struct audioformat *fp,
46293db51d0STakashi Iwai 					   int clock)
46393db51d0STakashi Iwai {
46493db51d0STakashi Iwai 	struct usb_device *dev = chip->dev;
46593db51d0STakashi Iwai 	unsigned int *table;
46693db51d0STakashi Iwai 	unsigned int nr_rates;
46793db51d0STakashi Iwai 	int i, err;
46893db51d0STakashi Iwai 
469fe773b87STakashi Iwai 	/* performing the rate verification may lead to unexpected USB bus
470fe773b87STakashi Iwai 	 * behavior afterwards by some unknown reason.  Do this only for the
471fe773b87STakashi Iwai 	 * known devices.
472fe773b87STakashi Iwai 	 */
473fe773b87STakashi Iwai 	switch (USB_ID_VENDOR(chip->usb_id)) {
474fe773b87STakashi Iwai 	case 0x07fd: /* MOTU */
475fe773b87STakashi Iwai 		break;
476fe773b87STakashi Iwai 	default:
477fe773b87STakashi Iwai 		return 0; /* don't perform the validation as default */
478fe773b87STakashi Iwai 	}
479fe773b87STakashi Iwai 
48093db51d0STakashi Iwai 	table = kcalloc(fp->nr_rates, sizeof(*table), GFP_KERNEL);
48193db51d0STakashi Iwai 	if (!table)
48293db51d0STakashi Iwai 		return -ENOMEM;
48393db51d0STakashi Iwai 
48493db51d0STakashi Iwai 	/* clear the interface altsetting at first */
48593db51d0STakashi Iwai 	usb_set_interface(dev, fp->iface, 0);
48693db51d0STakashi Iwai 
48793db51d0STakashi Iwai 	nr_rates = 0;
48893db51d0STakashi Iwai 	for (i = 0; i < fp->nr_rates; i++) {
48993db51d0STakashi Iwai 		err = snd_usb_set_sample_rate_v2v3(chip, fp, clock,
49093db51d0STakashi Iwai 						   fp->rate_table[i]);
49193db51d0STakashi Iwai 		if (err < 0)
49293db51d0STakashi Iwai 			continue;
49393db51d0STakashi Iwai 
49413ee0336STakashi Iwai 		if (check_valid_altsetting_v2v3(chip, fp->iface, fp->altsetting))
49593db51d0STakashi Iwai 			table[nr_rates++] = fp->rate_table[i];
49693db51d0STakashi Iwai 	}
49793db51d0STakashi Iwai 
49893db51d0STakashi Iwai 	if (!nr_rates) {
49993db51d0STakashi Iwai 		usb_audio_dbg(chip,
50093db51d0STakashi Iwai 			      "No valid sample rate available for %d:%d, assuming a firmware bug\n",
50193db51d0STakashi Iwai 			      fp->iface, fp->altsetting);
50293db51d0STakashi Iwai 		nr_rates = fp->nr_rates; /* continue as is */
50393db51d0STakashi Iwai 	}
50493db51d0STakashi Iwai 
50593db51d0STakashi Iwai 	if (fp->nr_rates == nr_rates) {
50693db51d0STakashi Iwai 		kfree(table);
50793db51d0STakashi Iwai 		return 0;
50893db51d0STakashi Iwai 	}
50993db51d0STakashi Iwai 
51093db51d0STakashi Iwai 	kfree(fp->rate_table);
51193db51d0STakashi Iwai 	fp->rate_table = table;
51293db51d0STakashi Iwai 	fp->nr_rates = nr_rates;
51393db51d0STakashi Iwai 	return 0;
51493db51d0STakashi Iwai }
51593db51d0STakashi Iwai 
51667c10366SDaniel Mack /*
517e5779998SDaniel Mack  * parse the format descriptor and stores the possible sample rates
5189a2fe9b8SRuslan Bilovol  * on the audioformat table (audio class v2 and v3).
519e5779998SDaniel Mack  */
5209a2fe9b8SRuslan Bilovol static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
5213d8d4dcfSDaniel Mack 				       struct audioformat *fp)
522e5779998SDaniel Mack {
523e5779998SDaniel Mack 	struct usb_device *dev = chip->dev;
524e5779998SDaniel Mack 	unsigned char tmp[2], *data;
525d4bd3053SNicola Lunghi 	int nr_triplets, data_size, ret = 0, ret_l6;
5269f35a312SAlexander Tsoy 	int clock = snd_usb_clock_find_source(chip, fp, false);
527e5779998SDaniel Mack 
528d07140baSDaniel Mack 	if (clock < 0) {
5290ba41d91STakashi Iwai 		dev_err(&dev->dev,
5300ba41d91STakashi Iwai 			"%s(): unable to find clock source (clock %d)\n",
531d07140baSDaniel Mack 				__func__, clock);
532d07140baSDaniel Mack 		goto err;
533d07140baSDaniel Mack 	}
534d07140baSDaniel Mack 
535e5779998SDaniel Mack 	/* get the number of sample rates first by only fetching 2 bytes */
536e5779998SDaniel Mack 	ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
537e5779998SDaniel Mack 			      USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
53811bcbc44SDaniel Mack 			      UAC2_CS_CONTROL_SAM_FREQ << 8,
53911bcbc44SDaniel Mack 			      snd_usb_ctrl_intf(chip) | (clock << 8),
54017d900c4SClemens Ladisch 			      tmp, sizeof(tmp));
541e5779998SDaniel Mack 
542e5779998SDaniel Mack 	if (ret < 0) {
543d4bd3053SNicola Lunghi 		/* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
544d4bd3053SNicola Lunghi 		ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
545d4bd3053SNicola Lunghi 		if (ret_l6 == -ENODEV) {
546d4bd3053SNicola Lunghi 			/* no line6 device found continue showing the error */
5470ba41d91STakashi Iwai 			dev_err(&dev->dev,
5480ba41d91STakashi Iwai 				"%s(): unable to retrieve number of sample rates (clock %d)\n",
54979f920fbSDaniel Mack 				__func__, clock);
550e5779998SDaniel Mack 			goto err;
551e5779998SDaniel Mack 		}
552d4bd3053SNicola Lunghi 		if (ret_l6 == 0) {
553d4bd3053SNicola Lunghi 			dev_info(&dev->dev,
554d4bd3053SNicola Lunghi 				"%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
555d4bd3053SNicola Lunghi 				__func__, clock);
556d4bd3053SNicola Lunghi 			return 0;
557d4bd3053SNicola Lunghi 		}
558d4bd3053SNicola Lunghi 		ret = ret_l6;
559d4bd3053SNicola Lunghi 		goto err;
560d4bd3053SNicola Lunghi 	}
561e5779998SDaniel Mack 
56267c10366SDaniel Mack 	nr_triplets = (tmp[1] << 8) | tmp[0];
56367c10366SDaniel Mack 	data_size = 2 + 12 * nr_triplets;
564e5779998SDaniel Mack 	data = kzalloc(data_size, GFP_KERNEL);
565e5779998SDaniel Mack 	if (!data) {
566e5779998SDaniel Mack 		ret = -ENOMEM;
567e5779998SDaniel Mack 		goto err;
568e5779998SDaniel Mack 	}
569e5779998SDaniel Mack 
570e5779998SDaniel Mack 	/* now get the full information */
571e5779998SDaniel Mack 	ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
572e5779998SDaniel Mack 			      USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
57311bcbc44SDaniel Mack 			      UAC2_CS_CONTROL_SAM_FREQ << 8,
57411bcbc44SDaniel Mack 			      snd_usb_ctrl_intf(chip) | (clock << 8),
57517d900c4SClemens Ladisch 			      data, data_size);
576e5779998SDaniel Mack 
577e5779998SDaniel Mack 	if (ret < 0) {
5780ba41d91STakashi Iwai 		dev_err(&dev->dev,
5790ba41d91STakashi Iwai 			"%s(): unable to retrieve sample rate range (clock %d)\n",
58079f920fbSDaniel Mack 				__func__, clock);
581e5779998SDaniel Mack 		ret = -EINVAL;
582e5779998SDaniel Mack 		goto err_free;
583e5779998SDaniel Mack 	}
584e5779998SDaniel Mack 
58567c10366SDaniel Mack 	/* Call the triplet parser, and make sure fp->rate_table is NULL.
58667c10366SDaniel Mack 	 * We just use the return value to know how many sample rates we
58767c10366SDaniel Mack 	 * will have to deal with. */
58867c10366SDaniel Mack 	kfree(fp->rate_table);
58967c10366SDaniel Mack 	fp->rate_table = NULL;
5900ba41d91STakashi Iwai 	fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
59167c10366SDaniel Mack 
59267c10366SDaniel Mack 	if (fp->nr_rates == 0) {
59367c10366SDaniel Mack 		/* SNDRV_PCM_RATE_CONTINUOUS */
59467c10366SDaniel Mack 		ret = 0;
59567c10366SDaniel Mack 		goto err_free;
59667c10366SDaniel Mack 	}
59767c10366SDaniel Mack 
5986da2ec56SKees Cook 	fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
599e5779998SDaniel Mack 	if (!fp->rate_table) {
600e5779998SDaniel Mack 		ret = -ENOMEM;
601e5779998SDaniel Mack 		goto err_free;
602e5779998SDaniel Mack 	}
603e5779998SDaniel Mack 
60467c10366SDaniel Mack 	/* Call the triplet parser again, but this time, fp->rate_table is
60567c10366SDaniel Mack 	 * allocated, so the rates will be stored */
6060ba41d91STakashi Iwai 	parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
607e5779998SDaniel Mack 
60893db51d0STakashi Iwai 	ret = validate_sample_rate_table_v2v3(chip, fp, clock);
60913ee0336STakashi Iwai 	if (ret < 0)
61013ee0336STakashi Iwai 		goto err_free;
61113ee0336STakashi Iwai 
61213ee0336STakashi Iwai 	set_rate_table_min_max(fp);
61393db51d0STakashi Iwai 
614e5779998SDaniel Mack err_free:
615e5779998SDaniel Mack 	kfree(data);
616e5779998SDaniel Mack err:
617e5779998SDaniel Mack 	return ret;
618e5779998SDaniel Mack }
619e5779998SDaniel Mack 
620e5779998SDaniel Mack /*
621e5779998SDaniel Mack  * parse the format type I and III descriptors
622e5779998SDaniel Mack  */
623e5779998SDaniel Mack static int parse_audio_format_i(struct snd_usb_audio *chip,
6249a2fe9b8SRuslan Bilovol 				struct audioformat *fp, u64 format,
6259a2fe9b8SRuslan Bilovol 				void *_fmt)
626e5779998SDaniel Mack {
62774c34ca1SEldad Zack 	snd_pcm_format_t pcm_format;
6289a2fe9b8SRuslan Bilovol 	unsigned int fmt_type;
62974c34ca1SEldad Zack 	int ret;
630e5779998SDaniel Mack 
6319a2fe9b8SRuslan Bilovol 	switch (fp->protocol) {
6329a2fe9b8SRuslan Bilovol 	default:
6339a2fe9b8SRuslan Bilovol 	case UAC_VERSION_1:
6349a2fe9b8SRuslan Bilovol 	case UAC_VERSION_2: {
6359a2fe9b8SRuslan Bilovol 		struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
6369a2fe9b8SRuslan Bilovol 
6379a2fe9b8SRuslan Bilovol 		fmt_type = fmt->bFormatType;
6389a2fe9b8SRuslan Bilovol 		break;
6399a2fe9b8SRuslan Bilovol 	}
6409a2fe9b8SRuslan Bilovol 	case UAC_VERSION_3: {
6419a2fe9b8SRuslan Bilovol 		/* fp->fmt_type is already set in this case */
6429a2fe9b8SRuslan Bilovol 		fmt_type = fp->fmt_type;
6439a2fe9b8SRuslan Bilovol 		break;
6449a2fe9b8SRuslan Bilovol 	}
6459a2fe9b8SRuslan Bilovol 	}
6469a2fe9b8SRuslan Bilovol 
6479a2fe9b8SRuslan Bilovol 	if (fmt_type == UAC_FORMAT_TYPE_III) {
648e5779998SDaniel Mack 		/* FIXME: the format type is really IECxxx
649e5779998SDaniel Mack 		 *        but we give normal PCM format to get the existing
650e5779998SDaniel Mack 		 *        apps working...
651e5779998SDaniel Mack 		 */
652e5779998SDaniel Mack 		switch (chip->usb_id) {
653e5779998SDaniel Mack 
654e5779998SDaniel Mack 		case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
655e5779998SDaniel Mack 			if (chip->setup == 0x00 &&
656e5779998SDaniel Mack 			    fp->altsetting == 6)
657e5779998SDaniel Mack 				pcm_format = SNDRV_PCM_FORMAT_S16_BE;
658e5779998SDaniel Mack 			else
659e5779998SDaniel Mack 				pcm_format = SNDRV_PCM_FORMAT_S16_LE;
660e5779998SDaniel Mack 			break;
661e5779998SDaniel Mack 		default:
662e5779998SDaniel Mack 			pcm_format = SNDRV_PCM_FORMAT_S16_LE;
663e5779998SDaniel Mack 		}
66474c34ca1SEldad Zack 		fp->formats = pcm_format_to_bits(pcm_format);
665e5779998SDaniel Mack 	} else {
6669a2fe9b8SRuslan Bilovol 		fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
66729088fefSClemens Ladisch 		if (!fp->formats)
6688ad10dc6SSachin Kamat 			return -EINVAL;
669e5779998SDaniel Mack 	}
670e5779998SDaniel Mack 
671e5779998SDaniel Mack 	/* gather possible sample rates */
672e5779998SDaniel Mack 	/* audio class v1 reports possible sample rates as part of the
673e5779998SDaniel Mack 	 * proprietary class specific descriptor.
674e5779998SDaniel Mack 	 * audio class v2 uses class specific EP0 range requests for that.
675e5779998SDaniel Mack 	 */
6768f898e92SClemens Ladisch 	switch (fp->protocol) {
677a2acad82SClemens Ladisch 	default:
6789a2fe9b8SRuslan Bilovol 	case UAC_VERSION_1: {
6799a2fe9b8SRuslan Bilovol 		struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
6809a2fe9b8SRuslan Bilovol 
681e5779998SDaniel Mack 		fp->channels = fmt->bNrChannels;
68274754f97SDaniel Mack 		ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
683e5779998SDaniel Mack 		break;
6849a2fe9b8SRuslan Bilovol 	}
685e5779998SDaniel Mack 	case UAC_VERSION_2:
6869a2fe9b8SRuslan Bilovol 	case UAC_VERSION_3: {
687e5779998SDaniel Mack 		/* fp->channels is already set in this case */
6889a2fe9b8SRuslan Bilovol 		ret = parse_audio_format_rates_v2v3(chip, fp);
689e5779998SDaniel Mack 		break;
690e5779998SDaniel Mack 	}
6919a2fe9b8SRuslan Bilovol 	}
692e5779998SDaniel Mack 
693e5779998SDaniel Mack 	if (fp->channels < 1) {
6940ba41d91STakashi Iwai 		usb_audio_err(chip,
6950ba41d91STakashi Iwai 			"%u:%d : invalid channels %d\n",
6960ba41d91STakashi Iwai 			fp->iface, fp->altsetting, fp->channels);
6978ad10dc6SSachin Kamat 		return -EINVAL;
698e5779998SDaniel Mack 	}
699e5779998SDaniel Mack 
700e5779998SDaniel Mack 	return ret;
701e5779998SDaniel Mack }
702e5779998SDaniel Mack 
703e5779998SDaniel Mack /*
704e5779998SDaniel Mack  * parse the format type II descriptor
705e5779998SDaniel Mack  */
706e5779998SDaniel Mack static int parse_audio_format_ii(struct snd_usb_audio *chip,
707e5779998SDaniel Mack 				 struct audioformat *fp,
7089a2fe9b8SRuslan Bilovol 				 u64 format, void *_fmt)
709e5779998SDaniel Mack {
710e5779998SDaniel Mack 	int brate, framesize, ret;
711e5779998SDaniel Mack 
712e5779998SDaniel Mack 	switch (format) {
713e5779998SDaniel Mack 	case UAC_FORMAT_TYPE_II_AC3:
714e5779998SDaniel Mack 		/* FIXME: there is no AC3 format defined yet */
715015eb0b0SClemens Ladisch 		// fp->formats = SNDRV_PCM_FMTBIT_AC3;
716015eb0b0SClemens Ladisch 		fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
717e5779998SDaniel Mack 		break;
718e5779998SDaniel Mack 	case UAC_FORMAT_TYPE_II_MPEG:
719015eb0b0SClemens Ladisch 		fp->formats = SNDRV_PCM_FMTBIT_MPEG;
720e5779998SDaniel Mack 		break;
721e5779998SDaniel Mack 	default:
7220ba41d91STakashi Iwai 		usb_audio_info(chip,
7239a2fe9b8SRuslan Bilovol 			 "%u:%d : unknown format tag %#llx is detected.  processed as MPEG.\n",
7240ba41d91STakashi Iwai 			 fp->iface, fp->altsetting, format);
725015eb0b0SClemens Ladisch 		fp->formats = SNDRV_PCM_FMTBIT_MPEG;
726e5779998SDaniel Mack 		break;
727e5779998SDaniel Mack 	}
728e5779998SDaniel Mack 
729e5779998SDaniel Mack 	fp->channels = 1;
730e5779998SDaniel Mack 
7318f898e92SClemens Ladisch 	switch (fp->protocol) {
732a2acad82SClemens Ladisch 	default:
733e5779998SDaniel Mack 	case UAC_VERSION_1: {
734e5779998SDaniel Mack 		struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
735e5779998SDaniel Mack 		brate = le16_to_cpu(fmt->wMaxBitRate);
736e5779998SDaniel Mack 		framesize = le16_to_cpu(fmt->wSamplesPerFrame);
7370ba41d91STakashi Iwai 		usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
738e5779998SDaniel Mack 		fp->frame_size = framesize;
739e5779998SDaniel Mack 		ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
740e5779998SDaniel Mack 		break;
741e5779998SDaniel Mack 	}
742e5779998SDaniel Mack 	case UAC_VERSION_2: {
743e5779998SDaniel Mack 		struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
744e5779998SDaniel Mack 		brate = le16_to_cpu(fmt->wMaxBitRate);
745e5779998SDaniel Mack 		framesize = le16_to_cpu(fmt->wSamplesPerFrame);
7460ba41d91STakashi Iwai 		usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
747e5779998SDaniel Mack 		fp->frame_size = framesize;
7489a2fe9b8SRuslan Bilovol 		ret = parse_audio_format_rates_v2v3(chip, fp);
749e5779998SDaniel Mack 		break;
750e5779998SDaniel Mack 	}
751e5779998SDaniel Mack 	}
752e5779998SDaniel Mack 
753e5779998SDaniel Mack 	return ret;
754e5779998SDaniel Mack }
755e5779998SDaniel Mack 
7562fcdb06dSDaniel Mack int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
7579a2fe9b8SRuslan Bilovol 			       struct audioformat *fp, u64 format,
7582fcdb06dSDaniel Mack 			       struct uac_format_type_i_continuous_descriptor *fmt,
7598f898e92SClemens Ladisch 			       int stream)
760e5779998SDaniel Mack {
761e5779998SDaniel Mack 	int err;
762e5779998SDaniel Mack 
76374754f97SDaniel Mack 	switch (fmt->bFormatType) {
764e5779998SDaniel Mack 	case UAC_FORMAT_TYPE_I:
765e5779998SDaniel Mack 	case UAC_FORMAT_TYPE_III:
7668f898e92SClemens Ladisch 		err = parse_audio_format_i(chip, fp, format, fmt);
767e5779998SDaniel Mack 		break;
768e5779998SDaniel Mack 	case UAC_FORMAT_TYPE_II:
7698f898e92SClemens Ladisch 		err = parse_audio_format_ii(chip, fp, format, fmt);
770e5779998SDaniel Mack 		break;
771e5779998SDaniel Mack 	default:
7720ba41d91STakashi Iwai 		usb_audio_info(chip,
7730ba41d91STakashi Iwai 			 "%u:%d : format type %d is not supported yet\n",
7740ba41d91STakashi Iwai 			 fp->iface, fp->altsetting,
77574754f97SDaniel Mack 			 fmt->bFormatType);
7768d091242SDaniel Mack 		return -ENOTSUPP;
777e5779998SDaniel Mack 	}
77874754f97SDaniel Mack 	fp->fmt_type = fmt->bFormatType;
779e5779998SDaniel Mack 	if (err < 0)
780e5779998SDaniel Mack 		return err;
781e5779998SDaniel Mack #if 1
782e5779998SDaniel Mack 	/* FIXME: temporary hack for extigy/audigy 2 nx/zs */
783e5779998SDaniel Mack 	/* extigy apparently supports sample rates other than 48k
784e5779998SDaniel Mack 	 * but not in ordinary way.  so we enable only 48k atm.
785e5779998SDaniel Mack 	 */
786e5779998SDaniel Mack 	if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
787e5779998SDaniel Mack 	    chip->usb_id == USB_ID(0x041e, 0x3020) ||
788e5779998SDaniel Mack 	    chip->usb_id == USB_ID(0x041e, 0x3061)) {
78974754f97SDaniel Mack 		if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
790e5779998SDaniel Mack 		    fp->rates != SNDRV_PCM_RATE_48000 &&
791e5779998SDaniel Mack 		    fp->rates != SNDRV_PCM_RATE_96000)
7928d091242SDaniel Mack 			return -ENOTSUPP;
793e5779998SDaniel Mack 	}
794e5779998SDaniel Mack #endif
795e5779998SDaniel Mack 	return 0;
796e5779998SDaniel Mack }
797e5779998SDaniel Mack 
7989a2fe9b8SRuslan Bilovol int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
7999a2fe9b8SRuslan Bilovol 			       struct audioformat *fp,
8009a2fe9b8SRuslan Bilovol 			       struct uac3_as_header_descriptor *as,
8019a2fe9b8SRuslan Bilovol 			       int stream)
8029a2fe9b8SRuslan Bilovol {
8039a2fe9b8SRuslan Bilovol 	u64 format = le64_to_cpu(as->bmFormats);
8049a2fe9b8SRuslan Bilovol 	int err;
8059a2fe9b8SRuslan Bilovol 
8069a2fe9b8SRuslan Bilovol 	/*
8079a2fe9b8SRuslan Bilovol 	 * Type I format bits are D0..D6
8089a2fe9b8SRuslan Bilovol 	 * This test works because type IV is not supported
8099a2fe9b8SRuslan Bilovol 	 */
8109a2fe9b8SRuslan Bilovol 	if (format & 0x7f)
8119a2fe9b8SRuslan Bilovol 		fp->fmt_type = UAC_FORMAT_TYPE_I;
8129a2fe9b8SRuslan Bilovol 	else
8139a2fe9b8SRuslan Bilovol 		fp->fmt_type = UAC_FORMAT_TYPE_III;
8149a2fe9b8SRuslan Bilovol 
8159a2fe9b8SRuslan Bilovol 	err = parse_audio_format_i(chip, fp, format, as);
8169a2fe9b8SRuslan Bilovol 	if (err < 0)
8179a2fe9b8SRuslan Bilovol 		return err;
8189a2fe9b8SRuslan Bilovol 
8199a2fe9b8SRuslan Bilovol 	return 0;
8209a2fe9b8SRuslan Bilovol }
821