Skip to content

Commit 2bec6d9

Browse files
kjain101djbw
authored andcommitted
docs: ABI: sysfs-bus-nvdimm: Document sysfs event format entries for nvdimm pmu
Details are added for the event, cpumask and format attributes in the ABI documentation. Acked-by: Peter Zijlstra (Intel) <peterz@infradead.org> Tested-by: Nageswara R Sastry <rnsastry@linux.ibm.com> Signed-off-by: Kajol Jain <kjain@linux.ibm.com> Reviewed-by: Madhavan Srinivasan <maddy@in.ibm.com> Link: https://lore.kernel.org/r/20220225143024.47947-5-kjain@linux.ibm.com Signed-off-by: Dan Williams <dan.j.williams@intel.com>
1 parent 4c08d4b commit 2bec6d9

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

Documentation/ABI/testing/sysfs-bus-nvdimm

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,38 @@ Description:
66

77
The libnvdimm sub-system implements a common sysfs interface for
88
platform nvdimm resources. See Documentation/driver-api/nvdimm/.
9+
10+
What: /sys/bus/event_source/devices/nmemX/format
11+
Date: February 2022
12+
KernelVersion: 5.18
13+
Contact: Kajol Jain <kjain@linux.ibm.com>
14+
Description: (RO) Attribute group to describe the magic bits
15+
that go into perf_event_attr.config for a particular pmu.
16+
(See ABI/testing/sysfs-bus-event_source-devices-format).
17+
18+
Each attribute under this group defines a bit range of the
19+
perf_event_attr.config. Supported attribute is listed
20+
below::
21+
event = "config:0-4" - event ID
22+
23+
For example::
24+
ctl_res_cnt = "event=0x1"
25+
26+
What: /sys/bus/event_source/devices/nmemX/events
27+
Date: February 2022
28+
KernelVersion: 5.18
29+
Contact: Kajol Jain <kjain@linux.ibm.com>
30+
Description: (RO) Attribute group to describe performance monitoring events
31+
for the nvdimm memory device. Each attribute in this group
32+
describes a single performance monitoring event supported by
33+
this nvdimm pmu. The name of the file is the name of the event.
34+
(See ABI/testing/sysfs-bus-event_source-devices-events). A
35+
listing of the events supported by a given nvdimm provider type
36+
can be found in Documentation/driver-api/nvdimm/$provider.
37+
38+
What: /sys/bus/event_source/devices/nmemX/cpumask
39+
Date: February 2022
40+
KernelVersion: 5.18
41+
Contact: Kajol Jain <kjain@linux.ibm.com>
42+
Description: (RO) This sysfs file exposes the cpumask which is designated to
43+
to retrieve nvdimm pmu event counter data.

0 commit comments

Comments
 (0)