Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 8e140a1c8076adf45e8dd975a8c6e4bcfc6ea578
commit8e140a1c8076adf45e8dd975a8c6e4bcfc6ea578[log] [tgz]
authorPriyangaRamasamy <priyanga24@in.ibm.com>Mon Apr 13 19:24:03 2020 +0530
committerSantosh Puranik <santosh.puranik@in.ibm.com>Sat Oct 31 19:04:57 2020 +0530
tree0b89bc8f984b3ed69399ac59a69c2dee941050f1
parentb665c5545482ac9add1e340ac8b17e5ae1f456db [diff]
Prime the Inventory VPD objects

At the time of collecting the system vpd, prime those non system vpd
inventory objects by populating only certain properites of the objects
(like - Location code, Type interface and the inventory object).

Test:
Tested on simics by adding a missing fru in inventory json
and introspecting it to get the primed version of the object.

Output:

root@rainier:/tmp# busctl introspect xyz.openbmc_project.Inventory.Manager /xyz/openbmc_project/inventory/system/chassis/motherboard/dasd_card_pyramid0
NAME                                             TYPE      SIGNATURE RESULT/VALUE           FLAGS
com.ibm.ipzvpd.Location                          interface -         -                      -
.LocationCode                                    property  s         "U78DA.ND1.1234567-P1" emits-change writable
org.freedesktop.DBus.Introspectable              interface -         -                      -
.Introspect                                      method    -         s                      -
org.freedesktop.DBus.Peer                        interface -         -                      -
.GetMachineId                                    method    -         s                      -
.Ping                                            method    -         -                      -
org.freedesktop.DBus.Properties                  interface -         -                      -
.Get                                             method    ss        v                      -
.GetAll                                          method    s         a{sv}                  -
.Set                                             method    ssv       -                      -
.PropertiesChanged                               signal    sa{sv}as  -                      -
xyz.openbmc_project.Inventory.Item.DiskBackplane interface -         -                      -

Tested in conjunction with this commit
<https://gerrit.openbmc-project.xyz/c/openbmc/meta-ibm/+/31821>

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