[mirror_ubuntu-hirsute-kernel.git] / sound / usb / format.c

/*
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#include <linux/init.h>
#include <linux/slab.h>
#include <linux/usb.h>
#include <linux/usb/audio.h>
#include <linux/usb/audio-v2.h>
#include <linux/usb/audio-v3.h>

#include <sound/core.h>
#include <sound/pcm.h>

#include "usbaudio.h"
#include "card.h"
#include "quirks.h"
#include "helper.h"
#include "debug.h"
#include "clock.h"
#include "format.h"

/*
 * parse the audio format type I descriptor
 * and returns the corresponding pcm format
 *
 * @dev: usb device
 * @fp: audioformat record
 * @format: the format tag (wFormatTag)
 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
 */
static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
				     struct audioformat *fp,
				     u64 format, void *_fmt)
{
	int sample_width, sample_bytes;
	u64 pcm_formats = 0;

	switch (fp->protocol) {
	case UAC_VERSION_1:
	default: {
		struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
		sample_width = fmt->bBitResolution;
		sample_bytes = fmt->bSubframeSize;
		format = 1ULL << format;
		break;
	}

	case UAC_VERSION_2: {
		struct uac_format_type_i_ext_descriptor *fmt = _fmt;
		sample_width = fmt->bBitResolution;
		sample_bytes = fmt->bSubslotSize;

		if (format & UAC2_FORMAT_TYPE_I_RAW_DATA)
			pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;

		format <<= 1;
		break;
	}
	case UAC_VERSION_3: {
		struct uac3_as_header_descriptor *as = _fmt;

		sample_width = as->bBitResolution;
		sample_bytes = as->bSubslotSize;

		if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
			pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;

		format <<= 1;
		break;
	}
	}

	if ((pcm_formats == 0) &&
	    (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
		/* some devices don't define this correctly... */
		usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
			fp->iface, fp->altsetting);
		format = 1 << UAC_FORMAT_TYPE_I_PCM;
	}
	if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
		if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
		     /* Edirol SD-90 */
		     (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
		     /* Roland SC-D70 */
		    sample_width == 24 && sample_bytes == 2)
			sample_bytes = 3;
		else if (sample_width > sample_bytes * 8) {
			usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
				 fp->iface, fp->altsetting,
				 sample_width, sample_bytes);
		}
		/* check the format byte size */
		switch (sample_bytes) {
		case 1:
			pcm_formats |= SNDRV_PCM_FMTBIT_S8;
			break;
		case 2:
			if (snd_usb_is_big_endian_format(chip, fp))
				pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
			else
				pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
			break;
		case 3:
			if (snd_usb_is_big_endian_format(chip, fp))
				pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
			else
				pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
			break;
		case 4:
			pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
			break;
		default:
			usb_audio_info(chip,
				 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
				 fp->iface, fp->altsetting,
				 sample_width, sample_bytes);
			break;
		}
	}
	if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
		/* Dallas DS4201 workaround: it advertises U8 format, but really
		   supports S8. */
		if (chip->usb_id == USB_ID(0x04fa, 0x4201))
			pcm_formats |= SNDRV_PCM_FMTBIT_S8;
		else
			pcm_formats |= SNDRV_PCM_FMTBIT_U8;
	}
	if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
		pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
	}
	if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
		pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
	}
	if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
		pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
	}
	if (format & ~0x3f) {
		usb_audio_info(chip,
			 "%u:%d : unsupported format bits %#llx\n",
			 fp->iface, fp->altsetting, format);
	}

	pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);

	return pcm_formats;
}


/*
 * parse the format descriptor and stores the possible sample rates
 * on the audioformat table (audio class v1).
 *
 * @dev: usb device
 * @fp: audioformat record
 * @fmt: the format descriptor
 * @offset: the start offset of descriptor pointing the rate type
 *          (7 for type I and II, 8 for type II)
 */
static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
				       unsigned char *fmt, int offset)
{
	int nr_rates = fmt[offset];

	if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
		usb_audio_err(chip,
			"%u:%d : invalid UAC_FORMAT_TYPE desc\n",
			fp->iface, fp->altsetting);
		return -EINVAL;
	}

	if (nr_rates) {
		/*
		 * build the rate table and bitmap flags
		 */
		int r, idx;

		fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
					       GFP_KERNEL);
		if (fp->rate_table == NULL)
			return -ENOMEM;

		fp->nr_rates = 0;
		fp->rate_min = fp->rate_max = 0;
		for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
			unsigned int rate = combine_triple(&fmt[idx]);
			if (!rate)
				continue;
			/* C-Media CM6501 mislabels its 96 kHz altsetting */
			/* Terratec Aureon 7.1 USB C-Media 6206, too */
			if (rate == 48000 && nr_rates == 1 &&
			    (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
			     chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
			     chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
			    fp->altsetting == 5 && fp->maxpacksize == 392)
				rate = 96000;
			/* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
			if (rate == 16000 &&
			    (chip->usb_id == USB_ID(0x041e, 0x4064) ||
			     chip->usb_id == USB_ID(0x041e, 0x4068)))
				rate = 8000;

			fp->rate_table[fp->nr_rates] = rate;
			if (!fp->rate_min || rate < fp->rate_min)
				fp->rate_min = rate;
			if (!fp->rate_max || rate > fp->rate_max)
				fp->rate_max = rate;
			fp->rates |= snd_pcm_rate_to_rate_bit(rate);
			fp->nr_rates++;
		}
		if (!fp->nr_rates) {
			hwc_debug("All rates were zero. Skipping format!\n");
			return -EINVAL;
		}
	} else {
		/* continuous rates */
		fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
		fp->rate_min = combine_triple(&fmt[offset + 1]);
		fp->rate_max = combine_triple(&fmt[offset + 4]);
	}
	return 0;
}

