summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_identify_secondary_ctrl_list.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/nvme_identify_secondary_ctrl_list.2
parentInitial commit. (diff)
downloadlibnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.tar.xz
libnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.zip
Adding upstream version 1.0.upstream/1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_identify_secondary_ctrl_list.2')
-rw-r--r--doc/man/nvme_identify_secondary_ctrl_list.229
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/man/nvme_identify_secondary_ctrl_list.2 b/doc/man/nvme_identify_secondary_ctrl_list.2
new file mode 100644
index 0000000..7a81cce
--- /dev/null
+++ b/doc/man/nvme_identify_secondary_ctrl_list.2
@@ -0,0 +1,29 @@
+.TH "nvme_identify_secondary_ctrl_list" 9 "nvme_identify_secondary_ctrl_list" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_identify_secondary_ctrl_list \- Retrieves secondary controller list
+.SH SYNOPSIS
+.B "int" nvme_identify_secondary_ctrl_list
+.BI "(int fd " ","
+.BI "__u32 nsid " ","
+.BI "__u16 cntid " ","
+.BI "struct nvme_secondary_ctrl_list *sc_list " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "nsid" 12
+Namespace identifier
+.IP "cntid" 12
+Return controllers starting at this identifier
+.IP "sc_list" 12
+User space destination address to transfer the data
+.SH "DESCRIPTION"
+A Secondary Controller List is returned to the host for up to 127 secondary
+controllers associated with the primary controller processing this command.
+The list contains entries for controller identifiers greater than or equal
+to the value specified in the Controller Identifier (cntid).
+
+See \fIstruct nvme_secondary_ctrls_list\fP for a defintion of the returned
+structure.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.