summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_init_dsm_range.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
commit2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_init_dsm_range.2
parentInitial commit. (diff)
downloadlibnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.tar.xz
libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.zip
Adding upstream version 1.3.upstream/1.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_init_dsm_range.2')
-rw-r--r--doc/man/nvme_init_dsm_range.227
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/man/nvme_init_dsm_range.2 b/doc/man/nvme_init_dsm_range.2
new file mode 100644
index 0000000..ff73816
--- /dev/null
+++ b/doc/man/nvme_init_dsm_range.2
@@ -0,0 +1,27 @@
+.TH "nvme_init_dsm_range" 9 "nvme_init_dsm_range" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_init_dsm_range \- Constructs a data set range structure
+.SH SYNOPSIS
+.B "void" nvme_init_dsm_range
+.BI "(struct nvme_dsm_range *dsm " ","
+.BI "__u32 *ctx_attrs " ","
+.BI "__u32 *llbas " ","
+.BI "__u64 *slbas " ","
+.BI "__u16 nr_ranges " ");"
+.SH ARGUMENTS
+.IP "dsm" 12
+DSM range array
+.IP "ctx_attrs" 12
+Array of context attributes
+.IP "llbas" 12
+Array of length in logical blocks
+.IP "slbas" 12
+Array of starting logical blocks
+.IP "nr_ranges" 12
+The size of the dsm arrays
+.SH "DESCRIPTION"
+Each array must be the same size of size 'nr_ranges'. This is intended to be
+used with constructing a payload for \fBnvme_dsm\fP.
+.SH "RETURN"
+The nvme command status if a response was received or -errno
+otherwise.