xref: /openbmc/openpower-vpd-parser/const.hpp (revision 6c71c9dcbf9e56a6ae44525b11ca4e4a92b5ab5e)
1 #pragma once
2 
3 #include <iostream>
4 
5 namespace openpower
6 {
7 namespace vpd
8 {
9 namespace constants
10 {
11 
12 using RecordId = uint8_t;
13 using RecordOffset = uint16_t;
14 using RecordSize = uint16_t;
15 using RecordType = uint16_t;
16 using RecordLength = uint16_t;
17 using KwSize = uint8_t;
18 using PoundKwSize = uint16_t;
19 using ECCOffset = uint16_t;
20 using ECCLength = uint16_t;
21 using LE2ByteData = uint16_t;
22 using DataOffset = uint16_t;
23 
24 static constexpr auto NEXT_64_KB = 65536;
25 static constexpr auto MAC_ADDRESS_LEN_BYTES = 6;
26 static constexpr auto LAST_KW = "PF";
27 static constexpr auto POUND_KW = '#';
28 static constexpr auto UUID_LEN_BYTES = 16;
29 static constexpr auto UUID_TIME_LOW_END = 8;
30 static constexpr auto UUID_TIME_MID_END = 13;
31 static constexpr auto UUID_TIME_HIGH_END = 18;
32 static constexpr auto UUID_CLK_SEQ_END = 23;
33 
34 static constexpr auto MB_RESULT_LEN = 19;
35 static constexpr auto MB_LEN_BYTES = 8;
36 static constexpr auto MB_YEAR_END = 4;
37 static constexpr auto MB_MONTH_END = 7;
38 static constexpr auto MB_DAY_END = 10;
39 static constexpr auto MB_HOUR_END = 13;
40 static constexpr auto MB_MIN_END = 16;
41 static constexpr auto SYSTEM_OBJECT = "/system/chassis/motherboard";
42 static constexpr auto LOCATION_CODE_INF = "com.ibm.ipzvpd.Location";
43 constexpr int IPZ_DATA_START = 11;
44 constexpr uint8_t KW_VAL_PAIR_START_TAG = 0x84;
45 constexpr uint8_t RECORD_END_TAG = 0x78;
46 constexpr int UNEXP_LOCATION_CODE_MIN_LENGTH = 4;
47 constexpr uint8_t EXP_LOCATIN_CODE_MIN_LENGTH = 17;
48 static constexpr auto SE_KWD_LENGTH = 7;
49 static constexpr auto INVALID_NODE_NUMBER = -1;
50 static constexpr auto RAINIER_2U = "50001001";
51 static constexpr auto RAINIER_4U = "50001000";
52 static constexpr auto RAINIER_1S4U = "50001002";
53 static constexpr auto EVEREST = "50003000";
54 
55 constexpr uint8_t KW_VPD_START_TAG = 0x82;
56 constexpr uint8_t KW_VPD_END_TAG = 0x78;
57 constexpr uint8_t ALT_KW_VAL_PAIR_START_TAG = 0x90;
58 constexpr uint8_t KW_VAL_PAIR_END_TAG = 0x79;
59 constexpr auto MEMORY_VPD_START_TAG = "11S";
60 constexpr int TWO_BYTES = 2;
61 constexpr int KW_VPD_DATA_START = 0;
62 constexpr auto MEMORY_VPD_DATA_START = 416;
63 constexpr auto FORMAT_11S_LEN = 3;
64 static constexpr auto PART_NUM_LEN = 7;
65 static constexpr auto SERIAL_NUM_LEN = 12;
66 static constexpr auto CCIN_LEN = 4;
67 
68 using namespace std::string_literals;
69 constexpr auto pimPath = "/xyz/openbmc_project/inventory";
70 constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager";
71 constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
72 constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI";
73 constexpr auto ipzVpdInf = "com.ibm.ipzvpd.";
74 constexpr auto offsetJsonDirectory = "/var/lib/vpd/";
75 constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper";
76 constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper";
77 constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper";
78 constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging";
79 constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create";
80 constexpr auto errIntfForBlankSystemVPD = "com.ibm.VPD.Error.BlankSystemVPD";
81 constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD";
82 constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InavlidEepromPath";
83 constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed";
84 constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson";
85 constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure";
86 constexpr auto motherBoardInterface =
87     "xyz.openbmc_project.Inventory.Item.Board.Motherboard";
88 
89 namespace lengths
90 {
91 enum Lengths
92 {
93     RECORD_NAME = 4,
94     KW_NAME = 2,
95     RECORD_OFFSET = 2,
96     RECORD_MIN = 44,
97     RECORD_LENGTH = 2,
98     RECORD_ECC_OFFSET = 2,
99     VHDR_ECC_LENGTH = 11,
100     VHDR_RECORD_LENGTH = 44
101 }; // enum Lengths
102 } // namespace lengths
103 
104 namespace offsets
105 {
106 enum Offsets
107 {
108     VHDR = 17,
109     VHDR_TOC_ENTRY = 29,
110     VTOC_PTR = 35,
111     VTOC_REC_LEN = 37,
112     VTOC_ECC_OFF = 39,
113     VTOC_ECC_LEN = 41,
114     VTOC_DATA = 13,
115     VHDR_ECC = 0,
116     VHDR_RECORD = 11
117 };
118 } // namespace offsets
119 
120 namespace eccStatus
121 {
122 enum Status
123 {
124     SUCCESS = 0,
125     FAILED = -1
126 };
127 } // namespace eccStatus
128 
129 /**
130  * @brief Types of VPD
131  */
132 enum vpdType
133 {
134     IPZ_VPD,           /**< IPZ VPD type */
135     KEYWORD_VPD,       /**< Keyword VPD type */
136     MEMORY_VPD,        /**< Memory VPD type */
137     INVALID_VPD_FORMAT /**< Invalid VPD type */
138 };
139 } // namespace constants
140 } // namespace vpd
141 } // namespace openpower
142