summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_identify.2
blob: 1d95814b932a11406b79a81f623d51c9f3448d99 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.TH "nvme_mi_admin_identify" 9 "nvme_mi_admin_identify" "August 2022" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify \- Perform an Admin identify command.
.SH SYNOPSIS
.B "int" nvme_mi_admin_identify
.BI "(nvme_mi_ctrl_t ctrl "  ","
.BI "struct nvme_identify_args *args "  ");"
.SH ARGUMENTS
.IP "ctrl" 12
Controller to process identify command
.IP "args" 12
Identify command arguments
.SH "DESCRIPTION"
Perform an Identify command, using the Identify command parameters in \fIargs\fP.
Stores the identify data in ->data, and (if set) the result from cdw0
into args->result.

Will return an error if the length of the response data (from the
controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP.

See: \fIstruct nvme_identify_args\fP
.SH "RETURN"
0 on success, non-zero on failure