[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"

/*
 * 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,
				     int format, void *_fmt,
				     int protocol)
{
	int sample_width, sample_bytes;
	u64 pcm_formats;

	switch (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;
		format <<= 1;
		break;
	}
	}

	pcm_formats = 0;

	if (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);
	}
	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 -1;
	}

	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 -1;
		}

		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 */
			if (rate == 48000 && nr_rates == 1 &&
			    (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
			     chip->usb_id == USB_ID(0x0d8c, 0x0102)) &&
			    fp->altsetting == 5 && fp->maxpacksize == 392)
				rate = 96000;
			/* Creative VF0470 Live Cam reports 16 kHz instead of 8kHz */
			if (rate == 16000 && 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 -1;
		}
	} 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]);
		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++;

			/* 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);

	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), 1000);

	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, 1000);

	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, int format,
				struct uac_format_type_i_continuous_descriptor *fmt,
				struct usb_host_interface *iface)
{
	struct usb_interface_descriptor *altsd = get_iface_desc(iface);
	int protocol = altsd->bInterfaceProtocol;
	int pcm_format, 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 = 1uLL << pcm_format;
	} else {
		fp->formats = parse_audio_format_i_type(chip, fp, format,
							fmt, protocol);
		if (!fp->formats)
			return -1;
	}

	/* 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 (protocol) {
	default:
		snd_printdd(KERN_WARNING "%d:%u:%d : invalid protocol version %d, assuming v1\n",
			   chip->dev->devnum, fp->iface, fp->altsetting, protocol);
		/* fall through */
	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 -1;
	}

	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,
				 struct usb_host_interface *iface)
{
	int brate, framesize, ret;
	struct usb_interface_descriptor *altsd = get_iface_desc(iface);
	int protocol = altsd->bInterfaceProtocol;

	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 (protocol) {
	default:
		snd_printdd(KERN_WARNING "%d:%u:%d : invalid protocol version %d, assuming v1\n",
			   chip->dev->devnum, fp->iface, fp->altsetting, protocol);
		/* fall through */
	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,
			       int format, struct uac_format_type_i_continuous_descriptor *fmt,
			       int stream, struct usb_host_interface *iface)
{
	int err;

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