diff options
Diffstat (limited to 'doc/man/nvme_mi_admin_get_features_data.2')
-rw-r--r-- | doc/man/nvme_mi_admin_get_features_data.2 | 30 |
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..07ecbf4 --- /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" "January 2023" "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. |