[linux-2.6-block.git] / sound / usb / clock.c

/*
 *   Clock domain and sample rate management functions
 *
 *   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/bitops.h>
#include <linux/init.h>
#include <linux/string.h>
#include <linux/usb.h>
#include <linux/usb/audio.h>
#include <linux/usb/audio-v2.h>

#include <sound/core.h>
#include <sound/info.h>
#include <sound/pcm.h>

#include "usbaudio.h"
#include "card.h"
#include "helper.h"
#include "clock.h"

static struct uac_clock_source_descriptor *
	snd_usb_find_clock_source(struct usb_host_interface *ctrl_iface,
				  int clock_id)
{
	struct uac_clock_source_descriptor *cs = NULL;

	while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
					     ctrl_iface->extralen,
					     cs, UAC2_CLOCK_SOURCE))) {
		if (cs->bClockID == clock_id)
			return cs;
	}

	return NULL;
}

static struct uac_clock_selector_descriptor *
	snd_usb_find_clock_selector(struct usb_host_interface *ctrl_iface,
				    int clock_id)
{
	struct uac_clock_selector_descriptor *cs = NULL;

	while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
					     ctrl_iface->extralen,
					     cs, UAC2_CLOCK_SELECTOR))) {
		if (cs->bClockID == clock_id)
			return cs;
	}

	return NULL;
}

static struct uac_clock_multiplier_descriptor *
	snd_usb_find_clock_multiplier(struct usb_host_interface *ctrl_iface,
				      int clock_id)
{
	struct uac_clock_multiplier_descriptor *cs = NULL;

	while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
					     ctrl_iface->extralen,
					     cs, UAC2_CLOCK_MULTIPLIER))) {
		if (cs->bClockID == clock_id)
			return cs;
	}

	return NULL;
}

static int uac_clock_selector_get_val(struct snd_usb_audio *chip, int selector_id)
{
	unsigned char buf;
	int ret;

	ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0),
			      UAC2_CS_CUR,
			      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
			      UAC2_CX_CLOCK_SELECTOR << 8,
			      snd_usb_ctrl_intf(chip) | (selector_id << 8),
			      &buf, sizeof(buf), 1000);

	if (ret < 0)
		return ret;

	return buf;
}

static bool uac_clock_source_is_valid(struct snd_usb_audio *chip, int source_id)
{
	int err;
	unsigned char data;
	struct usb_device *dev = chip->dev;

	err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
			      USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
			      UAC2_CS_CONTROL_CLOCK_VALID << 8,
			      snd_usb_ctrl_intf(chip) | (source_id << 8),
			      &data, sizeof(data), 1000);

	if (err < 0) {
		snd_printk(KERN_WARNING "%s(): cannot get clock validity for id %d\n",
			   __func__, source_id);
		return err;
	}

	return !!data;
}

/* Try to find the clock source ID of a given clock entity */

static int __uac_clock_find_source(struct snd_usb_audio *chip,
				   struct usb_host_interface *host_iface,
				   int entity_id, unsigned long *visited)
{
	struct uac_clock_source_descriptor *source;
	struct uac_clock_selector_descriptor *selector;
	struct uac_clock_multiplier_descriptor *multiplier;

	entity_id &= 0xff;

	if (test_and_set_bit(entity_id, visited)) {
		snd_printk(KERN_WARNING
			"%s(): recursive clock topology detected, id %d.\n",
			__func__, entity_id);
		return -EINVAL;
	}

	/* first, see if the ID we're looking for is a clock source already */
	source = snd_usb_find_clock_source(host_iface, entity_id);
	if (source)
		return source->bClockID;

	selector = snd_usb_find_clock_selector(host_iface, entity_id);
	if (selector) {
		int ret;

		/* the entity ID we are looking for is a selector.
		 * find out what it currently selects */
		ret = uac_clock_selector_get_val(chip, selector->bClockID);
		if (ret < 0)
			return ret;

		if (ret > selector->bNrInPins || ret < 1) {
			printk(KERN_ERR
				"%s(): selector reported illegal value, id %d, ret %d\n",
				__func__, selector->bClockID, ret);

			return -EINVAL;
		}

		return __uac_clock_find_source(chip, host_iface,
					       selector->baCSourceID[ret-1],
					       visited);
	}

	/* FIXME: multipliers only act as pass-thru element for now */
	multiplier = snd_usb_find_clock_multiplier(host_iface, entity_id);
	if (multiplier)
		return __uac_clock_find_source(chip, host_iface,
					       multiplier->bCSourceID, visited);

	return -EINVAL;
}

int snd_usb_clock_find_source(struct snd_usb_audio *chip,
			      struct usb_host_interface *host_iface,
			      int entity_id)
{
	DECLARE_BITMAP(visited, 256);
	memset(visited, 0, sizeof(visited));
	return __uac_clock_find_source(chip, host_iface, entity_id, visited);
}

