Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 4be52ac62b6cf38b57c309c6534fda48c44d811e / . / const.hpp
blob: 7a2907d0c08e80a7db1f4e98913067b26af20f62 [file] [log] [blame]
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]1#pragma once
2
Patrick Williams9cf56ee2023-05-26 15:09:01 -0500[diff] [blame]3#include <cstdint>
Priyanga Ramasamy4170bda2023-07-19 09:25:36 +0000[diff] [blame]4#include <filesystem>
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]5#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 -0500[diff] [blame]24using DataOffset = uint16_t;
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]25
Alpana Kumari58e22142020-05-05 00:22:12 -0500[diff] [blame]26static constexpr auto NEXT_64_KB = 65536;
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]27static 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 -0600[diff] [blame]30static constexpr auto POUND_KW_PREFIX = "PD_";
31static constexpr auto NUMERIC_KW_PREFIX = "N_";
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]32static 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 -0500[diff] [blame]45static constexpr auto SYSTEM_OBJECT = "/system/chassis/motherboard";
Alpana Kumari414d5ae2021-03-04 21:06:35 +0000[diff] [blame]46static 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 -0600[diff] [blame]49constexpr 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 -0500[diff] [blame]52constexpr int UNEXP_LOCATION_CODE_MIN_LENGTH = 4;
SunnySrivastava1984fb5815a2020-04-24 08:03:52 -0500[diff] [blame]53constexpr 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 +0530[diff] [blame]56static 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 -0600[diff] [blame]62static constexpr auto EVEREST_V2 = "50003000_v2.json";
Santosh Puranikdedb5a62022-12-19 23:58:32 +0530[diff] [blame]63static constexpr auto BONNELL = "50004000.json";
Jinu Joy Thomas3b61ff52024-07-18 23:24:01 -0500[diff] [blame]64static constexpr auto BLUERIDGE_2U = "60001001.json";
65static constexpr auto BLUERIDGE_2U_V2 = "60001001_v2.json";
66static constexpr auto BLUERIDGE_4U = "60001000.json";
67static constexpr auto BLUERIDGE_4U_V2 = "60001000_v2.json";
68static constexpr auto BLUERIDGE_1S4U = "60001002.json";
69static constexpr auto FUJI = "60002000.json";
70static constexpr auto FUJI_V2 = "60002000_v2.json";
Jinu Joy Thomasc023f9b2024-08-25 22:42:34 -0500[diff] [blame]71static constexpr auto HUYGENS = "70001000.json";
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]72
SunnySrivastava1984945a02d2020-05-06 01:55:41 -0500[diff] [blame]73constexpr uint8_t KW_VPD_START_TAG = 0x82;
74constexpr uint8_t KW_VPD_END_TAG = 0x78;
75constexpr uint8_t ALT_KW_VAL_PAIR_START_TAG = 0x90;
76constexpr uint8_t KW_VAL_PAIR_END_TAG = 0x79;
77constexpr auto MEMORY_VPD_START_TAG = "11S";
78constexpr int TWO_BYTES = 2;
79constexpr int KW_VPD_DATA_START = 0;
80constexpr auto MEMORY_VPD_DATA_START = 416;
81constexpr auto FORMAT_11S_LEN = 3;
82static constexpr auto PART_NUM_LEN = 7;
83static constexpr auto SERIAL_NUM_LEN = 12;
84static constexpr auto CCIN_LEN = 4;
Alpana Kumari3ab26a72021-04-05 19:09:19 +0000[diff] [blame]85static constexpr auto CONVERT_MB_TO_KB = 1024;
Jinu Joy Thomas60c68e02024-02-05 22:07:32 -0600[diff] [blame]86static constexpr auto CONVERT_GB_TO_KB = 1024 * 1024;
SunnySrivastava1984945a02d2020-05-06 01:55:41 -0500[diff] [blame]87
jinuthomas6555e7e2023-02-14 21:48:00 -0600[diff] [blame]88static constexpr auto SPD_BYTE_2 = 2;
89static constexpr auto SPD_BYTE_3 = 3;
90static constexpr auto SPD_BYTE_4 = 4;
91static constexpr auto SPD_BYTE_6 = 6;
92static constexpr auto SPD_BYTE_12 = 12;
93static constexpr auto SPD_BYTE_13 = 13;
jinuthomas680960e2023-05-17 05:58:50 -0500[diff] [blame]94static constexpr auto SPD_BYTE_18 = 18;
Jinu Joy Thomasdb43bcd2023-08-17 09:40:16 +0530[diff] [blame]95static constexpr auto SPD_BYTE_234 = 234;
96static constexpr auto SPD_BYTE_235 = 235;
jinuthomas6555e7e2023-02-14 21:48:00 -0600[diff] [blame]97static constexpr auto SPD_BYTE_BIT_0_3_MASK = 0x0F;
98static constexpr auto SPD_BYTE_MASK = 0xFF;
99
Jinu Joy Thomasdb43bcd2023-08-17 09:40:16 +0530[diff] [blame]100static constexpr auto VALUE_0 = 0;
101static constexpr auto VALUE_1 = 1;
102static constexpr auto VALUE_2 = 2;
103static constexpr auto VALUE_3 = 3;
104static constexpr auto VALUE_4 = 4;
105static constexpr auto VALUE_5 = 5;
106static constexpr auto VALUE_6 = 6;
107static constexpr auto VALUE_7 = 7;
108static constexpr auto VALUE_8 = 8;
Sunny Srivastava4788e1b2024-03-19 02:11:07 -0500[diff] [blame]109static constexpr auto VALUE_10 = 10;
110static constexpr auto VALUE_100000 = 100000;
Jinu Joy Thomasdb43bcd2023-08-17 09:40:16 +0530[diff] [blame]111
Jinu Joy Thomasd7a6dec2024-02-19 01:10:29 -0600[diff] [blame]112static constexpr auto MASK_BYTE_BITS_6 = 0x40;
113static constexpr auto MASK_BYTE_BITS_7 = 0x80;
Jinu Joy Thomasdb43bcd2023-08-17 09:40:16 +0530[diff] [blame]114static constexpr auto MASK_BYTE_BITS_01 = 0x03;
115static constexpr auto MASK_BYTE_BITS_345 = 0x38;
116static constexpr auto MASK_BYTE_BITS_012 = 0x07;
117static constexpr auto MASK_BYTE_BITS_567 = 0xE0;
118static constexpr auto MASK_BYTE_BITS_0123 = 0x0F;
119static constexpr auto MASK_BYTE_BITS_01234 = 0x1F;
120
121static constexpr auto SHIFT_BITS_0 = 0;
122static constexpr auto SHIFT_BITS_3 = 3;
123static constexpr auto SHIFT_BITS_5 = 5;
124
jinuthomas6555e7e2023-02-14 21:48:00 -0600[diff] [blame]125static constexpr auto SPD_MODULE_TYPE_DDIMM = 0x0A;
126static constexpr auto SPD_DRAM_TYPE_DDR5 = 0x12;
127static constexpr auto SPD_DRAM_TYPE_DDR4 = 0x0C;
128
SunnySrivastava1984945a02d2020-05-06 01:55:41 -0500[diff] [blame]129constexpr auto pimPath = "/xyz/openbmc_project/inventory";
130constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager";
Sunny Srivastavac6e7ea92023-11-03 21:10:43 +0530[diff] [blame]131constexpr auto pimService = "xyz.openbmc_project.Inventory.Manager";
SunnySrivastava1984e12b1812020-05-26 02:23:11 -0500[diff] [blame]132constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
133constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI";
134constexpr auto ipzVpdInf = "com.ibm.ipzvpd.";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500[diff] [blame]135constexpr auto offsetJsonDirectory = "/var/lib/vpd/";
136constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper";
137constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper";
138constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500[diff] [blame]139constexpr auto loggerService = "xyz.openbmc_project.Logging";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500[diff] [blame]140constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging";
141constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600[diff] [blame]142constexpr auto errIntfForVPDDefault = "com.ibm.VPD.Error.DefaultValue";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500[diff] [blame]143constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600[diff] [blame]144constexpr auto errIntfForVPDMismatch = "com.ibm.VPD.Error.Mismatch";
Kantesh Nagaradder38ee9c82023-04-07 00:58:12 -0500[diff] [blame]145constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InvalidEepromPath";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500[diff] [blame]146constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed";
147constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson";
148constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure";
Alpana Kumariab1e22c2021-11-24 11:03:38 -0600[diff] [blame]149constexpr auto errIntfForInvalidSystemType =
150 "com.ibm.VPD.Error.UnknownSytemType";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500[diff] [blame]151constexpr auto errIntfForEssentialFru = "com.ibm.VPD.Error.RequiredFRUMissing";
Alpana Kumari6bd095f2022-02-23 10:20:20 -0600[diff] [blame]152constexpr auto errIntfForGpioError = "com.ibm.VPD.Error.GPIOError";
SunnySrivastava19849094d4f2020-08-05 09:32:29 -0500[diff] [blame]153constexpr auto motherBoardInterface =
154 "xyz.openbmc_project.Inventory.Item.Board.Motherboard";
jinuthomasf457a3e2023-04-13 12:22:48 -0500[diff] [blame]155constexpr auto systemVpdFilePath = "/sys/bus/i2c/drivers/at24/8-0050/eeprom";
156constexpr auto i2cPathPrefix = "/sys/bus/i2c/drivers/";
157constexpr auto spiPathPrefix = "/sys/bus/spi/drivers/";
158constexpr auto at24driver = "at24";
159constexpr auto at25driver = "at25";
160constexpr auto ee1004driver = "ee1004";
Priyanga Ramasamy4170bda2023-07-19 09:25:36 +0000[diff] [blame]161constexpr auto invItemIntf = "xyz.openbmc_project.Inventory.Item";
Sunny Srivastavac6e7ea92023-11-03 21:10:43 +0530[diff] [blame]162constexpr auto invAssetIntf = "xyz.openbmc_project.Inventory.Decorator.Asset";
163constexpr auto invOperationalStatusIntf =
164 "xyz.openbmc_project.State.Decorator.OperationalStatus";
Priyanga Ramasamy4170bda2023-07-19 09:25:36 +0000[diff] [blame]165static constexpr std::uintmax_t MAX_VPD_SIZE = 65504;
PriyangaRamasamy647868e2020-09-08 17:03:19 +0530[diff] [blame]166
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]167namespace lengths
168{
169enum Lengths
170{
171 RECORD_NAME = 4,
172 KW_NAME = 2,
173 RECORD_OFFSET = 2,
174 RECORD_MIN = 44,
175 RECORD_LENGTH = 2,
176 RECORD_ECC_OFFSET = 2,
177 VHDR_ECC_LENGTH = 11,
178 VHDR_RECORD_LENGTH = 44
179}; // enum Lengths
180} // namespace lengths
181
182namespace offsets
183{
184enum Offsets
185{
186 VHDR = 17,
187 VHDR_TOC_ENTRY = 29,
188 VTOC_PTR = 35,
SunnySrivastava1984f6d541e2020-02-04 12:50:40 -0600[diff] [blame]189 VTOC_REC_LEN = 37,
190 VTOC_ECC_OFF = 39,
191 VTOC_ECC_LEN = 41,
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]192 VTOC_DATA = 13,
193 VHDR_ECC = 0,
194 VHDR_RECORD = 11
195};
196} // namespace offsets
197
198namespace eccStatus
199{
200enum Status
201{
202 SUCCESS = 0,
203 FAILED = -1
204};
205} // namespace eccStatus
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500[diff] [blame]206
207/**
208 * @brief Types of VPD
209 */
210enum vpdType
211{
jinuthomas6555e7e2023-02-14 21:48:00 -0600[diff] [blame]212 IPZ_VPD, /**< IPZ VPD type */
213 KEYWORD_VPD, /**< Keyword VPD type */
214 DDR4_DDIMM_MEMORY_VPD, /**< DDR4 DDIMM Memory VPD type */
215 DDR5_DDIMM_MEMORY_VPD, /**< DDR5 DDIMM Memory VPD type */
216 DDR4_ISDIMM_MEMORY_VPD, /**< DDR4 ISDIMM Memory VPD type */
217 DDR5_ISDIMM_MEMORY_VPD, /**< DDR5 ISDIMM Memory VPD type */
jinuthomasf457a3e2023-04-13 12:22:48 -0500[diff] [blame]218 INVALID_VPD_FORMAT /**< Invalid VPD type Format */
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500[diff] [blame]219};
Sunny Srivastava0746eee2021-03-22 13:36:54 -0500[diff] [blame]220
221enum PelSeverity
222{
223 NOTICE,
224 INFORMATIONAL,
225 DEBUG,
226 WARNING,
227 CRITICAL,
228 EMERGENCY,
229 ALERT,
230 ERROR
231};
232
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]233} // namespace constants
234} // namespace vpd
235} // namespace openpower