diff mbox series

[v2,1/2] regulator: rt6160: Add DT binding document for Richtek RT6160

Message ID 1621183560-6668-1-git-send-email-u0084500@gmail.com
State Changes Requested
Headers show
Series [v2,1/2] regulator: rt6160: Add DT binding document for Richtek RT6160 | expand

Checks

Context Check Description
robh/checkpatch success
robh/dt-meta-schema success
robh/dtbs-check success

Commit Message

ChiYuan Huang May 16, 2021, 4:45 p.m. UTC
From: ChiYuan Huang <cy_huang@richtek.com>

Add DT binding document for Richtek RT6160 voltage regulator.

Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
---
since v2
- Move buckboost node from patternProperties to Properties.
---
 .../regulator/richtek,rt6160-regulator.yaml        | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml

Comments

Rob Herring May 18, 2021, 1:38 p.m. UTC | #1
On Mon, May 17, 2021 at 12:45:59AM +0800, cy_huang wrote:
> From: ChiYuan Huang <cy_huang@richtek.com>
> 
> Add DT binding document for Richtek RT6160 voltage regulator.
> 
> Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
> ---
> since v2
> - Move buckboost node from patternProperties to Properties.
> ---
>  .../regulator/richtek,rt6160-regulator.yaml        | 67 ++++++++++++++++++++++
>  1 file changed, 67 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml
> 
> diff --git a/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml b/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml
> new file mode 100644
> index 00000000..4ce1f7c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml
> @@ -0,0 +1,67 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/richtek,rt6160-regulator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Richtek RT6160 BuckBoost converter
> +
> +maintainers:
> +  - ChiYuan Huang <cy_huang@richtek.com>
> +
> +description: |
> +  The RT6160 is a high-efficiency buck-boost converter that can provide
> +  up to 3A output current from 2025mV to 5200mV. And it support the wide
> +  input voltage range from 2200mV to 5500mV.
> +
> +  Datasheet is available at
> +  https://www.richtek.com/assets/product_file/RT6160A/DS6160A-00.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - richtek,rt6160
> +
> +  reg:
> +    maxItems: 1
> +
> +  enable-gpios:
> +    description: A connection of the 'enable' gpio line.
> +    maxItems: 1
> +
> +  richtek,vsel_active_low:

richtek,vsel-active-low

> +    description: |
> +      Used to indicate the 'vsel' pin active level. if not specified, use
> +      high active level as the default.
> +    type: boolean
> +
> +  buckboost:

If this is the only regulator, you don't really need a child node here. 
Just move everything up.

> +    description: BuckBoost converter regulator description.
> +    type: object
> +    $ref: regulator.yaml#
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      rt6160@75 {
> +        compatible = "richtek,rt6160";
> +        reg = <0x75>;
> +        enable-gpios = <&gpio26 2 0>;
> +
> +        buckboost {
> +          regulator-name = "rt6160-buckboost";
> +          regulator-min-microvolt = <2025000>;
> +          regulator-max-microvolt = <5200000>;
> +          regulator-allowed-modes = <0 1>;
> +        };
> +      };
> +    };
> -- 
> 2.7.4
>
ChiYuan Huang May 19, 2021, 2:41 a.m. UTC | #2
Hi,

Rob Herring <robh@kernel.org> 於 2021年5月18日 週二 下午9:38寫道:
>
> On Mon, May 17, 2021 at 12:45:59AM +0800, cy_huang wrote:
> > From: ChiYuan Huang <cy_huang@richtek.com>
> >
> > Add DT binding document for Richtek RT6160 voltage regulator.
> >
> > Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
> > ---
> > since v2
> > - Move buckboost node from patternProperties to Properties.
> > ---
> >  .../regulator/richtek,rt6160-regulator.yaml        | 67 ++++++++++++++++++++++
> >  1 file changed, 67 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml b/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml
> > new file mode 100644
> > index 00000000..4ce1f7c
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml
> > @@ -0,0 +1,67 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/regulator/richtek,rt6160-regulator.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Richtek RT6160 BuckBoost converter
> > +
> > +maintainers:
> > +  - ChiYuan Huang <cy_huang@richtek.com>
> > +
> > +description: |
> > +  The RT6160 is a high-efficiency buck-boost converter that can provide
> > +  up to 3A output current from 2025mV to 5200mV. And it support the wide
> > +  input voltage range from 2200mV to 5500mV.
> > +
> > +  Datasheet is available at
> > +  https://www.richtek.com/assets/product_file/RT6160A/DS6160A-00.pdf
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - richtek,rt6160
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  enable-gpios:
> > +    description: A connection of the 'enable' gpio line.
> > +    maxItems: 1
> > +
> > +  richtek,vsel_active_low:
>
> richtek,vsel-active-low
>
Ack in next v3.
> > +    description: |
> > +      Used to indicate the 'vsel' pin active level. if not specified, use
> > +      high active level as the default.
> > +    type: boolean
> > +
> > +  buckboost:
>
> If this is the only regulator, you don't really need a child node here.
> Just move everything up.
>
OK, the original thinking is to separate the node to make the
regulator property more clear.
To put the regulator property up is also good.

I'll refine it and resend the v3 patch series, Thanks.
> > +    description: BuckBoost converter regulator description.
> > +    type: object
> > +    $ref: regulator.yaml#
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    i2c {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +
> > +      rt6160@75 {
> > +        compatible = "richtek,rt6160";
> > +        reg = <0x75>;
> > +        enable-gpios = <&gpio26 2 0>;
> > +
> > +        buckboost {
> > +          regulator-name = "rt6160-buckboost";
> > +          regulator-min-microvolt = <2025000>;
> > +          regulator-max-microvolt = <5200000>;
> > +          regulator-allowed-modes = <0 1>;
> > +        };
> > +      };
> > +    };
> > --
> > 2.7.4
> >
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml b/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml
new file mode 100644
index 00000000..4ce1f7c
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/richtek,rt6160-regulator.yaml
@@ -0,0 +1,67 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/regulator/richtek,rt6160-regulator.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Richtek RT6160 BuckBoost converter
+
+maintainers:
+  - ChiYuan Huang <cy_huang@richtek.com>
+
+description: |
+  The RT6160 is a high-efficiency buck-boost converter that can provide
+  up to 3A output current from 2025mV to 5200mV. And it support the wide
+  input voltage range from 2200mV to 5500mV.
+
+  Datasheet is available at
+  https://www.richtek.com/assets/product_file/RT6160A/DS6160A-00.pdf
+
+properties:
+  compatible:
+    enum:
+      - richtek,rt6160
+
+  reg:
+    maxItems: 1
+
+  enable-gpios:
+    description: A connection of the 'enable' gpio line.
+    maxItems: 1
+
+  richtek,vsel_active_low:
+    description: |
+      Used to indicate the 'vsel' pin active level. if not specified, use
+      high active level as the default.
+    type: boolean
+
+  buckboost:
+    description: BuckBoost converter regulator description.
+    type: object
+    $ref: regulator.yaml#
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      rt6160@75 {
+        compatible = "richtek,rt6160";
+        reg = <0x75>;
+        enable-gpios = <&gpio26 2 0>;
+
+        buckboost {
+          regulator-name = "rt6160-buckboost";
+          regulator-min-microvolt = <2025000>;
+          regulator-max-microvolt = <5200000>;
+          regulator-allowed-modes = <0 1>;
+        };
+      };
+    };