summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_lba_status_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_get_lba_status_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_get_lba_status_args.2')
-rw-r--r--doc/man/nvme_get_lba_status_args.252
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/man/nvme_get_lba_status_args.2 b/doc/man/nvme_get_lba_status_args.2
new file mode 100644
index 0000000..f12ab36
--- /dev/null
+++ b/doc/man/nvme_get_lba_status_args.2
@@ -0,0 +1,52 @@
+.TH "libnvme" 9 "struct nvme_get_lba_status_args" "April 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_get_lba_status_args \- Arguments for the NVMe Get LBA Status command
+.SH SYNOPSIS
+struct nvme_get_lba_status_args {
+.br
+.BI " __u64 slba;"
+.br
+.BI " __u32 *result;"
+.br
+.BI " struct nvme_lba_status *lbas;"
+.br
+.BI " int args_size;"
+.br
+.BI " int fd;"
+.br
+.BI " __u32 timeout;"
+.br
+.BI " __u32 nsid;"
+.br
+.BI " __u32 mndw;"
+.br
+.BI " enum nvme_lba_status_atype atype;"
+.br
+.BI " __u16 rl;"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "slba" 12
+Starting logical block address to check statuses
+.IP "result" 12
+The command completion result from CQE dword0
+.IP "lbas" 12
+Data payload to return status descriptors
+.IP "args_size" 12
+Size of \fIstruct nvme_get_lba_status_args\fP
+.IP "fd" 12
+File descriptor of nvme device
+.IP "timeout" 12
+Timeout in ms
+.IP "nsid" 12
+Namespace ID to retrieve LBA status
+.IP "mndw" 12
+Maximum number of dwords to return
+.IP "atype" 12
+Action type mechanism to determine LBA status desctriptors to
+return, see \fIenum nvme_lba_status_atype\fP
+.IP "rl" 12
+Range length from slba to perform the action