summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_log_discovery.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
commit2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_get_log_discovery.2
parentInitial commit. (diff)
downloadlibnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.tar.xz
libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.zip
Adding upstream version 1.3.upstream/1.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_get_log_discovery.2')
-rw-r--r--doc/man/nvme_get_log_discovery.227
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/man/nvme_get_log_discovery.2 b/doc/man/nvme_get_log_discovery.2
new file mode 100644
index 0000000..4fd1409
--- /dev/null
+++ b/doc/man/nvme_get_log_discovery.2
@@ -0,0 +1,27 @@
+.TH "nvme_get_log_discovery" 9 "nvme_get_log_discovery" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_get_log_discovery \- Retrieve Discovery log page
+.SH SYNOPSIS
+.B "int" nvme_get_log_discovery
+.BI "(int fd " ","
+.BI "bool rae " ","
+.BI "__u32 offset " ","
+.BI "__u32 len " ","
+.BI "void *log " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "rae" 12
+Retain asynchronous events
+.IP "offset" 12
+Offset of this log to retrieve
+.IP "len" 12
+The allocated size for this portion of the log
+.IP "log" 12
+User address to store the discovery log
+.SH "DESCRIPTION"
+Supported only by fabrics discovery controllers, returning discovery
+records.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.