Debian Codegraph @

doc/man/nvme_mi_admin_fw_download.2

raw
1 .TH "nvme_mi_admin_fw_download" 9 "nvme_mi_admin_fw_download" "November 2025" "libnvme API manual" LINUX
2 .SH NAME
3 nvme_mi_admin_fw_download \- Download part or all of a firmware image to the controller
4 .SH SYNOPSIS
5 .B "int" nvme_mi_admin_fw_download
6 .BI "(nvme_mi_ctrl_t ctrl " ","
7 .BI "struct nvme_fw_download_args *args " ");"
8 .SH ARGUMENTS
9 .IP "ctrl" 12
10 Controller to send firmware data to
11 .IP "args" 12
12 \fIstruct nvme_fw_download_args\fP argument structure
13 .SH "DESCRIPTION"
14 The Firmware Image Download command downloads all or a portion of an image
15 for a future update to the controller. The Firmware Image Download command
16 downloads a new image (in whole or in part) to the controller.
17
18 The image may be constructed of multiple pieces that are individually
19 downloaded with separate Firmware Image Download commands. Each Firmware
20 Image Download command includes a Dword Offset and Number of Dwords that
21 specify a dword range.
22
23 The new firmware image is not activated as part of the Firmware Image
24 Download command. Use the \fBnvme_mi_admin_fw_commit\fP to activate a newly
25 downloaded image.
26 .SH "RETURN"
27 0 on success, non-zero on failure