Skip to content

Commit c8dff67

Browse files
bagasmewilldeacon
authored andcommitted
Documentation: perf: Indent filter options list of hisi-pcie-pmu
The "Filter options" list have a rather ugly indentation. Also, the first paragraph after list name is rendered without separator (as continuation from the name). Align the list by indenting the list items and add a blank line separator for each list name. Reviewed-by: Jonathan Cameron <[email protected]> Signed-off-by: Bagas Sanjaya <[email protected]> Signed-off-by: Yicong Yang <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Will Deacon <[email protected]>
1 parent eb79f12 commit c8dff67

File tree

1 file changed

+43
-37
lines changed

1 file changed

+43
-37
lines changed

Documentation/admin-guide/perf/hisi-pcie-pmu.rst

Lines changed: 43 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -48,59 +48,65 @@ Filter options
4848
--------------
4949

5050
1. Target filter
51-
PMU could only monitor the performance of traffic downstream target Root Ports
52-
or downstream target Endpoint. PCIe PMU driver support "port" and "bdf"
53-
interfaces for users, and these two interfaces aren't supported at the same
54-
time.
5551

56-
-port
57-
"port" filter can be used in all PCIe PMU events, target Root Port can be
58-
selected by configuring the 16-bits-bitmap "port". Multi ports can be selected
59-
for AP-layer-events, and only one port can be selected for TL/DL-layer-events.
52+
PMU could only monitor the performance of traffic downstream target Root
53+
Ports or downstream target Endpoint. PCIe PMU driver support "port" and
54+
"bdf" interfaces for users, and these two interfaces aren't supported at the
55+
same time.
6056

61-
For example, if target Root Port is 0000:00:00.0 (x8 lanes), bit0 of bitmap
62-
should be set, port=0x1; if target Root Port is 0000:00:04.0 (x4 lanes),
63-
bit8 is set, port=0x100; if these two Root Ports are both monitored, port=0x101.
57+
- port
6458

65-
Example usage of perf::
59+
"port" filter can be used in all PCIe PMU events, target Root Port can be
60+
selected by configuring the 16-bits-bitmap "port". Multi ports can be
61+
selected for AP-layer-events, and only one port can be selected for
62+
TL/DL-layer-events.
6663

67-
$# perf stat -e hisi_pcie0_core0/rx_mwr_latency,port=0x1/ sleep 5
64+
For example, if target Root Port is 0000:00:00.0 (x8 lanes), bit0 of
65+
bitmap should be set, port=0x1; if target Root Port is 0000:00:04.0 (x4
66+
lanes), bit8 is set, port=0x100; if these two Root Ports are both
67+
monitored, port=0x101.
6868

69-
-bdf
69+
Example usage of perf::
7070

71-
"bdf" filter can only be used in bandwidth events, target Endpoint is selected
72-
by configuring BDF to "bdf". Counter only counts the bandwidth of message
73-
requested by target Endpoint.
71+
$# perf stat -e hisi_pcie0_core0/rx_mwr_latency,port=0x1/ sleep 5
7472

75-
For example, "bdf=0x3900" means BDF of target Endpoint is 0000:39:00.0.
73+
- bdf
7674

77-
Example usage of perf::
75+
"bdf" filter can only be used in bandwidth events, target Endpoint is
76+
selected by configuring BDF to "bdf". Counter only counts the bandwidth of
77+
message requested by target Endpoint.
78+
79+
For example, "bdf=0x3900" means BDF of target Endpoint is 0000:39:00.0.
80+
81+
Example usage of perf::
7882

79-
$# perf stat -e hisi_pcie0_core0/rx_mrd_flux,bdf=0x3900/ sleep 5
83+
$# perf stat -e hisi_pcie0_core0/rx_mrd_flux,bdf=0x3900/ sleep 5
8084

8185
2. Trigger filter
82-
Event statistics start when the first time TLP length is greater/smaller
83-
than trigger condition. You can set the trigger condition by writing "trig_len",
84-
and set the trigger mode by writing "trig_mode". This filter can only be used
85-
in bandwidth events.
8686

87-
For example, "trig_len=4" means trigger condition is 2^4 DW, "trig_mode=0"
88-
means statistics start when TLP length > trigger condition, "trig_mode=1"
89-
means start when TLP length < condition.
87+
Event statistics start when the first time TLP length is greater/smaller
88+
than trigger condition. You can set the trigger condition by writing
89+
"trig_len", and set the trigger mode by writing "trig_mode". This filter can
90+
only be used in bandwidth events.
9091

91-
Example usage of perf::
92+
For example, "trig_len=4" means trigger condition is 2^4 DW, "trig_mode=0"
93+
means statistics start when TLP length > trigger condition, "trig_mode=1"
94+
means start when TLP length < condition.
95+
96+
Example usage of perf::
9297

93-
$# perf stat -e hisi_pcie0_core0/rx_mrd_flux,trig_len=0x4,trig_mode=1/ sleep 5
98+
$# perf stat -e hisi_pcie0_core0/rx_mrd_flux,trig_len=0x4,trig_mode=1/ sleep 5
9499

95100
3. Threshold filter
96-
Counter counts when TLP length within the specified range. You can set the
97-
threshold by writing "thr_len", and set the threshold mode by writing
98-
"thr_mode". This filter can only be used in bandwidth events.
99101

100-
For example, "thr_len=4" means threshold is 2^4 DW, "thr_mode=0" means
101-
counter counts when TLP length >= threshold, and "thr_mode=1" means counts
102-
when TLP length < threshold.
102+
Counter counts when TLP length within the specified range. You can set the
103+
threshold by writing "thr_len", and set the threshold mode by writing
104+
"thr_mode". This filter can only be used in bandwidth events.
103105

104-
Example usage of perf::
106+
For example, "thr_len=4" means threshold is 2^4 DW, "thr_mode=0" means
107+
counter counts when TLP length >= threshold, and "thr_mode=1" means counts
108+
when TLP length < threshold.
109+
110+
Example usage of perf::
105111

106-
$# perf stat -e hisi_pcie0_core0/rx_mrd_flux,thr_len=0x4,thr_mode=1/ sleep 5
112+
$# perf stat -e hisi_pcie0_core0/rx_mrd_flux,thr_len=0x4,thr_mode=1/ sleep 5

0 commit comments

Comments
 (0)