Re: [PATCH v5 7/8] counter: stm32-timer-cnt: Add sysfs documentation

[Jonathan Cameron]

On Fri,  9 Mar 2018 13:43:44 -0500
William Breathitt Gray <vilhelm.gray@xxxxxxxxx> wrote:

> From: Benjamin Gaignard <benjamin.gaignard@xxxxxx>
> 
> In addition of the generic sysfs-bus-counter ABI stm32-timer-cnt
> offerts three functionality:
> - enable the counter
> - set preset value
> - allow to read counter direction
> 
> Signed-off-by: Benjamin Gaignard <benjamin.gaignard@xxxxxx>
> Signed-off-by: William Breathitt Gray <vilhelm.gray@xxxxxxxxx>
My main thought here is that there is nothing which doesn't belong
in sysfs-bus-counter to my mind anyway.

Jonathan

> ---
>  .../ABI/testing/sysfs-bus-counter-stm32-timer-cnt   | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-counter-stm32-timer-cnt
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-counter-stm32-timer-cnt b/Documentation/ABI/testing/sysfs-bus-counter-stm32-timer-cnt
> new file mode 100644
> index 000000000000..73328e8e6d7e
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-counter-stm32-timer-cnt
> @@ -0,0 +1,21 @@
> +What:		/sys/bus/counter/devices/counterX/countY_direction
> +KernelVersion:	4.17
> +Contact:	linux-iio@xxxxxxxxxxxxxxx
> +Description:
> +		Read-only attribute that indicates the count direction of
> +		Count Y. Two count directions are available: Forward and
> +		Backward.
Given both existing devices have this, I'm guessing it is generic enough
to graduate to the generic sysfs documentation file.
> +
> +What:		/sys/bus/counter/devices/counterX/countY_enable
> +KernelVersion:	4.17
> +Contact:	linux-iio@xxxxxxxxxxxxxxx
> +Description:
> +		Whether channel Y inputs A and B are enabled. Valid attribute
> +		values are boolean.
Given for the previous device we had individual inputs (which to my mind
made no sense to disable separately) perhaps we should have this as the
generic option.  If a driver needs to separately disable the two signals
then that is up to it to sort out.

At least this way we reduce the guessing any userspace code will need
to do in order to turns things on.
> +
> +What:		/sys/bus/counter/devices/counterX/countY_preset
> +KernelVersion:	4.17
> +Contact:	linux-iio@xxxxxxxxxxxxxxx
> +Description:
> +		If the counter device supports preset registers, the preset
> +		count for channel Y is provided by this attribute.
Again, looks pretty generic...