linux-kernel - Re: [PATCH v1 2/2] dt-bindings:iio:proximity: Add hx9031as binding

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: <18b7ea5a-ea10-47b6-9d86-9dcec50e5f9e@kernel.org>
Date: Sun, 16 Jun 2024 09:47:16 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: Yasin Lee <yasin.lee.x@...look.com>, jic23@...nel.org
Cc: andy.shevchenko@...il.com, lars@...afoo.de, linux-iio@...r.kernel.org,
 linux-kernel@...r.kernel.org, nuno.a@...log.com, swboyd@...omium.org,
 u.kleine-koenig@...gutronix.de, yasin.lee.x@...il.com
Subject: Re: [PATCH v1 2/2] dt-bindings:iio:proximity: Add hx9031as binding

On 15/05/2024 10:06, Krzysztof Kozlowski wrote:
> On 14/05/2024 22:25, Yasin Lee wrote:
>> From: Yasin Lee <yasin.lee.x@...il.com>
>>
>> A capacitive proximity sensor with 5 channels
>>
>> Signed-off-by: Yasin Lee <yasin.lee.x@...il.com>
> 
> Do not attach (thread) your patchsets to some other threads (unrelated
> or older versions). This buries them deep in the mailbox and might
> interfere with applying entire sets.

Did you implement this?

> 
> A nit, subject: drop second/last, redundant "bindings". The
> "dt-bindings" prefix is already stating that these are bindings.
> See also:
> https://elixir.bootlin.com/linux/v6.7-rc8/source/Documentation/devicetree/bindings/submitting-patches.rst#L18

Did you implement this?

> 
> Subject: missing spaces. See  `git log --oneline -- DIRECTORY_OR_FILE`
> on the directory your patch is touching.

Did you implement this?


> 
> 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.
> 
> Tools like b4 or scripts/get_maintainer.pl provide you proper list of
> people, so fix your workflow. Tools might also fail if you work on some
> ancient tree (don't, instead use mainline), work on fork of kernel
> (don't, instead use mainline) or you ignore some maintainers (really
> don't). Just use b4 and everything should be fine, although remember
> about `b4 prep --auto-to-cc` if you added new patches to the patchset.
> 
> You missed at least devicetree 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.

Did you implement this?


> 
> Limited review follows.
> 
>> ---
>>  .../bindings/iio/proximity/tyhx,hx9031as.yaml | 60 +++++++++++++++++++
>>  .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
>>  2 files changed, 62 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/iio/proximity/tyhx,hx9031as.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/iio/proximity/tyhx,hx9031as.yaml b/Documentation/devicetree/bindings/iio/proximity/tyhx,hx9031as.yaml
>> new file mode 100644
>> index 000000000000..62a71c0c4d04
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/iio/proximity/tyhx,hx9031as.yaml
>> @@ -0,0 +1,60 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/iio/proximity/tyhx,hx9031as.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Tyhx's HX9031AS capacitive proximity sensor
>> +
>> +maintainers:
>> +  - Yasin Lee <yasin.lee.x@...il.com>
>> +
>> +description: |
>> +  Tyhx's HX9031AS proximity sensor.
>> +
>> +allOf:
>> +  - $ref: /schemas/iio/iio.yaml#
>> +
>> +properties:
>> +  compatible:
>> +    const: tyhx,hx9031as
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    description:
>> +      Generated by device to announce preceding read request has finished
>> +      and data is available or that a close/far proximity event has happened.
>> +    maxItems: 1
>> +
>> +  vdd-supply:
>> +    description: Main power supply
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +unevaluatedProperties: false
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/interrupt-controller/irq.h>
>> +    i2c {
>> +      #address-cells = <1>;
>> +      #size-cells = <0>;
>> +      hx9031as@2a {
> 
> 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

Did you implement this?

> 
> 
>> +        compatible = "tyhx,hx9031as";
>> +        reg = <0x2a>;
>> +        interrupt-parent = <&pio>;
>> +        interrupts = <16 IRQ_TYPE_EDGE_FALLING 16 0>;
>> +        vdd-supply = <&pp3300_a>;
>> +        status = "okay";
> 
> Drop

Did you implement this?

> 
>> +      };
>> +    };
>> +
>> +
>> +
>> +
>> +
>> +
> 
> Drop useless blank lines...

Did you implement this?


Best regards,
Krzysztof