Debian Codegraph @

doc/man/nvme_sanitize_log_page.2

raw
1 .TH "libnvme" 9 "struct nvme_sanitize_log_page" "November 2025" "API Manual" LINUX
2 .SH NAME
3 struct nvme_sanitize_log_page \- Sanitize Status (Log Identifier 81h)
4 .SH SYNOPSIS
5 struct nvme_sanitize_log_page {
6 .br
7 .BI " __le16 sprog;"
8 .br
9 .BI " __le16 sstat;"
10 .br
11 .BI " __le32 scdw10;"
12 .br
13 .BI " __le32 eto;"
14 .br
15 .BI " __le32 etbe;"
16 .br
17 .BI " __le32 etce;"
18 .br
19 .BI " __le32 etond;"
20 .br
21 .BI " __le32 etbend;"
22 .br
23 .BI " __le32 etcend;"
24 .br
25 .BI " __le32 etpvds;"
26 .br
27 .BI " __u8 ssi;"
28 .br
29 .BI " __u8 rsvd37[475];"
30 .br
31 .BI "
32 };
33 .br
34
35 .SH Members
36 .IP "sprog" 12
37 Sanitize Progress (SPROG): indicates the fraction complete of the
38 sanitize operation. The value is a numerator of the fraction
39 complete that has 65,536 (10000h) as its denominator. This value
40 shall be set to FFFFh if the \fIsstat\fP field is not set to
41 NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS.
42 .IP "sstat" 12
43 Sanitize Status (SSTAT): indicates the status associated with
44 the most recent sanitize operation. See \fIenum nvme_sanitize_sstat\fP.
45 .IP "scdw10" 12
46 Sanitize Command Dword 10 Information (SCDW10): contains the value
47 of the Command Dword 10 field of the Sanitize command that started
48 the sanitize operation.
49 .IP "eto" 12
50 Estimated Time For Overwrite: indicates the number of seconds required
51 to complete an Overwrite sanitize operation with 16 passes in
52 the background when the No-Deallocate Modifies Media After Sanitize
53 field is not set to 10b. A value of 0h indicates that the sanitize
54 operation is expected to be completed in the background when the
55 Sanitize command that started that operation is completed. A value
56 of FFFFFFFFh indicates that no time period is reported.
57 .IP "etbe" 12
58 Estimated Time For Block Erase: indicates the number of seconds
59 required to complete a Block Erase sanitize operation in the
60 background when the No-Deallocate Modifies Media After Sanitize
61 field is not set to 10b. A value of 0h indicates that the sanitize
62 operation is expected to be completed in the background when the
63 Sanitize command that started that operation is completed.
64 A value of FFFFFFFFh indicates that no time period is reported.
65 .IP "etce" 12
66 Estimated Time For Crypto Erase: indicates the number of seconds
67 required to complete a Crypto Erase sanitize operation in the
68 background when the No-Deallocate Modifies Media After Sanitize
69 field is not set to 10b. A value of 0h indicates that the sanitize
70 operation is expected to be completed in the background when the
71 Sanitize command that started that operation is completed.
72 A value of FFFFFFFFh indicates that no time period is reported.
73 .IP "etond" 12
74 Estimated Time For Overwrite With No-Deallocate Media Modification:
75 indicates the number of seconds required to complete an Overwrite
76 sanitize operation and the associated additional media modification
77 after the Overwrite sanitize operation in the background when
78 the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
79 command that requested the Overwrite sanitize operation; and
80 the No-Deallocate Modifies Media After Sanitize field is set to 10b.
81 A value of 0h indicates that the sanitize operation is expected
82 to be completed in the background when the Sanitize command that
83 started that operation is completed. A value of FFFFFFFFh indicates
84 that no time period is reported.
85 .IP "etbend" 12
86 Estimated Time For Block Erase With No-Deallocate Media Modification:
87 indicates the number of seconds required to complete a Block Erase
88 sanitize operation and the associated additional media modification
89 after the Block Erase sanitize operation in the background when
90 the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
91 command that requested the Overwrite sanitize operation; and
92 the No-Deallocate Modifies Media After Sanitize field is set to 10b.
93 A value of 0h indicates that the sanitize operation is expected
94 to be completed in the background when the Sanitize command that
95 started that operation is completed. A value of FFFFFFFFh indicates
96 that no time period is reported.
97 .IP "etcend" 12
98 Estimated Time For Crypto Erase With No-Deallocate Media Modification:
99 indicates the number of seconds required to complete a Crypto Erase
100 sanitize operation and the associated additional media modification
101 after the Crypto Erase sanitize operation in the background when
102 the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
103 command that requested the Overwrite sanitize operation; and
104 the No-Deallocate Modifies Media After Sanitize field is set to 10b.
105 A value of 0h indicates that the sanitize operation is expected
106 to be completed in the background when the Sanitize command that
107 started that operation is completed. A value of FFFFFFFFh indicates
108 that no time period is reported.
109 .IP "etpvds" 12
110 Estimated Time For Post-Verification Deallocation State: indicates the
111 number of seconds required to deallocate all media allocated for user data
112 after exiting the Media Verification state (i.e., the time difference between
113 entering and exiting the Post-Verification Deallocation state), if that state
114 is entered as part of the sanitize operation. A value of FFFFFFFFh indicates
115 that no time period is reported.
116 .IP "ssi" 12
117 Sanitize State Information: indicate the state of the Sanitize Operation
118 State Machine.
119 .IP "rsvd37" 12
120 Reserved