1 // SPDX-License-Identifier: GPL-2.0-or-later
3  *   Clock domain and sample rate management functions
11 #include <linux/usb/audio-v2.h>
12 #include <linux/usb/audio-v3.h>
21 #include "clock.h"
42 	 ((p)->v3.bLength >= sizeof((p)->v3)) :	\
43 	 ((p)->v2.bLength >= sizeof((p)->v2)))
46 	((proto) == UAC_VERSION_3 ? (p)->v3.field : (p)->v2.field)
54 	while ((cs = snd_usb_find_csint_desc(iface->extra, iface->extralen,  in find_uac_clock_desc()
84 		return cs->v3.bLength >= sizeof(cs->v3) + cs->v3.bNrInPins +  in validate_clock_selector()
87 		return cs->v2.bLength >= sizeof(cs->v2) + cs->v2.bNrInPins +  in validate_clock_selector()
105 		snd_usb_find_ctrl_interface(chip, fmt->iface); \
107 				   fmt->protocol == UAC_VERSION_3 ? (type3) : (type2), \
108 				   fmt->protocol);				\
129 	ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0),  in uac_clock_selector_get_val()
149 	ret = snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0),  in uac_clock_selector_set_val()
162 		return -EINVAL;  in uac_clock_selector_set_val()
173 		return -EINVAL;  in uac_clock_selector_set_val()
186 	struct usb_device *dev = chip->dev;  in uac_clock_source_is_valid_quirk()
190 	ctrl_intf = snd_usb_find_ctrl_interface(chip, fmt->iface);  in uac_clock_source_is_valid_quirk()
195 	if (fmt->protocol == UAC_VERSION_2) {  in uac_clock_source_is_valid_quirk()
197 		 * Assume the clock is valid if clock source supports only one  in uac_clock_source_is_valid_quirk()
199 		 * (there is no clock selector) and clock type is internal.  in uac_clock_source_is_valid_quirk()
201 		 * reports that clock is invalid.  in uac_clock_source_is_valid_quirk()
203 		if (fmt->nr_rates == 1 &&  in uac_clock_source_is_valid_quirk()
204 		    (fmt->clock & 0xff) == cs_desc->v2.bClockID &&  in uac_clock_source_is_valid_quirk()
205 		    (cs_desc->v2.bmAttributes & 0x3) !=  in uac_clock_source_is_valid_quirk()
214 	 * clock source. During this period the clock validity request  in uac_clock_source_is_valid_quirk()
218 	 *   - MicroBook IIc          → 0x0004  in uac_clock_source_is_valid_quirk()
219 	 *   - 1248, 624, 8A, UltraLite AVB, 8M, 16A, ... → 0x0005  in uac_clock_source_is_valid_quirk()
221 	if (chip->usb_id == USB_ID(0x07fd, 0x0004) ||  /* MicroBook IIc */  in uac_clock_source_is_valid_quirk()
222 	    chip->usb_id == USB_ID(0x07fd, 0x0005)) {  /* 1248 / 624 / 8A / UltraLite AVB / ... */  in uac_clock_source_is_valid_quirk()
236 				dev_warn(&dev->dev,  in uac_clock_source_is_valid_quirk()
237 					 "%s(): cannot get clock validity for id %d\n",  in uac_clock_source_is_valid_quirk()
256 	struct usb_device *dev = chip->dev;  in uac_clock_source_is_valid()
261 	ctrl_intf = snd_usb_find_ctrl_interface(chip, fmt->iface);  in uac_clock_source_is_valid()
266 	if (fmt->protocol == UAC_VERSION_3)  in uac_clock_source_is_valid()
267 		bmControls = le32_to_cpu(cs_desc->v3.bmControls);  in uac_clock_source_is_valid()
269 		bmControls = cs_desc->v2.bmControls;  in uac_clock_source_is_valid()
271 	/* If a clock source can't tell us whether it's valid, we assume it is */  in uac_clock_source_is_valid()
283 		dev_warn(&dev->dev,  in uac_clock_source_is_valid()
284 			 "%s(): cannot get clock validity for id %d\n",  in uac_clock_source_is_valid()
299 	union uac23_clock_source_desc *source;  in __uac_clock_find_source()  local
304 	int proto = fmt->protocol;  in __uac_clock_find_source()
312 			 "%s(): recursive clock topology detected, id %d.\n",  in __uac_clock_find_source()
314 		return -EINVAL;  in __uac_clock_find_source()
317 	/* first, see if the ID we're looking at is a clock source already */  in __uac_clock_find_source()
318 	source = snd_usb_find_clock_source(chip, entity_id, fmt);  in __uac_clock_find_source()
319 	if (source) {  in __uac_clock_find_source()
320 		entity_id = GET_VAL(source, proto, bClockID);  in __uac_clock_find_source()
324 				"clock source %d is not valid, cannot use\n",  in __uac_clock_find_source()
326 			return -ENXIO;  in __uac_clock_find_source()
339 			bmControls = le32_to_cpu(*(__le32 *)(&selector->v3.baCSourceID[0] + pins));  in __uac_clock_find_source()
341 			bmControls = *(__u8 *)(&selector->v2.baCSourceID[0] + pins);  in __uac_clock_find_source()
356 				"%s(): clock selector control is not readable, id %d\n",  in __uac_clock_find_source()
361 		ret = uac_clock_selector_get_val(chip, clock_id, fmt->iface);  in __uac_clock_find_source()
363 			if (!chip->autoclock)  in __uac_clock_find_source()
368 		/* Selector values are one-based */  in __uac_clock_find_source()
375 			if (!chip->autoclock)  in __uac_clock_find_source()
376 				return -EINVAL;  in __uac_clock_find_source()
383 					      sources[ret - 1],  in __uac_clock_find_source()
386 			/* Skip setting clock selector again for some devices */  in __uac_clock_find_source()
387 			if (chip->quirk_flags & QUIRK_FLAG_SKIP_CLOCK_SELECTOR ||  in __uac_clock_find_source()
390 			err = uac_clock_selector_set_val(chip, entity_id, cur, fmt->iface);  in __uac_clock_find_source()
403 		if (!validate || ret > 0 || !chip->autoclock)  in __uac_clock_find_source()
408 			return -ENXIO;  in __uac_clock_find_source()
410 		/* The current clock source is invalid, try others. */  in __uac_clock_find_source()
416 						      sources[i - 1],  in __uac_clock_find_source()
421 			err = uac_clock_selector_set_val(chip, entity_id, i, fmt->iface);  in __uac_clock_find_source()
426 				 "found and selected valid clock source %d\n",  in __uac_clock_find_source()
431 		return -ENXIO;  in __uac_clock_find_source()
434 	/* FIXME: multipliers only act as pass-thru element for now */  in __uac_clock_find_source()
441 	return -EINVAL;  in __uac_clock_find_source()
446  * the clock source (end-leaf) must be used. However, clock selectors,
447  * clock multipliers and sample rate converters may be specified as
448  * clock source input to terminal. This functions walks the clock path
449  * to its end and tries to find the source.
453  * Returns the clock source UnitID (>=0) on success, or an error.
461 	switch (fmt->protocol) {  in snd_usb_clock_find_source()
464 		return __uac_clock_find_source(chip, fmt, fmt->clock, visited,  in snd_usb_clock_find_source()
467 		return -EINVAL;  in snd_usb_clock_find_source()
474 	struct usb_device *dev = chip->dev;  in set_sample_rate_v1()
479 	if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE))  in set_sample_rate_v1()
488 			      fmt->endpoint, data, sizeof(data));  in set_sample_rate_v1()
490 		dev_err(&dev->dev, "%d:%d: cannot set freq %d to ep %#x\n",  in set_sample_rate_v1()
491 			fmt->iface, fmt->altsetting, rate, fmt->endpoint);  in set_sample_rate_v1()
497 	if (chip->quirk_flags & QUIRK_FLAG_GET_SAMPLE_RATE)  in set_sample_rate_v1()
500 	if (chip->sample_rate_read_error > 2)  in set_sample_rate_v1()
506 			      fmt->endpoint, data, sizeof(data));  in set_sample_rate_v1()
508 		dev_err(&dev->dev, "%d:%d: cannot get freq at ep %#x\n",  in set_sample_rate_v1()
509 			fmt->iface, fmt->altsetting, fmt->endpoint);  in set_sample_rate_v1()
510 		chip->sample_rate_read_error++;  in set_sample_rate_v1()
516 		dev_info(&dev->dev, "failed to read current rate; disabling the check\n");  in set_sample_rate_v1()
517 		chip->sample_rate_read_error = 3; /* three strikes, see above */  in set_sample_rate_v1()
522 		dev_warn(&dev->dev, "current rate %d is different from the runtime rate %d\n", crate, rate);  in set_sample_rate_v1()
523 		// runtime->rate = crate;  in set_sample_rate_v1()
530 			      int altsetting, int clock)  in get_sample_rate_v2v3()  argument
532 	struct usb_device *dev = chip->dev;  in get_sample_rate_v2v3()
541 			      snd_usb_ctrl_intf(ctrl_intf) | (clock << 8),  in get_sample_rate_v2v3()
544 		dev_warn(&dev->dev, "%d:%d: cannot get freq (v2/v3): err %d\n",  in get_sample_rate_v2v3()
555  * Return 0 if the clock source is read-only, the actual rate on success,
563 				 int clock, int rate)  in snd_usb_set_sample_rate_v2v3()  argument
572 	ctrl_intf = snd_usb_find_ctrl_interface(chip, fmt->iface);  in snd_usb_set_sample_rate_v2v3()
573 	cs_desc = snd_usb_find_clock_source(chip, clock, fmt);  in snd_usb_set_sample_rate_v2v3()
578 	if (fmt->protocol == UAC_VERSION_3)  in snd_usb_set_sample_rate_v2v3()
579 		bmControls = le32_to_cpu(cs_desc->v3.bmControls);  in snd_usb_set_sample_rate_v2v3()
581 		bmControls = cs_desc->v2.bmControls;  in snd_usb_set_sample_rate_v2v3()
589 	err = snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0), UAC2_CS_CUR,  in snd_usb_set_sample_rate_v2v3()
592 			      snd_usb_ctrl_intf(ctrl_intf) | (clock << 8),  in snd_usb_set_sample_rate_v2v3()
597 	return get_sample_rate_v2v3(chip, fmt->iface, fmt->altsetting, clock);  in snd_usb_set_sample_rate_v2v3()
604 	int clock;  in set_sample_rate_v2v3()  local
606 	/* First, try to find a valid clock. This may trigger  in set_sample_rate_v2v3()
607 	 * automatic clock selection if the current clock is not  in set_sample_rate_v2v3()
610 	clock = snd_usb_clock_find_source(chip, fmt, true);  in set_sample_rate_v2v3()
611 	if (clock < 0) {  in set_sample_rate_v2v3()
612 		/* We did not find a valid clock, but that might be  in set_sample_rate_v2v3()
614 		 * external clock source. Try again without validation  in set_sample_rate_v2v3()
618 		clock = snd_usb_clock_find_source(chip, fmt, false);  in set_sample_rate_v2v3()
621 		if (chip->quirk_flags & QUIRK_FLAG_IGNORE_CLOCK_SOURCE)  in set_sample_rate_v2v3()
624 		if (clock < 0)  in set_sample_rate_v2v3()
625 			return clock;  in set_sample_rate_v2v3()
628 	prev_rate = get_sample_rate_v2v3(chip, fmt->iface, fmt->altsetting, clock);  in set_sample_rate_v2v3()
632 	cur_rate = snd_usb_set_sample_rate_v2v3(chip, fmt, clock, rate);  in set_sample_rate_v2v3()
636 			      fmt->iface, fmt->altsetting, rate, cur_rate);  in set_sample_rate_v2v3()
645 			      "%d:%d: freq mismatch: req %d, clock runs @%d\n",  in set_sample_rate_v2v3()
646 			      fmt->iface, fmt->altsetting, rate, cur_rate);  in set_sample_rate_v2v3()
650 	/* FIXME - TEAC devices require the immediate interface setup */  in set_sample_rate_v2v3()
651 	if (USB_ID_VENDOR(chip->usb_id) == 0x0644) {  in set_sample_rate_v2v3()
655 			usb_set_interface(chip->dev, fmt->iface, fmt->altsetting);  in set_sample_rate_v2v3()
656 			if (chip->quirk_flags & QUIRK_FLAG_IFACE_DELAY)  in set_sample_rate_v2v3()
662 	/* validate clock after rate change */  in set_sample_rate_v2v3()
663 	if (!uac_clock_source_is_valid(chip, fmt, clock))  in set_sample_rate_v2v3()
664 		return -ENXIO;  in set_sample_rate_v2v3()
671 	usb_audio_dbg(chip, "%d:%d Set sample rate %d, clock %d\n",  in snd_usb_init_sample_rate()
672 		      fmt->iface, fmt->altsetting, rate, fmt->clock);  in snd_usb_init_sample_rate()
674 	switch (fmt->protocol) {  in snd_usb_init_sample_rate()
680 		if (chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {  in snd_usb_init_sample_rate()
682 				return -ENXIO;  in snd_usb_init_sample_rate()