linux-kernel - Re: [PATCH 1/3] dt-bindings: hwmon: pmbus: add ti tps25990 documentation

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: <3efbzcys4762rhx2h2cbhqvi6dgik7pfrxcziccdko34pb5z54@joodcym6c3s4>
Date: Tue, 10 Sep 2024 09:48:34 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: Jerome Brunet <jbrunet@...libre.com>
Cc: Jean Delvare <jdelvare@...e.com>, Guenter Roeck <linux@...ck-us.net>, 
	Rob Herring <robh@...nel.org>, Krzysztof Kozlowski <krzk+dt@...nel.org>, 
	Conor Dooley <conor+dt@...nel.org>, Jonathan Corbet <corbet@....net>, 
	Delphine CC Chiu <Delphine_CC_Chiu@...ynn.com>, linux-hwmon@...r.kernel.org, devicetree@...r.kernel.org, 
	linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org, linux-i2c@...r.kernel.org
Subject: Re: [PATCH 1/3] dt-bindings: hwmon: pmbus: add ti tps25990
 documentation

On Mon, Sep 09, 2024 at 05:39:03PM +0200, Jerome Brunet wrote:
> Add DT binding documentation for the Texas Instruments TPS25990 eFuse
> 
> Signed-off-by: Jerome Brunet <jbrunet@...libre.com>
> ---
>  .../bindings/hwmon/pmbus/ti,tps25990.yaml          | 73 ++++++++++++++++++++++
>  1 file changed, 73 insertions(+)
>

A nit, subject: drop second/last, redundant "documentation". The
"dt-bindings" prefix is already stating that these are bindings/docs.
See also:
https://elixir.bootlin.com/linux/v6.7-rc8/source/Documentation/devicetree/bindings/submitting-patches.rst#L18

> diff --git a/Documentation/devicetree/bindings/hwmon/pmbus/ti,tps25990.yaml b/Documentation/devicetree/bindings/hwmon/pmbus/ti,tps25990.yaml
> new file mode 100644
> index 000000000000..e717942b3598
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/pmbus/ti,tps25990.yaml
> @@ -0,0 +1,73 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +

Drop blank line.

> +$id: http://devicetree.org/schemas/hwmon/pmbus/ti,tps25990.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments TPS25990 Stackable eFuse
> +
> +maintainers:
> +  - Jerome Brunet <jbrunet@...libre.com>
> +
> +description: |

Do not need '|' unless you need to preserve formatting.

> +  The TI TPS25990 is an integrated, high-current circuit
> +  protection and power management device with PMBUS interface
> +
> +properties:
> +  compatible:
> +    const: ti,tps25990
> +
> +  reg:
> +    maxItems: 1
> +
> +  ti,rimon-milli-ohms:
> +    description:
> +      milli Ohms value of the resistance installed between the Imon pin
> +      and the ground reference.

Ohms is not enough? We don't have mOhm in property units.
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/property-units.yaml

> +
> +  interrupts:
> +    description: PMBUS SMB Alert Interrupt.
> +    maxItems: 1
> +
> +  regulators:
> +    type: object
> +    description:
> +      list of regulators provided by this controller.

You have just one regulator, so drop "regulators" node and use directly
vout here.

> +
> +    properties:
> +      vout:
> +        $ref: /schemas/regulator/regulator.yaml#
> +        type: object
> +        unevaluatedProperties: false
> +    additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +  - ti,rimon-milli-ohms
> +
> +additionalProperties: false

Best regards,
Krzysztof