* [PATCH v4 3/3] iio: distance: srf08: add driver ABI documentation
@ 2017-01-25 19:07 Andreas Klinger
2017-01-28 16:39 ` Jonathan Cameron
0 siblings, 1 reply; 2+ messages in thread
From: Andreas Klinger @ 2017-01-25 19:07 UTC (permalink / raw)
To: jic23-DgEjT+Ai2ygdnm+yROfE0A, knaack.h-Mmb7MZpHnFY,
lars-Qo5EllUWu/uELgA04lAiVw, pmeerw-jW+XmwGofnusTnJN9+BGXg,
linux-iio-u79uwXL29TY76Z2rM5mHXA,
linux-kernel-u79uwXL29TY76Z2rM5mHXA, ktsai-GubuWUlQtMwciDkP5Hr2oA,
wsa-z923LK4zBo2bacvFa/9K2g, robh+dt-DgEjT+Ai2ygdnm+yROfE0A,
pawel.moll-5wv7dgnIgG8, mark.rutland-5wv7dgnIgG8,
ijc+devicetree-KcIKpvwj1kUDXYZnReoRVg,
galak-sgV2jX0FEOL9JmXXK+q4OQ, trivial-DgEjT+Ai2ygdnm+yROfE0A,
mranostay-Re5JQEeQqe8AvxtiuMwx3w,
linux-i2c-u79uwXL29TY76Z2rM5mHXA,
devicetree-u79uwXL29TY76Z2rM5mHXA
Cc: ak-n176/SwNRljddJNmlsFzeA
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-n176/SwNRljddJNmlsFzeA@public.gmane.org>
---
.../ABI/testing/sysfs-bus-iio-distance-srf08 | 22 ++++++++++++++++++++++
1 file changed, 22 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..0a1ca1487fa9
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
@@ -0,0 +1,22 @@
+What /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
+Date: January 2017
+KernelVersion: 4.11
+Contact: linux-iio-u79uwXL29TY76Z2rM5mHXA@public.gmane.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-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
+Description:
+ Show or set the maximum range between the sensor and the
+ first object echoed in meters. Default value is 6.020.
+ This setting limits the time the driver is waiting for a
+ echo.
+ Showing the range of available values is represented as the
+ minimum value, the step and the maximum value, all enclosed
+ in square brackets.
+ Example:
+ [0.043 0.043 11.008]
--
2.1.4
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH v4 3/3] iio: distance: srf08: add driver ABI documentation
2017-01-25 19:07 [PATCH v4 3/3] iio: distance: srf08: add driver ABI documentation Andreas Klinger
@ 2017-01-28 16:39 ` Jonathan Cameron
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Cameron @ 2017-01-28 16:39 UTC (permalink / raw)
To: Andreas Klinger, knaack.h, lars, pmeerw, linux-iio, linux-kernel,
ktsai, wsa, robh+dt, pawel.moll, mark.rutland, ijc+devicetree,
galak, trivial, mranostay, linux-i2c, devicetree
On 25/01/17 19:07, Andreas Klinger wrote:
> 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@it-klinger.de>
Nice clear docs. Thanks,
Applied.
> ---
> .../ABI/testing/sysfs-bus-iio-distance-srf08 | 22 ++++++++++++++++++++++
> 1 file changed, 22 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..0a1ca1487fa9
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
> @@ -0,0 +1,22 @@
> +What /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
> +Date: January 2017
> +KernelVersion: 4.11
> +Contact: linux-iio@vger.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@vger.kernel.org
> +Description:
> + Show or set the maximum range between the sensor and the
> + first object echoed in meters. Default value is 6.020.
> + This setting limits the time the driver is waiting for a
> + echo.
> + Showing the range of available values is represented as the
> + minimum value, the step and the maximum value, all enclosed
> + in square brackets.
> + Example:
> + [0.043 0.043 11.008]
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-01-28 16:39 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-01-25 19:07 [PATCH v4 3/3] iio: distance: srf08: add driver ABI documentation Andreas Klinger
2017-01-28 16:39 ` Jonathan Cameron
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).