Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-power / e4fef0fcf29fb330527afd467b90b6c5dcc245ca
commite4fef0fcf29fb330527afd467b90b6c5dcc245ca[log] [tgz]
authorShawn McCarney <shawnmm@us.ibm.com>Fri Apr 05 17:56:09 2024 -0500
committerShawn McCarney <shawnmm@us.ibm.com>Mon Apr 08 19:15:23 2024 -0500
tree511a36c6e88e1ea5199921be0df8d3960002748e
parent2ae827a8d28dd586233036a4bc3a09320c82dd34 [diff]
pseq: Add presence caching to Services

Add caching of hardware presence data to the Services class in the
phosphor-power-sequencer application.  Obtaining hardware presence from
D-Bus is a slow operation.  During pgood fault isolation, multiple rails
may need the same hardware presence information.  Cache this information
to improve performance.

Provide a method to clear the cached data since it is only valid for a
short period of time.  For example, power supplies are hot-pluggable, so
their presence may change while a system is powered on.

Tested:
* BMCServices
  * createPMBus()
    * Verify correct sysfs path passed to PMBus constructor
  * isPresent()
    * Test where hardware is present
      * Test where value is not cached
        * Verify value is cached after data obtained from D-Bus
      * Test where value is cached
    * Test where hardware is not present
      * Test where value is not cached
        * Verify value is cached after data obtained from D-Bus
      * Test where value is cached
    * Test where D-Bus method call fails with an expected exception
      * Verify false is stored in cache
      * Verify false is returned
    * Test where D-Bus method call fails with an unexpected exception
      * Verify nothing is cached
      * Verify exception is re-thrown
  * clearCache()
    * Verify clears all cached data
* MockServices
  * Verify all methods can be called from an automated test
* Run existing automated tests

Change-Id: I3e92be3ded1ed333acbedc970409176cabe98c09
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
5 files changed
tree: 511a36c6e88e1ea5199921be0df8d3960002748e
  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. device.hpp
  17. device_monitor.hpp
  18. elog-errors.hpp
  19. file_descriptor.hpp
  20. gpio.cpp
  21. gpio.hpp
  22. LICENSE
  23. meson.build
  24. meson.options
  25. names_values.hpp
  26. OWNERS
  27. pmbus.cpp
  28. pmbus.hpp
  29. README.md
  30. temporary_file.cpp
  31. temporary_file.hpp
  32. types.hpp
  33. utility.cpp
  34. utility.hpp
README.md

Overview

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

  • cold-redundancy: Application that makes power supplies work in Cold Redundancy mode and rotates them at intervals.
  • phosphor-power-sequencer: Applications for configuring and monitoring power sequencer and related devices that support JSON-driven configuration.
  • phosphor-power-supply: Next generation power supply monitoring application.
  • phosphor-regulators: JSON-driven application that configures and monitors voltage regulators.
  • power-sequencer: A power sequencer monitoring application.
  • power-supply: Original power supply monitoring application.
  • tools/power-utils: Power supply utilities.

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/./`
    • 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",
  }