Re: [PATCH v3 3/4] regulator: rt4831: Adds DT binding document for Richtek RT4831 DSV regulator

[Rob Herring]

On Tue, Dec 08, 2020 at 11:54:45PM +0800, cy_huang wrote:
> From: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
> 
> Adds DT binding document for Richtek RT4831 DSV regulator.
> 
> Signed-off-by: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
> ---
> since v3
> - Add dual license tag in regulator binding document.
> - Left regulator dt-binding example only.
> ---
>  .../regulator/richtek,rt4831-regulator.yaml        | 57 ++++++++++++++++++++++
>  1 file changed, 57 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/regulator/richtek,rt4831-regulator.yaml
> 
> diff --git a/Documentation/devicetree/bindings/regulator/richtek,rt4831-regulator.yaml b/Documentation/devicetree/bindings/regulator/richtek,rt4831-regulator.yaml
> new file mode 100644
> index 00000000..c6741f2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/richtek,rt4831-regulator.yaml
> @@ -0,0 +1,57 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/richtek,rt4831-regulator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Richtek RT4831 Display Bias Voltage Regulator
> +
> +maintainers:
> +  - ChiYuan Huang <cy_huang@xxxxxxxxxxx>
> +
> +description: |
> +  RT4831 is a multifunctional device that can provide power to the LCD display
> +  and LCD backlight.
> +
> +  For Display Bias Voltage DSVP and DSVN, the output range is about 4V to 6.5V.
> +  It is sufficient to meet the current LCD power requirement.
> +
> +  DSVLCM is a boost regulator in IC internal as DSVP and DSVN input power.
> +  Its voltage should be configured above 0.15V to 0.2V gap larger than the
> +  voltage needed for DSVP and DSVN. Too much voltage gap could improve the
> +  voltage drop from the heavy loading scenario. But it also make the power
> +  efficiency worse. It's a trade-off.
> +
> +  Datasheet is available at
> +  https://www.richtek.com/assets/product_file/RT4831A/DS4831A-05.pdf
> +
> +patternProperties:
> +  "^DSV(LCM|P|N)$":
> +    type: object
> +    $ref: regulator.yaml#
> +    description:
> +      Properties for single Display Bias Voltage regulator.

Just put this into the MFD schema directly if you don't have any custom 
properties to add.

> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    regulators {
> +      DSVLCM {
> +        regulator-min-microvolt = <4000000>;
> +        regulator-max-microvolt = <7150000>;
> +        regulator-allow-bypass;
> +      };
> +      DSVP {
> +        regulator-name = "rt4831-dsvp";
> +        regulator-min-microvolt = <4000000>;
> +        regulator-max-microvolt = <6500000>;
> +        regulator-boot-on;
> +      };
> +      DSVN {
> +        regulator-name = "rt4831-dsvn";
> +        regulator-min-microvolt = <4000000>;
> +        regulator-max-microvolt = <6500000>;
> +        regulator-boot-on;
> +      };
> +    };
> -- 
> 2.7.4
>