【NVMe2.0b 14-5】Firmware Download/Commit command

5.12Firmware Commit command

Be careful ： This command is on the 1.2 Before version NVM Express Base Specification revisions called “Firmware Activate”.

Firmware Commit The command is used to modify firmware image or Boot Partitions.

modify firmware image when ,Firmware Commit Command to verify that a valid... Has been downloaded firmware image And submit the modified version to the specific firmware slot. As part of this command , The host can choose firmware image So next time Controller Level Reset Activated when . The host can pass the check Figure 275 in Identify Controller data structure Medium Firmware Revision Field to determine the currently executing firmware version . The host can pass the check Firmware Slot Information log page To make sure that the next time Controller Level Reset Firmware version executed when .Domain All controllers in share firmware slot, And the same firmware image Apply to this domain All controllers in （NVM All controllers in the subsystem （ If multiple domains are not supported ） Or all controllers in the domain （ If multiple domains are supported ）） .

firmware image The activation of may result in unexpected controller behavior changes by the host （ for example ,UUID List Incompatible changes in （ Please refer to the first 8.25.2 section ））. under these circumstances , If Commit Action Field set to 011b, The controller shall abort the command , Status code for Firmware Activation Requires Conventional Reset.

modify Boot Partitions when , The host can choose Boot Partition Mark as active or replace .Boot Partition Only in unlock Write on （ Please refer to the first 8.2 section ）.

Firmware Commit Command to use Command Dword 10 Field . Keep all other command specific fields .

Figure 181: Firmware Commit – Command Dword 10

5.12.1Command Completion

complete Firmware Commit After the command , The controller publishes the completion queue entry to Admin Completion Queue, Indicates the status of the command .

For the specified next Controller Level Reset（ namely ,CA Field set to 001b or 010b） Activate new firmware image And the completion status code value is 0h Of Firmware Commit command , From the first 3.7.2 Section Controller Level Reset Will activate the specified firmware .

If the controller detects multiple firmware image and / or Boot Partition There are overlapping firmware/boot partition image update command sequences（ Reference resources 1.5.23） Or use multiple controllers and / or Management Endpoint Update single firmware image, And then Figure 182 As defined in , After completing the queue entry Dword 0 Report the results of this test in . Please refer to the first 3.11 Section and section 8.2.2 section .

Figure 182: Firmware Commit – Completion Queue Entry Dword 0

Firmware Commit Command specific status values in Figure 183 In the definition of .

Figure 183: Firmware Commit – Command Specific Status Values

5.13Firmware Image Download command

Firmware Image Download The command is used to download all or part of image, For future updates to the controller . When Admin Submission Queue or I/O Submission Queues When other commands on are not completed , May submit Firmware Image Download command .Firmware Image Download The command will be new image（ In whole or in part ） Download to controller .

image It can be composed of multiple segments , These fragments are separated by Firmware Image Download Command to download separately . Every Firmware Image Download Each command contains a Dword Offset and Number of Dwords, Used to designate a dword Range . The host software shall ensure that image There are no overlapped fragments Dword Range , also NUMD Fields and OFST The field satisfies FWUG Alignment and granularity requirements indicated in the fields （ See Figure 275）. The firmware may be submitted to the controller in disorder . to update Boot Partition when , The host software shall be submitted in sequence image part . If the range overlaps , The controller may return Overlapping Range error .

new firmware image Not as Firmware Image Download Part of the command activates . For more information about the firmware update process , Please refer to the first 3.11 section . The firmware update process does not modify Boot Partition The content of . of Boot Partition Details of the update process , Please refer to the first 8.2.2 section .

The host software should not be compatible with Boot Partitions and / or firmware image The update command sequence of overlaps （ Please refer to the first 3.11 Section and section 8.2.2 section ）.

download image after , The host software will download another image Issued before Firmware Commit Give orders . At the completion of Firmware Commit The first... Is processed after the command Firmware Image Download Command will cause the controller to discard the downloaded image All remaining parts （ If there is ）. If in firmware download and Firmware Commit Occurs between command completion Reset, The controller shall discard all image Download section （ If there is ）.

Firmware Image Download Command to use Data Pointer、Command Dword 10 and Command Dword 11 Field . Keep all other command specific fields .

Figure 184: Firmware Image Download – Data Pointer

Figure 185: Firmware Image Download – Command Dword 10

Figure 186: Firmware Image Download – Command Dword 11

5.13.1Command Completion

complete Firmware Image Download After the command , The controller publishes the completion queue entry to Admin Completion Queue.Firmware Image Download Command specific status values in Figure 187 In the definition of .

Figure 187: Firmware Image Download – Command Specific Status Values

If the controller detects multiple firmware image and / or Boot Partition There are overlapping firmware/boot partition image update command sequences（ Please refer to the first 1.5.23 section ） Or use multiple controllers and / or Management Endpoint Update single firmware image, Then you should complete the queue entry Dword 0 Report the results of this test in , Such as Figure 182 As defined in . Please refer to the first 3.11 Section and section 8.2.2 section .