Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / fa47e6c0c7f9ac505aa54fd5b33a3c10853579bc
commitfa47e6c0c7f9ac505aa54fd5b33a3c10853579bc[log] [tgz]
authorSouvik Roy <souvikroyofficial10@gmail.com>Thu Feb 20 00:17:25 2025 -0600
committerSouvik Roy <souvikroyofficial10@gmail.com>Fri Feb 21 10:46:31 2025 +0000
treeb70587ca57cd4eecdd853b61a4bf1808b1eeab3f
parentf277d6a748e3697a320c294c05bd5870833ceaac [diff]
Refactor insert or merge API exception handling

This commit refactors vpd specific utility API used to insert or merge
property map in interface map ,in order to handle any exceptions thrown
by it locally. All utility methods should handle exceptions locally and
log a journal log in case of failure. The caller of the utility APIs
should check the return value to detect success/failure.

This commit also removes unnecessary declaration of this API in
worker.hpp

Test:
```
- Install bitbaked image on Everest
- Clear persistent PIM data on filesystem, restart PIM and then
  vpd-manager services
- Check all interfaces under PIM like
  LocationCode,Item,OperationalStatus,etc. are populated properly
```

Change-Id: Ie13882c0697d691f0593765f6f4dad5ac5eadea2
Signed-off-by: Souvik Roy <souvikroyofficial10@gmail.com>
2 files changed
tree: b70587ca57cd4eecdd853b61a4bf1808b1eeab3f
  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.