Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 022112bc235c7f91ee998bb131f06e212dee1f6a
commit022112bc235c7f91ee998bb131f06e212dee1f6a[log] [tgz]
authorSunny Srivastava <sunnsr25@in.ibm.com>Wed Feb 19 19:53:29 2025 +0530
committerSunnySrivastava <sunnsr25@in.ibm.com>Mon Feb 24 08:56:31 2025 +0000
tree5de98dc7d99c50ebc228f9b914ef1f83a528be5c
parentc6ef42d66faa075073f2163e12cba119dbaf4076 [diff]
JSON and API prototype to update powerVS VPD

The commit introduces JSON file to hold the VPD that needs to be
updated for systems with PowerVS configuration.

It also adds API to fetch JSON as per system IM and prototype for API
which will checks the existing data and based on that will either skip
or update the VPD.

Change-Id: I5c279ce210831667be669c2a7c9c7d9c160de336
Signed-off-by: Sunny Srivastava <sunnsr25@in.ibm.com>
6 files changed
tree: 5de98dc7d99c50ebc228f9b914ef1f83a528be5c
  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.