2022-09-21 10:45:50

by Julien Panis

[permalink] [raw]

Subject: [PATCH v7 2/4] Documentation: ABI: sysfs-bus-counter: add frequency & num_overflows items

---

This commit adds frequency and num_overflows items to counter ABI file
(e.g. for TI ECAP hardware used in capture operating mode).

Signed-off-by: Julien Panis <[email protected]>
---
Documentation/ABI/testing/sysfs-bus-counter | 14 ++++++++++++++
1 file changed, 14 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter
index 30b6e1faa6f6..aea0adc3938f 100644
--- a/Documentation/ABI/testing/sysfs-bus-counter
+++ b/Documentation/ABI/testing/sysfs-bus-counter
@@ -209,6 +209,12 @@ Description:
both edges:
Any state transition.

+What: /sys/bus/counter/devices/counterX/countY/num_overflows
+KernelVersion: 6.0
+Contact: [email protected]
+Description:
+ This attribute indicates the number of overflows since count Y start.
+
What: /sys/bus/counter/devices/counterX/countY/ceiling_component_id
What: /sys/bus/counter/devices/counterX/countY/floor_component_id
What: /sys/bus/counter/devices/counterX/countY/count_mode_component_id
@@ -219,11 +225,13 @@ What: /sys/bus/counter/devices/counterX/countY/prescaler_component_id
What: /sys/bus/counter/devices/counterX/countY/preset_component_id
What: /sys/bus/counter/devices/counterX/countY/preset_enable_component_id
What: /sys/bus/counter/devices/counterX/countY/signalZ_action_component_id
+What: /sys/bus/counter/devices/counterX/countY/num_overflows_component_id
What: /sys/bus/counter/devices/counterX/signalY/cable_fault_component_id
What: /sys/bus/counter/devices/counterX/signalY/cable_fault_enable_component_id
What: /sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler_component_id
What: /sys/bus/counter/devices/counterX/signalY/index_polarity_component_id
What: /sys/bus/counter/devices/counterX/signalY/synchronous_mode_component_id
+What: /sys/bus/counter/devices/counterX/signalY/frequency_component_id
KernelVersion: 5.16
Contact: [email protected]
Description:
@@ -364,3 +372,9 @@ Description:
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.
+
+What: /sys/bus/counter/devices/counterX/signalY/frequency
+KernelVersion: 6.0
+Contact: [email protected]
+Description:
+ Read-only attribute that indicates the signal Y frequency, in Hz.
--
2.37.3

2022-09-22 02:38:34

by William Breathitt Gray

[permalink] [raw]

Subject: Re: [PATCH v7 2/4] Documentation: ABI: sysfs-bus-counter: add frequency & num_overflows items

---

On Wed, Sep 21, 2022 at 12:06:25PM +0200, Julien Panis wrote:
> This commit adds frequency and num_overflows items to counter ABI file
> (e.g. for TI ECAP hardware used in capture operating mode).
>
> Signed-off-by: Julien Panis <[email protected]>
> ---
> Documentation/ABI/testing/sysfs-bus-counter | 14 ++++++++++++++
> 1 file changed, 14 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter
> index 30b6e1faa6f6..aea0adc3938f 100644
> --- a/Documentation/ABI/testing/sysfs-bus-counter
> +++ b/Documentation/ABI/testing/sysfs-bus-counter
> @@ -209,6 +209,12 @@ Description:
> both edges:
> Any state transition.
>
> +What: /sys/bus/counter/devices/counterX/countY/num_overflows
> +KernelVersion: 6.0
> +Contact: [email protected]
> +Description:
> + This attribute indicates the number of overflows since count Y start.
> +

Update KernelVersion to "6.1" because that is the next merge target.
Change Contact to "[email protected]" since this ABI is
available for all Counter drivers.

Since num_overflows can be reset, replace the "since count Y start"
phrase with "of Count Y" instead.

> What: /sys/bus/counter/devices/counterX/countY/ceiling_component_id
> What: /sys/bus/counter/devices/counterX/countY/floor_component_id
> What: /sys/bus/counter/devices/counterX/countY/count_mode_component_id
> @@ -219,11 +225,13 @@ What: /sys/bus/counter/devices/counterX/countY/prescaler_component_id
> What: /sys/bus/counter/devices/counterX/countY/preset_component_id
> What: /sys/bus/counter/devices/counterX/countY/preset_enable_component_id
> What: /sys/bus/counter/devices/counterX/countY/signalZ_action_component_id
> +What: /sys/bus/counter/devices/counterX/countY/num_overflows_component_id
> What: /sys/bus/counter/devices/counterX/signalY/cable_fault_component_id
> What: /sys/bus/counter/devices/counterX/signalY/cable_fault_enable_component_id
> What: /sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler_component_id
> What: /sys/bus/counter/devices/counterX/signalY/index_polarity_component_id
> What: /sys/bus/counter/devices/counterX/signalY/synchronous_mode_component_id
> +What: /sys/bus/counter/devices/counterX/signalY/frequency_component_id
> KernelVersion: 5.16
> Contact: [email protected]
> Description:
> @@ -364,3 +372,9 @@ Description:
> 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.
> +
> +What: /sys/bus/counter/devices/counterX/signalY/frequency
> +KernelVersion: 6.0
> +Contact: [email protected]

Same changes for KernelVersion and Contact here as above.

William Breathitt Gray

---

Attachments:

(No filename) (2.78 kB)
signature.asc (235.00 B)
Download all attachments