blob: c3d4c03fe0e47f6bd7bcd0a959c0e23f9694bceb [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;
SunnySrivastava1984945a02d2020-05-06 01:55:41 -050078
jinuthomas6555e7e2023-02-14 21:48:00 -060079static constexpr auto SPD_BYTE_2 = 2;
80static constexpr auto SPD_BYTE_3 = 3;
81static constexpr auto SPD_BYTE_4 = 4;
82static constexpr auto SPD_BYTE_6 = 6;
83static constexpr auto SPD_BYTE_12 = 12;
84static constexpr auto SPD_BYTE_13 = 13;
jinuthomas680960e2023-05-17 05:58:50 -050085static constexpr auto SPD_BYTE_18 = 18;
jinuthomas6555e7e2023-02-14 21:48:00 -060086static constexpr auto SPD_BYTE_BIT_0_3_MASK = 0x0F;
87static constexpr auto SPD_BYTE_MASK = 0xFF;
88
89static constexpr auto SPD_MODULE_TYPE_DDIMM = 0x0A;
90static constexpr auto SPD_DRAM_TYPE_DDR5 = 0x12;
91static constexpr auto SPD_DRAM_TYPE_DDR4 = 0x0C;
92
SunnySrivastava1984945a02d2020-05-06 01:55:41 -050093constexpr auto pimPath = "/xyz/openbmc_project/inventory";
94constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager";
SunnySrivastava1984e12b1812020-05-26 02:23:11 -050095constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
96constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI";
97constexpr auto ipzVpdInf = "com.ibm.ipzvpd.";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -050098constexpr auto offsetJsonDirectory = "/var/lib/vpd/";
99constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper";
100constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper";
101constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500102constexpr auto loggerService = "xyz.openbmc_project.Logging";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500103constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging";
104constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600105constexpr auto errIntfForVPDDefault = "com.ibm.VPD.Error.DefaultValue";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500106constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600107constexpr auto errIntfForVPDMismatch = "com.ibm.VPD.Error.Mismatch";
Kantesh Nagaradder38ee9c82023-04-07 00:58:12 -0500108constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InvalidEepromPath";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500109constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed";
110constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson";
111constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure";
Alpana Kumariab1e22c2021-11-24 11:03:38 -0600112constexpr auto errIntfForInvalidSystemType =
113 "com.ibm.VPD.Error.UnknownSytemType";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500114constexpr auto errIntfForEssentialFru = "com.ibm.VPD.Error.RequiredFRUMissing";
Alpana Kumari6bd095f2022-02-23 10:20:20 -0600115constexpr auto errIntfForGpioError = "com.ibm.VPD.Error.GPIOError";
SunnySrivastava19849094d4f2020-08-05 09:32:29 -0500116constexpr auto motherBoardInterface =
117 "xyz.openbmc_project.Inventory.Item.Board.Motherboard";
jinuthomasf457a3e2023-04-13 12:22:48 -0500118constexpr auto systemVpdFilePath = "/sys/bus/i2c/drivers/at24/8-0050/eeprom";
119constexpr auto i2cPathPrefix = "/sys/bus/i2c/drivers/";
120constexpr auto spiPathPrefix = "/sys/bus/spi/drivers/";
121constexpr auto at24driver = "at24";
122constexpr auto at25driver = "at25";
123constexpr auto ee1004driver = "ee1004";
Priyanga Ramasamy4170bda2023-07-19 09:25:36 +0000124constexpr auto invItemIntf = "xyz.openbmc_project.Inventory.Item";
125static constexpr std::uintmax_t MAX_VPD_SIZE = 65504;
PriyangaRamasamy647868e2020-09-08 17:03:19 +0530126
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600127namespace lengths
128{
129enum Lengths
130{
131 RECORD_NAME = 4,
132 KW_NAME = 2,
133 RECORD_OFFSET = 2,
134 RECORD_MIN = 44,
135 RECORD_LENGTH = 2,
136 RECORD_ECC_OFFSET = 2,
137 VHDR_ECC_LENGTH = 11,
138 VHDR_RECORD_LENGTH = 44
139}; // enum Lengths
140} // namespace lengths
141
142namespace offsets
143{
144enum Offsets
145{
146 VHDR = 17,
147 VHDR_TOC_ENTRY = 29,
148 VTOC_PTR = 35,
SunnySrivastava1984f6d541e2020-02-04 12:50:40 -0600149 VTOC_REC_LEN = 37,
150 VTOC_ECC_OFF = 39,
151 VTOC_ECC_LEN = 41,
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600152 VTOC_DATA = 13,
153 VHDR_ECC = 0,
154 VHDR_RECORD = 11
155};
156} // namespace offsets
157
158namespace eccStatus
159{
160enum Status
161{
162 SUCCESS = 0,
163 FAILED = -1
164};
165} // namespace eccStatus
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500166
167/**
168 * @brief Types of VPD
169 */
170enum vpdType
171{
jinuthomas6555e7e2023-02-14 21:48:00 -0600172 IPZ_VPD, /**< IPZ VPD type */
173 KEYWORD_VPD, /**< Keyword VPD type */
174 DDR4_DDIMM_MEMORY_VPD, /**< DDR4 DDIMM Memory VPD type */
175 DDR5_DDIMM_MEMORY_VPD, /**< DDR5 DDIMM Memory VPD type */
176 DDR4_ISDIMM_MEMORY_VPD, /**< DDR4 ISDIMM Memory VPD type */
177 DDR5_ISDIMM_MEMORY_VPD, /**< DDR5 ISDIMM Memory VPD type */
jinuthomasf457a3e2023-04-13 12:22:48 -0500178 INVALID_VPD_FORMAT /**< Invalid VPD type Format */
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500179};
Sunny Srivastava0746eee2021-03-22 13:36:54 -0500180
181enum PelSeverity
182{
183 NOTICE,
184 INFORMATIONAL,
185 DEBUG,
186 WARNING,
187 CRITICAL,
188 EMERGENCY,
189 ALERT,
190 ERROR
191};
192
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600193} // namespace constants
194} // namespace vpd
195} // namespace openpower