Converts st,stih407-thermal binding to DT schema format and cleans
unused property "st,passive_cooling_temp" which does not appear in the
device-tree.
Signed-off-by: Raphael Gallais-Pou <[email protected]>
---
.../bindings/thermal/st,stih407-thermal.yaml | 61 ++++++++++++++++++++++
.../devicetree/bindings/thermal/st-thermal.txt | 32 ------------
2 files changed, 61 insertions(+), 32 deletions(-)
diff --git a/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml b/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml
new file mode 100644
index 000000000000..807f8d77edf5
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/st,stih407-thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: STMicroelectronics STi digital thermal sensor (DTS)
+
+maintainers:
+ - Patrice Chotard <[email protected]>
+ - Lee Jones <[email protected]>
+
+description:
+ Binding for Thermal Sensor device for STMicroelectronics STi SoCs series.
+
+allOf:
+ - $ref: thermal-sensor.yaml
+
+properties:
+ compatible:
+ const: st,stih407-thermal
+
+ clocks:
+ maxItems: 1
+ description: Phandle of the clock used by the thermal sensor.
+
+ clock-names:
+ items:
+ - const: thermal
+
+ reg:
+ description:
+ For non-sysconf based sensors, this should be the physical base
+ address and length of the sensor's registers.
+
+ interrupts:
+ description: |
+ Standard way to define interrupt number.
+ For thermal sensor's for which no interrupt has been
+ defined, a polling delay of 1000ms will be used to read the
+ temperature from device.
+
+required:
+ - compatible
+ - clocks
+ - clock-names
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ temp0@91a0000 {
+ compatible = "st,stih407-thermal";
+ reg = <0x91a0000 0x28>;
+ clock-names = "thermal";
+ clocks = <&CLK_SYSIN>;
+ interrupts = <GIC_SPI 205 IRQ_TYPE_EDGE_RISING>;
+ #thermal-sensor-cells = <0>;
+ };
+...
diff --git a/Documentation/devicetree/bindings/thermal/st-thermal.txt b/Documentation/devicetree/bindings/thermal/st-thermal.txt
deleted file mode 100644
index a2f939137e35..000000000000
--- a/Documentation/devicetree/bindings/thermal/st-thermal.txt
+++ /dev/null
@@ -1,32 +0,0 @@
-Binding for Thermal Sensor driver for STMicroelectronics STi series of SoCs.
-
-Required parameters:
--------------------
-
-compatible : Should be "st,stih407-thermal"
-
-clock-names : Should be "thermal".
- See: Documentation/devicetree/bindings/resource-names.txt
-clocks : Phandle of the clock used by the thermal sensor.
- See: Documentation/devicetree/bindings/clock/clock-bindings.txt
-
-Optional parameters:
--------------------
-
-reg : For non-sysconf based sensors, this should be the physical base
- address and length of the sensor's registers.
-interrupts : Standard way to define interrupt number.
- NB: For thermal sensor's for which no interrupt has been
- defined, a polling delay of 1000ms will be used to read the
- temperature from device.
-
-Example:
-
- temp0@91a0000 {
- compatible = "st,stih407-thermal";
- reg = <0x91a0000 0x28>;
- clock-names = "thermal";
- clocks = <&CLK_SYSIN>;
- interrupts = <GIC_SPI 205 IRQ_TYPE_EDGE_RISING>;
- st,passive_cooling_temp = <110>;
- };
--
2.43.2
On 26/02/2024 08:48, Raphael Gallais-Pou wrote:
> Converts st,stih407-thermal binding to DT schema format and cleans
Please use imperative for your future patches.
https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95
> unused property "st,passive_cooling_temp" which does not appear in the
> device-tree.
>
> Signed-off-by: Raphael Gallais-Pou <[email protected]>
> ---
> .../bindings/thermal/st,stih407-thermal.yaml | 61 ++++++++++++++++++++++
> .../devicetree/bindings/thermal/st-thermal.txt | 32 ------------
> 2 files changed, 61 insertions(+), 32 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml b/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml
> new file mode 100644
> index 000000000000..807f8d77edf5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml
> @@ -0,0 +1,61 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/st,stih407-thermal.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: STMicroelectronics STi digital thermal sensor (DTS)
> +
> +maintainers:
> + - Patrice Chotard <[email protected]>
> + - Lee Jones <[email protected]>
> +
> +description:
> + Binding for Thermal Sensor device for STMicroelectronics STi SoCs series.
Drop "Binding for" and describe the hardware. If you repeat the title,
then the description is not really needed.
> +
> +allOf:
> + - $ref: thermal-sensor.yaml
> +
> +properties:
> + compatible:
> + const: st,stih407-thermal
> +
> + clocks:
> + maxItems: 1
> + description: Phandle of the clock used by the thermal sensor.
Drop description, it's obvious.
> +
> + clock-names:
> + items:
> + - const: thermal
> +
> + reg:
> + description:
> + For non-sysconf based sensors, this should be the physical base
> + address and length of the sensor's registers.
That's odd, probably old binding was incomplete. You have only one
device described here, so I expect this to be always present (thus
description is obvious).
> +
> + interrupts:
> + description: |
Do not need '|' unless you need to preserve formatting.
> + Standard way to define interrupt number.
???
> + For thermal sensor's for which no interrupt has been
> + defined, a polling delay of 1000ms will be used to read the
> + temperature from device.
Missing thermal-sensor-cells.
> +
> +required:
> + - compatible
> + - clocks
> + - clock-names
Missing reg and please mention the change from pure conversion in commit
msg.
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + temp0@91a0000 {
Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
> + compatible = "st,stih407-thermal";
> + reg = <0x91a0000 0x28>;
> + clock-names = "thermal";
> + clocks = <&CLK_SYSIN>;
> + interrupts = <GIC_SPI 205 IRQ_TYPE_EDGE_RISING>;
> + #thermal-sensor-cells = <0>;
> + };
Best regards,
Krzysztof
Hi Krzysztof,
Le 29/02/2024 à 20:15, Krzysztof Kozlowski a écrit :
> On 26/02/2024 08:48, Raphael Gallais-Pou wrote:
>> Converts st,stih407-thermal binding to DT schema format and cleans
>
> Please use imperative for your future patches.
> https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95
>
>> unused property "st,passive_cooling_temp" which does not appear in the
>> device-tree.
>>
>> Signed-off-by: Raphael Gallais-Pou <[email protected]>
>> ---
>> .../bindings/thermal/st,stih407-thermal.yaml | 61 ++++++++++++++++++++++
>> .../devicetree/bindings/thermal/st-thermal.txt | 32 ------------
>> 2 files changed, 61 insertions(+), 32 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml b/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml
>> new file mode 100644
>> index 000000000000..807f8d77edf5
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml
>> @@ -0,0 +1,61 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/thermal/st,stih407-thermal.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: STMicroelectronics STi digital thermal sensor (DTS)
>> +
>> +maintainers:
>> + - Patrice Chotard <[email protected]>
>> + - Lee Jones <[email protected]>
>> +
>> +description:
>> + Binding for Thermal Sensor device for STMicroelectronics STi SoCs series.
>
> Drop "Binding for" and describe the hardware. If you repeat the title,
> then the description is not really needed.
>
>> +
>> +allOf:
>> + - $ref: thermal-sensor.yaml
>> +
>> +properties:
>> + compatible:
>> + const: st,stih407-thermal
>> +
>> + clocks:
>> + maxItems: 1
>> + description: Phandle of the clock used by the thermal sensor.
>
> Drop description, it's obvious.
>
>> +
>> + clock-names:
>> + items:
>> + - const: thermal
>> +
>> + reg:
>> + description:
>> + For non-sysconf based sensors, this should be the physical base
>> + address and length of the sensor's registers.
>
> That's odd, probably old binding was incomplete. You have only one
> device described here, so I expect this to be always present (thus
> description is obvious).
It is indeed missing in the old file.
>
>> +
>> + interrupts:
>> + description: |
>
> Do not need '|' unless you need to preserve formatting.
>
>> + Standard way to define interrupt number.
>
> ???
>
>> + For thermal sensor's for which no interrupt has been
>> + defined, a polling delay of 1000ms will be used to read the
>> + temperature from device.
>
> Missing thermal-sensor-cells.
>
>> +
>> +required:
>> + - compatible
>> + - clocks
>> + - clock-names
>
> Missing reg and please mention the change from pure conversion in commit
> msg.
>
>> +
>> +unevaluatedProperties: false
>> +
>> +examples:
>> + - |
>> + #include <dt-bindings/interrupt-controller/arm-gic.h>
>> + temp0@91a0000 {
>
> Node names should be generic. See also an explanation and list of
> examples (not exhaustive) in DT specification:
> https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
>
>
>> + compatible = "st,stih407-thermal";
>> + reg = <0x91a0000 0x28>;
>> + clock-names = "thermal";
>> + clocks = <&CLK_SYSIN>;
>> + interrupts = <GIC_SPI 205 IRQ_TYPE_EDGE_RISING>;
>> + #thermal-sensor-cells = <0>;
>> + };
>
>
>
Thanks for your review. I will send a v2 with the changes your mentioned
above.
Regards,
Raphaël
> Best regards,
> Krzysztof
>