summaryrefslogtreecommitdiffstats
path: root/doc/man/nvmf_discovery_log.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/nvmf_discovery_log.2
parentInitial commit. (diff)
downloadlibnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.tar.xz
libnvme-3945f3269b3e2763faa1ab22d225ca4dd1856b82.zip
Adding upstream version 1.0.upstream/1.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvmf_discovery_log.2')
-rw-r--r--doc/man/nvmf_discovery_log.238
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/man/nvmf_discovery_log.2 b/doc/man/nvmf_discovery_log.2
new file mode 100644
index 0000000..f8707c1
--- /dev/null
+++ b/doc/man/nvmf_discovery_log.2
@@ -0,0 +1,38 @@
+.TH "libnvme" 9 "struct nvmf_discovery_log" "April 2022" "API Manual" LINUX
+.SH NAME
+struct nvmf_discovery_log \- Discovery Log Page (Log Identifier 70h)
+.SH SYNOPSIS
+struct nvmf_discovery_log {
+.br
+.BI " __le64 genctr;"
+.br
+.BI " __le64 numrec;"
+.br
+.BI " __le16 recfmt;"
+.br
+.BI " __u8 rsvd14[1006];"
+.br
+.BI " struct nvmf_disc_log_entry entries[];"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "genctr" 12
+Generation Counter (GENCTR): Indicates the version of the discovery
+information, starting at a value of 0h. For each change in the
+Discovery Log Page, this counter is incremented by one. If the value
+of this field is FFFFFFFF_FFFFFFFFh, then the field shall be cleared
+to 0h when incremented (i.e., rolls over to 0h).
+.IP "numrec" 12
+Number of Records (NUMREC): Indicates the number of records
+contained in the log.
+.IP "recfmt" 12
+Record Format (RECFMT): Specifies the format of the Discovery Log
+Page. If a new format is defined, this value is incremented by one.
+The format of the record specified in this definition shall be 0h.
+.IP "rsvd14" 12
+Reserved
+.IP "entries" 12
+Discovery Log Page Entries - see \fIstruct nvmf_disc_log_entry\fP.