From 2dba2525fb35dcfc79aad5bdf6c92e790d69635c Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 29 Apr 2024 06:40:20 +0200 Subject: Adding upstream version 1.3. Signed-off-by: Daniel Baumann --- doc/man/nvme_mi_admin_get_log.2 | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 doc/man/nvme_mi_admin_get_log.2 (limited to 'doc/man/nvme_mi_admin_get_log.2') diff --git a/doc/man/nvme_mi_admin_get_log.2 b/doc/man/nvme_mi_admin_get_log.2 new file mode 100644 index 0000000..3d63864 --- /dev/null +++ b/doc/man/nvme_mi_admin_get_log.2 @@ -0,0 +1,25 @@ +.TH "nvme_mi_admin_get_log" 9 "nvme_mi_admin_get_log" "January 2023" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_get_log \- Retrieve log page data from controller +.SH SYNOPSIS +.B "int" nvme_mi_admin_get_log +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_get_log_args *args " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to query +.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. -- cgit v1.2.3