linux-kernel - Re: [PATCH 1/2] dt-bindings: Convert lp873x.txt to json-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] [day] [month] [year] [list]

Date: Mon, 29 Apr 2024 08:06:58 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: Nathan Morrisson <nmorrisson@...tec.com>, lee@...nel.org,
 robh@...nel.org, krzk+dt@...nel.org, conor+dt@...nel.org, nm@...com,
 vigneshr@...com, kristo@...nel.org, j-keerthy@...com
Cc: devicetree@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-arm-kernel@...ts.infradead.org, upstream@...ts.phytec.de,
 w.egorov@...tec.de
Subject: Re: [PATCH 1/2] dt-bindings: Convert lp873x.txt to json-schema

On 26/04/2024 19:21, Nathan Morrisson wrote:
> Convert the lp873x binding to DT schema format. Converted with
> minimal corrections.
> 
> Signed-off-by: Nathan Morrisson <nmorrisson@...tec.com>

Please use subject prefixes matching the subsystem. You can get them for
example with `git log --oneline -- DIRECTORY_OR_FILE` on the directory
your patch is touching.


..

> -};
> diff --git a/Documentation/devicetree/bindings/mfd/lp873x.yaml b/Documentation/devicetree/bindings/mfd/lp873x.yaml
> new file mode 100644
> index 000000000000..87fefdc3126b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/lp873x.yaml

Missing vendor prefix. Name it after compatible, so ti,lp8732.yaml

> @@ -0,0 +1,114 @@
> +# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mfd/lp873x.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: TI LP873X PMIC MFD drivers


MFD is Linuxism, 'drivers' is not a hardware usually. Please provide
title matching hardware.

> +
> +maintainers:
> +  - J Keerthy <j-keerthy@...com>
> +
> +description: |

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

> +  PMIC with two high-current buck converters and two linear regulators.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ti,lp8732
> +      - ti,lp8733
> +
> +  reg:
> +    maxItems: 1
> +
> +  gpio-controller: true
> +
> +  '#gpio-cells':
> +    const: 2
> +
> +  regulators:
> +    description:
> +      List of child nodes that specify the regulator initialization data.
> +    type: object
> +    patternProperties:
> +      "^buck[01]|ldo[01]$":
> +        type: object
> +        $ref: /schemas/regulator/regulator.yaml#
> +        unevaluatedProperties: false
> +    additionalProperties: false
> +
> +patternProperties:
> +  '^(buck[01]|ldo[01])-in-supply$':
> +    description: Phandle to parent supply of each regulator populated under regulators node.
> +
> +required:
> +  - compatible
> +  - reg
> +  - regulators

Several other properties are required and you did not mention changes in
the conversion.

> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        i2c@0 {
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +            reg = <0>;
> +
> +            pmic: lp8733@60 {

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

That's usually pmic


Best regards,
Krzysztof