summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_resv_register_args.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_resv_register_args.2')
-rw-r--r--doc/man/nvme_resv_register_args.252
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/man/nvme_resv_register_args.2 b/doc/man/nvme_resv_register_args.2
new file mode 100644
index 0000000..5654c8d
--- /dev/null
+++ b/doc/man/nvme_resv_register_args.2
@@ -0,0 +1,52 @@
+.TH "libnvme" 9 "struct nvme_resv_register_args" "April 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_resv_register_args \- Arguments for the NVMe Reservation Register command
+.SH SYNOPSIS
+struct nvme_resv_register_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_rrega rrega;"
+.br
+.BI " enum nvme_resv_cptpl cptpl;"
+.br
+.BI " bool iekey;"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "crkey" 12
+The current reservation key associated with the host
+.IP "nrkey" 12
+The new reservation key to be register if action is register or
+replace
+.IP "result" 12
+The command completion result from CQE dword0
+.IP "args_size" 12
+Size of \fIstruct nvme_resv_register_args\fP
+.IP "fd" 12
+File descriptor of nvme device
+.IP "timeout" 12
+Timeout in ms
+.IP "nsid" 12
+Namespace identifier
+.IP "rrega" 12
+The registration action, see \fIenum nvme_resv_rrega\fP
+.IP "cptpl" 12
+Change persist through power loss, see \fIenum nvme_resv_cptpl\fP
+.IP "iekey" 12
+Set to ignore the existing key