linux-kernel - Re: [PATCH 1/4] maxbotix,mb12x2.txt: add dt doc for maxbotix,mb12x2

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] [day] [month] [year] [list]

Message-ID: <5c2efbb1-e243-a272-5106-9cd279d1c973@suse.de>
Date:   Sun, 24 Feb 2019 17:51:53 +0100
From:   Andreas Färber <afaerber@...e.de>
To:     Andreas Klinger <ak@...klinger.de>
Cc:     arnd@...db.de, davem@...emloft.net, devicetree@...r.kernel.org,
        gregkh@...uxfoundation.org, jic23@...nel.org, johan@...nel.org,
        khilman@...libre.com, knaack.h@....de, lars@...afoo.de,
        linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org,
        mark.rutland@....com, martin.blumenstingl@...glemail.com,
        mchehab+samsung@...nel.org, m.othacehe@...il.com,
        nicolas.ferre@...rochip.com, pmeerw@...erw.net, robh+dt@...nel.org,
        robh@...nel.org, songqiang1304521@...il.com, treding@...dia.com
Subject: Re: [PATCH 1/4] maxbotix,mb12x2.txt: add dt doc for maxbotix,mb12x2

Hi Andreas,

Am 24.02.19 um 17:22 schrieb Andreas Klinger:
> add dt doc for maxbotix,mb12x2 and also a new vendor prefix maxbotix

Please don't mix the two.
The subject prefix should be "dt-bindings:". Please compare git log.
And please avoid putting the whole world in To rather than CC.

> 
> Signed-off-by: Andreas Klinger <ak@...klinger.de>
> ---
>  .../bindings/iio/proximity/maxbotix,mb12x2.txt     | 22 ++++++++++++++++++++++
>  .../devicetree/bindings/vendor-prefixes.txt        |  1 +
>  2 files changed, 23 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb12x2.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb12x2.txt b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb12x2.txt
> new file mode 100644
> index 000000000000..29f7fc09cfdc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb12x2.txt
> @@ -0,0 +1,22 @@

You're aware that a conversion from txt to YAML was under way?

> +* MaxSonar-I2CXL ultrasonic distance sensor of type mb12x2 using the i2c
> +  interface for ranging
> +
> +Required properties:
> + - compatible:		Should be "maxbotix,mb12x2"

Is that really the model name with x? No wildcards as compatible please.

> +
> + - reg:			i2c address of the device
> +
> +Optional properties:
> + - status-gpios:	Definition of the status gpio (input) which is used
> +			to announce the preceding reading request has
> +			finished and that data is available. If no status
> +			gpio is specified the device driver falls back to
> +			wait a certain amount of time (15 ms) until data
> +			can be retrieved.

That sounds like an implementation detail that should not be part of the
binding? It at least needs to be reworded.

> +
> +Example:
> +mb@70 {

Please use a generic node name - maybe proximity? Check other examples.

> +	compatible = "maxbotix,mb12x2";
> +	reg = <0x70>;
> +	status-gpios = <&gpio2 2 GPIO_ACTIVE_HIGH>;
> +};
> diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt
> index 389508584f48..added54a1108 100644
> --- a/Documentation/devicetree/bindings/vendor-prefixes.txt
> +++ b/Documentation/devicetree/bindings/vendor-prefixes.txt
> @@ -225,6 +225,7 @@ lsi	LSI Corp. (LSI Logic)
>  lwn	Liebherr-Werk Nenzing GmbH
>  macnica	Macnica Americas
>  marvell	Marvell Technology Group Ltd.
> +maxbotix	MaxBotix Inc.
>  maxim	Maxim Integrated Products
>  mbvl	Mobiveil Inc.
>  mcube	mCube

This part looks fine and could get my Reviewed-by if you split it off as
"dt-bindings: Add vendor prefix for MaxBotix" and add a sentence about
the company in its commit message.

You might want to CC the vendor, if you're not contracted by them.

Regards,
Andreas

-- 
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Felix Imendörffer, Jane Smithard, Graham Norton
HRB 21284 (AG Nürnberg)