diff mbox series

[v2,2/2] coresight: etm4x: docs: Add documentation for 'ts_source' sysfs interface

Message ID 20220503123537.1003035-2-german.gomez@arm.com (mailing list archive)
State New, archived
Headers show
Series [v2,1/2] coresight: etm4x: Expose default timestamp source in sysfs | expand

Commit Message

German Gomez May 3, 2022, 12:35 p.m. UTC
Sync sysfs documentation pages to include the new ts_source (timestamp
source) interface.

Signed-off-by: German Gomez <german.gomez@arm.com>
---
v1:
    - https://lore.kernel.org/all/20220429123100.268059-3-german.gomez@arm.com/
v2:
    - Update Data, KernelVersion, and Contact fields (Date is
      tentative but likely).
---
 .../ABI/testing/sysfs-bus-coresight-devices-etm4x  |  8 ++++++++
 .../trace/coresight/coresight-etm4x-reference.rst  | 14 ++++++++++++++
 2 files changed, 22 insertions(+)

Comments

German Gomez June 8, 2022, 12:50 p.m. UTC | #1
Hi,

Thanks for your comments and review in the previous submission (and
sorry for not including a cover letter this time).

Do you want me to hold on this change, or update the corresponding
fields with new estimates?

Thanks,
German

On 03/05/2022 13:35, German Gomez wrote:
> Sync sysfs documentation pages to include the new ts_source (timestamp
> source) interface.
>
> Signed-off-by: German Gomez <german.gomez@arm.com>
> ---
> v1:
>     - https://lore.kernel.org/all/20220429123100.268059-3-german.gomez@arm.com/
> v2:
>     - Update Data, KernelVersion, and Contact fields (Date is
>       tentative but likely).
> ---
>  .../ABI/testing/sysfs-bus-coresight-devices-etm4x  |  8 ++++++++
>  .../trace/coresight/coresight-etm4x-reference.rst  | 14 ++++++++++++++
>  2 files changed, 22 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x b/Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x
> index 8e53a32f81505..520dd2e27eab3 100644
> --- a/Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x
> +++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x
> @@ -516,3 +516,11 @@ Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>
>  Description:	(Read) Returns the number of special conditional P1 right-hand keys
>  		that the trace unit can use (0x194).  The value is taken
>  		directly from the HW.
> +
> +What:		/sys/bus/coresight/devices/etm<N>/ts_source
> +Date:		July 2022
> +KernelVersion:	5.19
> +Contact:	Mathieu Poirier <mathieu.poirier@linaro.org> or Suzuki K Poulose <suzuki.poulose@arm.com>
> +Description:	(Read) When FEAT_TRF is implemented, value of TRFCR_ELx.TS used for
> +		trace session. Otherwise -1 indicates an unknown time source. Check
> +		trcidr0.tssize to see if a global timestamp is available.
> diff --git a/Documentation/trace/coresight/coresight-etm4x-reference.rst b/Documentation/trace/coresight/coresight-etm4x-reference.rst
> index d25dfe86af9bf..f016c7c29429b 100644
> --- a/Documentation/trace/coresight/coresight-etm4x-reference.rst
> +++ b/Documentation/trace/coresight/coresight-etm4x-reference.rst
> @@ -71,6 +71,20 @@ the ‘TRC’ prefix.
>  
>  ----
>  
> +:File:            ``ts_source`` (ro)
> +:Trace Registers: None.
> +:Notes:
> +    When FEAT_TRF is implemented, value of TRFCR_ELx.TS used for trace session. Otherwise -1
> +    indicates an unknown time source. Check trcidr0.tssize to see if a global timestamp is
> +    available.
> +
> +:Example:
> +    ``$> cat ts_source``
> +
> +    ``$> 1``
> +
> +----
> +
>  :File:            ``addr_idx`` (rw)
>  :Trace Registers: None.
>  :Notes:
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x b/Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x
index 8e53a32f81505..520dd2e27eab3 100644
--- a/Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x
+++ b/Documentation/ABI/testing/sysfs-bus-coresight-devices-etm4x
@@ -516,3 +516,11 @@  Contact:	Mathieu Poirier <mathieu.poirier@linaro.org>
 Description:	(Read) Returns the number of special conditional P1 right-hand keys
 		that the trace unit can use (0x194).  The value is taken
 		directly from the HW.
+
+What:		/sys/bus/coresight/devices/etm<N>/ts_source
+Date:		July 2022
+KernelVersion:	5.19
+Contact:	Mathieu Poirier <mathieu.poirier@linaro.org> or Suzuki K Poulose <suzuki.poulose@arm.com>
+Description:	(Read) When FEAT_TRF is implemented, value of TRFCR_ELx.TS used for
+		trace session. Otherwise -1 indicates an unknown time source. Check
+		trcidr0.tssize to see if a global timestamp is available.
diff --git a/Documentation/trace/coresight/coresight-etm4x-reference.rst b/Documentation/trace/coresight/coresight-etm4x-reference.rst
index d25dfe86af9bf..f016c7c29429b 100644
--- a/Documentation/trace/coresight/coresight-etm4x-reference.rst
+++ b/Documentation/trace/coresight/coresight-etm4x-reference.rst
@@ -71,6 +71,20 @@  the ‘TRC’ prefix.
 
 ----
 
+:File:            ``ts_source`` (ro)
+:Trace Registers: None.
+:Notes:
+    When FEAT_TRF is implemented, value of TRFCR_ELx.TS used for trace session. Otherwise -1
+    indicates an unknown time source. Check trcidr0.tssize to see if a global timestamp is
+    available.
+
+:Example:
+    ``$> cat ts_source``
+
+    ``$> 1``
+
+----
+
 :File:            ``addr_idx`` (rw)
 :Trace Registers: None.
 :Notes: