Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / sysfs-bus-nvdimm
1 What:          nvdimm
2 Date:          July 2020
3 KernelVersion: 5.8
4 Contact:       Dan Williams <dan.j.williams@intel.com>
5 Description:
6
7 The libnvdimm sub-system implements a common sysfs interface for
8 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
22                   event  = "config:0-4"  - event ID
23
24                 For example::
25
26                   ctl_res_cnt = "event=0x1"
27
28 What:           /sys/bus/event_source/devices/nmemX/events
29 Date:           February 2022
30 KernelVersion:  5.18
31 Contact:        Kajol Jain <kjain@linux.ibm.com>
32 Description:    (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
40 What:          /sys/bus/event_source/devices/nmemX/cpumask
41 Date:          February 2022
42 KernelVersion:  5.18
43 Contact:        Kajol Jain <kjain@linux.ibm.com>
44 Description:    (RO) This sysfs file exposes the cpumask which is designated to
45                 to retrieve nvdimm pmu event counter data.
46
47 What:           /sys/bus/nd/devices/nmemX/cxl/id
48 Date:           November 2022
49 KernelVersion:  6.2
50 Contact:        Dave Jiang <dave.jiang@intel.com>
51 Description:    (RO) Show the id (serial) of the device. This is CXL specific.
52
53 What:           /sys/bus/nd/devices/nmemX/cxl/provider
54 Date:           November 2022
55 KernelVersion:  6.2
56 Contact:        Dave Jiang <dave.jiang@intel.com>
57 Description:    (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.