Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-power / 91090e41032e4f606df9aae44377f1b3c9a48e4f
commit91090e41032e4f606df9aae44377f1b3c9a48e4f[log] [tgz]
authorShawn McCarney <shawnmm@us.ibm.com>Tue May 19 18:33:21 2020 -0500
committerShawn McCarney <shawnmm@us.ibm.com>Wed May 20 15:51:16 2020 +0000
tree9b25e7ba72c3f7cd5bc590b7d97cd8416a204ce0
parent3c20846483a0c2cfdb53d562efe4b9d639b1556b [diff]
regulators: Create README in application directory

Create a README file in the phosphor-regulators directory.  The file
summarizes the features of the application.  It also contains a link to
the config file documentation.

Also made minor updates to the config file README.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Idf04501234237d84e6a0350fd93de3f9d3a7c431
2 files changed
tree: 9b25e7ba72c3f7cd5bc590b7d97cd8416a204ce0
  1. cold-redundancy/
  2. example/
  3. org/
  4. phosphor-power-supply/
  5. phosphor-regulators/
  6. power-sequencer/
  7. power-supply/
  8. services/
  9. test/
  10. tools/
  11. .clang-format
  12. .gitignore
  13. argument.hpp
  14. device.hpp
  15. device_monitor.hpp
  16. elog-errors.hpp
  17. file.hpp
  18. gpio.cpp
  19. gpio.hpp
  20. LICENSE
  21. MAINTAINERS
  22. meson.build
  23. meson_options.txt
  24. names_values.hpp
  25. pmbus.cpp
  26. pmbus.hpp
  27. README.md
  28. types.hpp
  29. utility.cpp
  30. utility.hpp
README.md

Code for detecting and analyzing power faults on Witherspoon.

To Build

To build this package, do the following steps:

    1. meson build
    2. ninja -C build

To clean the repository again run `rm -rf build`.

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",
  }