xref: /freebsd/sys/contrib/device-tree/Bindings/clock/ti/fixed-factor-clock.txt (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
1Binding for TI fixed factor rate clock sources.
2
3Binding status: Unstable - ABI compatibility may be broken in the future
4
5This binding uses the common clock binding[1], and also uses the autoidle
6support from TI autoidle clock [2].
7
8[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
9[2] Documentation/devicetree/bindings/clock/ti/autoidle.txt
10
11Required properties:
12- compatible : shall be "ti,fixed-factor-clock".
13- #clock-cells : from common clock binding; shall be set to 0.
14- ti,clock-div: fixed divider.
15- ti,clock-mult: fixed multiplier.
16- clocks: parent clock.
17
18Optional properties:
19- clock-output-names : from common clock binding.
20- ti,autoidle-shift: bit shift of the autoidle enable bit for the clock,
21  see [2]
22- reg: offset for the autoidle register of this clock, see [2]
23- ti,invert-autoidle-bit: autoidle is enabled by setting the bit to 0, see [2]
24- ti,set-rate-parent: clk_set_rate is propagated to parent
25
26Example:
27	clock {
28		compatible = "ti,fixed-factor-clock";
29		clocks = <&parentclk>;
30		#clock-cells = <0>;
31		ti,clock-div = <2>;
32		ti,clock-mult = <1>;
33	};
34
35	dpll_usb_clkdcoldo_ck: dpll_usb_clkdcoldo_ck {
36		#clock-cells = <0>;
37		compatible = "ti,fixed-factor-clock";
38		clocks = <&dpll_usb_ck>;
39		ti,clock-div = <1>;
40		ti,autoidle-shift = <8>;
41		reg = <0x01b4>;
42		ti,clock-mult = <1>;
43		ti,invert-autoidle-bit;
44	};
45