From: William Breathitt Gray <vilhelm.gray@gmail.com>
To: gregkh@linuxfoundation.org
Cc: jic23@kernel.org, linux-arm-kernel@lists.infradead.org,
devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-iio@vger.kernel.org, fabrice.gasnier@st.com,
benjamin.gaignard@st.com, knaack.h@gmx.de, lars@metafoo.de,
pmeerw@pmeerw.net, akpm@linux-foundation.org,
William Breathitt Gray <vilhelm.gray@gmail.com>
Subject: [PATCH v9 06/11] counter: 104-quad-8: Documentation: Add Generic Counter sysfs documentation
Date: Sun, 22 Jul 2018 18:51:13 -0400 [thread overview]
Message-ID: <3f51391e2bb036b332a518503d60f15fe1dfddd9.1532298882.git.vilhelm.gray@gmail.com> (raw)
In-Reply-To: <cover.1532298882.git.vilhelm.gray@gmail.com>
This patch adds standard documentation for the Generic Counter interface
userspace sysfs attributes of the 104-QUAD-8 driver.
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
---
.../ABI/testing/sysfs-bus-counter-104-quad-8 | 36 +++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 37 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-counter-104-quad-8
diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8
new file mode 100644
index 000000000000..2d9fa57af101
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8
@@ -0,0 +1,36 @@
+What: /sys/bus/counter/devices/counterX/signalY/index_polarity
+KernelVersion: 4.19
+Contact: linux-iio@vger.kernel.org
+Description:
+ 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: 4.19
+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/synchronous_mode
+KernelVersion: 4.19
+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.
diff --git a/MAINTAINERS b/MAINTAINERS
index f41c45246e2b..865c47a3feae 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -270,6 +270,7 @@ ACCES 104-QUAD-8 DRIVER
M: William Breathitt Gray <vilhelm.gray@gmail.com>
L: linux-iio@vger.kernel.org
S: Maintained
+F: Documentation/ABI/testing/sysfs-bus-counter-104-quad-8
F: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8
F: drivers/counter/104-quad-8.c
--
2.18.0
next prev parent reply other threads:[~2018-07-22 22:51 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-22 22:49 [PATCH v9 00/11] Introduce the Counter subsystem William Breathitt Gray
2018-07-22 22:50 ` [PATCH v9 01/11] counter: Introduce the Generic Counter interface William Breathitt Gray
2018-07-22 22:50 ` [PATCH v9 02/11] counter: Documentation: Add Generic Counter sysfs documentation William Breathitt Gray
2018-07-22 22:50 ` [PATCH v9 03/11] docs: Add Generic Counter interface documentation William Breathitt Gray
2018-07-22 22:50 ` [PATCH v9 04/11] iio: 104-quad-8: Update license boilerplate William Breathitt Gray
2018-07-22 22:50 ` [PATCH v9 05/11] counter: 104-quad-8: Add Generic Counter interface support William Breathitt Gray
2018-07-22 22:51 ` William Breathitt Gray [this message]
2018-07-22 22:51 ` [PATCH v9 07/11] counter: Add STM32 Timer quadrature encoder William Breathitt Gray
2018-07-22 22:51 ` [PATCH v9 08/11] dt-bindings: counter: Document stm32 " William Breathitt Gray
2018-07-22 22:51 ` [PATCH v9 09/11] counter: stm32-lptimer: add counter device William Breathitt Gray
2018-07-22 22:51 ` [PATCH v9 10/11] dt-bindings: counter: Adjust dt-bindings for STM32 lptimer move William Breathitt Gray
2018-07-22 22:52 ` [PATCH v9 11/11] iio: counter: Add deprecation markings for IIO Counter attributes William Breathitt Gray
2018-10-17 2:01 ` [PATCH v9 00/11] Introduce the Counter subsystem William Breathitt Gray
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=3f51391e2bb036b332a518503d60f15fe1dfddd9.1532298882.git.vilhelm.gray@gmail.com \
--to=vilhelm.gray@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=benjamin.gaignard@st.com \
--cc=devicetree@vger.kernel.org \
--cc=fabrice.gasnier@st.com \
--cc=gregkh@linuxfoundation.org \
--cc=jic23@kernel.org \
--cc=knaack.h@gmx.de \
--cc=lars@metafoo.de \
--cc=linux-arm-kernel@lists.infradead.org \
--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;
as well as URLs for NNTP newsgroup(s).