Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / a88a298f0756a525b4d628cda2fb77b8e74a283f
commita88a298f0756a525b4d628cda2fb77b8e74a283f[log] [tgz]
authorSunny Srivastava <sunnsr25@in.ibm.com>Thu Jan 23 12:03:21 2025 +0530
committerSunny Srivastava <sunnsr25@in.ibm.com>Tue Jan 28 11:46:06 2025 +0530
tree77fad858888493999d038f079fca4333405fe6ce
parent98c6afa3a3be745748c4941f3ace31d552d8b220 [diff]
Add custom exception class and type

The commit adds few custom exception class and type so that exact
exception can be thrown for a failure.
This is required to detect the type of failure and log appropriate PEL
for the error. With just throwing runtime error in most of the cases it
is not possible to detect the reason for failure at catching point.

Change-Id: I672c3c5fd6d289b8e6943b9a22836acfb9e6b04b
Signed-off-by: Sunny Srivastava <sunnsr25@in.ibm.com>
3 files changed
tree: 77fad858888493999d038f079fca4333405fe6ce
  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.