diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:22:29 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-10 19:22:29 +0000 |
commit | 068a45420f2c98887e220b45e946cc7074da550e (patch) | |
tree | c5b54e8b4b235232b057a9c534d9a16d2208463d /doc/man/nvme_mi_mi_read_mi_data_ctrl.2 | |
parent | Initial commit. (diff) | |
download | libnvme-068a45420f2c98887e220b45e946cc7074da550e.tar.xz libnvme-068a45420f2c98887e220b45e946cc7074da550e.zip |
Adding upstream version 1.8.upstream/1.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_mi_read_mi_data_ctrl.2')
-rw-r--r-- | doc/man/nvme_mi_mi_read_mi_data_ctrl.2 | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_mi_read_mi_data_ctrl.2 b/doc/man/nvme_mi_mi_read_mi_data_ctrl.2 new file mode 100644 index 0000000..36ee870 --- /dev/null +++ b/doc/man/nvme_mi_mi_read_mi_data_ctrl.2 @@ -0,0 +1,23 @@ +.TH "nvme_mi_mi_read_mi_data_ctrl" 9 "nvme_mi_mi_read_mi_data_ctrl" "February 2024" "libnvme API manual" LINUX +.SH NAME +nvme_mi_mi_read_mi_data_ctrl \- Perform a Read MI Data Structure command, retrieving controller information +.SH SYNOPSIS +.B "int" nvme_mi_mi_read_mi_data_ctrl +.BI "(nvme_mi_ep_t ep " "," +.BI "__u16 ctrl_id " "," +.BI "struct nvme_mi_read_ctrl_info *ctrl " ");" +.SH ARGUMENTS +.IP "ep" 12 +endpoint for MI communication +.IP "ctrl_id" 12 +ID of controller to query +.IP "ctrl" 12 +controller data to populate +.SH "DESCRIPTION" +Retrieves the Controller Information Data Structure for the attached +controller with ID \fIctrlid\fP. + +See \fIstruct nvme_mi_read_ctrl_info\fP. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise.. |