diff options
Diffstat (limited to 'doc/man/nvme_mi_admin_identify.2')
| -rw-r--r-- | doc/man/nvme_mi_admin_identify.2 | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_identify.2 b/doc/man/nvme_mi_admin_identify.2 new file mode 100644 index 0000000..3af75ee --- /dev/null +++ b/doc/man/nvme_mi_admin_identify.2 @@ -0,0 +1,24 @@ +.TH "nvme_mi_admin_identify" 9 "nvme_mi_admin_identify" "February 2024" "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" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |