| 1 |
.TH "nvme_mi_admin_identify_partial" 9 "nvme_mi_admin_identify_partial" "November 2025" "libnvme API manual" LINUX |
| 2 |
.SH NAME |
| 3 |
nvme_mi_admin_identify_partial \- Perform an Admin identify command, and retrieve partial response data. |
| 4 |
.SH SYNOPSIS |
| 5 |
.B "int" nvme_mi_admin_identify_partial |
| 6 |
.BI "(nvme_mi_ctrl_t ctrl " "," |
| 7 |
.BI "struct nvme_identify_args *args " "," |
| 8 |
.BI "off_t offset " "," |
| 9 |
.BI "size_t size " ");" |
| 10 |
.SH ARGUMENTS |
| 11 |
.IP "ctrl" 12 |
| 12 |
Controller to process identify command |
| 13 |
.IP "args" 12 |
| 14 |
Identify command arguments |
| 15 |
.IP "offset" 12 |
| 16 |
offset of identify data to retrieve from response |
| 17 |
.IP "size" 12 |
| 18 |
size of identify data to return |
| 19 |
.SH "DESCRIPTION" |
| 20 |
Perform an Identify command, using the Identify command parameters in \fIargs\fP. |
| 21 |
The \fIoffset\fP and \fIsize\fP arguments allow the caller to retrieve part of |
| 22 |
the identify response. See NVMe-MI section 6.2 for the semantics (and some |
| 23 |
handy diagrams) of the offset & size parameters. |
| 24 |
|
| 25 |
Will return an error if the length of the response data (from the controller) |
| 26 |
did not match \fIsize\fP. |
| 27 |
|
| 28 |
Unless you're performing a vendor-unique identify command, You'll probably |
| 29 |
want to use one of the identify helpers (nvme_mi_admin_identify, |
| 30 |
nvme_mi_admin_identify_cns_nsid, or nvme_mi_admin_identify_<type>) instead |
| 31 |
of this. If the type of your identify command is standardized but not |
| 32 |
yet supported by libnvme-mi, please contact the maintainers. |
| 33 |
|
| 34 |
See: \fIstruct nvme_identify_args\fP |
| 35 |
.SH "RETURN" |
| 36 |
The nvme command status if a response was received (see |
| 37 |
\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |