Debian Codegraph @

doc/man/nvme_mi_mi_xfer.2

raw
1 .TH "nvme_mi_mi_xfer" 9 "nvme_mi_mi_xfer" "November 2025" "libnvme API manual" LINUX
2 .SH NAME
3 nvme_mi_mi_xfer \- Raw mi transfer interface.
4 .SH SYNOPSIS
5 .B "int" nvme_mi_mi_xfer
6 .BI "(nvme_mi_ep_t ep " ","
7 .BI "struct nvme_mi_mi_req_hdr *mi_req " ","
8 .BI "size_t req_data_size " ","
9 .BI "struct nvme_mi_mi_resp_hdr *mi_resp " ","
10 .BI "size_t *resp_data_size " ");"
11 .SH ARGUMENTS
12 .IP "ep" 12
13 endpoint to send the MI command to
14 .IP "mi_req" 12
15 request data
16 .IP "req_data_size" 12
17 size of request data payload
18 .IP "mi_resp" 12
19 buffer for response data
20 .IP "resp_data_size" 12
21 size of response data buffer, updated to received size
22 .SH "DESCRIPTION"
23 Performs an arbitrary NVMe MI command, using the provided request data,
24 in \fImi_req\fP. The size of the request data *payload* is specified in
25 \fIreq_data_size\fP - this does not include the standard header length (so a
26 header-only request would have a size of 0). Note that the Management
27 Request Doublewords are considered part of the header data.
28
29 On success, response data is stored in \fImi_resp\fP, which has an optional
30 appended payload buffer of \fIresp_data_size\fP bytes. The actual payload
31 size transferred will be stored in \fIresp_data_size\fP. This size does not
32 include the MI response header, so 0 represents no payload.
33
34 See: \fIstruct nvme_mi_mi_req_hdr\fP and \fIstruct nvme_mi_mi_resp_hdr\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..