summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_get_feature_length.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_get_feature_length.2')
-rw-r--r--doc/man/nvme_get_feature_length.219
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/man/nvme_get_feature_length.2 b/doc/man/nvme_get_feature_length.2
new file mode 100644
index 0000000..c8f66a0
--- /dev/null
+++ b/doc/man/nvme_get_feature_length.2
@@ -0,0 +1,19 @@
+.TH "nvme_get_feature_length" 9 "nvme_get_feature_length" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_get_feature_length \- Retreive the command payload length for a specific feature identifier
+.SH SYNOPSIS
+.B "int" nvme_get_feature_length
+.BI "(int fid " ","
+.BI "__u32 cdw11 " ","
+.BI "__u32 *len " ");"
+.SH ARGUMENTS
+.IP "fid" 12
+Feature identifier, see \fIenum nvme_features_id\fP.
+.IP "cdw11" 12
+The cdw11 value may affect the transfer (only known fid is
+NVME_FEAT_FID_HOST_ID)
+.IP "len" 12
+On success, set to this features payload length in bytes.
+.SH "RETURN"
+0 on success, -1 with errno set to EINVAL if the function did not
+recognize \fIfid\fP.