TechPanelGM/kernel_xiaomi_sm8250
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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: Changbin Du <changbin.du@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Changbin Du
2018-02-17 13:39:50 +08:00
committed by Jonathan Corbet
parent 6613581ecd
commit 1606f8d8e7
2 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/trace/index.rst
View File

@@ -20,3 +20,4 @@ Linux Tracing Technologies
mmiotrace mmiotrace
hwlat_detector hwlat_detector
intel_th intel_th
stm

23
Documentation/trace/stm.txt → Documentation/trace/stm.rst
View File

@@ -1,3 +1,4 @@
===================
System Trace Module System Trace Module
=================== ===================
@@ -32,14 +33,14 @@ associated with it, located in "stp-policy" subsystem directory in
configfs. The topmost directory's name (the policy) is formatted as configfs. The topmost directory's name (the policy) is formatted as
the STM device name to which this policy applies and and arbitrary the STM device name to which this policy applies and and arbitrary
string identifier separated by a stop. From the examle above, a rule string identifier separated by a stop. From the examle above, a rule
may look like this: may look like this::
$ ls /config/stp-policy/dummy_stm.my-policy/user $ ls /config/stp-policy/dummy_stm.my-policy/user
channels masters channels masters
$ cat /config/stp-policy/dummy_stm.my-policy/user/masters $ cat /config/stp-policy/dummy_stm.my-policy/user/masters
48 63 48 63
$ cat /config/stp-policy/dummy_stm.my-policy/user/channels $ cat /config/stp-policy/dummy_stm.my-policy/user/channels
0 127 0 127
which means that the master allocation pool for this rule consists of which means that the master allocation pool for this rule consists of
masters 48 through 63 and channel allocation pool has channels 0 masters 48 through 63 and channel allocation pool has channels 0
@@ -78,9 +79,9 @@ stm_source
For kernel-based trace sources, there is "stm_source" device For kernel-based trace sources, there is "stm_source" device
class. Devices of this class can be connected and disconnected to/from class. Devices of this class can be connected and disconnected to/from
stm devices at runtime via a sysfs attribute called "stm_source_link" stm devices at runtime via a sysfs attribute called "stm_source_link"
by writing the name of the desired stm device there, for example: by writing the name of the desired stm device there, for example::
$ echo dummy_stm.0 > /sys/class/stm_source/console/stm_source_link $ echo dummy_stm.0 > /sys/class/stm_source/console/stm_source_link
For examples on how to use stm_source interface in the kernel, refer For examples on how to use stm_source interface in the kernel, refer
to stm_console, stm_heartbeat or stm_ftrace drivers. to stm_console, stm_heartbeat or stm_ftrace drivers.
@@ -118,5 +119,5 @@ the same time.
Currently only Ftrace "function" tracer is supported. Currently only Ftrace "function" tracer is supported.
[1] https://software.intel.com/sites/default/files/managed/d3/3c/intel-th-developer-manual.pdf * [1] https://software.intel.com/sites/default/files/managed/d3/3c/intel-th-developer-manual.pdf
[2] http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0444b/index.html * [2] http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0444b/index.html