/*
 * Helper function to walk the array of sample rate triplets reported by
 * the device. The problem is that we need to parse whole array first to
 * get to know how many sample rates we have to expect.
 * Then fp->rate_table can be allocated and filled.
 */
static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
					struct audioformat *fp, int nr_triplets,
					const unsigned char *data)
{
	int i, nr_rates = 0;

	fp->rates = fp->rate_min = fp->rate_max = 0;

	for (i = 0; i < nr_triplets; i++) {
		int min = combine_quad(&data[2 + 12 * i]);
		int max = combine_quad(&data[6 + 12 * i]);
		int res = combine_quad(&data[10 + 12 * i]);
		unsigned int rate;

		if ((max < 0) || (min < 0) || (res < 0) || (max < min))
			continue;

		/*
		 * for ranges with res == 1, we announce a continuous sample
		 * rate range, and this function should return 0 for no further
		 * parsing.
		 */
		if (res == 1) {
			fp->rate_min = min;
			fp->rate_max = max;
			fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
			return 0;
		}

		for (rate = min; rate <= max; rate += res) {
			if (fp->rate_table)
				fp->rate_table[nr_rates] = rate;
			if (!fp->rate_min || rate < fp->rate_min)
				fp->rate_min = rate;
			if (!fp->rate_max || rate > fp->rate_max)
				fp->rate_max = rate;
			fp->rates |= snd_pcm_rate_to_rate_bit(rate);

			nr_rates++;
			if (nr_rates >= MAX_NR_RATES) {
				usb_audio_err(chip, "invalid uac2 rates\n");
				break;
			}

			/* avoid endless loop */
			if (res == 0)
				break;
		}
	}

	return nr_rates;
}

/*
 * parse the format descriptor and stores the possible sample rates
 * on the audioformat table (audio class v2 and v3).
 */
static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
				       struct audioformat *fp)
{
	struct usb_device *dev = chip->dev;
	unsigned char tmp[2], *data;
	int nr_triplets, data_size, ret = 0;
	int clock = snd_usb_clock_find_source(chip, fp->protocol,
					      fp->clock, false);

	if (clock < 0) {
		dev_err(&dev->dev,
			"%s(): unable to find clock source (clock %d)\n",
				__func__, clock);
		goto err;
	}

	/* get the number of sample rates first by only fetching 2 bytes */
	ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
			      USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
			      UAC2_CS_CONTROL_SAM_FREQ << 8,
			      snd_usb_ctrl_intf(chip) | (clock << 8),
			      tmp, sizeof(tmp));

	if (ret < 0) {
		dev_err(&dev->dev,
			"%s(): unable to retrieve number of sample rates (clock %d)\n",
				__func__, clock);
		goto err;
	}

	nr_triplets = (tmp[1] << 8) | tmp[0];
	data_size = 2 + 12 * nr_triplets;
	data = kzalloc(data_size, GFP_KERNEL);
	if (!data) {
		ret = -ENOMEM;
		goto err;
	}

	/* now get the full information */
	ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
			      USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
			      UAC2_CS_CONTROL_SAM_FREQ << 8,
			      snd_usb_ctrl_intf(chip) | (clock << 8),
			      data, data_size);

	if (ret < 0) {
		dev_err(&dev->dev,
			"%s(): unable to retrieve sample rate range (clock %d)\n",
				__func__, clock);
		ret = -EINVAL;
		goto err_free;
	}

	/* Call the triplet parser, and make sure fp->rate_table is NULL.
	 * We just use the return value to know how many sample rates we
	 * will have to deal with. */
	kfree(fp->rate_table);
	fp->rate_table = NULL;
	fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);

	if (fp->nr_rates == 0) {
		/* SNDRV_PCM_RATE_CONTINUOUS */
		ret = 0;
		goto err_free;
	}

	fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
	if (!fp->rate_table) {
		ret = -ENOMEM;
		goto err_free;
	}

	/* Call the triplet parser again, but this time, fp->rate_table is
	 * allocated, so the rates will be stored */
	parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);

err_free:
	kfree(data);
err:
	return ret;
}

/*
 * parse the format type I and III descriptors
 */
