[PATCH v3 3/3] iio: distance: srf08: add driver ABI documentation

From: Andreas Klinger
Date: Tue Jan 17 2017 - 08:50:53 EST


Add sysfs-bus-iio-distance-srf08 for individual attributes of the driver,
especially:
- sensitivity which the device documentation calls gain for amplifying the
signal
- max_range for limiting the maximum distance for expected echos and
therefore limiting the time waiting for telegrams

Signed-off-by: Andreas Klinger <ak@xxxxxxxxxxxxx>
---
.../ABI/testing/sysfs-bus-iio-distance-srf08 | 27 ++++++++++++++++++++++
1 file changed, 27 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-distance-srf08

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-distance-srf08 b/Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
new file mode 100644
index 000000000000..e96c28064748
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
@@ -0,0 +1,27 @@
+What /sys/bus/iio/devices/iio:deviceX/in_distance_raw
+Date: January 2017
+KernelVersion: 4.11
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Get the current distance in meters between the sensor and
+ the first object recognized
+
+What /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
+Date: January 2017
+KernelVersion: 4.11
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Show or set the gain boost of the amp, from 0-31 range.
+ default 31
+
+What /sys/bus/iio/devices/iio:deviceX/sensor_max_range
+Date: January 2017
+KernelVersion: 4.11
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Show or set the maximum range between the sensor and the
+ first object echoed in millimeters.
+ This setting limits the time the driver is waiting for a
+ echo.
+ Can be set between 43 and 11008 in a grid of 43 mm.
+ default 6020
--
2.1.4


--