Re: [PATCH 1/8] dt-bindings: Add MAX7360 MFD device

From: Krzysztof Kozlowski
Date: Sat Dec 21 2024 - 15:29:07 EST


On 19/12/2024 17:21, Mathieu Dubois-Briand wrote:
> Add device tree bindings for Maxim Integrated MAX7360 MFD device with
> support for keypad, rotary, gpios and pwm functionalities.

Please use subject prefixes matching the subsystem. You can get them for
example with `git log --oneline -- DIRECTORY_OR_FILE` on the directory
your patch is touching. For bindings, the preferred subjects are
explained here:
https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters

Subject/commit msg: drop MFD and explain what the hardware is. MFD is
Linuxism.

>
> Signed-off-by: Mathieu Dubois-Briand <mathieu.dubois-briand@xxxxxxxxxxx>
> ---
> Documentation/devicetree/bindings/mfd/max7360.yaml | 56 ++++++++++++++++++++++

Use compatible as filename.
> 1 file changed, 56 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/mfd/max7360.yaml b/Documentation/devicetree/bindings/mfd/max7360.yaml
> new file mode 100644
> index 000000000000..49dd437fd313
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/max7360.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mfd/max7360.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Maxim MAX7360 Keypad, Rotary encoder, PWM and GPIO controller
> +
> +maintainers:
> + - Kamel Bouhara <kamel.bouhara@xxxxxxxxxxx>
> + - Mathieu Dubois-Briand <mathieu.dubois-briand@xxxxxxxxxxx>
> +
> +description: |
> + Maxim MAX7360 MFD device, with following functions:
> + - keypad controller
> + - rotary controller
> + - GPIO and GPO controller
> + - PWM controller
> +
> + https://www.analog.com/en/products/max7360.html
> +
> +properties:
> + compatible:
> + enum:
> + - maxim,max7360
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + description: The interrupt line the device is connected to.

Drop description,

> + maxItems: 1

I don't think this was tested at all. It is heavily incomplete,
considering this is sort of MFD device.

Or you split patches in odd way. Look how other PMIC-style things are
upstreamed.

> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + max7360@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


> + compatible = "maxim,max7360";
> + reg = <0x38>;
> +
Best regards,
Krzysztof