Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / c74c8efe7646df9d6eb3797e672e257620670e11
commitc74c8efe7646df9d6eb3797e672e257620670e11[log] [tgz]
authorSunny Srivastava <sunnsr25@in.ibm.com>Wed Apr 16 12:45:27 2025 +0530
committerJinu Joy Thomas <jinu.joy.thomas@in.ibm.com>Tue Apr 22 09:15:23 2025 +0000
tree96cc9cb1cfd0860770390f6860eae769f8f8190e
parent879d465b367c1a4c994cefe3245e5a7e03ac567e [diff]
Instantiation of handler class

The commit adds implementation of handler class.
Mostly, oem specific implementation has been moved from manager class
to handler class.

Change-Id: Ie2a4ed3f2265b77c260c190809b18b465a81b2f9
Signed-off-by: Sunny Srivastava <sunnsr25@in.ibm.com>
4 files changed
tree: 96cc9cb1cfd0860770390f6860eae769f8f8190e
  1. configuration/
  2. docs/
  3. scripts/
  4. service_files/
  5. test/
  6. vpd-manager/
  7. vpd-tool/
  8. vpdecc/
  9. .clang-format
  10. .gitignore
  11. LICENSE
  12. meson.build
  13. meson.options
  14. OWNERS
  15. 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.