[v4,05/11] counter: Documentation: Add Simple Counter sysfs documentation
diff mbox

Message ID 91b739431afb52f0f95a4e33d01e636347649d05.1513266127.git.vilhelm.gray@gmail.com
State New
Headers show

Commit Message

William Breathitt Gray Dec. 14, 2017, 8:51 p.m. UTC
This patch adds standard documentation for the userspace sysfs
attributes of the Simple Counter interface.

Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
---
 .../ABI/testing/sysfs-bus-counter-simple-sysfs     | 61 ++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-counter-simple-sysfs

Comments

Jonathan Cameron Jan. 1, 2018, 12:36 p.m. UTC | #1
On Thu, 14 Dec 2017 15:51:43 -0500
William Breathitt Gray <vilhelm.gray@gmail.com> wrote:

> This patch adds standard documentation for the userspace sysfs
> attributes of the Simple Counter interface.
> 
> Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
> ---
>  .../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@vger.kernel.org
> +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@vger.kernel.org
> +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.

Ah, so the specifics are in these files.  Fair enough I suppose though in that
case. Perhaps add a note where relevant in the generic file to say this.

> +
> +What:		/sys/bus/counter/devices/counterX/countY_max
> +KernelVersion:	4.16
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Count Y count data maximum value.

What does this mean?  Does it wrap here, or stop here?
Needs defining.

> +
> +What:		/sys/bus/counter/devices/counterX/countY_min
> +KernelVersion:	4.16
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Count Y count data minimum value.
> +
> +What:		/sys/bus/counter/devices/counterX/countY_signalZ_action
> +KernelVersion:	4.16
> +Contact:	linux-iio@vger.kernel.org
> +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.

I'd put the values in quotes to make it easy to isolate them.

> +
> +		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@vger.kernel.org
> +Description:
> +		Signal data of Signal Y. This is the respective input level
> +		represented by two available states: low and high.

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

Patch
diff mbox

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@vger.kernel.org
+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@vger.kernel.org
+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@vger.kernel.org
+Description:
+		Count Y count data maximum value.
+
+What:		/sys/bus/counter/devices/counterX/countY_min
+KernelVersion:	4.16
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Count Y count data minimum value.
+
+What:		/sys/bus/counter/devices/counterX/countY_signalZ_action
+KernelVersion:	4.16
+Contact:	linux-iio@vger.kernel.org
+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@vger.kernel.org
+Description:
+		Signal data of Signal Y. This is the respective input level
+		represented by two available states: low and high.