linux-kernel - Re: [PATCH v1 1/2] dt-bindings: hwmon: Add nct736x bindings

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: <94607c47-9824-4e2c-8f22-99ca2e088b27@linaro.org>
Date:   Mon, 4 Dec 2023 09:04:22 +0100
From:   Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To:     baneric926@...il.com, jdelvare@...e.com, linux@...ck-us.net,
        robh+dt@...nel.org, krzysztof.kozlowski+dt@...aro.org,
        conor+dt@...nel.org, corbet@....net
Cc:     linux-hwmon@...r.kernel.org, devicetree@...r.kernel.org,
        linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
        openbmc@...ts.ozlabs.org, kwliu@...oton.com, kcfeng0@...oton.com,
        DELPHINE_CHIU@...ynn.com, Bonnie_Lo@...ynn.com
Subject: Re: [PATCH v1 1/2] dt-bindings: hwmon: Add nct736x bindings

On 04/12/2023 06:56, baneric926@...il.com wrote:
> From: Ban Feng <kcfeng0@...oton.com>
> 
> This change documents the device tree bindings for the Nuvoton
> NCT7362Y, NCT7363Y driver.
> 
> Signed-off-by: Ban Feng <kcfeng0@...oton.com>
> ---
>  .../bindings/hwmon/nuvoton,nct736x.yaml       | 80 +++++++++++++++++++
>  MAINTAINERS                                   |  6 ++
>  2 files changed, 86 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/nuvoton,nct736x.yaml
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/nuvoton,nct736x.yaml b/Documentation/devicetree/bindings/hwmon/nuvoton,nct736x.yaml
> new file mode 100644
> index 000000000000..f98fd260a20f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/nuvoton,nct736x.yaml
> @@ -0,0 +1,80 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +
> +$id: http://devicetree.org/schemas/hwmon/nuvoton,nct736x.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Nuvoton NCT736X Hardware Monitoring IC
> +
> +maintainers:
> +  - Ban Feng <kcfeng0@...oton.com>
> +
> +description: |
> +  The NCT736X is a Fan controller which provides up to 16 independent
> +  FAN input monitors, and up to 16 independent PWM output with SMBus interface.
> +  Besides, NCT7363Y has a built-in watchdog timer which is used for
> +  conditionally generating a system reset output (INT#).
> +
> +additionalProperties: false

Please place it just like other bindings are placing it. Not in some
random order. See example-schema.

You should use common fan properties. If it was not merged yet, you must
rebase on patchset on LKML and mention the dependency in the change log
(---).

> +
> +properties:
> +  compatible:
> +    enum:
> +      - nuvoton,nct7362
> +      - nuvoton,nct7363
> +
> +  reg:
> +    maxItems: 1
> +
> +  nuvoton,pwm-mask:
> +    description: |
> +      each bit means PWMx enable/disable setting, where x = 0~15.
> +      0: disabled, 1: enabled
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    minimum: 0x0
> +    maximum: 0xFFFF
> +    default: 0x0

Use pwms, not own property for this.

> +
> +  nuvoton,fanin-mask:
> +    description: |
> +      each bit means FANINx monitoring enable/disable setting,
> +      where x = 0~15.
> +      0: disabled, 1: enabled
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    minimum: 0x0
> +    maximum: 0xFFFF
> +    default: 0x0

Use properties from common fan bindings.

> +
> +  nuvoton,wdt-timeout:
> +    description: |
> +      Watchdog Timer time configuration for NCT7363Y, as below
> +      0: 15 sec (default)
> +      1: 7.5 sec
> +      2: 3.75 sec
> +      3: 30 sec
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    enum: [0, 1, 2, 3]
> +    default: 0

Nope, reference watchdog.yaml and use its properties. See other watchdog
bindings for examples.

> +
> +required:
> +  - compatible
> +  - reg
> +  - nuvoton,pwm-mask
> +  - nuvoton,fanin-mask
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        nct7363@22 {

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




Best regards,
Krzysztof