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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20170117135006.GA22903@andreas>
Date:   Tue, 17 Jan 2017 14:50:06 +0100
From:   Andreas Klinger <ak@...klinger.de>
To:     jic23@...nel.org, knaack.h@....de, lars@...afoo.de,
        pmeerw@...erw.net, linux-iio@...r.kernel.org,
        linux-kernel@...r.kernel.org, ktsai@...ellamicro.com,
        wsa@...-dreams.de, robh+dt@...nel.org, pawel.moll@....com,
        mark.rutland@....com, ijc+devicetree@...lion.org.uk,
        galak@...eaurora.org, trivial@...nel.org, mranostay@...il.com,
        linux-i2c@...r.kernel.org, devicetree@...r.kernel.org
Cc:     ak@...klinger.de
Subject: [PATCH v3 3/3] iio: distance: srf08: add driver ABI documentation

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@...klinger.de>
---
 .../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@...r.kernel.org
+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@...r.kernel.org
+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@...r.kernel.org
+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


--