Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / refs/heads/master
commit963e842d76719f5ca740ba03afabdb7aacea542e[log] [tgz]
authorSouvik Roy <souvikroyofficial10@gmail.com>Mon May 05 02:18:22 2025 -0500
committerSunnySrivastava <sunnsr25@in.ibm.com>Tue May 13 16:11:53 2025 +0000
tree32361f1049a342c82167ef1aa3b202a16c7ad799
parent410d96ca32a937940f5eb07211728272dedadf53 [diff]
Clear dump directory during manufacturing clean

This commit clears the vpd dump directory in case of manufacturing
clean.The vpd dump directory contains invalid vpd files found during
parsing. These files need to be deleted when manufacturing clean is
executed.

Test:
```
1. Ensure vpd-manager has dumped 3 bad VPD files in the VPD dump
   directory.
2. Execute vpd-tool --mfgClean --yes
3. After manufacturing clean is done, check return code, should be 0.
4. After manufacturing clean is done, check the VPD dump directory in
   /var/lib/vpd. There should be no dumps directory inside.
```

Change-Id: Ic8079013e8b6608b2365b3ce874f0950bf50d77a
Signed-off-by: Souvik Roy <souvikroyofficial10@gmail.com>
4 files changed
tree: 32361f1049a342c82167ef1aa3b202a16c7ad799
  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.