xref: /openbmc/phosphor-dbus-interfaces/yaml/com/ibm/ipzvpd/README.md (revision 9b664e95f79a66b515e360bf3cdce13e42d818ef)
1b1b4d261SWilliam A. Kennington III# IPZ VPD D-Bus Interfaces
2388b58f9SPatrick Williams
3a1347418SPatrick WilliamsIPZ is a VPD (Vital Product Data) format used in IBM Power systems. The format
4a1347418SPatrick Williamsconsists of keywords that are stored as key-value pairs (Keyword name and its
5a1347418SPatrick Williamsvalue). Keywords are grouped into records, usually with similar function grouped
6a1347418SPatrick Williamsinto a single record.
7b1b4d261SWilliam A. Kennington III
8a1347418SPatrick WilliamsThe [OpenPower VPD][1] format is quite similar to the IPZ format and describes
9a1347418SPatrick Williamsthe record-keyword structure.
10b1b4d261SWilliam A. Kennington III
11*9b664e95SPatrick WilliamsAlso refer to the [VPD Collection design document][2] that describes how the VPD
12*9b664e95SPatrick Williamscollection application on the BMC will parse and publish the VPD data for IBM
13*9b664e95SPatrick WilliamsPower systems on D-Bus.
14b1b4d261SWilliam A. Kennington III
15b1b4d261SWilliam A. Kennington IIIThe D-Bus interfaces defined here describe how IPZ VPD will be made available on
16b1b4d261SWilliam A. Kennington IIID-Bus. Each YAML here represents a record in the IPZ VPD and keywords that
17a1347418SPatrick Williamsbelong to that record are represented as properties under that interface. The
18a1347418SPatrick Williamstype of every property shall be a byte array.
19b1b4d261SWilliam A. Kennington III
20a1347418SPatrick Williams[1]:
21a1347418SPatrick Williams  https://www-355.ibm.com/systems/power/openpower/posting.xhtml?postingId=1D060729AC96891885257E1B0053BC95
22b1b4d261SWilliam A. Kennington III[2]: https://github.com/openbmc/docs/blob/master/designs/vpd-collection.md
23