| 1 |
.TH "libnvme" 9 "struct nvme_get_log_args" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_get_log_args \- Arguments for the NVMe Admin Get Log command |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_get_log_args { |
| 6 |
.br |
| 7 |
.BI " __u64 lpo;" |
| 8 |
.br |
| 9 |
.BI " __u32 *result;" |
| 10 |
.br |
| 11 |
.BI " void *log;" |
| 12 |
.br |
| 13 |
.BI " int args_size;" |
| 14 |
.br |
| 15 |
.BI " int fd;" |
| 16 |
.br |
| 17 |
.BI " __u32 timeout;" |
| 18 |
.br |
| 19 |
.BI " enum nvme_cmd_get_log_lid lid;" |
| 20 |
.br |
| 21 |
.BI " __u32 len;" |
| 22 |
.br |
| 23 |
.BI " __u32 nsid;" |
| 24 |
.br |
| 25 |
.BI " enum nvme_csi csi;" |
| 26 |
.br |
| 27 |
.BI " __u16 lsi;" |
| 28 |
.br |
| 29 |
.BI " __u8 lsp;" |
| 30 |
.br |
| 31 |
.BI " __u8 uuidx;" |
| 32 |
.br |
| 33 |
.BI " bool rae;" |
| 34 |
.br |
| 35 |
.BI " bool ot;" |
| 36 |
.br |
| 37 |
.BI " |
| 38 |
}; |
| 39 |
.br |
| 40 |
|
| 41 |
.SH Members |
| 42 |
.IP "lpo" 12 |
| 43 |
Log page offset for partial log transfers |
| 44 |
.IP "result" 12 |
| 45 |
The command completion result from CQE dword0 |
| 46 |
.IP "log" 12 |
| 47 |
User space destination address to transfer the data |
| 48 |
.IP "args_size" 12 |
| 49 |
Length of the structure |
| 50 |
.IP "fd" 12 |
| 51 |
File descriptor of nvme device |
| 52 |
.IP "timeout" 12 |
| 53 |
Timeout in ms |
| 54 |
.IP "lid" 12 |
| 55 |
Log page identifier, see \fIenum nvme_cmd_get_log_lid\fP for known |
| 56 |
values |
| 57 |
.IP "len" 12 |
| 58 |
Length of provided user buffer to hold the log data in bytes |
| 59 |
.IP "nsid" 12 |
| 60 |
Namespace identifier, if applicable |
| 61 |
.IP "csi" 12 |
| 62 |
Command set identifier, see \fIenum nvme_csi\fP for known values |
| 63 |
.IP "lsi" 12 |
| 64 |
Log Specific Identifier |
| 65 |
.IP "lsp" 12 |
| 66 |
Log specific field |
| 67 |
.IP "uuidx" 12 |
| 68 |
UUID selection, if supported |
| 69 |
.IP "rae" 12 |
| 70 |
Retain asynchronous events |
| 71 |
.IP "ot" 12 |
| 72 |
Offset Type; if set \fIlpo\fP specifies the index into the list |
| 73 |
of data structures, otherwise \fIlpo\fP specifies the byte offset |
| 74 |
into the log page. |