WIP FPC-III support
[linux/fpc-iii.git] / Documentation / ABI / testing / sysfs-bus-papr-pmem
blob8316c33862a047b86fb508a75122bcae16ca9768
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>, linux-nvdimm@lists.01.org,
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/powerpc/papr_hcalls.rst' . Below are
12                 the flags reported in this sysfs file:
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 cant
34                                   be modified until next power cycle.
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>, linux-nvdimm@lists.01.org,
40 Description:
41                 (RO) Report various performance stats related to papr-scm NVDIMM
42                 device.  Each stat is reported on a new line with each line
43                 composed of a stat-identifier followed by it value. Below are
44                 currently known dimm performance stats which are reported:
46                 * "CtlResCt" : Controller Reset Count
47                 * "CtlResTm" : Controller Reset Elapsed Time
48                 * "PonSecs " : Power-on Seconds
49                 * "MemLife " : Life Remaining
50                 * "CritRscU" : Critical Resource Utilization
51                 * "HostLCnt" : Host Load Count
52                 * "HostSCnt" : Host Store Count
53                 * "HostSDur" : Host Store Duration
54                 * "HostLDur" : Host Load Duration
55                 * "MedRCnt " : Media Read Count
56                 * "MedWCnt " : Media Write Count
57                 * "MedRDur " : Media Read Duration
58                 * "MedWDur " : Media Write Duration
59                 * "CchRHCnt" : Cache Read Hit Count
60                 * "CchWHCnt" : Cache Write Hit Count
61                 * "FastWCnt" : Fast Write Count