summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_get_features_data.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-05 18:17:21 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-05 18:17:32 +0000
commitb0dc2feab3271dbcb42df6e6d8a37138a90c44a1 (patch)
treeae02f159c125f183b2adae47fdf0e64357bf76a8 /doc/man/nvme_mi_admin_get_features_data.2
parentReleasing debian version 1.1-2. (diff)
downloadlibnvme-b0dc2feab3271dbcb42df6e6d8a37138a90c44a1.tar.xz
libnvme-b0dc2feab3271dbcb42df6e6d8a37138a90c44a1.zip
Merging upstream version 1.2.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_admin_get_features_data.2')
-rw-r--r--doc/man/nvme_mi_admin_get_features_data.230
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_get_features_data.2 b/doc/man/nvme_mi_admin_get_features_data.2
new file mode 100644
index 0000000..4b57744
--- /dev/null
+++ b/doc/man/nvme_mi_admin_get_features_data.2
@@ -0,0 +1,30 @@
+.TH "nvme_mi_admin_get_features_data" 9 "nvme_mi_admin_get_features_data" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_features_data \- Helper function for &nvme_mi_admin_get_features()
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_features_data
+.BI "(nvme_mi_ctrl_t ctrl " ","
+.BI "enum nvme_features_id fid " ","
+.BI "__u32 nsid " ","
+.BI "__u32 data_len " ","
+.BI "void *data " ","
+.BI "__u32 *result " ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send command to
+.IP "fid" 12
+Feature identifier
+.IP "nsid" 12
+Namespace ID, if applicable for \fIfid\fP
+.IP "data_len" 12
+Length of feature data, if applicable for \fIfid\fP, in bytes
+.IP "data" 12
+User address of feature data, if applicable
+.IP "result" 12
+The command completion result from CQE dword0
+.SH "DESCRIPTION"
+Helper for optionally features that optionally return data, using the
+SEL_CURRENT selector value.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.