Commit 769841c9 authored by William Breathitt Gray's avatar William Breathitt Gray Committed by Jonathan Cameron
Browse files

docs: counter: Consolidate Counter sysfs attributes documentation 



Duplicate ABIs are not valid, so let's consolidate these sysfs
attributes into the main sysfs-bus-counter documentation file.

Cc: Patrick Havelange <patrick.havelange@essensium.com>
Reviewed-by: default avatarDavid Lechner <david@lechnology.com>
Signed-off-by: default avatarWilliam Breathitt Gray <vilhelm.gray@gmail.com>
Link: https://lore.kernel.org/r/c651ec1c541754ad108160839e2b8425ad089819.1623201081.git.vilhelm.gray@gmail.com


Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
parent 6771fb0b

Documentation/ABI/testing/sysfs-bus-counter

+74 −2
Original line number Diff line number Diff line
@@ -57,6 +57,7 @@ Description: 
What:		/sys/bus/counter/devices/counterX/countY/count_mode_available

What:		/sys/bus/counter/devices/counterX/countY/error_noise_available

What:		/sys/bus/counter/devices/counterX/countY/function_available

What:		/sys/bus/counter/devices/counterX/countY/prescaler_available

What:		/sys/bus/counter/devices/counterX/countY/signalZ_action_available

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org
@@ -154,6 +155,15 @@ Description: 
		Count Y. If possible, this should match the name of the

		respective channel as it appears in the device datasheet.



What:		/sys/bus/counter/devices/counterX/countY/prescaler

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Configure the prescaler value associated with Count Y.

		On the FlexTimer, the counter clock source passes through a

		prescaler (i.e. a counter). This acts like a clock

		divider.



What:		/sys/bus/counter/devices/counterX/countY/preset

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org
@@ -224,11 +234,45 @@ Description: 
		Read-only attribute that indicates the total number of Signals

		belonging to the Counter.



What:		/sys/bus/counter/devices/counterX/signalY/signal

What:		/sys/bus/counter/devices/counterX/signalY/cable_fault

KernelVersion:	5.7

Contact:	linux-iio@vger.kernel.org

Description:

		Read-only attribute that indicates whether a differential

		encoder cable fault (not connected or loose wires) is detected

		for the respective channel of Signal Y. Valid attribute values

		are boolean. Detection must first be enabled via the

		corresponding cable_fault_enable attribute.



What:		/sys/bus/counter/devices/counterX/signalY/cable_fault_enable

KernelVersion:	5.7

Contact:	linux-iio@vger.kernel.org

Description:

		Whether detection of differential encoder cable faults for the

		respective channel of Signal Y is enabled. Valid attribute

		values are boolean.



What:		/sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler

KernelVersion:	5.7

Contact:	linux-iio@vger.kernel.org

Description:

		Filter clock factor for input Signal Y. This prescaler value

		affects the inputs of both quadrature pair signals.



What:		/sys/bus/counter/devices/counterX/signalY/index_polarity

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Signal data of Signal Y represented as a string.

		Active level of index input Signal Y; irrelevant in

		non-synchronous load mode.



What:		/sys/bus/counter/devices/counterX/signalY/index_polarity_available

What:		/sys/bus/counter/devices/counterX/signalY/synchronous_mode_available

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Discrete set of available values for the respective Signal Y

		configuration are listed in this file.



What:		/sys/bus/counter/devices/counterX/signalY/name

KernelVersion:	5.2
@@ -237,3 +281,31 @@ Description: 
		Read-only attribute that indicates the device-specific name of

		Signal Y. If possible, this should match the name of the

		respective signal as it appears in the device datasheet.



What:		/sys/bus/counter/devices/counterX/signalY/signal

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Signal data of Signal Y represented as a string.



What:		/sys/bus/counter/devices/counterX/signalY/synchronous_mode

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Configure the counter associated with Signal Y for

		non-synchronous or synchronous load mode. Synchronous load mode

		cannot be selected in non-quadrature (Pulse-Direction) clock

		mode.



		non-synchronous:

			A logic low level is the active level at this index

			input. The index function (as enabled via preset_enable)

			is performed directly on the active level of the index

			input.



		synchronous:

			Intended for interfacing with encoder Index output in

			quadrature clock mode. The active level is configured

			via index_polarity. The index function (as enabled via

			preset_enable) is performed synchronously with the

			quadrature clock on the active level of the index input.

