Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6613581e authored by Changbin Du's avatar Changbin Du Committed by Jonathan Corbet
Browse files

trace doc: convert trace/intel_th.txt to rst format 



This converts the plain text documentation to reStructuredText format and
add it into Sphinx TOC tree. No essential content change.

Cc: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: default avatarChangbin Du <changbin.du@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 8df2d75e

Documentation/trace/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -19,3 +19,4 @@ Linux Tracing Technologies 
   events-msr

   mmiotrace

   hwlat_detector

   intel_th

Documentation/trace/intel_th.txt→Documentation/trace/intel_th.rst

+22 −21
Original line number Diff line number Diff line 
=======================

Intel(R) Trace Hub (TH)

=======================
@@ -65,41 +66,41 @@ allocated, are accessible via /dev/intel_th0/msc{0,1}. 
Quick example

-------------



# figure out which GTH port is the first memory controller:

# figure out which GTH port is the first memory controller::



	$ cat /sys/bus/intel_th/devices/0-msc0/port

	0



# looks like it's port 0, configure master 33 to send data to port 0:

# looks like it's port 0, configure master 33 to send data to port 0::



	$ echo 0 > /sys/bus/intel_th/devices/0-gth/masters/33



# allocate a 2-windowed multiblock buffer on the first memory

# controller, each with 64 pages:

# controller, each with 64 pages::



	$ echo multi > /sys/bus/intel_th/devices/0-msc0/mode

	$ echo 64,64 > /sys/bus/intel_th/devices/0-msc0/nr_pages



# enable wrapping for this controller, too:

# enable wrapping for this controller, too::



	$ echo 1 > /sys/bus/intel_th/devices/0-msc0/wrap



# and enable tracing into this port:

# and enable tracing into this port::



	$ echo 1 > /sys/bus/intel_th/devices/0-msc0/active



# .. send data to master 33, see stm.txt for more details ..

# .. wait for traces to pile up ..

# .. and stop the trace:

# .. and stop the trace::



	$ echo 0 > /sys/bus/intel_th/devices/0-msc0/active



# and now you can collect the trace from the device node:

# and now you can collect the trace from the device node::



	$ cat /dev/intel_th0/msc0 > my_stp_trace



Host Debugger Mode

==================

------------------



It is possible to configure the Trace Hub and control its trace

capture from a remote debug host, which should be connected via one of