Merge tag 'docs-6.5-2' of git://git.lwn.net/linux
[linux-2.6-microblaze.git] / Documentation / trace / coresight / coresight-dummy.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 =============================
4 Coresight Dummy Trace Module
5 =============================
6
7     :Author:   Hao Zhang <quic_hazha@quicinc.com>
8     :Date:     June 2023
9
10 Introduction
11 ------------
12
13 The Coresight dummy trace module is for the specific devices that kernel don't
14 have permission to access or configure, e.g., CoreSight TPDMs on Qualcomm
15 platforms. For these devices, a dummy driver is needed to register them as
16 Coresight devices. The module may also be used to define components that may
17 not have any programming interfaces, so that paths can be created in the driver.
18 It provides Coresight API for operations on dummy devices, such as enabling and
19 disabling them. It also provides the Coresight dummy sink/source paths for
20 debugging.
21
22 Config details
23 --------------
24
25 There are two types of nodes, dummy sink and dummy source. These nodes
26 are available at ``/sys/bus/coresight/devices``.
27
28 Example output::
29
30     $ ls -l /sys/bus/coresight/devices | grep dummy
31     dummy_sink0 -> ../../../devices/platform/soc@0/soc@0:sink/dummy_sink0
32     dummy_source0 -> ../../../devices/platform/soc@0/soc@0:source/dummy_source0