summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_req_hdr.2
blob: 3e6bf4aac4fd323b485a48854def8bdab251b992 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.TH "libnvme" 9 "struct nvme_mi_admin_req_hdr" "August 2022" "API Manual" LINUX
.SH NAME
struct nvme_mi_admin_req_hdr \- Admin command request header.
.SH SYNOPSIS
struct nvme_mi_admin_req_hdr {
.br
.BI "    struct nvme_mi_msg_hdr hdr;"
.br
.BI "    __u8 opcode;"
.br
.BI "    __u8 flags;"
.br
.BI "    __le16 ctrl_id;"
.br
.BI "    __le32 cdw1, cdw2, cdw3, cdw4, cdw5;"
.br
.BI "    __le32 doff;"
.br
.BI "    __le32 dlen;"
.br
.BI "    __le32 rsvd0, rsvd1;"
.br
.BI "    __le32 cdw10, cdw11, cdw12, cdw13, cdw14, cdw15;"
.br
.BI "
};
.br

.SH Members
.IP "hdr" 12
Generic MI message header
.IP "opcode" 12
Admin command opcode (using enum nvme_admin_opcode)
.IP "flags" 12
Command Flags, indicating dlen and doff validity; Only defined in
NVMe-MI version 1.1, no fields defined in 1.2 (where the dlen/doff
are always considered valid).
.IP "ctrl_id" 12
Controller ID target of command
.IP "cdw1" 12
Submission Queue Entry doubleword 1
.IP "cdw2" 12
Submission Queue Entry doubleword 2
.IP "cdw3" 12
Submission Queue Entry doubleword 3
.IP "cdw4" 12
Submission Queue Entry doubleword 4
.IP "cdw5" 12
Submission Queue Entry doubleword 5
.IP "doff" 12
Offset of data to return from command
.IP "dlen" 12
Length of sent/returned data
.IP "rsvd0" 12
Reserved
.IP "rsvd1" 12
Reserved
.IP "cdw10" 12
Submission Queue Entry doubleword 10
.IP "cdw11" 12
Submission Queue Entry doubleword 11
.IP "cdw12" 12
Submission Queue Entry doubleword 12
.IP "cdw13" 12
Submission Queue Entry doubleword 13
.IP "cdw14" 12
Submission Queue Entry doubleword 14
.IP "cdw15" 12
Submission Queue Entry doubleword 15
.SH "Description"
Wire format for Admin command message headers, defined in section 6 of
NVMe-MI.