Re: [PATCH v2 6/6] iio: accel: adxl372: Update sysfs docs

[Jonathan Cameron <jic23@kernel.org>]

On Tue, 25 Feb 2020 14:09:09 +0200
Alexandru Tachici <alexandru.tachici@analog.com> wrote:

> This patch adds entries in the syfs docs of ADXL372.
> 
> Signed-off-by: Stefan Popa <stefan.popa@analog.com>
> Signed-off-by: Alexandru Tachici <alexandru.tachici@analog.com>
> ---
>  .../ABI/testing/sysfs-bus-iio-accel-adxl372   | 30 +++++++++++++++++++
>  1 file changed, 30 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-accel-adxl372
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-accel-adxl372 b/Documentation/ABI/testing/sysfs-bus-iio-accel-adxl372
> new file mode 100644
> index 000000000000..709376b54bec
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-accel-adxl372
> @@ -0,0 +1,30 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/buffer_peak_mode_enable
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		This attribute allows to configure the FIFO to store sample
> +		sets of impact event peak (x, y, z). As a precondition, all
> +		three channels (x, y, z) need to be enabled.
> +		Writing 1, peak fifo mode will be enabled, if cleared and
> +		all three channels are enabled, sample sets of concurrent
> +		3-axis data will be stored in the FIFO.

As this is referring to the internal fifo (I think!) should we name it
hwfifo_peak_mode_enable to separate it from being related to the software "buffer"?


> +
> +What:		/sys/bus/iio/devices/iio:deviceX/activity_detect_event
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		adxl372 works in loop mode. It will loop  between activity
> +		and inactivity detection mode. The thresh_rising sysfs files
> +		found in events/ need to be configured in order to define when
> +		the device will mark a sensed acceleration over a period of
> +		time as activity.

Hmm. As you noted in the cover letter this is a bit odd having a mixture of
an event and a more fundamental state control.

Please state what value this will provide when read.

> +
> +What:		/sys/bus/iio/devices/iio:deviceX/inactivity_detect_event
> +KernelVersion:
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		adxl372 works in loop mode. It will loop  between activity
> +		and inactivity detection mode. The thresh_falling sysfs files
> +		found in events/ need to be configured in order to define when
> +		the device will mark a sensed acceleration over a period of
> +		time as inactivity.