Merge tag 'fuse-update-4.20' of git://git.kernel.org/pub/scm/linux/kernel/git/mszered...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / thermal / stm32-thermal.txt
1 Binding for Thermal Sensor for STMicroelectronics STM32 series of SoCs.
2
3 On STM32 SoCs, the Digital Temperature Sensor (DTS) is in charge of managing an
4 analog block which delivers a frequency depending on the internal SoC's
5 temperature. By using a reference frequency, DTS is able to provide a sample
6 number which can be translated into a temperature by the user.
7
8 DTS provides interrupt notification mechanism by threshold. This mechanism
9 offers two temperature trip points: passive and critical. The first is intended
10 for passive cooling notification while the second is used for over-temperature
11 reset.
12
13 Required parameters:
14 -------------------
15
16 compatible:     Should be "st,stm32-thermal"
17 reg:            This should be the physical base address and length of the
18                 sensor's registers.
19 clocks:         Phandle of the clock used by the thermal sensor.
20                   See: Documentation/devicetree/bindings/clock/clock-bindings.txt
21 clock-names:    Should be "pclk" for register access clock and reference clock.
22                   See: Documentation/devicetree/bindings/resource-names.txt
23 #thermal-sensor-cells: Should be 0. See ./thermal.txt for a description.
24 interrupts:     Standard way to define interrupt number.
25
26 Example:
27
28         thermal-zones {
29                 cpu_thermal: cpu-thermal {
30                         polling-delay-passive = <0>;
31                         polling-delay = <0>;
32
33                         thermal-sensors = <&thermal>;
34
35                         trips {
36                                 cpu_alert1: cpu-alert1 {
37                                         temperature = <85000>;
38                                         hysteresis = <0>;
39                                         type = "passive";
40                                 };
41
42                                 cpu-crit: cpu-crit {
43                                         temperature = <120000>;
44                                         hysteresis = <0>;
45                                         type = "critical";
46                                 };
47                         };
48
49                         cooling-maps {
50                         };
51                 };
52         };
53
54         thermal: thermal@50028000 {
55                 compatible = "st,stm32-thermal";
56                 reg = <0x50028000 0x100>;
57                 clocks = <&rcc TMPSENS>;
58                 clock-names = "pclk";
59                 #thermal-sensor-cells = <0>;
60                 interrupts = <GIC_SPI 147 IRQ_TYPE_LEVEL_HIGH>;
61         };