Merge branch 'for-4.19/upstream' into for-linus
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / clock / ti / interface.txt
1 Binding for Texas Instruments interface clock.
2
3 Binding status: Unstable - ABI compatibility may be broken in the future
4
5 This binding uses the common clock binding[1]. This clock is
6 quite much similar to the basic gate-clock [2], however,
7 it supports a number of additional features, including
8 companion clock finding (match corresponding functional gate
9 clock) and hardware autoidle enable / disable.
10
11 [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
12 [2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
13
14 Required properties:
15 - compatible : shall be one of:
16   "ti,omap3-interface-clock" - basic OMAP3 interface clock
17   "ti,omap3-no-wait-interface-clock" - interface clock which has no hardware
18                                        capability for waiting clock to be ready
19   "ti,omap3-hsotgusb-interface-clock" - interface clock with USB specific HW
20                                         handling
21   "ti,omap3-dss-interface-clock" - interface clock with DSS specific HW handling
22   "ti,omap3-ssi-interface-clock" - interface clock with SSI specific HW handling
23   "ti,am35xx-interface-clock" - interface clock with AM35xx specific HW handling
24   "ti,omap2430-interface-clock" - interface clock with OMAP2430 specific HW
25                                   handling
26 - #clock-cells : from common clock binding; shall be set to 0
27 - clocks : link to phandle of parent clock
28 - reg : base address for the control register
29
30 Optional properties:
31 - ti,bit-shift : bit shift for the bit enabling/disabling the clock (default 0)
32
33 Examples:
34         aes1_ick: aes1_ick@48004a14 {
35                 #clock-cells = <0>;
36                 compatible = "ti,omap3-interface-clock";
37                 clocks = <&security_l4_ick2>;
38                 reg = <0x48004a14 0x4>;
39                 ti,bit-shift = <3>;
40         };
41
42         cam_ick: cam_ick@48004f10 {
43                 #clock-cells = <0>;
44                 compatible = "ti,omap3-no-wait-interface-clock";
45                 clocks = <&l4_ick>;
46                 reg = <0x48004f10 0x4>;
47                 ti,bit-shift = <0>;
48         };
49
50         ssi_ick_3430es2: ssi_ick_3430es2@48004a10 {
51                 #clock-cells = <0>;
52                 compatible = "ti,omap3-ssi-interface-clock";
53                 clocks = <&ssi_l4_ick>;
54                 reg = <0x48004a10 0x4>;
55                 ti,bit-shift = <0>;
56         };