From: William Breathitt Gray <vilhelm.gray@gmail.com>
To: jic23@kernel.org, knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net
Cc: benjamin.gaignard@linaro.org, linux-iio@vger.kernel.org,
linux-kernel@vger.kernel.org,
William Breathitt Gray <vilhelm.gray@gmail.com>
Subject: [PATCH v4 02/11] counter: Documentation: Add Generic Counter sysfs documentation
Date: Thu, 14 Dec 2017 15:50:58 -0500 [thread overview]
Message-ID: <e1235f0c7151a69f838dfc8eb4f25bd4cb9fe415.1513266127.git.vilhelm.gray@gmail.com> (raw)
In-Reply-To: <cover.1513266127.git.vilhelm.gray@gmail.com>
This patch adds standard documentation for the userspace sysfs
attributes of the Generic Counter interface.
Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
---
.../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@vger.kernel.org
+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@vger.kernel.org
+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@vger.kernel.org
+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@vger.kernel.org
+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@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.
+
+What: /sys/bus/counter/devices/counterX/countY_signalZ_action_available
+KernelVersion: 4.16
+Contact: linux-iio@vger.kernel.org
+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@vger.kernel.org
+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@vger.kernel.org
+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@vger.kernel.org
+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@vger.kernel.org
+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@gmail.com>
L: linux-iio@vger.kernel.org
S: Maintained
+F: Documentation/ABI/testing/sysfs-bus-counter-*
F: drivers/iio/counter/
F: include/linux/iio/counter.h
--
2.15.1
next prev parent reply other threads:[~2017-12-14 20:51 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-14 20:50 [PATCH v4 00/11] Introduce the Counter subsystem William Breathitt Gray
2017-12-14 20:50 ` [PATCH v4 01/11] iio: Introduce the Generic Counter interface William Breathitt Gray
2018-01-01 12:09 ` Jonathan Cameron
2017-12-14 20:50 ` William Breathitt Gray [this message]
2018-01-01 11:26 ` [PATCH v4 02/11] counter: Documentation: Add Generic Counter sysfs documentation Jonathan Cameron
2017-12-14 20:51 ` [PATCH v4 03/11] docs: Add Generic Counter interface documentation William Breathitt Gray
2018-01-01 11:45 ` Jonathan Cameron
2017-12-14 20:51 ` [PATCH v4 04/11] counter: Introduce the Simple Counter interface William Breathitt Gray
2018-01-01 12:33 ` Jonathan Cameron
2017-12-14 20:51 ` [PATCH v4 05/11] counter: Documentation: Add Simple Counter sysfs documentation William Breathitt Gray
2018-01-01 12:36 ` Jonathan Cameron
2017-12-14 20:51 ` [PATCH v4 06/11] docs: Add Simple Counter interface documentation William Breathitt Gray
2018-01-01 12:42 ` Jonathan Cameron
2017-12-14 20:52 ` [PATCH v4 07/11] counter: Add dummy counter driver William Breathitt Gray
2017-12-14 20:52 ` [PATCH v4 08/11] counter: Introduce the Quadrature Counter interface William Breathitt Gray
2018-01-01 12:48 ` Jonathan Cameron
2017-12-14 20:52 ` [PATCH v4 09/11] counter: Documentation: Add Quadrature Counter sysfs documentation William Breathitt Gray
2017-12-14 20:52 ` [PATCH v4 10/11] docs: Add Quadrature Counter interface documentation William Breathitt Gray
2017-12-14 20:53 ` [PATCH v4 11/11] counter: 104-quad-8: Add Quadrature Counter interface support William Breathitt Gray
2018-01-01 11:16 ` [PATCH v4 00/11] Introduce the Counter subsystem Jonathan Cameron
2018-01-01 13:04 ` Jonathan Cameron
2018-01-15 9:02 ` Benjamin Gaignard
2018-02-23 12:58 ` Benjamin Gaignard
2018-02-23 13:14 ` William Breathitt Gray
2018-02-23 13:19 ` Benjamin Gaignard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e1235f0c7151a69f838dfc8eb4f25bd4cb9fe415.1513266127.git.vilhelm.gray@gmail.com \
--to=vilhelm.gray@gmail.com \
--cc=benjamin.gaignard@linaro.org \
--cc=jic23@kernel.org \
--cc=knaack.h@gmx.de \
--cc=lars@metafoo.de \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pmeerw@pmeerw.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®