Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 1f0b1e6d2aaaebdabc2767081e809b5486ef9223
commit1f0b1e6d2aaaebdabc2767081e809b5486ef9223[log] [tgz]
authorPriyangaRamasamy <priyanga24@in.ibm.com>Thu Feb 20 20:48:25 2020 +0530
committerPriyanga Ramasamy <priyanga24@in.ibm.com>Sun Jun 21 16:57:30 2020 +0000
tree4f87175ca360293e79981b0689ee83cde05d3621
parent31970ded12a125ec04ac11f506bad8251d2a9f22 [diff]
VPD tool : dumpInventory & dumpObject

VPD tool has four options.

a) Dump Complete Inventory - no additional arguments are needed.
b) Dump Specific Object - by providing the object name.
c) Read the keyword - by providing the object name, record name and keyword to be read.
d) Write/Update the keyword - by providing the object name,  record name, keyword and the value to be updated.

{value - in ascii or hex & all the other arguments in string}

"--help" option provides details on how to use the above mentioned options.

This commit has implementation of dump inventory and dump specific object.

Output:

---------Dump Inventory---------
Not displaying the complete output.

root@rainier:/tmp# ./vpd-tool -i
[
    {
        "/system": {
            "LocationCode": "U9105.22A.SIMP10R",
            "Model": "9105-22A",
            "SerialNumber": "SIMP10R",
            "type": "xyz.openbmc_project.Inventory.Item.System"
        },
        "/system/chassis": {
            "LocationCode": "U78DA.ND1.1234567",
            "type": "xyz.openbmc_project.Inventory.Item.Chassis"
        },
        .
        .
        .
        .
       and so on..
]

---------Dump Object----------

root@rainier:/tmp# ./vpd-tool -o -O /system/chassis/motherboard/ebmc_card_bmc
[
    {
        "/system/chassis/motherboard/ebmc_card_bmc": {
            "CC": "6B58",
            "DR": "EBMC            ",
            "FN": "F191014",
            "LocationCode": "U78DA.ND1.1234567-P0-C5",
            "PN": "PN12345",
            "SN": "YL6B58010000",
            "type": "xyz.openbmc_project.Inventory.Item.Bmc"
        }
    }
]

Flag to enable VPD tool:
There is no seperate flag for VPD tool.
ibm-parser flag will generate the vpd-tool binary.

Steps to build and generate the executable using meson:
meson -Denabled=ibm-parser build
ninja -C build

Test:
Tested on simics.

Signed-off-by: PriyangaRamasamy <priyanga24@in.ibm.com>
Change-Id: I712f7ad4303eefa68f232685b6b0e53646f859f5
7 files changed
tree: 4f87175ca360293e79981b0689ee83cde05d3621
  1. examples/
  2. test/
  3. vpdecc/
  4. .clang-format
  5. .gitignore
  6. app.cpp
  7. args.cpp
  8. args.hpp
  9. bootstrap.sh
  10. configure.ac
  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. Makefile.am
  26. meson.build
  27. meson_options.txt
  28. parser.cpp
  29. parser.hpp
  30. README.md
  31. store.hpp
  32. types.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.