1NVME-FW-COMMIT(1) NVMe Manual NVME-FW-COMMIT(1)
2
6 nvme-fw-commit - Used to verify and commit a firmware image.
7
9 nvme fw-commit <device> [--slot=<slot> | -s <slot>]
10 [--action=<action> | -a <action>]
11 [--bpid=<boot-partid> | -b <boot-partid> ]
12
14 For the NVMe device given, send an nvme Firmware Commit admin command
15 and provides the results.
16 The Firmware Commit command is used to verify that a valid firmware
18 image has been downloaded and to commit that revision to a specific
19 firmware slot. The host may select the firmware image to commit on the
20 next controller reset (CC.EN transitions from ‘1’ to ‘0’, a PCI
21 function level reset, and/or other Controller or NVM Subsystem Reset)
22 as part of this command. The currently executing firmware revision may
23 be determined from the Firmware Revision field of the Identify
24 Controller data structure as indicated in the Firmware Slot Information
25 log page.
26 No further action is automatically taken to reset the device, which is
28 usually required to complete the activation process. If your kernel and
29 driver are recent enough, you can commit the firmware by issuing a
30 reset through Linux sysfs, for example:
31 # echo 1 > /sys/class/nvme/nvme0/device/reset
33 If your kernel is not recent enough, you will need to remove and add
35 the device some other way.
36
38 -a <action>, --action=<action>
39 Commit Action: This field specifies the action that is taken on the
40 image downloaded with the Firmware Image Download command or on a
41 previously downloaded and placed image.
42 ┌──────┬────────────────────────────┐
44 │Value │ Definition │
45 ├──────┼────────────────────────────┤
46 │0 │ Downloaded image replaces │
47 │ │ the image indicated by the │
48 │ │ Firmware Slot field. This │
49 │ │ image is not activated. │
50 ├──────┼────────────────────────────┤
51 │1 │ Downloaded image replaces │
52 │ │ the image indicated by the │
53 │ │ Firmware Slot field. This │
54 │ │ image is activated at the │
55 │ │ next reset. │
56 ├──────┼────────────────────────────┤
57 │2 │ The image indicated by the │
58 │ │ Firmware Slot field is │
59 │ │ activated at the next │
60 │ │ reset. │
61 ├──────┼────────────────────────────┤
62 │3 │ The image specified by the │
63 │ │ Firmware Slot field is │
64 │ │ requested to be activated │
65 │ │ immediately without reset. │
66 ├──────┼────────────────────────────┤
67 │6 │ Downloaded image replaces │
68 │ │ the Boot Partition │
69 │ │ specified by the Boot │
70 │ │ Partition ID field. │
71 ├──────┼────────────────────────────┤
72 │7 │ Mark the Boot Partition │
73 │ │ specified in the BPID │
74 │ │ field as active and update │
75 │ │ BPINFO.ABPID. │
76 └──────┴────────────────────────────┘
77 -s <slot>, --slot=<slot>
79 Firmware Slot: Specifies the firmware slot that shall be used for
80 the Commit Action, if applicable. If the value specified is 0h,
81 then the controller shall choose the firmware slot (slot 1 – 7) to
82 use for the operation.
83 --bpid=<boot-partid>, -b <boot-partid>
85 Specifies the Boot partition that shall be used for the Commit
86 Action, if applicable (default: 0)
87
89 • commit the last downloaded fw to slot 1.
90 # nvme fw-commit /dev/nvme0 --slot=1 --action=2
92
94 fw-activate
95
97 Part of the nvme-user suite
98NVMe 09/29/2023 NVME-FW-COMMIT(1)