summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_init_ctrl.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
commit2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_init_ctrl.2
parentInitial commit. (diff)
downloadlibnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.tar.xz
libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.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_init_ctrl.2')
-rw-r--r--doc/man/nvme_init_ctrl.217
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man/nvme_init_ctrl.2 b/doc/man/nvme_init_ctrl.2
new file mode 100644
index 0000000..1102cb0
--- /dev/null
+++ b/doc/man/nvme_init_ctrl.2
@@ -0,0 +1,17 @@
+.TH "nvme_init_ctrl" 9 "nvme_init_ctrl" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_init_ctrl \- Initialize nvme_ctrl_t object for an existing controller.
+.SH SYNOPSIS
+.B "int" nvme_init_ctrl
+.BI "(nvme_host_t h " ","
+.BI "nvme_ctrl_t c " ","
+.BI "int instance " ");"
+.SH ARGUMENTS
+.IP "h" 12
+nvme_host_t object
+.IP "c" 12
+nvme_ctrl_t object
+.IP "instance" 12
+Instance number (e.g. 1 for nvme1)
+.SH "RETURN"
+The \fBioctl\fP return code. Typically 0 on success.