Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-power / 837ece7cdfb2654da19f91612e064041cb7bcce9
commit837ece7cdfb2654da19f91612e064041cb7bcce9[log] [tgz]
authorShawn McCarney <shawnmm@us.ibm.com>Thu Apr 22 13:21:08 2021 -0500
committerShawn McCarney <shawnmm@us.ibm.com>Tue Apr 27 19:06:12 2021 +0000
tree290d8ac2e6af1f39d101f62f749e8e61e389d69f
parentcb091801fc0a6bfb11b032461f1e216a6dd25e05 [diff]
regulators: Create DBusSensor class

Create the DBusSensor class that represents a voltage regulator sensor
on D-Bus.

Each voltage rail in the system may provide multiple types of sensor
data, such as temperature, output voltage, and output current.  A
DBusSensor tracks one of these data types for a voltage rail.

Class supports the following sensor operations:
* Create sensor
* Set sensor value
* Disable sensor (when system is powered off)
* Set sensor to error state (when unable to read value due to I2C error)
* Delete sensor

Note: A different class will implement the ObjectManager interface for
all voltage regulator sensors.  That will be in a future commit.

Tested:
* Created a sensor of each supported type (vout, iout, etc.)
* Set the value of a sensor
  * Tested update policies: hysteresis, highest, lowest
* Disabled a sensor
* Set a sensor to the error state
* Verified all D-Bus signals emitted
  * InterfacesAdded signal emitted with all info when sensor created
  * PropertiesChanged signal emitted when sensor properties change
  * InterfacesRemoved signal emitted when sensor deleted
* See https://gist.github.com/smccarney/5ae989da1977162ae1a21c208d5302fc
  for complete test plan.

Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I655277e6bf0a31a8778a54e87d5864f9951b045e
4 files changed
tree: 290d8ac2e6af1f39d101f62f749e8e61e389d69f
  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. test/
  11. tools/
  12. .clang-format
  13. .gitignore
  14. .shellcheck
  15. argument.hpp
  16. device.hpp
  17. device_monitor.hpp
  18. elog-errors.hpp
  19. file_descriptor.hpp
  20. gpio.cpp
  21. gpio.hpp
  22. LICENSE
  23. MAINTAINERS
  24. meson.build
  25. meson_options.txt
  26. names_values.hpp
  27. pmbus.cpp
  28. pmbus.hpp
  29. README.md
  30. types.hpp
  31. utility.cpp
  32. 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 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",
  }