Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-power / 5a582d3c7a6865eaa0d80f0dc6aeb85b2f72c2a8
commit5a582d3c7a6865eaa0d80f0dc6aeb85b2f72c2a8[log] [tgz]
authorFaisal Awada <faisal@us.ibm.com>Fri Nov 15 14:11:44 2024 -0600
committerFaisal Awada <faisal@us.ibm.com>Wed Nov 20 16:55:37 2024 -0600
tree03a6f5a0767ca35bd4748c6acbe7f702d164ca22
parent23dee383ca3a45889fbb4f7bbae65fe3325c5805 [diff]
psutils: Partial AEI Updater class

The AeiUpdater class within the aeiUpdater namespace, responsible for
updating AEI PSU firmware via I2C communication. The code focuses on
executing  various stages of the firmware update process,  ensuring each
step performed and validated correctly. The following partial functions
of the key component of the class:

doUpdate()
This method initiates the firmware update process. It checks and sets
the ISP (In-System Programming) mode using writeIspKey(),
writeIspMode(), and writeIspStatusReset().

writeIspKey()
Unlocks the ISP by writing a specific key to the KEY_REGISTER. Handles
exceptions for any I2C communication errors and logs the failure.

writeIspMode()
Sends a command to enter ISP mode and checks the status register.
Retries on failure, with a maximum retry limit. Checks the status
register to confirm the mode has been set.  Logs any I2C errors
encountered.

writeIspStatusReset()
Resets ISP status register, clearing any existing status flags. Verifies
the reset by reading the status register, retrying as needed. Logs any
I2C errors encountered.

Test:
Tested the function listed in the class on a system with AEI PSU:

- Validated the PSU ISP key was accepted and no error logged.
- Validated an error was logged when I used wrong key.
- Validated the PSU entered to ISP mode by reading back status register
  and confirmed the bit is set.
- Validated the PSU status reset by reading the back status register and
  confirmed the bit is set.

Change-Id: I1e8e594f088e7d66d8fc5b1723c4bd33b08bd3f8
Signed-off-by: Faisal Awada <faisal@us.ibm.com>
3 files changed
tree: 03a6f5a0767ca35bd4748c6acbe7f702d164ca22
  1. cold-redundancy/
  2. example/
  3. org/
  4. phosphor-power-sequencer/
  5. phosphor-power-supply/
  6. phosphor-regulators/
  7. power-sequencer/
  8. power-supply/
  9. services/
  10. subprojects/
  11. test/
  12. tools/
  13. .clang-format
  14. .gitignore
  15. .shellcheck
  16. compatible_system_types_finder.cpp
  17. compatible_system_types_finder.hpp
  18. dbus_interfaces_finder.cpp
  19. dbus_interfaces_finder.hpp
  20. device.hpp
  21. device_monitor.hpp
  22. elog-errors.hpp
  23. file_descriptor.hpp
  24. format_utils.hpp
  25. gpio.cpp
  26. gpio.hpp
  27. LICENSE
  28. meson.build
  29. meson.options
  30. names_values.hpp
  31. OWNERS
  32. pmbus.cpp
  33. pmbus.hpp
  34. README.md
  35. temporary_file.cpp
  36. temporary_file.hpp
  37. temporary_subdirectory.cpp
  38. temporary_subdirectory.hpp
  39. types.hpp
  40. utility.cpp
  41. utility.hpp
README.md

phosphor-power

Overview

This repository contains applications for configuring and monitoring devices that deliver power to the system.

Actively-maintained applications:

  • cold-redundancy: Application that makes power supplies work in Cold Redundancy mode and rotates them at intervals.
  • phosphor-power-sequencer: JSON-driven application that powers the chassis on/off and monitors the power sequencer device.
  • phosphor-power-supply: Next generation power supply monitoring application.
  • phosphor-regulators: JSON-driven application that configures and monitors voltage regulators.
  • tools/power-utils: Power supply utilities.

Legacy applications:

  • power-sequencer: Original power sequencer monitoring application.
  • power-supply: Original power supply monitoring application.

Build

To build all applications in this repository:

  meson setup build
  ninja -C build

To clean the repository and remove all build output:

  rm -rf build

You can specify meson options to customize the build process. For example, you can specify:

  • Which applications to build and install.
  • Application-specific configuration data, such as power sequencer type.
  • Whether to build tests.

Power Supply Monitor and Util JSON config

Several applications in this repository require a PSU JSON config to run. The JSON config file provides information for:

  • Where to access the pmbus attributes
  • Which attribute file in pmbus maps to which property and interface in D-Bus
  • Which kernel device directory is used on which PSU

There is an example psu.json to describe the necessary configurations.

  • inventoryPMBusAccessType defines the pmbus access type, which tells the service which sysfs type to use to read the attributes. The possible values are:

    • Base: The base dir, e.g. /sys/bus/i2c/devices/3-0069/
    • Hwmon: The hwmon dir, e.g. /sys/bus/i2c/devices/3-0069/hwmon/hwmonX/
    • Debug: The pmbus debug dir, e.g. /sys/kernel/debug/pmbus/hwmonX/
    • DeviceDebug: The device debug dir, e.g. /sys/kernel/debug/<driver>.<instance>/
    • HwmonDeviceDebug: The hwmon device debug dir, e.g. /sys/kernel/debug/pmbus/hwmonX/cffps1/

  • fruConfigs defines the mapping between the attribute file and the FRU inventory interface and property. The configuration example below indicates that the service will read part_number attribute file from a directory specified by the above pmbus access type, and assign to PartNumber property in xyz.openbmc_project.Inventory.Decorator.Asset interface.

      "fruConfigs": [
    {
      "propertyName": "PartNumber",
      "fileName": "part_number",
      "interface": "xyz.openbmc_project.Inventory.Decorator.Asset"
    }
  ]

  • psuDevices defines the kernel device dir for each PSU in inventory. The configuration example below indicates that powersupply0's device is located in /sys/bus/i2c/devices/3-0069.

      "psuDevices": {
    "/xyz/openbmc_project/inventory/system/chassis/motherboard/powersupply0" : "/sys/bus/i2c/devices/3-0069",
  }