Documentation: afe4403: Add DT bindings for the AFE4403 heart monitor
authorAndrew F. Davis <afd@ti.com>
Tue, 2 Feb 2016 17:50:45 +0000 (11:50 -0600)
committerJonathan Cameron <jic23@kernel.org>
Sat, 6 Feb 2016 18:58:01 +0000 (18:58 +0000)
Add the TI AFE4403 heart monitor DT bindings documentation.

Signed-off-by: Andrew F. Davis <afd@ti.com>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
Documentation/devicetree/bindings/iio/health/afe4403.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/iio/health/afe4403.txt b/Documentation/devicetree/bindings/iio/health/afe4403.txt
new file mode 100644 (file)
index 0000000..2fffd70
--- /dev/null
@@ -0,0 +1,34 @@
+Texas Instruments AFE4403 Heart rate and Pulse Oximeter
+
+Required properties:
+ - compatible          : Should be "ti,afe4403".
+ - reg                 : SPI chip select address of device.
+ - tx-supply           : Regulator supply to transmitting LEDs.
+ - interrupt-parent    : Phandle to he parent interrupt controller.
+ - interrupts          : The interrupt line the device ADC_RDY pin is
+                         connected to. For details refer to,
+                         ../../interrupt-controller/interrupts.txt.
+
+Optional properties:
+ - reset-gpios         : GPIO used to reset the device.
+                         For details refer to, ../../gpio/gpio.txt.
+
+For other required and optional properties of SPI slave nodes
+please refer to ../../spi/spi-bus.txt.
+
+Example:
+
+&spi0 {
+       heart_mon@0 {
+               compatible = "ti,afe4403";
+               reg = <0>;
+               spi-max-frequency = <10000000>;
+
+               tx-supply = <&vbat>;
+
+               interrupt-parent = <&gpio1>;
+               interrupts = <28 IRQ_TYPE_EDGE_RISING>;
+
+               reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
+       };
+};