Re: [PATCH] dt-bindings: regulator: Convert anatop regulator to json-schema

[Rob Herring]

On Mon, May 18, 2020 at 03:55:05PM +0800, Anson Huang wrote:
> Convert the anatop regulator binding to DT schema format using json-schema.
> 
> Signed-off-by: Anson Huang <Anson.Huang@xxxxxxx>
> ---
>  .../bindings/regulator/anatop-regulator.txt        | 40 ---------
>  .../bindings/regulator/anatop-regulator.yaml       | 94 ++++++++++++++++++++++
>  2 files changed, 94 insertions(+), 40 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/regulator/anatop-regulator.txt
>  create mode 100644 Documentation/devicetree/bindings/regulator/anatop-regulator.yaml
> 
> diff --git a/Documentation/devicetree/bindings/regulator/anatop-regulator.txt b/Documentation/devicetree/bindings/regulator/anatop-regulator.txt
> deleted file mode 100644
> index a3106c7..0000000
> --- a/Documentation/devicetree/bindings/regulator/anatop-regulator.txt
> +++ /dev/null
> @@ -1,40 +0,0 @@
> -Anatop Voltage regulators
> -
> -Required properties:
> -- compatible: Must be "fsl,anatop-regulator"
> -- regulator-name: A string used as a descriptive name for regulator outputs
> -- anatop-reg-offset: Anatop MFD register offset
> -- anatop-vol-bit-shift: Bit shift for the register
> -- anatop-vol-bit-width: Number of bits used in the register
> -- anatop-min-bit-val: Minimum value of this register
> -- anatop-min-voltage: Minimum voltage of this regulator
> -- anatop-max-voltage: Maximum voltage of this regulator
> -
> -Optional properties:
> -- anatop-delay-reg-offset: Anatop MFD step time register offset
> -- anatop-delay-bit-shift: Bit shift for the step time register
> -- anatop-delay-bit-width: Number of bits used in the step time register
> -- vin-supply: The supply for this regulator
> -- anatop-enable-bit: Regulator enable bit offset
> -
> -Any property defined as part of the core regulator
> -binding, defined in regulator.txt, can also be used.
> -
> -Example:
> -
> -	regulator-vddpu {
> -		compatible = "fsl,anatop-regulator";
> -		regulator-name = "vddpu";
> -		regulator-min-microvolt = <725000>;
> -		regulator-max-microvolt = <1300000>;
> -		regulator-always-on;
> -		anatop-reg-offset = <0x140>;
> -		anatop-vol-bit-shift = <9>;
> -		anatop-vol-bit-width = <5>;
> -		anatop-delay-reg-offset = <0x170>;
> -		anatop-delay-bit-shift = <24>;
> -		anatop-delay-bit-width = <2>;
> -		anatop-min-bit-val = <1>;
> -		anatop-min-voltage = <725000>;
> -		anatop-max-voltage = <1300000>;
> -	};
> diff --git a/Documentation/devicetree/bindings/regulator/anatop-regulator.yaml b/Documentation/devicetree/bindings/regulator/anatop-regulator.yaml
> new file mode 100644
> index 0000000..a8c9dd0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/anatop-regulator.yaml
> @@ -0,0 +1,94 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/anatop-regulator.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale Anatop Voltage Regulators
> +
> +maintainers:
> +  - Ying-Chun Liu (PaulLiu) <paul.liu@xxxxxxxxxx>
> +
> +allOf:
> +  - $ref: "regulator.yaml#"
> +
> +properties:
> +  compatible:
> +    const: fsl,anatop-regulator
> +
> +  regulator-name:
> +    $ref: '/schemas/types.yaml#/definitions/string'
> +    description: string used as a descriptive name for regulator outputs

Standard property, right? It already has a definition.

> +
> +  anatop-reg-offset:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the anatop MFD register offset.
> +
> +  anatop-vol-bit-shift:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the bit shift for the register.
> +
> +  anatop-vol-bit-width:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the number of bits used in the register.
> +
> +  anatop-min-bit-val:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the minimum value of this register.
> +
> +  anatop-min-voltage:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the minimum voltage of this regulator.
> +
> +  anatop-max-voltage:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the maximum voltage of this regulator.
> +
> +  anatop-delay-reg-offset:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the anatop MFD step time register offset.
> +
> +  anatop-delay-bit-shift:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the bit shift for the step time register.
> +
> +  anatop-delay-bit-width:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing the number of bits used in the step time register.
> +
> +  anatop-enable-bit:
> +    $ref: '/schemas/types.yaml#/definitions/uint32'
> +    description: u32 value representing regulator enable bit offset.
> +
> +  vin-supply:
> +    $ref: '/schemas/types.yaml#/definitions/phandle'
> +    description: input supply phandle.
> +
> +required:
> +  - compatible
> +  - regulator-name
> +  - anatop-reg-offset
> +  - anatop-vol-bit-shift
> +  - anatop-vol-bit-width
> +  - anatop-min-bit-val
> +  - anatop-min-voltage
> +  - anatop-max-voltage

Add here:

unevaluatedProperties: false

> +
> +examples:
> +  - |
> +    regulator-vddpu {
> +        compatible = "fsl,anatop-regulator";
> +        regulator-name = "vddpu";
> +        regulator-min-microvolt = <725000>;
> +        regulator-max-microvolt = <1300000>;
> +        regulator-always-on;
> +        anatop-reg-offset = <0x140>;
> +        anatop-vol-bit-shift = <9>;
> +        anatop-vol-bit-width = <5>;
> +        anatop-delay-reg-offset = <0x170>;
> +        anatop-delay-bit-shift = <24>;
> +        anatop-delay-bit-width = <2>;
> +        anatop-min-bit-val = <1>;
> +        anatop-min-voltage = <725000>;
> +        anatop-max-voltage = <1300000>;
> +    };
> -- 
> 2.7.4
>