Documentation/ABI: Add ABI documentation for hv-24x7 format
authorKajol Jain <kjain@linux.ibm.com>
Sat, 3 Oct 2020 07:49:40 +0000 (13:19 +0530)
committerMichael Ellerman <mpe@ellerman.id.au>
Wed, 7 Oct 2020 11:34:48 +0000 (22:34 +1100)
This patch adds ABI documentation for hv-24x7 format.

Signed-off-by: Kajol Jain <kjain@linux.ibm.com>
Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20201003074943.338618-2-kjain@linux.ibm.com
Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_24x7

index e82fc37..2273627 100644 (file)
@@ -1,3 +1,28 @@
+What:           /sys/bus/event_source/devices/hv_24x7/format
+Date:           September 2020
+Contact:        Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>
+Description:    Read-only. Attribute group to describe the magic bits
+                that go into perf_event_attr.config for a particular pmu.
+                (See ABI/testing/sysfs-bus-event_source-devices-format).
+
+                Each attribute under this group defines a bit range of the
+                perf_event_attr.config. All supported attributes are listed
+                below.
+
+                               chip = "config:16-31"
+                               core  = "config:16-31"
+                               domain = "config:0-3"
+                               lpar = "config:0-15"
+                               offset = "config:32-63"
+                               vcpu = "config:16-31"
+
+               For example,
+
+               PM_PB_CYC =  "domain=1,offset=0x80,chip=?,lpar=0x0"
+
+               In this event, '?' after chip specifies that
+               this value will be provided by user while running this event.
+
 What:          /sys/bus/event_source/devices/hv_24x7/interface/catalog
 Date:          February 2014
 Contact:       Linux on PowerPC Developer List <linuxppc-dev@lists.ozlabs.org>