treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / admin-guide / perf / xgene-pmu.rst
blob644f8ed89152d69cfdbd97485bf2557948fd96e5
1 ================================================
2 APM X-Gene SoC Performance Monitoring Unit (PMU)
3 ================================================
5 X-Gene SoC PMU consists of various independent system device PMUs such as
6 L3 cache(s), I/O bridge(s), memory controller bridge(s) and memory
7 controller(s). These PMU devices are loosely architected to follow the
8 same model as the PMU for ARM cores. The PMUs share the same top level
9 interrupt and status CSR region.
11 PMU (perf) driver
12 -----------------
14 The xgene-pmu driver registers several perf PMU drivers. Each of the perf
15 driver provides description of its available events and configuration options
16 in sysfs, see /sys/devices/<l3cX/iobX/mcbX/mcX>/.
18 The "format" directory describes format of the config (event ID),
19 config1 (agent ID) fields of the perf_event_attr structure. The "events"
20 directory provides configuration templates for all supported event types that
21 can be used with perf tool. For example, "l3c0/bank-fifo-full/" is an
22 equivalent of "l3c0/config=0x0b/".
24 Most of the SoC PMU has a specific list of agent ID used for monitoring
25 performance of a specific datapath. For example, agents of a L3 cache can be
26 a specific CPU or an I/O bridge. Each PMU has a set of 2 registers capable of
27 masking the agents from which the request come from. If the bit with
28 the bit number corresponding to the agent is set, the event is counted only if
29 it is caused by a request from that agent. Each agent ID bit is inversely mapped
30 to a corresponding bit in "config1" field. By default, the event will be
31 counted for all agent requests (config1 = 0x0). For all the supported agents of
32 each PMU, please refer to APM X-Gene User Manual.
34 Each perf driver also provides a "cpumask" sysfs attribute, which contains a
35 single CPU ID of the processor which will be used to handle all the PMU events.
37 Example for perf tool use::
39  / # perf list | grep -e l3c -e iob -e mcb -e mc
40    l3c0/ackq-full/                                    [Kernel PMU event]
41  <...>
42    mcb1/mcb-csw-stall/                                [Kernel PMU event]
44  / # perf stat -a -e l3c0/read-miss/,mcb1/csw-write-request/ sleep 1
46  / # perf stat -a -e l3c0/read-miss,config1=0xfffffffffffffffe/ sleep 1
48 The driver does not support sampling, therefore "perf record" will
49 not work. Per-task (without "-a") perf sessions are not supported.