linux-kernel - Re: [RFC PATCH 3/5] dt-bindings: regulator: add documentation entry for 88pm88x-regulator

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: <9cecc4bd-34ec-4b34-b0c8-de02473f038a@linaro.org>
Date: Thu, 4 Jan 2024 10:25:08 +0100
From: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To: Karel Balej <karelb@...li.ms.mff.cuni.cz>, Karel Balej
 <balejk@...fyz.cz>, Lee Jones <lee@...nel.org>,
 Rob Herring <robh+dt@...nel.org>,
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>,
 Conor Dooley <conor+dt@...nel.org>, Liam Girdwood <lgirdwood@...il.com>,
 Mark Brown <broonie@...nel.org>, devicetree@...r.kernel.org,
 linux-kernel@...r.kernel.org
Cc: Duje Mihanović <duje.mihanovic@...le.hr>,
 ~postmarketos/upstreaming@...ts.sr.ht, phone-devel@...r.kernel.org
Subject: Re: [RFC PATCH 3/5] dt-bindings: regulator: add documentation entry
 for 88pm88x-regulator

On 28/12/2023 10:39, Karel Balej wrote:
> From: Karel Balej <balejk@...fyz.cz>
> 

A nit, subject: drop second/last, redundant "documentation entry". The
"dt-bindings" prefix is already stating that these are bindings.

> The Marvell 88PM88X PMICs provide regulators among other things.
> Document how to use them.


You did not document them in the bindings. You just added example to
make it complete. Where is the binding change?

What's more, I have doubts that you tested it.


> 
> Signed-off-by: Karel Balej <balejk@...fyz.cz>
> ---
>  .../bindings/mfd/marvell,88pm88x.yaml         | 17 +++++++++++
>  .../regulator/marvell,88pm88x-regulator.yaml  | 28 +++++++++++++++++++
>  2 files changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/regulator/marvell,88pm88x-regulator.yaml
> 
> diff --git a/Documentation/devicetree/bindings/mfd/marvell,88pm88x.yaml b/Documentation/devicetree/bindings/mfd/marvell,88pm88x.yaml
> index 115b41c9f22c..e6944369fc5c 100644
> --- a/Documentation/devicetree/bindings/mfd/marvell,88pm88x.yaml
> +++ b/Documentation/devicetree/bindings/mfd/marvell,88pm88x.yaml
> @@ -54,6 +54,23 @@ examples:
>          onkey {
>            compatible = "marvell,88pm88x-onkey";
>          };
> +
> +        regulators {
> +          ldo2: ldo2 {
> +            regulator-min-microvolt = <3100000>;
> +            regulator-max-microvolt = <3300000>;
> +            };
> +
> +          ldo15: ldo15 {
> +            regulator-min-microvolt = <3300000>;
> +            regulator-max-microvolt = <3300000>;
> +            };
> +
> +          buck2: buck2 {
> +            regulator-min-microvolt = <1800000>;
> +            regulator-max-microvolt = <1800000>;
> +            };
> +        };
>        };
>      };
>  ...
> diff --git a/Documentation/devicetree/bindings/regulator/marvell,88pm88x-regulator.yaml b/Documentation/devicetree/bindings/regulator/marvell,88pm88x-regulator.yaml
> new file mode 100644
> index 000000000000..c6ac17b113e7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/marvell,88pm88x-regulator.yaml
> @@ -0,0 +1,28 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/marvell,88pm88x-regulator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Marvell 88PM88X PMICs regulators
> +
> +maintainers:
> +  - Karel Balej <balejk@...fyz.cz>
> +
> +description: |
> +  This module is part of the Marvell 88PM88X MFD device. For more details
> +  see Documentation/devicetree/bindings/mfd/marvell,88pm88x.yaml.
> +
> +  The regulator controller is represented as a sub-node of the PMIC node
> +  in the device tree.
> +
> +  The valid names for 88PM886 regulator nodes are ldo[1-9], ldo1[0-6], buck[1-5].

Don't repeat constraints in free form text.

> +
> +patternProperties:
> +  "^(ldo|buck)[0-9]+$":

You need to fix the pattern to be narrow. buck0 and buck6 are not correct.


> +    type: object
> +    description:
> +      Properties for single regulator.
> +    $ref: regulator.yaml#

Not many benefits of this being in its own schema.

> +
> +additionalProperties: false

Best regards,
Krzysztof