diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-04-03 07:38:52 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-04-03 07:38:52 +0000 |
commit | 90cf2208656c513b78a587e3e0f1f64144c0f209 (patch) | |
tree | 003a07f93ade469ca1e876018c1a0b133b478f3b /doc/man/nvme_mi_admin_get_log_page.2 | |
parent | Releasing debian version 1.3-1. (diff) | |
download | libnvme-90cf2208656c513b78a587e3e0f1f64144c0f209.tar.xz libnvme-90cf2208656c513b78a587e3e0f1f64144c0f209.zip |
Merging upstream version 1.4.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_admin_get_log_page.2')
-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..dbd580c --- /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" "March 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. |