|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | Today | - |
| config/ibm/ | H | 04-Jan-2024 | - | -489 | -492 |
| examples/ | H | 18-Jun-2024 | - | 1,454 | 1,452 |
| rules/ | H | 06-Feb-2024 | - | 4 | 3 |
| scripts/ | H | 04-Jan-2024 | - | 19 | 17 |
| service_files/ | H | 04-Jan-2024 | - | 94 | 76 |
| subprojects/ | H | 04-Jan-2024 | - | 48 | 36 |
| test/ | H | 04-Jan-2024 | - | 1,293 | 1,066 |
| vpd-manager/ | H | 04-Nov-2024 | - | 3,801 | 2,598 |
| vpd-parser/ | H | 26-Aug-2024 | - | 1,756 | 1,151 |
| vpdecc/ | H | 18-Jun-2024 | - | 224 | 90 |
| .clang-format | H A D | 26-Aug-2024 | 3.7 KiB | 137 | 135 |
| .gitignore | H A D | 21-Apr-2023 | 45 | 5 | 4 |
| LICENSE | H A D | 07-Mar-2021 | 11.1 KiB | 202 | 169 |
| OWNERS | H A D | 19-Jan-2023 | 1.8 KiB | 53 | 48 |
| README.md | H A D | 02-Feb-2024 | 2.1 KiB | 48 | 35 |
| app.cpp | H A D | 29-Mar-2023 | 2.5 KiB | 91 | 73 |
| args.cpp | H A D | 07-Mar-2021 | 2.7 KiB | 100 | 87 |
| args.hpp | H A D | 07-Mar-2021 | 604 | 34 | 16 |
| common_utility.cpp | H A D | 26-Aug-2024 | 1.9 KiB | 77 | 65 |
| common_utility.hpp | H A D | 16-May-2023 | 712 | 32 | 17 |
| const.hpp | H A D | 26-Aug-2024 | 8.1 KiB | 236 | 214 |
| defines.hpp | H A D | 07-Mar-2021 | 2.9 KiB | 162 | 120 |
| extra-properties-example.yaml | H A D | 12-Dec-2022 | 218 | 8 | 6 |
| extra-properties.mako.hpp | H A D | 07-Mar-2021 | 756 | 41 | 34 |
| extra-properties.py | H A D | 12-Dec-2022 | 937 | 37 | 25 |
| ibm_vpd_app.cpp | H A D | 16-Oct-2024 | 71.1 KiB | 1,982 | 1,425 |
| ibm_vpd_utils.cpp | H A D | 20-Sep-2024 | 38.8 KiB | 1,257 | 1,067 |
| ibm_vpd_utils.hpp | H A D | 20-Sep-2024 | 19.3 KiB | 581 | 217 |
| impl.cpp | H A D | 26-Aug-2024 | 19.7 KiB | 664 | 506 |
| impl.hpp | H A D | 26-Aug-2024 | 6.3 KiB | 212 | 86 |
| meson.build | H A D | 13-Feb-2024 | 10.2 KiB | 259 | 222 |
| meson.options | H A D | 18-Jun-2024 | 2.5 KiB | 22 | 21 |
| store.hpp | H A D | 16-May-2023 | 2.8 KiB | 115 | 68 |
| types.hpp | H A D | 04-Jan-2024 | 3 KiB | 88 | 69 |
| utilInterface.hpp | H A D | 16-May-2023 | 809 | 41 | 33 |
| vpd_exceptions.hpp | H A D | 18-Jun-2024 | 4 KiB | 156 | 77 |
| vpd_tool.cpp | H A D | 20-Sep-2024 | 8.8 KiB | 265 | 227 |
| vpd_tool_impl.cpp | H A D | 26-Aug-2024 | 42.2 KiB | 1,352 | 1,163 |
| vpd_tool_impl.hpp | H A D | 26-Aug-2024 | 10 KiB | 323 | 71 |
| write.cpp | H A D | 07-Mar-2021 | 1.5 KiB | 67 | 53 |
| write.hpp | H A D | 16-May-2023 | 470 | 26 | 14 |
| writefru.mako.hpp | H A D | 19-Apr-2021 | 2.8 KiB | 109 | 84 |
| writefru.py | H A D | 06-Dec-2022 | 891 | 37 | 25 |
| writefru.yaml | H A D | 07-Mar-2021 | 662 | 23 | 20 |
README.md
1# Overview
2
3This repository hosts code for OpenPower and IBM IPZ format VPD parsers. Both
4OpenPower VPD and IPZ VPD formats are structured binaries that consist of
5records and keywords. A record is a collection of multiple keywords. More
6information about the format can be found
7[here](https://www-355.ibm.com/systems/power/openpower/posting.xhtml?postingId=1D060729AC96891885257E1B0053BC95).
8
9The repository consists of two distinct applications, which are:
10
11## OpenPower VPD Parser
12
13This is a build-time YAML driven application that parses the OpenPower VPD
14format and uses the YAML configuration (see extra-properties-example.yaml and
15writefru.yaml) to determine:
16
17- The supported records and keywords.
18- How VPD data is translated into D-Bus interfaces and properties.
19
20The application instance must be passed in the file path to the VPD (this can,
21for example, be a sysfs path exposed by the EEPROM device driver) and also the
22D-Bus object path(s) that EEPROM data needs to be published under.
23
24## IBM VPD Parser
25
26This parser is can be built by passing in the `--enable-ibm-parser` configure
27option. This parser differs from the OpenPower VPD parser in the following ways:
28
29- It parses all the records and keywords from the VPD, including large keywords
30 (Keywords that begin with a `#` and are > 255 bytes in length).
31- It relies on a runtime JSON configuration (see examples/inventory.json) tocf
32 determine the D-Bus object path(s) that hold interfaces and properties
33 representing the VPD for a given VPD file path.
34
35Making the application runtime JSON driven allows us to support multiple systems
36(with different FRU configurations) to be supported in a single code image as
37well as making the application more flexible for future improvements.
38
39## TODOs and Future Improvements
40
411. The long-term goal is to completely do away with the build time YAML driven
42 configurations and instead reconcile the OpenPower VPD parser and the IBM VPD
43 parser applications into a single runtime JSON driven application.
442. Add details to the README on how to configure and build the application.
453. More JSON documentation.
464. Support for more IBM VPD formats.
475. VPD Write and tool documentation.
48