summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_discovery_args.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-05 18:17:17 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-05 18:17:17 +0000
commit0e75b5495117b9888b7a557fab1db40145a9a705 (patch)
treee294b5156b7a85197e4b3192b6fba291a26dd5c6 /doc/man/nvme_get_discovery_args.2
parentAdding upstream version 1.1. (diff)
downloadlibnvme-0e75b5495117b9888b7a557fab1db40145a9a705.tar.xz
libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.zip
Adding upstream version 1.2.upstream/1.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_get_discovery_args.2')
-rw-r--r--doc/man/nvme_get_discovery_args.235
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/man/nvme_get_discovery_args.2 b/doc/man/nvme_get_discovery_args.2
new file mode 100644
index 0000000..d80b614
--- /dev/null
+++ b/doc/man/nvme_get_discovery_args.2
@@ -0,0 +1,35 @@
+.TH "libnvme" 9 "struct nvme_get_discovery_args" "October 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_get_discovery_args \- Arguments for nvmf_get_discovery_wargs()
+.SH SYNOPSIS
+struct nvme_get_discovery_args {
+.br
+.BI " nvme_ctrl_t c;"
+.br
+.BI " int args_size;"
+.br
+.BI " int max_retries;"
+.br
+.BI " __u32 *result;"
+.br
+.BI " __u32 timeout;"
+.br
+.BI " __u8 lsp;"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "c" 12
+Discovery controller
+.IP "args_size" 12
+Length of the structure
+.IP "max_retries" 12
+Number of retries in case of failure
+.IP "result" 12
+The command completion result from CQE dword0
+.IP "timeout" 12
+Timeout in ms (default: NVME_DEFAULT_IOCTL_TIMEOUT)
+.IP "lsp" 12
+Log specific field (See enum nvmf_log_discovery_lsp)