diff mbox series

[v4,2/3] Documentation: ABI: add sysfs-bus-counter-ecap

Message ID 20220810140724.182389-3-jpanis@baylibre.com (mailing list archive)
State Handled Elsewhere
Headers show
Series ECAP support on TI AM62x SoC | expand

Commit Message

Julien Panis Aug. 10, 2022, 2:07 p.m. UTC
This commit adds an ABI file for TI ECAP used in capture operating mode.

Signed-off-by: Julien Panis <jpanis@baylibre.com>
---
 .../ABI/testing/sysfs-bus-counter-ecap        | 64 +++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-counter-ecap

Comments

William Breathitt Gray Aug. 13, 2022, 10:47 p.m. UTC | #1
On Wed, Aug 10, 2022 at 04:07:23PM +0200, Julien Panis wrote:
> This commit adds an ABI file for TI ECAP used in capture operating mode.
> 
> Signed-off-by: Julien Panis <jpanis@baylibre.com>

Hi Julien,

Duplicate ABIs are no longer valid, so we consolidated the Counter sysfs
attributes documentation to a single sysfs-bus-counter file in commit
769841c966fd. You can document the new sysfs attributes you introduce
for the TI eCAP counter driver to that sysfs-bus-counter file as well.

William Breathitt Gray

> ---
>  .../ABI/testing/sysfs-bus-counter-ecap        | 64 +++++++++++++++++++
>  1 file changed, 64 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-counter-ecap
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-counter-ecap b/Documentation/ABI/testing/sysfs-bus-counter-ecap
> new file mode 100644
> index 000000000000..ca530a6806de
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-counter-ecap
> @@ -0,0 +1,64 @@
> +What:		/sys/bus/counter/devices/counter0/signal0/polarity1
> +What:		/sys/bus/counter/devices/counter0/signal0/polarity2
> +What:		/sys/bus/counter/devices/counter0/signal0/polarity3
> +What:		/sys/bus/counter/devices/counter0/signal0/polarity4
> +KernelVersion:	5.19
> +Contact:	jpanis@baylibre.com
> +Description:
> +		ECAP module includes 4 timestamp capture registers.
> +		For all 4 sequenced timestamp capture events (1->2->3->4->1->...),
> +		edge polarity can be selected. Then, each capture register can be
> +		tuned to capture event by either:
> +
> +		- "rising"
> +		- "falling"
> +
> +		Reading returns current trigger polarity.
> +
> +		Writing value before enabling capture sets trigger polarity.
> +
> +What:		/sys/bus/counter/devices/counter0/signal0/polarity1_available
> +What:		/sys/bus/counter/devices/counter0/signal0/polarity2_available
> +What:		/sys/bus/counter/devices/counter0/signal0/polarity3_available
> +What:		/sys/bus/counter/devices/counter0/signal0/polarity4_available
> +KernelVersion:	5.19
> +Contact:	jpanis@baylibre.com
> +Description:
> +		Discrete set of available values for the respective polarity X
> +		configuration are listed in this file. Values are delimited by
> +		newline characters.
> +
> +What:		/sys/bus/counter/devices/counter0/count0/enable
> +KernelVersion:	5.19
> +Contact:	jpanis@baylibre.com
> +Description:
> +		Whether ECAP is enabled. Valid attribute values are boolean.
> +
> +		This attribute is intended to serve as a start/stop mechanism
> +		for ECAP.
> +
> +What:		/sys/bus/counter/devices/counter0/count0/count
> +KernelVersion:	5.19
> +Contact:	jpanis@baylibre.com
> +Description:
> +		Read-only attribute that indicates the current base counter value.
> +
> +What:		/sys/bus/counter/devices/counter0/count0/capture1
> +What:		/sys/bus/counter/devices/counter0/count0/capture2
> +What:		/sys/bus/counter/devices/counter0/count0/capture3
> +What:		/sys/bus/counter/devices/counter0/count0/capture4
> +KernelVersion:	5.19
> +Contact:	jpanis@baylibre.com
> +Description:
> +		Read-only attributes that indicate the last timestamp captured
> +		for the respective capture X register.
> +
> +What:		/sys/bus/counter/devices/counter0/count0/capture1_component_id
> +What:		/sys/bus/counter/devices/counter0/count0/capture2_component_id
> +What:		/sys/bus/counter/devices/counter0/count0/capture3_component_id
> +What:		/sys/bus/counter/devices/counter0/count0/capture4_component_id
> +KernelVersion:	5.19
> +Contact:	jpanis@baylibre.com
> +Description:
> +		Read-only attributes that indicate the component ID of the
> +		respective extension or synapse.
> -- 
> 2.25.1
>
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-counter-ecap b/Documentation/ABI/testing/sysfs-bus-counter-ecap
new file mode 100644
index 000000000000..ca530a6806de
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-counter-ecap
@@ -0,0 +1,64 @@ 
+What:		/sys/bus/counter/devices/counter0/signal0/polarity1
+What:		/sys/bus/counter/devices/counter0/signal0/polarity2
+What:		/sys/bus/counter/devices/counter0/signal0/polarity3
+What:		/sys/bus/counter/devices/counter0/signal0/polarity4
+KernelVersion:	5.19
+Contact:	jpanis@baylibre.com
+Description:
+		ECAP module includes 4 timestamp capture registers.
+		For all 4 sequenced timestamp capture events (1->2->3->4->1->...),
+		edge polarity can be selected. Then, each capture register can be
+		tuned to capture event by either:
+
+		- "rising"
+		- "falling"
+
+		Reading returns current trigger polarity.
+
+		Writing value before enabling capture sets trigger polarity.
+
+What:		/sys/bus/counter/devices/counter0/signal0/polarity1_available
+What:		/sys/bus/counter/devices/counter0/signal0/polarity2_available
+What:		/sys/bus/counter/devices/counter0/signal0/polarity3_available
+What:		/sys/bus/counter/devices/counter0/signal0/polarity4_available
+KernelVersion:	5.19
+Contact:	jpanis@baylibre.com
+Description:
+		Discrete set of available values for the respective polarity X
+		configuration are listed in this file. Values are delimited by
+		newline characters.
+
+What:		/sys/bus/counter/devices/counter0/count0/enable
+KernelVersion:	5.19
+Contact:	jpanis@baylibre.com
+Description:
+		Whether ECAP is enabled. Valid attribute values are boolean.
+
+		This attribute is intended to serve as a start/stop mechanism
+		for ECAP.
+
+What:		/sys/bus/counter/devices/counter0/count0/count
+KernelVersion:	5.19
+Contact:	jpanis@baylibre.com
+Description:
+		Read-only attribute that indicates the current base counter value.
+
+What:		/sys/bus/counter/devices/counter0/count0/capture1
+What:		/sys/bus/counter/devices/counter0/count0/capture2
+What:		/sys/bus/counter/devices/counter0/count0/capture3
+What:		/sys/bus/counter/devices/counter0/count0/capture4
+KernelVersion:	5.19
+Contact:	jpanis@baylibre.com
+Description:
+		Read-only attributes that indicate the last timestamp captured
+		for the respective capture X register.
+
+What:		/sys/bus/counter/devices/counter0/count0/capture1_component_id
+What:		/sys/bus/counter/devices/counter0/count0/capture2_component_id
+What:		/sys/bus/counter/devices/counter0/count0/capture3_component_id
+What:		/sys/bus/counter/devices/counter0/count0/capture4_component_id
+KernelVersion:	5.19
+Contact:	jpanis@baylibre.com
+Description:
+		Read-only attributes that indicate the component ID of the
+		respective extension or synapse.