Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 8fc1252efced598cb4e9ca5e3720a0a7ad117451
commit8fc1252efced598cb4e9ca5e3720a0a7ad117451[log] [tgz]
authorSouvik Roy <souvikroyofficial10@gmail.com>Wed Feb 19 01:28:38 2025 -0600
committerSunnySrivastava <sunnsr25@in.ibm.com>Thu Feb 20 03:26:15 2025 +0000
tree9002f02ecb6c1b5877c358b408c20e57b9eaac18
parent1ef2100813606df470aeb0a373fdeb232cc9deb5 [diff]
Refactor dump bad VPD utility exception handling

This commit refactors vpd specific utility APIs used to dump bad VPD in
order to handle any exceptions thrown by them locally. All utility
methods should handle exception 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.

Change-Id: I53addf47f717999aae9c86ec89d7561ebe8be879
Signed-off-by: Souvik Roy <souvikroyofficial10@gmail.com>
1 file changed
tree: 9002f02ecb6c1b5877c358b408c20e57b9eaac18
  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.