Adding upstream version 1.3.upstream/1.3upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 25 insertions, 0 deletions

diff --git a/doc/man/nvme_fw_download.2 b/doc/man/nvme_fw_download.2
new file mode 100644
index 0000000..c021d31
--- /dev/null
+++ b/doc/man/nvme_fw_download.2
@@ -0,0 +1,25 @@
+.TH "nvme_fw_download" 9 "nvme_fw_download" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_fw_download \- Download part or all of a firmware image to the controller
+.SH SYNOPSIS
+.B "int" nvme_fw_download
+.BI "(struct nvme_fw_download_args *args "  ");"
+.SH ARGUMENTS
+.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_fw_commit\fP to activate a newly downloaded
+image.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.