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