summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_set_features_data.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_set_features_data.2')
-rw-r--r--doc/man/nvme_set_features_data.233
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/man/nvme_set_features_data.2 b/doc/man/nvme_set_features_data.2
new file mode 100644
index 0000000..ec7e399
--- /dev/null
+++ b/doc/man/nvme_set_features_data.2
@@ -0,0 +1,33 @@
+.TH "nvme_set_features_data" 9 "nvme_set_features_data" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_set_features_data \- Helper function for @nvme_set_features()
+.SH SYNOPSIS
+.B "int" nvme_set_features_data
+.BI "(int fd " ","
+.BI "__u8 fid " ","
+.BI "__u32 nsid " ","
+.BI "__u32 cdw11 " ","
+.BI "bool save " ","
+.BI "__u32 data_len " ","
+.BI "void *data " ","
+.BI "__u32 *result " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "fid" 12
+Feature identifier
+.IP "nsid" 12
+Namespace ID, if applicable
+.IP "cdw11" 12
+Value to set the feature to
+.IP "save" 12
+Save value across power states
+.IP "data_len" 12
+Length of feature data, if applicable, in bytes
+.IP "data" 12
+User address of feature data, if applicable
+.IP "result" 12
+The command completion result from CQE dword0
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.