Adding upstream version 1.0.upstream/1.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 52 insertions, 0 deletions

diff --git a/doc/man/nvme_format_nvm_args.2 b/doc/man/nvme_format_nvm_args.2
new file mode 100644
index 0000000..53f4fcb
--- /dev/null
+++ b/doc/man/nvme_format_nvm_args.2
@@ -0,0 +1,52 @@
+.TH "libnvme" 9 "struct nvme_format_nvm_args" "April 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_format_nvm_args \- Arguments for the Format Nvme Namespace command
+.SH SYNOPSIS
+struct nvme_format_nvm_args {
+.br
+.BI "    __u32 *result;"
+.br
+.BI "    int args_size;"
+.br
+.BI "    int fd;"
+.br
+.BI "    __u32 timeout;"
+.br
+.BI "    __u32 nsid;"
+.br
+.BI "    enum nvme_cmd_format_mset mset;"
+.br
+.BI "    enum nvme_cmd_format_pi pi;"
+.br
+.BI "    enum nvme_cmd_format_pil pil;"
+.br
+.BI "    enum nvme_cmd_format_ses ses;"
+.br
+.BI "    __u8 lbaf;"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "result" 12
+The command completion result from CQE dword0
+.IP "args_size" 12
+Size of \fIstruct nvme_format_nvm_args\fP
+.IP "fd" 12
+File descriptor of nvme device
+.IP "timeout" 12
+Set to override default timeout to this value in milliseconds;
+useful for long running formats. 0 will use system default.
+.IP "nsid" 12
+Namespace ID to format
+.IP "mset" 12
+Metadata settings (extended or separated), true if extended
+.IP "pi" 12
+Protection information type
+.IP "pil" 12
+Protection information location (beginning or end), true if end
+.IP "ses" 12
+Secure erase settings
+.IP "lbaf" 12
+Logical block address format