summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_set_features_args.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_set_features_args.2')
-rw-r--r--doc/man/nvme_set_features_args.265
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/man/nvme_set_features_args.2 b/doc/man/nvme_set_features_args.2
new file mode 100644
index 0000000..9c15083
--- /dev/null
+++ b/doc/man/nvme_set_features_args.2
@@ -0,0 +1,65 @@
+.TH "libnvme" 9 "struct nvme_set_features_args" "April 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_set_features_args \- Arguments for the NVMe Admin Set Feature command
+.SH SYNOPSIS
+struct nvme_set_features_args {
+.br
+.BI " __u32 *result;"
+.br
+.BI " void *data;"
+.br
+.BI " int args_size;"
+.br
+.BI " int fd;"
+.br
+.BI " __u32 timeout;"
+.br
+.BI " __u32 nsid;"
+.br
+.BI " __u32 cdw11;"
+.br
+.BI " __u32 cdw12;"
+.br
+.BI " __u32 cdw13;"
+.br
+.BI " __u32 cdw15;"
+.br
+.BI " __u32 data_len;"
+.br
+.BI " bool save;"
+.br
+.BI " __u8 uuidx;"
+.br
+.BI " __u8 fid;"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "result" 12
+The command completion result from CQE dword0
+.IP "data" 12
+User address of feature data, if applicable
+.IP "args_size" 12
+Size of \fIstruct nvme_set_features_args\fP
+.IP "fd" 12
+File descriptor of nvme device
+.IP "timeout" 12
+Timeout in ms
+.IP "nsid" 12
+Namespace ID, if applicable
+.IP "cdw11" 12
+Value to set the feature to
+.IP "cdw12" 12
+Feature specific command dword12 field
+.IP "cdw15" 12
+Feature specific command dword15 field
+.IP "data_len" 12
+Length of feature data, if applicable, in bytes
+.IP "save" 12
+Save value across power states
+.IP "uuidx" 12
+UUID Index for differentiating vendor specific encoding
+.IP "fid" 12
+Feature identifier