static int parse_audio_format_i(struct snd_usb_audio *chip,
				struct audioformat *fp, u64 format,
				void *_fmt)
{
	snd_pcm_format_t pcm_format;
	unsigned int fmt_type;
	int ret;

	switch (fp->protocol) {
	default:
	case UAC_VERSION_1:
	case UAC_VERSION_2: {
		struct uac_format_type_i_continuous_descriptor *fmt = _fmt;

		fmt_type = fmt->bFormatType;
		break;
	}
	case UAC_VERSION_3: {
		/* fp->fmt_type is already set in this case */
		fmt_type = fp->fmt_type;
		break;
	}
	}

	if (fmt_type == UAC_FORMAT_TYPE_III) {
		/* FIXME: the format type is really IECxxx
		 *        but we give normal PCM format to get the existing
		 *        apps working...
		 */
		switch (chip->usb_id) {

		case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
			if (chip->setup == 0x00 && 
			    fp->altsetting == 6)
				pcm_format = SNDRV_PCM_FORMAT_S16_BE;
			else
				pcm_format = SNDRV_PCM_FORMAT_S16_LE;
			break;
		default:
			pcm_format = SNDRV_PCM_FORMAT_S16_LE;
		}
		fp->formats = pcm_format_to_bits(pcm_format);
	} else {
		fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
		if (!fp->formats)
			return -EINVAL;
	}

	/* gather possible sample rates */
	/* audio class v1 reports possible sample rates as part of the
	 * proprietary class specific descriptor.
	 * audio class v2 uses class specific EP0 range requests for that.
	 */
	switch (fp->protocol) {
	default:
	case UAC_VERSION_1: {
		struct uac_format_type_i_continuous_descriptor *fmt = _fmt;

		fp->channels = fmt->bNrChannels;
		ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
		break;
	}
	case UAC_VERSION_2:
	case UAC_VERSION_3: {
		/* fp->channels is already set in this case */
		ret = parse_audio_format_rates_v2v3(chip, fp);
		break;
	}
	}

	if (fp->channels < 1) {
		usb_audio_err(chip,
			"%u:%d : invalid channels %d\n",
			fp->iface, fp->altsetting, fp->channels);
		return -EINVAL;
	}

	return ret;
}

/*
 * parse the format type II descriptor
 */
static int parse_audio_format_ii(struct snd_usb_audio *chip,
				 struct audioformat *fp,
				 u64 format, void *_fmt)
{
	int brate, framesize, ret;

	switch (format) {
	case UAC_FORMAT_TYPE_II_AC3:
		/* FIXME: there is no AC3 format defined yet */
		// fp->formats = SNDRV_PCM_FMTBIT_AC3;
		fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
		break;
	case UAC_FORMAT_TYPE_II_MPEG:
		fp->formats = SNDRV_PCM_FMTBIT_MPEG;
		break;
	default:
		usb_audio_info(chip,
			 "%u:%d : unknown format tag %#llx is detected.  processed as MPEG.\n",
			 fp->iface, fp->altsetting, format);
		fp->formats = SNDRV_PCM_FMTBIT_MPEG;
		break;
	}

	fp->channels = 1;

	switch (fp->protocol) {
	default:
	case UAC_VERSION_1: {
		struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
		brate = le16_to_cpu(fmt->wMaxBitRate);
		framesize = le16_to_cpu(fmt->wSamplesPerFrame);
		usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
		fp->frame_size = framesize;
		ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
		break;
	}
	case UAC_VERSION_2: {
		struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
		brate = le16_to_cpu(fmt->wMaxBitRate);
		framesize = le16_to_cpu(fmt->wSamplesPerFrame);
		usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
		fp->frame_size = framesize;
		ret = parse_audio_format_rates_v2v3(chip, fp);
		break;
	}
	}

	return ret;
}

int 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)
{
	int err;

	switch (fmt->bFormatType) {
	case UAC_FORMAT_TYPE_I:
	case UAC_FORMAT_TYPE_III:
		err = parse_audio_format_i(chip, fp, format, fmt);
		break;
	case UAC_FORMAT_TYPE_II:
		err = parse_audio_format_ii(chip, fp, format, fmt);
		break;
	default:
		usb_audio_info(chip,
			 "%u:%d : format type %d is not supported yet\n",
			 fp->iface, fp->altsetting,
			 fmt->bFormatType);
		return -ENOTSUPP;
	}
	fp->fmt_type = fmt->bFormatType;
	if (err < 0)
		return err;
#if 1
	/* FIXME: temporary hack for extigy/audigy 2 nx/zs */
	/* extigy apparently supports sample rates other than 48k
	 * but not in ordinary way.  so we enable only 48k atm.
	 */
	if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
	    chip->usb_id == USB_ID(0x041e, 0x3020) ||
	    chip->usb_id == USB_ID(0x041e, 0x3061)) {
		if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
		    fp->rates != SNDRV_PCM_RATE_48000 &&
		    fp->rates != SNDRV_PCM_RATE_96000)
			return -ENOTSUPP;
	}
