summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_sanitize_log_page.2
blob: ee300b21c2c4cf366e36cb165e0c4325628f2c3e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
.TH "libnvme" 9 "struct nvme_sanitize_log_page" "February 2024" "API Manual" LINUX
.SH NAME
struct nvme_sanitize_log_page \- Sanitize Status (Log Identifier 81h)
.SH SYNOPSIS
struct nvme_sanitize_log_page {
.br
.BI "    __le16 sprog;"
.br
.BI "    __le16 sstat;"
.br
.BI "    __le32 scdw10;"
.br
.BI "    __le32 eto;"
.br
.BI "    __le32 etbe;"
.br
.BI "    __le32 etce;"
.br
.BI "    __le32 etond;"
.br
.BI "    __le32 etbend;"
.br
.BI "    __le32 etcend;"
.br
.BI "    __u8 rsvd32[480];"
.br
.BI "
};
.br

.SH Members
.IP "sprog" 12
Sanitize Progress (SPROG): indicates the fraction complete of the
sanitize operation. The value is a numerator of the fraction
complete that has 65,536 (10000h) as its denominator. This value
shall be set to FFFFh if the \fIsstat\fP field is not set to
NVME_SANITIZE_SSTAT_STATUS_IN_PROGESS.
.IP "sstat" 12
Sanitize Status (SSTAT): indicates the status associated with
the most recent sanitize operation. See \fIenum nvme_sanitize_sstat\fP.
.IP "scdw10" 12
Sanitize Command Dword 10 Information (SCDW10): contains the value
of the Command Dword 10 field of the Sanitize command that started
the sanitize operation.
.IP "eto" 12
Estimated Time For Overwrite: indicates the number of seconds required
to complete an Overwrite sanitize operation with 16 passes in
the background when the No-Deallocate Modifies Media After Sanitize
field is not set to 10b. A value of 0h indicates that the sanitize
operation is expected to be completed in the background when the
Sanitize command that started that operation is completed. A value
of FFFFFFFFh indicates that no time period is reported.
.IP "etbe" 12
Estimated Time For Block Erase: indicates the number of seconds
required to complete a Block Erase sanitize operation in the
background when the No-Deallocate Modifies Media After Sanitize
field is not set to 10b. A value of 0h indicates that the sanitize
operation is expected to be completed in the background when the
Sanitize command that started that operation is completed.
A value of FFFFFFFFh indicates that no time period is reported.
.IP "etce" 12
Estimated Time For Crypto Erase: indicates the number of seconds
required to complete a Crypto Erase sanitize operation in the
background when the No-Deallocate Modifies Media After Sanitize
field is not set to 10b. A value of 0h indicates that the sanitize
operation is expected to be completed in the background when the
Sanitize command that started that operation is completed.
A value of FFFFFFFFh indicates that no time period is reported.
.IP "etond" 12
Estimated Time For Overwrite With No-Deallocate Media Modification:
indicates the number of seconds required to complete an Overwrite
sanitize operation and the associated additional media modification
after the Overwrite sanitize operation in the background when
the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
command that requested the Overwrite sanitize operation; and
the No-Deallocate Modifies Media After Sanitize field is set to 10b.
A value of 0h indicates that the sanitize operation is expected
to be completed in the background when the Sanitize command that
started that operation is completed. A value of FFFFFFFFh indicates
that no time period is reported.
.IP "etbend" 12
Estimated Time For Block Erase With No-Deallocate Media Modification:
indicates the number of seconds required to complete a Block Erase
sanitize operation and the associated additional media modification
after the Block Erase sanitize operation in the background when
the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
command that requested the Overwrite sanitize operation; and
the No-Deallocate Modifies Media After Sanitize field is set to 10b.
A value of 0h indicates that the sanitize operation is expected
to be completed in the background when the Sanitize command that
started that operation is completed. A value of FFFFFFFFh indicates
that no time period is reported.
.IP "etcend" 12
Estimated Time For Crypto Erase With No-Deallocate Media Modification:
indicates the number of seconds required to complete a Crypto Erase
sanitize operation and the associated additional media modification
after the Crypto Erase sanitize operation in the background when
the No-Deallocate After Sanitize bit was set to 1 in the Sanitize
command that requested the Overwrite sanitize operation; and
the No-Deallocate Modifies Media After Sanitize field is set to 10b.
A value of 0h indicates that the sanitize operation is expected
to be completed in the background when the Sanitize command that
started that operation is completed. A value of FFFFFFFFh indicates
that no time period is reported.
.IP "rsvd32" 12
Reserved