summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_init_ctrl_list.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_list.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_list.2')
-rw-r--r--doc/man/nvme_init_ctrl_list.218
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/man/nvme_init_ctrl_list.2 b/doc/man/nvme_init_ctrl_list.2
new file mode 100644
index 0000000..04b7edf
--- /dev/null
+++ b/doc/man/nvme_init_ctrl_list.2
@@ -0,0 +1,18 @@
+.TH "nvme_init_ctrl_list" 9 "nvme_init_ctrl_list" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_init_ctrl_list \- Initialize an nvme_ctrl_list structure from an array.
+.SH SYNOPSIS
+.B "void" nvme_init_ctrl_list
+.BI "(struct nvme_ctrl_list *cntlist " ","
+.BI "__u16 num_ctrls " ","
+.BI "__u16 *ctrlist " ");"
+.SH ARGUMENTS
+.IP "cntlist" 12
+The controller list structure to initialize
+.IP "num_ctrls" 12
+The number of controllers in the array, \fIctrlist\fP.
+.IP "ctrlist" 12
+An array of controller identifiers in CPU native endian.
+.SH "DESCRIPTION"
+This is intended to be used with any command that takes a controller list
+argument. See \fBnvme_ns_attach_ctrls\fP and \fBnvme_ns_detach\fP.