#endif
	return 0;
}

int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
			       struct audioformat *fp,
			       struct uac3_as_header_descriptor *as,
			       int stream)
{
	u64 format = le64_to_cpu(as->bmFormats);
	int err;

	/*
	 * Type I format bits are D0..D6
	 * This test works because type IV is not supported
	 */
	if (format & 0x7f)
		fp->fmt_type = UAC_FORMAT_TYPE_I;
	else
		fp->fmt_type = UAC_FORMAT_TYPE_III;

	err = parse_audio_format_i(chip, fp, format, as);
	if (err < 0)
		return err;

	return 0;
}
Commit	Line	Data
e5779998 DM	1	/*
	2	* This program is free software; you can redistribute it and/or modify
	3	* it under the terms of the GNU General Public License as published by
	4	* the Free Software Foundation; either version 2 of the License, or
	5	* (at your option) any later version.
	6	*
	7	* This program is distributed in the hope that it will be useful,
	8	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	9	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	10	* GNU General Public License for more details.
	11	*
	12	* You should have received a copy of the GNU General Public License
	13	* along with this program; if not, write to the Free Software
	14	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	15	*
	16	*/
	17
	18	#include <linux/init.h>
36db0456	19	#include <linux/slab.h>
e5779998 DM	20	#include <linux/usb.h>
e5779998 DM	21	#include <linux/usb/audio.h>
7e847894	22	#include <linux/usb/audio-v2.h>
9a2fe9b8	23	#include <linux/usb/audio-v3.h>
e5779998 DM	24
	25	#include <sound/core.h>
	26	#include <sound/pcm.h>
	27
	28	#include "usbaudio.h"
	29	#include "card.h"
	30	#include "quirks.h"
	31	#include "helper.h"
	32	#include "debug.h"
79f920fb	33	#include "clock.h"
ee95cb61	34	#include "format.h"
e5779998 DM	35
	36	/*
	37	* parse the audio format type I descriptor
	38	* and returns the corresponding pcm format
	39	*
	40	* @dev: usb device
	41	* @fp: audioformat record
	42	* @format: the format tag (wFormatTag)
9a2fe9b8	43	* @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
e5779998	44	*/
29088fef	45	static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
e5779998	46	struct audioformat *fp,
9a2fe9b8	47	u64 format, void *_fmt)
e5779998	48	{
e5779998	49	int sample_width, sample_bytes;
717bfb5f	50	u64 pcm_formats = 0;
e5779998	51
8f898e92	52	switch (fp->protocol) {
a2acad82 CL	53	case UAC_VERSION_1:
a2acad82 CL	54	default: {
e5779998 DM	55	struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
	56	sample_width = fmt->bBitResolution;
	57	sample_bytes = fmt->bSubframeSize;
b44d419b	58	format = 1ULL << format;
e5779998 DM	59	break;
	60	}
	61
	62	case UAC_VERSION_2: {
	63	struct uac_format_type_i_ext_descriptor *fmt = _fmt;
	64	sample_width = fmt->bBitResolution;
	65	sample_bytes = fmt->bSubslotSize;
717bfb5f DM	66
	67	if (format & UAC2_FORMAT_TYPE_I_RAW_DATA)
	68	pcm_formats \|= SNDRV_PCM_FMTBIT_SPECIAL;
	69
29088fef	70	format <<= 1;
e5779998 DM	71	break;
e5779998 DM	72	}
9a2fe9b8 RB	73	case UAC_VERSION_3: {
	74	struct uac3_as_header_descriptor *as = _fmt;
	75
	76	sample_width = as->bBitResolution;
	77	sample_bytes = as->bSubslotSize;
	78
	79	if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
	80	pcm_formats \|= SNDRV_PCM_FMTBIT_SPECIAL;
	81
	82	format <<= 1;
	83	break;
	84	}
e5779998 DM	85	}
e5779998 DM	86
717bfb5f DM	87	if ((pcm_formats == 0) &&
717bfb5f DM	88	(format == 0 \|\| format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
29088fef	89	/* some devices don't define this correctly... */
0ba41d91 TI	90	usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
0ba41d91 TI	91	fp->iface, fp->altsetting);
29088fef CL	92	format = 1 << UAC_FORMAT_TYPE_I_PCM;
	93	}
	94	if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
6d1f2f60 TH	95	if (((chip->usb_id == USB_ID(0x0582, 0x0016)) \|\|
	96	/* Edirol SD-90 */
	97	(chip->usb_id == USB_ID(0x0582, 0x000c))) &&
	98	/* Roland SC-D70 */
061b869e CL	99	sample_width == 24 && sample_bytes == 2)
	100	sample_bytes = 3;
	101	else if (sample_width > sample_bytes * 8) {
0ba41d91 TI	102	usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
	103	fp->iface, fp->altsetting,
	104	sample_width, sample_bytes);
e5779998 DM	105	}
	106	/* check the format byte size */
	107	switch (sample_bytes) {
	108	case 1:
29088fef	109	pcm_formats \|= SNDRV_PCM_FMTBIT_S8;
e5779998 DM	110	break;
	111	case 2:
	112	if (snd_usb_is_big_endian_format(chip, fp))
29088fef	113	pcm_formats \|= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
e5779998	114	else
29088fef	115	pcm_formats \|= SNDRV_PCM_FMTBIT_S16_LE;
e5779998 DM	116	break;
	117	case 3:
	118	if (snd_usb_is_big_endian_format(chip, fp))
29088fef	119	pcm_formats \|= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
e5779998	120	else
29088fef	121	pcm_formats \|= SNDRV_PCM_FMTBIT_S24_3LE;
e5779998 DM	122	break;
e5779998 DM	123	case 4:
29088fef	124	pcm_formats \|= SNDRV_PCM_FMTBIT_S32_LE;
e5779998 DM	125	break;
e5779998 DM	126	default:
0ba41d91 TI	127	usb_audio_info(chip,
	128	"%u:%d : unsupported sample bitwidth %d in %d bytes\n",
	129	fp->iface, fp->altsetting,
	130	sample_width, sample_bytes);
e5779998 DM	131	break;
e5779998 DM	132	}
29088fef CL	133	}
29088fef CL	134	if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
e5779998 DM	135	/* Dallas DS4201 workaround: it advertises U8 format, but really
	136	supports S8. */
	137	if (chip->usb_id == USB_ID(0x04fa, 0x4201))
