[v5,1/4] dt-bindings: mfd: Add Analog Devices ADP5585

The ADP5585 is a 10/11 input/output port expander with a built in keypad
matrix decoder, programmable logic, reset generator, and PWM generator.
These bindings model the device as an MFD, and support the GPIO expander
and PWM functions.

These bindings support the GPIO and PWM functions.

Drop the existing adi,adp5585 and adi,adp5585-02 compatible strings from
trivial-devices.yaml. They have been added there by mistake as the
driver that was submitted at the same time used different compatible
strings. We can take them over safely.

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
I've limited the bindings to GPIO and PWM as I lack hardware to design,
implement and test the rest of the features the chip supports.

Changes since v4:

- Drop the right comment in trivial-devices.yaml

Changes since v3:

- Fix prefix and drop redundant text in subject line
- Rename node in example from mfd@ to io-expander@

Changes since v2:

- Drop gpio property from required
- Drop second example

Changes since v1:

- Squash "dt-bindings: trivial-devices: Drop adi,adp5585 and
  adi,adp5585-02" into this patch
- Merge child nodes into parent node
---
 .../devicetree/bindings/mfd/adi,adp5585.yaml  | 90 +++++++++++++++++++
 .../devicetree/bindings/trivial-devices.yaml  |  4 -
 MAINTAINERS                                   |  7 ++
 3 files changed, 97 insertions(+), 4 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/mfd/adi,adp5585.yaml

On Fri, 19 Jul 2024 23:39:43 +0300, Laurent Pinchart wrote:
> The ADP5585 is a 10/11 input/output port expander with a built in keypad
> matrix decoder, programmable logic, reset generator, and PWM generator.
> These bindings model the device as an MFD, and support the GPIO expander
> and PWM functions.
> 
> These bindings support the GPIO and PWM functions.
> 
> Drop the existing adi,adp5585 and adi,adp5585-02 compatible strings from
> trivial-devices.yaml. They have been added there by mistake as the
> driver that was submitted at the same time used different compatible
> strings. We can take them over safely.
> 
> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
> I've limited the bindings to GPIO and PWM as I lack hardware to design,
> implement and test the rest of the features the chip supports.
> 
> Changes since v4:
> 
> - Drop the right comment in trivial-devices.yaml
> 
> Changes since v3:
> 
> - Fix prefix and drop redundant text in subject line
> - Rename node in example from mfd@ to io-expander@
> 
> Changes since v2:
> 
> - Drop gpio property from required
> - Drop second example
> 
> Changes since v1:
> 
> - Squash "dt-bindings: trivial-devices: Drop adi,adp5585 and
>   adi,adp5585-02" into this patch
> - Merge child nodes into parent node
> ---
>  .../devicetree/bindings/mfd/adi,adp5585.yaml  | 90 +++++++++++++++++++
>  .../devicetree/bindings/trivial-devices.yaml  |  4 -
>  MAINTAINERS                                   |  7 ++
>  3 files changed, 97 insertions(+), 4 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/mfd/adi,adp5585.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/mfd/adi,adp5585.example.dtb: io-expander@34: gpio-reserved-ranges:0: 5 was expected
	from schema $id: http://devicetree.org/schemas/mfd/adi,adp5585.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/mfd/adi,adp5585.example.dtb: io-expander@34: gpio-reserved-ranges: [[5, 1]] is too short
	from schema $id: http://devicetree.org/schemas/mfd/adi,adp5585.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20240719203946.22909-2-laurent.pinchart@ideasonboard.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.

On 19/07/2024 22:39, Laurent Pinchart wrote:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  vdd-supply: true
> +
> +  gpio-controller: true
> +
> +  '#gpio-cells':
> +    const: 2
> +
> +  gpio-reserved-ranges: true
> +
> +  "#pwm-cells":
> +    const: 3
> +
> +required:
> +  - compatible
> +  - reg
> +  - gpio-controller
> +  - "#gpio-cells"
> +  - "#pwm-cells"
> +
> +allOf:
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            const: adi,adp5585-01
> +    then:
> +      properties:
> +        gpio-reserved-ranges: false
> +    else:
> +      properties:
> +        gpio-reserved-ranges:
> +          items:
> +            - const: 5
> +            - const: 1

