| 1 |
.TH "libnvme" 9 "struct nvme_passthru_cmd" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_passthru_cmd \- nvme passthrough command structure |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_passthru_cmd { |
| 6 |
.br |
| 7 |
.BI " __u8 opcode;" |
| 8 |
.br |
| 9 |
.BI " __u8 flags;" |
| 10 |
.br |
| 11 |
.BI " __u16 rsvd1;" |
| 12 |
.br |
| 13 |
.BI " __u32 nsid;" |
| 14 |
.br |
| 15 |
.BI " __u32 cdw2;" |
| 16 |
.br |
| 17 |
.BI " __u32 cdw3;" |
| 18 |
.br |
| 19 |
.BI " __u64 metadata;" |
| 20 |
.br |
| 21 |
.BI " __u64 addr;" |
| 22 |
.br |
| 23 |
.BI " __u32 metadata_len;" |
| 24 |
.br |
| 25 |
.BI " __u32 data_len;" |
| 26 |
.br |
| 27 |
.BI " __u32 cdw10;" |
| 28 |
.br |
| 29 |
.BI " __u32 cdw11;" |
| 30 |
.br |
| 31 |
.BI " __u32 cdw12;" |
| 32 |
.br |
| 33 |
.BI " __u32 cdw13;" |
| 34 |
.br |
| 35 |
.BI " __u32 cdw14;" |
| 36 |
.br |
| 37 |
.BI " __u32 cdw15;" |
| 38 |
.br |
| 39 |
.BI " __u32 timeout_ms;" |
| 40 |
.br |
| 41 |
.BI " __u32 result;" |
| 42 |
.br |
| 43 |
.BI " |
| 44 |
}; |
| 45 |
.br |
| 46 |
|
| 47 |
.SH Members |
| 48 |
.IP "opcode" 12 |
| 49 |
Operation code, see \fIenum nvme_io_opcodes\fP and \fIenum nvme_admin_opcodes\fP |
| 50 |
.IP "flags" 12 |
| 51 |
Not supported: intended for command flags (eg: SGL, FUSE) |
| 52 |
.IP "rsvd1" 12 |
| 53 |
Reserved for future use |
| 54 |
.IP "nsid" 12 |
| 55 |
Namespace Identifier, or Fabrics type |
| 56 |
.IP "cdw2" 12 |
| 57 |
Command Dword 2 (no spec defined use) |
| 58 |
.IP "cdw3" 12 |
| 59 |
Command Dword 3 (no spec defined use) |
| 60 |
.IP "metadata" 12 |
| 61 |
User space address to metadata buffer (NULL if not used) |
| 62 |
.IP "addr" 12 |
| 63 |
User space address to data buffer (NULL if not used) |
| 64 |
.IP "metadata_len" 12 |
| 65 |
Metadata buffer transfer length |
| 66 |
.IP "data_len" 12 |
| 67 |
Data buffer transfer length |
| 68 |
.IP "cdw10" 12 |
| 69 |
Command Dword 10 (command specific) |
| 70 |
.IP "cdw11" 12 |
| 71 |
Command Dword 11 (command specific) |
| 72 |
.IP "cdw12" 12 |
| 73 |
Command Dword 12 (command specific) |
| 74 |
.IP "cdw13" 12 |
| 75 |
Command Dword 13 (command specific) |
| 76 |
.IP "cdw14" 12 |
| 77 |
Command Dword 14 (command specific) |
| 78 |
.IP "cdw15" 12 |
| 79 |
Command Dword 15 (command specific) |
| 80 |
.IP "timeout_ms" 12 |
| 81 |
If non-zero, overrides system default timeout in milliseconds |
| 82 |
.IP "result" 12 |
| 83 |
Set on completion to the command's CQE DWORD 0 controller response |