Documentation/ABI/testing/sysfs-bus-counter-104-quad-8

deleted100644 → 0
+0 −61
Original line number Diff line number Diff line 
What:		/sys/bus/counter/devices/counterX/signalY/cable_fault

KernelVersion:	5.7

Contact:	linux-iio@vger.kernel.org

Description:

		Read-only attribute that indicates whether a differential

		encoder cable fault (not connected or loose wires) is detected

		for the respective channel of Signal Y. Valid attribute values

		are boolean. Detection must first be enabled via the

		corresponding cable_fault_enable attribute.



What:		/sys/bus/counter/devices/counterX/signalY/cable_fault_enable

KernelVersion:	5.7

Contact:	linux-iio@vger.kernel.org

Description:

		Whether detection of differential encoder cable faults for the

		respective channel of Signal Y is enabled. Valid attribute

		values are boolean.



What:		/sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler

KernelVersion:	5.7

Contact:	linux-iio@vger.kernel.org

Description:

		Filter clock factor for input Signal Y. This prescaler value

		affects the inputs of both quadrature pair signals.



What:		/sys/bus/counter/devices/counterX/signalY/index_polarity

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Active level of index input Signal Y; irrelevant in

		non-synchronous load mode.



What:		/sys/bus/counter/devices/counterX/signalY/index_polarity_available

What:		/sys/bus/counter/devices/counterX/signalY/synchronous_mode_available

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Discrete set of available values for the respective Signal Y

		configuration are listed in this file.



What:		/sys/bus/counter/devices/counterX/signalY/synchronous_mode

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Configure the counter associated with Signal Y for

		non-synchronous or synchronous load mode. Synchronous load mode

		cannot be selected in non-quadrature (Pulse-Direction) clock

		mode.



		non-synchronous:

			A logic low level is the active level at this index

			input. The index function (as enabled via preset_enable)

			is performed directly on the active level of the index

			input.



		synchronous:

			Intended for interfacing with encoder Index output in

			quadrature clock mode. The active level is configured

			via index_polarity. The index function (as enabled via

			preset_enable) is performed synchronously with the

			quadrature clock on the active level of the index input.

Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec

deleted100644 → 0
+0 −16
Original line number Diff line number Diff line 
What:		/sys/bus/counter/devices/counterX/countY/prescaler_available

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Discrete set of available values for the respective Count Y

		configuration are listed in this file. Values are delimited by

		newline characters.



What:		/sys/bus/counter/devices/counterX/countY/prescaler

KernelVersion:	5.2

Contact:	linux-iio@vger.kernel.org

Description:

		Configure the prescaler value associated with Count Y.

		On the FlexTimer, the counter clock source passes through a

		prescaler (i.e. a counter). This acts like a clock

		divider.

MAINTAINERS

+1 −3
Original line number Diff line number Diff line
@@ -299,7 +299,6 @@ M: William Breathitt Gray <vilhelm.gray@gmail.com> 
M:	Syed Nayyar Waris <syednwaris@gmail.com>

L:	linux-iio@vger.kernel.org

S:	Maintained

F:	Documentation/ABI/testing/sysfs-bus-counter-104-quad-8

F:	drivers/counter/104-quad-8.c









ACCES PCI-IDIO-16 GPIO DRIVER










@@ -4683,7 +4682,7 @@ COUNTER SUBSYSTEM







M:	William Breathitt Gray <vilhelm.gray@gmail.com>









L:	linux-iio@vger.kernel.org









S:	Maintained









F:	Documentation/ABI/testing/sysfs-bus-counter*









F:	Documentation/ABI/testing/sysfs-bus-counter









F:	Documentation/driver-api/generic-counter.rst









F:	drivers/counter/









F:	include/linux/counter.h










@@ -7094,7 +7093,6 @@ FLEXTIMER FTM-QUADDEC DRIVER







M:	Patrick Havelange <patrick.havelange@essensium.com>









L:	linux-iio@vger.kernel.org









S:	Maintained









F:	Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec









F:	Documentation/devicetree/bindings/counter/ftm-quaddec.txt









F:	drivers/counter/ftm-quaddec.c