pseq: Make JSON configuration file required

Modify the phosphor-power-sequencer application so that a JSON
configuration file is required. Previously it was optional.

Create a default JSON config file. This file implements the same
behavior that was previously hard-coded if no config file was found.

Provide a meson build option to specify whether to use the default JSON
config file. Set the default option value to true.

Update the config file documentation to reflect these changes.

The result of these changes is:
- Eliminates the current hard-coding and dual code paths caused by JSON
  config files being optional.
- Application behavior should be the same to the end user.

Tested:
- Build
  - Verified default meson option is true
  - Verified C constant that is generated based on meson option
    - When meson option is true
    - When meson option is false
- Run-time
  - Tested in simulation
  - Default config file used
    - Verified default file was found and loaded successfully
  - Default config file was not used
    - Verified system-specific file was found and loaded successfully

Change-Id: If4c8aeffa81aa351cf81cc25e367bdd4c61a8e32
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
9 files changed
tree: 2cc76914b800fddb4e56112c80c76b5077ee4479
  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. chassis_status_monitor.cpp
  20. chassis_status_monitor.hpp
  21. compatible_system_types_finder.cpp
  22. compatible_system_types_finder.hpp
  23. config_file_parser_error.hpp
  24. dbus_interfaces_finder.cpp
  25. dbus_interfaces_finder.hpp
  26. device.hpp
  27. device_monitor.hpp
  28. elog-errors.hpp
  29. file_descriptor.hpp
  30. format_utils.hpp
  31. gpio.cpp
  32. gpio.hpp
  33. json_parser_utils.cpp
  34. json_parser_utils.hpp
  35. LICENSE
  36. meson.build
  37. meson.options
  38. names_values.hpp
  39. OWNERS
  40. pmbus.cpp
  41. pmbus.hpp
  42. README.md
  43. temporary_file.cpp
  44. temporary_file.hpp
  45. temporary_subdirectory.cpp
  46. temporary_subdirectory.hpp
  47. types.hpp
  48. utility.cpp
  49. 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",
      }