29088fef CL	138	pcm_formats \|= SNDRV_PCM_FMTBIT_S8;
	139	else
	140	pcm_formats \|= SNDRV_PCM_FMTBIT_U8;
	141	}
	142	if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
	143	pcm_formats \|= SNDRV_PCM_FMTBIT_FLOAT_LE;
	144	}
	145	if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
	146	pcm_formats \|= SNDRV_PCM_FMTBIT_A_LAW;
	147	}
	148	if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
	149	pcm_formats \|= SNDRV_PCM_FMTBIT_MU_LAW;
	150	}
	151	if (format & ~0x3f) {
0ba41d91	152	usb_audio_info(chip,
9a2fe9b8	153	"%u:%d : unsupported format bits %#llx\n",
0ba41d91	154	fp->iface, fp->altsetting, format);
e5779998	155	}
126825e7 DM	156
	157	pcm_formats \|= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
	158
29088fef	159	return pcm_formats;
e5779998 DM	160	}
	161
	162
	163	/*
	164	* parse the format descriptor and stores the possible sample rates
	165	* on the audioformat table (audio class v1).
	166	*
	167	* @dev: usb device
	168	* @fp: audioformat record
	169	* @fmt: the format descriptor
	170	* @offset: the start offset of descriptor pointing the rate type
	171	* (7 for type I and II, 8 for type II)
	172	*/
	173	static int parse_audio_format_rates_v1(struct snd_usb_audio chip, struct audioformat fp,
	174	unsigned char *fmt, int offset)
	175	{
	176	int nr_rates = fmt[offset];
	177
	178	if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
0ba41d91 TI	179	usb_audio_err(chip,
	180	"%u:%d : invalid UAC_FORMAT_TYPE desc\n",
	181	fp->iface, fp->altsetting);
8ad10dc6	182	return -EINVAL;
e5779998 DM	183	}
	184
	185	if (nr_rates) {
	186	/*
	187	* build the rate table and bitmap flags
	188	*/
	189	int r, idx;
	190
6da2ec56 KC	191	fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
6da2ec56 KC	192	GFP_KERNEL);
1bc00f32	193	if (fp->rate_table == NULL)
8ad10dc6	194	return -ENOMEM;
e5779998 DM	195
	196	fp->nr_rates = 0;
	197	fp->rate_min = fp->rate_max = 0;
	198	for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
	199	unsigned int rate = combine_triple(&fmt[idx]);
	200	if (!rate)
	201	continue;
	202	/* C-Media CM6501 mislabels its 96 kHz altsetting */
8129e79e	203	/* Terratec Aureon 7.1 USB C-Media 6206, too */
e5779998 DM	204	if (rate == 48000 && nr_rates == 1 &&
e5779998 DM	205	(chip->usb_id == USB_ID(0x0d8c, 0x0201) \|\|
8129e79e WB	206	chip->usb_id == USB_ID(0x0d8c, 0x0102) \|\|
8129e79e WB	207	chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
e5779998 DM	208	fp->altsetting == 5 && fp->maxpacksize == 392)
e5779998 DM	209	rate = 96000;
8c4b79cf PH	210	/* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
	211	if (rate == 16000 &&
	212	(chip->usb_id == USB_ID(0x041e, 0x4064) \|\|
	213	chip->usb_id == USB_ID(0x041e, 0x4068)))
e5779998 DM	214	rate = 8000;
	215
	216	fp->rate_table[fp->nr_rates] = rate;
	217	if (!fp->rate_min \|\| rate < fp->rate_min)
	218	fp->rate_min = rate;
	219	if (!fp->rate_max \|\| rate > fp->rate_max)
	220	fp->rate_max = rate;
	221	fp->rates \|= snd_pcm_rate_to_rate_bit(rate);
	222	fp->nr_rates++;
	223	}
	224	if (!fp->nr_rates) {
	225	hwc_debug("All rates were zero. Skipping format!\n");
8ad10dc6	226	return -EINVAL;
e5779998 DM	227	}
	228	} else {
	229	/* continuous rates */
	230	fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
	231	fp->rate_min = combine_triple(&fmt[offset + 1]);
	232	fp->rate_max = combine_triple(&fmt[offset + 4]);
	233	}
	234	return 0;
	235	}
	236
