summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_identify_ctrl_list.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_identify_ctrl_list.2')
-rw-r--r--doc/man/nvme_identify_ctrl_list.224
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/man/nvme_identify_ctrl_list.2 b/doc/man/nvme_identify_ctrl_list.2
new file mode 100644
index 0000000..dc2296f
--- /dev/null
+++ b/doc/man/nvme_identify_ctrl_list.2
@@ -0,0 +1,24 @@
+.TH "nvme_identify_ctrl_list" 9 "nvme_identify_ctrl_list" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_identify_ctrl_list \- Retrieves identify controller list
+.SH SYNOPSIS
+.B "int" nvme_identify_ctrl_list
+.BI "(int fd " ","
+.BI "__u16 cntid " ","
+.BI "struct nvme_ctrl_list *cntlist " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "cntid" 12
+Starting CNTLID to return in the list
+.IP "cntlist" 12
+User space destination address to transfer the data
+.SH "DESCRIPTION"
+Up to 2047 controller identifiers is returned containing a controller
+identifier greater than or equal to the controller identifier specified in
+\fIcntid\fP.
+
+See \fIstruct nvme_ctrl_list\fP for a definition of the structure returned.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.