diff mbox series

[1/2] dt-bindings: Convert lp873x.txt to json-schema

Message ID 20240426172155.10860-1-nmorrisson@phytec.com (mailing list archive)
State New, archived
Headers show
Series [1/2] dt-bindings: Convert lp873x.txt to json-schema | expand

Commit Message

Nathan Morrisson April 26, 2024, 5:21 p.m. UTC 
Convert the lp873x binding to DT schema format. Converted with
minimal corrections.

Signed-off-by: Nathan Morrisson <nmorrisson@phytec.com>
---
 .../devicetree/bindings/mfd/lp873x.txt        |  67 ----------
 .../devicetree/bindings/mfd/lp873x.yaml       | 114 ++++++++++++++++++
 2 files changed, 114 insertions(+), 67 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/mfd/lp873x.txt
 create mode 100644 Documentation/devicetree/bindings/mfd/lp873x.yaml

Comments

Krzysztof Kozlowski April 29, 2024, 6:06 a.m. UTC | #1 
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@phytec.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@ti.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
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/mfd/lp873x.txt b/Documentation/devicetree/bindings/mfd/lp873x.txt
deleted file mode 100644
index ae9cf39bd101..000000000000
--- a/Documentation/devicetree/bindings/mfd/lp873x.txt
+++ /dev/null
@@ -1,67 +0,0 @@ 
-TI LP873X PMIC MFD driver
-
-Required properties:
-  - compatible:	"ti,lp8732", "ti,lp8733"
-  - reg:		I2C slave address.
-  - gpio-controller:	Marks the device node as a GPIO Controller.
-  - #gpio-cells:	Should be two.  The first cell is the pin number and
-			the second cell is used to specify flags.
-			See ../gpio/gpio.txt for more information.
-  - xxx-in-supply:	Phandle to parent supply node of each regulator
-			populated under regulators node. xxx can be
-			buck0, buck1, ldo0 or ldo1.
-  - regulators:	List of child nodes that specify the regulator
-			initialization data.
-Example:
-
-pmic: lp8733@60 {
-	compatible = "ti,lp8733";
-	reg = <0x60>;
-	gpio-controller;
-	#gpio-cells = <2>;
-
-	buck0-in-supply = <&vsys_3v3>;
-	buck1-in-supply = <&vsys_3v3>;
-	ldo0-in-supply = <&vsys_3v3>;
-	ldo1-in-supply = <&vsys_3v3>;
-
-	regulators {
-		lp8733_buck0: buck0 {
-			regulator-name = "lp8733-buck0";
-			regulator-min-microvolt = <800000>;
-			regulator-max-microvolt = <1400000>;
-			regulator-min-microamp = <1500000>;
-			regulator-max-microamp = <4000000>;
-			regulator-ramp-delay = <10000>;
-			regulator-always-on;
-			regulator-boot-on;
-		};
-
-		lp8733_buck1: buck1 {
-			regulator-name = "lp8733-buck1";
-			regulator-min-microvolt = <800000>;
-			regulator-max-microvolt = <1400000>;
-			regulator-min-microamp = <1500000>;
-			regulator-max-microamp = <4000000>;
-			regulator-ramp-delay = <10000>;
-			regulator-boot-on;
-			regulator-always-on;
-		};
-
-		lp8733_ldo0: ldo0 {
-			regulator-name = "lp8733-ldo0";
-			regulator-min-microvolt = <800000>;
-			regulator-max-microvolt = <3000000>;
-			regulator-boot-on;
-			regulator-always-on;
-		};
-
-		lp8733_ldo1: ldo1 {
-			regulator-name = "lp8733-ldo1";
-			regulator-min-microvolt = <800000>;
-			regulator-max-microvolt = <3000000>;
-			regulator-always-on;
-			regulator-boot-on;
-		};
-	};
-};
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
@@ -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
+
+maintainers:
+  - J Keerthy <j-keerthy@ti.com>
+
+description: |
+  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
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        i2c@0 {
+            #address-cells = <1>;
+            #size-cells = <0>;
+            reg = <0>;
+
+            pmic: lp8733@60 {
+                compatible = "ti,lp8733";
+                reg = <0x60>;
+                gpio-controller;
+                #gpio-cells = <2>;
+
+                buck0-in-supply = <&vsys_3v3>;
+                buck1-in-supply = <&vsys_3v3>;
+                ldo0-in-supply = <&vsys_3v3>;
+                ldo1-in-supply = <&vsys_3v3>;
+
+                regulators {
+                    lp8733_buck0: buck0 {
+                        regulator-name = "lp8733-buck0";
+                        regulator-min-microvolt = <800000>;
+                        regulator-max-microvolt = <1400000>;
+                        regulator-min-microamp = <1500000>;
+                        regulator-max-microamp = <4000000>;
+                        regulator-ramp-delay = <10000>;
+                        regulator-always-on;
+                        regulator-boot-on;
+                    };
+
+                    lp8733_buck1: buck1 {
+                        regulator-name = "lp8733-buck1";
+                        regulator-min-microvolt = <800000>;
+                        regulator-max-microvolt = <1400000>;
+                        regulator-min-microamp = <1500000>;
+                        regulator-max-microamp = <4000000>;
+                        regulator-ramp-delay = <10000>;
+                        regulator-boot-on;
+                        regulator-always-on;
+                    };
+
+                    lp8733_ldo0: ldo0 {
+                        regulator-name = "lp8733-ldo0";
+                        regulator-min-microvolt = <800000>;
+                        regulator-max-microvolt = <3000000>;
+                        regulator-boot-on;
+                        regulator-always-on;
+                    };
+
+                    lp8733_ldo1: ldo1 {
+                        regulator-name = "lp8733-ldo1";
+                        regulator-min-microvolt = <800000>;
+                        regulator-max-microvolt = <3000000>;
+                        regulator-always-on;
+                        regulator-boot-on;
+                    };
+                };
+            };
+        };
+    };