diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:17 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:17 +0000 |
commit | 0e75b5495117b9888b7a557fab1db40145a9a705 (patch) | |
tree | e294b5156b7a85197e4b3192b6fba291a26dd5c6 /doc/man/nvme_mi_admin_get_nsid_log.2 | |
parent | Adding upstream version 1.1. (diff) | |
download | libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.tar.xz libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.zip |
Adding upstream version 1.2.upstream/1.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | doc/man/nvme_mi_admin_get_nsid_log.2 | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_get_nsid_log.2 b/doc/man/nvme_mi_admin_get_nsid_log.2 new file mode 100644 index 0000000..6976fe4 --- /dev/null +++ b/doc/man/nvme_mi_admin_get_nsid_log.2 @@ -0,0 +1,32 @@ +.TH "nvme_mi_admin_get_nsid_log" 9 "nvme_mi_admin_get_nsid_log" "October 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_get_nsid_log \- Helper for Get Log Page functions +.SH SYNOPSIS +.B "int" nvme_mi_admin_get_nsid_log +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "bool rae " "," +.BI "enum nvme_cmd_get_log_lid lid " "," +.BI "__u32 nsid " "," +.BI "__u32 len " "," +.BI "void *log " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to query +.IP "rae" 12 +Retain Asynchronous Events +.IP "lid" 12 +Log identifier +.IP "nsid" 12 +Namespace ID +.IP "len" 12 +length of log buffer +.IP "log" 12 +pointer for resulting log data +.SH "DESCRIPTION" +Performs a Get Log Page Admin command for a specific log ID \fIlid\fP and +namespace ID \fInsid\fP. Log data is expected to be \fIlen\fP bytes, and is stored +in \fIlog\fP on success. The \fIrae\fP flag is passed as-is to the Get Log Page +command, and is specific to the Log Page requested. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |