[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: {
		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;
	}

	default:
		return -EINVAL;
	}

	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) {
	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;
	default:
		snd_printk(KERN_ERR "%d:%u:%d : invalid protocol version %d\n",
			   chip->dev->devnum, fp->iface, fp->altsetting, protocol);
		return -EINVAL;
	}

	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) {
	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;
	}
	default:
		snd_printk(KERN_ERR "%d:%u:%d : invalid protocol version %d\n",
			   chip->dev->devnum, fp->iface, fp->altsetting, protocol);
		return -EINVAL;
	}

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