diff mbox series

[v3,2/4] dt-bindings: maxbotix,mb1232: Add MaxBotix i2c ultrasonic rangers

Message ID 20190317203526.4pcwo4gdrrng44v7@arbad (mailing list archive)
State New, archived
Headers show
Series add MaxBotix I2CXL ultrasonic iio driver | expand

Commit Message

Andreas Klinger March 17, 2019, 8:35 p.m. UTC
Add doc for dt binding maxbotix,mb1232. This binding is for MaxBotix
I2CXL-MaxSonar ultrasonic rangers which share a common i2c interface.

Signed-off-by: Andreas Klinger <ak@it-klinger.de>
---
 .../bindings/iio/proximity/maxbotix,mb1232.txt     | 31 ++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt

Comments

Jonathan Cameron March 24, 2019, 12:03 p.m. UTC | #1
On Sun, 17 Mar 2019 21:35:27 +0100
Andreas Klinger <ak@it-klinger.de> wrote:

> Add doc for dt binding maxbotix,mb1232. This binding is for MaxBotix
> I2CXL-MaxSonar ultrasonic rangers which share a common i2c interface.
> 
> Signed-off-by: Andreas Klinger <ak@it-klinger.de>
This seems pretty straight forward so I'll apply it to the togreg branch
of iio.git and push out as testing.  Still time for any feedback from
Rob or others though before this goes out as non rebasing.

Thanks,

Jonathan

> ---
>  .../bindings/iio/proximity/maxbotix,mb1232.txt     | 31 ++++++++++++++++++++++
>  1 file changed, 31 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> new file mode 100644
> index 000000000000..0e9df87eca1d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> @@ -0,0 +1,31 @@
> +* MaxBotix I2CXL-MaxSonar ultrasonic distance sensor of type  mb1202,
> +  mb1212, mb1222, mb1232, mb1242, mb7040 or mb7137 using the i2c interface
> +  for ranging
> +
> +Required properties:
> + - compatible:		"maxbotix,mb1202",
> +			"maxbotix,mb1212",
> +			"maxbotix,mb1222",
> +			"maxbotix,mb1232",
> +			"maxbotix,mb1242",
> +			"maxbotix,mb7040" or
> +			"maxbotix,mb7137"
> +
> + - reg:			i2c address of the device, see also i2c/i2c.txt
> +
> +Optional properties:
> + - interrupt-parent:	Interrupt controller to use
> +
> + - interrupts:		Interrupt used to announce the preceding reading
> +			request has finished and that data is available.
> +			If no interrupt is specified the device driver
> +			falls back to wait a fixed amount of time until
> +			data can be retrieved.
> +
> +Example:
> +proximity@70 {
> +	compatible = "maxbotix,mb1232";
> +	reg = <0x70>;
> +	interrupt-parent = <&gpio2>;
> +	interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
> +};
Rob Herring (Arm) March 28, 2019, 5:51 p.m. UTC | #2
On Sun, Mar 17, 2019 at 09:35:27PM +0100, Andreas Klinger wrote:
> Add doc for dt binding maxbotix,mb1232. This binding is for MaxBotix
> I2CXL-MaxSonar ultrasonic rangers which share a common i2c interface.
> 
> Signed-off-by: Andreas Klinger <ak@it-klinger.de>
> ---
>  .../bindings/iio/proximity/maxbotix,mb1232.txt     | 31 ++++++++++++++++++++++
>  1 file changed, 31 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> new file mode 100644
> index 000000000000..0e9df87eca1d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> @@ -0,0 +1,31 @@
> +* MaxBotix I2CXL-MaxSonar ultrasonic distance sensor of type  mb1202,
> +  mb1212, mb1222, mb1232, mb1242, mb7040 or mb7137 using the i2c interface
> +  for ranging
> +
> +Required properties:
> + - compatible:		"maxbotix,mb1202",
> +			"maxbotix,mb1212",
> +			"maxbotix,mb1222",
> +			"maxbotix,mb1232",
> +			"maxbotix,mb1242",
> +			"maxbotix,mb7040" or
> +			"maxbotix,mb7137"
> +
> + - reg:			i2c address of the device, see also i2c/i2c.txt
> +
> +Optional properties:
> + - interrupt-parent:	Interrupt controller to use

