treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / devicetree / bindings / thermal / rcar-gen3-thermal.txt
blob12c740b975f786903a73acb3ef1a166f15d55d83
1 * DT bindings for Renesas R-Car Gen3 Thermal Sensor driver
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.
7 Required properties:
8 - compatible            : "renesas,<soctype>-thermal",
9                           Examples with soctypes are:
10                             - "renesas,r8a774a1-thermal" (RZ/G2M)
11                             - "renesas,r8a774b1-thermal" (RZ/G2N)
12                             - "renesas,r8a7795-thermal" (R-Car H3)
13                             - "renesas,r8a7796-thermal" (R-Car M3-W)
14                             - "renesas,r8a77965-thermal" (R-Car M3-N)
15                             - "renesas,r8a77980-thermal" (R-Car V3H)
16 - reg                   : Address ranges of the thermal registers. Each sensor
17                           needs one address range. Sorting must be done in
18                           increasing order according to datasheet, i.e.
19                           TSC1, TSC2, ...
20 - clocks                : Must contain a reference to the functional clock.
21 - #thermal-sensor-cells : must be <1>.
23 Optional properties:
25 - interrupts            : interrupts routed to the TSC (must be 3).
26 - power-domain          : Must contain a reference to the power domain. This
27                           property is mandatory if the thermal sensor instance
28                           is part of a controllable power domain.
30 Example:
32         tsc: thermal@e6198000 {
33                 compatible = "renesas,r8a7795-thermal";
34                 reg = <0 0xe6198000 0 0x100>,
35                       <0 0xe61a0000 0 0x100>,
36                       <0 0xe61a8000 0 0x100>;
37                 interrupts = <GIC_SPI 67 IRQ_TYPE_LEVEL_HIGH>,
38                              <GIC_SPI 68 IRQ_TYPE_LEVEL_HIGH>,
39                              <GIC_SPI 69 IRQ_TYPE_LEVEL_HIGH>;
40                 clocks = <&cpg CPG_MOD 522>;
41                 power-domains = <&sysc R8A7795_PD_ALWAYS_ON>;
42                 #thermal-sensor-cells = <1>;
43         };
45         thermal-zones {
46                 sensor_thermal1: sensor-thermal1 {
47                         polling-delay-passive = <250>;
48                         polling-delay = <1000>;
49                         thermal-sensors = <&tsc 0>;
51                         trips {
52                                 sensor1_crit: sensor1-crit {
53                                         temperature = <90000>;
54                                         hysteresis = <2000>;
55                                         type = "critical";
56                                 };
57                         };
58                 };
59         };