Commit c8dff677 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Will Deacon
Browse files

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: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarYicong Yang <yangyicong@hisilicon.com>
Link: https://lore.kernel.org/r/20221117084136.53572-4-yangyicong@huawei.com


Signed-off-by: default avatarWill Deacon <will@kernel.org>
parent eb79f12b

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

+43 −37
Original line number Diff line number Diff line
@@ -48,19 +48,23 @@ Filter options 
--------------



1. Target filter

PMU could only monitor the performance of traffic downstream target Root Ports

or downstream target Endpoint. PCIe PMU driver support "port" and "bdf"

interfaces for users, and these two interfaces aren't supported at the same

time.



   PMU could only monitor the performance of traffic downstream target Root

   Ports or downstream target Endpoint. PCIe PMU driver support "port" and

   "bdf" interfaces for users, and these two interfaces aren't supported at the

   same time.



   - port



     "port" filter can be used in all PCIe PMU events, target Root Port can be

selected by configuring the 16-bits-bitmap "port". Multi ports can be selected

for AP-layer-events, and only one port can be selected for TL/DL-layer-events.

     selected by configuring the 16-bits-bitmap "port". Multi ports can be

     selected for AP-layer-events, and only one port can be selected for

     TL/DL-layer-events.



For example, if target Root Port is 0000:00:00.0 (x8 lanes), bit0 of bitmap

should be set, port=0x1; if target Root Port is 0000:00:04.0 (x4 lanes),

bit8 is set, port=0x100; if these two Root Ports are both monitored, port=0x101.

     For example, if target Root Port is 0000:00:00.0 (x8 lanes), bit0 of

     bitmap should be set, port=0x1; if target Root Port is 0000:00:04.0 (x4

     lanes), bit8 is set, port=0x100; if these two Root Ports are both

     monitored, port=0x101.



     Example usage of perf::
@@ -68,9 +72,9 @@ Example usage of perf:: 


   - bdf



"bdf" filter can only be used in bandwidth events, target Endpoint is selected

by configuring BDF to "bdf". Counter only counts the bandwidth of message

requested by target Endpoint.

     "bdf" filter can only be used in bandwidth events, target Endpoint is

     selected by configuring BDF to "bdf". Counter only counts the bandwidth of

     message requested by target Endpoint.



     For example, "bdf=0x3900" means BDF of target Endpoint is 0000:39:00.0.
@@ -79,10 +83,11 @@ Example usage of perf:: 
       $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,bdf=0x3900/ sleep 5



2. Trigger filter



   Event statistics start when the first time TLP length is greater/smaller

than trigger condition. You can set the trigger condition by writing "trig_len",

and set the trigger mode by writing "trig_mode". This filter can only be used

in bandwidth events.

   than trigger condition. You can set the trigger condition by writing

   "trig_len", and set the trigger mode by writing "trig_mode". This filter can

   only be used in bandwidth events.



   For example, "trig_len=4" means trigger condition is 2^4 DW, "trig_mode=0"

   means statistics start when TLP length > trigger condition, "trig_mode=1"
@@ -93,6 +98,7 @@ Example usage of perf:: 
     $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,trig_len=0x4,trig_mode=1/ sleep 5



3. Threshold filter



   Counter counts when TLP length within the specified range. You can set the

   threshold by writing "thr_len", and set the threshold mode by writing

   "thr_mode". This filter can only be used in bandwidth events.