Why reserved ranges are fixed? If they pins are *always* not accessible,
then these are not GPIOs. This really looks incorrect.

Anyway, testing reports failures which *must* be addressed, one way or
another.


Best regards,
Krzysztof

Hi Krzysztof,

On Sun, Jul 21, 2024 at 11:23:12AM +0200, Krzysztof Kozlowski wrote:
> On 19/07/2024 22:39, Laurent Pinchart wrote:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  vdd-supply: true
> > +
> > +  gpio-controller: true
> > +
> > +  '#gpio-cells':
> > +    const: 2
> > +
> > +  gpio-reserved-ranges: true
> > +
> > +  "#pwm-cells":
> > +    const: 3
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - gpio-controller
> > +  - "#gpio-cells"
> > +  - "#pwm-cells"
> > +
> > +allOf:
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          contains:
> > +            const: adi,adp5585-01
> > +    then:
> > +      properties:
> > +        gpio-reserved-ranges: false
> > +    else:
> > +      properties:
> > +        gpio-reserved-ranges:
> > +          items:
> > +            - const: 5
> > +            - const: 1
> 
> Why reserved ranges are fixed? If they pins are *always* not accessible,
> then these are not GPIOs. This really looks incorrect.

It's model-dependent. The ADP5585 has 11 pins that can be used as GPIOs.
They are named GPIO 1 to GPIO 11 in the datasheet. The -01 variant uses
the pin associated with GPIO 6 for a different purpose, so GPIO 6 is not
usable. That maps to index 5 as GPIO numbers in DT bindings are 0-based.
I've decided to handle that as a reserved GPIO range to keep the GPIO 7
to GPIO 11 indices the same across all ADP5585 variants.

> Anyway, testing reports failures which *must* be addressed, one way or
> another.

Yes I'll fix that.

On 21/07/2024 11:45, Laurent Pinchart wrote:
> Hi Krzysztof,
> 
> On Sun, Jul 21, 2024 at 11:23:12AM +0200, Krzysztof Kozlowski wrote:
>> On 19/07/2024 22:39, Laurent Pinchart wrote:
>>> +    maxItems: 1
>>> +
>>> +  interrupts:
>>> +    maxItems: 1
>>> +
>>> +  vdd-supply: true
>>> +
>>> +  gpio-controller: true
>>> +
>>> +  '#gpio-cells':
>>> +    const: 2
>>> +
>>> +  gpio-reserved-ranges: true
>>> +
>>> +  "#pwm-cells":
>>> +    const: 3
>>> +
>>> +required:
>>> +  - compatible
>>> +  - reg
>>> +  - gpio-controller
>>> +  - "#gpio-cells"
>>> +  - "#pwm-cells"
>>> +
>>> +allOf:
>>> +  - if:
>>> +      properties:
>>> +        compatible:
>>> +          contains:
>>> +            const: adi,adp5585-01
>>> +    then:
>>> +      properties:
>>> +        gpio-reserved-ranges: false
>>> +    else:
>>> +      properties:
>>> +        gpio-reserved-ranges:
>>> +          items:
>>> +            - const: 5
>>> +            - const: 1
>>
>> Why reserved ranges are fixed? If they pins are *always* not accessible,
>> then these are not GPIOs. This really looks incorrect.
> 
> It's model-dependent. The ADP5585 has 11 pins that can be used as GPIOs.
> They are named GPIO 1 to GPIO 11 in the datasheet. The -01 variant uses
> the pin associated with GPIO 6 for a different purpose, so GPIO 6 is not
> usable. That maps to index 5 as GPIO numbers in DT bindings are 0-based.
> I've decided to handle that as a reserved GPIO range to keep the GPIO 7
> to GPIO 11 indices the same across all ADP5585 variants.

Ah, I missed the fact that gpio-reserved-ranges are not required, so
some of variants can just skip it. It's fine.

Best regards,
Krzysztof