Re: [PATCH v1 14/15] dt-bindings: auxdisplay: Add Maxim MAX6958/6959

From: Krzysztof Kozlowski
Date: Fri Feb 09 2024 - 03:03:01 EST


On 08/02/2024 19:48, Andy Shevchenko wrote:
> Add initial device tree documentation for Maxim MAX6958/6959.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
> ---
> .../bindings/auxdisplay/maxim,max6959.yaml | 35 +++++++++++++++++++
> 1 file changed, 35 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/auxdisplay/maxim,max6959.yaml
>
> diff --git a/Documentation/devicetree/bindings/auxdisplay/maxim,max6959.yaml b/Documentation/devicetree/bindings/auxdisplay/maxim,max6959.yaml
> new file mode 100644
> index 000000000000..49ce26176797
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/auxdisplay/maxim,max6959.yaml
> @@ -0,0 +1,35 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/auxdisplay/maxim,max6959.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MAX6958/6959 7-segment LED display controller with keyscan
> +
> +maintainers:
> + - Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
> +

Please describe the device, e.g. bus/interface.

> +properties:
> + compatible:
> + const: maxim,max6959

Your title said also max6958, so I would expect it to be here as well.
Cam be followed by 6959 fallback compatible, if they are compatible.

> +
> + reg:
> + maxItems: 1

No power supplies? No reset pins?

> +
> +required:
> + - compatible
> + - reg
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + i2c {
> + #address-cells = <1>;

Use 4 spaces for example indentation. 2 is also fine.

> + #size-cells = <0>;
> +
> + max6959: max6959@38 {

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
e.g. display-controller or display

> + compatible = "maxim,max6959";
> + reg = <0x38>;
> + };
> + };

Best regards,
Krzysztof