summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_sanitize_nvm.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_sanitize_nvm.2')
-rw-r--r--doc/man/nvme_sanitize_nvm.222
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/man/nvme_sanitize_nvm.2 b/doc/man/nvme_sanitize_nvm.2
new file mode 100644
index 0000000..05f59a1
--- /dev/null
+++ b/doc/man/nvme_sanitize_nvm.2
@@ -0,0 +1,22 @@
+.TH "nvme_sanitize_nvm" 9 "nvme_sanitize_nvm" "February 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_sanitize_nvm \- Start a sanitize operation
+.SH SYNOPSIS
+.B "int" nvme_sanitize_nvm
+.BI "(struct nvme_sanitize_nvm_args *args " ");"
+.SH ARGUMENTS
+.IP "args" 12
+\fIstruct nvme_sanitize_nvm_args\fP argument structure
+.SH "DESCRIPTION"
+A sanitize operation alters all user data in the NVM subsystem such that
+recovery of any previous user data from any cache, the non-volatile media,
+or any Controller Memory Buffer is not possible.
+
+The Sanitize command starts a sanitize operation or to recover from a
+previously failed sanitize operation. The sanitize operation types that may
+be supported are Block Erase, Crypto Erase, and Overwrite. All sanitize
+operations are processed in the background, i.e., completion of the sanitize
+command does not indicate completion of the sanitize operation.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.