[linux-2.6-block.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;
			/* flag potentially raw DSD capable altsettings */
			fp->dsd_raw = true;
		}

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