Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openpower-vpd-parser / 051b34fb4923b970041ffb58d84f8359d3423d31 / . / const.hpp
blob: 0c80ba489e16701438e995f4342c79e91b33e264 [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>
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]4#include <iostream>
5
6namespace openpower
7{
8namespace vpd
9{
10namespace constants
11{
12
13using RecordId = uint8_t;
14using RecordOffset = uint16_t;
15using RecordSize = uint16_t;
16using RecordType = uint16_t;
17using RecordLength = uint16_t;
18using KwSize = uint8_t;
19using PoundKwSize = uint16_t;
20using ECCOffset = uint16_t;
21using ECCLength = uint16_t;
22using LE2ByteData = uint16_t;
SunnySrivastava19846d8314d2020-05-15 09:34:58 -0500[diff] [blame]23using DataOffset = uint16_t;
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]24
Alpana Kumari58e22142020-05-05 00:22:12 -0500[diff] [blame]25static constexpr auto NEXT_64_KB = 65536;
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]26static constexpr auto MAC_ADDRESS_LEN_BYTES = 6;
27static constexpr auto LAST_KW = "PF";
28static constexpr auto POUND_KW = '#';
Priyanga Ramasamy5629fbc2023-03-01 08:17:19 -0600[diff] [blame]29static constexpr auto POUND_KW_PREFIX = "PD_";
30static constexpr auto NUMERIC_KW_PREFIX = "N_";
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]31static constexpr auto UUID_LEN_BYTES = 16;
32static constexpr auto UUID_TIME_LOW_END = 8;
33static constexpr auto UUID_TIME_MID_END = 13;
34static constexpr auto UUID_TIME_HIGH_END = 18;
35static constexpr auto UUID_CLK_SEQ_END = 23;
36
37static constexpr auto MB_RESULT_LEN = 19;
38static constexpr auto MB_LEN_BYTES = 8;
39static constexpr auto MB_YEAR_END = 4;
40static constexpr auto MB_MONTH_END = 7;
41static constexpr auto MB_DAY_END = 10;
42static constexpr auto MB_HOUR_END = 13;
43static constexpr auto MB_MIN_END = 16;
SunnySrivastava198443306542020-04-01 02:50:20 -0500[diff] [blame]44static constexpr auto SYSTEM_OBJECT = "/system/chassis/motherboard";
Alpana Kumari414d5ae2021-03-04 21:06:35 +0000[diff] [blame]45static constexpr auto IBM_LOCATION_CODE_INF = "com.ibm.ipzvpd.Location";
46static constexpr auto XYZ_LOCATION_CODE_INF =
47 "xyz.openbmc_project.Inventory.Decorator.LocationCode";
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]48constexpr int IPZ_DATA_START = 11;
49constexpr uint8_t KW_VAL_PAIR_START_TAG = 0x84;
50constexpr uint8_t RECORD_END_TAG = 0x78;
SunnySrivastava1984bca5aaa2020-04-21 05:31:04 -0500[diff] [blame]51constexpr int UNEXP_LOCATION_CODE_MIN_LENGTH = 4;
SunnySrivastava1984fb5815a2020-04-24 08:03:52 -0500[diff] [blame]52constexpr uint8_t EXP_LOCATIN_CODE_MIN_LENGTH = 17;
53static constexpr auto SE_KWD_LENGTH = 7;
54static constexpr auto INVALID_NODE_NUMBER = -1;
Santosh Puranike5f177a2022-01-24 20:14:46 +0530[diff] [blame]55static constexpr auto RAINIER_2U = "50001001.json";
56static constexpr auto RAINIER_2U_V2 = "50001001_v2.json";
57static constexpr auto RAINIER_4U = "50001000.json";
58static constexpr auto RAINIER_4U_V2 = "50001000_v2.json";
59static constexpr auto RAINIER_1S4U = "50001002.json";
60static constexpr auto EVEREST = "50003000.json";
Alpana Kumari1b026112022-03-02 23:41:38 -0600[diff] [blame]61static constexpr auto EVEREST_V2 = "50003000_v2.json";
Santosh Puranikdedb5a62022-12-19 23:58:32 +0530[diff] [blame]62static constexpr auto BONNELL = "50004000.json";
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]63
SunnySrivastava1984945a02d2020-05-06 01:55:41 -0500[diff] [blame]64constexpr uint8_t KW_VPD_START_TAG = 0x82;
65constexpr uint8_t KW_VPD_END_TAG = 0x78;
66constexpr uint8_t ALT_KW_VAL_PAIR_START_TAG = 0x90;
67constexpr uint8_t KW_VAL_PAIR_END_TAG = 0x79;
68constexpr auto MEMORY_VPD_START_TAG = "11S";
69constexpr int TWO_BYTES = 2;
70constexpr int KW_VPD_DATA_START = 0;
71constexpr auto MEMORY_VPD_DATA_START = 416;
72constexpr auto FORMAT_11S_LEN = 3;
73static constexpr auto PART_NUM_LEN = 7;
74static constexpr auto SERIAL_NUM_LEN = 12;
75static constexpr auto CCIN_LEN = 4;
Alpana Kumari3ab26a72021-04-05 19:09:19 +0000[diff] [blame]76static constexpr auto CONVERT_MB_TO_KB = 1024;
SunnySrivastava1984945a02d2020-05-06 01:55:41 -0500[diff] [blame]77
jinuthomas6555e7e2023-02-14 21:48:00 -0600[diff] [blame]78static constexpr auto SPD_BYTE_2 = 2;
79static constexpr auto SPD_BYTE_3 = 3;
80static constexpr auto SPD_BYTE_4 = 4;
81static constexpr auto SPD_BYTE_6 = 6;
82static constexpr auto SPD_BYTE_12 = 12;
83static constexpr auto SPD_BYTE_13 = 13;
jinuthomas680960e2023-05-17 05:58:50 -0500[diff] [blame]84static constexpr auto SPD_BYTE_18 = 18;
jinuthomas6555e7e2023-02-14 21:48:00 -0600[diff] [blame]85static constexpr auto SPD_BYTE_BIT_0_3_MASK = 0x0F;
86static constexpr auto SPD_BYTE_MASK = 0xFF;
87
88static constexpr auto SPD_MODULE_TYPE_DDIMM = 0x0A;
89static constexpr auto SPD_DRAM_TYPE_DDR5 = 0x12;
90static constexpr auto SPD_DRAM_TYPE_DDR4 = 0x0C;
91
SunnySrivastava1984945a02d2020-05-06 01:55:41 -0500[diff] [blame]92constexpr auto pimPath = "/xyz/openbmc_project/inventory";
93constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager";
SunnySrivastava1984e12b1812020-05-26 02:23:11 -0500[diff] [blame]94constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
95constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI";
96constexpr auto ipzVpdInf = "com.ibm.ipzvpd.";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500[diff] [blame]97constexpr auto offsetJsonDirectory = "/var/lib/vpd/";
98constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper";
99constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper";
100constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500[diff] [blame]101constexpr auto loggerService = "xyz.openbmc_project.Logging";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500[diff] [blame]102constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging";
103constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600[diff] [blame]104constexpr auto errIntfForVPDDefault = "com.ibm.VPD.Error.DefaultValue";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500[diff] [blame]105constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600[diff] [blame]106constexpr auto errIntfForVPDMismatch = "com.ibm.VPD.Error.Mismatch";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500[diff] [blame]107constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InavlidEepromPath";
108constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed";
109constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson";
110constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure";
Alpana Kumariab1e22c2021-11-24 11:03:38 -0600[diff] [blame]111constexpr auto errIntfForInvalidSystemType =
112 "com.ibm.VPD.Error.UnknownSytemType";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500[diff] [blame]113constexpr auto errIntfForEssentialFru = "com.ibm.VPD.Error.RequiredFRUMissing";
Alpana Kumari6bd095f2022-02-23 10:20:20 -0600[diff] [blame]114constexpr auto errIntfForGpioError = "com.ibm.VPD.Error.GPIOError";
SunnySrivastava19849094d4f2020-08-05 09:32:29 -0500[diff] [blame]115constexpr auto motherBoardInterface =
116 "xyz.openbmc_project.Inventory.Item.Board.Motherboard";
Priyanga Ramasamyaa8a8932022-01-27 09:12:41 -0600[diff] [blame]117constexpr auto invItemIntf = "xyz.openbmc_project.Inventory.Item";
jinuthomasf457a3e2023-04-13 12:22:48 -0500[diff] [blame]118constexpr 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";
PriyangaRamasamy647868e2020-09-08 17:03:19 +0530[diff] [blame]124
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]125namespace lengths
126{
127enum Lengths
128{
129 RECORD_NAME = 4,
130 KW_NAME = 2,
131 RECORD_OFFSET = 2,
132 RECORD_MIN = 44,
133 RECORD_LENGTH = 2,
134 RECORD_ECC_OFFSET = 2,
135 VHDR_ECC_LENGTH = 11,
136 VHDR_RECORD_LENGTH = 44
137}; // enum Lengths
138} // namespace lengths
139
140namespace offsets
141{
142enum Offsets
143{
144 VHDR = 17,
145 VHDR_TOC_ENTRY = 29,
146 VTOC_PTR = 35,
SunnySrivastava1984f6d541e2020-02-04 12:50:40 -0600[diff] [blame]147 VTOC_REC_LEN = 37,
148 VTOC_ECC_OFF = 39,
149 VTOC_ECC_LEN = 41,
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]150 VTOC_DATA = 13,
151 VHDR_ECC = 0,
152 VHDR_RECORD = 11
153};
154} // namespace offsets
155
156namespace eccStatus
157{
158enum Status
159{
160 SUCCESS = 0,
161 FAILED = -1
162};
163} // namespace eccStatus
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500[diff] [blame]164
165/**
166 * @brief Types of VPD
167 */
168enum vpdType
169{
jinuthomas6555e7e2023-02-14 21:48:00 -0600[diff] [blame]170 IPZ_VPD, /**< IPZ VPD type */
171 KEYWORD_VPD, /**< Keyword VPD type */
172 DDR4_DDIMM_MEMORY_VPD, /**< DDR4 DDIMM Memory VPD type */
173 DDR5_DDIMM_MEMORY_VPD, /**< DDR5 DDIMM Memory VPD type */
174 DDR4_ISDIMM_MEMORY_VPD, /**< DDR4 ISDIMM Memory VPD type */
175 DDR5_ISDIMM_MEMORY_VPD, /**< DDR5 ISDIMM Memory VPD type */
jinuthomasf457a3e2023-04-13 12:22:48 -0500[diff] [blame]176 INVALID_VPD_FORMAT /**< Invalid VPD type Format */
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500[diff] [blame]177};
Sunny Srivastava0746eee2021-03-22 13:36:54 -0500[diff] [blame]178
179enum PelSeverity
180{
181 NOTICE,
182 INFORMATIONAL,
183 DEBUG,
184 WARNING,
185 CRITICAL,
186 EMERGENCY,
187 ALERT,
188 ERROR
189};
190
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600[diff] [blame]191} // namespace constants
192} // namespace vpd
193} // namespace openpower