[PATCH v4 02/11] counter: Documentation: Add Generic Counter sysfs documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



This patch adds standard documentation for the userspace sysfs
attributes of the Generic Counter interface.

Signed-off-by: William Breathitt Gray <vilhelm.gray@xxxxxxxxx>
---
 .../ABI/testing/sysfs-bus-counter-generic-sysfs    | 73 ++++++++++++++++++++++
 MAINTAINERS                                        |  1 +
 2 files changed, 74 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-counter-generic-sysfs

diff --git a/Documentation/ABI/testing/sysfs-bus-counter-generic-sysfs b/Documentation/ABI/testing/sysfs-bus-counter-generic-sysfs
new file mode 100644
index 000000000000..3b1c3c4498d1
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-counter-generic-sysfs
@@ -0,0 +1,73 @@
+What:		/sys/bus/counter/devices/counterX/countY
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Count data of Count Y. Typically, this is an accumulated count
+		value.
+
+What:		/sys/bus/counter/devices/counterX/countY_function
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Count function mode of Count Y; count function evaluation is
+		triggered by conditions specified by the countY_signalZ_action
+		attributes.
+
+What:		/sys/bus/counter/devices/counterX/countY_function_available
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Discrete set of available count function modes for the
+		configuration of the respective Count Y are listed in this file.
+
+What:		/sys/bus/counter/devices/counterX/countY_name
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Read-only attribute that indicates the device-specific name of
+		Count Y.
+
+What:		/sys/bus/counter/devices/counterX/countY_signalZ_action
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Action mode of Count Y for Signal Z. This attribute indicates
+		the condition of Signal Z that triggers the count function
+		evaluation for Count Y.
+
+What:		/sys/bus/counter/devices/counterX/countY_signalZ_action_available
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Discrete set of available action modes are listed in this file
+		for the configuration of the respective Synapse associating
+		Signal Z to Count Y.
+
+What:		/sys/bus/counter/devices/counterX/counter_name
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Read-only attribute that indicates the device-specific name of
+		the Counter.
+
+What:		/sys/bus/counter/devices/counterX/signalY
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Signal data of Signal Y. Typically, this is an input line level
+		state.
+
+What:		/sys/bus/counter/devices/counterX/signalY_name
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Read-only attribute that indicates the device-specific name of
+		Signal Y.
+
+What:		/sys/bus/counter/devices/counterX/countY_synapses
+KernelVersion:	4.16
+Contact:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		List of Synapses associating Signals to Count Y. The columns
+		represent the following in the respective order: Signal ID,
+		Signal name, and current action mode.
diff --git a/MAINTAINERS b/MAINTAINERS
index 07dd7b933bfa..38da1bc615b3 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3665,6 +3665,7 @@ COUNTER INTERFACE
 M:	William Breathitt Gray <vilhelm.gray@xxxxxxxxx>
 L:	linux-iio@xxxxxxxxxxxxxxx
 S:	Maintained
+F:	Documentation/ABI/testing/sysfs-bus-counter-*
 F:	drivers/iio/counter/
 F:	include/linux/iio/counter.h
 
-- 
2.15.1

--
To unsubscribe from this list: send the line "unsubscribe linux-iio" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Input]     [Linux Kernel]     [Linux SCSI]     [X.org]

  Powered by Linux