diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:40:20 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:40:20 +0000 |
| commit | 2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch) | |
| tree | ac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_cmd_format_ses.2 | |
| parent | Initial commit. (diff) | |
| download | libnvme-upstream/1.3.tar.xz libnvme-upstream/1.3.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_cmd_format_ses.2')
| -rw-r--r-- | doc/man/nvme_cmd_format_ses.2 | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/man/nvme_cmd_format_ses.2 b/doc/man/nvme_cmd_format_ses.2 new file mode 100644 index 0000000..6374138 --- /dev/null +++ b/doc/man/nvme_cmd_format_ses.2 @@ -0,0 +1,33 @@ +.TH "libnvme" 9 "enum nvme_cmd_format_ses" "January 2023" "API Manual" LINUX +.SH NAME +enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings +.SH SYNOPSIS +enum nvme_cmd_format_ses { +.br +.BI " NVME_FORMAT_SES_NONE" +, +.br +.br +.BI " NVME_FORMAT_SES_USER_DATA_ERASE" +, +.br +.br +.BI " NVME_FORMAT_SES_CRYPTO_ERASE" + +}; +.SH Constants +.IP "NVME_FORMAT_SES_NONE" 12 +No secure erase operation requested. +.IP "NVME_FORMAT_SES_USER_DATA_ERASE" 12 +User Data Erase: All user data shall be erased, +contents of the user data after the erase is +indeterminate (e.g. the user data may be zero +filled, one filled, etc.). If a User Data Erase +is requested and all affected user data is +encrypted, then the controller is allowed +to use a cryptographic erase to perform +the requested User Data Erase. +.IP "NVME_FORMAT_SES_CRYPTO_ERASE" 12 +Cryptographic Erase: All user data shall +be erased cryptographically. This is +accomplished by deleting the encryption key. |