Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / d3a379a6b259a0cd4b7b1af700079b31a6a492b2
commitd3a379a6b259a0cd4b7b1af700079b31a6a492b2[log] [tgz]
authorSantosh Puranik <santosh.puranik@in.ibm.com>Mon Aug 23 19:12:59 2021 +0530
committerSantosh Puranik <santosh.puranik@in.ibm.com>Tue Sep 14 15:53:04 2021 +0000
tree79079582f59a69b84687562c392c2cc09714ffdf
parentb17dd3b3e45d9add8e37f549e6f3ab63ecdf4340 [diff]
Set one-time properties and PrettyName

This commit adds support for the following:

* Sets "one-time" properties in the inventory. For a given object, if
  the property does not already exist, we set the property on D-Bus. The
  current use-case is to only set the Functional and Enabled properties.

* Sets the PrettyName property when priming the inventory. This makes
  sure we have the name set even when we haven't collected the said
  FRU's VPD. This is useful for FRUs where we don't collect VPD yet
  (DIMMs, for example). For this to work, the property needs to be
  available under the extraInterfaces key in the JSON entry for the
  FRU. For ex:

```
"extraInterfaces": {
    "xyz.openbmc_project.Inventory.Item": {
        "PrettyName": "Memory Controller Channel"
    }
```

Signed-off-by: Santosh Puranik <santosh.puranik@in.ibm.com>
Change-Id: Idd40836482a2f4dd512116c9e373da66df7bea1a
1 file changed
tree: 79079582f59a69b84687562c392c2cc09714ffdf
  1. examples/
  2. subprojects/
  3. test/
  4. vpd-manager/
  5. vpd-parser/
  6. vpdecc/
  7. .clang-format
  8. .gitignore
  9. app.cpp
  10. args.cpp
  11. args.hpp
  12. common_utility.cpp
  13. common_utility.hpp
  14. const.hpp
  15. defines.hpp
  16. extra-properties-example.yaml
  17. extra-properties.mako.hpp
  18. extra-properties.py
  19. ibm_vpd_app.cpp
  20. ibm_vpd_utils.cpp
  21. ibm_vpd_utils.hpp
  22. impl.cpp
  23. impl.hpp
  24. LICENSE
  25. MAINTAINERS
  26. meson.build
  27. meson_options.txt
  28. README.md
  29. store.hpp
  30. types.hpp
  31. utilInterface.hpp
  32. vpd_exceptions.hpp
  33. vpd_tool.cpp
  34. vpd_tool_impl.cpp
  35. vpd_tool_impl.hpp
  36. write.cpp
  37. write.hpp
  38. writefru.mako.hpp
  39. writefru.py
  40. writefru.yaml
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.