Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / e0e1549e82c4691ad41703cfb6563c77b76cf2c4
commite0e1549e82c4691ad41703cfb6563c77b76cf2c4[log] [tgz]
authorMatt Spinler <spinler@us.ibm.com>Mon Oct 28 04:17:48 2024 -0500
committerMatt Spinler <spinler@us.ibm.com>Thu Nov 07 14:09:26 2024 -0600
treeaf430d8b88fc3a4dbbed004204056f9595c755f9
parentf04c17494ce93764dd81fc8bbc2feda2196a2e7a [diff]
Add Slot interface to all NVMe drives

Assign a slot number to all drive paths so that the entity manager
config file for IBM's drives can use that to give its objects unique
names.  Previously it used its own incrementing index but sometimes got
confused and tried to put a duplicate interface on the same object path
which would crash.

This was already being done for IBM's cable card sensors.

Because the NVMe temperature sensor names are being hardcoded in other
places (fan control and HMC telemetry), the slots are being assigned to
always start at 1 and sequentially increment to keep the names the same
as before.

Tested:

Properties are on D-Bus:

```
 busctl get-property xyz.openbmc_project.Inventory.Manager \
 /xyz/openbmc_project/inventory/system/chassis/motherboard/disk_backplane0/nvme0/dp0_drive0 \
 xyz.openbmc_project.Inventory.Decorator.Slot SlotNumber
u 1
```

Change-Id: Id83c5c4ea2aaae810bcd9c1120cef11fb0e7ba74
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
7 files changed
tree: af430d8b88fc3a4dbbed004204056f9595c755f9
  1. config/
  2. examples/
  3. rules/
  4. scripts/
  5. service_files/
  6. subprojects/
  7. test/
  8. vpd-manager/
  9. vpd-parser/
  10. vpdecc/
  11. .clang-format
  12. .gitignore
  13. app.cpp
  14. args.cpp
  15. args.hpp
  16. common_utility.cpp
  17. common_utility.hpp
  18. const.hpp
  19. defines.hpp
  20. extra-properties-example.yaml
  21. extra-properties.mako.hpp
  22. extra-properties.py
  23. ibm_vpd_app.cpp
  24. ibm_vpd_utils.cpp
  25. ibm_vpd_utils.hpp
  26. impl.cpp
  27. impl.hpp
  28. LICENSE
  29. meson.build
  30. meson.options
  31. OWNERS
  32. README.md
  33. store.hpp
  34. types.hpp
  35. utilInterface.hpp
  36. vpd_exceptions.hpp
  37. vpd_tool.cpp
  38. vpd_tool_impl.cpp
  39. vpd_tool_impl.hpp
  40. write.cpp
  41. write.hpp
  42. writefru.mako.hpp
  43. writefru.py
  44. 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) tocf 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.