diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:17 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-11-05 18:17:17 +0000 |
commit | 0e75b5495117b9888b7a557fab1db40145a9a705 (patch) | |
tree | e294b5156b7a85197e4b3192b6fba291a26dd5c6 /doc/man/nvme_mi_admin_fw_download.2 | |
parent | Adding upstream version 1.1. (diff) | |
download | libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.tar.xz libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.zip |
Adding upstream version 1.2.upstream/1.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_admin_fw_download.2')
-rw-r--r-- | doc/man/nvme_mi_admin_fw_download.2 | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_fw_download.2 b/doc/man/nvme_mi_admin_fw_download.2 new file mode 100644 index 0000000..9faf329 --- /dev/null +++ b/doc/man/nvme_mi_admin_fw_download.2 @@ -0,0 +1,27 @@ +.TH "nvme_mi_admin_fw_download" 9 "nvme_mi_admin_fw_download" "October 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_fw_download \- Download part or all of a firmware image to the controller +.SH SYNOPSIS +.B "int" nvme_mi_admin_fw_download +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_fw_download_args *args " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to send firmware data to +.IP "args" 12 +\fIstruct nvme_fw_download_args\fP argument structure +.SH "DESCRIPTION" +The Firmware Image Download command downloads all or a portion of an image +for a future update to the controller. The Firmware Image Download command +downloads a new image (in whole or in part) to the controller. + +The image may be constructed of multiple pieces that are individually +downloaded with separate Firmware Image Download commands. Each Firmware +Image Download command includes a Dword Offset and Number of Dwords that +specify a dword range. + +The new firmware image is not activated as part of the Firmware Image +Download command. Use the \fBnvme_mi_admin_fw_commit\fP to activate a newly +downloaded image. +.SH "RETURN" +0 on success, non-zero on failure |