vpd-tool: Flow to read keyword from hardware updated

The commit implements change to check if the offset passed by the user
for a given EEPROM path is equal to the offset if defined for that
EEPROM in inventory JSON.
In case of any mismatch, error message is flagged to the user.

As all EEPROMs are not modelled in inventory JSON file, In order to
handle case where an EEPROM path passed by user is not present in JSON,
check has been added to avoid any exception thrown due to extraction of
inventory path from JSON based on the passed EEPROM path.

Test cases:

CASE1: Trying to read from i2c FRU

/tmp/vpd-tool -r -H -O "/sys/bus/i2c/drivers/at24/8-0050/eeprom" -R VINI -K PN --seek 0x30000
Invalid offset, please correct the offset
Recommended Offset is: 0

/tmp/vpd-tool -r -H -O "/sys/bus/i2c/drivers/at24/8-0050/eeprom" -R VINI -K PN
{
    "/sys/bus/i2c/drivers/at24/8-0050/eeprom": {
        "PN": "00L5521"
    }
}

CASE2: Trying to read from proc and EEPROM not defined in JSON:

/tmp/vpd-tool -r -H -O /sys/bus/spi/drivers/at25/spi22.0/eeprom  -R VINI -K CC
Invalid offset, please correct the offset
Recommended Offset is: 196608

/tmp/vpd-tool -r -H -O /sys/bus/spi/drivers/at25/spi22.0/eeprom  -R VINI -K CC --seek 0x30000
{
    "/sys/bus/spi/drivers/at25/spi22.0/eeprom": {
        "CC": "5C5F"
    }
}
/tmp/vpd-tool -r -H -O /sys/bus/spi/drivers/at25/spi23.0/eeprom  -R VINI -K CC --seek 0x30000
{
    "/sys/bus/spi/drivers/at25/spi23.0/eeprom": {
        "CC": "5C5F"
    }
}

/tmp/vpd-tool -r -H -O /sys/bus/spi/drivers/at25/spi23.0/eeprom  -R VINI -K CC --seek 0x3000
VHDR record not found
Did you provide a valid offset? By default VPD offset is taken as 0. To input offset, use --seek. Refer vpd-tool help.

/tmp/vpd-tool -r -H -O /sys/bus/spi/drivers/at25/spi23.0/eeprom  -R VINI -K CC
VHDR record not found
Did you provide a valid offset? By default VPD offset is taken as 0. To input offset, use --seek. Refer vpd-tool help.

/tmp/vpd-tool -r -H -O /sys/bus/spi/drivers/at25/spi22.0/eeprom  -R VINI -K CC --seek 0x3000
Invalid offset, please correct the offset
Recommended Offset is: 196608

Signed-off-by: Giridhari Krishna <giridharikrishnan@gmail.com>
Change-Id: I246ca983fc75490999f18386bf60e949959d49d2
2 files changed
tree: 080861a07264f611fa84cdae8b8b411f58a9b25d
  1. examples/
  2. ibm_vpd/
  3. subprojects/
  4. test/
  5. vpd-manager/
  6. vpd-parser/
  7. vpdecc/
  8. .clang-format
  9. .gitignore
  10. app.cpp
  11. args.cpp
  12. args.hpp
  13. common_utility.cpp
  14. common_utility.hpp
  15. const.hpp
  16. defines.hpp
  17. extra-properties-example.yaml
  18. extra-properties.mako.hpp
  19. extra-properties.py
  20. ibm_vpd_app.cpp
  21. ibm_vpd_utils.cpp
  22. ibm_vpd_utils.hpp
  23. impl.cpp
  24. impl.hpp
  25. LICENSE
  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.