vpd-tool:Option to fixSystemVPD keywords

This commit has an added option in vpd-tool that fixes system VPD
restorable keywords in an interactive way.
This option is required in a field usecase.

In the field when there is a fault in BMC and BMC gets replaced,
the replaced BMC VPD will now have all blank data. Now the Product
engineer can use vpd-tool fixSystemVPD option to update the BMC
critical keywords by chosing the corresponding keyword data from
system backplane.

Similarly when the system backplane is replaced,
using the option, the PEs' can copy the keyword data from BMC.

When both system backplane and BMC are replaced, the PEs' will have
option to update new value on both.

This interactive tool option eases keyword data updation and avoids
manual updation for each and every mismatching critical keyword.

Test: Tested on everest

// Create a mismatch.
root@ever8bmc:/tmp# ./vpd-tool-writeHardwareFix -w -H -O /sys/bus/i2c/drivers/at24/8-0050/eeprom -R VCEN -K FC -V 0x64560204
Disabled reboot
Sleep started
Enabled reboot
root@ever8bmc:/tmp#
root@ever8bmc:/tmp# busctl set-property xyz.openbmc_project.Inventory.Manager /xyz/openbmc_project/inventory/system/chassis/motherboard com.ibm.ipzvpd.LXR0 LX ay 2 0x04 0x64
root@ever8bmc:/tmp#
root@ever8bmc:/tmp# busctl set-property xyz.openbmc_project.Inventory.Manager /xyz/openbmc_project/inventory/system/chassis/motherboard com.ibm.ipzvpd.VSYS WN ay 3 0x74 0x85 0x69
root@ever8bmc:/tmp# ./vpd-tool-writeHardwareFix -w -H -O /sys/bus/i2c/drivers/at24/8-0050/eeprom -R VSYS -K WN -V 0x64560204077675
Disabled reboot
Sleep started
Enabled reboot

=========

(Trimmed the output)
root@ever8bmc:/tmp# ./vpd-tool --fixSystemVPD

Restorable record-keyword pairs and their data on cache & hardware.

|======================================================================================================|
S.No  Record  Keyword  Data On Cache                 Data On Hardware              Data Mismatch
|======================================================================================================|
1     UTIL    D0       0x69                          0x69                          NO
|------------------------------------------------------------------------------------------------------|
2     LXR0    LX       0x0464                        0x3100080100300074            YES
|------------------------------------------------------------------------------------------------------|
3     VCEN    FC       0x373830432d303031            0x645602042d303031            YES
|------------------------------------------------------------------------------------------------------|
4     VCEN    SE       RCH0014                       RCH0014                       NO
|------------------------------------------------------------------------------------------------------|
5     VSYS    BR       0x5330                        0x5330                        NO
|------------------------------------------------------------------------------------------------------|
6     VSYS    TM       0x646534302d4d5258            0x646534302d4d5258            NO
|------------------------------------------------------------------------------------------------------|
7     VSYS    SE       13E8CEX                       13E8CEX                       NO
|------------------------------------------------------------------------------------------------------|
8     VSYS    SU       0x0004ac1e9fd4                0x0004ac1e9fd4                NO
|------------------------------------------------------------------------------------------------------|
9     VSYS    RB       0x31000000                    0x31000000                    NO
|------------------------------------------------------------------------------------------------------|
10    VSYS    WN       0x748569                      0x645602040776754243453432    YES
|------------------------------------------------------------------------------------------------------|
11    VSYS    RG       0x00000000                    0x00000000                    NO
|------------------------------------------------------------------------------------------------------|

Enter 1 => If you choose cache data of all mismatching record-keyword pairs
Enter 2 => If you choose hardware data of all mismatching record-keyword pairs
Enter 3 => If you wish to explore more options
Enter 0 to exit  3

|======================================================================================================|

Iterate through all restorable record-keyword pairs

