[PATCH v4 05/11] counter: Documentation: Add Simple Counter sysfs documentation
From: William Breathitt Gray
Date: Thu Dec 14 2017 - 15:52:00 EST
This patch adds standard documentation for the userspace sysfs
attributes of the Simple Counter interface.
Signed-off-by: William Breathitt Gray <vilhelm.gray@xxxxxxxxx>
---
.../ABI/testing/sysfs-bus-counter-simple-sysfs | 61 ++++++++++++++++++++++
1 file changed, 61 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-counter-simple-sysfs
diff --git a/Documentation/ABI/testing/sysfs-bus-counter-simple-sysfs b/Documentation/ABI/testing/sysfs-bus-counter-simple-sysfs
new file mode 100644
index 000000000000..e1f32c64c667
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-counter-simple-sysfs
@@ -0,0 +1,61 @@
+What: /sys/bus/counter/devices/counterX/countY
+KernelVersion: 4.16
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Count data of Count Y. This is a signed integer value that
+ represents the accumulated count.
+
+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. Two count function modes are available: increase and
+ decrease.
+
+ Increase:
+ Accumulated count is incremented.
+
+ Decrease:
+ Accumulated count is decremented.
+
+What: /sys/bus/counter/devices/counterX/countY_max
+KernelVersion: 4.16
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Count Y count data maximum value.
+
+What: /sys/bus/counter/devices/counterX/countY_min
+KernelVersion: 4.16
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Count Y count data minimum value.
+
+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. Four action modes are available: none,
+ rising edge, falling edge, and both edges.
+
+ None:
+ Signal does not trigger the count function.
+
+ Rising Edge:
+ Low state transitions to High state.
+
+ Falling Edge:
+ High state transitions to Low state.
+
+ Both Edges:
+ Any state transition.
+
+What: /sys/bus/counter/devices/counterX/signalY
+KernelVersion: 4.16
+Contact: linux-iio@xxxxxxxxxxxxxxx
+Description:
+ Signal data of Signal Y. This is the respective input level
+ represented by two available states: low and high.
--
2.15.1