summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_identify_nvmset_list.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_identify_nvmset_list.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_identify_nvmset_list.2')
-rw-r--r--doc/man/nvme_identify_nvmset_list.225
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/man/nvme_identify_nvmset_list.2 b/doc/man/nvme_identify_nvmset_list.2
new file mode 100644
index 0000000..98b368a
--- /dev/null
+++ b/doc/man/nvme_identify_nvmset_list.2
@@ -0,0 +1,25 @@
+.TH "nvme_identify_nvmset_list" 9 "nvme_identify_nvmset_list" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_identify_nvmset_list \- Retrieves NVM Set List
+.SH SYNOPSIS
+.B "int" nvme_identify_nvmset_list
+.BI "(int fd " ","
+.BI "__u16 nvmsetid " ","
+.BI "struct nvme_id_nvmset_list *nvmset " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "nvmsetid" 12
+NVM Set Identifier
+.IP "nvmset" 12
+User space destination address to transfer the data
+.SH "DESCRIPTION"
+Retrieves an NVM Set List, \fIstruct nvme_id_nvmset_list\fP. The data structure
+is an ordered list by NVM Set Identifier, starting with the first NVM Set
+Identifier supported by the NVM subsystem that is equal to or greater than
+the NVM Set Identifier.
+
+See \fIstruct nvme_id_nvmset_list\fP for the defintion of the returned structure.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.