Merge branch 'pm-cpufreq'
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / thermal / rcar-gen3-thermal.txt
1 * DT bindings for Renesas R-Car Gen3 Thermal Sensor driver
2
3 On R-Car Gen3 SoCs, the thermal sensor controllers (TSC) control the thermal
4 sensors (THS) which are the analog circuits for measuring temperature (Tj)
5 inside the LSI.
6
7 Required properties:
8 - compatible            : "renesas,<soctype>-thermal",
9                           Examples with soctypes are:
10                             - "renesas,r8a7795-thermal" (R-Car H3)
11                             - "renesas,r8a7796-thermal" (R-Car M3-W)
12 - reg                   : Address ranges of the thermal registers. Each sensor
13                           needs one address range. Sorting must be done in
14                           increasing order according to datasheet, i.e.
15                           TSC1, TSC2, ...
16 - clocks                : Must contain a reference to the functional clock.
17 - #thermal-sensor-cells : must be <1>.
18
19 Optional properties:
20
21 - interrupts           : interrupts routed to the TSC (3 for H3 and M3-W)
22 - power-domain          : Must contain a reference to the power domain. This
23                           property is mandatory if the thermal sensor instance
24                           is part of a controllable power domain.
25
26 Example:
27
28         tsc: thermal@e6198000 {
29                 compatible = "renesas,r8a7795-thermal";
30                 reg = <0 0xe6198000 0 0x68>,
31                       <0 0xe61a0000 0 0x5c>,
32                       <0 0xe61a8000 0 0x5c>;
33                 interrupts = <GIC_SPI 67 IRQ_TYPE_LEVEL_HIGH>,
34                              <GIC_SPI 68 IRQ_TYPE_LEVEL_HIGH>,
35                              <GIC_SPI 69 IRQ_TYPE_LEVEL_HIGH>;
36                 clocks = <&cpg CPG_MOD 522>;
37                 power-domains = <&sysc R8A7795_PD_ALWAYS_ON>;
38                 #thermal-sensor-cells = <1>;
39                 status = "okay";
40         };
41
42         thermal-zones {
43                 sensor_thermal1: sensor-thermal1 {
44                         polling-delay-passive = <250>;
45                         polling-delay = <1000>;
46                         thermal-sensors = <&tsc 0>;
47
48                         trips {
49                                 sensor1_crit: sensor1-crit {
50                                         temperature = <90000>;
51                                         hysteresis = <2000>;
52                                         type = "critical";
53                                 };
54                         };
55                 };
56         };