11a59d1b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later 279f920fbSDaniel Mack /* 379f920fbSDaniel Mack * Clock domain and sample rate management functions 479f920fbSDaniel Mack */ 579f920fbSDaniel Mack 679f920fbSDaniel Mack #include <linux/bitops.h> 779f920fbSDaniel Mack #include <linux/init.h> 879f920fbSDaniel Mack #include <linux/string.h> 979f920fbSDaniel Mack #include <linux/usb.h> 1079f920fbSDaniel Mack #include <linux/usb/audio.h> 1179f920fbSDaniel Mack #include <linux/usb/audio-v2.h> 129a2fe9b8SRuslan Bilovol #include <linux/usb/audio-v3.h> 1379f920fbSDaniel Mack 1479f920fbSDaniel Mack #include <sound/core.h> 1579f920fbSDaniel Mack #include <sound/info.h> 1679f920fbSDaniel Mack #include <sound/pcm.h> 1779f920fbSDaniel Mack 1879f920fbSDaniel Mack #include "usbaudio.h" 1979f920fbSDaniel Mack #include "card.h" 2079f920fbSDaniel Mack #include "helper.h" 21f22aa949SDaniel Mack #include "clock.h" 2221bb5aafSDaniel Mack #include "quirks.h" 2379f920fbSDaniel Mack 24*9ec73005STakashi Iwai union uac23_clock_source_desc { 25*9ec73005STakashi Iwai struct uac_clock_source_descriptor v2; 26*9ec73005STakashi Iwai struct uac3_clock_source_descriptor v3; 27*9ec73005STakashi Iwai }; 28*9ec73005STakashi Iwai 29*9ec73005STakashi Iwai union uac23_clock_selector_desc { 30*9ec73005STakashi Iwai struct uac_clock_selector_descriptor v2; 31*9ec73005STakashi Iwai struct uac3_clock_selector_descriptor v3; 32*9ec73005STakashi Iwai }; 33*9ec73005STakashi Iwai 34*9ec73005STakashi Iwai union uac23_clock_multiplier_desc { 35*9ec73005STakashi Iwai struct uac_clock_multiplier_descriptor v2; 36*9ec73005STakashi Iwai struct uac_clock_multiplier_descriptor v3; 37*9ec73005STakashi Iwai }; 38*9ec73005STakashi Iwai 39*9ec73005STakashi Iwai #define GET_VAL(p, proto, field) \ 40*9ec73005STakashi Iwai ((proto) == UAC_VERSION_3 ? (p)->v3.field : (p)->v2.field) 41*9ec73005STakashi Iwai 42f7645bd6STakashi Iwai static void *find_uac_clock_desc(struct usb_host_interface *iface, int id, 43*9ec73005STakashi Iwai bool (*validator)(void *, int, int), 44*9ec73005STakashi Iwai u8 type, int proto) 4579f920fbSDaniel Mack { 46f7645bd6STakashi Iwai void *cs = NULL; 4779f920fbSDaniel Mack 48f7645bd6STakashi Iwai while ((cs = snd_usb_find_csint_desc(iface->extra, iface->extralen, 49f7645bd6STakashi Iwai cs, type))) { 50*9ec73005STakashi Iwai if (validator(cs, id, proto)) 5179f920fbSDaniel Mack return cs; 5279f920fbSDaniel Mack } 5379f920fbSDaniel Mack 5479f920fbSDaniel Mack return NULL; 5579f920fbSDaniel Mack } 5679f920fbSDaniel Mack 57*9ec73005STakashi Iwai static bool validate_clock_source(void *p, int id, int proto) 589a2fe9b8SRuslan Bilovol { 59*9ec73005STakashi Iwai union uac23_clock_source_desc *cs = p; 60*9ec73005STakashi Iwai 61*9ec73005STakashi Iwai return GET_VAL(cs, proto, bClockID) == id; 629a2fe9b8SRuslan Bilovol } 639a2fe9b8SRuslan Bilovol 64*9ec73005STakashi Iwai static bool validate_clock_selector(void *p, int id, int proto) 6579f920fbSDaniel Mack { 66*9ec73005STakashi Iwai union uac23_clock_selector_desc *cs = p; 67*9ec73005STakashi Iwai 68*9ec73005STakashi Iwai return GET_VAL(cs, proto, bClockID) == id; 690a62d6c9STakashi Iwai } 7079f920fbSDaniel Mack 71*9ec73005STakashi Iwai static bool validate_clock_multiplier(void *p, int id, int proto) 729a2fe9b8SRuslan Bilovol { 73*9ec73005STakashi Iwai union uac23_clock_multiplier_desc *cs = p; 74*9ec73005STakashi Iwai 75*9ec73005STakashi Iwai return GET_VAL(cs, proto, bClockID) == id; 769a2fe9b8SRuslan Bilovol } 779a2fe9b8SRuslan Bilovol 78*9ec73005STakashi Iwai #define DEFINE_FIND_HELPER(name, obj, validator, type2, type3) \ 79*9ec73005STakashi Iwai static obj *name(struct snd_usb_audio *chip, int id, int proto) \ 80f7645bd6STakashi Iwai { \ 81*9ec73005STakashi Iwai return find_uac_clock_desc(chip->ctrl_intf, id, validator, \ 82*9ec73005STakashi Iwai proto == UAC_VERSION_3 ? (type3) : (type2), \ 83*9ec73005STakashi Iwai proto); \ 84f7645bd6STakashi Iwai } 85f7645bd6STakashi Iwai 86f7645bd6STakashi Iwai DEFINE_FIND_HELPER(snd_usb_find_clock_source, 87*9ec73005STakashi Iwai union uac23_clock_source_desc, validate_clock_source, 88*9ec73005STakashi Iwai UAC2_CLOCK_SOURCE, UAC3_CLOCK_SOURCE); 89f7645bd6STakashi Iwai DEFINE_FIND_HELPER(snd_usb_find_clock_selector, 90*9ec73005STakashi Iwai union uac23_clock_selector_desc, validate_clock_selector, 91*9ec73005STakashi Iwai UAC2_CLOCK_SELECTOR, UAC3_CLOCK_SELECTOR); 92f7645bd6STakashi Iwai DEFINE_FIND_HELPER(snd_usb_find_clock_multiplier, 93*9ec73005STakashi Iwai union uac23_clock_multiplier_desc, validate_clock_multiplier, 94*9ec73005STakashi Iwai UAC2_CLOCK_MULTIPLIER, UAC3_CLOCK_MULTIPLIER); 95f7645bd6STakashi Iwai 9679f920fbSDaniel Mack static int uac_clock_selector_get_val(struct snd_usb_audio *chip, int selector_id) 9779f920fbSDaniel Mack { 9879f920fbSDaniel Mack unsigned char buf; 9979f920fbSDaniel Mack int ret; 10079f920fbSDaniel Mack 10179f920fbSDaniel Mack ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), 10279f920fbSDaniel Mack UAC2_CS_CUR, 10379f920fbSDaniel Mack USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 10411bcbc44SDaniel Mack UAC2_CX_CLOCK_SELECTOR << 8, 10511bcbc44SDaniel Mack snd_usb_ctrl_intf(chip) | (selector_id << 8), 10617d900c4SClemens Ladisch &buf, sizeof(buf)); 10779f920fbSDaniel Mack 10879f920fbSDaniel Mack if (ret < 0) 10979f920fbSDaniel Mack return ret; 11079f920fbSDaniel Mack 11179f920fbSDaniel Mack return buf; 11279f920fbSDaniel Mack } 11379f920fbSDaniel Mack 1148c55af3fSEldad Zack static int uac_clock_selector_set_val(struct snd_usb_audio *chip, int selector_id, 1158c55af3fSEldad Zack unsigned char pin) 1168c55af3fSEldad Zack { 1178c55af3fSEldad Zack int ret; 1188c55af3fSEldad Zack 1198c55af3fSEldad Zack ret = snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0), 1208c55af3fSEldad Zack UAC2_CS_CUR, 1218c55af3fSEldad Zack USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT, 1228c55af3fSEldad Zack UAC2_CX_CLOCK_SELECTOR << 8, 1238c55af3fSEldad Zack snd_usb_ctrl_intf(chip) | (selector_id << 8), 1248c55af3fSEldad Zack &pin, sizeof(pin)); 1258c55af3fSEldad Zack if (ret < 0) 1268c55af3fSEldad Zack return ret; 1278c55af3fSEldad Zack 1288c55af3fSEldad Zack if (ret != sizeof(pin)) { 1290ba41d91STakashi Iwai usb_audio_err(chip, 1300ba41d91STakashi Iwai "setting selector (id %d) unexpected length %d\n", 1310ba41d91STakashi Iwai selector_id, ret); 1328c55af3fSEldad Zack return -EINVAL; 1338c55af3fSEldad Zack } 1348c55af3fSEldad Zack 1358c55af3fSEldad Zack ret = uac_clock_selector_get_val(chip, selector_id); 1368c55af3fSEldad Zack if (ret < 0) 1378c55af3fSEldad Zack return ret; 1388c55af3fSEldad Zack 1398c55af3fSEldad Zack if (ret != pin) { 1400ba41d91STakashi Iwai usb_audio_err(chip, 1410ba41d91STakashi Iwai "setting selector (id %d) to %x failed (current: %d)\n", 1420ba41d91STakashi Iwai selector_id, pin, ret); 1438c55af3fSEldad Zack return -EINVAL; 1448c55af3fSEldad Zack } 1458c55af3fSEldad Zack 1468c55af3fSEldad Zack return ret; 1478c55af3fSEldad Zack } 1488c55af3fSEldad Zack 1499f35a312SAlexander Tsoy static bool uac_clock_source_is_valid_quirk(struct snd_usb_audio *chip, 150cab941b7STakashi Iwai const struct audioformat *fmt, 1519f35a312SAlexander Tsoy int source_id) 1529f35a312SAlexander Tsoy { 1532edb84e3SAlexander Tsoy bool ret = false; 1542edb84e3SAlexander Tsoy int count; 1552edb84e3SAlexander Tsoy unsigned char data; 1562edb84e3SAlexander Tsoy struct usb_device *dev = chip->dev; 157*9ec73005STakashi Iwai union uac23_clock_source_desc *cs_desc; 1582edb84e3SAlexander Tsoy 159*9ec73005STakashi Iwai cs_desc = snd_usb_find_clock_source(chip, source_id, fmt->protocol); 1609f35a312SAlexander Tsoy if (!cs_desc) 1619f35a312SAlexander Tsoy return false; 1629f35a312SAlexander Tsoy 163*9ec73005STakashi Iwai if (fmt->protocol == UAC_VERSION_2) { 1642edb84e3SAlexander Tsoy /* 1652edb84e3SAlexander Tsoy * Assume the clock is valid if clock source supports only one 1662edb84e3SAlexander Tsoy * single sample rate, the terminal is connected directly to it 1672edb84e3SAlexander Tsoy * (there is no clock selector) and clock type is internal. 1682edb84e3SAlexander Tsoy * This is to deal with some Denon DJ controllers that always 1692edb84e3SAlexander Tsoy * reports that clock is invalid. 1702edb84e3SAlexander Tsoy */ 1712edb84e3SAlexander Tsoy if (fmt->nr_rates == 1 && 172*9ec73005STakashi Iwai (fmt->clock & 0xff) == cs_desc->v2.bClockID && 173*9ec73005STakashi Iwai (cs_desc->v2.bmAttributes & 0x3) != 1742edb84e3SAlexander Tsoy UAC_CLOCK_SOURCE_TYPE_EXT) 1752edb84e3SAlexander Tsoy return true; 1769f35a312SAlexander Tsoy } 1779f35a312SAlexander Tsoy 1782edb84e3SAlexander Tsoy /* 1792edb84e3SAlexander Tsoy * MOTU MicroBook IIc 1802edb84e3SAlexander Tsoy * Sample rate changes takes more than 2 seconds for this device. Clock 1812edb84e3SAlexander Tsoy * validity request returns false during that period. 1822edb84e3SAlexander Tsoy */ 1832edb84e3SAlexander Tsoy if (chip->usb_id == USB_ID(0x07fd, 0x0004)) { 1842edb84e3SAlexander Tsoy count = 0; 1852edb84e3SAlexander Tsoy 1862edb84e3SAlexander Tsoy while ((!ret) && (count < 50)) { 1872edb84e3SAlexander Tsoy int err; 1882edb84e3SAlexander Tsoy 1892edb84e3SAlexander Tsoy msleep(100); 1902edb84e3SAlexander Tsoy 1912edb84e3SAlexander Tsoy err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR, 1922edb84e3SAlexander Tsoy USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN, 1932edb84e3SAlexander Tsoy UAC2_CS_CONTROL_CLOCK_VALID << 8, 1942edb84e3SAlexander Tsoy snd_usb_ctrl_intf(chip) | (source_id << 8), 1952edb84e3SAlexander Tsoy &data, sizeof(data)); 1962edb84e3SAlexander Tsoy if (err < 0) { 1972edb84e3SAlexander Tsoy dev_warn(&dev->dev, 1982edb84e3SAlexander Tsoy "%s(): cannot get clock validity for id %d\n", 1992edb84e3SAlexander Tsoy __func__, source_id); 2009f35a312SAlexander Tsoy return false; 2019f35a312SAlexander Tsoy } 2029f35a312SAlexander Tsoy 2032edb84e3SAlexander Tsoy ret = !!data; 2042edb84e3SAlexander Tsoy count++; 2052edb84e3SAlexander Tsoy } 2062edb84e3SAlexander Tsoy } 2072edb84e3SAlexander Tsoy 2082edb84e3SAlexander Tsoy return ret; 2092edb84e3SAlexander Tsoy } 2102edb84e3SAlexander Tsoy 2119a2fe9b8SRuslan Bilovol static bool uac_clock_source_is_valid(struct snd_usb_audio *chip, 212cab941b7STakashi Iwai const struct audioformat *fmt, 2139a2fe9b8SRuslan Bilovol int source_id) 21479f920fbSDaniel Mack { 21579f920fbSDaniel Mack int err; 21679f920fbSDaniel Mack unsigned char data; 21779f920fbSDaniel Mack struct usb_device *dev = chip->dev; 2189a2fe9b8SRuslan Bilovol u32 bmControls; 219*9ec73005STakashi Iwai union uac23_clock_source_desc *cs_desc; 2209a2fe9b8SRuslan Bilovol 221*9ec73005STakashi Iwai cs_desc = snd_usb_find_clock_source(chip, source_id, fmt->protocol); 2229a2fe9b8SRuslan Bilovol if (!cs_desc) 2231d4961d9SSaurav Girepunje return false; 2243bc6fbc7SDaniel Mack 225*9ec73005STakashi Iwai if (fmt->protocol == UAC_VERSION_3) 226*9ec73005STakashi Iwai bmControls = le32_to_cpu(cs_desc->v3.bmControls); 227*9ec73005STakashi Iwai else 228*9ec73005STakashi Iwai bmControls = cs_desc->v2.bmControls; 2293bc6fbc7SDaniel Mack 2303bc6fbc7SDaniel Mack /* If a clock source can't tell us whether it's valid, we assume it is */ 2319a2fe9b8SRuslan Bilovol if (!uac_v2v3_control_is_readable(bmControls, 23221e9b3e9SAndrew Chant UAC2_CS_CONTROL_CLOCK_VALID)) 2331d4961d9SSaurav Girepunje return true; 23479f920fbSDaniel Mack 23579f920fbSDaniel Mack err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR, 23679f920fbSDaniel Mack USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN, 23711bcbc44SDaniel Mack UAC2_CS_CONTROL_CLOCK_VALID << 8, 23811bcbc44SDaniel Mack snd_usb_ctrl_intf(chip) | (source_id << 8), 23917d900c4SClemens Ladisch &data, sizeof(data)); 24079f920fbSDaniel Mack 24179f920fbSDaniel Mack if (err < 0) { 2420ba41d91STakashi Iwai dev_warn(&dev->dev, 2430ba41d91STakashi Iwai "%s(): cannot get clock validity for id %d\n", 24479f920fbSDaniel Mack __func__, source_id); 2451d4961d9SSaurav Girepunje return false; 24679f920fbSDaniel Mack } 24779f920fbSDaniel Mack 2489f35a312SAlexander Tsoy if (data) 2499f35a312SAlexander Tsoy return true; 2509f35a312SAlexander Tsoy else 2519f35a312SAlexander Tsoy return uac_clock_source_is_valid_quirk(chip, fmt, source_id); 25279f920fbSDaniel Mack } 25379f920fbSDaniel Mack 2549f35a312SAlexander Tsoy static int __uac_clock_find_source(struct snd_usb_audio *chip, 255cab941b7STakashi Iwai const struct audioformat *fmt, int entity_id, 2569a2fe9b8SRuslan Bilovol unsigned long *visited, bool validate) 25779f920fbSDaniel Mack { 258*9ec73005STakashi Iwai union uac23_clock_source_desc *source; 259*9ec73005STakashi Iwai union uac23_clock_selector_desc *selector; 260*9ec73005STakashi Iwai union uac23_clock_multiplier_desc *multiplier; 261*9ec73005STakashi Iwai int ret, i, cur, err, pins, clock_id; 262*9ec73005STakashi Iwai const u8 *sources; 263*9ec73005STakashi Iwai int proto = fmt->protocol; 26479f920fbSDaniel Mack 26579f920fbSDaniel Mack entity_id &= 0xff; 26679f920fbSDaniel Mack 26779f920fbSDaniel Mack if (test_and_set_bit(entity_id, visited)) { 2680ba41d91STakashi Iwai usb_audio_warn(chip, 26979f920fbSDaniel Mack "%s(): recursive clock topology detected, id %d.\n", 27079f920fbSDaniel Mack __func__, entity_id); 27179f920fbSDaniel Mack return -EINVAL; 27279f920fbSDaniel Mack } 27379f920fbSDaniel Mack 27479f920fbSDaniel Mack /* first, see if the ID we're looking for is a clock source already */ 275*9ec73005STakashi Iwai source = snd_usb_find_clock_source(chip, entity_id, proto); 27606ffc1ebSEldad Zack if (source) { 277*9ec73005STakashi Iwai entity_id = GET_VAL(source, proto, bClockID); 2789f35a312SAlexander Tsoy if (validate && !uac_clock_source_is_valid(chip, fmt, 2799a2fe9b8SRuslan Bilovol entity_id)) { 2800ba41d91STakashi Iwai usb_audio_err(chip, 2810ba41d91STakashi Iwai "clock source %d is not valid, cannot use\n", 2820ba41d91STakashi Iwai entity_id); 28306ffc1ebSEldad Zack return -ENXIO; 28406ffc1ebSEldad Zack } 28506ffc1ebSEldad Zack return entity_id; 28606ffc1ebSEldad Zack } 28779f920fbSDaniel Mack 288*9ec73005STakashi Iwai selector = snd_usb_find_clock_selector(chip, entity_id, proto); 28979f920fbSDaniel Mack if (selector) { 290*9ec73005STakashi Iwai pins = GET_VAL(selector, proto, bNrInPins); 291*9ec73005STakashi Iwai clock_id = GET_VAL(selector, proto, bClockID); 292*9ec73005STakashi Iwai sources = GET_VAL(selector, proto, baCSourceID); 29379f920fbSDaniel Mack 294*9ec73005STakashi Iwai if (pins == 1) { 295086b957cSTakashi Iwai ret = 1; 296086b957cSTakashi Iwai goto find_source; 297086b957cSTakashi Iwai } 298086b957cSTakashi Iwai 29979f920fbSDaniel Mack /* the entity ID we are looking for is a selector. 30079f920fbSDaniel Mack * find out what it currently selects */ 301*9ec73005STakashi Iwai ret = uac_clock_selector_get_val(chip, clock_id); 30279f920fbSDaniel Mack if (ret < 0) 30379f920fbSDaniel Mack return ret; 30479f920fbSDaniel Mack 305157a57b6SDaniel Mack /* Selector values are one-based */ 306157a57b6SDaniel Mack 307*9ec73005STakashi Iwai if (ret > pins || ret < 1) { 3080ba41d91STakashi Iwai usb_audio_err(chip, 30979f920fbSDaniel Mack "%s(): selector reported illegal value, id %d, ret %d\n", 310*9ec73005STakashi Iwai __func__, clock_id, ret); 31179f920fbSDaniel Mack 31279f920fbSDaniel Mack return -EINVAL; 31379f920fbSDaniel Mack } 31479f920fbSDaniel Mack 315086b957cSTakashi Iwai find_source: 3168c55af3fSEldad Zack cur = ret; 3179f35a312SAlexander Tsoy ret = __uac_clock_find_source(chip, fmt, 318*9ec73005STakashi Iwai sources[ret - 1], 31906ffc1ebSEldad Zack visited, validate); 320d2e8f641STakashi Iwai if (ret > 0) { 321d2e8f641STakashi Iwai err = uac_clock_selector_set_val(chip, entity_id, cur); 322d2e8f641STakashi Iwai if (err < 0) 323d2e8f641STakashi Iwai return err; 324d2e8f641STakashi Iwai } 325d2e8f641STakashi Iwai 326ef02e29bSEldad Zack if (!validate || ret > 0 || !chip->autoclock) 3278c55af3fSEldad Zack return ret; 3288c55af3fSEldad Zack 3298c55af3fSEldad Zack /* The current clock source is invalid, try others. */ 330*9ec73005STakashi Iwai for (i = 1; i <= pins; i++) { 3318c55af3fSEldad Zack if (i == cur) 3328c55af3fSEldad Zack continue; 3338c55af3fSEldad Zack 3349f35a312SAlexander Tsoy ret = __uac_clock_find_source(chip, fmt, 335*9ec73005STakashi Iwai sources[i - 1], 3368c55af3fSEldad Zack visited, true); 3378c55af3fSEldad Zack if (ret < 0) 3388c55af3fSEldad Zack continue; 3398c55af3fSEldad Zack 3408c55af3fSEldad Zack err = uac_clock_selector_set_val(chip, entity_id, i); 3418c55af3fSEldad Zack if (err < 0) 3428c55af3fSEldad Zack continue; 3438c55af3fSEldad Zack 3440ba41d91STakashi Iwai usb_audio_info(chip, 3450ba41d91STakashi Iwai "found and selected valid clock source %d\n", 3460ba41d91STakashi Iwai ret); 3478c55af3fSEldad Zack return ret; 3488c55af3fSEldad Zack } 3498c55af3fSEldad Zack 3508c55af3fSEldad Zack return -ENXIO; 35179f920fbSDaniel Mack } 35279f920fbSDaniel Mack 35379f920fbSDaniel Mack /* FIXME: multipliers only act as pass-thru element for now */ 354*9ec73005STakashi Iwai multiplier = snd_usb_find_clock_multiplier(chip, entity_id, proto); 35579f920fbSDaniel Mack if (multiplier) 3569f35a312SAlexander Tsoy return __uac_clock_find_source(chip, fmt, 357*9ec73005STakashi Iwai GET_VAL(multiplier, proto, bCSourceID), 3589a2fe9b8SRuslan Bilovol visited, validate); 3599a2fe9b8SRuslan Bilovol 3609a2fe9b8SRuslan Bilovol return -EINVAL; 3619a2fe9b8SRuslan Bilovol } 3629a2fe9b8SRuslan Bilovol 363157a57b6SDaniel Mack /* 364157a57b6SDaniel Mack * For all kinds of sample rate settings and other device queries, 365157a57b6SDaniel Mack * the clock source (end-leaf) must be used. However, clock selectors, 366157a57b6SDaniel Mack * clock multipliers and sample rate converters may be specified as 367157a57b6SDaniel Mack * clock source input to terminal. This functions walks the clock path 368157a57b6SDaniel Mack * to its end and tries to find the source. 369157a57b6SDaniel Mack * 370157a57b6SDaniel Mack * The 'visited' bitfield is used internally to detect recursive loops. 371157a57b6SDaniel Mack * 372157a57b6SDaniel Mack * Returns the clock source UnitID (>=0) on success, or an error. 373157a57b6SDaniel Mack */ 3749f35a312SAlexander Tsoy int snd_usb_clock_find_source(struct snd_usb_audio *chip, 375cab941b7STakashi Iwai const struct audioformat *fmt, bool validate) 37679f920fbSDaniel Mack { 37779f920fbSDaniel Mack DECLARE_BITMAP(visited, 256); 37879f920fbSDaniel Mack memset(visited, 0, sizeof(visited)); 3799a2fe9b8SRuslan Bilovol 3809f35a312SAlexander Tsoy switch (fmt->protocol) { 3819a2fe9b8SRuslan Bilovol case UAC_VERSION_2: 3829a2fe9b8SRuslan Bilovol case UAC_VERSION_3: 383*9ec73005STakashi Iwai return __uac_clock_find_source(chip, fmt, fmt->clock, visited, 3849a2fe9b8SRuslan Bilovol validate); 3859a2fe9b8SRuslan Bilovol default: 3869a2fe9b8SRuslan Bilovol return -EINVAL; 3879a2fe9b8SRuslan Bilovol } 38879f920fbSDaniel Mack } 38979f920fbSDaniel Mack 390953a446bSTakashi Iwai static int set_sample_rate_v1(struct snd_usb_audio *chip, 391cab941b7STakashi Iwai const struct audioformat *fmt, int rate) 39279f920fbSDaniel Mack { 39379f920fbSDaniel Mack struct usb_device *dev = chip->dev; 39479f920fbSDaniel Mack unsigned char data[3]; 39579f920fbSDaniel Mack int err, crate; 39679f920fbSDaniel Mack 39779f920fbSDaniel Mack /* if endpoint doesn't have sampling rate control, bail out */ 398d32d552eSClemens Ladisch if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE)) 39979f920fbSDaniel Mack return 0; 40079f920fbSDaniel Mack 40179f920fbSDaniel Mack data[0] = rate; 40279f920fbSDaniel Mack data[1] = rate >> 8; 40379f920fbSDaniel Mack data[2] = rate >> 16; 404f25ecf8fSTakashi Iwai err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR, 40579f920fbSDaniel Mack USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT, 40687cb9af9STakashi Iwai UAC_EP_CS_ATTR_SAMPLE_RATE << 8, 40787cb9af9STakashi Iwai fmt->endpoint, data, sizeof(data)); 408f25ecf8fSTakashi Iwai if (err < 0) { 4090ba41d91STakashi Iwai dev_err(&dev->dev, "%d:%d: cannot set freq %d to ep %#x\n", 41087cb9af9STakashi Iwai fmt->iface, fmt->altsetting, rate, fmt->endpoint); 41179f920fbSDaniel Mack return err; 41279f920fbSDaniel Mack } 41379f920fbSDaniel Mack 414b62b9980SJoe Turner /* Don't check the sample rate for devices which we know don't 415b62b9980SJoe Turner * support reading */ 416b62b9980SJoe Turner if (snd_usb_get_sample_rate_quirk(chip)) 417b62b9980SJoe Turner return 0; 41857dd5414STakashi Iwai /* the firmware is likely buggy, don't repeat to fail too many times */ 41957dd5414STakashi Iwai if (chip->sample_rate_read_error > 2) 42057dd5414STakashi Iwai return 0; 421b62b9980SJoe Turner 422f25ecf8fSTakashi Iwai err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC_GET_CUR, 42379f920fbSDaniel Mack USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_IN, 42487cb9af9STakashi Iwai UAC_EP_CS_ATTR_SAMPLE_RATE << 8, 42587cb9af9STakashi Iwai fmt->endpoint, data, sizeof(data)); 426f25ecf8fSTakashi Iwai if (err < 0) { 4270ba41d91STakashi Iwai dev_err(&dev->dev, "%d:%d: cannot get freq at ep %#x\n", 42887cb9af9STakashi Iwai fmt->iface, fmt->altsetting, fmt->endpoint); 42957dd5414STakashi Iwai chip->sample_rate_read_error++; 43079f920fbSDaniel Mack return 0; /* some devices don't support reading */ 43179f920fbSDaniel Mack } 43279f920fbSDaniel Mack 43379f920fbSDaniel Mack crate = data[0] | (data[1] << 8) | (data[2] << 16); 4349df28edcSTakashi Iwai if (!crate) { 4359df28edcSTakashi Iwai dev_info(&dev->dev, "failed to read current rate; disabling the check\n"); 4369df28edcSTakashi Iwai chip->sample_rate_read_error = 3; /* three strikes, see above */ 4379df28edcSTakashi Iwai return 0; 4389df28edcSTakashi Iwai } 4399df28edcSTakashi Iwai 44079f920fbSDaniel Mack if (crate != rate) { 4410ba41d91STakashi Iwai dev_warn(&dev->dev, "current rate %d is different from the runtime rate %d\n", crate, rate); 44279f920fbSDaniel Mack // runtime->rate = crate; 44379f920fbSDaniel Mack } 44479f920fbSDaniel Mack 44579f920fbSDaniel Mack return 0; 44679f920fbSDaniel Mack } 44779f920fbSDaniel Mack 4489a2fe9b8SRuslan Bilovol static int get_sample_rate_v2v3(struct snd_usb_audio *chip, int iface, 4497c517465STakashi Iwai int altsetting, int clock) 4507c517465STakashi Iwai { 4517c517465STakashi Iwai struct usb_device *dev = chip->dev; 452f6a8bc70SEldad Zack __le32 data; 4537c517465STakashi Iwai int err; 4547c517465STakashi Iwai 4557c517465STakashi Iwai err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR, 4567c517465STakashi Iwai USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN, 4577c517465STakashi Iwai UAC2_CS_CONTROL_SAM_FREQ << 8, 4587c517465STakashi Iwai snd_usb_ctrl_intf(chip) | (clock << 8), 459f6a8bc70SEldad Zack &data, sizeof(data)); 4607c517465STakashi Iwai if (err < 0) { 4619a2fe9b8SRuslan Bilovol dev_warn(&dev->dev, "%d:%d: cannot get freq (v2/v3): err %d\n", 4620ba41d91STakashi Iwai iface, altsetting, err); 4637c517465STakashi Iwai return 0; 4647c517465STakashi Iwai } 4657c517465STakashi Iwai 466f6a8bc70SEldad Zack return le32_to_cpu(data); 4677c517465STakashi Iwai } 4687c517465STakashi Iwai 46993db51d0STakashi Iwai /* 47093db51d0STakashi Iwai * Try to set the given sample rate: 47193db51d0STakashi Iwai * 47293db51d0STakashi Iwai * Return 0 if the clock source is read-only, the actual rate on success, 47393db51d0STakashi Iwai * or a negative error code. 47493db51d0STakashi Iwai * 47593db51d0STakashi Iwai * This function gets called from format.c to validate each sample rate, too. 47693db51d0STakashi Iwai * Hence no message is shown upon error 47793db51d0STakashi Iwai */ 47893db51d0STakashi Iwai int snd_usb_set_sample_rate_v2v3(struct snd_usb_audio *chip, 47993db51d0STakashi Iwai const struct audioformat *fmt, 48093db51d0STakashi Iwai int clock, int rate) 48193db51d0STakashi Iwai { 48293db51d0STakashi Iwai bool writeable; 48393db51d0STakashi Iwai u32 bmControls; 48493db51d0STakashi Iwai __le32 data; 48593db51d0STakashi Iwai int err; 486*9ec73005STakashi Iwai union uac23_clock_source_desc *cs_desc; 48793db51d0STakashi Iwai 488*9ec73005STakashi Iwai cs_desc = snd_usb_find_clock_source(chip, clock, fmt->protocol); 489*9ec73005STakashi Iwai if (fmt->protocol == UAC_VERSION_3) 490*9ec73005STakashi Iwai bmControls = le32_to_cpu(cs_desc->v3.bmControls); 491*9ec73005STakashi Iwai else 492*9ec73005STakashi Iwai bmControls = cs_desc->v2.bmControls; 49393db51d0STakashi Iwai 49493db51d0STakashi Iwai writeable = uac_v2v3_control_is_writeable(bmControls, 49593db51d0STakashi Iwai UAC2_CS_CONTROL_SAM_FREQ); 49693db51d0STakashi Iwai if (!writeable) 49793db51d0STakashi Iwai return 0; 49893db51d0STakashi Iwai 49993db51d0STakashi Iwai data = cpu_to_le32(rate); 50093db51d0STakashi Iwai err = snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0), UAC2_CS_CUR, 50193db51d0STakashi Iwai USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT, 50293db51d0STakashi Iwai UAC2_CS_CONTROL_SAM_FREQ << 8, 50393db51d0STakashi Iwai snd_usb_ctrl_intf(chip) | (clock << 8), 50493db51d0STakashi Iwai &data, sizeof(data)); 50593db51d0STakashi Iwai if (err < 0) 50693db51d0STakashi Iwai return err; 50793db51d0STakashi Iwai 50893db51d0STakashi Iwai return get_sample_rate_v2v3(chip, fmt->iface, fmt->altsetting, clock); 50993db51d0STakashi Iwai } 51093db51d0STakashi Iwai 511953a446bSTakashi Iwai static int set_sample_rate_v2v3(struct snd_usb_audio *chip, 512cab941b7STakashi Iwai const struct audioformat *fmt, int rate) 51379f920fbSDaniel Mack { 51493db51d0STakashi Iwai int cur_rate, prev_rate; 5158c55af3fSEldad Zack int clock; 51679f920fbSDaniel Mack 51758cabe87SAdam Goode /* First, try to find a valid clock. This may trigger 51858cabe87SAdam Goode * automatic clock selection if the current clock is not 51958cabe87SAdam Goode * valid. 52058cabe87SAdam Goode */ 5219f35a312SAlexander Tsoy clock = snd_usb_clock_find_source(chip, fmt, true); 52258cabe87SAdam Goode if (clock < 0) { 52358cabe87SAdam Goode /* We did not find a valid clock, but that might be 52458cabe87SAdam Goode * because the current sample rate does not match an 52558cabe87SAdam Goode * external clock source. Try again without validation 52658cabe87SAdam Goode * and we will do another validation after setting the 52758cabe87SAdam Goode * rate. 52858cabe87SAdam Goode */ 5299f35a312SAlexander Tsoy clock = snd_usb_clock_find_source(chip, fmt, false); 53079f920fbSDaniel Mack if (clock < 0) 53179f920fbSDaniel Mack return clock; 53258cabe87SAdam Goode } 53379f920fbSDaniel Mack 534953a446bSTakashi Iwai prev_rate = get_sample_rate_v2v3(chip, fmt->iface, fmt->altsetting, clock); 535fa92dd77SDavid Henningsson if (prev_rate == rate) 53658cabe87SAdam Goode goto validation; 537690a863fSTorstein Hegge 53893db51d0STakashi Iwai cur_rate = snd_usb_set_sample_rate_v2v3(chip, fmt, clock, rate); 53993db51d0STakashi Iwai if (cur_rate < 0) { 5400ba41d91STakashi Iwai usb_audio_err(chip, 5419a2fe9b8SRuslan Bilovol "%d:%d: cannot set freq %d (v2/v3): err %d\n", 542953a446bSTakashi Iwai fmt->iface, fmt->altsetting, rate, cur_rate); 54393db51d0STakashi Iwai return cur_rate; 54479f920fbSDaniel Mack } 54579f920fbSDaniel Mack 54693db51d0STakashi Iwai if (!cur_rate) 5471dc669feSEldad Zack cur_rate = prev_rate; 54879f920fbSDaniel Mack 549690a863fSTorstein Hegge if (cur_rate != rate) { 550dcf269b3STakashi Iwai usb_audio_dbg(chip, 551dcf269b3STakashi Iwai "%d:%d: freq mismatch: req %d, clock runs @%d\n", 55293db51d0STakashi Iwai fmt->iface, fmt->altsetting, rate, cur_rate); 553dcf269b3STakashi Iwai /* continue processing */ 5541dc669feSEldad Zack } 555690a863fSTorstein Hegge 55658cabe87SAdam Goode validation: 55758cabe87SAdam Goode /* validate clock after rate change */ 5589f35a312SAlexander Tsoy if (!uac_clock_source_is_valid(chip, fmt, clock)) 55958cabe87SAdam Goode return -ENXIO; 56079f920fbSDaniel Mack return 0; 56179f920fbSDaniel Mack } 56279f920fbSDaniel Mack 563953a446bSTakashi Iwai int snd_usb_init_sample_rate(struct snd_usb_audio *chip, 564cab941b7STakashi Iwai const struct audioformat *fmt, int rate) 56579f920fbSDaniel Mack { 566bf6313a0STakashi Iwai usb_audio_dbg(chip, "%d:%d Set sample rate %d, clock %d\n", 567bf6313a0STakashi Iwai fmt->iface, fmt->altsetting, rate, fmt->clock); 568bf6313a0STakashi Iwai 5698f898e92SClemens Ladisch switch (fmt->protocol) { 57079f920fbSDaniel Mack case UAC_VERSION_1: 571a2acad82SClemens Ladisch default: 572953a446bSTakashi Iwai return set_sample_rate_v1(chip, fmt, rate); 57379f920fbSDaniel Mack 5749a2fe9b8SRuslan Bilovol case UAC_VERSION_3: 57517156f23SRuslan Bilovol if (chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) { 57617156f23SRuslan Bilovol if (rate != UAC3_BADD_SAMPLING_RATE) 57717156f23SRuslan Bilovol return -ENXIO; 57817156f23SRuslan Bilovol else 57917156f23SRuslan Bilovol return 0; 58017156f23SRuslan Bilovol } 581c0dbbdadSGustavo A. R. Silva fallthrough; 58217156f23SRuslan Bilovol case UAC_VERSION_2: 583953a446bSTakashi Iwai return set_sample_rate_v2v3(chip, fmt, rate); 58479f920fbSDaniel Mack } 58579f920fbSDaniel Mack } 58679f920fbSDaniel Mack 587