Re: [PATCH 1/2] dt-bindings: regulator: Add bindings for Richtek RT5190A PMIC

[Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>]

On 07/03/2022 11:08, cy_huang wrote:
> From: ChiYuan Huang <cy_huang@richtek.com>
> 
> Add bindings for Richtek RT5190A PMIC.
> 
> Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
> ---
>  .../regulator/richtek,rt5190a-regulator.yaml       | 138 +++++++++++++++++++++
>  1 file changed, 138 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/regulator/richtek,rt5190a-regulator.yaml
> 
> diff --git a/Documentation/devicetree/bindings/regulator/richtek,rt5190a-regulator.yaml b/Documentation/devicetree/bindings/regulator/richtek,rt5190a-regulator.yaml
> new file mode 100644
> index 00000000..b9f5836
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/richtek,rt5190a-regulator.yaml
> @@ -0,0 +1,138 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/richtek,rt5190a-regulator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Richtek RT5190A PMIC Regulator
> +
> +maintainers:
> +  - ChiYuan Huang <cy_huang@richtek.com>
> +
> +description: |
> +  The RT5190A integrates 1 channel buck controller, 3 channels high efficiency
> +  synchronous buck converters, 1 LDO, I2C control interface and peripherial
> +  logical control.
> +
> +  It also supports mute AC OFF depop sound and quick setting storage while
> +  input power is removed.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - richtek,rt5190a
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  vin2-supply:
> +    description: phandle to buck2 input voltage.
> +
> +  vin3-supply:
> +    description: phandle to buck3 input voltage.
> +
> +  vin4-supply:
> +    description: phandle to buck4 input voltage.
> +
> +  vinldo-supply:
> +    description: phandle to ldo input voltage
> +
> +  richtek,buck1-fixed-microvolt:
> +    description: buck1 fixed voltage that depends on the external resistor.
> +    $ref: "/schemas/types.yaml#/definitions/uint32"

You should use standard bindings for it.

> +
> +  richtek,buck4-fixed-microvolt:
> +    description: buck4 fixed voltage that depends on the external resistor.
> +    $ref: "/schemas/types.yaml#/definitions/uint32"
> +
> +  richtek,ldo-fixed-microvolt:
> +    description: ldo fixed voltage that depends on the external resistor.
> +    $ref: "/schemas/types.yaml#/definitions/uint32"
> +
> +  richtek,mute-enable:
> +    description: this can be used to enable mute function.

Please describe what is "mute" function". Your description copied
property name, so it is not useful.

> +    type: boolean
> +
> +  regulators:
> +    type: object
> +
> +    patternProperties:
> +      "^buck[1-4]$|^ldo$":
> +        type: object
> +        $ref: regulator.yaml#
> +        description: |
> +          regulator description for buck[1-4] and ldo.
> +
> +        properties:
> +          richtek,latchup-enable:
> +            type: boolean
> +            description: |
> +              If specified, undervolt protection mode changes from the default
> +              hiccup to latchup.
> +
> +        unevaluatedProperties: false
> +
> +    additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +  - richtek,buck1-fixed-microvolt
> +  - richtek,buck4-fixed-microvolt
> +  - richtek,ldo-fixed-microvolt
> +  - regulators
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      rt5190a@64 {

Generic node name, so "pmic".

> +        compatible = "richtek,rt5190a";
> +        reg = <0x64>;
> +        interrupts-extended = <&gpio26 0 IRQ_TYPE_LEVEL_LOW>;
> +        vin2-supply = <&rt5190_buck1>;
> +        vin3-supply = <&rt5190_buck1>;
> +        vin4-supply = <&rt5190_buck1>;
> +        richtek,buck1-fixed-microvolt = <5090000>;
> +        richtek,buck4-fixed-microvolt = <850000>;
> +        richtek,ldo-fixed-microvolt = <1200000>;
> +
> +        regulators {
> +          rt5190_buck1: buck1 {
> +            regulator-name = "rt5190a-buck1";
> +            regulator-allowed-modes = <0 1>;

Please describe these in header file in bindings and mention as one of
regulator properties with description and enum.



Best regards,
Krzysztof