diff mbox series

[v10,06/10] docs: sysfs: coresight: Add sysfs ABI documentation for TPDM

Message ID 20220611004331.7343-7-quic_jinlmao@quicinc.com
State New
Headers show
Series Coresight: Add support for TPDM and TPDA | expand

Commit Message

Mao Jinlong June 11, 2022, 12:43 a.m. UTC
Add API usage document for sysfs API in TPDM driver.

Reviewed-by: Mike Leach <mike.leach@linaro.org>
Signed-off-by: Mao Jinlong <quic_jinlmao@quicinc.com>
---
 .../ABI/testing/sysfs-bus-coresight-devices-tpdm    | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm

Comments

Suzuki K Poulose June 14, 2022, 10:13 p.m. UTC | #1
On 11/06/2022 01:43, Mao Jinlong wrote:
> Add API usage document for sysfs API in TPDM driver.
> 
> Reviewed-by: Mike Leach <mike.leach@linaro.org>
> Signed-off-by: Mao Jinlong <quic_jinlmao@quicinc.com>
> ---
>   .../ABI/testing/sysfs-bus-coresight-devices-tpdm    | 13 +++++++++++++
>   1 file changed, 13 insertions(+)
>   create mode 100644 Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> new file mode 100644
> index 000000000000..92bc09fbb69b
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
> @@ -0,0 +1,13 @@
> +What:		/sys/bus/coresight/devices/<tpdm-name>/integration_test
> +Date:		June 2022
> +KernelVersion	5.18

We have gone past this release. Please make this 5.20. Also, please 
merge this patch with the previous patch.

> +Contact:	Jinlong Mao (QUIC) <quic_jinlmao@quicinc.com>, Tao Zhang (QUIC) <quic_taozha@quicinc.com>
> +Description:
> +		(Write) Run integration test for tpdm. Integration test
> +		will generate test data for tpdm. It can help to make
> +		sure that the trace path is enabled and the link configurations
> +		are fine.
> +
> +		value to this sysfs node:

This is not entirely clear to me/reader. Could we say :

		Accepts only one of the 2 values -  1 or 2.
	
> +		1 : Generate 64 bits data
> +		2 : Generate 32 bits data


Suzuki
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
new file mode 100644
index 000000000000..92bc09fbb69b
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-tpdm
@@ -0,0 +1,13 @@ 
+What:		/sys/bus/coresight/devices/<tpdm-name>/integration_test
+Date:		June 2022
+KernelVersion	5.18
+Contact:	Jinlong Mao (QUIC) <quic_jinlmao@quicinc.com>, Tao Zhang (QUIC) <quic_taozha@quicinc.com>
+Description:
+		(Write) Run integration test for tpdm. Integration test
+		will generate test data for tpdm. It can help to make
+		sure that the trace path is enabled and the link configurations
+		are fine.
+
+		value to this sysfs node:
+		1 : Generate 64 bits data
+		2 : Generate 32 bits data