From: Jonathan Cameron <jic23@kernel.org>
To: William Breathitt Gray <vilhelm.gray@gmail.com>
Cc: linux-stm32@st-md-mailman.stormreply.com, kernel@pengutronix.de,
a.fatoum@pengutronix.de, kamel.bouhara@bootlin.com,
gwendal@chromium.org, alexandre.belloni@bootlin.com,
david@lechnology.com, linux-iio@vger.kernel.org,
linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org, syednwaris@gmail.com,
patrick.havelange@essensium.com, fabrice.gasnier@st.com,
mcoquelin.stm32@gmail.com, alexandre.torgue@st.com,
o.rempel@pengutronix.de, jarkko.nikula@linux.intel.com
Subject: Re: [PATCH v11 01/33] docs: counter: Consolidate Counter sysfs attributes documentation
Date: Wed, 9 Jun 2021 15:55:58 +0100 [thread overview]
Message-ID: <20210609155558.502a1b11@jic23-huawei> (raw)
In-Reply-To: <c651ec1c541754ad108160839e2b8425ad089819.1623201081.git.vilhelm.gray@gmail.com>
On Wed, 9 Jun 2021 10:31:04 +0900
William Breathitt Gray <vilhelm.gray@gmail.com> wrote:
> Duplicate ABIs are not valid, so let's consolidate these sysfs
> attributes into the main sysfs-bus-counter documentation file.
>
> Cc: Patrick Havelange <patrick.havelange@essensium.com>
> Reviewed-by: David Lechner <david@lechnology.com>
> Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
Applied to the togreg branch of iio.git and pushed out as testing for
the autobuilders to see if they find anything that we missed.
Thanks,
Jonathan
> ---
> Documentation/ABI/testing/sysfs-bus-counter | 76 ++++++++++++++++++-
> .../ABI/testing/sysfs-bus-counter-104-quad-8 | 61 ---------------
> .../ABI/testing/sysfs-bus-counter-ftm-quaddec | 16 ----
> MAINTAINERS | 4 +-
> 4 files changed, 75 insertions(+), 82 deletions(-)
> delete mode 100644 Documentation/ABI/testing/sysfs-bus-counter-104-quad-8
> delete mode 100644 Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter
> index e9d9e50f03be..20fe5afd4f9e 100644
> --- a/Documentation/ABI/testing/sysfs-bus-counter
> +++ b/Documentation/ABI/testing/sysfs-bus-counter
> @@ -57,6 +57,7 @@ Description:
> What: /sys/bus/counter/devices/counterX/countY/count_mode_available
> What: /sys/bus/counter/devices/counterX/countY/error_noise_available
> What: /sys/bus/counter/devices/counterX/countY/function_available
> +What: /sys/bus/counter/devices/counterX/countY/prescaler_available
> What: /sys/bus/counter/devices/counterX/countY/signalZ_action_available
> KernelVersion: 5.2
> Contact: linux-iio@vger.kernel.org
> @@ -154,6 +155,15 @@ Description:
> Count Y. If possible, this should match the name of the
> respective channel as it appears in the device datasheet.
>
> +What: /sys/bus/counter/devices/counterX/countY/prescaler
> +KernelVersion: 5.2
> +Contact: linux-iio@vger.kernel.org
> +Description:
> + Configure the prescaler value associated with Count Y.
> + On the FlexTimer, the counter clock source passes through a
> + prescaler (i.e. a counter). This acts like a clock
> + divider.
> +
> What: /sys/bus/counter/devices/counterX/countY/preset
> KernelVersion: 5.2
> Contact: linux-iio@vger.kernel.org
> @@ -224,11 +234,45 @@ Description:
> Read-only attribute that indicates the total number of Signals
> belonging to the Counter.
>
> -What: /sys/bus/counter/devices/counterX/signalY/signal
> +What: /sys/bus/counter/devices/counterX/signalY/cable_fault
> +KernelVersion: 5.7
> +Contact: linux-iio@vger.kernel.org
> +Description:
> + Read-only attribute that indicates whether a differential
> + encoder cable fault (not connected or loose wires) is detected
> + for the respective channel of Signal Y. Valid attribute values
> + are boolean. Detection must first be enabled via the
> + corresponding cable_fault_enable attribute.
> +
> +What: /sys/bus/counter/devices/counterX/signalY/cable_fault_enable
> +KernelVersion: 5.7
> +Contact: linux-iio@vger.kernel.org
> +Description:
> + Whether detection of differential encoder cable faults for the
> + respective channel of Signal Y is enabled. Valid attribute
> + values are boolean.
> +
> +What: /sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler
> +KernelVersion: 5.7
> +Contact: linux-iio@vger.kernel.org
> +Description:
> + Filter clock factor for input Signal Y. This prescaler value
> + affects the inputs of both quadrature pair signals.
> +
> +What: /sys/bus/counter/devices/counterX/signalY/index_polarity
> KernelVersion: 5.2
> Contact: linux-iio@vger.kernel.org
> Description:
> - Signal data of Signal Y represented as a string.
> + 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: 5.2
> +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/name
> KernelVersion: 5.2
> @@ -237,3 +281,31 @@ Description:
> Read-only attribute that indicates the device-specific name of
> Signal Y. If possible, this should match the name of the
> respective signal as it appears in the device datasheet.
> +
> +What: /sys/bus/counter/devices/counterX/signalY/signal
> +KernelVersion: 5.2
> +Contact: linux-iio@vger.kernel.org
> +Description:
> + Signal data of Signal Y represented as a string.
> +
> +What: /sys/bus/counter/devices/counterX/signalY/synchronous_mode
> +KernelVersion: 5.2
> +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/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8
> deleted file mode 100644
> index eac32180c40d..000000000000
> --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8
> +++ /dev/null
> @@ -1,61 +0,0 @@
> -What: /sys/bus/counter/devices/counterX/signalY/cable_fault
> -KernelVersion: 5.7
> -Contact: linux-iio@vger.kernel.org
> -Description:
> - Read-only attribute that indicates whether a differential
> - encoder cable fault (not connected or loose wires) is detected
> - for the respective channel of Signal Y. Valid attribute values
> - are boolean. Detection must first be enabled via the
> - corresponding cable_fault_enable attribute.
> -
> -What: /sys/bus/counter/devices/counterX/signalY/cable_fault_enable
> -KernelVersion: 5.7
> -Contact: linux-iio@vger.kernel.org
> -Description:
> - Whether detection of differential encoder cable faults for the
> - respective channel of Signal Y is enabled. Valid attribute
> - values are boolean.
> -
> -What: /sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler
> -KernelVersion: 5.7
> -Contact: linux-iio@vger.kernel.org
> -Description:
> - Filter clock factor for input Signal Y. This prescaler value
> - affects the inputs of both quadrature pair signals.
> -
> -What: /sys/bus/counter/devices/counterX/signalY/index_polarity
> -KernelVersion: 5.2
> -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: 5.2
> -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: 5.2
> -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/Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec b/Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec
> deleted file mode 100644
> index 7d2e7b363467..000000000000
> --- a/Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec
> +++ /dev/null
> @@ -1,16 +0,0 @@
> -What: /sys/bus/counter/devices/counterX/countY/prescaler_available
> -KernelVersion: 5.2
> -Contact: linux-iio@vger.kernel.org
> -Description:
> - Discrete set of available values for the respective Count Y
> - configuration are listed in this file. Values are delimited by
> - newline characters.
> -
> -What: /sys/bus/counter/devices/counterX/countY/prescaler
> -KernelVersion: 5.2
> -Contact: linux-iio@vger.kernel.org
> -Description:
> - Configure the prescaler value associated with Count Y.
> - On the FlexTimer, the counter clock source passes through a
> - prescaler (i.e. a counter). This acts like a clock
> - divider.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index e679d422b472..8fa9202610c5 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -299,7 +299,6 @@ M: William Breathitt Gray <vilhelm.gray@gmail.com>
> M: Syed Nayyar Waris <syednwaris@gmail.com>
> L: linux-iio@vger.kernel.org
> S: Maintained
> -F: Documentation/ABI/testing/sysfs-bus-counter-104-quad-8
> F: drivers/counter/104-quad-8.c
>
> ACCES PCI-IDIO-16 GPIO DRIVER
> @@ -4675,7 +4674,7 @@ COUNTER SUBSYSTEM
> M: William Breathitt Gray <vilhelm.gray@gmail.com>
> L: linux-iio@vger.kernel.org
> S: Maintained
> -F: Documentation/ABI/testing/sysfs-bus-counter*
> +F: Documentation/ABI/testing/sysfs-bus-counter
> F: Documentation/driver-api/generic-counter.rst
> F: drivers/counter/
> F: include/linux/counter.h
> @@ -7087,7 +7086,6 @@ FLEXTIMER FTM-QUADDEC DRIVER
> M: Patrick Havelange <patrick.havelange@essensium.com>
> L: linux-iio@vger.kernel.org
> S: Maintained
> -F: Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec
> F: Documentation/devicetree/bindings/counter/ftm-quaddec.txt
> F: drivers/counter/ftm-quaddec.c
>
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2021-06-09 16:09 UTC|newest]
Thread overview: 63+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-09 1:31 [PATCH v11 00/33] Introduce the Counter character device interface William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 01/33] docs: counter: Consolidate Counter sysfs attributes documentation William Breathitt Gray
2021-06-09 14:55 ` Jonathan Cameron [this message]
2021-06-09 1:31 ` [PATCH v11 02/33] docs: counter: Fix spelling William Breathitt Gray
2021-06-09 15:02 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 03/33] counter: 104-quad-8: Remove pointless comment William Breathitt Gray
2021-06-09 15:02 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 04/33] counter: 104-quad-8: Return error when invalid mode during ceiling_write William Breathitt Gray
2021-06-09 15:12 ` Jonathan Cameron
2021-06-09 15:48 ` William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 05/33] counter: 104-quad-8: Annotate hardware config module parameter William Breathitt Gray
2021-06-09 15:17 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 06/33] counter: 104-quad-8: Add const qualifiers for quad8_preset_register_set William Breathitt Gray
2021-06-09 15:19 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 07/33] counter: 104-quad-8: Add const qualifier for functions_list array William Breathitt Gray
2021-06-09 15:20 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 08/33] counter: interrupt-cnt: " William Breathitt Gray
2021-06-09 15:21 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 09/33] counter: microchip-tcb-capture: " William Breathitt Gray
2021-06-09 15:22 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 10/33] counter: stm32-lptimer-cnt: " William Breathitt Gray
2021-06-09 15:25 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 11/33] counter: stm32-timer-cnt: " William Breathitt Gray
2021-06-09 15:25 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 12/33] counter: 104-quad-8: Add const qualifier for actions_list array William Breathitt Gray
2021-06-09 15:27 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 13/33] counter: ftm-quaddec: " William Breathitt Gray
2021-06-09 15:28 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 14/33] counter: interrupt-cnt: " William Breathitt Gray
2021-06-09 15:29 ` Jonathan Cameron
2021-06-09 15:36 ` William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 15/33] counter: microchip-tcb-capture: " William Breathitt Gray
2021-06-09 15:30 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 16/33] counter: stm32-lptimer-cnt: " William Breathitt Gray
2021-06-09 15:32 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 17/33] counter: stm32-timer-cnt: " William Breathitt Gray
2021-06-09 15:33 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 18/33] counter: Return error code on invalid modes William Breathitt Gray
2021-06-09 15:47 ` Jonathan Cameron
2021-07-03 10:41 ` William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 19/33] counter: Standardize to ERANGE for limit exceeded errors William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 20/33] counter: Rename counter_signal_value to counter_signal_level William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 21/33] counter: Rename counter_count_function to counter_function William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 23/33] counter: Update counter.h comments to reflect sysfs internalization William Breathitt Gray
2021-06-09 16:55 ` Jonathan Cameron
2021-06-09 1:31 ` [PATCH v11 24/33] docs: counter: Update " William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 25/33] counter: Move counter enums to uapi header William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 26/33] counter: Add character device interface William Breathitt Gray
2021-06-09 8:07 ` Dan Carpenter
2021-06-09 8:28 ` William Breathitt Gray
2021-06-09 8:59 ` Dan Carpenter
2021-06-09 14:16 ` William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 27/33] docs: counter: Document " William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 28/33] tools/counter: Create Counter tools William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 29/33] counter: Implement signalZ_action_component_id sysfs attribute William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 30/33] counter: Implement *_component_id sysfs attributes William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 31/33] counter: Implement events_queue_size sysfs attribute William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 32/33] counter: 104-quad-8: Replace mutex with spinlock William Breathitt Gray
2021-06-09 1:31 ` [PATCH v11 33/33] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 William Breathitt Gray
2021-06-09 17:27 ` Jonathan Cameron
2021-06-09 13:59 ` [PATCH v11 00/33] Introduce the Counter character device interface Jonathan Cameron
2021-06-09 14:26 ` William Breathitt Gray
[not found] ` <87dec6c889e40068ed27cbb3e66a6376856e2267.1623201082.git.vilhelm.gray@gmail.com>
2021-06-09 16:51 ` [RESEND PATCH v11 22/33] counter: Internalize sysfs interface code 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=20210609155558.502a1b11@jic23-huawei \
--to=jic23@kernel.org \
--cc=a.fatoum@pengutronix.de \
--cc=alexandre.belloni@bootlin.com \
--cc=alexandre.torgue@st.com \
--cc=david@lechnology.com \
--cc=fabrice.gasnier@st.com \
--cc=gwendal@chromium.org \
--cc=jarkko.nikula@linux.intel.com \
--cc=kamel.bouhara@bootlin.com \
--cc=kernel@pengutronix.de \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-stm32@st-md-mailman.stormreply.com \
--cc=mcoquelin.stm32@gmail.com \
--cc=o.rempel@pengutronix.de \
--cc=patrick.havelange@essensium.com \
--cc=syednwaris@gmail.com \
--cc=vilhelm.gray@gmail.com \
/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).