static int set_sample_rate_v1(struct snd_usb_audio *chip, int iface,
			      struct usb_host_interface *alts,
			      struct audioformat *fmt, int rate)
{
	struct usb_device *dev = chip->dev;
	unsigned int ep;
	unsigned char data[3];
	int err, crate;

	ep = get_endpoint(alts, 0)->bEndpointAddress;

	/* if endpoint doesn't have sampling rate control, bail out */
	if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE)) {
		snd_printk(KERN_WARNING "%d:%d:%d: endpoint lacks sample rate attribute bit, cannot set.\n",
				   dev->devnum, iface, fmt->altsetting);
		return 0;
	}

	data[0] = rate;
	data[1] = rate >> 8;
	data[2] = rate >> 16;
	if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
				   USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
				   UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
				   data, sizeof(data), 1000)) < 0) {
		snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep %#x\n",
			   dev->devnum, iface, fmt->altsetting, rate, ep);
		return err;
	}

	if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC_GET_CUR,
				   USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_IN,
				   UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
				   data, sizeof(data), 1000)) < 0) {
		snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep %#x\n",
			   dev->devnum, iface, fmt->altsetting, ep);
		return 0; /* some devices don't support reading */
	}

	crate = data[0] | (data[1] << 8) | (data[2] << 16);
	if (crate != rate) {
		snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
		// runtime->rate = crate;
	}

	return 0;
}

static int set_sample_rate_v2(struct snd_usb_audio *chip, int iface,
			      struct usb_host_interface *alts,
			      struct audioformat *fmt, int rate)
{
	struct usb_device *dev = chip->dev;
	unsigned char data[4];
	int err, crate;
	int clock = snd_usb_clock_find_source(chip, chip->ctrl_intf, fmt->clock);

	if (clock < 0)
		return clock;

	if (!uac_clock_source_is_valid(chip, clock)) {
		snd_printk(KERN_ERR "%d:%d:%d: clock source %d is not valid, cannot use\n",
			   dev->devnum, iface, fmt->altsetting, clock);
		return -ENXIO;
	}

	data[0] = rate;
	data[1] = rate >> 8;
	data[2] = rate >> 16;
	data[3] = rate >> 24;
	if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
				   USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
				   UAC2_CS_CONTROL_SAM_FREQ << 8,
				   snd_usb_ctrl_intf(chip) | (clock << 8),
				   data, sizeof(data), 1000)) < 0) {
		snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d (v2)\n",
			   dev->devnum, iface, fmt->altsetting, rate);
		return err;
	}

	if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
				   USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
				   UAC2_CS_CONTROL_SAM_FREQ << 8,
				   snd_usb_ctrl_intf(chip) | (clock << 8),
				   data, sizeof(data), 1000)) < 0) {
		snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq (v2)\n",
			   dev->devnum, iface, fmt->altsetting);
		return err;
	}

	crate = data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24);
	if (crate != rate)
		snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);

	return 0;
}

int snd_usb_init_sample_rate(struct snd_usb_audio *chip, int iface,
			     struct usb_host_interface *alts,
			     struct audioformat *fmt, int rate)
{
	struct usb_interface_descriptor *altsd = get_iface_desc(alts);

	switch (altsd->bInterfaceProtocol) {
	case UAC_VERSION_1:
		return set_sample_rate_v1(chip, iface, alts, fmt, rate);

	case UAC_VERSION_2:
		return set_sample_rate_v2(chip, iface, alts, fmt, rate);
	}

	return -EINVAL;
}
Commit	Line	Data
79f920fb DM	1	/*
	2	* Clock domain and sample rate management functions
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	17	*
	18	*/
	19
	20	#include <linux/bitops.h>
	21	#include <linux/init.h>
79f920fb DM	22	#include <linux/string.h>
79f920fb DM	23	#include <linux/usb.h>
79f920fb DM	24	#include <linux/usb/audio.h>
	25	#include <linux/usb/audio-v2.h>
	26
	27	#include <sound/core.h>
	28	#include <sound/info.h>
	29	#include <sound/pcm.h>
79f920fb DM	30
	31	#include "usbaudio.h"
	32	#include "card.h"
