diff options
Diffstat (limited to '')
-rw-r--r-- | doc/man/nvme_mi_admin_identify_ctrl.2 | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_identify_ctrl.2 b/doc/man/nvme_mi_admin_identify_ctrl.2 new file mode 100644 index 0000000..d624c3e --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_ctrl.2 @@ -0,0 +1,23 @@ +.TH "nvme_mi_admin_identify_ctrl" 9 "nvme_mi_admin_identify_ctrl" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_ctrl \- Perform an Admin identify for a controller +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_ctrl +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_id_ctrl *id " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "id" 12 +Controller identify data to populate +.SH "DESCRIPTION" +Perform an Identify command, for the controller specified by \fIctrl\fP, +writing identify data to \fIid\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_id_ctrl\fP +.SH "RETURN" +0 on success, non-zero on failure |