summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_identify_ctrl_list.2
blob: ad4f894c5e46c03d5185f102afcedf68b69c8e09 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
.TH "nvme_mi_admin_identify_ctrl_list" 9 "nvme_mi_admin_identify_ctrl_list" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_ctrl_list \- Perform an Admin identify for a controller list.
.SH SYNOPSIS
.B "int" nvme_mi_admin_identify_ctrl_list
.BI "(nvme_mi_ctrl_t ctrl "  ","
.BI "__u16 cntid "  ","
.BI "struct nvme_ctrl_list *list "  ");"
.SH ARGUMENTS
.IP "ctrl" 12
Controller to process identify command
.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 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.