All of lore.kernel.org
 help / color / mirror / Atom feed
From: William Breathitt Gray <vilhelm.gray@gmail.com>
To: jic23@kernel.org
Cc: benjamin.gaignard@st.com, fabrice.gasnier@st.com,
	linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
	devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
	William Breathitt Gray <vilhelm.gray@gmail.com>
Subject: [PATCH v6 5/9] counter: 104-quad-8: Documentation: Add Generic Counter sysfs documentation
Date: Wed, 16 May 2018 13:51:44 -0400	[thread overview]
Message-ID: <2dc403b8eebda6f8558bf0883ec7ceae99a8c255.1526487615.git.vilhelm.gray@gmail.com> (raw)
In-Reply-To: <cover.1526487615.git.vilhelm.gray@gmail.com>

This patch adds standard documentation for the Generic Counter interface
userspace sysfs attributes of the 104-QUAD-8 driver.

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..274df6768b97
--- /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.18
+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.18
+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.18
+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 f11bf7885aeb..8e27b49e8d5e 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.17.0

WARNING: multiple messages have this Message-ID (diff)
From: vilhelm.gray@gmail.com (William Breathitt Gray)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH v6 5/9] counter: 104-quad-8: Documentation: Add Generic Counter sysfs documentation
Date: Wed, 16 May 2018 13:51:44 -0400	[thread overview]
Message-ID: <2dc403b8eebda6f8558bf0883ec7ceae99a8c255.1526487615.git.vilhelm.gray@gmail.com> (raw)
In-Reply-To: <cover.1526487615.git.vilhelm.gray@gmail.com>

This patch adds standard documentation for the Generic Counter interface
userspace sysfs attributes of the 104-QUAD-8 driver.

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..274df6768b97
--- /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.18
+Contact:	linux-iio at 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.18
+Contact:	linux-iio at 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.18
+Contact:	linux-iio at 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 f11bf7885aeb..8e27b49e8d5e 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 at 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.17.0

  parent reply	other threads:[~2018-05-16 17:51 UTC|newest]

Thread overview: 76+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-16 17:50 [PATCH v6 0/9] Introduce the Counter subsystem William Breathitt Gray
2018-05-16 17:50 ` William Breathitt Gray
2018-05-16 17:50 ` [PATCH v6 1/9] counter: Introduce the Generic Counter interface William Breathitt Gray
2018-05-16 17:50   ` William Breathitt Gray
2018-05-20 15:06   ` Jonathan Cameron
2018-05-20 15:06     ` Jonathan Cameron
2018-05-21 13:06     ` William Breathitt Gray
2018-05-21 13:06       ` William Breathitt Gray
2018-05-16 17:50 ` [PATCH v6 2/9] counter: Documentation: Add Generic Counter sysfs documentation William Breathitt Gray
2018-05-16 17:50   ` William Breathitt Gray
2018-05-20 15:12   ` Jonathan Cameron
2018-05-20 15:12     ` Jonathan Cameron
2018-05-16 17:51 ` [PATCH v6 3/9] docs: Add Generic Counter interface documentation William Breathitt Gray
2018-05-16 17:51   ` William Breathitt Gray
2018-05-19 15:30   ` kbuild test robot
2018-05-19 15:30     ` kbuild test robot
2018-05-19 15:30     ` kbuild test robot
2018-05-20 15:31   ` Jonathan Cameron
2018-05-20 15:31     ` Jonathan Cameron
2018-05-20 15:31     ` Jonathan Cameron
2018-05-21 13:47     ` William Breathitt Gray
2018-05-21 13:47       ` William Breathitt Gray
2018-05-22 17:08       ` Jonathan Cameron
2018-05-22 17:08         ` Jonathan Cameron
2018-05-25  9:26         ` Fabrice Gasnier
2018-05-25  9:26           ` Fabrice Gasnier
2018-05-25  9:26           ` Fabrice Gasnier
2018-05-25 13:00           ` William Breathitt Gray
2018-05-25 13:00             ` William Breathitt Gray
2018-05-16 17:51 ` [PATCH v6 4/9] counter: 104-quad-8: Add Generic Counter interface support William Breathitt Gray
2018-05-16 17:51   ` William Breathitt Gray
2018-05-19 13:16   ` kbuild test robot
2018-05-19 13:16     ` kbuild test robot
2018-05-19 13:16     ` kbuild test robot
2018-05-19 13:55     ` William Breathitt Gray
2018-05-19 13:55       ` William Breathitt Gray
2018-05-19 13:55       ` William Breathitt Gray
2018-05-19 13:16   ` [RFC PATCH] counter: 104-quad-8: quad8_ops can be static kbuild test robot
2018-05-19 13:16     ` kbuild test robot
2018-05-19 13:16     ` kbuild test robot
2018-05-20 15:42   ` [PATCH v6 4/9] counter: 104-quad-8: Add Generic Counter interface support Jonathan Cameron
2018-05-20 15:42     ` Jonathan Cameron
2018-05-21 13:51     ` William Breathitt Gray
2018-05-21 13:51       ` William Breathitt Gray
2018-05-16 17:51 ` William Breathitt Gray [this message]
2018-05-16 17:51   ` [PATCH v6 5/9] counter: 104-quad-8: Documentation: Add Generic Counter sysfs documentation William Breathitt Gray
2018-05-16 17:51 ` [PATCH v6 6/9] dt-bindings: counter: Document stm32 quadrature encoder William Breathitt Gray
2018-05-16 17:51   ` William Breathitt Gray
2018-05-17 16:23   ` Rob Herring
2018-05-17 16:23     ` Rob Herring
2018-05-17 18:07     ` William Breathitt Gray
2018-05-17 18:07       ` William Breathitt Gray
2018-05-17 18:59     ` Benjamin Gaignard
2018-05-17 18:59       ` Benjamin Gaignard
2018-05-18 16:28       ` Rob Herring
2018-05-18 16:28         ` Rob Herring
2018-05-20 15:47         ` Jonathan Cameron
2018-05-20 15:47           ` Jonathan Cameron
2018-06-04 13:03         ` Benjamin Gaignard
2018-06-04 13:03           ` Benjamin Gaignard
2018-06-04 13:03           ` Benjamin Gaignard
2018-05-16 17:52 ` [PATCH v6 7/9] counter: Add STM32 Timer " William Breathitt Gray
2018-05-16 17:52   ` William Breathitt Gray
2018-05-16 17:52 ` [PATCH v6 8/9] counter: stm32-lptimer: add counter device William Breathitt Gray
2018-05-16 17:52   ` William Breathitt Gray
2018-05-18 16:34   ` Rob Herring
2018-05-18 16:34     ` Rob Herring
2018-05-16 17:52 ` [PATCH v6 9/9] iio: counter: Remove IIO counter subdirectory William Breathitt Gray
2018-05-16 17:52   ` William Breathitt Gray
2018-05-20 15:53   ` Jonathan Cameron
2018-05-20 15:53     ` Jonathan Cameron
2018-05-21 13:58     ` William Breathitt Gray
2018-05-21 13:58       ` William Breathitt Gray
2018-05-22 10:44       ` Jonathan Cameron
2018-05-22 10:44         ` Jonathan Cameron
2018-05-22 10:44         ` Jonathan Cameron

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=2dc403b8eebda6f8558bf0883ec7ceae99a8c255.1526487615.git.vilhelm.gray@gmail.com \
    --to=vilhelm.gray@gmail.com \
    --cc=benjamin.gaignard@st.com \
    --cc=devicetree@vger.kernel.org \
    --cc=fabrice.gasnier@st.com \
    --cc=jic23@kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.