ipmctl-update-firmware - Man Page

Updates the firmware on one or more PMem modules

Synopsis

ipmctl load [OPTIONS] -source (path) -dimm [TARGETS]

Description

Updates the firmware on one or more PMem modules. On the next power cycle, the firmware will become active.

Note

If Address Range Scrub (ARS) is in progress on any target PMem module, an attempt will be made to abort ARS and then proceed with the firmware update.

Note

A power cycle reboot is required to activate the updated firmware image and is recommended to ensure ARS runs to completion.

Options

-x, -examine

Verifies the target PMem modules are compatible and ready to receive the firmware image specified in the source option. Returns the firmware image version.

-f, -force

Downgrading the firmware to an older version is a potentially destructive operation which requires confirmation from the user for each PMem module. This option suppresses the confirmation when attempting to downgrade.

-h, -help

Displays help for the command.

-ddrt

Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.

-smbus

Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
Note

The -ddrt and -smbus options are mutually exclusive and may not be used together.

-lpmb

Used to specify large transport payload size for the current invocation of ipmctl.

-spmb

Used to specify small transport payload size for the current invocation of ipmctl.
Note

The -lpmb and -spmb options are mutually exclusive and may not be used together.

-source

Specifies the firmware image binary to upload to the PMem module.

-recover

--DEPRECATED--
This flag is no longer necessary to run firmware update on PMem modules where the DDRT link is not trained. These untrained PMem modules are now automatically included when the command is run without the -recover option.. However, this flag is still maintained for backwards compatibility.

-o (text|nvmxml), -output (text|nvmxml)

Changes the output format. One of: "text" (default) or "nvmxml".

Targets

-dimm [DimmIDs]

Updates the firmware on specific PMem modules by supplying one or more comma separated PMem module identifiers. However, this is not recommended as it may put the system in an undesirable state. The default is to update all manageable PMem modules.

Examples

Updates the firmware on all PMem modules in the system to the image in sourcefile.bin on the next power cycle.

ipmctl load -source sourcefile.bin -dimm

Checks the firmware image in sourcefile.bin and retrieves the version.

ipmctl load -examine -source sourcefile.bin -dimm

Limitations

In order to successfully execute this command:

Firmware version (PN.RN.SV.bbbb) updates are supported as follows:

Note

Once a firmware image is staged for execution, a power cycle is required before another firmware image of the same type (production or debug) can be staged for execution using this command.

Return Data

When the examine option is provided, the firmware image is checked and the version number and firmware type is provided. The firmware will either be valid for the PMem module, a downgrade or invalid meaning it cannot be used for that PMem module.

Sample Output

(file path): MM.mm.hh.bbbb
Load FW on PMem module (DimmID): (Valid|Downgrade) [(with
confirmation or the force option)]

If the firmware is being downgraded and the force option is not provided, the user will be prompted to confirm the downgrade for each PMem module. Otherwise, for each PMem module, the CLI will indicate the status of the operation.

Downgrade firmware on PMem module (DimmID)? (y or [n]) Downgrade firmware
on PMem module (DimmID)? (y or [n])

If a failure occurs when updating multiple PMem modules, the process will continue attempting to update the remaining PMem modules requested. The firmware will not become active until the next power cycle. Use the command Section [Show Device Firmware] to view more detailed information about the active and staged firmware.

Load FW on PMem module (DimmID): Success, a power cycle is required to
activate the FW.
Load FW on PMem module (DimmID): Error (Code) - (Description)

Referenced By

ipmctl(1).

2020-10-15 ipmctl