[linux.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 <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
 */
static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
				     struct audioformat *fp,
				     unsigned int 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 = 1 << 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;
	}
	}

	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 %#x\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(sizeof(int) * nr_rates, 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).
 */
static int parse_audio_format_rates_v2(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->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(sizeof(int) * fp->nr_rates, 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, unsigned int format,
				struct uac_format_type_i_continuous_descriptor *fmt)
{
	snd_pcm_format_t pcm_format;
	int ret;

	if (fmt->bFormatType == 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:
		fp->channels = fmt->bNrChannels;
		ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
		break;
	case UAC_VERSION_2:
		/* fp->channels is already set in this case */
		ret = parse_audio_format_rates_v2(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,
				 int 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 %#x 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_v2(chip, fp);
		break;
	}
	}

	return ret;
}

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