commit	8dca5075fc2bc68d7900d0ffa49a499351be197a	[log] [tgz]
author	Faisal Awada <faisal@us.ibm.com>	Sat Nov 23 08:07:38 2024 -0600
committer	Faisal Awada <faisal@us.ibm.com>	Mon Dec 02 15:55:54 2024 -0600
tree	6be4c2a6aadff376a8880c90d8dedf60a2ca37f1
parent	5a582d3c7a6865eaa0d80f0dc6aeb85b2f72c2a8 [diff]

psutils: Add new functions to  AEI Updater class

The following functions handle the critical stages of firmware update,
including validation, reading, preparation, and reboot verification.
Error handling and logging are incorporated to isolate issues during the
update.

getFirmwarePath()
Retrieves the firmware file path from the image directory. Uses
getFWFilenamePath to fetch the path. Logs an error if the firmware path
is not found and returns an empty string otherwise returns firmware
path.

isFirmwareFileValid()
Validates the firmware file at the given path using validateFWFile.
Ensure the firmware file exists and meets requirements before proceeding
with the update. Logs an error if validation fails.

openFirmwareFile()
Opens the firmware file at the specified path for reading in binary
mode. Logs an error if the file cannot be opened.

readFirmwareBlock()
Reads a block of data from the firmware file.Uses readFirmwareBytes to
read the specified number of bytes.

prepareCommandBlock()
Prepares a command block for writing firmware data to the PSU. Adds
metadata, data, and a CRC8 checksum. Packages firmware data in a format
suitable for I2C transmission.

ispReboot()
Sends a reboot command to the status register to apply new firmware.

ispReadRebootStatus()
Reads the reboot status from ISP, returns true for success otherwise
false.

Tested:
- Validated that the firmware path retrieves the correct file.
- A validation error is logged when the file is empty or path is
  incorrect.
- Removed read permission on the firmware file and verified that an
  error was logged.
- Verify the block of data read as specified in the specification.
- Printed the command block and verified that the command and data are
  ready to be sent to the PSU via I2C.
- Downloaded the firmware and verified that the command block, ISP
  reboot and reboot status are working as expected.

Change-Id: I097b4aeefc0967d5591b8fb6aefb3c600c9f77f8
Signed-off-by: Faisal Awada <faisal@us.ibm.com>

2 files changed

tree: 6be4c2a6aadff376a8880c90d8dedf60a2ca37f1

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