docs: counter: Consolidate Counter sysfs attributes documentation

[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-bus-counter

diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter
index e9d9e50..20fe5af 100644 (file)
--- a/Documentation/ABI/testing/sysfs-bus-counter
+++ b/Documentation/ABI/testing/sysfs-bus-counter
@@ -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.