xref: /linux/Documentation/devicetree/bindings/thermal/ti,j72xx-thermal.yaml (revision e04e2b760ddbe3d7b283a05898c3a029085cd8cd) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/thermal/ti,j72xx-thermal.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Texas Instruments J72XX VTM (DTS)
8
9maintainers:
10  - Keerthy <j-keerthy@ti.com>
11
12description: |
13  The TI K3 family of SoCs typically have a Voltage & Thermal
14  Management (VTM) device to control up to 8 temperature diode
15  sensors to measure silicon junction temperatures from different
16  hotspots of the chip as well as provide temperature, interrupt
17  and alerting information.
18
19  The following polynomial equation can then be used to convert
20  value returned by this device into a temperature in Celsius
21
22  Temp(C) = (-9.2627e-12) * x^4 + (6.0373e-08) * x^3 + \
23            (-1.7058e-04) * x^2 + (3.2512e-01) * x   + (-4.9003e+01)
24
25$ref: thermal-sensor.yaml#
26
27properties:
28  compatible:
29    enum:
30      - ti,j721e-vtm
31      - ti,j7200-vtm
32
33  reg:
34    items:
35      - description: VTM cfg1 register space
36      - description: VTM cfg2 register space
37      - description: |
38          A software trimming method must be applied to some Jacinto
39          devices to function properly. This eFuse region provides
40          the information needed for these SoCs to report
41          temperatures accurately.
42    minItems: 2
43
44  power-domains:
45    maxItems: 1
46
47  "#thermal-sensor-cells":
48    const: 1
49
50allOf:
51  - if:
52      properties:
53        compatible:
54          contains:
55            const: ti,j721e-vtm
56    then:
57      properties:
58        reg:
59          minItems: 3
60    else:
61      properties:
62        reg:
63          maxItems: 2
64
65required:
66  - compatible
67  - reg
68  - power-domains
69
70unevaluatedProperties: false
71
72examples:
73  - |
74    #include <dt-bindings/soc/ti,sci_pm_domain.h>
75    wkup_vtm0: thermal-sensor@42040000 {
76        compatible = "ti,j721e-vtm";
77        reg = <0x42040000 0x350>,
78              <0x42050000 0x350>,
79              <0x43000300 0x10>;
80        power-domains = <&k3_pds 154 TI_SCI_PD_EXCLUSIVE>;
81        #thermal-sensor-cells = <1>;
82    };
83
84    mpu_thermal: mpu-thermal {
85        polling-delay-passive = <250>; /* milliseconds */
86        polling-delay = <500>; /* milliseconds */
87        thermal-sensors = <&wkup_vtm0 0>;
88
89        trips {
90            mpu_crit: mpu-crit {
91                temperature = <125000>; /* milliCelsius */
92                hysteresis = <2000>; /* milliCelsius */
93                type = "critical";
94            };
95        };
96    };
97...
98