summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_lookup_ctrl.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:22:29 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:22:29 +0000
commit068a45420f2c98887e220b45e946cc7074da550e (patch)
treec5b54e8b4b235232b057a9c534d9a16d2208463d /doc/man/nvme_lookup_ctrl.2
parentInitial commit. (diff)
downloadlibnvme-068a45420f2c98887e220b45e946cc7074da550e.tar.xz
libnvme-068a45420f2c98887e220b45e946cc7074da550e.zip
Adding upstream version 1.8.upstream/1.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_lookup_ctrl.2')
-rw-r--r--doc/man/nvme_lookup_ctrl.235
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/man/nvme_lookup_ctrl.2 b/doc/man/nvme_lookup_ctrl.2
new file mode 100644
index 0000000..d68e4da
--- /dev/null
+++ b/doc/man/nvme_lookup_ctrl.2
@@ -0,0 +1,35 @@
+.TH "nvme_lookup_ctrl" 9 "nvme_lookup_ctrl" "February 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_lookup_ctrl \- Lookup nvme_ctrl_t object
+.SH SYNOPSIS
+.B "nvme_ctrl_t" nvme_lookup_ctrl
+.BI "(nvme_subsystem_t s " ","
+.BI "const char *transport " ","
+.BI "const char *traddr " ","
+.BI "const char *host_traddr " ","
+.BI "const char *host_iface " ","
+.BI "const char *trsvcid " ","
+.BI "nvme_ctrl_t p " ");"
+.SH ARGUMENTS
+.IP "s" 12
+\fInvme_subsystem_t\fP object
+.IP "transport" 12
+Transport name
+.IP "traddr" 12
+Transport address
+.IP "host_traddr" 12
+Host transport address
+.IP "host_iface" 12
+Host interface name
+.IP "trsvcid" 12
+Transport service identifier
+.IP "p" 12
+Previous controller instance
+.SH "DESCRIPTION"
+Lookup a controller in \fIs\fP based on \fItransport\fP, \fItraddr\fP,
+\fIhost_traddr\fP, \fIhost_iface\fP, and \fItrsvcid\fP. \fItransport\fP must be specified,
+other fields may be required depending on the transport. A new
+object is created if none is found. If \fIp\fP is specified the lookup
+will start at \fIp\fP instead of the first controller.
+.SH "RETURN"
+Controller instance