dt-bindings: regulator: Convert ti,tps65133 to YAML

Message ID 20231217-tps65132-v1-1-73c69a960d28@apitzsch.eu
State New
Headers
Series dt-bindings: regulator: Convert ti,tps65133 to YAML |

Commit Message

André Apitzsch Dec. 17, 2023, 1:21 p.m. UTC
  Convert TI TPS65132 bindings from .txt to .yaml format.

Signed-off-by: André Apitzsch <git@apitzsch.eu>
---
Note, we still have to find a person willing to be listed as maintainer.
Suggestions are welcome.
---
 .../devicetree/bindings/regulator/ti,tps65132.yaml | 81 ++++++++++++++++++++++
 .../bindings/regulator/tps65132-regulator.txt      | 46 ------------
 2 files changed, 81 insertions(+), 46 deletions(-)


---
base-commit: 17cb8a20bde66a520a2ca7aad1063e1ce7382240
change-id: 20231217-tps65132-7f8229dcad59

Best regards,
  

Comments

Rob Herring Dec. 17, 2023, 2:24 p.m. UTC | #1
On Sun, 17 Dec 2023 14:21:39 +0100, André Apitzsch wrote:
> Convert TI TPS65132 bindings from .txt to .yaml format.
> 
> Signed-off-by: André Apitzsch <git@apitzsch.eu>
> ---
> Note, we still have to find a person willing to be listed as maintainer.
> Suggestions are welcome.
> ---
>  .../devicetree/bindings/regulator/ti,tps65132.yaml | 81 ++++++++++++++++++++++
>  .../bindings/regulator/tps65132-regulator.txt      | 46 ------------
>  2 files changed, 81 insertions(+), 46 deletions(-)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/regulator/ti,tps65132.yaml: 'maintainers' is a required property
	hint: Metaschema for devicetree binding documentation
	from schema $id: http://devicetree.org/meta-schemas/base.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20231217-tps65132-v1-1-73c69a960d28@apitzsch.eu

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
  
André Apitzsch Dec. 22, 2023, 7:50 a.m. UTC | #2
Am Sonntag, dem 17.12.2023 um 08:24 -0600 schrieb Rob Herring:
> 
> On Sun, 17 Dec 2023 14:21:39 +0100, André Apitzsch wrote:
> > Convert TI TPS65132 bindings from .txt to .yaml format.
> > 
> > Signed-off-by: André Apitzsch <git@apitzsch.eu>
> > ---
> > Note, we still have to find a person willing to be listed as
> > maintainer.
> > Suggestions are welcome.
> > ---
> >  .../devicetree/bindings/regulator/ti,tps65132.yaml | 81
> > ++++++++++++++++++++++
> >  .../bindings/regulator/tps65132-regulator.txt      | 46 ----------
> > --
> >  2 files changed, 81 insertions(+), 46 deletions(-)
> > 
> 
> My bot found errors running 'make DT_CHECKER_FLAGS=-m
> dt_binding_check'
> on your patch (DT_CHECKER_FLAGS is new in v5.13):
> 
> yamllint warnings/errors:
> 
> dtschema/dtc warnings/errors:
> /builds/robherring/dt-review-
> ci/linux/Documentation/devicetree/bindings/regulator/ti,tps65132.yaml
> : 'maintainers' is a required property
> 	hint: Metaschema for devicetree binding documentation
> 	from schema $id:
> http://devicetree.org/meta-schemas/base.yaml#

Hi everyone,

I haven't add a maintainer, yet, as the driver for tps65132 doesn't
list one.

Who is willing to be listed as maintainer for this device or who can be
asked to become a maintainer for tps65132?

André
  
Mark Brown Dec. 22, 2023, 2:49 p.m. UTC | #3
On Fri, Dec 22, 2023 at 08:50:14AM +0100, André Apitzsch wrote:
> Am Sonntag, dem 17.12.2023 um 08:24 -0600 schrieb Rob Herring:
> > On Sun, 17 Dec 2023 14:21:39 +0100, André Apitzsch wrote:

> > dtschema/dtc warnings/errors:
> > /builds/robherring/dt-review-
> > ci/linux/Documentation/devicetree/bindings/regulator/ti,tps65132.yaml
> > : 'maintainers' is a required property
> > 	hint: Metaschema for devicetree binding documentation
> > 	from schema $id:
> > http://devicetree.org/meta-schemas/base.yaml#

> I haven't add a maintainer, yet, as the driver for tps65132 doesn't
> list one.

> Who is willing to be listed as maintainer for this device or who can be
> asked to become a maintainer for tps65132?

You could just put the list in as a fallback I guess?

The requirement for DT maintainer does seem to in conflict with the push
to convert things when people are doing incidental work on the driver...
  
