Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / c9ecf8eabe11a1f8766c0e043d94c76ad00c0551
commitc9ecf8eabe11a1f8766c0e043d94c76ad00c0551[log] [tgz]
authorPriyanga Ramasamy <priyanga24@in.ibm.com>Fri Oct 08 02:28:52 2021 -0500
committerSantosh Puranik <santosh.puranik@in.ibm.com>Fri Nov 26 12:43:09 2021 +0000
tree9df11fcde8f095446a38147faa9cad8e87a269e3
parent0243493148100bb98527ce82f5c929f071aec999 [diff]
VpdTool:Treat NULL char at the end as a terminator

If there is a non-printable null character at the end or if
there are many non printable null characters towards the end of
the buffer, vpd-tool treats null char(s) as a null terminator
and displays the bytes in ascii format.

vpd-tool displays the vector data in hex if,
 - If there are any other non printable character(s) except null.
 - If the non printable null character(s) is at the middle of the
   buffer.

Test:
Tested on rainier

-> vpd-tool output before emplacing this logic:(displays SN in hex)
(where SN has only one non printable NULL at the end)

root@rain135bmc:/tmp# vpd-tool -o -O /system/chassis/motherboard/powersupply3
[
    {
        "/system/chassis/motherboard/powersupply3": {
            "CC": "2B1E",
            "DR": "IBM PS",
            "FN": "03FP302",
            "LocationCode": "U78DB.ND0.WZS000G-E3",
            "PN": "03FP301",
            "SN": "0x594c31304b593038434b364b00",
            "TYPE": "FRU",
            "type": "xyz.openbmc_project.Inventory.Item.PowerSupply"
        }
    }
]

-> vpd-tool output after emplacing this logic:(displays SN in string format)
(by treating end NULL char as NULL terminator)

root@rain135bmc:/tmp# ./vpd-tool -o -O "/system/chassis/motherboard/powersupply3"
[
    {
        "/system/chassis/motherboard/powersupply3": {
            "CC": "2B1E",
            "DR": "IBM PS",
            "FN": "03FP302",
            "LocationCode": "U78DB.ND0.WZS000G-E3",
            "PN": "03FP301",
            "SN": "YL10KY08CK6K",
            "TYPE": "FRU",
            "type": "xyz.openbmc_project.Inventory.Item.PowerSupply"
        }
    }
]

Signed-off-by: Priyanga Ramasamy <priyanga24@in.ibm.com>
Change-Id: I4fb073c49ed3cad117e8dbd0d4da54dcb35f0dc2
2 files changed
tree: 9df11fcde8f095446a38147faa9cad8e87a269e3
  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.