1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Clock domain and sample rate management functions 4 */ 5 6 #include <linux/bitops.h> 7 #include <linux/init.h> 8 #include <linux/string.h> 9 #include <linux/usb.h> 10 #include <linux/usb/audio.h> 11 #include <linux/usb/audio-v2.h> 12 #include <linux/usb/audio-v3.h> 13 14 #include <sound/core.h> 15 #include <sound/info.h> 16 #include <sound/pcm.h> 17 18 #include "usbaudio.h" 19 #include "card.h" 20 #include "helper.h" 21 #include "clock.h" 22 #include "quirks.h" 23 24 static void *find_uac_clock_desc(struct usb_host_interface *iface, int id, 25 bool (*validator)(void *, int), u8 type) 26 { 27 void *cs = NULL; 28 29 while ((cs = snd_usb_find_csint_desc(iface->extra, iface->extralen, 30 cs, type))) { 31 if (validator(cs, id)) 32 return cs; 33 } 34 35 return NULL; 36 } 37 38 static bool validate_clock_source_v2(void *p, int id) 39 { 40 struct uac_clock_source_descriptor *cs = p; 41 return cs->bClockID == id; 42 } 43 44 static bool validate_clock_source_v3(void *p, int id) 45 { 46 struct uac3_clock_source_descriptor *cs = p; 47 return cs->bClockID == id; 48 } 49 50 static bool validate_clock_selector_v2(void *p, int id) 51 { 52 struct uac_clock_selector_descriptor *cs = p; 53 return cs->bClockID == id; 54 } 55 56 static bool validate_clock_selector_v3(void *p, int id) 57 { 58 struct uac3_clock_selector_descriptor *cs = p; 59 return cs->bClockID == id; 60 } 61 62 static bool validate_clock_multiplier_v2(void *p, int id) 63 { 64 struct uac_clock_multiplier_descriptor *cs = p; 65 return cs->bClockID == id; 66 } 67 68 static bool validate_clock_multiplier_v3(void *p, int id) 69 { 70 struct uac3_clock_multiplier_descriptor *cs = p; 71 return cs->bClockID == id; 72 } 73 74 #define DEFINE_FIND_HELPER(name, obj, validator, type) \ 75 static obj *name(struct usb_host_interface *iface, int id) \ 76 { \ 77 return find_uac_clock_desc(iface, id, validator, type); \ 78 } 79 80 DEFINE_FIND_HELPER(snd_usb_find_clock_source, 81 struct uac_clock_source_descriptor, 82 validate_clock_source_v2, UAC2_CLOCK_SOURCE); 83 DEFINE_FIND_HELPER(snd_usb_find_clock_source_v3, 84 struct uac3_clock_source_descriptor, 85 validate_clock_source_v3, UAC3_CLOCK_SOURCE); 86 87 DEFINE_FIND_HELPER(snd_usb_find_clock_selector, 88 struct uac_clock_selector_descriptor, 89 validate_clock_selector_v2, UAC2_CLOCK_SELECTOR); 90 DEFINE_FIND_HELPER(snd_usb_find_clock_selector_v3, 91 struct uac3_clock_selector_descriptor, 92 validate_clock_selector_v3, UAC3_CLOCK_SELECTOR); 93 94 DEFINE_FIND_HELPER(snd_usb_find_clock_multiplier, 95 struct uac_clock_multiplier_descriptor, 96 validate_clock_multiplier_v2, UAC2_CLOCK_MULTIPLIER); 97 DEFINE_FIND_HELPER(snd_usb_find_clock_multiplier_v3, 98 struct uac3_clock_multiplier_descriptor, 99 validate_clock_multiplier_v3, UAC3_CLOCK_MULTIPLIER); 100 101 static int uac_clock_selector_get_val(struct snd_usb_audio *chip, int selector_id) 102 { 103 unsigned char buf; 104 int ret; 105 106 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), 107 UAC2_CS_CUR, 108 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN, 109 UAC2_CX_CLOCK_SELECTOR << 8, 110 snd_usb_ctrl_intf(chip) | (selector_id << 8), 111 &buf, sizeof(buf)); 112 113 if (ret < 0) 114 return ret; 115 116 return buf; 117 } 118 119 static int uac_clock_selector_set_val(struct snd_usb_audio *chip, int selector_id, 120 unsigned char pin) 121 { 122 int ret; 123 124 ret = snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0), 125 UAC2_CS_CUR, 126 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT, 127 UAC2_CX_CLOCK_SELECTOR << 8, 128 snd_usb_ctrl_intf(chip) | (selector_id << 8), 129 &pin, sizeof(pin)); 130 if (ret < 0) 131 return ret; 132 133 if (ret != sizeof(pin)) { 134 usb_audio_err(chip, 135 "setting selector (id %d) unexpected length %d\n", 136 selector_id, ret); 137 return -EINVAL; 138 } 139 140 ret = uac_clock_selector_get_val(chip, selector_id); 141 if (ret < 0) 142 return ret; 143 144 if (ret != pin) { 145 usb_audio_err(chip, 146 "setting selector (id %d) to %x failed (current: %d)\n", 147 selector_id, pin, ret); 148 return -EINVAL; 149 } 150 151 return ret; 152 } 153 154 static bool uac_clock_source_is_valid_quirk(struct snd_usb_audio *chip, 155 const struct audioformat *fmt, 156 int source_id) 157 { 158 bool ret = false; 159 int count; 160 unsigned char data; 161 struct usb_device *dev = chip->dev; 162 163 if (fmt->protocol == UAC_VERSION_2) { 164 struct uac_clock_source_descriptor *cs_desc = 165 snd_usb_find_clock_source(chip->ctrl_intf, source_id); 166 167 if (!cs_desc) 168 return false; 169 170 /* 171 * Assume the clock is valid if clock source supports only one 172 * single sample rate, the terminal is connected directly to it 173 * (there is no clock selector) and clock type is internal. 174 * This is to deal with some Denon DJ controllers that always 175 * reports that clock is invalid. 176 */ 177 if (fmt->nr_rates == 1 && 178 (fmt->clock & 0xff) == cs_desc->bClockID && 179 (cs_desc->bmAttributes & 0x3) != 180 UAC_CLOCK_SOURCE_TYPE_EXT) 181 return true; 182 } 183 184 /* 185 * MOTU MicroBook IIc 186 * Sample rate changes takes more than 2 seconds for this device. Clock 187 * validity request returns false during that period. 188 */ 189 if (chip->usb_id == USB_ID(0x07fd, 0x0004)) { 190 count = 0; 191 192 while ((!ret) && (count < 50)) { 193 int err; 194 195 msleep(100); 196 197 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR, 198 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN, 199 UAC2_CS_CONTROL_CLOCK_VALID << 8, 200 snd_usb_ctrl_intf(chip) | (source_id << 8), 201 &data, sizeof(data)); 202 if (err < 0) { 203 dev_warn(&dev->dev, 204 "%s(): cannot get clock validity for id %d\n", 205 __func__, source_id); 206 return false; 207 } 208 209 ret = !!data; 210 count++; 211 } 212 } 213 214 return ret; 215 } 216 217 static bool uac_clock_source_is_valid(struct snd_usb_audio *chip, 218 const struct audioformat *fmt, 219 int source_id) 220 { 221 int err; 222 unsigned char data; 223 struct usb_device *dev = chip->dev; 224 u32 bmControls; 225 226 if (fmt->protocol == UAC_VERSION_3) { 227 struct uac3_clock_source_descriptor *cs_desc = 228 snd_usb_find_clock_source_v3(chip->ctrl_intf, source_id); 229 230 if (!cs_desc) 231 return false; 232 bmControls = le32_to_cpu(cs_desc->bmControls); 233 } else { /* UAC_VERSION_1/2 */ 234 struct uac_clock_source_descriptor *cs_desc = 235 snd_usb_find_clock_source(chip->ctrl_intf, source_id); 236 237 if (!cs_desc) 238 return false; 239 bmControls = cs_desc->bmControls; 240 } 241 242 /* If a clock source can't tell us whether it's valid, we assume it is */ 243 if (!uac_v2v3_control_is_readable(bmControls, 244 UAC2_CS_CONTROL_CLOCK_VALID)) 245 return true; 246 247 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR, 248 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN, 249 UAC2_CS_CONTROL_CLOCK_VALID << 8, 250 snd_usb_ctrl_intf(chip) | (source_id << 8), 251 &data, sizeof(data)); 252 253 if (err < 0) { 254 dev_warn(&dev->dev, 255 "%s(): cannot get clock validity for id %d\n", 256 __func__, source_id); 257 return false; 258 } 259 260 if (data) 261 return true; 262 else 263 return uac_clock_source_is_valid_quirk(chip, fmt, source_id); 264 } 265 266 static int __uac_clock_find_source(struct snd_usb_audio *chip, 267 const struct audioformat *fmt, int entity_id, 268 unsigned long *visited, bool validate) 269 { 270 struct uac_clock_source_descriptor *source; 271 struct uac_clock_selector_descriptor *selector; 272 struct uac_clock_multiplier_descriptor *multiplier; 273 274 entity_id &= 0xff; 275 276 if (test_and_set_bit(entity_id, visited)) { 277 usb_audio_warn(chip, 278 "%s(): recursive clock topology detected, id %d.\n", 279 __func__, entity_id); 280 return -EINVAL; 281 } 282 283 /* first, see if the ID we're looking for is a clock source already */ 284 source = snd_usb_find_clock_source(chip->ctrl_intf, entity_id); 285 if (source) { 286 entity_id = source->bClockID; 287 if (validate && !uac_clock_source_is_valid(chip, fmt, 288 entity_id)) { 289 usb_audio_err(chip, 290 "clock source %d is not valid, cannot use\n", 291 entity_id); 292 return -ENXIO; 293 } 294 return entity_id; 295 } 296 297 selector = snd_usb_find_clock_selector(chip->ctrl_intf, entity_id); 298 if (selector) { 299 int ret, i, cur, err; 300 301 if (selector->bNrInPins == 1) { 302 ret = 1; 303 goto find_source; 304 } 305 306 /* the entity ID we are looking for is a selector. 307 * find out what it currently selects */ 308 ret = uac_clock_selector_get_val(chip, selector->bClockID); 309 if (ret < 0) 310 return ret; 311 312 /* Selector values are one-based */ 313 314 if (ret > selector->bNrInPins || ret < 1) { 315 usb_audio_err(chip, 316 "%s(): selector reported illegal value, id %d, ret %d\n", 317 __func__, selector->bClockID, ret); 318 319 return -EINVAL; 320 } 321 322 find_source: 323 cur = ret; 324 ret = __uac_clock_find_source(chip, fmt, 325 selector->baCSourceID[ret - 1], 326 visited, validate); 327 if (ret > 0) { 328 err = uac_clock_selector_set_val(chip, entity_id, cur); 329 if (err < 0) 330 return err; 331 } 332 333 if (!validate || ret > 0 || !chip->autoclock) 334 return ret; 335 336 /* The current clock source is invalid, try others. */ 337 for (i = 1; i <= selector->bNrInPins; i++) { 338 if (i == cur) 339 continue; 340 341 ret = __uac_clock_find_source(chip, fmt, 342 selector->baCSourceID[i - 1], 343 visited, true); 344 if (ret < 0) 345 continue; 346 347 err = uac_clock_selector_set_val(chip, entity_id, i); 348 if (err < 0) 349 continue; 350 351 usb_audio_info(chip, 352 "found and selected valid clock source %d\n", 353 ret); 354 return ret; 355 } 356 357 return -ENXIO; 358 } 359 360 /* FIXME: multipliers only act as pass-thru element for now */ 361 multiplier = snd_usb_find_clock_multiplier(chip->ctrl_intf, entity_id); 362 if (multiplier) 363 return __uac_clock_find_source(chip, fmt, 364 multiplier->bCSourceID, 365 visited, validate); 366 367 return -EINVAL; 368 } 369 370 static int __uac3_clock_find_source(struct snd_usb_audio *chip, 371 const struct audioformat *fmt, int entity_id, 372 unsigned long *visited, bool validate) 373 { 374 struct uac3_clock_source_descriptor *source; 375 struct uac3_clock_selector_descriptor *selector; 376 struct uac3_clock_multiplier_descriptor *multiplier; 377 378 entity_id &= 0xff; 379 380 if (test_and_set_bit(entity_id, visited)) { 381 usb_audio_warn(chip, 382 "%s(): recursive clock topology detected, id %d.\n", 383 __func__, entity_id); 384 return -EINVAL; 385 } 386 387 /* first, see if the ID we're looking for is a clock source already */ 388 source = snd_usb_find_clock_source_v3(chip->ctrl_intf, entity_id); 389 if (source) { 390 entity_id = source->bClockID; 391 if (validate && !uac_clock_source_is_valid(chip, fmt, 392 entity_id)) { 393 usb_audio_err(chip, 394 "clock source %d is not valid, cannot use\n", 395 entity_id); 396 return -ENXIO; 397 } 398 return entity_id; 399 } 400 401 selector = snd_usb_find_clock_selector_v3(chip->ctrl_intf, entity_id); 402 if (selector) { 403 int ret, i, cur, err; 404 405 /* the entity ID we are looking for is a selector. 406 * find out what it currently selects */ 407 ret = uac_clock_selector_get_val(chip, selector->bClockID); 408 if (ret < 0) 409 return ret; 410 411 /* Selector values are one-based */ 412 413 if (ret > selector->bNrInPins || ret < 1) { 414 usb_audio_err(chip, 415 "%s(): selector reported illegal value, id %d, ret %d\n", 416 __func__, selector->bClockID, ret); 417 418 return -EINVAL; 419 } 420 421 cur = ret; 422 ret = __uac3_clock_find_source(chip, fmt, 423 selector->baCSourceID[ret - 1], 424 visited, validate); 425 if (ret > 0) { 426 err = uac_clock_selector_set_val(chip, entity_id, cur); 427 if (err < 0) 428 return err; 429 } 430 431 if (!validate || ret > 0 || !chip->autoclock) 432 return ret; 433 434 /* The current clock source is invalid, try others. */ 435 for (i = 1; i <= selector->bNrInPins; i++) { 436 int err; 437 438 if (i == cur) 439 continue; 440 441 ret = __uac3_clock_find_source(chip, fmt, 442 selector->baCSourceID[i - 1], 443 visited, true); 444 if (ret < 0) 445 continue; 446 447 err = uac_clock_selector_set_val(chip, entity_id, i); 448 if (err < 0) 449 continue; 450 451 usb_audio_info(chip, 452 "found and selected valid clock source %d\n", 453 ret); 454 return ret; 455 } 456 457 return -ENXIO; 458 } 459 460 /* FIXME: multipliers only act as pass-thru element for now */ 461 multiplier = snd_usb_find_clock_multiplier_v3(chip->ctrl_intf, 462 entity_id); 463 if (multiplier) 464 return __uac3_clock_find_source(chip, fmt, 465 multiplier->bCSourceID, 466 visited, validate); 467 468 return -EINVAL; 469 } 470 471 /* 472 * For all kinds of sample rate settings and other device queries, 473 * the clock source (end-leaf) must be used. However, clock selectors, 474 * clock multipliers and sample rate converters may be specified as 475 * clock source input to terminal. This functions walks the clock path 476 * to its end and tries to find the source. 477 * 478 * The 'visited' bitfield is used internally to detect recursive loops. 479 * 480 * Returns the clock source UnitID (>=0) on success, or an error. 481 */ 482 int snd_usb_clock_find_source(struct snd_usb_audio *chip, 483 const struct audioformat *fmt, bool validate) 484 { 485 DECLARE_BITMAP(visited, 256); 486 memset(visited, 0, sizeof(visited)); 487 488 switch (fmt->protocol) { 489 case UAC_VERSION_2: 490 return __uac_clock_find_source(chip, fmt, fmt->clock, visited, 491 validate); 492 case UAC_VERSION_3: 493 return __uac3_clock_find_source(chip, fmt, fmt->clock, visited, 494 validate); 495 default: 496 return -EINVAL; 497 } 498 } 499 500 static int set_sample_rate_v1(struct snd_usb_audio *chip, 501 const struct audioformat *fmt, int rate) 502 { 503 struct usb_device *dev = chip->dev; 504 unsigned char data[3]; 505 int err, crate; 506 507 /* if endpoint doesn't have sampling rate control, bail out */ 508 if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE)) 509 return 0; 510 511 data[0] = rate; 512 data[1] = rate >> 8; 513 data[2] = rate >> 16; 514 err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR, 515 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT, 516 UAC_EP_CS_ATTR_SAMPLE_RATE << 8, 517 fmt->endpoint, data, sizeof(data)); 518 if (err < 0) { 519 dev_err(&dev->dev, "%d:%d: cannot set freq %d to ep %#x\n", 520 fmt->iface, fmt->altsetting, rate, fmt->endpoint); 521 return err; 522 } 523 524 /* Don't check the sample rate for devices which we know don't 525 * support reading */ 526 if (snd_usb_get_sample_rate_quirk(chip)) 527 return 0; 528 /* the firmware is likely buggy, don't repeat to fail too many times */ 529 if (chip->sample_rate_read_error > 2) 530 return 0; 531 532 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC_GET_CUR, 533 USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_IN, 534 UAC_EP_CS_ATTR_SAMPLE_RATE << 8, 535 fmt->endpoint, data, sizeof(data)); 536 if (err < 0) { 537 dev_err(&dev->dev, "%d:%d: cannot get freq at ep %#x\n", 538 fmt->iface, fmt->altsetting, fmt->endpoint); 539 chip->sample_rate_read_error++; 540 return 0; /* some devices don't support reading */ 541 } 542 543 crate = data[0] | (data[1] << 8) | (data[2] << 16); 544 if (!crate) { 545 dev_info(&dev->dev, "failed to read current rate; disabling the check\n"); 546 chip->sample_rate_read_error = 3; /* three strikes, see above */ 547 return 0; 548 } 549 550 if (crate != rate) { 551 dev_warn(&dev->dev, "current rate %d is different from the runtime rate %d\n", crate, rate); 552 // runtime->rate = crate; 553 } 554 555 return 0; 556 } 557 558 static int get_sample_rate_v2v3(struct snd_usb_audio *chip, int iface, 559 int altsetting, int clock) 560 { 561 struct usb_device *dev = chip->dev; 562 __le32 data; 563 int err; 564 565 err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR, 566 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN, 567 UAC2_CS_CONTROL_SAM_FREQ << 8, 568 snd_usb_ctrl_intf(chip) | (clock << 8), 569 &data, sizeof(data)); 570 if (err < 0) { 571 dev_warn(&dev->dev, "%d:%d: cannot get freq (v2/v3): err %d\n", 572 iface, altsetting, err); 573 return 0; 574 } 575 576 return le32_to_cpu(data); 577 } 578 579 /* 580 * Try to set the given sample rate: 581 * 582 * Return 0 if the clock source is read-only, the actual rate on success, 583 * or a negative error code. 584 * 585 * This function gets called from format.c to validate each sample rate, too. 586 * Hence no message is shown upon error 587 */ 588 int snd_usb_set_sample_rate_v2v3(struct snd_usb_audio *chip, 589 const struct audioformat *fmt, 590 int clock, int rate) 591 { 592 bool writeable; 593 u32 bmControls; 594 __le32 data; 595 int err; 596 597 if (fmt->protocol == UAC_VERSION_3) { 598 struct uac3_clock_source_descriptor *cs_desc; 599 600 cs_desc = snd_usb_find_clock_source_v3(chip->ctrl_intf, clock); 601 bmControls = le32_to_cpu(cs_desc->bmControls); 602 } else { 603 struct uac_clock_source_descriptor *cs_desc; 604 605 cs_desc = snd_usb_find_clock_source(chip->ctrl_intf, clock); 606 bmControls = cs_desc->bmControls; 607 } 608 609 writeable = uac_v2v3_control_is_writeable(bmControls, 610 UAC2_CS_CONTROL_SAM_FREQ); 611 if (!writeable) 612 return 0; 613 614 data = cpu_to_le32(rate); 615 err = snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0), UAC2_CS_CUR, 616 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT, 617 UAC2_CS_CONTROL_SAM_FREQ << 8, 618 snd_usb_ctrl_intf(chip) | (clock << 8), 619 &data, sizeof(data)); 620 if (err < 0) 621 return err; 622 623 return get_sample_rate_v2v3(chip, fmt->iface, fmt->altsetting, clock); 624 } 625 626 static int set_sample_rate_v2v3(struct snd_usb_audio *chip, 627 const struct audioformat *fmt, int rate) 628 { 629 int cur_rate, prev_rate; 630 int clock; 631 632 /* First, try to find a valid clock. This may trigger 633 * automatic clock selection if the current clock is not 634 * valid. 635 */ 636 clock = snd_usb_clock_find_source(chip, fmt, true); 637 if (clock < 0) { 638 /* We did not find a valid clock, but that might be 639 * because the current sample rate does not match an 640 * external clock source. Try again without validation 641 * and we will do another validation after setting the 642 * rate. 643 */ 644 clock = snd_usb_clock_find_source(chip, fmt, false); 645 if (clock < 0) 646 return clock; 647 } 648 649 prev_rate = get_sample_rate_v2v3(chip, fmt->iface, fmt->altsetting, clock); 650 if (prev_rate == rate) 651 goto validation; 652 653 cur_rate = snd_usb_set_sample_rate_v2v3(chip, fmt, clock, rate); 654 if (cur_rate < 0) { 655 usb_audio_err(chip, 656 "%d:%d: cannot set freq %d (v2/v3): err %d\n", 657 fmt->iface, fmt->altsetting, rate, cur_rate); 658 return cur_rate; 659 } 660 661 if (!cur_rate) 662 cur_rate = prev_rate; 663 664 if (cur_rate != rate) { 665 usb_audio_dbg(chip, 666 "%d:%d: freq mismatch: req %d, clock runs @%d\n", 667 fmt->iface, fmt->altsetting, rate, cur_rate); 668 /* continue processing */ 669 } 670 671 validation: 672 /* validate clock after rate change */ 673 if (!uac_clock_source_is_valid(chip, fmt, clock)) 674 return -ENXIO; 675 return 0; 676 } 677 678 int snd_usb_init_sample_rate(struct snd_usb_audio *chip, 679 const struct audioformat *fmt, int rate) 680 { 681 usb_audio_dbg(chip, "%d:%d Set sample rate %d, clock %d\n", 682 fmt->iface, fmt->altsetting, rate, fmt->clock); 683 684 switch (fmt->protocol) { 685 case UAC_VERSION_1: 686 default: 687 return set_sample_rate_v1(chip, fmt, rate); 688 689 case UAC_VERSION_3: 690 if (chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) { 691 if (rate != UAC3_BADD_SAMPLING_RATE) 692 return -ENXIO; 693 else 694 return 0; 695 } 696 fallthrough; 697 case UAC_VERSION_2: 698 return set_sample_rate_v2v3(chip, fmt, rate); 699 } 700 } 701 702