|======================================================================================================|
S.No  Record  Keyword  Data On Cache                 Data On Hardware              Data Mismatch
1     UTIL    D0       0x69                          0x69                          NO
|======================================================================================================|

No mismatch found.

Enter 6 => If you wish to enter a new value to update both on BMC and System Backplane
Enter 7 => If you wish to skip the above record-keyword pair
Enter 0 => To exit successfully : 6

|======================================================================================================|

Enter the new value to update both on BMC & System Backplane (Value should be in ASCII or in HEX(prefixed with 0x)) : 0x02

|======================================================================================================|

Data updated successfully.

|======================================================================================================|
S.No  Record  Keyword  Data On Cache                 Data On Hardware              Data Mismatch
2     LXR0    LX       0x0464                        0x3100080100300074            YES
|======================================================================================================|

Enter 4 => If you choose the cache value as the right value
Enter 5 => If you choose hardware value as the right value
Enter 6 => If you wish to enter a new value to update both cache and hardware
Enter 7 => If you wish to skip the above record-keyword pair
Enter 0 => To exit successfully  5

|=======================================================================|
Disabled reboot
Sleep started, try to reboot
Sleep end
Sleep started
Enabled reboot

Data updated successfully.

|======================================================================================================|
S.No  Record  Keyword  Data On Cache                 Data On Hardware              Data Mismatch
3     VCEN    FC       0x373830432d303031            0x645602042d303031            YES
|======================================================================================================|

Enter 4 => If you choose the cache value as the right value
Enter 5 => If you choose hardware value as the right value
Enter 6 => If you wish to enter a new value to update both cache and hardware
Enter 7 => If you wish to skip the above record-keyword pair
Enter 0 => To exit successfully  4

|=======================================================================|
Disabled reboot
Sleep started, try to reboot
Sleep end
Sleep started
Enabled reboot

Data updated successfully.

|======================================================================================================|
S.No  Record  Keyword  Data On Cache                 Data On Hardware              Data Mismatch
4     VCEN    SE       RCH0014                       RCH0014                       NO
|======================================================================================================|

No mismatch found.

Enter 6 => If you wish to enter a new value to update both on BMC and System Backplane
Enter 7 => If you wish to skip the above record-keyword pair
Enter 0 => To exit successfully : 7

|======================================================================================================|

Skipped the above record-keyword pair. Continueing to the next pair if available.

|======================================================================================================|
S.No  Record  Keyword  Data On Cache                 Data On Hardware              Data Mismatch
10    VSYS    WN       0x748569                      0x645602040776754243453432    YES
|======================================================================================================|

Enter 4 => If you choose the cache value as the right value
Enter 5 => If you choose hardware value as the right value
Enter 6 => If you wish to enter a new value to update both cache and hardware
Enter 7 => If you wish to skip the above record-keyword pair
Enter 0 => To exit successfully  6

|=======================================================================|

Enter the new value to update both in cache & hardware (Value should be in ASCII or in HEX(prefixed with 0x)) : 0x433035303736304243453432

|=======================================================================|

Data updated successfully.

|======================================================================================================|
S.No  Record  Keyword  Data On Cache                 Data On Hardware              Data Mismatch
11    VSYS    RG       0x00000000                    0x00000000                    NO
|======================================================================================================|
No mismatch found. Skip this record-keyword pair.

Signed-off-by: Priyanga Ramasamy <priyanga24@in.ibm.com>
Change-Id: Ifb32efd1174360409b795b162282673a4f73df1b
4 files changed
tree: a1c6c090341712ca18dfd3d1eab4da6b8b437455
  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. meson.build
  26. meson_options.txt
  27. OWNERS
  28. README.md
  29. store.hpp
  30. types.hpp
  31. utilInterface.hpp
  32. vpd_exceptions.hpp
  33. vpd_tool.cpp
  34. vpd_tool_impl.cpp
  35. vpd_tool_impl.hpp
  36. write.cpp
  37. write.hpp
  38. writefru.mako.hpp
  39. writefru.py
  40. 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.