diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:22:29 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:22:29 +0000 |
commit | 068a45420f2c98887e220b45e946cc7074da550e (patch) | |
tree | c5b54e8b4b235232b057a9c534d9a16d2208463d /doc/man/nvme_mi_admin_get_log_page.2 | |
parent | Initial commit. (diff) | |
download | libnvme-068a45420f2c98887e220b45e946cc7074da550e.tar.xz libnvme-068a45420f2c98887e220b45e946cc7074da550e.zip |
Adding upstream version 1.8.upstream/1.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | doc/man/nvme_mi_admin_get_log_page.2 | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_get_log_page.2 b/doc/man/nvme_mi_admin_get_log_page.2 new file mode 100644 index 0000000..f016429 --- /dev/null +++ b/doc/man/nvme_mi_admin_get_log_page.2 @@ -0,0 +1,28 @@ +.TH "nvme_mi_admin_get_log_page" 9 "nvme_mi_admin_get_log_page" "February 2024" "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. |