Krzysztof Kozlowski Dec. 23, 2023, 2:17 p.m. UTC | #4
On 22/12/2023 15:49, Mark Brown wrote:
> On Fri, Dec 22, 2023 at 08:50:14AM +0100, André Apitzsch wrote:
>> Am Sonntag, dem 17.12.2023 um 08:24 -0600 schrieb Rob Herring:
>>> On Sun, 17 Dec 2023 14:21:39 +0100, André Apitzsch wrote:
> 
>>> dtschema/dtc warnings/errors:
>>> /builds/robherring/dt-review-
>>> ci/linux/Documentation/devicetree/bindings/regulator/ti,tps65132.yaml
>>> : 'maintainers' is a required property
>>> 	hint: Metaschema for devicetree binding documentation
>>> 	from schema $id:
>>> http://devicetree.org/meta-schemas/base.yaml#
> 
>> I haven't add a maintainer, yet, as the driver for tps65132 doesn't
>> list one.
> 
>> Who is willing to be listed as maintainer for this device or who can be
>> asked to become a maintainer for tps65132?
> 
> You could just put the list in as a fallback I guess?
> 
> The requirement for DT maintainer does seem to in conflict with the push
> to convert things when people are doing incidental work on the driver...

I agree. How about relaxing the check and not marking missing maintainer
as a failure?

Best regards,
Krzysztof
  
Mark Brown Dec. 28, 2023, 5:40 p.m. UTC | #5
On Sat, Dec 23, 2023 at 03:17:24PM +0100, Krzysztof Kozlowski wrote:
> On 22/12/2023 15:49, Mark Brown wrote:

> > The requirement for DT maintainer does seem to in conflict with the push
> > to convert things when people are doing incidental work on the driver...

> I agree. How about relaxing the check and not marking missing maintainer
> as a failure?

That certainly works for me - it could just be a warning for example.
  

Patch

diff --git a/Documentation/devicetree/bindings/regulator/ti,tps65132.yaml b/Documentation/devicetree/bindings/regulator/ti,tps65132.yaml
new file mode 100644
index 000000000000..0add88dd0e80
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/ti,tps65132.yaml
@@ -0,0 +1,81 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/regulator/ti,tps65132.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TI TPS65132 Dual Output Power Regulators
+
+description: |
+  The TPS65132 is designed to supply positive/negative driven applications.
+
+  Datasheet is available at:
+  https://www.ti.com/lit/gpn/tps65132
+
+properties:
+  compatible:
+    enum:
+      - ti,tps65132
+
+  reg:
+    maxItems: 1
+
+patternProperties:
+  "^out[pn]$":
+    type: object
+    $ref: regulator.yaml#
+    unevaluatedProperties: false
+    description:
+      Properties for single regulator.
+
+    properties:
+      enable-gpios:
+        maxItems: 1
+        description:
+          GPIO specifier to enable the GPIO control (on/off) for regulator.
+
+      active-discharge-gpios:
+        maxItems: 1
+        description:
+          GPIO specifier to actively discharge the delay mechanism.
+
+      ti,active-discharge-time-us:
+        description: Regulator active discharge time in microseconds.
+
+    dependencies:
+      active-discharge-gpios: [ 'ti,active-discharge-time-us' ]
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        regulator@3e {
+            compatible = "ti,tps65132";
+            reg = <0x3e>;
+
+            outp {
+                regulator-name = "outp";
+                regulator-boot-on;
+                regulator-always-on;
+                enable-gpios = <&gpio 23 GPIO_ACTIVE_HIGH>;
+            };
+
+            outn {
+                regulator-name = "outn";
+                regulator-boot-on;
+                regulator-always-on;
+                regulator-active-discharge = <0>;
+                enable-gpios = <&gpio 40 GPIO_ACTIVE_HIGH>;
+            };
+        };
+    };
diff --git a/Documentation/devicetree/bindings/regulator/tps65132-regulator.txt b/Documentation/devicetree/bindings/regulator/tps65132-regulator.txt
deleted file mode 100644
index 3a3505520c69..000000000000
--- a/Documentation/devicetree/bindings/regulator/tps65132-regulator.txt
+++ /dev/null
@@ -1,46 +0,0 @@ 
-TPS65132 regulators
-
-Required properties:
-- compatible: "ti,tps65132"
-- reg: I2C slave address
-
-Optional Subnode:
-Device supports two regulators OUTP and OUTN. A sub node within the
-   device node describe the properties of these regulators. The sub-node
-   names must be as follows:
-	-For regulator outp, the sub node name should be "outp".
-	-For regulator outn, the sub node name should be "outn".
-
--enable-gpios:(active high, output) Regulators are controlled by the input pins.
-   If it is connected to GPIO through host system then provide the
-   gpio number as per gpio.txt.
--active-discharge-gpios: (active high, output) Some configurations use delay mechanisms
-  on the enable pin, to keep the regulator enabled for some time after
-  the enable signal goes low. This GPIO is used to actively discharge
-  the delay mechanism. Requires specification of ti,active-discharge-time-us
--ti,active-discharge-time-us: how long the active discharge gpio should be
-  asserted for during active discharge, in microseconds.
-
-Each regulator is defined using the standard binding for regulators.
-
-Example:
-
-	tps65132@3e {
-		compatible = "ti,tps65132";
-		reg = <0x3e>;
-
-		outp {
-			regulator-name = "outp";
-			regulator-boot-on;
-			regulator-always-on;
-			enable-gpios = <&gpio 23 0>;
-		};
-
-		outn {
-			regulator-name = "outn";
-			regulator-boot-on;
-			regulator-always-on;
-			regulator-active-discharge = <0>;
-			enable-gpios = <&gpio 40 0>;
-		};
-	};