summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_sanitize_log_page.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
commit2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_sanitize_log_page.2
parentInitial commit. (diff)
downloadlibnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.tar.xz
libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.zip
Adding upstream version 1.3.upstream/1.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_sanitize_log_page.2')
-rw-r--r--doc/man/nvme_sanitize_log_page.2106
1 files changed, 106 insertions, 0 deletions
diff --git a/doc/man/nvme_sanitize_log_page.2 b/doc/man/nvme_sanitize_log_page.2
new file mode 100644
index 0000000..2c14b07
--- /dev/null
+++ b/doc/man/nvme_sanitize_log_page.2
@@ -0,0 +1,106 @@
+.TH "libnvme" 9 "struct nvme_sanitize_log_page" "January 2023" "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