1IPMCTL-LOAD-DIMM(1)                 ipmctl                 IPMCTL-LOAD-DIMM(1)
2
3
4

NAME

6       ipmctl-load-dimm - Updates the firmware on one or more PMem modules
7

SYNOPSIS

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

DESCRIPTION

12       Updates the firmware on one or more PMem modules. On the next power
13       cycle, the firmware will become active.
14
15           Note
16           If Address Range Scrub (ARS) is in progress on any target PMem
17           module, an attempt will be made to abort ARS and then proceed with
18           the firmware update.
19
20           Note
21           A power cycle reboot is required to activate the updated firmware
22           image and is recommended to ensure ARS runs to completion.
23

OPTIONS

25       -x, -examine
26           Verifies the target PMem modules are compatible and ready to
27           receive the firmware image specified in the source option. Returns
28           the firmware image version.
29
30       -f, -force
31           Downgrading the firmware to an older version is a potentially
32           destructive operation which requires confirmation from the user for
33           each PMem module. This option suppresses the confirmation when
34           attempting to downgrade.
35
36       -h, -help
37           Displays help for the command.
38
39       -ddrt
40           Used to specify DDRT as the desired transport protocol for the
41           current invocation of ipmctl.
42
43       -smbus
44           Used to specify SMBUS as the desired transport protocol for the
45           current invocation of ipmctl.
46
47           Note
48           The -ddrt and -smbus options are mutually exclusive and may not be
49           used together.
50
51       -lpmb
52           Used to specify large transport payload size for the current
53           invocation of ipmctl.
54
55       -spmb
56           Used to specify small transport payload size for the current
57           invocation of ipmctl.
58
59           Note
60           The -lpmb and -spmb options are mutually exclusive and may not be
61           used together.
62
63       -source
64           Specifies the firmware image binary to upload to the PMem module.
65
66       -recover
67           --DEPRECATED--
68           This flag is no longer necessary to run firmware update on PMem
69           modules where the DDRT link is not trained. These untrained PMem
70           modules are now automatically included when the command is run
71           without the -recover option.. However, this flag is still
72           maintained for backwards compatibility.
73
74       -o (text|nvmxml), -output (text|nvmxml)
75           Changes the output format. One of: "text" (default) or "nvmxml".
76

TARGETS

78       -dimm [DimmIDs]
79           Updates the firmware on specific PMem modules by supplying one or
80           more comma separated PMem module identifiers. However, this is not
81           recommended as it may put the system in an undesirable state. The
82           default is to update all manageable PMem modules.
83

EXAMPLES

85       Updates the firmware on all PMem modules in the system to the image in
86       sourcefile.bin on the next power cycle.
87
88           ipmctl load -source sourcefile.bin -dimm
89
90       Checks the firmware image in sourcefile.bin and retrieves the version.
91
92           ipmctl load -examine -source sourcefile.bin -dimm
93

LIMITATIONS

95       In order to successfully execute this command:
96
97       •   The caller must have the appropriate privileges.
98
99       •   The specified PMem modules must be manageable by the host software.
100
101       Firmware version (PN.RN.SV.bbbb) updates are supported as follows:
102
103       •   The product number (PN) cannot be changed.
104
105       •   The revision number (RN) can be upgraded when PN is the same.
106
107       •   The security revision number (SV) can be upgraded when PN.RN is the
108           same. In some configurations it can also be downgraded when PN.RN
109           is the same; use the examine option to determine if the security
110           revision number can be downgraded.
111
112       •   The build number (bbbb) can be upgraded or downgraded. However, if
113           the firmware API version in the firmware image is lower than is
114           supported by the host software and would make the PMem module
115           become unmanageable, the downgrade is not supported.
116
117           Note
118           Once a firmware image is staged for execution, a power cycle is
119           required before another firmware image of the same type (production
120           or debug) can be staged for execution using this command.
121

RETURN DATA

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

SAMPLE OUTPUT

129           (file path): MM.mm.hh.bbbb
130           Load FW on PMem module (DimmID): (Valid|Downgrade) [(with
131           confirmation or the force option)]
132
133       If the firmware is being downgraded and the force option is not
134       provided, the user will be prompted to confirm the downgrade for each
135       PMem module. Otherwise, for each PMem module, the CLI will indicate the
136       status of the operation.
137
138           Downgrade firmware on PMem module (DimmID)? (y or [n]) Downgrade firmware
139           on PMem module (DimmID)? (y or [n])
140
141       If a failure occurs when updating multiple PMem modules, the process
142       will continue attempting to update the remaining PMem modules
143       requested. The firmware will not become active until the next power
144       cycle. Use the command Section [Show Firmware] to view more detailed
145       information about the active and staged firmware.
146
147           Load FW on PMem module (DimmID): Success, a power cycle is required to
148           activate the FW.
149
150           Load FW on PMem module (DimmID): Error (Code) - (Description)
151
152
153
154ipmctl                            2023-07-20               IPMCTL-LOAD-DIMM(1)
Impressum