Commit cff1d293 authored by Amit Kucheria's avatar Amit Kucheria Committed by Daniel Lezcano

dt-bindings: thermal: Get rid of thermal.txt and replace references

Now that we have yaml bindings for the thermal subsystem, get rid of the
old bindings (thermal.txt).

Replace all references to thermal.txt in the Documentation with a link
to the appropriate YAML bindings using the following search and replace
pattern:
 - If the reference is specific to the thermal-sensor-cells property,
 replace with a pointer to thermal-sensor.yaml
 - If the reference is to the cooling-cells property, replace with a
 pointer to thermal-cooling-devices.yaml
 - If the reference is generic thermal bindings, replace with a
 reference to thermal*.yaml.
Signed-off-by: default avatarAmit Kucheria <amit.kucheria@linaro.org>
Acked-by: default avatarViresh Kumar <viresh.kumar@linaro.org>
Signed-off-by: default avatarDaniel Lezcano <daniel.lezcano@linaro.org>
Link: https://lore.kernel.org/r/e9aacd33071a00568b67e110fa3bcc4d86d3e1e4.1595245166.git.amit.kucheria@linaro.org
parent 3f5a2cbe
...@@ -102,7 +102,7 @@ Required sub-node properties: ...@@ -102,7 +102,7 @@ Required sub-node properties:
[0] http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/index.html [0] http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/index.html
[1] Documentation/devicetree/bindings/clock/clock-bindings.txt [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
[2] Documentation/devicetree/bindings/power/power-domain.yaml [2] Documentation/devicetree/bindings/power/power-domain.yaml
[3] Documentation/devicetree/bindings/thermal/thermal.txt [3] Documentation/devicetree/bindings/thermal/thermal*.yaml
[4] Documentation/devicetree/bindings/sram/sram.yaml [4] Documentation/devicetree/bindings/sram/sram.yaml
[5] Documentation/devicetree/bindings/reset/reset.txt [5] Documentation/devicetree/bindings/reset/reset.txt
......
...@@ -108,7 +108,7 @@ Required properties: ...@@ -108,7 +108,7 @@ Required properties:
[0] http://infocenter.arm.com/help/topic/com.arm.doc.dui0922b/index.html [0] http://infocenter.arm.com/help/topic/com.arm.doc.dui0922b/index.html
[1] Documentation/devicetree/bindings/clock/clock-bindings.txt [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
[2] Documentation/devicetree/bindings/thermal/thermal.txt [2] Documentation/devicetree/bindings/thermal/thermal*.yaml
[3] Documentation/devicetree/bindings/sram/sram.yaml [3] Documentation/devicetree/bindings/sram/sram.yaml
[4] Documentation/devicetree/bindings/power/power-domain.yaml [4] Documentation/devicetree/bindings/power/power-domain.yaml
......
...@@ -176,7 +176,7 @@ Required properties: ...@@ -176,7 +176,7 @@ Required properties:
"fsl,imx8qxp-sc-thermal" "fsl,imx8qxp-sc-thermal"
followed by "fsl,imx-sc-thermal"; followed by "fsl,imx-sc-thermal";
- #thermal-sensor-cells: See Documentation/devicetree/bindings/thermal/thermal.txt - #thermal-sensor-cells: See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml
for a description. for a description.
Example (imx8qxp): Example (imx8qxp):
......
...@@ -111,7 +111,7 @@ Thermal: ...@@ -111,7 +111,7 @@ Thermal:
-------- --------
For common binding part and usage, refer to For common binding part and usage, refer to
Documentation/devicetree/bindings/thermal/thermal.txt Documentation/devicetree/bindings/thermal/thermal*.yaml
The thermal IP can probe the temperature all around the processor. It The thermal IP can probe the temperature all around the processor. It
may feature several channels, each of them wired to one sensor. may feature several channels, each of them wired to one sensor.
......
...@@ -203,7 +203,7 @@ It is possible to setup an overheat interrupt by giving at least one ...@@ -203,7 +203,7 @@ It is possible to setup an overheat interrupt by giving at least one
critical point to any subnode of the thermal-zone node. critical point to any subnode of the thermal-zone node.
For common binding part and usage, refer to For common binding part and usage, refer to
Documentation/devicetree/bindings/thermal/thermal.txt Documentation/devicetree/bindings/thermal/thermal*.yaml
Required properties: Required properties:
- compatible: must be one of: - compatible: must be one of:
......
...@@ -18,7 +18,8 @@ Optional properties: ...@@ -18,7 +18,8 @@ Optional properties:
in unit of nanoseconds. in unit of nanoseconds.
- voltage-tolerance: Specify the CPU voltage tolerance in percentage. - voltage-tolerance: Specify the CPU voltage tolerance in percentage.
- #cooling-cells: - #cooling-cells:
Please refer to Documentation/devicetree/bindings/thermal/thermal.txt. Please refer to
Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml.
Examples: Examples:
......
...@@ -21,8 +21,8 @@ Optional properties: ...@@ -21,8 +21,8 @@ Optional properties:
flow is handled by hardware, hence no software "voltage tracking" is flow is handled by hardware, hence no software "voltage tracking" is
needed. needed.
- #cooling-cells: - #cooling-cells:
Please refer to Documentation/devicetree/bindings/thermal/thermal.txt For details, please refer to
for detail. Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml
Example 1 (MT7623 SoC): Example 1 (MT7623 SoC):
......
...@@ -5,7 +5,7 @@ Required properties: ...@@ -5,7 +5,7 @@ Required properties:
- clocks: Must contain an entry for the CPU clock. - clocks: Must contain an entry for the CPU clock.
See ../clocks/clock-bindings.txt for details. See ../clocks/clock-bindings.txt for details.
- operating-points-v2: See ../bindings/opp/opp.txt for details. - operating-points-v2: See ../bindings/opp/opp.txt for details.
- #cooling-cells: Should be 2. See ../thermal/thermal.txt for details. - #cooling-cells: Should be 2. See ../thermal/thermal-cooling-devices.yaml for details.
For each opp entry in 'operating-points-v2' table: For each opp entry in 'operating-points-v2' table:
- opp-supported-hw: Two bitfields indicating: - opp-supported-hw: Two bitfields indicating:
......
...@@ -12,7 +12,8 @@ Optional properties: ...@@ -12,7 +12,8 @@ Optional properties:
- alarm-gpios: This pin going active indicates something is wrong with - alarm-gpios: This pin going active indicates something is wrong with
the fan, and a udev event will be fired. the fan, and a udev event will be fired.
- #cooling-cells: If used as a cooling device, must be <2> - #cooling-cells: If used as a cooling device, must be <2>
Also see: Documentation/devicetree/bindings/thermal/thermal.txt Also see:
Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml
min and max states are derived from the speed-map of the fan. min and max states are derived from the speed-map of the fan.
Note: At least one the "gpios" or "alarm-gpios" properties must be set. Note: At least one the "gpios" or "alarm-gpios" properties must be set.
......
...@@ -34,8 +34,8 @@ Optional properties: ...@@ -34,8 +34,8 @@ Optional properties:
LM90 "-ALERT" pin output. LM90 "-ALERT" pin output.
See interrupt-controller/interrupts.txt for the format. See interrupt-controller/interrupts.txt for the format.
- #thermal-sensor-cells: should be set to 1. See thermal/thermal.txt for - #thermal-sensor-cells: should be set to 1. See thermal/thermal-sensor.yaml
details. See <include/dt-bindings/thermal/lm90.h> for the for details. See <include/dt-bindings/thermal/lm90.h> for the
definition of the local, remote and 2nd remote sensor index definition of the local, remote and 2nd remote sensor index
constants. constants.
......
...@@ -50,7 +50,7 @@ properties: ...@@ -50,7 +50,7 @@ properties:
nvmem-cell-names: nvmem-cell-names:
const: calibration const: calibration
# See ./thermal.txt for details # See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for details
"#thermal-sensor-cells": "#thermal-sensor-cells":
enum: enum:
- 0 - 0
......
...@@ -6,7 +6,7 @@ transaction. ...@@ -6,7 +6,7 @@ transaction.
Required properties: Required properties:
- compatible: "amazon,al-thermal". - compatible: "amazon,al-thermal".
- reg: The physical base address and length of the sensor's registers. - reg: The physical base address and length of the sensor's registers.
- #thermal-sensor-cells: Must be 1. See ./thermal.txt for a description. - #thermal-sensor-cells: Must be 1. See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for a description.
Example: Example:
thermal: thermal { thermal: thermal {
......
...@@ -23,7 +23,7 @@ properties: ...@@ -23,7 +23,7 @@ properties:
compatible: compatible:
const: brcm,bcm2711-thermal const: brcm,bcm2711-thermal
# See ./thermal.txt for details # See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for details
"#thermal-sensor-cells": "#thermal-sensor-cells":
const: 0 const: 0
......
...@@ -7,7 +7,7 @@ compatible: should be one of: "brcm,bcm2835-thermal", ...@@ -7,7 +7,7 @@ compatible: should be one of: "brcm,bcm2835-thermal",
"brcm,bcm2836-thermal" or "brcm,bcm2837-thermal" "brcm,bcm2836-thermal" or "brcm,bcm2837-thermal"
reg: Address range of the thermal registers. reg: Address range of the thermal registers.
clocks: Phandle of the clock used by the thermal sensor. clocks: Phandle of the clock used by the thermal sensor.
#thermal-sensor-cells: should be 0 (see thermal.txt) #thermal-sensor-cells: should be 0 (see Documentation/devicetree/bindings/thermal/thermal-sensor.yaml)
Example: Example:
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
by /SOCTHERM/tsensor. by /SOCTHERM/tsensor.
- clock-names: Input clock name, should be 'thermal_clk'. - clock-names: Input clock name, should be 'thermal_clk'.
- clocks: phandles for clock specified in "clock-names" property. - clocks: phandles for clock specified in "clock-names" property.
- #thermal-sensor-cells: Should be 1. See ./thermal.txt for a description. - #thermal-sensor-cells: Should be 1. See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for a description.
Example : Example :
......
...@@ -8,12 +8,12 @@ below threshold level. ...@@ -8,12 +8,12 @@ below threshold level.
Required properties: Required properties:
------------------- -------------------
#thermal-sensor-cells: Please refer <devicetree/bindings/thermal/thermal.txt> #thermal-sensor-cells: For more details, please refer to
for more details. <devicetree/bindings/thermal/thermal-sensor.yaml>
The value must be 0. The value must be 0.
For more details, please refer generic thermal DT binding document For more details, please refer generic thermal DT binding document
<devicetree/bindings/thermal/thermal.txt>. <devicetree/bindings/thermal/thermal*.yaml>.
Please refer <devicetree/bindings/mfd/max77620.txt> for mfd DT binding Please refer <devicetree/bindings/mfd/max77620.txt> for mfd DT binding
document for the MAX77620. document for the MAX77620.
......
...@@ -23,7 +23,7 @@ Required properties: ...@@ -23,7 +23,7 @@ Required properties:
- resets: Reference to the reset controller controlling the thermal controller. - resets: Reference to the reset controller controlling the thermal controller.
- mediatek,auxadc: A phandle to the AUXADC which the thermal controller uses - mediatek,auxadc: A phandle to the AUXADC which the thermal controller uses
- mediatek,apmixedsys: A phandle to the APMIXEDSYS controller. - mediatek,apmixedsys: A phandle to the APMIXEDSYS controller.
- #thermal-sensor-cells : Should be 0. See ./thermal.txt for a description. - #thermal-sensor-cells : Should be 0. See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for a description.
Optional properties: Optional properties:
- nvmem-cells: A phandle to the calibration data provided by a nvmem device. If - nvmem-cells: A phandle to the calibration data provided by a nvmem device. If
......
...@@ -28,9 +28,10 @@ Required properties : ...@@ -28,9 +28,10 @@ Required properties :
See ../reset/reset.txt for details. See ../reset/reset.txt for details.
- reset-names : Must include the following entries: - reset-names : Must include the following entries:
- soctherm - soctherm
- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description - #thermal-sensor-cells : Should be 1. For a description of this property, see
of this property. See <dt-bindings/thermal/tegra124-soctherm.h> for a Documentation/devicetree/bindings/thermal/thermal-sensor.yaml.
list of valid values when referring to thermal sensors. See <dt-bindings/thermal/tegra124-soctherm.h> for a list of valid values
when referring to thermal sensors.
- throttle-cfgs: A sub-node which is a container of configuration for each - throttle-cfgs: A sub-node which is a container of configuration for each
hardware throttle events. These events can be set as cooling devices. hardware throttle events. These events can be set as cooling devices.
* throttle events: Sub-nodes must be named as "light" or "heavy". * throttle events: Sub-nodes must be named as "light" or "heavy".
...@@ -62,7 +63,8 @@ Required properties : ...@@ -62,7 +63,8 @@ Required properties :
TEGRA_SOCTHERM_THROT_LEVEL_MED (75%), TEGRA_SOCTHERM_THROT_LEVEL_MED (75%),
TEGRA_SOCTHERM_THROT_LEVEL_HIGH (85%). TEGRA_SOCTHERM_THROT_LEVEL_HIGH (85%).
- #cooling-cells: Should be 1. This cooling device only support on/off state. - #cooling-cells: Should be 1. This cooling device only support on/off state.
See ./thermal.txt for a description of this property. For a description of this property see:
Documentation/devicetree/bindings/thermal/thermal-cooling-devices.yaml
Optional properties: The following properties are T210 specific and Optional properties: The following properties are T210 specific and
valid only for OCx throttle events. valid only for OCx throttle events.
......
...@@ -8,7 +8,7 @@ exposed by BPMP. ...@@ -8,7 +8,7 @@ exposed by BPMP.
The BPMP thermal node must be located directly inside the main BPMP node. See The BPMP thermal node must be located directly inside the main BPMP node. See
../firmware/nvidia,tegra186-bpmp.txt for details of the BPMP binding. ../firmware/nvidia,tegra186-bpmp.txt for details of the BPMP binding.
This node represents a thermal sensor. See thermal.txt for details of the This node represents a thermal sensor. See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for details of the
core thermal binding. core thermal binding.
Required properties: Required properties:
......
...@@ -8,7 +8,7 @@ Required properties: ...@@ -8,7 +8,7 @@ Required properties:
- compatible: Should contain "qcom,spmi-temp-alarm". - compatible: Should contain "qcom,spmi-temp-alarm".
- reg: Specifies the SPMI address. - reg: Specifies the SPMI address.
- interrupts: PMIC temperature alarm interrupt. - interrupts: PMIC temperature alarm interrupt.
- #thermal-sensor-cells: Should be 0. See thermal.txt for a description. - #thermal-sensor-cells: Should be 0. See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for a description.
Optional properties: Optional properties:
- io-channels: Should contain IIO channel specifier for the ADC channel, - io-channels: Should contain IIO channel specifier for the ADC channel,
......
...@@ -24,7 +24,7 @@ Required properties: ...@@ -24,7 +24,7 @@ Required properties:
- pinctrl-1 : The "default" pinctrl state, it will be set after reset the - pinctrl-1 : The "default" pinctrl state, it will be set after reset the
TSADC controller. TSADC controller.
- pinctrl-2 : The "sleep" pinctrl state, it will be in for suspend. - pinctrl-2 : The "sleep" pinctrl state, it will be in for suspend.
- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description. - #thermal-sensor-cells : Should be 1. See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for a description.
Optional properties: Optional properties:
- rockchip,hw-tshut-temp : The hardware-controlled shutdown temperature value. - rockchip,hw-tshut-temp : The hardware-controlled shutdown temperature value.
......
...@@ -4,7 +4,7 @@ The SMP8758 SoC includes 3 instances of this temperature sensor ...@@ -4,7 +4,7 @@ The SMP8758 SoC includes 3 instances of this temperature sensor
(in the CPU, video decoder, and PCIe controller). (in the CPU, video decoder, and PCIe controller).
Required properties: Required properties:
- #thermal-sensor-cells: Should be 0 (see thermal.txt) - #thermal-sensor-cells: Should be 0 (see Documentation/devicetree/bindings/thermal/thermal-sensor.yaml)
- compatible: "sigma,smp8758-thermal" - compatible: "sigma,smp8758-thermal"
- reg: Address range of the thermal registers - reg: Address range of the thermal registers
......
...@@ -8,7 +8,7 @@ temperature using voltage-temperature lookup table. ...@@ -8,7 +8,7 @@ temperature using voltage-temperature lookup table.
Required properties: Required properties:
=================== ===================
- compatible: Must be "generic-adc-thermal". - compatible: Must be "generic-adc-thermal".
- #thermal-sensor-cells: Should be 1. See ./thermal.txt for a description - #thermal-sensor-cells: Should be 1. See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml for a description
of this property. of this property.
Optional properties: Optional properties:
=================== ===================
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment