summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_endurance_group.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_get_log_endurance_group.2')
-rw-r--r--doc/man/nvme_get_log_endurance_group.225
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/man/nvme_get_log_endurance_group.2 b/doc/man/nvme_get_log_endurance_group.2
new file mode 100644
index 0000000..91b596e
--- /dev/null
+++ b/doc/man/nvme_get_log_endurance_group.2
@@ -0,0 +1,25 @@
+.TH "nvme_get_log_endurance_group" 9 "nvme_get_log_endurance_group" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_get_log_endurance_group \- Get Endurance Group log
+.SH SYNOPSIS
+.B "int" nvme_get_log_endurance_group
+.BI "(int fd " ","
+.BI "__u16 endgid " ","
+.BI "struct nvme_endurance_group_log *log " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "endgid" 12
+Starting group identifier to return in the list
+.IP "log" 12
+User address to store the endurance log
+.SH "DESCRIPTION"
+This log page indicates if an Endurance Group Event has occurred for a
+particular Endurance Group. If an Endurance Group Event has occurred, the
+details of the particular event are included in the Endurance Group
+Information log page for that Endurance Group. An asynchronous event is
+generated when an entry for an Endurance Group is newly added to this log
+page.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.