1IPMCTL-UPDATE-FIRMWARE(1) ipmctl IPMCTL-UPDATE-FIRMWARE(1)
2
6 ipmctl-update-firmware - Updates the firmware on one or more PMem
7 modules
8
10 ipmctl load [OPTIONS] -source (path) -dimm [TARGETS]
11
13 Updates the firmware on one or more PMem modules. On the next power
14 cycle, the firmware will become active.
15 Note
17 If Address Range Scrub (ARS) is in progress on any target PMem
18 module, an attempt will be made to abort ARS and then proceed with
19 the firmware update.
20 Note
22 A power cycle reboot is required to activate the updated firmware
23 image and is recommended to ensure ARS runs to completion.
24
26 -x, -examine
27 Verifies the target PMem modules are compatible and ready to
28 receive the firmware image specified in the source option. Returns
29 the firmware image version.
30 -f, -force
32 Downgrading the firmware to an older version is a potentially
33 destructive operation which requires confirmation from the user for
34 each PMem module. This option suppresses the confirmation when
35 attempting to downgrade.
36 -h, -help
38 Displays help for the command.
39 -ddrt
41 Used to specify DDRT as the desired transport protocol for the
42 current invocation of ipmctl.
43 -smbus
45 Used to specify SMBUS as the desired transport protocol for the
46 current invocation of ipmctl.
47 Note
49 The -ddrt and -smbus options are mutually exclusive and may not be
50 used together.
51 -lpmb
53 Used to specify large transport payload size for the current
54 invocation of ipmctl.
55 -spmb
57 Used to specify small transport payload size for the current
58 invocation of ipmctl.
59 Note
61 The -lpmb and -spmb options are mutually exclusive and may not be
62 used together.
63 -source
65 Specifies the firmware image binary to upload to the PMem module.
66 -recover
68 --DEPRECATED--
69 This flag is no longer necessary to run firmware update on PMem
70 modules where the DDRT link is not trained. These untrained PMem
71 modules are now automatically included when the command is run
72 without the -recover option.. However, this flag is still
73 maintained for backwards compatibility.
74 -o (text|nvmxml), -output (text|nvmxml)
76 Changes the output format. One of: "text" (default) or "nvmxml".
77
79 -dimm [DimmIDs]
80 Updates the firmware on specific PMem modules by supplying one or
81 more comma separated PMem module identifiers. However, this is not
82 recommended as it may put the system in an undesirable state. The
83 default is to update all manageable PMem modules.
84
86 Updates the firmware on all PMem modules in the system to the image in
87 sourcefile.bin on the next power cycle.
88 ipmctl load -source sourcefile.bin -dimm
90 Checks the firmware image in sourcefile.bin and retrieves the version.
92 ipmctl load -examine -source sourcefile.bin -dimm
94
96 In order to successfully execute this command:
97 • The caller must have the appropriate privileges.
99 • The specified PMem modules must be manageable by the host software.
101 Firmware version (PN.RN.SV.bbbb) updates are supported as follows:
103 • The product number (PN) cannot be changed.
105 • The revision number (RN) can be upgraded when PN is the same.
107 • The security revision number (SV) can be upgraded when PN.RN is the
109 same. In some configurations it can also be downgraded when PN.RN
110 is the same; use the examine option to determine if the security
111 revision number can be downgraded.
112 • The build number (bbbb) can be upgraded or downgraded. However, if
114 the firmware API version in the firmware image is lower than is
115 supported by the host software and would make the PMem module
116 become unmanageable, the downgrade is not supported.
117 Note
119 Once a firmware image is staged for execution, a power cycle is
120 required before another firmware image of the same type (production
121 or debug) can be staged for execution using this command.
122
124 When the examine option is provided, the firmware image is checked and
125 the version number and firmware type is provided. The firmware will
126 either be valid for the PMem module, a downgrade or invalid meaning it
127 cannot be used for that PMem module.
128
130 (file path): MM.mm.hh.bbbb
131 Load FW on PMem module (DimmID): (Valid|Downgrade) [(with
132 confirmation or the force option)]
133 If the firmware is being downgraded and the force option is not
135 provided, the user will be prompted to confirm the downgrade for each
136 PMem module. Otherwise, for each PMem module, the CLI will indicate the
137 status of the operation.
138 Downgrade firmware on PMem module (DimmID)? (y or [n]) Downgrade firmware
140 on PMem module (DimmID)? (y or [n])
141 If a failure occurs when updating multiple PMem modules, the process
143 will continue attempting to update the remaining PMem modules
144 requested. The firmware will not become active until the next power
145 cycle. Use the command Section [Show Device Firmware] to view more
146 detailed information about the active and staged firmware.
147 Load FW on PMem module (DimmID): Success, a power cycle is required to
149 activate the FW.
150 Load FW on PMem module (DimmID): Error (Code) - (Description)
152ipmctl 2021-05-13 IPMCTL-UPDATE-FIRMWARE(1)