diff options
Diffstat (limited to 'doc/man/nvme_mi_admin_get_log.2')
| -rw-r--r-- | doc/man/nvme_mi_admin_get_log.2 | 24 |
1 files changed, 24 insertions, 0 deletions
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..1727124 --- /dev/null +++ b/doc/man/nvme_mi_admin_get_log.2 @@ -0,0 +1,24 @@ +.TH "nvme_mi_admin_get_log" 9 "nvme_mi_admin_get_log" "August 2022" "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" +0 on success, non-zero on failure |