summaryrefslogtreecommitdiffstats
path: root/doc/man/nvmf_register_ctrl.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/nvmf_register_ctrl.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/nvmf_register_ctrl.2')
-rw-r--r--doc/man/nvmf_register_ctrl.222
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/man/nvmf_register_ctrl.2 b/doc/man/nvmf_register_ctrl.2
new file mode 100644
index 0000000..813cac6
--- /dev/null
+++ b/doc/man/nvmf_register_ctrl.2
@@ -0,0 +1,22 @@
+.TH "nvmf_register_ctrl" 9 "nvmf_register_ctrl" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvmf_register_ctrl \- Perform registration task with a DC
+.SH SYNOPSIS
+.B "int" nvmf_register_ctrl
+.BI "(nvme_ctrl_t c " ","
+.BI "enum nvmf_dim_tas tas " ","
+.BI "__u32 *result " ");"
+.SH ARGUMENTS
+.IP "c" 12
+Controller instance
+.IP "tas" 12
+Task field of the Command Dword 10 (cdw10). Indicates whether to
+perform a Registration, Deregistration, or Registration-update.
+.IP "result" 12
+The command-specific result returned by the DC upon command
+completion.
+.SH "DESCRIPTION"
+Perform registration task with a Discovery Controller (DC). Three
+tasks are supported: register, deregister, and registration update.
+.SH "RETURN"
+0 on success; on failure -1 is returned and errno is set