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

From: Jonathan Cameron
Date: Sat Jan 28 2017 - 11:40:14 EST


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@xxxxxxxxxxxxx>
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@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 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]
>