[RFC 3/4] powerpc/papr_scm: Document papr_scm sysfs event format entries

From: Kajol Jain
Date: Wed May 12 2021 - 14:45:51 EST


This patch add event format and events details in ABI
documentation

Signed-off-by: Kajol Jain <kjain@xxxxxxxxxxxxx>
---
Documentation/ABI/testing/sysfs-bus-papr-pmem | 25 +++++++++++++++++++
1 file changed, 25 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-papr-pmem b/Documentation/ABI/testing/sysfs-bus-papr-pmem
index 8316c33862a0..216f70deca7e 100644
--- a/Documentation/ABI/testing/sysfs-bus-papr-pmem
+++ b/Documentation/ABI/testing/sysfs-bus-papr-pmem
@@ -59,3 +59,28 @@ Description:
* "CchRHCnt" : Cache Read Hit Count
* "CchWHCnt" : Cache Write Hit Count
* "FastWCnt" : Fast Write Count
+
+What: /sys/devices/nmemX/format
+Date: May 2021
+Contact: linuxppc-dev <linuxppc-dev@xxxxxxxxxxxxxxxx>, linux-nvdimm@xxxxxxxxxxxx,
+Description: (RO) 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. Supported attributes is listed
+ below::
+
+ event = "config:0-37" - event ID
+
+ For example::
+ noopstat = "event=0x1"
+
+What: /sys/devices/nmemX/events
+Date: May 2021
+Contact: linuxppc-dev <linuxppc-dev@xxxxxxxxxxxxxxxx>, linux-nvdimm@xxxxxxxxxxxx,
+Description: (RO) Attribute group to describe performance monitoring
+ events specific to papr_pmem. Each attribute in this group describes
+ a single performance monitoring event supported by this nvdimm pmu.
+ The name of the file is the name of the event.
+ (See ABI/testing/sysfs-bus-event_source-devices-events).
--
2.27.0