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

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

[Andreas Klinger]

add dt doc for maxbotix,mb12x2 and also a new vendor prefix maxbotix

Signed-off-by: Andreas Klinger <ak@it-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 @@
+* MaxSonar-I2CXL ultrasonic distance sensor of type mb12x2 using the i2c
+  interface for ranging
+
+Required properties:
+ - compatible:		Should be "maxbotix,mb12x2"
+
+ - 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.
+
+Example:
+mb@70 {
+	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
-- 
2.11.0

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

[Andreas Färber]

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@it-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)