Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 46b73d9fcf234034801baed2998644b2bc79a67b
commit46b73d9fcf234034801baed2998644b2bc79a67b[log] [tgz]
authorPriyanga Ramasamy <priyanga24@in.ibm.com>Thu Jan 09 10:52:07 2025 -0600
committerJinu Joy Thomas <jinu.joy.thomas@in.ibm.com>Fri Feb 14 09:29:59 2025 +0000
tree847fba7947bb8bcc3a0c4cd4962dcb084ca4057d
parent1aad78345651f03c08274f2f0c8b3f5bf600ccd7 [diff]
manager:CollectionStatus property update

This commit updates the CollectionStatus during single FRU VPD
collection execution.

Test:
1. busctl call com.ibm.VPD.Manager /com/ibm/VPD/Manager
com.ibm.VPD.Manager CollectFRUVPD o /xyz/openbmc_project/
inventory/system/chassis/motherboard/lcd_op_panel_hill

CollectionStatus property value on success vpd collection:
s "com.ibm.VPD.Collection.Status.Success"

2. busctl call com.ibm.VPD.Manager /com/ibm/VPD/Manager
com.ibm.VPD.Manager CollectFRUVPD o /xyz/openbmc_project/
inventory/system/chassis/motherboard

Given FRU is neither replaceable at standby nor replaceable at runtime.
Single FRU VPD collection is not performed for
/xyz/openbmc_project/inventory/system/chassis/motherboard

3. busctl call com.ibm.VPD.Manager /com/ibm/VPD/Manager
 com.ibm.VPD.Manager CollectFRUVPD o /xyz/openbmc_project/
inventory/system/chassis/motherboard/pcieslot0/pcie_card0

CollectionStatus property value when pcie_card not found:
s "com.ibm.VPD.Collection.Status.Failure"

Change-Id: I776edd0c5002ec516f656281d0325ecdc6acf00e
Signed-off-by: Priyanga Ramasamy <priyanga24@in.ibm.com>
1 file changed
tree: 847fba7947bb8bcc3a0c4cd4962dcb084ca4057d
  1. configuration/
  2. scripts/
  3. service_files/
  4. test/
  5. vpd-manager/
  6. vpd-tool/
  7. vpdecc/
  8. .clang-format
  9. .gitignore
  10. LICENSE
  11. meson.build
  12. meson_options.txt
  13. OWNERS
  14. README.md
README.md

Overview

This repository hosts code for OpenPower and IBM IPZ format VPD parsers. Both OpenPower VPD and IPZ VPD formats are structured binaries that consist of records and keywords. A record is a collection of multiple keywords. More information about the format can be found here.

The repository consists of two distinct applications, which are:

OpenPower VPD Parser

This is a build-time YAML driven application that parses the OpenPower VPD format and uses the YAML configuration (see extra-properties-example.yaml and writefru.yaml) to determine:

  • The supported records and keywords.
  • How VPD data is translated into D-Bus interfaces and properties.

The application instance must be passed in the file path to the VPD (this can, for example, be a sysfs path exposed by the EEPROM device driver) and also the D-Bus object path(s) that EEPROM data needs to be published under.

IBM VPD Parser

This parser is can be built by passing in the --enable-ibm-parser configure option. This parser differs from the OpenPower VPD parser in the following ways:

  • It parses all the records and keywords from the VPD, including large keywords (Keywords that begin with a # and are > 255 bytes in length).
  • It relies on a runtime JSON configuration (see examples/inventory.json) to determine the D-Bus object path(s) that hold interfaces and properties representing the VPD for a given VPD file path.

Making the application runtime JSON driven allows us to support multiple systems (with different FRU configurations) to be supported in a single code image as well as making the application more flexible for future improvements.

TODOs and Future Improvements

  1. The long-term goal is to completely do away with the build time YAML driven configurations and instead reconcile the OpenPower VPD parser and the IBM VPD parser applications into a single runtime JSON driven application.
  2. Add details to the README on how to configure and build the application.
  3. More JSON documentation.
  4. Support for more IBM VPD formats.
  5. VPD Write and tool documentation.