linux-kernel - Re: [PATCH 1/2] devicetree: bindings: Add keypad driver ducumentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <3f17d903-20c4-59ac-f52b-ed108fe9475f@kernel.org>
Date:   Wed, 9 Aug 2023 20:31:14 +0200
From:   Krzysztof Kozlowski <krzk@...nel.org>
To:     Wenhua Lin <Wenhua.Lin@...soc.com>,
        Dmitry Torokhov <dmitry.torokhov@...il.com>,
        Jonathan Cameron <Jonathan.Cameron@...wei.com>,
        Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
        Nuno Sá <nuno.sa@...log.com>,
        Arnd Bergmann <arnd@...db.de>,
        Samuel Holland <samuel@...lland.org>,
        Robert Jarzmik <robert.jarzmik@...e.fr>,
        Mattijs Korpershoek <mkorpershoek@...libre.com>,
        Bartosz Golaszewski <bartosz.golaszewski@...aro.org>,
        Orson Zhai <orsonzhai@...il.com>,
        Baolin Wang <baolin.wang@...ux.alibaba.com>,
        Chunyan Zhang <zhang.lyra@...il.com>
Cc:     linux-serial@...r.kernel.org, linux-kernel@...r.kernel.org,
        wenhua lin <wenhua.lin1994@...il.com>,
        Xiongpeng Wu <xiongpeng.wu@...soc.com>
Subject: Re: [PATCH 1/2] devicetree: bindings: Add keypad driver ducumentation

On 08/08/2023 09:22, Wenhua Lin wrote:
> Add keypad driver ducumentation.

1. Please use scripts/get_maintainers.pl to get a list of necessary
people and lists to CC. It might happen, that command when run on an
older kernel, gives you outdated entries. Therefore please be sure you
base your patches on recent Linux kernel.

You missed at least DT list (maybe more), so this won't be tested by
automated tooling. Performing review on untested code might be a waste
of time, thus I will skip this patch entirely till you follow the
process allowing the patch to be tested.

Please kindly resend and include all necessary To/Cc entries.

2. 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.

Limited review follows:

> 
> Signed-off-by: Wenhua Lin <Wenhua.Lin@...soc.com>
> ---
>  .../bindings/input/sprd-keypad.yaml           | 76 +++++++++++++++++++
>  1 file changed, 76 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/sprd-keypad.yaml

Filename matching compatible, so sprd,block-name-etc.yaml

> 
> diff --git a/Documentation/devicetree/bindings/input/sprd-keypad.yaml b/Documentation/devicetree/bindings/input/sprd-keypad.yaml
> new file mode 100644
> index 000000000000..51710e1eb389
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/sprd-keypad.yaml
> @@ -0,0 +1,76 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright 2023 Unisoc Inc.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/sprd-keypad.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Device-Tree bindings for GPIO attached keys

This should not work and you should see warnings... which means:

It does not look like you tested the bindings, at least after quick
look. Please run `make dt_binding_check` (see
Documentation/devicetree/bindings/writing-schema.rst for instructions).
Maybe you need to update your dtschema and yamllint.

so drop "Device-tree bindings".

Title also says nothing about the hardware - it is entirely unrelated.
Describe the hardware.

> +
> +maintainers:
> +  - Orson Zhai <orsonzhai@...il.com>
> +  - Baolin Wang <baolin.wang7@...il.com>
> +  - Chunyan Zhang <zhang.lyra@...il.com>
> +
> +description: |
> +    Keypad controller is used to interface a SoC with a matrix-keypad device.

Mention which SoC.

> +    The keypad controller supports multiple row and column lines.
> +    A key can be placed at each intersection of a unique row and a unique column.
> +    The keypad controller can sense a key-press and key-release and report the
> +    event using a interrupt to the cpu.
> +
> +properties:
> +    compatible:
> +    const: sprd,sc9860-keypad
> +
> +    reg:
> +        maxItems: 1

OK, so this was for 100% not tested and won't work. No need to waste our
time on this. Test before sending:

It does not look like you tested the bindings, at least after quick
look. Please run `make dt_binding_check` (see
Documentation/devicetree/bindings/writing-schema.rst for instructions).
Maybe you need to update your dtschema and yamllint.

Best regards,
Krzysztof