linux-kernel - Re: [PATCH v3 3/6] dt-bindings: regulator: max77650: convert the binding document to yaml

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 for Android: free password hash cracker in your pocket

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

Message-ID: <CAMpxmJUMgqocphdPhS_zCYX3ib_hnwhnhBfQEVaY8hnpi4vxQg@mail.gmail.com>
Date:   Fri, 18 Oct 2019 08:44:57 +0200
From:   Bartosz Golaszewski <bgolaszewski@...libre.com>
To:     Rob Herring <robh@...nel.org>
Cc:     Bartosz Golaszewski <brgl@...ev.pl>,
        Mark Rutland <mark.rutland@....com>,
        Dmitry Torokhov <dmitry.torokhov@...il.com>,
        Jacek Anaszewski <jacek.anaszewski@...il.com>,
        Pavel Machek <pavel@....cz>, Dan Murphy <dmurphy@...com>,
        Lee Jones <lee.jones@...aro.org>,
        Sebastian Reichel <sre@...nel.org>,
        Liam Girdwood <lgirdwood@...il.com>,
        Mark Brown <broonie@...nel.org>,
        Linux Input <linux-input@...r.kernel.org>,
        linux-devicetree <devicetree@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Linux LED Subsystem <linux-leds@...r.kernel.org>,
        linux-pm <linux-pm@...r.kernel.org>
Subject: Re: [PATCH v3 3/6] dt-bindings: regulator: max77650: convert the
 binding document to yaml

czw., 17 paź 2019 o 20:35 Rob Herring <robh@...nel.org> napisał(a):
>
> On Thu, Oct 17, 2019 at 09:12:31AM +0200, Bartosz Golaszewski wrote:
> > From: Bartosz Golaszewski <bgolaszewski@...libre.com>
> >
> > Convert the binding document for MAX77650 regulator module to YAML.
> >
> > Signed-off-by: Bartosz Golaszewski <bgolaszewski@...libre.com>
> > ---
> >  .../bindings/regulator/max77650-regulator.txt | 41 -------------------
> >  .../regulator/max77650-regulator.yaml         | 31 ++++++++++++++
> >  2 files changed, 31 insertions(+), 41 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> >  create mode 100644 Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt b/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> > deleted file mode 100644
> > index f1cbe813c30f..000000000000
> > --- a/Documentation/devicetree/bindings/regulator/max77650-regulator.txt
> > +++ /dev/null
> > @@ -1,41 +0,0 @@
> > -Regulator driver for MAX77650 PMIC from Maxim Integrated.
> > -
> > -This module is part of the MAX77650 MFD device. For more details
> > -see Documentation/devicetree/bindings/mfd/max77650.txt.
> > -
> > -The regulator controller is represented as a sub-node of the PMIC node
> > -on the device tree.
> > -
> > -The device has a single LDO regulator and a SIMO buck-boost regulator with
> > -three independent power rails.
> > -
> > -Required properties:
> > ---------------------
> > -- compatible:                Must be "maxim,max77650-regulator"
> > -
> > -Each rail must be instantiated under the regulators subnode of the top PMIC
> > -node. Up to four regulators can be defined. For standard regulator properties
> > -refer to Documentation/devicetree/bindings/regulator/regulator.txt.
> > -
> > -Available regulator compatible strings are: "ldo", "sbb0", "sbb1", "sbb2".
> > -
> > -Example:
> > ---------
> > -
> > -     regulators {
> > -             compatible = "maxim,max77650-regulator";
> > -
> > -             max77650_ldo: regulator@0 {
> > -                     regulator-compatible = "ldo";
> > -                     regulator-name = "max77650-ldo";
> > -                     regulator-min-microvolt = <1350000>;
> > -                     regulator-max-microvolt = <2937500>;
> > -             };
> > -
> > -             max77650_sbb0: regulator@1 {
> > -                     regulator-compatible = "sbb0";
> > -                     regulator-name = "max77650-sbb0";
> > -                     regulator-min-microvolt = <800000>;
> > -                     regulator-max-microvolt = <1587500>;
> > -             };
> > -     };
> > diff --git a/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> > new file mode 100644
> > index 000000000000..a8770742836d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/regulator/max77650-regulator.yaml
> > @@ -0,0 +1,31 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/regulator/max77650-regulator.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Regulator driver for MAX77650 PMIC from Maxim Integrated.
> > +
> > +maintainers:
> > +  - Bartosz Golaszewski <bgolaszewski@...libre.com>
> > +
> > +description: |
> > +  This module is part of the MAX77650 MFD device. For more details
> > +  see Documentation/devicetree/bindings/mfd/max77650.txt.
>
> .yaml?
>

Is there any better way of referencing the main document than
mentioning it in the description?

Bart

> > +
> > +  The regulator controller is represented as a sub-node of the PMIC node
> > +  on the device tree.
> > +
> > +  The device has a single LDO regulator and a SIMO buck-boost regulator with
> > +  three independent power rails.
> > +
> > +properties:
> > +  compatible:
> > +    const: maxim,max77650-regulator
> > +
> > +patternProperties:
> > +  "^regulator@[0-3]$":
> > +    $ref: "regulator.yaml#"
> > +
> > +required:
> > +  - compatible
> > --
> > 2.23.0
> >