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