xref: /linux/Documentation/ABI/testing/sysfs-bus-nvdimm (revision c532de5a67a70f8533d495f8f2aaa9a0491c3ad0)
1What:          nvdimm
2Date:          July 2020
3KernelVersion: 5.8
4Contact:       Dan Williams <dan.j.williams@intel.com>
5Description:
6
7The libnvdimm sub-system implements a common sysfs interface for
8platform nvdimm resources. See Documentation/driver-api/nvdimm/.
9
10What:           /sys/bus/event_source/devices/nmemX/format
11Date:           February 2022
12KernelVersion:  5.18
13Contact:        Kajol Jain <kjain@linux.ibm.com>
14Description:	(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
22		  event  = "config:0-4"  - event ID
23
24		For example::
25
26		  ctl_res_cnt = "event=0x1"
27
28What:           /sys/bus/event_source/devices/nmemX/events
29Date:           February 2022
30KernelVersion:  5.18
31Contact:        Kajol Jain <kjain@linux.ibm.com>
32Description:	(RO) Attribute group to describe performance monitoring events
33                for the nvdimm memory device. Each attribute in this group
34                describes a single performance monitoring event supported by
35                this nvdimm pmu.  The name of the file is the name of the event.
36                (See ABI/testing/sysfs-bus-event_source-devices-events). A
37                listing of the events supported by a given nvdimm provider type
38                can be found in Documentation/driver-api/nvdimm/$provider.
39
40What:          /sys/bus/event_source/devices/nmemX/cpumask
41Date:          February 2022
42KernelVersion:  5.18
43Contact:        Kajol Jain <kjain@linux.ibm.com>
44Description:	(RO) This sysfs file exposes the cpumask which is designated to
45		to retrieve nvdimm pmu event counter data.
46
47What:		/sys/bus/nd/devices/nmemX/cxl/id
48Date:		November 2022
49KernelVersion:	6.2
50Contact:	Dave Jiang <dave.jiang@intel.com>
51Description:	(RO) Show the id (serial) of the device. This is CXL specific.
52
53What:		/sys/bus/nd/devices/nmemX/cxl/provider
54Date:		November 2022
55KernelVersion:	6.2
56Contact:	Dave Jiang <dave.jiang@intel.com>
57Description:	(RO) Shows the CXL bridge device that ties to a CXL memory device
58		to this NVDIMM device. I.e. the parent of the device returned is
59		a /sys/bus/cxl/devices/memX instance.
60