Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 5cb3b1f361d347c7881d546241c4bb214d246da2
commit5cb3b1f361d347c7881d546241c4bb214d246da2[log] [tgz]
authoralpana07 <alpana07@gfw289.aus.stglabs.ibm.com>Thu Dec 16 11:19:36 2021 -0600
committerSantosh Puranik <santosh.puranik@in.ibm.com>Mon Mar 07 04:38:09 2022 +0000
tree68c2a361474780fd9d93ac8a56d84d3d283d0bab
parent64b9f5f12083b15e47d1df63a3be3500d8c842c4 [diff]
PEL: Error support for VPD

This commit takes care of logging predictive error in case of
any vpd file has invalid data/no data.
If FRU is present on the system and due to any reason vpd
collection fails, then there should be a non-informational
PEL to indicate there is a vpd issue.

Test: Tested for an empty vpd file-

./ibm-read-vpd  -f /tmp/empty.vpd
        "0x500011DF": {
        "SRC":                  "BD554001",
        "Message":              "A VPD data exception occurred.",
        "PLID":                 "0x500011DF",
        "CreatorID":            "BMC",
        "Subsystem":            "CEC Hardware - VPD Interface",
        "Commit Time":          "12/22/2021 04:20:05",
        "Sev":                  "Predictive Error",
        "CompID":               "0x4000"
    }

Change-Id: I4fe119b580b555bb1bc47bf1f714bac4fb7e2b55
Signed-off-by: Alpana Kumari <alpankum@in.ibm.com>
1 file changed
tree: 68c2a361474780fd9d93ac8a56d84d3d283d0bab
  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. OWNERS
  29. README.md
  30. store.hpp
  31. types.hpp
  32. utilInterface.hpp
  33. vpd_exceptions.hpp
  34. vpd_tool.cpp
  35. vpd_tool_impl.cpp
  36. vpd_tool_impl.hpp
  37. write.cpp
  38. write.hpp
  39. writefru.mako.hpp
  40. writefru.py
  41. 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.