Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-power / 80689db1ed2f4677bd3ea3fc3b74f26900bf44d9
commit80689db1ed2f4677bd3ea3fc3b74f26900bf44d9[log] [tgz]
authorShawn McCarney <shawnmm@us.ibm.com>Tue Sep 23 16:44:03 2025 -0500
committerShawn McCarney <shawnmm@us.ibm.com>Thu Sep 25 15:09:29 2025 -0500
treebf2f20f1196003929a04ff98aeb306ce53bbb63d
parent27ae70b8219cd292f3d8d9b3d5ff2a9ee18b1f37 [diff]
regs: Reorganize regulators documentation

Reorganize the existing phosphor-regulators application documentation.
Break the documentation into smaller files describing one topic.

This will make it easier to add new documentation describing the
upcoming changes for multiple chassis systems.

Most of the 'changes' in this commit are just text that has been moved
between files.

Change-Id: I096f1d396910987188fe1143f36bade61655e7d1
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
9 files changed
tree: bf2f20f1196003929a04ff98aeb306ce53bbb63d
  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. .clang-tidy
  15. .clang-tidy-ignore
  16. .gitignore
  17. .shellcheck
  18. compatible_system_types_finder.cpp
  19. compatible_system_types_finder.hpp
  20. dbus_interfaces_finder.cpp
  21. dbus_interfaces_finder.hpp
  22. device.hpp
  23. device_monitor.hpp
  24. elog-errors.hpp
  25. file_descriptor.hpp
  26. format_utils.hpp
  27. gpio.cpp
  28. gpio.hpp
  29. LICENSE
  30. meson.build
  31. meson.options
  32. names_values.hpp
  33. OWNERS
  34. pmbus.cpp
  35. pmbus.hpp
  36. README.md
  37. temporary_file.cpp
  38. temporary_file.hpp
  39. temporary_subdirectory.cpp
  40. temporary_subdirectory.hpp
  41. types.hpp
  42. utility.cpp
  43. 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",
  }