Fix MD033 warnings

The following warnings are generated by using markdownlint analysis:
```
README.md:67:24 MD033/no-inline-html Inline HTML [Element: driver]
README.md:67:33 MD033/no-inline-html Inline HTML [Element: instance]
```
Refer to markdown-lint [1] to fix MD033
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/033-no-inline-html.md

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: Ib9ede70d1b126910a702b829f8890084b5c3c1e0
1 file changed
tree: 9ff1b87d6422d6fb6f74c4655f664b529b7c91fd
  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. .gitignore
  15. .shellcheck
  16. compatible_system_types_finder.cpp
  17. compatible_system_types_finder.hpp
  18. dbus_interfaces_finder.cpp
  19. dbus_interfaces_finder.hpp
  20. device.hpp
  21. device_monitor.hpp
  22. elog-errors.hpp
  23. file_descriptor.hpp
  24. gpio.cpp
  25. gpio.hpp
  26. LICENSE
  27. meson.build
  28. meson.options
  29. names_values.hpp
  30. OWNERS
  31. pmbus.cpp
  32. pmbus.hpp
  33. README.md
  34. temporary_file.cpp
  35. temporary_file.hpp
  36. temporary_subdirectory.cpp
  37. temporary_subdirectory.hpp
  38. types.hpp
  39. utility.cpp
  40. 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",
      }