summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_endurance_group.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:53:09 +0000
commit3945f3269b3e2763faa1ab22d225ca4dd1856b82 (patch)
tree7e96ec768baa3807ce3a1076a74037a287f4caa8 /doc/man/nvme_get_log_endurance_group.2
parentInitial commit. (diff)
downloadlibnvme-c5db69fa99ba733bb136fc2b6fbb4961839f27ea.tar.xz
libnvme-c5db69fa99ba733bb136fc2b6fbb4961839f27ea.zip
Adding upstream version 1.0.upstream/1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
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..7a305f7
--- /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" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_get_log_endurance_group \-
+.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.