summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_id_ctrl_fna.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
commit3945f3269b3e2763faa1ab22d225ca4dd1856b82 (patch)
tree7e96ec768baa3807ce3a1076a74037a287f4caa8 /doc/man/nvme_id_ctrl_fna.2
parentInitial commit. (diff)
downloadlibnvme-c5db69fa99ba733bb136fc2b6fbb4961839f27ea.tar.xz
libnvme-c5db69fa99ba733bb136fc2b6fbb4961839f27ea.zip
Adding upstream version 1.0.upstream/1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_id_ctrl_fna.2')
-rw-r--r--doc/man/nvme_id_ctrl_fna.239
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/man/nvme_id_ctrl_fna.2 b/doc/man/nvme_id_ctrl_fna.2
new file mode 100644
index 0000000..7b68f26
--- /dev/null
+++ b/doc/man/nvme_id_ctrl_fna.2
@@ -0,0 +1,39 @@
+.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "April 2022" "API Manual" LINUX
+.SH NAME
+enum nvme_id_ctrl_fna \- This field indicates attributes for the Format NVM command.
+.SH SYNOPSIS
+enum nvme_id_ctrl_fna {
+.br
+.BI " NVME_CTRL_FNA_FMT_ALL_NAMESPACES"
+,
+.br
+.br
+.BI " NVME_CTRL_FNA_SEC_ALL_NAMESPACES"
+,
+.br
+.br
+.BI " NVME_CTRL_FNA_CRYPTO_ERASE"
+
+};
+.SH Constants
+.IP "NVME_CTRL_FNA_FMT_ALL_NAMESPACES" 12
+If set, then all namespaces in an NVM
+subsystem shall be configured with the
+same attributes and a format (excluding
+secure erase) of any namespace results in
+a format of all namespaces in an NVM
+subsystem. If cleared, then the
+controller supports format on a per
+namespace basis.
+.IP "NVME_CTRL_FNA_SEC_ALL_NAMESPACES" 12
+If set, then any secure erase performed
+as part of a format operation results in
+a secure erase of all namespaces in the
+NVM subsystem. If cleared, then any
+secure erase performed as part of a
+format results in a secure erase of the
+particular namespace specified.
+.IP "NVME_CTRL_FNA_CRYPTO_ERASE" 12
+If set, then cryptographic erase is
+supported. If cleared, then cryptographic
+erase is not supported.