diff mbox series

[6/6] iio: imu: adis16480: Add docs for ADIS16480 IMU

Message ID 1550596338-24220-7-git-send-email-stefan.popa@analog.com (mailing list archive)
State New, archived
Headers show
Series iio: imu: adis16480: Add support for ADIS1649x family of devices | expand

Commit Message

Stefan Popa Feb. 19, 2019, 5:12 p.m. UTC
Document support for ADIS16480 Inertial Measurement Unit.

Signed-off-by: Stefan Popa <stefan.popa@analog.com>
---
 .../devicetree/bindings/iio/imu/adi,adis16480.txt  | 49 ++++++++++++++++++++++
 MAINTAINERS                                        |  1 +
 2 files changed, 50 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16480.txt

Comments

Jonathan Cameron Feb. 20, 2019, 10:46 a.m. UTC | #1
On Tue, 19 Feb 2019 19:12:18 +0200
Stefan Popa <stefan.popa@analog.com> wrote:

> Document support for ADIS16480 Inertial Measurement Unit.
> 
> Signed-off-by: Stefan Popa <stefan.popa@analog.com>
Make sure to CC the dt list as well as Rob.  Just because it's normally
Rob who is kind enough to review our patches, doesn't mean we shouldn't
bombard any other interested parties with them as well ;)

Looks good to me, with the exception of the DIO1 vs 2 default
discussed in the earlier patch.

Thanks,

Jonathan

> ---
>  .../devicetree/bindings/iio/imu/adi,adis16480.txt  | 49 ++++++++++++++++++++++
>  MAINTAINERS                                        |  1 +
>  2 files changed, 50 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16480.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/imu/adi,adis16480.txt b/Documentation/devicetree/bindings/iio/imu/adi,adis16480.txt
> new file mode 100644
> index 0000000..dacf5f7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/imu/adi,adis16480.txt
> @@ -0,0 +1,49 @@
> +
> +Analog Devices ADIS16480 and similar IMUs
> +
> +Required properties for the ADIS16480:
> +
> +- compatible: Must be one of
> +	* "adi,adis16375"
> +	* "adi,adis16480"
> +	* "adi,adis16485"
> +	* "adi,adis16488"
> +	* "adi,adis16495-1"
> +	* "adi,adis16495-2"
> +	* "adi,adis16495-3"
> +	* "adi,adis16497-1"
> +	* "adi,adis16497-2"
> +	* "adi,adis16497-3"
> +- reg: SPI chip select number for the device
> +- spi-max-frequency: Max SPI frequency to use
> +	see: Documentation/devicetree/bindings/spi/spi-bus.txt
> +- spi-cpha: See Documentation/devicetree/bindings/spi/spi-bus.txt
> +- spi-cpol: See Documentation/devicetree/bindings/spi/spi-bus.txt
> +- interrupts: interrupt mapping for IRQ, accepted values are:
> +	* IRQF_TRIGGER_RISING
> +	* IRQF_TRIGGER_FALLING
> +
> +Optional properties:
> +
> +- interrupt-names: Data ready line selection. Valid values are:
> +	* DIO1
> +	* DIO2
> +	* DIO3
> +	* DIO4
> +	If this field is left empty, the factory default assigns DIO2 as data
> +	ready signal.
> +- reset-gpios: must be the device tree identifier of the RESET pin. As the line
> +	is active low, it should be marked GPIO_ACTIVE_LOW.
> +
> +Example:
> +
> +	imu@0 {
> +		compatible = "adi,adis16495-1";
> +		reg = <0>;
> +		spi-max-frequency = <3200000>;
> +		spi-cpol;
> +		spi-cpha;
> +		interrupts = <25 IRQF_TRIGGER_FALLING>;
> +		interrupt-parent = <&gpio>;
> +		interrupt-names = "DIO2";
> +	};
> diff --git a/MAINTAINERS b/MAINTAINERS
> index e4091ac..beecd1e 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -942,6 +942,7 @@ F:	drivers/dma/dma-axi-dmac.c
>  ANALOG DEVICES INC IIO DRIVERS
>  M:	Lars-Peter Clausen <lars@metafoo.de>
>  M:	Michael Hennerich <Michael.Hennerich@analog.com>
> +M:	Stefan Popa <stefan.popa@analog.com>
>  W:	http://wiki.analog.com/
>  W:	http://ez.analog.com/community/linux-device-drivers
>  S:	Supported
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/imu/adi,adis16480.txt b/Documentation/devicetree/bindings/iio/imu/adi,adis16480.txt
new file mode 100644
index 0000000..dacf5f7
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/imu/adi,adis16480.txt
@@ -0,0 +1,49 @@ 
+
+Analog Devices ADIS16480 and similar IMUs
+
+Required properties for the ADIS16480:
+
+- compatible: Must be one of
+	* "adi,adis16375"
+	* "adi,adis16480"
+	* "adi,adis16485"
+	* "adi,adis16488"
+	* "adi,adis16495-1"
+	* "adi,adis16495-2"
+	* "adi,adis16495-3"
+	* "adi,adis16497-1"
+	* "adi,adis16497-2"
+	* "adi,adis16497-3"
+- reg: SPI chip select number for the device
+- spi-max-frequency: Max SPI frequency to use
+	see: Documentation/devicetree/bindings/spi/spi-bus.txt
+- spi-cpha: See Documentation/devicetree/bindings/spi/spi-bus.txt
+- spi-cpol: See Documentation/devicetree/bindings/spi/spi-bus.txt
+- interrupts: interrupt mapping for IRQ, accepted values are:
+	* IRQF_TRIGGER_RISING
+	* IRQF_TRIGGER_FALLING
+
+Optional properties:
+
+- interrupt-names: Data ready line selection. Valid values are:
+	* DIO1
+	* DIO2
+	* DIO3
+	* DIO4
+	If this field is left empty, the factory default assigns DIO2 as data
+	ready signal.
+- reset-gpios: must be the device tree identifier of the RESET pin. As the line
+	is active low, it should be marked GPIO_ACTIVE_LOW.
+
+Example:
+
+	imu@0 {
+		compatible = "adi,adis16495-1";
+		reg = <0>;
+		spi-max-frequency = <3200000>;
+		spi-cpol;
+		spi-cpha;
+		interrupts = <25 IRQF_TRIGGER_FALLING>;
+		interrupt-parent = <&gpio>;
+		interrupt-names = "DIO2";
+	};
diff --git a/MAINTAINERS b/MAINTAINERS
index e4091ac..beecd1e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -942,6 +942,7 @@  F:	drivers/dma/dma-axi-dmac.c
 ANALOG DEVICES INC IIO DRIVERS
 M:	Lars-Peter Clausen <lars@metafoo.de>
 M:	Michael Hennerich <Michael.Hennerich@analog.com>
+M:	Stefan Popa <stefan.popa@analog.com>
 W:	http://wiki.analog.com/
 W:	http://ez.analog.com/community/linux-device-drivers
 S:	Supported