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
|
.TH "nvme_io_passthru" 9 "nvme_io_passthru" "January 2023" "libnvme API manual" LINUX
.SH NAME
nvme_io_passthru \- Submit an nvme io passthrough command
.SH SYNOPSIS
.B "int" nvme_io_passthru
.BI "(int fd " ","
.BI "__u8 opcode " ","
.BI "__u8 flags " ","
.BI "__u16 rsvd " ","
.BI "__u32 nsid " ","
.BI "__u32 cdw2 " ","
.BI "__u32 cdw3 " ","
.BI "__u32 cdw10 " ","
.BI "__u32 cdw11 " ","
.BI "__u32 cdw12 " ","
.BI "__u32 cdw13 " ","
.BI "__u32 cdw14 " ","
.BI "__u32 cdw15 " ","
.BI "__u32 data_len " ","
.BI "void *data " ","
.BI "__u32 metadata_len " ","
.BI "void *metadata " ","
.BI "__u32 timeout_ms " ","
.BI "__u32 *result " ");"
.SH ARGUMENTS
.IP "fd" 12
File descriptor of nvme device
.IP "opcode" 12
The nvme io command to send
.IP "flags" 12
NVMe command flags (not used)
.IP "rsvd" 12
Reserved for future use
.IP "nsid" 12
Namespace identifier
.IP "cdw2" 12
Command dword 2
.IP "cdw3" 12
Command dword 3
.IP "cdw10" 12
Command dword 10
.IP "cdw11" 12
Command dword 11
.IP "cdw12" 12
Command dword 12
.IP "cdw13" 12
Command dword 13
.IP "cdw14" 12
Command dword 14
.IP "cdw15" 12
Command dword 15
.IP "data_len" 12
Length of the data transferred in this command in bytes
.IP "data" 12
Pointer to user address of the data buffer
.IP "metadata_len" 12
Length of metadata transferred in this command
.IP "metadata" 12
Pointer to user address of the metadata buffer
.IP "timeout_ms" 12
How long the kernel waits for the command to complete
.IP "result" 12
Optional field to return the result from the CQE dword 0
.SH "DESCRIPTION"
Parameterized form of \fBnvme_submit_io_passthru\fP. This sets up and submits
a \fIstruct nvme_passthru_cmd\fP.
Known values for \fIopcode\fP are defined in \fIenum nvme_io_opcode\fP.
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
|
