Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / sysfs-bus-papr-pmem
1 What:           /sys/bus/nd/devices/nmemX/papr/flags
2 Date:           Apr, 2020
3 KernelVersion:  v5.8
4 Contact:        linuxppc-dev <linuxppc-dev@lists.ozlabs.org>, nvdimm@lists.linux.dev,
5 Description:
6                 (RO) Report flags indicating various states of a
7                 papr-pmem NVDIMM device. Each flag maps to a one or
8                 more bits set in the dimm-health-bitmap retrieved in
9                 response to H_SCM_HEALTH hcall. The details of the bit
10                 flags returned in response to this hcall is available
11                 at 'Documentation/arch/powerpc/papr_hcalls.rst' . Below are
12                 the flags reported in this sysfs file:
13
14                 * "not_armed"
15                                   Indicates that NVDIMM contents will not
16                                   survive a power cycle.
17                 * "flush_fail"
18                                   Indicates that NVDIMM contents
19                                   couldn't be flushed during last
20                                   shut-down event.
21                 * "restore_fail"
22                                   Indicates that NVDIMM contents
23                                   couldn't be restored during NVDIMM
24                                   initialization.
25                 * "encrypted"
26                                   NVDIMM contents are encrypted.
27                 * "smart_notify"
28                                   There is health event for the NVDIMM.
29                 * "scrubbed"
30                                   Indicating that contents of the
31                                   NVDIMM have been scrubbed.
32                 * "locked"
33                                   Indicating that NVDIMM contents can't
34                                   be modified until next power cycle.
35
36 What:           /sys/bus/nd/devices/nmemX/papr/perf_stats
37 Date:           May, 2020
38 KernelVersion:  v5.9
39 Contact:        linuxppc-dev <linuxppc-dev@lists.ozlabs.org>, nvdimm@lists.linux.dev,
40 Description:
41                 (RO) Report various performance stats related to papr-scm NVDIMM
42                 device. This attribute is only available for NVDIMM devices
43                 that support reporting NVDIMM performance stats. Each stat is
44                 reported on a new line with each line composed of a
45                 stat-identifier followed by it value. Below are currently known
46                 dimm performance stats which are reported:
47
48                 * "CtlResCt" : Controller Reset Count
49                 * "CtlResTm" : Controller Reset Elapsed Time
50                 * "PonSecs " : Power-on Seconds
51                 * "MemLife " : Life Remaining
52                 * "CritRscU" : Critical Resource Utilization
53                 * "HostLCnt" : Host Load Count
54                 * "HostSCnt" : Host Store Count
55                 * "HostSDur" : Host Store Duration
56                 * "HostLDur" : Host Load Duration
57                 * "MedRCnt " : Media Read Count
58                 * "MedWCnt " : Media Write Count
59                 * "MedRDur " : Media Read Duration
60                 * "MedWDur " : Media Write Duration
61                 * "CchRHCnt" : Cache Read Hit Count
62                 * "CchWHCnt" : Cache Write Hit Count
63                 * "FastWCnt" : Fast Write Count
64
65 What:           /sys/bus/nd/devices/nmemX/papr/health_bitmap_inject
66 Date:           Jan, 2022
67 KernelVersion:  v5.17
68 Contact:        linuxppc-dev <linuxppc-dev@lists.ozlabs.org>, nvdimm@lists.linux.dev,
69 Description:
70                 (RO) Reports the health bitmap inject bitmap that is applied to
71                 bitmap received from PowerVM via the H_SCM_HEALTH. This is used
72                 to forcibly set specific bits returned from Hcall. These is then
73                 used to simulate various health or shutdown states for an nvdimm
74                 and are set by user-space tools like ndctl by issuing a PAPR DSM.
75