summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_identify_nsid_ctrl_list.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_mi_admin_identify_nsid_ctrl_list.2')
-rw-r--r--doc/man/nvme_mi_admin_identify_nsid_ctrl_list.230
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_identify_nsid_ctrl_list.2 b/doc/man/nvme_mi_admin_identify_nsid_ctrl_list.2
new file mode 100644
index 0000000..e10dfbe
--- /dev/null
+++ b/doc/man/nvme_mi_admin_identify_nsid_ctrl_list.2
@@ -0,0 +1,30 @@
+.TH "nvme_mi_admin_identify_nsid_ctrl_list" 9 "nvme_mi_admin_identify_nsid_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_nsid_ctrl_list \- Perform an Admin identify for a controller list with specific namespace ID
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_nsid_ctrl_list
+.BI "(nvme_mi_ctrl_t ctrl " ","
+.BI "__u32 nsid " ","
+.BI "__u16 cntid " ","
+.BI "struct nvme_ctrl_list *list " ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+Namespace identifier
+.IP "cntid" 12
+Controller ID to specify list start
+.IP "list" 12
+List data to populate
+.SH "DESCRIPTION"
+Perform an Identify command, for the controller list for \fInsid\fP, starting
+with IDs greater than or equal to \fIcntid\fP.
+
+Will return an error if the length of the response data (from the
+controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP, so \fIid\fP will be
+fully populated on success.
+
+See: \fIstruct nvme_ctrl_list\fP
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.