79f920fb	33	#include "helper.h"
f22aa949	34	#include "clock.h"
79f920fb DM	35
	36	static struct uac_clock_source_descriptor *
	37	snd_usb_find_clock_source(struct usb_host_interface *ctrl_iface,
	38	int clock_id)
	39	{
	40	struct uac_clock_source_descriptor *cs = NULL;
	41
	42	while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
	43	ctrl_iface->extralen,
	44	cs, UAC2_CLOCK_SOURCE))) {
	45	if (cs->bClockID == clock_id)
	46	return cs;
	47	}
	48
	49	return NULL;
	50	}
	51
	52	static struct uac_clock_selector_descriptor *
	53	snd_usb_find_clock_selector(struct usb_host_interface *ctrl_iface,
	54	int clock_id)
	55	{
	56	struct uac_clock_selector_descriptor *cs = NULL;
	57
	58	while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
	59	ctrl_iface->extralen,
	60	cs, UAC2_CLOCK_SELECTOR))) {
	61	if (cs->bClockID == clock_id)
	62	return cs;
	63	}
	64
	65	return NULL;
	66	}
	67
	68	static struct uac_clock_multiplier_descriptor *
	69	snd_usb_find_clock_multiplier(struct usb_host_interface *ctrl_iface,
	70	int clock_id)
	71	{
	72	struct uac_clock_multiplier_descriptor *cs = NULL;
	73
	74	while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
	75	ctrl_iface->extralen,
	76	cs, UAC2_CLOCK_MULTIPLIER))) {
	77	if (cs->bClockID == clock_id)
	78	return cs;
	79	}
	80
	81	return NULL;
	82	}
	83
	84	static int uac_clock_selector_get_val(struct snd_usb_audio *chip, int selector_id)
	85	{
	86	unsigned char buf;
	87	int ret;
	88
	89	ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0),
	90	UAC2_CS_CUR,
	91	USB_RECIP_INTERFACE \| USB_TYPE_CLASS \| USB_DIR_IN,
