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