diff mbox series

[v2,1/2] dt-bindings: thermal: convert st,stih407-thermal to DT schema

Message ID 20240301-thermal-v2-1-1b32752029ec@gmail.com (mailing list archive)
State New
Delegated to: Daniel Lezcano
Headers show
Series Update st,stih407-thermal device | expand

Commit Message

Raphaël Gallais-Pou March 1, 2024, 5:47 p.m. UTC
'st,passive_colling_temp' does not appear in the device-tree, and 'reg'
is missing in the device description.

Convert st,stih407-thermal binding to DT schema format in order to clean
unused 'st,passive_cooling_temp' and add missing 'reg' property.

Signed-off-by: Raphael Gallais-Pou <rgallaispou@gmail.com>
---
Changes in v2:
  - Change commit log to use imperative
  - Drop description
  - Drop 'clocks' description
  - Add 'reg' property
  - Add '#thermal-sensor-cells'
  - Make node name generic in example
  - Fix YAML style
---
 .../bindings/thermal/st,stih407-thermal.yaml       | 56 ++++++++++++++++++++++
 .../devicetree/bindings/thermal/st-thermal.txt     | 32 -------------
 2 files changed, 56 insertions(+), 32 deletions(-)

Comments

Rob Herring (Arm) March 4, 2024, 6:40 p.m. UTC | #1
On Fri, Mar 01, 2024 at 06:47:28PM +0100, Raphael Gallais-Pou wrote:
> 'st,passive_colling_temp' does not appear in the device-tree, and 'reg'
> is missing in the device description.
> 
> Convert st,stih407-thermal binding to DT schema format in order to clean
> unused 'st,passive_cooling_temp' and add missing 'reg' property.
> 
> Signed-off-by: Raphael Gallais-Pou <rgallaispou@gmail.com>
> ---
> Changes in v2:
>   - Change commit log to use imperative
>   - Drop description
>   - Drop 'clocks' description
>   - Add 'reg' property
>   - Add '#thermal-sensor-cells'
>   - Make node name generic in example
>   - Fix YAML style
> ---
>  .../bindings/thermal/st,stih407-thermal.yaml       | 56 ++++++++++++++++++++++
>  .../devicetree/bindings/thermal/st-thermal.txt     | 32 -------------
>  2 files changed, 56 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..68d7dd8b892f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml
> @@ -0,0 +1,56 @@
> +# 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 <patrice.chotard@foss.st.com>
> +  - Lee Jones <lee@kernel.org>
> +
> +allOf:
> +  - $ref: thermal-sensor.yaml
> +
> +properties:
> +  compatible:
> +    const: st,stih407-thermal
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    items:
> +      - const: thermal
> +
> +  interrupts:
> +    description:
> +      For thermal sensors for which no interrupt has been defined, a polling
> +      delay of 1000ms will be used to read the temperature from device.

maxItems: 1

> +
> +  '#thermal-sensor-cells': true

const: 1

Also, not in the original binding, so please state in the commit msg 
why you are adding it.

> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - clock-names
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    temperature-sensor@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>;
> +    };
> +...
Raphaël Gallais-Pou March 6, 2024, 7:53 a.m. UTC | #2
Le 04/03/2024 à 19:40, Rob Herring a écrit :
> On Fri, Mar 01, 2024 at 06:47:28PM +0100, Raphael Gallais-Pou wrote:
>> 'st,passive_colling_temp' does not appear in the device-tree, and 'reg'
>> is missing in the device description.
>>
>> Convert st,stih407-thermal binding to DT schema format in order to clean
>> unused 'st,passive_cooling_temp' and add missing 'reg' property.
>>
>> Signed-off-by: Raphael Gallais-Pou <rgallaispou@gmail.com>


Hi Rob,

...

>> +  interrupts:
>> +    description:
>> +      For thermal sensors for which no interrupt has been defined, a polling
>> +      delay of 1000ms will be used to read the temperature from device.
> 
> maxItems: 1

Ack.
> 
>> +
>> +  '#thermal-sensor-cells': true
> 
> const: 1
> 
> Also, not in the original binding, so please state in the commit msg
> why you are adding it.

I have mixed feeling regarding the value. Wouldn't this better be 
'const: 0' ?

In the thermal-sensor binding it is specified that it should be 0 for 
single sensor nodes, which is our case.

> 
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +  - clock-names
>> +
>> +unevaluatedProperties: false
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
>> +    temperature-sensor@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>;

If I misunderstand something and the value must be 1 then I will also 
change the value here and in the dt patches of the serie.

Regards,
Raphaël
>> +    };
>> +...
Raphaël Gallais-Pou March 19, 2024, 7:32 p.m. UTC | #3
Hi Rob,

It's been a few weeks.

Gentle ping :)

Regards,
Raphaël

Le 06/03/2024 à 08:53, Raphaël Gallais-Pou a écrit :
> 
> 
> Le 04/03/2024 à 19:40, Rob Herring a écrit :
>> On Fri, Mar 01, 2024 at 06:47:28PM +0100, Raphael Gallais-Pou wrote:
>>> 'st,passive_colling_temp' does not appear in the device-tree, and 'reg'
>>> is missing in the device description.
>>>
>>> Convert st,stih407-thermal binding to DT schema format in order to clean
>>> unused 'st,passive_cooling_temp' and add missing 'reg' property.
>>>
>>> Signed-off-by: Raphael Gallais-Pou <rgallaispou@gmail.com>
> 
> 
> Hi Rob,
> 
> ...
> 
>>> +  interrupts:
>>> +    description:
>>> +      For thermal sensors for which no interrupt has been defined, a 
>>> polling
>>> +      delay of 1000ms will be used to read the temperature from device.
>>
>> maxItems: 1
> 
> Ack.
>>
>>> +
>>> +  '#thermal-sensor-cells': true
>>
>> const: 1
>>
>> Also, not in the original binding, so please state in the commit msg
>> why you are adding it.
> 
> I have mixed feeling regarding the value. Wouldn't this better be 
> 'const: 0' ?
> 
> In the thermal-sensor binding it is specified that it should be 0 for 
> single sensor nodes, which is our case.
> 
>>
>>> +
>>> +required:
>>> +  - compatible
>>> +  - reg
>>> +  - clocks
>>> +  - clock-names
>>> +
>>> +unevaluatedProperties: false
>>> +
>>> +examples:
>>> +  - |
>>> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
>>> +    temperature-sensor@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>;
> 
> If I misunderstand something and the value must be 1 then I will also 
> change the value here and in the dt patches of the serie.
> 
> Regards,
> Raphaël
>>> +    };
>>> +...
Krzysztof Kozlowski March 20, 2024, 8:12 a.m. UTC | #4
On 19/03/2024 20:32, Raphaël Gallais-Pou wrote:
> Hi Rob,
> 
> It's been a few weeks.

Just choose the value which is correct. If you have just one sensor,
then cells=0, like you suggested.

Best regards,
Krzysztof
diff mbox series

Patch

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..68d7dd8b892f
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/st,stih407-thermal.yaml
@@ -0,0 +1,56 @@ 
+# 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 <patrice.chotard@foss.st.com>
+  - Lee Jones <lee@kernel.org>
+
+allOf:
+  - $ref: thermal-sensor.yaml
+
+properties:
+  compatible:
+    const: st,stih407-thermal
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    items:
+      - const: thermal
+
+  interrupts:
+    description:
+      For thermal sensors for which no interrupt has been defined, a polling
+      delay of 1000ms will be used to read the temperature from device.
+
+  '#thermal-sensor-cells': true
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    temperature-sensor@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>;
-	};