Debian Codegraph @

doc/man/nvme_sanitize_sstat.2

raw
1 .TH "libnvme" 9 "enum nvme_sanitize_sstat" "November 2025" "API Manual" LINUX
2 .SH NAME
3 enum nvme_sanitize_sstat \- Sanitize Status (SSTAT)
4 .SH SYNOPSIS
5 enum nvme_sanitize_sstat {
6 .br
7 .BI " NVME_SANITIZE_SSTAT_STATUS_SHIFT"
8 ,
9 .br
10 .br
11 .BI " NVME_SANITIZE_SSTAT_STATUS_MASK"
12 ,
13 .br
14 .br
15 .BI " NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED"
16 ,
17 .br
18 .br
19 .BI " NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS"
20 ,
21 .br
22 .br
23 .BI " NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS"
24 ,
25 .br
26 .br
27 .BI " NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED"
28 ,
29 .br
30 .br
31 .BI " NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESS"
32 ,
33 .br
34 .br
35 .BI " NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT"
36 ,
37 .br
38 .br
39 .BI " NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK"
40 ,
41 .br
42 .br
43 .BI " NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFT"
44 ,
45 .br
46 .br
47 .BI " NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASK"
48 ,
49 .br
50 .br
51 .BI " NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED"
52 ,
53 .br
54 .br
55 .BI " NVME_SANITIZE_SSTAT_MVCNCLD_SHIFT"
56 ,
57 .br
58 .br
59 .BI " NVME_SANITIZE_SSTAT_MVCNCLD_MASK"
60
61 };
62 .SH Constants
63 .IP "NVME_SANITIZE_SSTAT_STATUS_SHIFT" 12
64 Shift amount to get the status value of
65 the most recent sanitize operation from
66 the \fIstruct nvme_sanitize_log_page\fP.sstat
67 field.
68 .IP "NVME_SANITIZE_SSTAT_STATUS_MASK" 12
69 Mask to get the status value of the most
70 recent sanitize operation.
71 .IP "NVME_SANITIZE_SSTAT_STATUS_NEVER_SANITIZED" 12
72 The NVM subsystem has never been
73 sanitized.
74 .IP "NVME_SANITIZE_SSTAT_STATUS_COMPLETE_SUCCESS" 12
75 The most recent sanitize operation
76 completed successfully including any
77 additional media modification.
78 .IP "NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS" 12
79 A sanitize operation is currently in progress.
80 .IP "NVME_SANITIZE_SSTAT_STATUS_COMPLETED_FAILED" 12
81 The most recent sanitize operation
82 failed.
83 .IP "NVME_SANITIZE_SSTAT_STATUS_ND_COMPLETE_SUCCESS" 12
84 The most recent sanitize operation
85 for which No-Deallocate After Sanitize was
86 requested has completed successfully with
87 deallocation of all user data.
88 .IP "NVME_SANITIZE_SSTAT_COMPLETED_PASSES_SHIFT" 12
89 Shift amount to get the number
90 of completed passes if the most recent
91 sanitize operation was an Overwrite. This
92 value shall be cleared to 0h if the most
93 recent sanitize operation was not
94 an Overwrite.
95 .IP "NVME_SANITIZE_SSTAT_COMPLETED_PASSES_MASK" 12
96 Mask to get the number of completed
97 passes.
98 .IP "NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_SHIFT" 12
99 Shift amount to get the Global
100 Data Erased value from the
101 \fIstruct nvme_sanitize_log_page\fP.sstat field.
102 .IP "NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED_MASK" 12
103 Mask to get the Global Data Erased
104 value.
105 .IP "NVME_SANITIZE_SSTAT_GLOBAL_DATA_ERASED" 12
106 Global Data Erased: if set, then no
107 namespace user data in the NVM subsystem
108 has been written to and no Persistent
109 Memory Region in the NVM subsystem has
110 been enabled since being manufactured and
111 the NVM subsystem has never been sanitized;
112 or since the most recent successful sanitize
113 operation.
114 .IP "NVME_SANITIZE_SSTAT_MVCNCLD_SHIFT" 12
115 Shift amount to get the value of Media Verification
116 Canceled bit of Sanitize status field.
117 .IP "NVME_SANITIZE_SSTAT_MVCNCLD_MASK" 12
118 Mask to get the value of Media Verification Canceled
119 bit of Sanitize status field.