WIP FPC-III support
[linux/fpc-iii.git] / Documentation / ABI / testing / sysfs-bus-event_source-devices-hv_24x7
blobde390a010af857354f22e527db0c03cac4c6976e
1 What:           /sys/bus/event_source/devices/hv_24x7/format
2 Date:           September 2020
3 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
4 Description:    Read-only. Attribute group to describe the magic bits
5                 that go into perf_event_attr.config for a particular pmu.
6                 (See ABI/testing/sysfs-bus-event_source-devices-format).
8                 Each attribute under this group defines a bit range of the
9                 perf_event_attr.config. All supported attributes are listed
10                 below::
12                                 chip = "config:16-31"
13                                 core  = "config:16-31"
14                                 domain = "config:0-3"
15                                 lpar = "config:0-15"
16                                 offset = "config:32-63"
17                                 vcpu = "config:16-31"
19                 For example::
21                   PM_PB_CYC =  "domain=1,offset=0x80,chip=?,lpar=0x0"
23                 In this event, '?' after chip specifies that
24                 this value will be provided by user while running this event.
26 What:           /sys/bus/event_source/devices/hv_24x7/interface/catalog
27 Date:           February 2014
28 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
29 Description:
30                 Provides access to the binary "24x7 catalog" provided by the
31                 hypervisor on POWER7 and 8 systems. This catalog lists events
32                 available from the powerpc "hv_24x7" pmu. Its format is
33                 documented here:
34                 https://raw.githubusercontent.com/jmesmon/catalog-24x7/master/hv-24x7-catalog.h
36 What:           /sys/bus/event_source/devices/hv_24x7/interface/catalog_length
37 Date:           February 2014
38 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
39 Description:
40                 A number equal to the length in bytes of the catalog. This is
41                 also extractable from the provided binary "catalog" sysfs entry.
43 What:           /sys/bus/event_source/devices/hv_24x7/interface/catalog_version
44 Date:           February 2014
45 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
46 Description:
47                 Exposes the "version" field of the 24x7 catalog. This is also
48                 extractable from the provided binary "catalog" sysfs entry.
50 What:           /sys/devices/hv_24x7/interface/sockets
51 Date:           May 2020
52 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
53 Description:    read only
54                 This sysfs interface exposes the number of sockets present in the
55                 system.
57 What:           /sys/devices/hv_24x7/interface/chipspersocket
58 Date:           May 2020
59 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
60 Description:    read only
61                 This sysfs interface exposes the number of chips per socket
62                 present in the system.
64 What:           /sys/devices/hv_24x7/interface/coresperchip
65 Date:           May 2020
66 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
67 Description:    read only
68                 This sysfs interface exposes the number of cores per chip
69                 present in the system.
71 What:           /sys/devices/hv_24x7/cpumask
72 Date:           July 2020
73 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
74 Description:    read only
75                 This sysfs file exposes the cpumask which is designated to make
76                 HCALLs to retrieve hv-24x7 pmu event counter data.
78 What:           /sys/bus/event_source/devices/hv_24x7/event_descs/<event-name>
79 Date:           February 2014
80 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
81 Description:
82                 Provides the description of a particular event as provided by
83                 the firmware. If firmware does not provide a description, no
84                 file will be created.
86                 Note that the event-name lacks the domain suffix appended for
87                 events in the events/ dir.
89 What:           /sys/bus/event_source/devices/hv_24x7/event_long_descs/<event-name>
90 Date:           February 2014
91 Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
92 Description:
93                 Provides the "long" description of a particular event as
94                 provided by the firmware. If firmware does not provide a
95                 description, no file will be created.
97                 Note that the event-name lacks the domain suffix appended for
98                 events in the events/ dir.