Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / d7d3b51160edad6aa745232dc91d9dc03bfe5d02
commitd7d3b51160edad6aa745232dc91d9dc03bfe5d02[log] [tgz]
authorSouvik Roy <souvikroyofficial10@gmail.com>Thu Jan 23 03:22:09 2025 -0600
committerSouvik Roy <souvikroyofficial10@gmail.com>Mon Feb 03 07:50:45 2025 +0000
tree42d173676b742b6f58d7c179afeabf3814cf13f5
parentfeb5658b201b11a6b8cb3f4d6665272296585055 [diff]
Add BIOS attribute tag in backup_restore JSON

This commit adds a tag "isUsedForBiosAttributeBackup" to the "backupMap"
in backup_restore JSON files. This tag will be useful for identifying
keywords which are used for backing up BIOS attributes in VPD.
This tag is required for implementation of --syncBiosAttributes option
in vpd-tool --mfgClean.

Test:
```
- install bitbaked image on an Everest system
- reboot, after reboot, ensure that backup restore feature of
  vpd-manager runs as usual
```

Change-Id: I01d37c3ca4f05b82aba2f6877e90ec8360c3215b
Signed-off-by: Souvik Roy <souvikroyofficial10@gmail.com>
2 files changed
tree: 42d173676b742b6f58d7c179afeabf3814cf13f5
  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.