linux-input.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
To: "Nuno Sá" <nuno.sa@analog.com>,
	linux-gpio@vger.kernel.org, linux-input@vger.kernel.org,
	devicetree@vger.kernel.org
Cc: Linus Walleij <linus.walleij@linaro.org>,
	Rob Herring <robh+dt@kernel.org>,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	Bartosz Golaszewski <brgl@bgdev.pl>,
	Michael Hennerich <michael.hennerich@analog.com>,
	Andy Shevchenko <andy.shevchenko@gmail.com>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
Subject: Re: [PATCH v2 05/10] dt-bindings: input: adp5588-keys: add bindings
Date: Mon, 18 Jul 2022 16:27:10 +0200	[thread overview]
Message-ID: <1c73fe9e-81f8-3ecd-edd1-60e6ddd548f3@linaro.org> (raw)
In-Reply-To: <20220715125138.378632-6-nuno.sa@analog.com>

On 15/07/2022 14:51, Nuno Sá wrote:
> Add device tree bindings for the adp5588-keys driver.
> 
> Signed-off-by: Nuno Sá <nuno.sa@analog.com>
> ---
>  .../bindings/input/adi,adp5588-keys.yaml      | 110 ++++++++++++++++++
>  MAINTAINERS                                   |   1 +
>  2 files changed, 111 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/adi,adp5588-keys.yaml

Thank you for your patch. There is something to discuss/improve.

> 
> diff --git a/Documentation/devicetree/bindings/input/adi,adp5588-keys.yaml b/Documentation/devicetree/bindings/input/adi,adp5588-keys.yaml
> new file mode 100644
> index 000000000000..0d262b42150a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/adi,adp5588-keys.yaml
> @@ -0,0 +1,110 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/adi,adp5588-keys.yaml#

Is ADP5588 a multi-function device? If not, I propose to drop the "keys"
suffix.

> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices ADP5588 Keypad Controller
> +
> +maintainers:
> +  - Nuno Sá <nuno.sa@analog.com>
> +
> +description: |
> +  Analog Devices Mobile I/O Expander and QWERTY Keypad Controller
> +  https://www.analog.com/media/en/technical-documentation/data-sheets/ADP5588.pdf
> +
> +allOf:
> +  - $ref: matrix-keymap.yaml#
> +  - $ref: input.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,adp5588
> +      - adi,adp5587

Bring some order, like alphabetical.

> +
> +  reg:
> +    maxItems: 1
> +
> +  vcc-supply:
> +    description: Supply Voltage Input
> +
> +  reset-gpios:
> +    description:
> +      If specified, it will be asserted during driver probe. As the line is
> +      active low, it should be marked GPIO_ACTIVE_LOW.
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  gpio-controller:
> +    description:
> +      This property applies if either keypad,num-rows lower than 8 or
> +      keypad,num-columns lower than 10.
> +
> +  '#gpio-cells':
> +    const: 2
> +
> +  interrupt-controller:
> +    description:
> +      This property applies if either keypad,num-rows lower than 8 or
> +      keypad,num-columns lower than 10.
> +
> +  '#interrupt-cells':
> +    const: 2
> +
> +  adi,unlock-keys:
> +    description:
> +      Specifies a maximum of 2 keys that can be used to unlock the keypad.
> +      If this property is set, the keyboard will be locked and only unlocked
> +      after these keys are pressed. If only one key is set, a double click is
> +      needed to unlock the keypad.
> +    $ref: /schemas/types.yaml#/definitions/uint32-array
> +    minItems: 1
> +    maxItems: 2

What are the values/units? keycodes? If so, maybe "adi,unlock-keycodes"
and add limit on values (like linux,keycodes).

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - keypad,num-rows
> +  - keypad,num-columns
> +  - linux,keymap
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/input/input.h>
> +    #include <dt-bindings/gpio/gpio.h>
> +    i2c {
> +          #address-cells = <1>;

Wrong indentation. 4 spaces for DTS example.

> +          #size-cells = <0>;
> +
> +          adp5588@34 {

Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation


Best regards,
Krzysztof

  reply	other threads:[~2022-07-18 14:27 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-15 12:51 [PATCH v2 00/10] adp5588-keys refactor and fw properties support Nuno Sá
2022-07-15 12:51 ` [PATCH v2 01/10] input: keyboard: adp5588-keys: support gpi key events as 'gpio keys' Nuno Sá
2022-07-15 18:59   ` Andy Shevchenko
2022-07-18  8:07     ` Nuno Sá
2022-07-15 12:51 ` [PATCH v2 02/10] gpio: gpio-adp5588: drop the driver Nuno Sá
2022-07-15 12:51 ` [PATCH v2 03/10] input: keyboard: adp5588-keys: bail out on returned error Nuno Sá
2022-07-15 12:51 ` [PATCH v2 04/10] input: keyboard: adp5588-keys: add support for fw properties Nuno Sá
2022-07-15 12:51 ` [PATCH v2 05/10] dt-bindings: input: adp5588-keys: add bindings Nuno Sá
2022-07-18 14:27   ` Krzysztof Kozlowski [this message]
2022-07-18 14:52     ` Nuno Sá
2022-07-15 12:51 ` [PATCH v2 06/10] input: keyboard: adp5588-keys: do not check for irq presence Nuno Sá
2022-07-15 12:51 ` [PATCH v2 07/10] input: keyboard: adp5588-keys: fix coding style warnings Nuno Sá
2022-07-15 12:51 ` [PATCH v2 08/10] input: keyboard: adp5588-keys: add optional reset gpio Nuno Sá
2022-07-15 12:51 ` [PATCH v2 09/10] input: keyboard: adp5588-keys: add regulator support Nuno Sá
2022-07-15 12:51 ` [PATCH v2 10/10] input: keyboard: adp5588-keys: Use new PM macros Nuno Sá
2022-07-15 19:03 ` [PATCH v2 00/10] adp5588-keys refactor and fw properties support Andy Shevchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1c73fe9e-81f8-3ecd-edd1-60e6ddd548f3@linaro.org \
    --to=krzysztof.kozlowski@linaro.org \
    --cc=andy.shevchenko@gmail.com \
    --cc=brgl@bgdev.pl \
    --cc=devicetree@vger.kernel.org \
    --cc=dmitry.torokhov@gmail.com \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=michael.hennerich@analog.com \
    --cc=nuno.sa@analog.com \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).