diff options
Diffstat (limited to 'doc/man/nvme_mi_mi_read_mi_data_port.2')
| -rw-r--r-- | doc/man/nvme_mi_mi_read_mi_data_port.2 | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_mi_read_mi_data_port.2 b/doc/man/nvme_mi_mi_read_mi_data_port.2 new file mode 100644 index 0000000..4a20637 --- /dev/null +++ b/doc/man/nvme_mi_mi_read_mi_data_port.2 @@ -0,0 +1,23 @@ +.TH "nvme_mi_mi_read_mi_data_port" 9 "nvme_mi_mi_read_mi_data_port" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_mi_read_mi_data_port \- Perform a Read MI Data Structure command, retrieving port data. +.SH SYNOPSIS +.B "int" nvme_mi_mi_read_mi_data_port +.BI "(nvme_mi_ep_t ep " "," +.BI "__u8 portid " "," +.BI "struct nvme_mi_read_port_info *p " ");" +.SH ARGUMENTS +.IP "ep" 12 +endpoint for MI communication +.IP "portid" 12 +id of port data to retrieve +.IP "p" 12 +port information to populate +.SH "DESCRIPTION" +Retrieves the Port information, for the specified port ID. The subsystem +data (from \fInvme_mi_mi_read_mi_data_subsys\fP) nmp field contains the allowed +range of port IDs. + +See \fIstruct nvme_mi_read_port_info\fP. +.SH "RETURN" +0 on success, non-zero on failure. |