iio: light: opt3001: Add device tree binding documentation
authorAndreas Dannenberg <dannenberg@ti.com>
Fri, 29 Jan 2016 19:03:00 +0000 (13:03 -0600)
committerJonathan Cameron <jic23@kernel.org>
Mon, 1 Feb 2016 19:53:12 +0000 (19:53 +0000)
The original documentation as submitted with the driver appears to have
dropped down a rabbit hole.

Signed-off-by: Andreas Dannenberg <dannenberg@ti.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
Documentation/devicetree/bindings/iio/light/opt3001.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/iio/light/opt3001.txt b/Documentation/devicetree/bindings/iio/light/opt3001.txt
new file mode 100644 (file)
index 0000000..eac30d5
--- /dev/null
@@ -0,0 +1,26 @@
+* Texas Instruments OPT3001 Ambient Light Sensor
+
+The driver supports interrupt-driven and interrupt-less operation, depending
+on whether an interrupt property has been populated into the DT. Note that
+the optional generation of IIO events on rising/falling light threshold changes
+requires the use of interrupts. Without interrupts, only the simple reading
+of the current light value is supported through the IIO API.
+
+http://www.ti.com/product/opt3001
+
+Required properties:
+  - compatible: should be "ti,opt3001"
+  - reg: the I2C address of the sensor
+
+Optional properties:
+  - interrupt-parent: should be the phandle for the interrupt controller
+  - interrupts: interrupt mapping for GPIO IRQ (configure for falling edge)
+
+Example:
+
+opt3001@44 {
+       compatible = "ti,opt3001";
+       reg = <0x44>;
+       interrupt-parent = <&gpio1>;
+       interrupts = <28 IRQ_TYPE_EDGE_FALLING>;
+};