staging: iio: isl29018: document device tree bindings
authorBrian Masney <masneyb@onstation.org>
Fri, 7 Oct 2016 00:48:35 +0000 (20:48 -0400)
committerJonathan Cameron <jic23@kernel.org>
Tue, 11 Oct 2016 18:40:26 +0000 (19:40 +0100)
Fix the following warnings from checkpatch:

WARNING: DT compatible string "isil,isl29018" appears un-documented --
check ./Documentation/devicetree/bindings/
WARNING: DT compatible string "isil,isl29023" appears un-documented --
check ./Documentation/devicetree/bindings/
WARNING: DT compatible string "isil,isl29035" appears un-documented --
check ./Documentation/devicetree/bindings/

Signed-off-by: Brian Masney <masneyb@onstation.org>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
Documentation/devicetree/bindings/iio/light/isl29018.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/iio/light/isl29018.txt b/Documentation/devicetree/bindings/iio/light/isl29018.txt
new file mode 100644 (file)
index 0000000..425ab45
--- /dev/null
@@ -0,0 +1,28 @@
+* ISL 29018/29023/29035 I2C ALS, Proximity, and Infrared sensor
+
+Required properties:
+
+  - compatible: Should be one of
+               "isil,isl29018"
+               "isil,isl29023"
+               "isil,isl29035"
+  - reg: the I2C address of the device
+
+Optional properties:
+
+  - interrupt-parent: should be the phandle for the interrupt controller
+  - interrupts: the sole interrupt generated by the device
+
+  Refer to interrupt-controller/interrupts.txt for generic interrupt client
+  node bindings.
+
+  - vcc-supply: phandle to the regulator that provides power to the sensor.
+
+Example:
+
+isl29018@44 {
+       compatible = "isil,isl29018";
+       reg = <0x44>;
+       interrupt-parent = <&gpio>;
+       interrupts = <TEGRA_GPIO(Z, 2) IRQ_TYPE_LEVEL_HIGH>;
+};