Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[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,exynos5440-tmu"
16                "samsung,exynos7-tmu"
17 - interrupt-parent : The phandle for the interrupt controller
18 - reg : Address range of the thermal registers. For soc's which has multiple
19         instances of TMU and some registers are shared across all TMU's like
20         interrupt related then 2 set of register has to supplied. First set
21         belongs to register set of TMU instance and second set belongs to
22         registers shared with the TMU instance.
23
24   NOTE: On Exynos5420, the TRIMINFO register is misplaced for TMU
25         channels 2, 3 and 4
26         Use "samsung,exynos5420-tmu-ext-triminfo" in cases, there is a misplaced
27         register, also provide clock to access that base.
28
29         TRIMINFO at 0x1006c000 contains data for TMU channel 3
30         TRIMINFO at 0x100a0000 contains data for TMU channel 4
31         TRIMINFO at 0x10068000 contains data for TMU channel 2
32
33 - interrupts : Should contain interrupt for thermal system
34 - clocks : The main clocks for TMU device
35         -- 1. operational clock for TMU channel
36         -- 2. optional clock to access the shared registers of TMU channel
37         -- 3. optional special clock for functional operation
38 - clock-names : Thermal system clock name
39         -- "tmu_apbif" operational clock for current TMU channel
40         -- "tmu_triminfo_apbif" clock to access the shared triminfo register
41                 for current TMU channel
42         -- "tmu_sclk" clock for functional operation of the current TMU
43                 channel
44
45 The Exynos TMU supports generating interrupts when reaching given
46 temperature thresholds. Number of supported thermal trip points depends
47 on the SoC (only first trip points defined in DT will be configured):
48  - most of SoC: 4
49  - samsung,exynos5433-tmu: 8
50  - samsung,exynos7-tmu: 8
51
52 Following properties are mandatory (depending on SoC):
53 - samsung,tmu_gain: Gain value for internal TMU operation.
54 - samsung,tmu_reference_voltage: Value of TMU IP block's reference voltage
55 - samsung,tmu_noise_cancel_mode: Mode for noise cancellation
56 - samsung,tmu_efuse_value: Default level of temperature - it is needed when
57                            in factory fusing produced wrong value
58 - samsung,tmu_min_efuse_value: Minimum temperature fused value
59 - samsung,tmu_max_efuse_value: Maximum temperature fused value
60 - samsung,tmu_first_point_trim: First point trimming value
61 - samsung,tmu_second_point_trim: Second point trimming value
62 - samsung,tmu_default_temp_offset: Default temperature offset
63 - samsung,tmu_cal_type: Callibration type
64
65 ** Optional properties:
66
67 - vtmu-supply: This entry is optional and provides the regulator node supplying
68                 voltage to TMU. If needed this entry can be placed inside
69                 board/platform specific dts file.
70
71 Example 1):
72
73         tmu@100C0000 {
74                 compatible = "samsung,exynos4412-tmu";
75                 interrupt-parent = <&combiner>;
76                 reg = <0x100C0000 0x100>;
77                 interrupts = <2 4>;
78                 clocks = <&clock 383>;
79                 clock-names = "tmu_apbif";
80                 vtmu-supply = <&tmu_regulator_node>;
81                 #include "exynos4412-tmu-sensor-conf.dtsi"
82         };
83
84 Example 2):
85
86         tmuctrl_0: tmuctrl@160118 {
87                 compatible = "samsung,exynos5440-tmu";
88                 reg = <0x160118 0x230>, <0x160368 0x10>;
89                 interrupts = <0 58 0>;
90                 clocks = <&clock 21>;
91                 clock-names = "tmu_apbif";
92                 #include "exynos5440-tmu-sensor-conf.dtsi"
93         };
94
95 Example 3): (In case of Exynos5420 "with misplaced TRIMINFO register")
96         tmu_cpu2: tmu@10068000 {
97                 compatible = "samsung,exynos5420-tmu-ext-triminfo";
98                 reg = <0x10068000 0x100>, <0x1006c000 0x4>;
99                 interrupts = <0 184 0>;
100                 clocks = <&clock 318>, <&clock 318>;
101                 clock-names = "tmu_apbif", "tmu_triminfo_apbif";
102                 #include "exynos4412-tmu-sensor-conf.dtsi"
103         };
104
105         tmu_cpu3: tmu@1006c000 {
106                 compatible = "samsung,exynos5420-tmu-ext-triminfo";
107                 reg = <0x1006c000 0x100>, <0x100a0000 0x4>;
108                 interrupts = <0 185 0>;
109                 clocks = <&clock 318>, <&clock 319>;
110                 clock-names = "tmu_apbif", "tmu_triminfo_apbif";
111                 #include "exynos4412-tmu-sensor-conf.dtsi"
112         };
113
114         tmu_gpu: tmu@100a0000 {
115                 compatible = "samsung,exynos5420-tmu-ext-triminfo";
116                 reg = <0x100a0000 0x100>, <0x10068000 0x4>;
117                 interrupts = <0 215 0>;
118                 clocks = <&clock 319>, <&clock 318>;
119                 clock-names = "tmu_apbif", "tmu_triminfo_apbif";
120                 #include "exynos4412-tmu-sensor-conf.dtsi"
121         };
122
123 Note: For multi-instance tmu each instance should have an alias correctly
124 numbered in "aliases" node.
125
126 Example:
127
128 aliases {
129         tmuctrl0 = &tmuctrl_0;
130         tmuctrl1 = &tmuctrl_1;
131         tmuctrl2 = &tmuctrl_2;
132 };