xref: /linux/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732) 
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- ti,autoidle-shift: bit shift of the autoidle enable bit for the clock,
20  see [2]
21- reg: offset for the autoidle register of this clock, see [2]
22- ti,invert-autoidle-bit: autoidle is enabled by setting the bit to 0, see [2]
23- ti,set-rate-parent: clk_set_rate is propagated to parent
24
25Example:
26	clock {
27		compatible = "ti,fixed-factor-clock";
28		clocks = <&parentclk>;
29		#clock-cells = <0>;
30		ti,clock-div = <2>;
31		ti,clock-mult = <1>;
32	};
33
34	dpll_usb_clkdcoldo_ck: dpll_usb_clkdcoldo_ck {
35		#clock-cells = <0>;
36		compatible = "ti,fixed-factor-clock";
37		clocks = <&dpll_usb_ck>;
38		ti,clock-div = <1>;
39		ti,autoidle-shift = <8>;
40		reg = <0x01b4>;
41		ti,clock-mult = <1>;
42		ti,invert-autoidle-bit;
43	};
44