]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - Documentation/arm/CCN.txt
Merge branch 'core-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[mirror_ubuntu-bionic-kernel.git] / Documentation / arm / CCN.txt
CommitLineData
a33b0daa
PM
1ARM Cache Coherent Network
2==========================
3
4CCN-504 is a ring-bus interconnect consisting of 11 crosspoints
5(XPs), with each crosspoint supporting up to two device ports,
6so nodes (devices) 0 and 1 are connected to crosspoint 0,
7nodes 2 and 3 to crosspoint 1 etc.
8
9PMU (perf) driver
10-----------------
11
12The CCN driver registers a perf PMU driver, which provides
13description of available events and configuration options
14in sysfs, see /sys/bus/event_source/devices/ccn*.
15
16The "format" directory describes format of the config, config1
17and config2 fields of the perf_event_attr structure. The "events"
18directory provides configuration templates for all documented
19events, that can be used with perf tool. For example "xp_valid_flit"
20is an equivalent of "type=0x8,event=0x4". Other parameters must be
90d11e26 21explicitly specified.
a33b0daa 22
90d11e26
PM
23For events originating from device, "node" defines its index.
24
25Crosspoint PMU events require "xp" (index), "bus" (bus number)
26and "vc" (virtual channel ID).
27
28Crosspoint watchpoint-based events (special "event" value 0xfe)
29require "xp" and "vc" as as above plus "port" (device port index),
30"dir" (transmit/receive direction), comparator values ("cmp_l"
31and "cmp_h") and "mask", being index of the comparator mask.
a33b0daa
PM
32Masks are defined separately from the event description
33(due to limited number of the config values) in the "cmp_mask"
34directory, with first 8 configurable by user and additional
354 hardcoded for the most frequent use cases.
36
37Cycle counter is described by a "type" value 0xff and does
38not require any other settings.
39
ffa41524
PM
40The driver also provides a "cpumask" sysfs attribute, which contains
41a single CPU ID, of the processor which will be used to handle all
42the CCN PMU events. It is recommended that the user space tools
43request the events on this processor (if not, the perf_event->cpu value
44will be overwritten anyway). In case of this processor being offlined,
45the events are migrated to another one and the attribute is updated.
46
a33b0daa
PM
47Example of perf tool use:
48
49/ # perf list | grep ccn
50 ccn/cycles/ [Kernel PMU event]
51<...>
8f06c51f 52 ccn/xp_valid_flit,xp=?,port=?,vc=?,dir=?/ [Kernel PMU event]
a33b0daa
PM
53<...>
54
ffa41524 55/ # perf stat -a -e ccn/cycles/,ccn/xp_valid_flit,xp=1,port=0,vc=1,dir=1/ \
a33b0daa
PM
56 sleep 1
57
58The driver does not support sampling, therefore "perf record" will
ffa41524 59not work. Per-task (without "-a") perf sessions are not supported.