blob: 86adcb818effe4514fa093b41e52cf8bd6a89440 [file] [log] [blame]
SunnySrivastava198419be6d32020-03-03 07:21:45 -06001#pragma once
2
Patrick Williams9cf56ee2023-05-26 15:09:01 -05003#include <cstdint>
Priyanga Ramasamy4170bda2023-07-19 09:25:36 +00004#include <filesystem>
SunnySrivastava198419be6d32020-03-03 07:21:45 -06005#include <iostream>
6
7namespace openpower
8{
9namespace vpd
10{
11namespace constants
12{
13
14using RecordId = uint8_t;
15using RecordOffset = uint16_t;
16using RecordSize = uint16_t;
17using RecordType = uint16_t;
18using RecordLength = uint16_t;
19using KwSize = uint8_t;
20using PoundKwSize = uint16_t;
21using ECCOffset = uint16_t;
22using ECCLength = uint16_t;
23using LE2ByteData = uint16_t;
SunnySrivastava19846d8314d2020-05-15 09:34:58 -050024using DataOffset = uint16_t;
SunnySrivastava198419be6d32020-03-03 07:21:45 -060025
Alpana Kumari58e22142020-05-05 00:22:12 -050026static constexpr auto NEXT_64_KB = 65536;
SunnySrivastava198419be6d32020-03-03 07:21:45 -060027static constexpr auto MAC_ADDRESS_LEN_BYTES = 6;
28static constexpr auto LAST_KW = "PF";
29static constexpr auto POUND_KW = '#';
Priyanga Ramasamy5629fbc2023-03-01 08:17:19 -060030static constexpr auto POUND_KW_PREFIX = "PD_";
31static constexpr auto NUMERIC_KW_PREFIX = "N_";
SunnySrivastava198419be6d32020-03-03 07:21:45 -060032static constexpr auto UUID_LEN_BYTES = 16;
33static constexpr auto UUID_TIME_LOW_END = 8;
34static constexpr auto UUID_TIME_MID_END = 13;
35static constexpr auto UUID_TIME_HIGH_END = 18;
36static constexpr auto UUID_CLK_SEQ_END = 23;
37
38static constexpr auto MB_RESULT_LEN = 19;
39static constexpr auto MB_LEN_BYTES = 8;
40static constexpr auto MB_YEAR_END = 4;
41static constexpr auto MB_MONTH_END = 7;
42static constexpr auto MB_DAY_END = 10;
43static constexpr auto MB_HOUR_END = 13;
44static constexpr auto MB_MIN_END = 16;
SunnySrivastava198443306542020-04-01 02:50:20 -050045static constexpr auto SYSTEM_OBJECT = "/system/chassis/motherboard";
Alpana Kumari414d5ae2021-03-04 21:06:35 +000046static constexpr auto IBM_LOCATION_CODE_INF = "com.ibm.ipzvpd.Location";
47static constexpr auto XYZ_LOCATION_CODE_INF =
48 "xyz.openbmc_project.Inventory.Decorator.LocationCode";
SunnySrivastava198419be6d32020-03-03 07:21:45 -060049constexpr int IPZ_DATA_START = 11;
50constexpr uint8_t KW_VAL_PAIR_START_TAG = 0x84;
51constexpr uint8_t RECORD_END_TAG = 0x78;
SunnySrivastava1984bca5aaa2020-04-21 05:31:04 -050052constexpr int UNEXP_LOCATION_CODE_MIN_LENGTH = 4;
SunnySrivastava1984fb5815a2020-04-24 08:03:52 -050053constexpr uint8_t EXP_LOCATIN_CODE_MIN_LENGTH = 17;
54static constexpr auto SE_KWD_LENGTH = 7;
55static constexpr auto INVALID_NODE_NUMBER = -1;
Santosh Puranike5f177a2022-01-24 20:14:46 +053056static constexpr auto RAINIER_2U = "50001001.json";
57static constexpr auto RAINIER_2U_V2 = "50001001_v2.json";
58static constexpr auto RAINIER_4U = "50001000.json";
59static constexpr auto RAINIER_4U_V2 = "50001000_v2.json";
60static constexpr auto RAINIER_1S4U = "50001002.json";
61static constexpr auto EVEREST = "50003000.json";
Alpana Kumari1b026112022-03-02 23:41:38 -060062static constexpr auto EVEREST_V2 = "50003000_v2.json";
Santosh Puranikdedb5a62022-12-19 23:58:32 +053063static constexpr auto BONNELL = "50004000.json";
SunnySrivastava198419be6d32020-03-03 07:21:45 -060064
SunnySrivastava1984945a02d2020-05-06 01:55:41 -050065constexpr uint8_t KW_VPD_START_TAG = 0x82;
66constexpr uint8_t KW_VPD_END_TAG = 0x78;
67constexpr uint8_t ALT_KW_VAL_PAIR_START_TAG = 0x90;
68constexpr uint8_t KW_VAL_PAIR_END_TAG = 0x79;
69constexpr auto MEMORY_VPD_START_TAG = "11S";
70constexpr int TWO_BYTES = 2;
71constexpr int KW_VPD_DATA_START = 0;
72constexpr auto MEMORY_VPD_DATA_START = 416;
73constexpr auto FORMAT_11S_LEN = 3;
74static constexpr auto PART_NUM_LEN = 7;
75static constexpr auto SERIAL_NUM_LEN = 12;
76static constexpr auto CCIN_LEN = 4;
Alpana Kumari3ab26a72021-04-05 19:09:19 +000077static constexpr auto CONVERT_MB_TO_KB = 1024;
Jinu Joy Thomas60c68e02024-02-05 22:07:32 -060078static constexpr auto CONVERT_GB_TO_KB = 1024 * 1024;
SunnySrivastava1984945a02d2020-05-06 01:55:41 -050079
jinuthomas6555e7e2023-02-14 21:48:00 -060080static constexpr auto SPD_BYTE_2 = 2;
81static constexpr auto SPD_BYTE_3 = 3;
82static constexpr auto SPD_BYTE_4 = 4;
83static constexpr auto SPD_BYTE_6 = 6;
84static constexpr auto SPD_BYTE_12 = 12;
85static constexpr auto SPD_BYTE_13 = 13;
jinuthomas680960e2023-05-17 05:58:50 -050086static constexpr auto SPD_BYTE_18 = 18;
Jinu Joy Thomasdb43bcd2023-08-17 09:40:16 +053087static constexpr auto SPD_BYTE_234 = 234;
88static constexpr auto SPD_BYTE_235 = 235;
jinuthomas6555e7e2023-02-14 21:48:00 -060089static constexpr auto SPD_BYTE_BIT_0_3_MASK = 0x0F;
90static constexpr auto SPD_BYTE_MASK = 0xFF;
91
Jinu Joy Thomasdb43bcd2023-08-17 09:40:16 +053092static constexpr auto VALUE_0 = 0;
93static constexpr auto VALUE_1 = 1;
94static constexpr auto VALUE_2 = 2;
95static constexpr auto VALUE_3 = 3;
96static constexpr auto VALUE_4 = 4;
97static constexpr auto VALUE_5 = 5;
98static constexpr auto VALUE_6 = 6;
99static constexpr auto VALUE_7 = 7;
100static constexpr auto VALUE_8 = 8;
Sunny Srivastava4788e1b2024-03-19 02:11:07 -0500101static constexpr auto VALUE_10 = 10;
102static constexpr auto VALUE_100000 = 100000;
Jinu Joy Thomasdb43bcd2023-08-17 09:40:16 +0530103
Jinu Joy Thomasd7a6dec2024-02-19 01:10:29 -0600104static constexpr auto MASK_BYTE_BITS_6 = 0x40;
105static constexpr auto MASK_BYTE_BITS_7 = 0x80;
Jinu Joy Thomasdb43bcd2023-08-17 09:40:16 +0530106static constexpr auto MASK_BYTE_BITS_01 = 0x03;
107static constexpr auto MASK_BYTE_BITS_345 = 0x38;
108static constexpr auto MASK_BYTE_BITS_012 = 0x07;
109static constexpr auto MASK_BYTE_BITS_567 = 0xE0;
110static constexpr auto MASK_BYTE_BITS_0123 = 0x0F;
111static constexpr auto MASK_BYTE_BITS_01234 = 0x1F;
112
113static constexpr auto SHIFT_BITS_0 = 0;
114static constexpr auto SHIFT_BITS_3 = 3;
115static constexpr auto SHIFT_BITS_5 = 5;
116
jinuthomas6555e7e2023-02-14 21:48:00 -0600117static constexpr auto SPD_MODULE_TYPE_DDIMM = 0x0A;
118static constexpr auto SPD_DRAM_TYPE_DDR5 = 0x12;
119static constexpr auto SPD_DRAM_TYPE_DDR4 = 0x0C;
120
SunnySrivastava1984945a02d2020-05-06 01:55:41 -0500121constexpr auto pimPath = "/xyz/openbmc_project/inventory";
122constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager";
Sunny Srivastavac6e7ea92023-11-03 21:10:43 +0530123constexpr auto pimService = "xyz.openbmc_project.Inventory.Manager";
SunnySrivastava1984e12b1812020-05-26 02:23:11 -0500124constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
125constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI";
126constexpr auto ipzVpdInf = "com.ibm.ipzvpd.";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500127constexpr auto offsetJsonDirectory = "/var/lib/vpd/";
128constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper";
129constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper";
130constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500131constexpr auto loggerService = "xyz.openbmc_project.Logging";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500132constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging";
133constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600134constexpr auto errIntfForVPDDefault = "com.ibm.VPD.Error.DefaultValue";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500135constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600136constexpr auto errIntfForVPDMismatch = "com.ibm.VPD.Error.Mismatch";
Kantesh Nagaradder38ee9c82023-04-07 00:58:12 -0500137constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InvalidEepromPath";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500138constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed";
139constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson";
140constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure";
Alpana Kumariab1e22c2021-11-24 11:03:38 -0600141constexpr auto errIntfForInvalidSystemType =
142 "com.ibm.VPD.Error.UnknownSytemType";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500143constexpr auto errIntfForEssentialFru = "com.ibm.VPD.Error.RequiredFRUMissing";
Alpana Kumari6bd095f2022-02-23 10:20:20 -0600144constexpr auto errIntfForGpioError = "com.ibm.VPD.Error.GPIOError";
SunnySrivastava19849094d4f2020-08-05 09:32:29 -0500145constexpr auto motherBoardInterface =
146 "xyz.openbmc_project.Inventory.Item.Board.Motherboard";
jinuthomasf457a3e2023-04-13 12:22:48 -0500147constexpr auto systemVpdFilePath = "/sys/bus/i2c/drivers/at24/8-0050/eeprom";
148constexpr auto i2cPathPrefix = "/sys/bus/i2c/drivers/";
149constexpr auto spiPathPrefix = "/sys/bus/spi/drivers/";
150constexpr auto at24driver = "at24";
151constexpr auto at25driver = "at25";
152constexpr auto ee1004driver = "ee1004";
Priyanga Ramasamy4170bda2023-07-19 09:25:36 +0000153constexpr auto invItemIntf = "xyz.openbmc_project.Inventory.Item";
Sunny Srivastavac6e7ea92023-11-03 21:10:43 +0530154constexpr auto invAssetIntf = "xyz.openbmc_project.Inventory.Decorator.Asset";
155constexpr auto invOperationalStatusIntf =
156 "xyz.openbmc_project.State.Decorator.OperationalStatus";
Priyanga Ramasamy4170bda2023-07-19 09:25:36 +0000157static constexpr std::uintmax_t MAX_VPD_SIZE = 65504;
PriyangaRamasamy647868e2020-09-08 17:03:19 +0530158
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600159namespace lengths
160{
161enum Lengths
162{
163 RECORD_NAME = 4,
164 KW_NAME = 2,
165 RECORD_OFFSET = 2,
166 RECORD_MIN = 44,
167 RECORD_LENGTH = 2,
168 RECORD_ECC_OFFSET = 2,
169 VHDR_ECC_LENGTH = 11,
170 VHDR_RECORD_LENGTH = 44
171}; // enum Lengths
172} // namespace lengths
173
174namespace offsets
175{
176enum Offsets
177{
178 VHDR = 17,
179 VHDR_TOC_ENTRY = 29,
180 VTOC_PTR = 35,
SunnySrivastava1984f6d541e2020-02-04 12:50:40 -0600181 VTOC_REC_LEN = 37,
182 VTOC_ECC_OFF = 39,
183 VTOC_ECC_LEN = 41,
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600184 VTOC_DATA = 13,
185 VHDR_ECC = 0,
186 VHDR_RECORD = 11
187};
188} // namespace offsets
189
190namespace eccStatus
191{
192enum Status
193{
194 SUCCESS = 0,
195 FAILED = -1
196};
197} // namespace eccStatus
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500198
199/**
200 * @brief Types of VPD
201 */
202enum vpdType
203{
jinuthomas6555e7e2023-02-14 21:48:00 -0600204 IPZ_VPD, /**< IPZ VPD type */
205 KEYWORD_VPD, /**< Keyword VPD type */
206 DDR4_DDIMM_MEMORY_VPD, /**< DDR4 DDIMM Memory VPD type */
207 DDR5_DDIMM_MEMORY_VPD, /**< DDR5 DDIMM Memory VPD type */
208 DDR4_ISDIMM_MEMORY_VPD, /**< DDR4 ISDIMM Memory VPD type */
209 DDR5_ISDIMM_MEMORY_VPD, /**< DDR5 ISDIMM Memory VPD type */
jinuthomasf457a3e2023-04-13 12:22:48 -0500210 INVALID_VPD_FORMAT /**< Invalid VPD type Format */
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500211};
Sunny Srivastava0746eee2021-03-22 13:36:54 -0500212
213enum PelSeverity
214{
215 NOTICE,
216 INFORMATIONAL,
217 DEBUG,
218 WARNING,
219 CRITICAL,
220 EMERGENCY,
221 ALERT,
222 ERROR
223};
224
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600225} // namespace constants
226} // namespace vpd
227} // namespace openpower