1NVME-FW-DOWNLOAD(1)               NVMe Manual              NVME-FW-DOWNLOAD(1)
2
3
4

NAME

6       nvme-fw-download - Download all or a portion of an nvme firmware image.
7

SYNOPSIS

9       nvme fw-download <device> [--fw=<firmware-file> | -f <firmware-file>]
10                           [--xfer=<transfer-size> | -x <transfer-size>]
11                           [--offset=<offset> | -o <offset>]
12

DESCRIPTION

14       The Firmware Image Download command is used to download all or a
15       portion of the firmware image for a future update to the controller.
16       The Firmware Image Download command may be submitted while other
17       commands on the Admin Submission Queue or I/O Submission Queues are
18       outstanding. The Firmware Image Download command copies the new
19       firmware image (in whole or in part) to the controller.
20
21       The firmware image may be constructed of multiple pieces that are
22       individually downloaded with separate Firmware Image Download commands.
23       Each Firmware Image Download command includes a Dword Offset and Number
24       of Dwords that specify a Dword range. The host software shall ensure
25       that firmware pieces do not have Dword ranges that overlap. Firmware
26       portions may be submitted out of order to the controller.
27
28       The new firmware image is not applied as part of the Firmware Image
29       Download command. It is applied following a reset, where the image to
30       apply and the firmware slot it should be committed to is specified with
31       the Firmware Commit command (nvme fw-commit <args>).
32

OPTIONS

34       -f <firmware-file>, --fw=<firmware-file>
35           Required argument. This specifies the path to the device’s firmware
36           file on your system that will be read by the program and sent to
37           the device.
38
39       -x <transfer-size>, --xfer=<transfer-size>
40           This specifies the size to split each transfer. This is useful if
41           the device has a max transfer size requirement for firmware. It
42           defaults to 4k.
43
44       -o <offset>, --offset=<offset>
45           This specifies the starting offset in dwords. This is really only
46           useful if your firmware is split in multiple files; otherwise the
47           offset starts at zero and automatically adjusts based on the xfer
48           size given.
49

EXAMPLES

51       •   Transfer a firmware size 128KiB at a time:
52
53               # nvme fw-download /dev/nvme0 --fw=/path/to/nvme.fw --xfer=0x20000
54

NVME

56       Part of the nvme-user suite
57
58
59
60NVMe                              09/29/2023               NVME-FW-DOWNLOAD(1)