xref: /linux/Documentation/devicetree/bindings/clock/ti/autoidle.txt (revision 1f20a5769446a1acae67ac9e63d07a594829a789)
1Binding for Texas Instruments autoidle clock.
2
3This binding uses the common clock binding[1]. It assumes a register mapped
4clock which can be put to idle automatically by hardware based on the usage
5and a configuration bit setting. Autoidle clock is never an individual
6clock, it is always a derivative of some basic clock like a gate, divider,
7or fixed-factor.
8
9[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
10
11Required properties:
12- reg : offset for the register controlling the autoidle
13- ti,autoidle-shift : bit shift of the autoidle enable bit
14- ti,invert-autoidle-bit : autoidle is enabled by setting the bit to 0
15
16Examples:
17	dpll_core_m4_ck: dpll_core_m4_ck {
18		#clock-cells = <0>;
19		compatible = "ti,divider-clock";
20		clocks = <&dpll_core_x2_ck>;
21		ti,max-div = <31>;
22		ti,autoidle-shift = <8>;
23		reg = <0x2d38>;
24		ti,index-starts-at-one;
25		ti,invert-autoidle-bit;
26	};
27
28	dpll_usb_clkdcoldo_ck: dpll_usb_clkdcoldo_ck {
29		#clock-cells = <0>;
30		compatible = "ti,fixed-factor-clock";
31		clocks = <&dpll_usb_ck>;
32		ti,clock-div = <1>;
33		ti,autoidle-shift = <8>;
34		reg = <0x01b4>;
35		ti,clock-mult = <1>;
36		ti,invert-autoidle-bit;
37	};
38