xref: /openbmc/openpower-vpd-parser/const.hpp (revision 735dee9b9c2aa84aa43459002a67f56c47b0d69d)
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 IBM_LOCATION_CODE_INF = "com.ibm.ipzvpd.Location";
43 static constexpr auto XYZ_LOCATION_CODE_INF =
44     "xyz.openbmc_project.Inventory.Decorator.LocationCode";
45 constexpr int IPZ_DATA_START = 11;
46 constexpr uint8_t KW_VAL_PAIR_START_TAG = 0x84;
47 constexpr uint8_t RECORD_END_TAG = 0x78;
48 constexpr int UNEXP_LOCATION_CODE_MIN_LENGTH = 4;
49 constexpr uint8_t EXP_LOCATIN_CODE_MIN_LENGTH = 17;
50 static constexpr auto SE_KWD_LENGTH = 7;
51 static constexpr auto INVALID_NODE_NUMBER = -1;
52 static constexpr auto RAINIER_2U = "50001001.json";
53 static constexpr auto RAINIER_2U_V2 = "50001001_v2.json";
54 static constexpr auto RAINIER_4U = "50001000.json";
55 static constexpr auto RAINIER_4U_V2 = "50001000_v2.json";
56 static constexpr auto RAINIER_1S4U = "50001002.json";
57 static constexpr auto EVEREST = "50003000.json";
58 
59 constexpr uint8_t KW_VPD_START_TAG = 0x82;
60 constexpr uint8_t KW_VPD_END_TAG = 0x78;
61 constexpr uint8_t ALT_KW_VAL_PAIR_START_TAG = 0x90;
62 constexpr uint8_t KW_VAL_PAIR_END_TAG = 0x79;
63 constexpr auto MEMORY_VPD_START_TAG = "11S";
64 constexpr int TWO_BYTES = 2;
65 constexpr int KW_VPD_DATA_START = 0;
66 constexpr auto MEMORY_VPD_DATA_START = 416;
67 constexpr auto FORMAT_11S_LEN = 3;
68 static constexpr auto PART_NUM_LEN = 7;
69 static constexpr auto SERIAL_NUM_LEN = 12;
70 static constexpr auto CCIN_LEN = 4;
71 static constexpr auto CONVERT_MB_TO_KB = 1024;
72 
73 using namespace std::string_literals;
74 constexpr auto pimPath = "/xyz/openbmc_project/inventory";
75 constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager";
76 constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
77 constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI";
78 constexpr auto ipzVpdInf = "com.ibm.ipzvpd.";
79 constexpr auto offsetJsonDirectory = "/var/lib/vpd/";
80 constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper";
81 constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper";
82 constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper";
83 constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging";
84 constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create";
85 constexpr auto errIntfForBlankSystemVPD = "com.ibm.VPD.Error.BlankSystemVPD";
86 constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD";
87 constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InavlidEepromPath";
88 constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed";
89 constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson";
90 constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure";
91 constexpr auto errIntfForInvalidSystemType =
92     "com.ibm.VPD.Error.UnknownSytemType";
93 constexpr auto motherBoardInterface =
94     "xyz.openbmc_project.Inventory.Item.Board.Motherboard";
95 constexpr auto systemVpdFilePath = "/sys/bus/i2c/drivers/at24/8-0050/eeprom";
96 constexpr auto i2cPathPrefix = "/sys/bus/i2c/drivers/at24/";
97 constexpr auto spiPathPrefix = "/sys/bus/spi/drivers/at25/";
98 constexpr auto invItemIntf = "xyz.openbmc_project.Inventory.Item";
99 
100 namespace lengths
101 {
102 enum Lengths
103 {
104     RECORD_NAME = 4,
105     KW_NAME = 2,
106     RECORD_OFFSET = 2,
107     RECORD_MIN = 44,
108     RECORD_LENGTH = 2,
109     RECORD_ECC_OFFSET = 2,
110     VHDR_ECC_LENGTH = 11,
111     VHDR_RECORD_LENGTH = 44
112 }; // enum Lengths
113 } // namespace lengths
114 
115 namespace offsets
116 {
117 enum Offsets
118 {
119     VHDR = 17,
120     VHDR_TOC_ENTRY = 29,
121     VTOC_PTR = 35,
122     VTOC_REC_LEN = 37,
123     VTOC_ECC_OFF = 39,
124     VTOC_ECC_LEN = 41,
125     VTOC_DATA = 13,
126     VHDR_ECC = 0,
127     VHDR_RECORD = 11
128 };
129 } // namespace offsets
130 
131 namespace eccStatus
132 {
133 enum Status
134 {
135     SUCCESS = 0,
136     FAILED = -1
137 };
138 } // namespace eccStatus
139 
140 /**
141  * @brief Types of VPD
142  */
143 enum vpdType
144 {
145     IPZ_VPD,           /**< IPZ VPD type */
146     KEYWORD_VPD,       /**< Keyword VPD type */
147     MEMORY_VPD,        /**< Memory VPD type */
148     INVALID_VPD_FORMAT /**< Invalid VPD type */
149 };
150 
151 enum PelSeverity
152 {
153     NOTICE,
154     INFORMATIONAL,
155     DEBUG,
156     WARNING,
157     CRITICAL,
158     EMERGENCY,
159     ALERT,
160     ERROR
161 };
162 
163 } // namespace constants
164 } // namespace vpd
165 } // namespace openpower
166