Re: [PATCH V1 2/2] regulator: aw37503: add device-tree binding

From: Krzysztof Kozlowski
Date: Wed Jul 26 2023 - 07:15:22 EST


On 26/07/2023 10:16, like@xxxxxxxxxx wrote:
> From: Alec Li <like@xxxxxxxxxx>
>
> Add aw37503 regulator device-tree binding documentation

subject rather like:
regulator: dt-bindings: Add Awinic aw37503

>
> Signed-off-by: Alec Li <like@xxxxxxxxxx>
> ---
> .../bindings/regulator/awinic,aw37503.yaml | 73 +++++++++++++++++++
> 1 file changed, 73 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/regulator/awinic,aw37503.yaml
>
> diff --git a/Documentation/devicetree/bindings/regulator/awinic,aw37503.yaml b/Documentation/devicetree/bindings/regulator/awinic,aw37503.yaml
> new file mode 100644
> index 000000000000..0cd6fb001e20
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/awinic,aw37503.yaml
> @@ -0,0 +1,73 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/awinic,aw37503.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Awinic AW37503 Voltage Regulator
> +
> +maintainers:
> + - Alec Li <like@xxxxxxxxxx>
> +
> +description: |

Do not need '|' unless you need to preserve formatting.

> + The AW37503 is dual voltage regulator, designed to support positive/negative
> + supply for driving TFT-LCD panels. It support software-configurable output
> + switching and monitoring. The output voltages can be programmed via an I2C
> + compatible interface.
> +
> +properties:
> + compatible:
> + const:
> + - awinic,aw37503

This has to be in one line. As pointed out by Rob's bot: please test it
before sending.

> +
> + reg:
> + maxItems: 1
> +
> + patternProperties:

<sigh>

> + "^out[pn]$":
> + type: object
> + $ref: regulator.yaml#
> + unvaluatedproperties: false
> +
> + required:
> + - regulator-name
> + - enable-gpios

regulator.yaml does not define enable-gpios, so you must define it in
properties.

> +
> + additionalProperties: false

Drop, you already have unevaluatedProperties.

> +
> +required:
> + - compatible
> + - reg
> + - outp
> + - outn
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + aw37503@3e {

Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation


Best regards,
Krzysztof