Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: trace: Add documentation for TRBE

Add documentation for the TRBE under trace/coresight.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Anshuman Khandual <anshuman.khandual@arm.com>
[ Split from the TRBE driver patch ]
Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com>
Link: https://lore.kernel.org/r/20210405164307.1720226-20-suzuki.poulose@arm.com
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org>

authored by

Anshuman Khandual and committed by
Mathieu Poirier
4af43218 b20f34ae

+38
+38
Documentation/trace/coresight/coresight-trbe.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ============================== 4 + Trace Buffer Extension (TRBE). 5 + ============================== 6 + 7 + :Author: Anshuman Khandual <anshuman.khandual@arm.com> 8 + :Date: November 2020 9 + 10 + Hardware Description 11 + -------------------- 12 + 13 + Trace Buffer Extension (TRBE) is a percpu hardware which captures in system 14 + memory, CPU traces generated from a corresponding percpu tracing unit. This 15 + gets plugged in as a coresight sink device because the corresponding trace 16 + generators (ETE), are plugged in as source device. 17 + 18 + The TRBE is not compliant to CoreSight architecture specifications, but is 19 + driven via the CoreSight driver framework to support the ETE (which is 20 + CoreSight compliant) integration. 21 + 22 + Sysfs files and directories 23 + --------------------------- 24 + 25 + The TRBE devices appear on the existing coresight bus alongside the other 26 + coresight devices:: 27 + 28 + >$ ls /sys/bus/coresight/devices 29 + trbe0 trbe1 trbe2 trbe3 30 + 31 + The ``trbe<N>`` named TRBEs are associated with a CPU.:: 32 + 33 + >$ ls /sys/bus/coresight/devices/trbe0/ 34 + align flag 35 + 36 + *Key file items are:-* 37 + * ``align``: TRBE write pointer alignment 38 + * ``flag``: TRBE updates memory with access and dirty flags