summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_get_log_page.2
blob: cc180801abdf218ef931cfb4f9fc648b9c3af714 (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
.TH "nvme_mi_admin_get_log_page" 9 "nvme_mi_admin_get_log_page" "December 2023" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_page \- Retrieve log page data from controller
.SH SYNOPSIS
.B "int" nvme_mi_admin_get_log_page
.BI "(nvme_mi_ctrl_t ctrl "  ","
.BI "__u32 xfer_len "  ","
.BI "struct nvme_get_log_args *args "  ");"
.SH ARGUMENTS
.IP "ctrl" 12
Controller to query
.IP "xfer_len" 12
The chunk size of the read
.IP "args" 12
Get Log Page command arguments
.SH "DESCRIPTION"
Performs a Get Log Page Admin command as specified by \fIargs\fP. Response data
is stored in \fIargs->data\fP, which should be a buffer of \fIargs->data_len\fP bytes.
Resulting data length is stored in \fIargs->data_len\fP on successful
command completion.

This request may be implemented as multiple log page commands, in order
to fit within MI message-size limits.

See: \fIstruct nvme_get_log_args\fP
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.