Linux-libre 5.3.12-gnu
[librecmc/linux-libre.git] / Documentation / devicetree / bindings / arm / samsung / pmu.txt
1 SAMSUNG Exynos SoC series PMU Registers
2
3 Properties:
4  - compatible : should contain two values. First value must be one from following list:
5                    - "samsung,exynos3250-pmu" - for Exynos3250 SoC,
6                    - "samsung,exynos4210-pmu" - for Exynos4210 SoC,
7                    - "samsung,exynos4412-pmu" - for Exynos4412 SoC,
8                    - "samsung,exynos5250-pmu" - for Exynos5250 SoC,
9                    - "samsung,exynos5260-pmu" - for Exynos5260 SoC.
10                    - "samsung,exynos5410-pmu" - for Exynos5410 SoC,
11                    - "samsung,exynos5420-pmu" - for Exynos5420 SoC.
12                    - "samsung,exynos5433-pmu" - for Exynos5433 SoC.
13                    - "samsung,exynos7-pmu" - for Exynos7 SoC.
14                 second value must be always "syscon".
15
16  - reg : offset and length of the register set.
17
18  - #clock-cells : must be <1>, since PMU requires once cell as clock specifier.
19                 The single specifier cell is used as index to list of clocks
20                 provided by PMU, which is currently:
21                         0 : SoC clock output (CLKOUT pin)
22
23  - clock-names : list of clock names for particular CLKOUT mux inputs in
24                 following format:
25                         "clkoutN", where N is a decimal number corresponding to
26                         CLKOUT mux control bits value for given input, e.g.
27                                 "clkout0", "clkout7", "clkout15".
28
29  - clocks : list of phandles and specifiers to all input clocks listed in
30                 clock-names property.
31
32 Optional properties:
33
34 Some PMUs are capable of behaving as an interrupt controller (mostly
35 to wake up a suspended PMU). In which case, they can have the
36 following properties:
37
38 - interrupt-controller: indicate that said PMU is an interrupt controller
39
40 - #interrupt-cells: must be identical to the that of the parent interrupt
41   controller.
42
43
44 Optional nodes:
45
46 - nodes defining the restart and poweroff syscon children
47
48
49 Example :
50 pmu_system_controller: system-controller@10040000 {
51         compatible = "samsung,exynos5250-pmu", "syscon";
52         reg = <0x10040000 0x5000>;
53         interrupt-controller;
54         #interrupt-cells = <3>;
55         interrupt-parent = <&gic>;
56         #clock-cells = <1>;
57         clock-names = "clkout0", "clkout1", "clkout2", "clkout3",
58                         "clkout4", "clkout8", "clkout9";
59         clocks = <&clock CLK_OUT_DMC>, <&clock CLK_OUT_TOP>,
60                 <&clock CLK_OUT_LEFTBUS>, <&clock CLK_OUT_RIGHTBUS>,
61                 <&clock CLK_OUT_CPU>, <&clock CLK_XXTI>,
62                 <&clock CLK_XUSBXTI>;
63 };
64
65 Example of clock consumer :
66
67 usb3503: usb3503@8 {
68         /* ... */
69         clock-names = "refclk";
70         clocks = <&pmu_system_controller 0>;
71         /* ... */
72 };