linux-kernel - Re: [PATCH 1/2] dt-bindings: thermal: convert st,stih407-thermal to DT schema

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <6db2491d-5f8f-43e7-a8c2-b9018bdb7617@linaro.org>
Date: Thu, 29 Feb 2024 20:15:57 +0100
From: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To: Raphael Gallais-Pou <rgallaispou@...il.com>,
 "Rafael J. Wysocki" <rafael@...nel.org>,
 Daniel Lezcano <daniel.lezcano@...aro.org>, Zhang Rui <rui.zhang@...el.com>,
 Lukasz Luba <lukasz.luba@....com>, Rob Herring <robh+dt@...nel.org>,
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>,
 Conor Dooley <conor+dt@...nel.org>,
 Patrice Chotard <patrice.chotard@...s.st.com>, Lee Jones <lee@...nel.org>
Cc: linux-pm@...r.kernel.org, devicetree@...r.kernel.org,
 linux-kernel@...r.kernel.org, linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH 1/2] dt-bindings: thermal: convert st,stih407-thermal to
 DT schema

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 <rgallaispou@...il.com>
> ---
>  .../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 <patrice.chotard@...s.st.com>
> +  - Lee Jones <lee@...nel.org>
> +
> +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@...0000 {

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