summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_get_features_data.2
blob: fdde194e5c0e21757cbd0940b2c6b456a8f6b108 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
.TH "nvme_mi_admin_get_features_data" 9 "nvme_mi_admin_get_features_data" "February 2024" "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.