| 1 |
.TH "libnvme" 9 "struct nvme_mi_admin_req_hdr" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_mi_admin_req_hdr \- Admin command request header. |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_mi_admin_req_hdr { |
| 6 |
.br |
| 7 |
.BI " struct nvme_mi_msg_hdr hdr;" |
| 8 |
.br |
| 9 |
.BI " __u8 opcode;" |
| 10 |
.br |
| 11 |
.BI " __u8 flags;" |
| 12 |
.br |
| 13 |
.BI " __le16 ctrl_id;" |
| 14 |
.br |
| 15 |
.BI " __le32 cdw1, cdw2, cdw3, cdw4, cdw5;" |
| 16 |
.br |
| 17 |
.BI " __le32 doff;" |
| 18 |
.br |
| 19 |
.BI " __le32 dlen;" |
| 20 |
.br |
| 21 |
.BI " __le32 rsvd0, rsvd1;" |
| 22 |
.br |
| 23 |
.BI " __le32 cdw10, cdw11, cdw12, cdw13, cdw14, cdw15;" |
| 24 |
.br |
| 25 |
.BI " |
| 26 |
}; |
| 27 |
.br |
| 28 |
|
| 29 |
.SH Members |
| 30 |
.IP "hdr" 12 |
| 31 |
Generic MI message header |
| 32 |
.IP "opcode" 12 |
| 33 |
Admin command opcode (using enum nvme_admin_opcode) |
| 34 |
.IP "flags" 12 |
| 35 |
Command Flags, indicating dlen and doff validity; Only defined in |
| 36 |
NVMe-MI version 1.1, no fields defined in 1.2 (where the dlen/doff |
| 37 |
are always considered valid). |
| 38 |
.IP "ctrl_id" 12 |
| 39 |
Controller ID target of command |
| 40 |
.IP "cdw1" 12 |
| 41 |
Submission Queue Entry doubleword 1 |
| 42 |
.IP "cdw2" 12 |
| 43 |
Submission Queue Entry doubleword 2 |
| 44 |
.IP "cdw3" 12 |
| 45 |
Submission Queue Entry doubleword 3 |
| 46 |
.IP "cdw4" 12 |
| 47 |
Submission Queue Entry doubleword 4 |
| 48 |
.IP "cdw5" 12 |
| 49 |
Submission Queue Entry doubleword 5 |
| 50 |
.IP "doff" 12 |
| 51 |
Offset of data to return from command |
| 52 |
.IP "dlen" 12 |
| 53 |
Length of sent/returned data |
| 54 |
.IP "rsvd0" 12 |
| 55 |
Reserved |
| 56 |
.IP "rsvd1" 12 |
| 57 |
Reserved |
| 58 |
.IP "cdw10" 12 |
| 59 |
Submission Queue Entry doubleword 10 |
| 60 |
.IP "cdw11" 12 |
| 61 |
Submission Queue Entry doubleword 11 |
| 62 |
.IP "cdw12" 12 |
| 63 |
Submission Queue Entry doubleword 12 |
| 64 |
.IP "cdw13" 12 |
| 65 |
Submission Queue Entry doubleword 13 |
| 66 |
.IP "cdw14" 12 |
| 67 |
Submission Queue Entry doubleword 14 |
| 68 |
.IP "cdw15" 12 |
| 69 |
Submission Queue Entry doubleword 15 |
| 70 |
.SH "Description" |
| 71 |
Wire format for Admin command message headers, defined in section 6 of |
| 72 |
NVMe-MI. |