67c10366 DM	237	/*
	238	* Helper function to walk the array of sample rate triplets reported by
	239	* the device. The problem is that we need to parse whole array first to
	240	* get to know how many sample rates we have to expect.
	241	* Then fp->rate_table can be allocated and filled.
	242	*/
0ba41d91 TI	243	static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
0ba41d91 TI	244	struct audioformat *fp, int nr_triplets,
67c10366 DM	245	const unsigned char *data)
	246	{
	247	int i, nr_rates = 0;
	248
	249	fp->rates = fp->rate_min = fp->rate_max = 0;
	250
	251	for (i = 0; i < nr_triplets; i++) {
	252	int min = combine_quad(&data[2 + 12 * i]);
	253	int max = combine_quad(&data[6 + 12 * i]);
	254	int res = combine_quad(&data[10 + 12 * i]);
4fa0e81b	255	unsigned int rate;
67c10366 DM	256
	257	if ((max < 0) \|\| (min < 0) \|\| (res < 0) \|\| (max < min))
	258	continue;
	259
	260	/*
	261	* for ranges with res == 1, we announce a continuous sample
	262	* rate range, and this function should return 0 for no further
	263	* parsing.
	264	*/
	265	if (res == 1) {
	266	fp->rate_min = min;
	267	fp->rate_max = max;
	268	fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
	269	return 0;
	270	}
	271
	272	for (rate = min; rate <= max; rate += res) {
	273	if (fp->rate_table)
	274	fp->rate_table[nr_rates] = rate;
	275	if (!fp->rate_min \|\| rate < fp->rate_min)
	276	fp->rate_min = rate;
	277	if (!fp->rate_max \|\| rate > fp->rate_max)
	278	fp->rate_max = rate;
	279	fp->rates \|= snd_pcm_rate_to_rate_bit(rate);
	280
	281	nr_rates++;
8866f405	282	if (nr_rates >= MAX_NR_RATES) {
0ba41d91	283	usb_audio_err(chip, "invalid uac2 rates\n");
4fa0e81b XW	284	break;
4fa0e81b XW	285	}
67c10366 DM	286
	287	/* avoid endless loop */
	288	if (res == 0)
	289	break;
	290	}
	291	}
	292
	293	return nr_rates;
	294	}
	295
e5779998 DM	296	/*
e5779998 DM	297	* parse the format descriptor and stores the possible sample rates
9a2fe9b8	298	* on the audioformat table (audio class v2 and v3).
e5779998	299	*/
9a2fe9b8	300	static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
3d8d4dcf	301	struct audioformat *fp)
e5779998 DM	302	{
	303	struct usb_device *dev = chip->dev;
	304	unsigned char tmp[2], *data;
67c10366	305	int nr_triplets, data_size, ret = 0;
9a2fe9b8 RB	306	int clock = snd_usb_clock_find_source(chip, fp->protocol,
9a2fe9b8 RB	307	fp->clock, false);
e5779998	308
d07140ba	309	if (clock < 0) {
0ba41d91 TI	310	dev_err(&dev->dev,
0ba41d91 TI	311	"%s(): unable to find clock source (clock %d)\n",
d07140ba DM	312	__func__, clock);
	313	goto err;
	314	}
	315
e5779998 DM	316	/* get the number of sample rates first by only fetching 2 bytes */
	317	ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
	318	USB_TYPE_CLASS \| USB_RECIP_INTERFACE \| USB_DIR_IN,
11bcbc44 DM	319	UAC2_CS_CONTROL_SAM_FREQ << 8,
11bcbc44 DM	320	snd_usb_ctrl_intf(chip) \| (clock << 8),
17d900c4	321	tmp, sizeof(tmp));
e5779998 DM	322
e5779998 DM	323	if (ret < 0) {
0ba41d91 TI	324	dev_err(&dev->dev,
0ba41d91 TI	325	"%s(): unable to retrieve number of sample rates (clock %d)\n",
79f920fb	326	__func__, clock);
e5779998 DM	327	goto err;
	328	}
	329
67c10366 DM	330	nr_triplets = (tmp[1] << 8) \| tmp[0];
67c10366 DM	331	data_size = 2 + 12 * nr_triplets;
e5779998 DM	332	data = kzalloc(data_size, GFP_KERNEL);
	333	if (!data) {
	334	ret = -ENOMEM;
	335	goto err;
	336	}
	337
	338	/* now get the full information */
	339	ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
