diff mbox series

[v3,1/3] dt-bindings: regulator: document binding for MT6315 regulator

Message ID 1608725624-30594-2-git-send-email-hsin-hsiung.wang@mediatek.com
State Superseded
Headers show
Series Add support for MT6315 regulator | expand

Commit Message

Hsin-Hsiung Wang Dec. 23, 2020, 12:13 p.m. UTC
Add device tree binding information for MT6315 regulator driver.
Example bindings for MT6315 are added.

Signed-off-by: Hsin-Hsiung Wang <hsin-hsiung.wang@mediatek.com>
---
 .../bindings/regulator/mt6315-regulator.yaml  | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml

Comments

Rob Herring (Arm) Dec. 23, 2020, 5:47 p.m. UTC | #1
On Wed, 23 Dec 2020 20:13:42 +0800, Hsin-Hsiung Wang wrote:
> Add device tree binding information for MT6315 regulator driver.
> Example bindings for MT6315 are added.
> 
> Signed-off-by: Hsin-Hsiung Wang <hsin-hsiung.wang@mediatek.com>
> ---
>  .../bindings/regulator/mt6315-regulator.yaml  | 71 +++++++++++++++++++
>  1 file changed, 71 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
./Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml: $id: relative path/filename doesn't match actual path or filename
	expected: http://devicetree.org/schemas/regulator/mt6315-regulator.yaml#
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/regulator/mt6315-regulator.example.dt.yaml: example-0: pmic@6:reg:0: [6, 0, 11, 1] is too long
	From schema: /usr/local/lib/python3.8/dist-packages/dtschema/schemas/reg.yaml

See https://patchwork.ozlabs.org/patch/1420117

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

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.
Rob Herring (Arm) Dec. 31, 2020, 3:44 p.m. UTC | #2
On Wed, Dec 23, 2020 at 08:13:42PM +0800, Hsin-Hsiung Wang wrote:
> Add device tree binding information for MT6315 regulator driver.

> Example bindings for MT6315 are added.

> 

> Signed-off-by: Hsin-Hsiung Wang <hsin-hsiung.wang@mediatek.com>

> ---

>  .../bindings/regulator/mt6315-regulator.yaml  | 71 +++++++++++++++++++

>  1 file changed, 71 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml

> 

> diff --git a/Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml b/Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml

> new file mode 100644

> index 000000000000..15ce83a36174

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml

> @@ -0,0 +1,71 @@

> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/regulator/mtk,mt6315-regulator.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title: Mediatek MT6315 Regulator

> +

> +maintainers:

> +  - Hsin-Hsiung Wang <hsin-hsiung.wang@mediatek.com>

> +

> +description: |

> +  The MT6315 is a power management IC (PMIC) configurable with SPMI.

> +  that contains 4 BUCKs output which can combine with each other

> +  by different efuse settings.

> +

> +properties:

> +  compatible:

> +    const: mediatek,mt6315-regulator

> +

> +  reg:

> +    maxItems: 1

> +

> +  regulators:

> +    type: object

> +    description: List of regulators and its properties

> +

> +    patternProperties:

> +      "^vbuck[1-4]$":

> +        type: object

> +        $ref: "regulator.yaml#"

> +

> +        properties:

> +          regulator-name:

> +            pattern: "^vbuck[1-4]$"

> +            description:

> +              should be "vbuck1", ..., "vbuck4"


The description just repeats what the schema defines. Drop it.

> +

> +    additionalProperties: false

> +

> +required:

> +  - compatible

> +  - reg

> +  - regulators

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    pmic@6 {

> +      compatible = "mediatek,mt6315-regulator";

> +      reg = <0x6 0 0xb 1>;

> +

> +      regulators {

> +        vbuck1 {

> +          regulator-compatible = "vbuck1";

> +          regulator-min-microvolt = <300000>;

> +          regulator-max-microvolt = <1193750>;

> +          regulator-enable-ramp-delay = <256>;

> +          regulator-allowed-modes = <0 1 2 4>;

> +        };

> +

> +        vbuck3 {

> +          regulator-compatible = "vbuck3";

> +          regulator-min-microvolt = <300000>;

> +          regulator-max-microvolt = <1193750>;

> +          regulator-enable-ramp-delay = <256>;

> +          regulator-allowed-modes = <0 1 2 4>;

> +        };

> +      };

> +    };

> -- 

> 2.18.0

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml b/Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml
new file mode 100644
index 000000000000..15ce83a36174
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/mt6315-regulator.yaml
@@ -0,0 +1,71 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/regulator/mtk,mt6315-regulator.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mediatek MT6315 Regulator
+
+maintainers:
+  - Hsin-Hsiung Wang <hsin-hsiung.wang@mediatek.com>
+
+description: |
+  The MT6315 is a power management IC (PMIC) configurable with SPMI.
+  that contains 4 BUCKs output which can combine with each other
+  by different efuse settings.
+
+properties:
+  compatible:
+    const: mediatek,mt6315-regulator
+
+  reg:
+    maxItems: 1
+
+  regulators:
+    type: object
+    description: List of regulators and its properties
+
+    patternProperties:
+      "^vbuck[1-4]$":
+        type: object
+        $ref: "regulator.yaml#"
+
+        properties:
+          regulator-name:
+            pattern: "^vbuck[1-4]$"
+            description:
+              should be "vbuck1", ..., "vbuck4"
+
+    additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - regulators
+
+additionalProperties: false
+
+examples:
+  - |
+    pmic@6 {
+      compatible = "mediatek,mt6315-regulator";
+      reg = <0x6 0 0xb 1>;
+
+      regulators {
+        vbuck1 {
+          regulator-compatible = "vbuck1";
+          regulator-min-microvolt = <300000>;
+          regulator-max-microvolt = <1193750>;
+          regulator-enable-ramp-delay = <256>;
+          regulator-allowed-modes = <0 1 2 4>;
+        };
+
+        vbuck3 {
+          regulator-compatible = "vbuck3";
+          regulator-min-microvolt = <300000>;
+          regulator-max-microvolt = <1193750>;
+          regulator-enable-ramp-delay = <256>;
+          regulator-allowed-modes = <0 1 2 4>;
+        };
+      };
+    };