Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-power / 38f8500414fe5c1be6f5159c563937289fe557c2
commit38f8500414fe5c1be6f5159c563937289fe557c2[log] [tgz]
authorShawn McCarney <shawnmm@us.ibm.com>Fri Oct 31 17:59:36 2025 -0500
committerShawn McCarney <shawnmm@us.ibm.com>Tue Nov 18 13:33:00 2025 -0600
treee1e625fc3f33adb68671f35fa8618e2699d4c2d3
parent068f8073da127f5039d946e9e090390493f651fe [diff]
Create common json_parser_utils functions

Create a json_parser_utils namespace containing common functions for
parsing JSON.

Extract the common functions from the JSON parsing code in the
phosphor-regulators and phosphor-power-sequencer applications.
Both applications have some identical parsing functions.

Create a common ConfigFileParserError class. The phosphor-regulators and
phosphor-power-sequencer applications both have an identical version of
this exception class.

Extract the common test cases from the two applications and put them in
a common location as well.

Summary:
* Common JSON parsing functions in
  phosphor-power-sequencer/src/config_file_parser.* and
  phosphor-regulators/src/config_file_parser.* moved to
  json_parser_utils.*
* Common test cases in
  phosphor-power-sequencer/test/config_file_parser_tests.cpp and
  phosphor-regulators/test/config_file_parser_tests.cpp moved to
  test/json_parser_utils_tests.cpp
* phosphor-power-sequencer/src/config_file_parser_error.hpp and
  phosphor-regulators/src/config_file_parser_error.hpp replaced with
  config_file_parser_error.hpp
* phosphor-power-sequencer/test/config_file_parser_error_tests.cpp and
  phosphor-regulators/test/config_file_parser_error_tests.cpp replaced
  with test/config_file_parser_error_tests.cpp

Tested:
* Ran automated test cases.

Change-Id: I35074c5e42d9e89def41ba8e729fe11c54ed8d27
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
19 files changed
tree: e1e625fc3f33adb68671f35fa8618e2699d4c2d3
  1. cold-redundancy/
  2. example/
  3. org/
  4. phosphor-chassis-power/
  5. phosphor-power-sequencer/
  6. phosphor-power-supply/
  7. phosphor-regulators/
  8. power-sequencer/
  9. power-supply/
  10. services/
  11. subprojects/
  12. test/
  13. tools/
  14. .clang-format
  15. .clang-tidy
  16. .clang-tidy-ignore
  17. .gitignore
  18. .shellcheck
  19. compatible_system_types_finder.cpp
  20. compatible_system_types_finder.hpp
  21. config_file_parser_error.hpp
  22. dbus_interfaces_finder.cpp
  23. dbus_interfaces_finder.hpp
  24. device.hpp
  25. device_monitor.hpp
  26. elog-errors.hpp
  27. file_descriptor.hpp
  28. format_utils.hpp
  29. gpio.cpp
  30. gpio.hpp
  31. json_parser_utils.cpp
  32. json_parser_utils.hpp
  33. LICENSE
  34. meson.build
  35. meson.options
  36. names_values.hpp
  37. OWNERS
  38. pmbus.cpp
  39. pmbus.hpp
  40. README.md
  41. temporary_file.cpp
  42. temporary_file.hpp
  43. temporary_subdirectory.cpp
  44. temporary_subdirectory.hpp
  45. types.hpp
  46. utility.cpp
  47. 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-chassis-power: JSON-driven application that monitors chassis power on multi-chassis systems.
  • 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",
  }