79f920fb	340	USB_TYPE_CLASS \| USB_RECIP_INTERFACE \| USB_DIR_IN,
11bcbc44 DM	341	UAC2_CS_CONTROL_SAM_FREQ << 8,
11bcbc44 DM	342	snd_usb_ctrl_intf(chip) \| (clock << 8),
17d900c4	343	data, data_size);
e5779998 DM	344
e5779998 DM	345	if (ret < 0) {
0ba41d91 TI	346	dev_err(&dev->dev,
0ba41d91 TI	347	"%s(): unable to retrieve sample rate range (clock %d)\n",
79f920fb	348	__func__, clock);
e5779998 DM	349	ret = -EINVAL;
	350	goto err_free;
	351	}
	352
67c10366 DM	353	/* Call the triplet parser, and make sure fp->rate_table is NULL.
	354	* We just use the return value to know how many sample rates we
	355	* will have to deal with. */
	356	kfree(fp->rate_table);
	357	fp->rate_table = NULL;
0ba41d91	358	fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
67c10366 DM	359
	360	if (fp->nr_rates == 0) {
	361	/* SNDRV_PCM_RATE_CONTINUOUS */
	362	ret = 0;
	363	goto err_free;
	364	}
	365
6da2ec56	366	fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
e5779998 DM	367	if (!fp->rate_table) {
	368	ret = -ENOMEM;
	369	goto err_free;
	370	}
	371
67c10366 DM	372	/* Call the triplet parser again, but this time, fp->rate_table is
67c10366 DM	373	* allocated, so the rates will be stored */
0ba41d91	374	parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
e5779998 DM	375
	376	err_free:
	377	kfree(data);
	378	err:
	379	return ret;
	380	}
	381
	382	/*
	383	* parse the format type I and III descriptors
	384	*/
	385	static int parse_audio_format_i(struct snd_usb_audio *chip,
9a2fe9b8 RB	386	struct audioformat *fp, u64 format,
9a2fe9b8 RB	387	void *_fmt)
e5779998	388	{
74c34ca1	389	snd_pcm_format_t pcm_format;
9a2fe9b8	390	unsigned int fmt_type;
74c34ca1	391	int ret;
e5779998	392
9a2fe9b8 RB	393	switch (fp->protocol) {
	394	default:
	395	case UAC_VERSION_1:
	396	case UAC_VERSION_2: {
	397	struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
	398
	399	fmt_type = fmt->bFormatType;
	400	break;
	401	}
	402	case UAC_VERSION_3: {
	403	/* fp->fmt_type is already set in this case */
	404	fmt_type = fp->fmt_type;
	405	break;
	406	}
	407	}
	408
	409	if (fmt_type == UAC_FORMAT_TYPE_III) {
e5779998 DM	410	/* FIXME: the format type is really IECxxx
	411	* but we give normal PCM format to get the existing
	412	* apps working...
	413	*/
	414	switch (chip->usb_id) {
	415
	416	case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
	417	if (chip->setup == 0x00 &&
	418	fp->altsetting == 6)
	419	pcm_format = SNDRV_PCM_FORMAT_S16_BE;
	420	else
	421	pcm_format = SNDRV_PCM_FORMAT_S16_LE;
	422	break;
	423	default:
	424	pcm_format = SNDRV_PCM_FORMAT_S16_LE;
	425	}
74c34ca1	426	fp->formats = pcm_format_to_bits(pcm_format);
e5779998	427	} else {
9a2fe9b8	428	fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
29088fef	429	if (!fp->formats)
8ad10dc6	430	return -EINVAL;
e5779998 DM	431	}
e5779998 DM	432
e5779998 DM	433	/* gather possible sample rates */
	434	/* audio class v1 reports possible sample rates as part of the
	435	* proprietary class specific descriptor.
	436	* audio class v2 uses class specific EP0 range requests for that.
	437	*/
8f898e92	438	switch (fp->protocol) {
a2acad82	439	default:
9a2fe9b8 RB	440	case UAC_VERSION_1: {
	441	struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
	442
e5779998	443	fp->channels = fmt->bNrChannels;
74754f97	444	ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
e5779998	445	break;
9a2fe9b8	446	}
e5779998	447	case UAC_VERSION_2:
9a2fe9b8	448	case UAC_VERSION_3: {
e5779998	449	/* fp->channels is already set in this case */
9a2fe9b8	450	ret = parse_audio_format_rates_v2v3(chip, fp);
e5779998 DM	451	break;
e5779998 DM	452	}
9a2fe9b8	453	}
e5779998 DM	454
e5779998 DM	455	if (fp->channels < 1) {
0ba41d91 TI	456	usb_audio_err(chip,
	457	"%u:%d : invalid channels %d\n",
	458	fp->iface, fp->altsetting, fp->channels);
8ad10dc6	459	return -EINVAL;
e5779998 DM	460	}
	461
	462	return ret;
	463	}
	464
	465	/*
	466	* parse the format type II descriptor
	467	*/
	468	static int parse_audio_format_ii(struct snd_usb_audio *chip,
	469	struct audioformat *fp,
9a2fe9b8	470	u64 format, void *_fmt)
e5779998 DM	471	{
e5779998 DM	472	int brate, framesize, ret;
e5779998 DM	473
	474	switch (format) {
	475	case UAC_FORMAT_TYPE_II_AC3:
	476	/* FIXME: there is no AC3 format defined yet */
015eb0b0 CL	477	// fp->formats = SNDRV_PCM_FMTBIT_AC3;
015eb0b0 CL	478	fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
e5779998 DM	479	break;
e5779998 DM	480	case UAC_FORMAT_TYPE_II_MPEG:
015eb0b0	481	fp->formats = SNDRV_PCM_FMTBIT_MPEG;
e5779998 DM	482	break;
e5779998 DM	483	default:
0ba41d91	484	usb_audio_info(chip,
9a2fe9b8	485	"%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
0ba41d91	486	fp->iface, fp->altsetting, format);
015eb0b0	487	fp->formats = SNDRV_PCM_FMTBIT_MPEG;
e5779998 DM	488	break;
	489	}
	490
	491	fp->channels = 1;
	492
8f898e92	493	switch (fp->protocol) {
a2acad82	494	default:
e5779998 DM	495	case UAC_VERSION_1: {
	496	struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
	497	brate = le16_to_cpu(fmt->wMaxBitRate);
	498	framesize = le16_to_cpu(fmt->wSamplesPerFrame);
0ba41d91	499	usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
e5779998 DM	500	fp->frame_size = framesize;
	501	ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
	502	break;
	503	}
	504	case UAC_VERSION_2: {
	505	struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
	506	brate = le16_to_cpu(fmt->wMaxBitRate);
	507	framesize = le16_to_cpu(fmt->wSamplesPerFrame);
0ba41d91	508	usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
e5779998	509	fp->frame_size = framesize;
9a2fe9b8	510	ret = parse_audio_format_rates_v2v3(chip, fp);
e5779998 DM	511	break;
	512	}
	513	}
	514
	515	return ret;
	516	}
	517