Don't need this as it is implied and could be in the parent.

Otherwise,

Reviewed-by: Rob Herring <robh@kernel.org>

> +
> + - interrupts:		Interrupt used to announce the preceding reading
> +			request has finished and that data is available.
> +			If no interrupt is specified the device driver
> +			falls back to wait a fixed amount of time until
> +			data can be retrieved.
> +
> +Example:
> +proximity@70 {
> +	compatible = "maxbotix,mb1232";
> +	reg = <0x70>;
> +	interrupt-parent = <&gpio2>;
> +	interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
> +};
> -- 
> 2.11.0
Jonathan Cameron March 31, 2019, 10:34 a.m. UTC | #3
On Thu, 28 Mar 2019 12:51:35 -0500
Rob Herring <robh@kernel.org> wrote:

> On Sun, Mar 17, 2019 at 09:35:27PM +0100, Andreas Klinger wrote:
> > Add doc for dt binding maxbotix,mb1232. This binding is for MaxBotix
> > I2CXL-MaxSonar ultrasonic rangers which share a common i2c interface.
> > 
> > Signed-off-by: Andreas Klinger <ak@it-klinger.de>
> > ---
> >  .../bindings/iio/proximity/maxbotix,mb1232.txt     | 31 ++++++++++++++++++++++
> >  1 file changed, 31 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> > new file mode 100644
> > index 000000000000..0e9df87eca1d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
> > @@ -0,0 +1,31 @@
> > +* MaxBotix I2CXL-MaxSonar ultrasonic distance sensor of type  mb1202,
> > +  mb1212, mb1222, mb1232, mb1242, mb7040 or mb7137 using the i2c interface
> > +  for ranging
> > +
> > +Required properties:
> > + - compatible:		"maxbotix,mb1202",
> > +			"maxbotix,mb1212",
> > +			"maxbotix,mb1222",
> > +			"maxbotix,mb1232",
> > +			"maxbotix,mb1242",
> > +			"maxbotix,mb7040" or
> > +			"maxbotix,mb7137"
> > +
> > + - reg:			i2c address of the device, see also i2c/i2c.txt
> > +
> > +Optional properties:
> > + - interrupt-parent:	Interrupt controller to use  
> 
> Don't need this as it is implied and could be in the parent.
> 
> Otherwise,
> 
> Reviewed-by: Rob Herring <robh@kernel.org>
I tidied that up.

Thanks,

Jonathan

> 
> > +
> > + - interrupts:		Interrupt used to announce the preceding reading
> > +			request has finished and that data is available.
> > +			If no interrupt is specified the device driver
> > +			falls back to wait a fixed amount of time until
> > +			data can be retrieved.
> > +
> > +Example:
> > +proximity@70 {
> > +	compatible = "maxbotix,mb1232";
> > +	reg = <0x70>;
> > +	interrupt-parent = <&gpio2>;
> > +	interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
> > +};
> > -- 
> > 2.11.0
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
new file mode 100644
index 000000000000..0e9df87eca1d
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt
@@ -0,0 +1,31 @@ 
+* MaxBotix I2CXL-MaxSonar ultrasonic distance sensor of type  mb1202,
+  mb1212, mb1222, mb1232, mb1242, mb7040 or mb7137 using the i2c interface
+  for ranging
+
+Required properties:
+ - compatible:		"maxbotix,mb1202",
+			"maxbotix,mb1212",
+			"maxbotix,mb1222",
+			"maxbotix,mb1232",
+			"maxbotix,mb1242",
+			"maxbotix,mb7040" or
+			"maxbotix,mb7137"
+
+ - reg:			i2c address of the device, see also i2c/i2c.txt
+
+Optional properties:
+ - interrupt-parent:	Interrupt controller to use
+
+ - interrupts:		Interrupt used to announce the preceding reading
+			request has finished and that data is available.
+			If no interrupt is specified the device driver
+			falls back to wait a fixed amount of time until
+			data can be retrieved.
+
+Example:
+proximity@70 {
+	compatible = "maxbotix,mb1232";
+	reg = <0x70>;
+	interrupt-parent = <&gpio2>;
+	interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
+};