openbmc/phosphor-psu-code-mgmt/README.md

1 # phosphor-psu-code-mgmt
3 phosphor-psu-code-mgmt is a service to provide management for PSU code,
6 - PSU code version
7 - PSU code update
29 This repo contains generic code to handle the PSU versions and updates. It
30 depends on vendor-specific tools to provide the below functions on the real PSU
33 - Get PSU firmware version
34 - Get PSU model
36 - Update the PSU firmware
41   the PSU inventory path as input, and outputs the PSU version string to stdout.
43   PSU inventory path as input, and outputs the PSU model string to stdout.
45   accepts one or more PSU version strings, and outputs the latest version string
49   - The PSU inventory DBus object;
50   - The path of the PSU image(s).
59     '-DPSU_UPDATE_SERVICE=psu-update@.service' \
64 [phosphor-power][3] to get the PSU version and model, compare PSU versions, and
65 use `psu-update@.service` to perform the PSU firmware update, where internally
70 ### PSU version
72 When the service starts, it queries the inventory to get all the PSU inventory
74 objects under `/xyz/openbmc_project/software` that are associated with the PSU
75 inventory path. If multiple PSUs are using the same version, multiple PSU
94      "Purpose": "xyz.openbmc_project.Software.Version.VersionPurpose.PSU",
109      "Purpose": "xyz.openbmc_project.Software.Version.VersionPurpose.PSU",
134      "Purpose": "xyz.openbmc_project.Software.Version.VersionPurpose.PSU",
140 ### PSU update
142 1. Generate a tarball of PSU firmware image by [generate-psu-tar tool][4].
145    ./generate-psu-tar --image <psu-image> --version <version> --model <model> --manufacturer \
146    <manufacturer> --machineName <machineName> --outfile <psu.tar> --sign
149 2. To update the PSU firmware, follow the same steps as described in
151    - Upload a PSU image tarball and get the version ID;
154 3. After a successful update, the PSU image and the manifest is stored in BMC's
155    persistent storage defined by `IMG_DIR_PERSIST`. When a PSU is replaced, the
156    PSU's firmware version will be checked and updated if it's older than the one
158 4. It is possible to put a PSU image and MANIFEST in the built-in OpenBMC image
161    PSUs. If there is any PSU that has older firmware, it will be updated to the
169   https://github.com/openbmc/phosphor-psu-code-mgmt/blob/master/tools/generate-psu-tar