xref: /linux/Documentation/ABI/testing/sysfs-bus-nvdimm (revision a1c613ae4c322ddd58d5a8539dbfba2a0380a8c0)
1ed8c39d4SMauro Carvalho ChehabWhat:          nvdimm
2ed8c39d4SMauro Carvalho ChehabDate:          July 2020
3ed8c39d4SMauro Carvalho ChehabKernelVersion: 5.8
4ed8c39d4SMauro Carvalho ChehabContact:       Dan Williams <dan.j.williams@intel.com>
5ed8c39d4SMauro Carvalho ChehabDescription:
6ed8c39d4SMauro Carvalho Chehab
748001ea5SDan WilliamsThe libnvdimm sub-system implements a common sysfs interface for
848001ea5SDan Williamsplatform nvdimm resources. See Documentation/driver-api/nvdimm/.
92bec6d9aSKajol Jain
102bec6d9aSKajol JainWhat:           /sys/bus/event_source/devices/nmemX/format
112bec6d9aSKajol JainDate:           February 2022
122bec6d9aSKajol JainKernelVersion:  5.18
132bec6d9aSKajol JainContact:        Kajol Jain <kjain@linux.ibm.com>
142bec6d9aSKajol JainDescription:	(RO) Attribute group to describe the magic bits
152bec6d9aSKajol Jain		that go into perf_event_attr.config for a particular pmu.
162bec6d9aSKajol Jain		(See ABI/testing/sysfs-bus-event_source-devices-format).
172bec6d9aSKajol Jain
182bec6d9aSKajol Jain		Each attribute under this group defines a bit range of the
192bec6d9aSKajol Jain		perf_event_attr.config. Supported attribute is listed
202bec6d9aSKajol Jain		below::
21*16182e4aSJonathan Corbet
222bec6d9aSKajol Jain		  event  = "config:0-4"  - event ID
232bec6d9aSKajol Jain
242bec6d9aSKajol Jain		For example::
25*16182e4aSJonathan Corbet
262bec6d9aSKajol Jain		  ctl_res_cnt = "event=0x1"
272bec6d9aSKajol Jain
282bec6d9aSKajol JainWhat:           /sys/bus/event_source/devices/nmemX/events
292bec6d9aSKajol JainDate:           February 2022
302bec6d9aSKajol JainKernelVersion:  5.18
312bec6d9aSKajol JainContact:        Kajol Jain <kjain@linux.ibm.com>
322bec6d9aSKajol JainDescription:	(RO) Attribute group to describe performance monitoring events
332bec6d9aSKajol Jain                for the nvdimm memory device. Each attribute in this group
342bec6d9aSKajol Jain                describes a single performance monitoring event supported by
352bec6d9aSKajol Jain                this nvdimm pmu.  The name of the file is the name of the event.
362bec6d9aSKajol Jain                (See ABI/testing/sysfs-bus-event_source-devices-events). A
372bec6d9aSKajol Jain                listing of the events supported by a given nvdimm provider type
382bec6d9aSKajol Jain                can be found in Documentation/driver-api/nvdimm/$provider.
392bec6d9aSKajol Jain
402bec6d9aSKajol JainWhat:          /sys/bus/event_source/devices/nmemX/cpumask
412bec6d9aSKajol JainDate:          February 2022
422bec6d9aSKajol JainKernelVersion:  5.18
432bec6d9aSKajol JainContact:        Kajol Jain <kjain@linux.ibm.com>
442bec6d9aSKajol JainDescription:	(RO) This sysfs file exposes the cpumask which is designated to
452bec6d9aSKajol Jain		to retrieve nvdimm pmu event counter data.
46bd429e53SDave Jiang
47bd429e53SDave JiangWhat:		/sys/bus/nd/devices/nmemX/cxl/id
48bd429e53SDave JiangDate:		November 2022
49bd429e53SDave JiangKernelVersion:	6.2
50bd429e53SDave JiangContact:	Dave Jiang <dave.jiang@intel.com>
51bd429e53SDave JiangDescription:	(RO) Show the id (serial) of the device. This is CXL specific.
52452996faSDave Jiang
53452996faSDave JiangWhat:		/sys/bus/nd/devices/nmemX/cxl/provider
54452996faSDave JiangDate:		November 2022
55452996faSDave JiangKernelVersion:	6.2
56452996faSDave JiangContact:	Dave Jiang <dave.jiang@intel.com>
57452996faSDave JiangDescription:	(RO) Shows the CXL bridge device that ties to a CXL memory device
58452996faSDave Jiang		to this NVDIMM device. I.e. the parent of the device returned is
59452996faSDave Jiang		a /sys/bus/cxl/devices/memX instance.
60