GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / clock / rockchip,rk3368-cru.txt
1 * Rockchip RK3368 Clock and Reset Unit
2
3 The RK3368 clock controller generates and supplies clock to various
4 controllers within the SoC and also implements a reset controller for SoC
5 peripherals.
6
7 Required Properties:
8
9 - compatible: should be "rockchip,rk3368-cru"
10 - reg: physical base address of the controller and length of memory mapped
11   region.
12 - #clock-cells: should be 1.
13 - #reset-cells: should be 1.
14
15 Optional Properties:
16
17 - rockchip,grf: phandle to the syscon managing the "general register files"
18   If missing, pll rates are not changeable, due to the missing pll lock status.
19
20 Each clock is assigned an identifier and client nodes can use this identifier
21 to specify the clock which they consume. All available clocks are defined as
22 preprocessor macros in the dt-bindings/clock/rk3368-cru.h headers and can be
23 used in device tree sources. Similar macros exist for the reset sources in
24 these files.
25
26 External clocks:
27
28 There are several clocks that are generated outside the SoC. It is expected
29 that they are defined using standard clock bindings with following
30 clock-output-names:
31  - "xin24m" - crystal input - required,
32  - "xin32k" - rtc clock - optional,
33  - "ext_i2s" - external I2S clock - optional,
34  - "ext_gmac" - external GMAC clock - optional
35  - "ext_hsadc" - external HSADC clock - optional,
36  - "ext_isp" - external ISP clock - optional,
37  - "ext_jtag" - external JTAG clock - optional
38  - "ext_vip" - external VIP clock - optional,
39  - "usbotg_out" - output clock of the pll in the otg phy
40
41 Example: Clock controller node:
42
43         cru: clock-controller@ff760000 {
44                 compatible = "rockchip,rk3368-cru";
45                 reg = <0x0 0xff760000 0x0 0x1000>;
46                 rockchip,grf = <&grf>;
47                 #clock-cells = <1>;
48                 #reset-cells = <1>;
49         };
50
51 Example: UART controller node that consumes the clock generated by the clock
52   controller:
53
54         uart0: serial@10124000 {
55                 compatible = "snps,dw-apb-uart";
56                 reg = <0x10124000 0x400>;
57                 interrupts = <GIC_SPI 34 IRQ_TYPE_LEVEL_HIGH>;
58                 reg-shift = <2>;
59                 reg-io-width = <1>;
60                 clocks = <&cru SCLK_UART0>;
61         };