summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_error.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_get_log_error.2')
-rw-r--r--doc/man/nvme_get_log_error.225
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/man/nvme_get_log_error.2 b/doc/man/nvme_get_log_error.2
new file mode 100644
index 0000000..48c1bc1
--- /dev/null
+++ b/doc/man/nvme_get_log_error.2
@@ -0,0 +1,25 @@
+.TH "nvme_get_log_error" 9 "nvme_get_log_error" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_get_log_error \- Retrieve nvme error log
+.SH SYNOPSIS
+.B "int" nvme_get_log_error
+.BI "(int fd " ","
+.BI "unsigned int nr_entries " ","
+.BI "bool rae " ","
+.BI "struct nvme_error_log_page *err_log " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "nr_entries" 12
+Number of error log entries allocated
+.IP "rae" 12
+Retain asynchronous events
+.IP "err_log" 12
+Array of error logs of size 'entries'
+.SH "DESCRIPTION"
+This log page describes extended error information for a command that
+completed with error, or may report an error that is not specific to a
+particular command.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.