179f920fbSDaniel Mack /* 279f920fbSDaniel Mack * Clock domain and sample rate management functions 379f920fbSDaniel Mack * 479f920fbSDaniel Mack * This program is free software; you can redistribute it and/or modify 579f920fbSDaniel Mack * it under the terms of the GNU General Public License as published by 679f920fbSDaniel Mack * the Free Software Foundation; either version 2 of the License, or 779f920fbSDaniel Mack * (at your option) any later version. 879f920fbSDaniel Mack * 979f920fbSDaniel Mack * This program is distributed in the hope that it will be useful, 1079f920fbSDaniel Mack * but WITHOUT ANY WARRANTY; without even the implied warranty of 1179f920fbSDaniel Mack * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1279f920fbSDaniel Mack * GNU General Public License for more details. 1379f920fbSDaniel Mack * 1479f920fbSDaniel Mack * You should have received a copy of the GNU General Public License 1579f920fbSDaniel Mack * along with this program; if not, write to the Free Software 1679f920fbSDaniel Mack * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 1779f920fbSDaniel Mack * 1879f920fbSDaniel Mack */ 1979f920fbSDaniel Mack 2079f920fbSDaniel Mack #include <linux/bitops.h> 2179f920fbSDaniel Mack #include <linux/init.h> 2279f920fbSDaniel Mack #include <linux/string.h> 2379f920fbSDaniel Mack #include <linux/usb.h> 2479f920fbSDaniel Mack #include <linux/usb/audio.h> 2579f920fbSDaniel Mack #include <linux/usb/audio-v2.h> 2679f920fbSDaniel Mack 2779f920fbSDaniel Mack #include <sound/core.h> 2879f920fbSDaniel Mack #include <sound/info.h> 2979f920fbSDaniel Mack #include <sound/pcm.h> 3079f920fbSDaniel Mack 3179f920fbSDaniel Mack #include "usbaudio.h" 3279f920fbSDaniel Mack #include "card.h" 3379f920fbSDaniel Mack #include "helper.h" 34f22aa949SDaniel Mack #include "clock.h" 3579f920fbSDaniel Mack 3679f920fbSDaniel Mack static struct uac_clock_source_descriptor * 3779f920fbSDaniel Mack snd_usb_find_clock_source(struct usb_host_interface *ctrl_iface, 3879f920fbSDaniel Mack int clock_id) 3979f920fbSDaniel Mack { 4079f920fbSDaniel Mack struct uac_clock_source_descriptor *cs = NULL; 4179f920fbSDaniel Mack 4279f920fbSDaniel Mack while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra, 4379f920fbSDaniel Mack ctrl_iface->extralen, 4479f920fbSDaniel Mack cs, UAC2_CLOCK_SOURCE))) { 4579f920fbSDaniel Mack if (cs->bClockID == clock_id) 4679f920fbSDaniel Mack return cs; 4779f920fbSDaniel Mack } 4879f920fbSDaniel Mack 4979f920fbSDaniel Mack return NULL; 5079f920fbSDaniel Mack } 5179f920fbSDaniel Mack 5279f920fbSDaniel Mack static struct uac_clock_selector_descriptor * 5379f920fbSDaniel Mack snd_usb_find_clock_selector(struct usb_host_interface *ctrl_iface, 5479f920fbSDaniel Mack int clock_id) 5579f920fbSDaniel Mack { 5679f920fbSDaniel Mack struct uac_clock_selector_descriptor *cs = NULL; 5779f920fbSDaniel Mack 5879f920fbSDaniel Mack while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra, 5979f920fbSDaniel Mack ctrl_iface->extralen, 6079f920fbSDaniel Mack cs, UAC2_CLOCK_SELECTOR))) { 6179f920fbSDaniel Mack if (cs->bClockID == clock_id) 6279f920fbSDaniel Mack return cs; 6379f920fbSDaniel Mack } 6479f920fbSDaniel Mack 6579f920fbSDaniel Mack return NULL; 6679f920fbSDaniel Mack } 6779f920fbSDaniel Mack 6879f920fbSDaniel Mack static struct uac_clock_multiplier_descriptor * 6979f920fbSDaniel Mack snd_usb_find_clock_multiplier(struct usb_host_interface *ctrl_iface, 7079f920fbSDaniel Mack int clock_id) 7179f920fbSDaniel Mack { 7279f920fbSDaniel Mack struct uac_clock_multiplier_descriptor *cs = NULL; 7379f920fbSDaniel Mack 7479f920fbSDaniel Mack while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra, 7579f920fbSDaniel Mack ctrl_iface->extralen, 7679f920fbSDaniel Mack cs, UAC2_CLOCK_MULTIPLIER))) { 7779f920fbSDaniel Mack if (cs->bClockID == clock_id) 7879f920fbSDaniel Mack return cs; 7979f920fbSDaniel Mack } 8079f920fbSDaniel Mack 8179f920fbSDaniel Mack return NULL; 8279f920fbSDaniel Mack } 8379f920fbSDaniel Mack 8479f920fbSDaniel Mack static int uac_clock_selector_get_val(struct snd_usb_audio *chip, int selector_id) 8579f920fbSDaniel Mack { 8679f920fbSDaniel Mack unsigned char buf; 8779f920fbSDaniel Mack int ret; 8879f920fbSDaniel Mack 8979f920fbSDaniel Mack ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), 9079f920fbSDaniel Mack UAC2_CS_CUR, 9179f920fbSDaniel Mack USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 9211bcbc44SDaniel Mack UAC2_CX_CLOCK_SELECTOR << 8, 9311bcbc44SDaniel Mack snd_usb_ctrl_intf(chip) | (selector_id << 8), 9417d900c4SClemens Ladisch &buf, sizeof(buf)); 9579f920fbSDaniel Mack 9679f920fbSDaniel Mack if (ret < 0) 9779f920fbSDaniel Mack return ret; 9879f920fbSDaniel Mack 9979f920fbSDaniel Mack return buf; 10079f920fbSDaniel Mack } 10179f920fbSDaniel Mack 10279f920fbSDaniel Mack static bool uac_clock_source_is_valid(struct snd_usb_audio *chip, int source_id) 10379f920fbSDaniel Mack { 10479f920fbSDaniel Mack int err; 10579f920fbSDaniel Mack unsigned char data; 10679f920fbSDaniel Mack struct usb_device *dev = chip->dev; 1073bc6fbc7SDaniel Mack struct uac_clock_source_descriptor *cs_desc = 1083bc6fbc7SDaniel Mack snd_usb_find_clock_source(chip->ctrl_intf, source_id); 1093bc6fbc7SDaniel Mack 1103bc6fbc7SDaniel Mack if (!cs_desc) 1113bc6fbc7SDaniel Mack return 0; 1123bc6fbc7SDaniel Mack 1133bc6fbc7SDaniel Mack /* If a clock source can't tell us whether it's valid, we assume it is */ 114aff252a8SDaniel Mack if (!uac2_control_is_readable(cs_desc->bmControls, 115aff252a8SDaniel Mack UAC2_CS_CONTROL_CLOCK_VALID - 1)) 1163bc6fbc7SDaniel Mack return 1; 11779f920fbSDaniel Mack 11879f920fbSDaniel Mack err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR, 11979f920fbSDaniel Mack USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN, 12011bcbc44SDaniel Mack UAC2_CS_CONTROL_CLOCK_VALID << 8, 12111bcbc44SDaniel Mack snd_usb_ctrl_intf(chip) | (source_id << 8), 12217d900c4SClemens Ladisch &data, sizeof(data)); 12379f920fbSDaniel Mack 12479f920fbSDaniel Mack if (err < 0) { 12579f920fbSDaniel Mack snd_printk(KERN_WARNING "%s(): cannot get clock validity for id %d\n", 12679f920fbSDaniel Mack __func__, source_id); 1273bc6fbc7SDaniel Mack return 0; 12879f920fbSDaniel Mack } 12979f920fbSDaniel Mack 13079f920fbSDaniel Mack return !!data; 13179f920fbSDaniel Mack } 13279f920fbSDaniel Mack 13379f920fbSDaniel Mack static int __uac_clock_find_source(struct snd_usb_audio *chip, 13479f920fbSDaniel Mack int entity_id, unsigned long *visited) 13579f920fbSDaniel Mack { 13679f920fbSDaniel Mack struct uac_clock_source_descriptor *source; 13779f920fbSDaniel Mack struct uac_clock_selector_descriptor *selector; 13879f920fbSDaniel Mack struct uac_clock_multiplier_descriptor *multiplier; 13979f920fbSDaniel Mack 14079f920fbSDaniel Mack entity_id &= 0xff; 14179f920fbSDaniel Mack 14279f920fbSDaniel Mack if (test_and_set_bit(entity_id, visited)) { 14379f920fbSDaniel Mack snd_printk(KERN_WARNING 14479f920fbSDaniel Mack "%s(): recursive clock topology detected, id %d.\n", 14579f920fbSDaniel Mack __func__, entity_id); 14679f920fbSDaniel Mack return -EINVAL; 14779f920fbSDaniel Mack } 14879f920fbSDaniel Mack 14979f920fbSDaniel Mack /* first, see if the ID we're looking for is a clock source already */ 1503d8d4dcfSDaniel Mack source = snd_usb_find_clock_source(chip->ctrl_intf, entity_id); 15179f920fbSDaniel Mack if (source) 15279f920fbSDaniel Mack return source->bClockID; 15379f920fbSDaniel Mack 1543d8d4dcfSDaniel Mack selector = snd_usb_find_clock_selector(chip->ctrl_intf, entity_id); 15579f920fbSDaniel Mack if (selector) { 15679f920fbSDaniel Mack int ret; 15779f920fbSDaniel Mack 15879f920fbSDaniel Mack /* the entity ID we are looking for is a selector. 15979f920fbSDaniel Mack * find out what it currently selects */ 16079f920fbSDaniel Mack ret = uac_clock_selector_get_val(chip, selector->bClockID); 16179f920fbSDaniel Mack if (ret < 0) 16279f920fbSDaniel Mack return ret; 16379f920fbSDaniel Mack 164157a57b6SDaniel Mack /* Selector values are one-based */ 165157a57b6SDaniel Mack 16679f920fbSDaniel Mack if (ret > selector->bNrInPins || ret < 1) { 16779f920fbSDaniel Mack printk(KERN_ERR 16879f920fbSDaniel Mack "%s(): selector reported illegal value, id %d, ret %d\n", 16979f920fbSDaniel Mack __func__, selector->bClockID, ret); 17079f920fbSDaniel Mack 17179f920fbSDaniel Mack return -EINVAL; 17279f920fbSDaniel Mack } 17379f920fbSDaniel Mack 1743d8d4dcfSDaniel Mack return __uac_clock_find_source(chip, selector->baCSourceID[ret-1], 17579f920fbSDaniel Mack visited); 17679f920fbSDaniel Mack } 17779f920fbSDaniel Mack 17879f920fbSDaniel Mack /* FIXME: multipliers only act as pass-thru element for now */ 1793d8d4dcfSDaniel Mack multiplier = snd_usb_find_clock_multiplier(chip->ctrl_intf, entity_id); 18079f920fbSDaniel Mack if (multiplier) 1813d8d4dcfSDaniel Mack return __uac_clock_find_source(chip, multiplier->bCSourceID, 1823d8d4dcfSDaniel Mack visited); 18379f920fbSDaniel Mack 18479f920fbSDaniel Mack return -EINVAL; 18579f920fbSDaniel Mack } 18679f920fbSDaniel Mack 187157a57b6SDaniel Mack /* 188157a57b6SDaniel Mack * For all kinds of sample rate settings and other device queries, 189157a57b6SDaniel Mack * the clock source (end-leaf) must be used. However, clock selectors, 190157a57b6SDaniel Mack * clock multipliers and sample rate converters may be specified as 191157a57b6SDaniel Mack * clock source input to terminal. This functions walks the clock path 192157a57b6SDaniel Mack * to its end and tries to find the source. 193157a57b6SDaniel Mack * 194157a57b6SDaniel Mack * The 'visited' bitfield is used internally to detect recursive loops. 195157a57b6SDaniel Mack * 196157a57b6SDaniel Mack * Returns the clock source UnitID (>=0) on success, or an error. 197157a57b6SDaniel Mack */ 1983d8d4dcfSDaniel Mack int snd_usb_clock_find_source(struct snd_usb_audio *chip, int entity_id) 19979f920fbSDaniel Mack { 20079f920fbSDaniel Mack DECLARE_BITMAP(visited, 256); 20179f920fbSDaniel Mack memset(visited, 0, sizeof(visited)); 2023d8d4dcfSDaniel Mack return __uac_clock_find_source(chip, entity_id, visited); 20379f920fbSDaniel Mack } 20479f920fbSDaniel Mack 20579f920fbSDaniel Mack static int set_sample_rate_v1(struct snd_usb_audio *chip, int iface, 20679f920fbSDaniel Mack struct usb_host_interface *alts, 20779f920fbSDaniel Mack struct audioformat *fmt, int rate) 20879f920fbSDaniel Mack { 20979f920fbSDaniel Mack struct usb_device *dev = chip->dev; 21079f920fbSDaniel Mack unsigned int ep; 21179f920fbSDaniel Mack unsigned char data[3]; 21279f920fbSDaniel Mack int err, crate; 21379f920fbSDaniel Mack 21479f920fbSDaniel Mack ep = get_endpoint(alts, 0)->bEndpointAddress; 21579f920fbSDaniel Mack 21679f920fbSDaniel Mack /* if endpoint doesn't have sampling rate control, bail out */ 217d32d552eSClemens Ladisch if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE)) 21879f920fbSDaniel Mack return 0; 21979f920fbSDaniel Mack 22079f920fbSDaniel Mack data[0] = rate; 22179f920fbSDaniel Mack data[1] = rate >> 8; 22279f920fbSDaniel Mack data[2] = rate >> 16; 22379f920fbSDaniel Mack if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR, 22479f920fbSDaniel Mack USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT, 22579f920fbSDaniel Mack UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep, 22617d900c4SClemens Ladisch data, sizeof(data))) < 0) { 22779f920fbSDaniel Mack snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep %#x\n", 22879f920fbSDaniel Mack dev->devnum, iface, fmt->altsetting, rate, ep); 22979f920fbSDaniel Mack return err; 23079f920fbSDaniel Mack } 23179f920fbSDaniel Mack 23279f920fbSDaniel Mack if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC_GET_CUR, 23379f920fbSDaniel Mack USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_IN, 23479f920fbSDaniel Mack UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep, 23517d900c4SClemens Ladisch data, sizeof(data))) < 0) { 23679f920fbSDaniel Mack snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep %#x\n", 23779f920fbSDaniel Mack dev->devnum, iface, fmt->altsetting, ep); 23879f920fbSDaniel Mack return 0; /* some devices don't support reading */ 23979f920fbSDaniel Mack } 24079f920fbSDaniel Mack 24179f920fbSDaniel Mack crate = data[0] | (data[1] << 8) | (data[2] << 16); 24279f920fbSDaniel Mack if (crate != rate) { 24379f920fbSDaniel Mack snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate); 24479f920fbSDaniel Mack // runtime->rate = crate; 24579f920fbSDaniel Mack } 24679f920fbSDaniel Mack 24779f920fbSDaniel Mack return 0; 24879f920fbSDaniel Mack } 24979f920fbSDaniel Mack 2507c517465STakashi Iwai static int get_sample_rate_v2(struct snd_usb_audio *chip, int iface, 2517c517465STakashi Iwai int altsetting, int clock) 2527c517465STakashi Iwai { 2537c517465STakashi Iwai struct usb_device *dev = chip->dev; 254f6a8bc70SEldad Zack __le32 data; 2557c517465STakashi Iwai int err; 2567c517465STakashi Iwai 2577c517465STakashi Iwai err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR, 2587c517465STakashi Iwai USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN, 2597c517465STakashi Iwai UAC2_CS_CONTROL_SAM_FREQ << 8, 2607c517465STakashi Iwai snd_usb_ctrl_intf(chip) | (clock << 8), 261f6a8bc70SEldad Zack &data, sizeof(data)); 2627c517465STakashi Iwai if (err < 0) { 2637c517465STakashi Iwai snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq (v2)\n", 2647c517465STakashi Iwai dev->devnum, iface, altsetting); 2657c517465STakashi Iwai return 0; 2667c517465STakashi Iwai } 2677c517465STakashi Iwai 268f6a8bc70SEldad Zack return le32_to_cpu(data); 2697c517465STakashi Iwai } 2707c517465STakashi Iwai 27179f920fbSDaniel Mack static int set_sample_rate_v2(struct snd_usb_audio *chip, int iface, 27279f920fbSDaniel Mack struct usb_host_interface *alts, 27379f920fbSDaniel Mack struct audioformat *fmt, int rate) 27479f920fbSDaniel Mack { 27579f920fbSDaniel Mack struct usb_device *dev = chip->dev; 276f6a8bc70SEldad Zack __le32 data; 277690a863fSTorstein Hegge int err, cur_rate, prev_rate; 2783d8d4dcfSDaniel Mack int clock = snd_usb_clock_find_source(chip, fmt->clock); 27979f920fbSDaniel Mack 28079f920fbSDaniel Mack if (clock < 0) 28179f920fbSDaniel Mack return clock; 28279f920fbSDaniel Mack 28379f920fbSDaniel Mack if (!uac_clock_source_is_valid(chip, clock)) { 284157a57b6SDaniel Mack /* TODO: should we try to find valid clock setups by ourself? */ 28579f920fbSDaniel Mack snd_printk(KERN_ERR "%d:%d:%d: clock source %d is not valid, cannot use\n", 28679f920fbSDaniel Mack dev->devnum, iface, fmt->altsetting, clock); 28779f920fbSDaniel Mack return -ENXIO; 28879f920fbSDaniel Mack } 28979f920fbSDaniel Mack 2907c517465STakashi Iwai prev_rate = get_sample_rate_v2(chip, iface, fmt->altsetting, clock); 291690a863fSTorstein Hegge 292f6a8bc70SEldad Zack data = cpu_to_le32(rate); 29379f920fbSDaniel Mack if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR, 29479f920fbSDaniel Mack USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT, 29511bcbc44SDaniel Mack UAC2_CS_CONTROL_SAM_FREQ << 8, 29611bcbc44SDaniel Mack snd_usb_ctrl_intf(chip) | (clock << 8), 297f6a8bc70SEldad Zack &data, sizeof(data))) < 0) { 29879f920fbSDaniel Mack snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d (v2)\n", 29979f920fbSDaniel Mack dev->devnum, iface, fmt->altsetting, rate); 30079f920fbSDaniel Mack return err; 30179f920fbSDaniel Mack } 30279f920fbSDaniel Mack 3037c517465STakashi Iwai cur_rate = get_sample_rate_v2(chip, iface, fmt->altsetting, clock); 30479f920fbSDaniel Mack 305690a863fSTorstein Hegge if (cur_rate != rate) { 306690a863fSTorstein Hegge snd_printd(KERN_WARNING 307690a863fSTorstein Hegge "current rate %d is different from the runtime rate %d\n", 308690a863fSTorstein Hegge cur_rate, rate); 309690a863fSTorstein Hegge } 310690a863fSTorstein Hegge 311690a863fSTorstein Hegge /* Some devices doesn't respond to sample rate changes while the 312690a863fSTorstein Hegge * interface is active. */ 313690a863fSTorstein Hegge if (rate != prev_rate) { 314690a863fSTorstein Hegge usb_set_interface(dev, iface, 0); 315690a863fSTorstein Hegge usb_set_interface(dev, iface, fmt->altsetting); 316690a863fSTorstein Hegge } 31779f920fbSDaniel Mack 31879f920fbSDaniel Mack return 0; 31979f920fbSDaniel Mack } 32079f920fbSDaniel Mack 32179f920fbSDaniel Mack int snd_usb_init_sample_rate(struct snd_usb_audio *chip, int iface, 32279f920fbSDaniel Mack struct usb_host_interface *alts, 32379f920fbSDaniel Mack struct audioformat *fmt, int rate) 32479f920fbSDaniel Mack { 32579f920fbSDaniel Mack struct usb_interface_descriptor *altsd = get_iface_desc(alts); 32679f920fbSDaniel Mack 32779f920fbSDaniel Mack switch (altsd->bInterfaceProtocol) { 32879f920fbSDaniel Mack case UAC_VERSION_1: 329a2acad82SClemens Ladisch default: 33079f920fbSDaniel Mack return set_sample_rate_v1(chip, iface, alts, fmt, rate); 33179f920fbSDaniel Mack 33279f920fbSDaniel Mack case UAC_VERSION_2: 33379f920fbSDaniel Mack return set_sample_rate_v2(chip, iface, alts, fmt, rate); 33479f920fbSDaniel Mack } 33579f920fbSDaniel Mack } 33679f920fbSDaniel Mack 337