2fcdb06d	518	int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
9a2fe9b8	519	struct audioformat *fp, u64 format,
2fcdb06d	520	struct uac_format_type_i_continuous_descriptor *fmt,
8f898e92	521	int stream)
e5779998 DM	522	{
	523	int err;
	524
74754f97	525	switch (fmt->bFormatType) {
e5779998 DM	526	case UAC_FORMAT_TYPE_I:
e5779998 DM	527	case UAC_FORMAT_TYPE_III:
8f898e92	528	err = parse_audio_format_i(chip, fp, format, fmt);
e5779998 DM	529	break;
e5779998 DM	530	case UAC_FORMAT_TYPE_II:
8f898e92	531	err = parse_audio_format_ii(chip, fp, format, fmt);
e5779998 DM	532	break;
e5779998 DM	533	default:
0ba41d91 TI	534	usb_audio_info(chip,
	535	"%u:%d : format type %d is not supported yet\n",
	536	fp->iface, fp->altsetting,
	537	fmt->bFormatType);
8d091242	538	return -ENOTSUPP;
e5779998	539	}
74754f97	540	fp->fmt_type = fmt->bFormatType;
e5779998 DM	541	if (err < 0)
	542	return err;
	543	#if 1
	544	/* FIXME: temporary hack for extigy/audigy 2 nx/zs */
	545	/* extigy apparently supports sample rates other than 48k
	546	* but not in ordinary way. so we enable only 48k atm.
	547	*/
	548	if (chip->usb_id == USB_ID(0x041e, 0x3000) \|\|
	549	chip->usb_id == USB_ID(0x041e, 0x3020) \|\|
	550	chip->usb_id == USB_ID(0x041e, 0x3061)) {
74754f97	551	if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
e5779998 DM	552	fp->rates != SNDRV_PCM_RATE_48000 &&
e5779998 DM	553	fp->rates != SNDRV_PCM_RATE_96000)
8d091242	554	return -ENOTSUPP;
e5779998 DM	555	}
	556	#endif
	557	return 0;
	558	}
	559
9a2fe9b8 RB	560	int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
	561	struct audioformat *fp,
	562	struct uac3_as_header_descriptor *as,
	563	int stream)
	564	{
	565	u64 format = le64_to_cpu(as->bmFormats);
	566	int err;
	567
	568	/*
	569	* Type I format bits are D0..D6
	570	* This test works because type IV is not supported
	571	*/
	572	if (format & 0x7f)
	573	fp->fmt_type = UAC_FORMAT_TYPE_I;
	574	else
	575	fp->fmt_type = UAC_FORMAT_TYPE_III;
	576
	577	err = parse_audio_format_i(chip, fp, format, as);
	578	if (err < 0)
	579	return err;
	580
	581	return 0;
	582	}