11bcbc44 DM	92	UAC2_CX_CLOCK_SELECTOR << 8,
11bcbc44 DM	93	snd_usb_ctrl_intf(chip) \| (selector_id << 8),
79f920fb DM	94	&buf, sizeof(buf), 1000);
	95
	96	if (ret < 0)
	97	return ret;
	98
	99	return buf;
	100	}
	101
	102	static bool uac_clock_source_is_valid(struct snd_usb_audio *chip, int source_id)
	103	{
	104	int err;
	105	unsigned char data;
	106	struct usb_device *dev = chip->dev;
	107
	108	err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
	109	USB_TYPE_CLASS \| USB_RECIP_INTERFACE \| USB_DIR_IN,
11bcbc44 DM	110	UAC2_CS_CONTROL_CLOCK_VALID << 8,
11bcbc44 DM	111	snd_usb_ctrl_intf(chip) \| (source_id << 8),
79f920fb DM	112	&data, sizeof(data), 1000);
	113
	114	if (err < 0) {
	115	snd_printk(KERN_WARNING "%s(): cannot get clock validity for id %d\n",
	116	__func__, source_id);
	117	return err;
	118	}
	119
	120	return !!data;
	121	}
	122
	123	/* Try to find the clock source ID of a given clock entity */
	124
	125	static int __uac_clock_find_source(struct snd_usb_audio *chip,
	126	struct usb_host_interface *host_iface,
	127	int entity_id, unsigned long *visited)
	128	{
	129	struct uac_clock_source_descriptor *source;
	130	struct uac_clock_selector_descriptor *selector;
	131	struct uac_clock_multiplier_descriptor *multiplier;
	132
	133	entity_id &= 0xff;
	134
	135	if (test_and_set_bit(entity_id, visited)) {
	136	snd_printk(KERN_WARNING
	137	"%s(): recursive clock topology detected, id %d.\n",
	138	__func__, entity_id);
	139	return -EINVAL;
	140	}
	141
	142	/* first, see if the ID we're looking for is a clock source already */
	143	source = snd_usb_find_clock_source(host_iface, entity_id);
	144	if (source)
	145	return source->bClockID;
	146
	147	selector = snd_usb_find_clock_selector(host_iface, entity_id);
	148	if (selector) {
	149	int ret;
	150
	151	/* the entity ID we are looking for is a selector.
	152	* find out what it currently selects */
	153	ret = uac_clock_selector_get_val(chip, selector->bClockID);
	154	if (ret < 0)
	155	return ret;
	156
	157	if (ret > selector->bNrInPins \|\| ret < 1) {
	158	printk(KERN_ERR
	159	"%s(): selector reported illegal value, id %d, ret %d\n",
	160	__func__, selector->bClockID, ret);
	161
	162	return -EINVAL;
	163	}
	164
	165	return __uac_clock_find_source(chip, host_iface,
	166	selector->baCSourceID[ret-1],
	167	visited);
	168	}
	169
	170	/* FIXME: multipliers only act as pass-thru element for now */
	171	multiplier = snd_usb_find_clock_multiplier(host_iface, entity_id);
	172	if (multiplier)
	173	return __uac_clock_find_source(chip, host_iface,
	174	multiplier->bCSourceID, visited);
	175
176	return -EINVAL;
177	}
178
179	int snd_usb_clock_find_source(struct snd_usb_audio *chip,
180	struct usb_host_interface *host_iface,
181	int entity_id)
182	{
183	DECLARE_BITMAP(visited, 256);
184	memset(visited, 0, sizeof(visited));
185	return __uac_clock_find_source(chip, host_iface, entity_id, visited);
186	}
187
188	static int set_sample_rate_v1(struct snd_usb_audio *chip, int iface,
189	struct usb_host_interface *alts,
190	struct audioformat *fmt, int rate)
191	{
192	struct usb_device *dev = chip->dev;
193	unsigned int ep;
194	unsigned char data[3];
195	int err, crate;
196
197	ep = get_endpoint(alts, 0)->bEndpointAddress;
198
199	/* if endpoint doesn't have sampling rate control, bail out */
200	if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE)) {
201	snd_printk(KERN_WARNING "%d:%d:%d: endpoint lacks sample rate attribute bit, cannot set.\n",
202	dev->devnum, iface, fmt->altsetting);
203	return 0;
204	}
205
206	data[0] = rate;
207	data[1] = rate >> 8;
208	data[2] = rate >> 16;
209	if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
210	USB_TYPE_CLASS \| USB_RECIP_ENDPOINT \| USB_DIR_OUT,
211	UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
212	data, sizeof(data), 1000)) < 0) {
213	snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep %#x\n",
214	dev->devnum, iface, fmt->altsetting, rate, ep);
215	return err;
216	}
217
218	if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC_GET_CUR,
219	USB_TYPE_CLASS \| USB_RECIP_ENDPOINT \| USB_DIR_IN,
220	UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
221	data, sizeof(data), 1000)) < 0) {
222	snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep %#x\n",
223	dev->devnum, iface, fmt->altsetting, ep);
224	return 0; /* some devices don't support reading */
225	}
226
227	crate = data[0] \| (data[1] << 8) \| (data[2] << 16);
228	if (crate != rate) {
229	snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
230	// runtime->rate = crate;
231	}
232
233	return 0;
234	}
235
236	static int set_sample_rate_v2(struct snd_usb_audio *chip, int iface,
237	struct usb_host_interface *alts,
238	struct audioformat *fmt, int rate)
239	{
240	struct usb_device *dev = chip->dev;
241	unsigned char data[4];
242	int err, crate;
243	int clock = snd_usb_clock_find_source(chip, chip->ctrl_intf, fmt->clock);
244
245	if (clock < 0)
246	return clock;
247
248	if (!uac_clock_source_is_valid(chip, clock)) {
249	snd_printk(KERN_ERR "%d:%d:%d: clock source %d is not valid, cannot use\n",
250	dev->devnum, iface, fmt->altsetting, clock);
251	return -ENXIO;
252	}
253
254	data[0] = rate;
255	data[1] = rate >> 8;
256	data[2] = rate >> 16;
257	data[3] = rate >> 24;
258	if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
259	USB_TYPE_CLASS \| USB_RECIP_INTERFACE \| USB_DIR_OUT,
11bcbc44 DM	260	UAC2_CS_CONTROL_SAM_FREQ << 8,
11bcbc44 DM	261	snd_usb_ctrl_intf(chip) \| (clock << 8),
79f920fb DM	262	data, sizeof(data), 1000)) < 0) {
	263	snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d (v2)\n",
	264	dev->devnum, iface, fmt->altsetting, rate);
	265	return err;
	266	}
	267
	268	if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
	269	USB_TYPE_CLASS \| USB_RECIP_INTERFACE \| USB_DIR_IN,
11bcbc44 DM	270	UAC2_CS_CONTROL_SAM_FREQ << 8,
11bcbc44 DM	271	snd_usb_ctrl_intf(chip) \| (clock << 8),
79f920fb DM	272	data, sizeof(data), 1000)) < 0) {
	273	snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq (v2)\n",
	274	dev->devnum, iface, fmt->altsetting);
	275	return err;
	276	}
	277
	278	crate = data[0] \| (data[1] << 8) \| (data[2] << 16) \| (data[3] << 24);
	279	if (crate != rate)
	280	snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
	281
	282	return 0;
	283	}
	284
	285	int snd_usb_init_sample_rate(struct snd_usb_audio *chip, int iface,
	286	struct usb_host_interface *alts,
	287	struct audioformat *fmt, int rate)
	288	{
	289	struct usb_interface_descriptor *altsd = get_iface_desc(alts);
	290
	291	switch (altsd->bInterfaceProtocol) {
	292	case UAC_VERSION_1:
	293	return set_sample_rate_v1(chip, iface, alts, fmt, rate);
	294
	295	case UAC_VERSION_2:
	296	return set_sample_rate_v2(chip, iface, alts, fmt, rate);
	297	}
	298
	299	return -EINVAL;
	300	}
	301