Merge tag 'linux-kselftest-4.18-rc1-2' of git://git.kernel.org/pub/scm/linux/kernel...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / thermal / exynos-thermal.txt
1 * Exynos Thermal Management Unit (TMU)
2
3 ** Required properties:
4
5 - compatible : One of the following:
6                "samsung,exynos3250-tmu"
7                "samsung,exynos4412-tmu"
8                "samsung,exynos4210-tmu"
9                "samsung,exynos5250-tmu"
10                "samsung,exynos5260-tmu"
11                "samsung,exynos5420-tmu" for TMU channel 0, 1 on Exynos5420
12                "samsung,exynos5420-tmu-ext-triminfo" for TMU channels 2, 3 and 4
13                         Exynos5420 (Must pass triminfo base and triminfo clock)
14                "samsung,exynos5433-tmu"
15                "samsung,exynos7-tmu"
16 - interrupt-parent : The phandle for the interrupt controller
17 - reg : Address range of the thermal registers. For soc's which has multiple
18         instances of TMU and some registers are shared across all TMU's like
19         interrupt related then 2 set of register has to supplied. First set
20         belongs to register set of TMU instance and second set belongs to
21         registers shared with the TMU instance.
22
23   NOTE: On Exynos5420, the TRIMINFO register is misplaced for TMU
24         channels 2, 3 and 4
25         Use "samsung,exynos5420-tmu-ext-triminfo" in cases, there is a misplaced
26         register, also provide clock to access that base.
27
28         TRIMINFO at 0x1006c000 contains data for TMU channel 3
29         TRIMINFO at 0x100a0000 contains data for TMU channel 4
30         TRIMINFO at 0x10068000 contains data for TMU channel 2
31
32 - interrupts : Should contain interrupt for thermal system
33 - clocks : The main clocks for TMU device
34         -- 1. operational clock for TMU channel
35         -- 2. optional clock to access the shared registers of TMU channel
36         -- 3. optional special clock for functional operation
37 - clock-names : Thermal system clock name
38         -- "tmu_apbif" operational clock for current TMU channel
39         -- "tmu_triminfo_apbif" clock to access the shared triminfo register
40                 for current TMU channel
41         -- "tmu_sclk" clock for functional operation of the current TMU
42                 channel
43
44 The Exynos TMU supports generating interrupts when reaching given
45 temperature thresholds. Number of supported thermal trip points depends
46 on the SoC (only first trip points defined in DT will be configured):
47  - most of SoC: 4
48  - samsung,exynos5433-tmu: 8
49  - samsung,exynos7-tmu: 8
50
51 ** Optional properties:
52
53 - vtmu-supply: This entry is optional and provides the regulator node supplying
54                 voltage to TMU. If needed this entry can be placed inside
55                 board/platform specific dts file.
56
57 Example 1):
58
59         tmu@100c0000 {
60                 compatible = "samsung,exynos4412-tmu";
61                 interrupt-parent = <&combiner>;
62                 reg = <0x100C0000 0x100>;
63                 interrupts = <2 4>;
64                 clocks = <&clock 383>;
65                 clock-names = "tmu_apbif";
66                 vtmu-supply = <&tmu_regulator_node>;
67                 #thermal-sensor-cells = <0>;
68         };
69
70 Example 2): (In case of Exynos5420 "with misplaced TRIMINFO register")
71         tmu_cpu2: tmu@10068000 {
72                 compatible = "samsung,exynos5420-tmu-ext-triminfo";
73                 reg = <0x10068000 0x100>, <0x1006c000 0x4>;
74                 interrupts = <0 184 0>;
75                 clocks = <&clock 318>, <&clock 318>;
76                 clock-names = "tmu_apbif", "tmu_triminfo_apbif";
77                 #thermal-sensor-cells = <0>;
78         };
79
80         tmu_cpu3: tmu@1006c000 {
81                 compatible = "samsung,exynos5420-tmu-ext-triminfo";
82                 reg = <0x1006c000 0x100>, <0x100a0000 0x4>;
83                 interrupts = <0 185 0>;
84                 clocks = <&clock 318>, <&clock 319>;
85                 clock-names = "tmu_apbif", "tmu_triminfo_apbif";
86                 #thermal-sensor-cells = <0>;
87         };
88
89         tmu_gpu: tmu@100a0000 {
90                 compatible = "samsung,exynos5420-tmu-ext-triminfo";
91                 reg = <0x100a0000 0x100>, <0x10068000 0x4>;
92                 interrupts = <0 215 0>;
93                 clocks = <&clock 319>, <&clock 318>;
94                 clock-names = "tmu_apbif", "tmu_triminfo_apbif";
95                 #thermal-sensor-cells = <0>;
96         };
97
98 Note: For multi-instance tmu each instance should have an alias correctly
99 numbered in "aliases" node.
100
101 Example:
102
103 aliases {
104         tmuctrl0 = &tmuctrl_0;
105         tmuctrl1 = &tmuctrl_1;
106         tmuctrl2 = &tmuctrl_2;
107 };