summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_resv_acquire_args.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_resv_acquire_args.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/nvme_resv_acquire_args.2')
-rw-r--r--doc/man/nvme_resv_acquire_args.252
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/man/nvme_resv_acquire_args.2 b/doc/man/nvme_resv_acquire_args.2
new file mode 100644
index 0000000..bbbda30
--- /dev/null
+++ b/doc/man/nvme_resv_acquire_args.2
@@ -0,0 +1,52 @@
+.TH "libnvme" 9 "struct nvme_resv_acquire_args" "April 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_resv_acquire_args \- Arguments for the NVMe Reservation Acquire Comand
+.SH SYNOPSIS
+struct nvme_resv_acquire_args {
+.br
+.BI " __u64 crkey;"
+.br
+.BI " __u64 nrkey;"
+.br
+.BI " __u32 *result;"
+.br
+.BI " int args_size;"
+.br
+.BI " int fd;"
+.br
+.BI " __u32 timeout;"
+.br
+.BI " __u32 nsid;"
+.br
+.BI " enum nvme_resv_rtype rtype;"
+.br
+.BI " enum nvme_resv_racqa racqa;"
+.br
+.BI " bool iekey;"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "crkey" 12
+The current reservation key associated with the host
+.IP "nrkey" 12
+The reservation key to be unregistered from the namespace if
+the action is preempt
+.IP "result" 12
+The command completion result from CQE dword0
+.IP "args_size" 12
+Size of \fIstruct nvme_resv_acquire_args\fP
+.IP "fd" 12
+File descriptor of nvme device
+.IP "timeout" 12
+Timeout in ms
+.IP "nsid" 12
+Namespace identifier
+.IP "rtype" 12
+The type of reservation to be create, see \fIenum nvme_resv_rtype\fP
+.IP "racqa" 12
+The action that is performed by the command, see \fIenum nvme_resv_racqa\fP
+.IP "iekey" 12
+Set to ignore the existing key