staging: iio: isl29018: add ABI documentation for infrared suppression
authorBrian Masney <masneyb@onstation.org>
Mon, 10 Oct 2016 07:20:01 +0000 (03:20 -0400)
committerJonathan Cameron <jic23@kernel.org>
Sun, 23 Oct 2016 18:33:55 +0000 (19:33 +0100)
Add ABI documentation from the ISL29018 Data Sheet (FN6619.4, Oct 8,
2012) about the infrared suppression that can be controlled
with the proximity_on_chip_ambient_infrared_suppression sysfs attribute.

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

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-light-isl29018 b/Documentation/ABI/testing/sysfs-bus-iio-light-isl29018
new file mode 100644 (file)
index 0000000..f0ce0a0
--- /dev/null
@@ -0,0 +1,19 @@
+What:          /sys/bus/iio/devices/iio:deviceX/proximity_on_chip_ambient_infrared_suppression
+Date:          January 2011
+KernelVersion: 2.6.37
+Contact:       linux-iio@vger.kernel.org
+Description:
+               From ISL29018 Data Sheet (FN6619.4, Oct 8, 2012) regarding the
+               infrared suppression:
+
+               Scheme 0, makes full n (4, 8, 12, 16) bits (unsigned) proximity
+               detection. The range of Scheme 0 proximity count is from 0 to
+               2^n. Logic 1 of this bit, Scheme 1, makes n-1 (3, 7, 11, 15)
+               bits (2's complementary) proximity_less_ambient detection. The
+               range of Scheme 1 proximity count is from -2^(n-1) to 2^(n-1).
+               The sign bit is extended for resolutions less than 16. While
+               Scheme 0 has wider dynamic range, Scheme 1 proximity detection
+               is less affected by the ambient IR noise variation.
+
+               0 Sensing IR from LED and ambient
+               1 Sensing IR from LED with ambient IR rejection