docs/designs/psu-firmware-update.md

1 # PSU firmware update
14 There is no support in OpenBMC to update the firmware for PSUs.
18 In OpenBMC, there is an existing interface for [software update][1].
20 The update process consists of:
26 Currently, BMC and BIOS firmware update are supported:
28 - [phosphor-bmc-code-mgmt][2] implements BMC code update, and it supports all
30 - [openpower-pnor-code-mgmt][3] implements BIOS code update, and it only
35 For PSU firmware update, it is preferred to re-use the same function for the
42 1. The user manually invokes the APIs to do the update;
43 2. After BMC code update and if there is a newer PSU image in the BMC's
44    filesystem, BMC shall update the PSU firmware;
46    filesystem, BMC shall update the PSU firmware.
47 4. An optional 'override' parameter may be specified to do the update in the
52 For some PSUs, it is risky to do PSU code update while the host is running to
71 - When a new version is updated together with BMC code update;
74 ### Update by API
76 This method is usually used by users who manually update PSU firmware.
86    - The PSU update image shall be a tarball that consists of a MANIFEST,
91    update the PSU firmware.
104      update. For example, if a vendor specific tool `foo` is configured in
105      `psu-update@foo.service` which executes `foo psu.bin`, the service will
106      find the `psu-update@foo.service` and start it by systemd, which performs
107      the update.
108    - When the PSU code update is completed, an informational event log shall be
110    - When the PSU code update is completed, the image, MANIFEST, and optionally
114    and after the PSU update, and return a status to the above service to
116 5. When the vendor-specific tool returns errors, the PSU update will be aborted
118 6. During the update, the service shall set the related sensors to
119    non-functional, and when the update is done, it shall set the related sensors
122 ### Update by new BMC image
129    update shall be performed.
134      location for the saved PSU images by API update. Both places shall be
137 3. If PSU update is needed, the service will find the matched vendor-specific
138    tool to perform the code update.
139 4. The following process will be the same as [Update by API].
141 ### Update on replaced PSU
154    code update.
155 4. The following process will be the same as [Update by API].
161 The PSU firmware update could be implemented by separated recipes that only call
163 provided by OpenBMC's existing [software update interface][1], and thus it will
164 become difficult to use a standard API to the PSU firmware update.
188 interfaces. The newly introduced PSU firmware update service will be a new
200 It requires the manual tests to verify the PSU code update process.
202 - Verify the PSU code update is done on all PSUs successfully;
203 - Verify the PSU code update will fail if the vendor-specific tool fails on
205 - Verify the PSU code update is performed after a new BMC image is updated
207 - Verify the PSU code update is performed after a PSU with old (or different, if