blob: 6cafd6f20be05ccc15cb6419d2a050d1c4683190 [file] [log] [blame]
SunnySrivastava198419be6d32020-03-03 07:21:45 -06001#pragma once
2
3#include <iostream>
4
5namespace openpower
6{
7namespace vpd
8{
9namespace constants
10{
11
12using RecordId = uint8_t;
13using RecordOffset = uint16_t;
14using RecordSize = uint16_t;
15using RecordType = uint16_t;
16using RecordLength = uint16_t;
17using KwSize = uint8_t;
18using PoundKwSize = uint16_t;
19using ECCOffset = uint16_t;
20using ECCLength = uint16_t;
21using LE2ByteData = uint16_t;
SunnySrivastava19846d8314d2020-05-15 09:34:58 -050022using DataOffset = uint16_t;
SunnySrivastava198419be6d32020-03-03 07:21:45 -060023
Alpana Kumari58e22142020-05-05 00:22:12 -050024static constexpr auto NEXT_64_KB = 65536;
SunnySrivastava198419be6d32020-03-03 07:21:45 -060025static constexpr auto MAC_ADDRESS_LEN_BYTES = 6;
26static constexpr auto LAST_KW = "PF";
27static constexpr auto POUND_KW = '#';
28static constexpr auto UUID_LEN_BYTES = 16;
29static constexpr auto UUID_TIME_LOW_END = 8;
30static constexpr auto UUID_TIME_MID_END = 13;
31static constexpr auto UUID_TIME_HIGH_END = 18;
32static constexpr auto UUID_CLK_SEQ_END = 23;
33
34static constexpr auto MB_RESULT_LEN = 19;
35static constexpr auto MB_LEN_BYTES = 8;
36static constexpr auto MB_YEAR_END = 4;
37static constexpr auto MB_MONTH_END = 7;
38static constexpr auto MB_DAY_END = 10;
39static constexpr auto MB_HOUR_END = 13;
40static constexpr auto MB_MIN_END = 16;
SunnySrivastava198443306542020-04-01 02:50:20 -050041static constexpr auto SYSTEM_OBJECT = "/system/chassis/motherboard";
Alpana Kumari414d5ae2021-03-04 21:06:35 +000042static constexpr auto IBM_LOCATION_CODE_INF = "com.ibm.ipzvpd.Location";
43static constexpr auto XYZ_LOCATION_CODE_INF =
44 "xyz.openbmc_project.Inventory.Decorator.LocationCode";
SunnySrivastava198419be6d32020-03-03 07:21:45 -060045constexpr int IPZ_DATA_START = 11;
46constexpr uint8_t KW_VAL_PAIR_START_TAG = 0x84;
47constexpr uint8_t RECORD_END_TAG = 0x78;
SunnySrivastava1984bca5aaa2020-04-21 05:31:04 -050048constexpr int UNEXP_LOCATION_CODE_MIN_LENGTH = 4;
SunnySrivastava1984fb5815a2020-04-24 08:03:52 -050049constexpr uint8_t EXP_LOCATIN_CODE_MIN_LENGTH = 17;
50static constexpr auto SE_KWD_LENGTH = 7;
51static constexpr auto INVALID_NODE_NUMBER = -1;
Santosh Puranike5f177a2022-01-24 20:14:46 +053052static constexpr auto RAINIER_2U = "50001001.json";
53static constexpr auto RAINIER_2U_V2 = "50001001_v2.json";
54static constexpr auto RAINIER_4U = "50001000.json";
55static constexpr auto RAINIER_4U_V2 = "50001000_v2.json";
56static constexpr auto RAINIER_1S4U = "50001002.json";
57static constexpr auto EVEREST = "50003000.json";
Alpana Kumari1b026112022-03-02 23:41:38 -060058static constexpr auto EVEREST_V2 = "50003000_v2.json";
Santosh Puranikdedb5a62022-12-19 23:58:32 +053059static constexpr auto BONNELL = "50004000.json";
SunnySrivastava198419be6d32020-03-03 07:21:45 -060060
SunnySrivastava1984945a02d2020-05-06 01:55:41 -050061constexpr uint8_t KW_VPD_START_TAG = 0x82;
62constexpr uint8_t KW_VPD_END_TAG = 0x78;
63constexpr uint8_t ALT_KW_VAL_PAIR_START_TAG = 0x90;
64constexpr uint8_t KW_VAL_PAIR_END_TAG = 0x79;
65constexpr auto MEMORY_VPD_START_TAG = "11S";
66constexpr int TWO_BYTES = 2;
67constexpr int KW_VPD_DATA_START = 0;
68constexpr auto MEMORY_VPD_DATA_START = 416;
69constexpr auto FORMAT_11S_LEN = 3;
70static constexpr auto PART_NUM_LEN = 7;
71static constexpr auto SERIAL_NUM_LEN = 12;
72static constexpr auto CCIN_LEN = 4;
Alpana Kumari3ab26a72021-04-05 19:09:19 +000073static constexpr auto CONVERT_MB_TO_KB = 1024;
SunnySrivastava1984945a02d2020-05-06 01:55:41 -050074
jinuthomas6555e7e2023-02-14 21:48:00 -060075static constexpr auto SPD_BYTE_2 = 2;
76static constexpr auto SPD_BYTE_3 = 3;
77static constexpr auto SPD_BYTE_4 = 4;
78static constexpr auto SPD_BYTE_6 = 6;
79static constexpr auto SPD_BYTE_12 = 12;
80static constexpr auto SPD_BYTE_13 = 13;
81static constexpr auto SPD_BYTE_BIT_0_3_MASK = 0x0F;
82static constexpr auto SPD_BYTE_MASK = 0xFF;
83
84static constexpr auto SPD_MODULE_TYPE_DDIMM = 0x0A;
85static constexpr auto SPD_DRAM_TYPE_DDR5 = 0x12;
86static constexpr auto SPD_DRAM_TYPE_DDR4 = 0x0C;
87
SunnySrivastava1984945a02d2020-05-06 01:55:41 -050088constexpr auto pimPath = "/xyz/openbmc_project/inventory";
89constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager";
SunnySrivastava1984e12b1812020-05-26 02:23:11 -050090constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
91constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI";
92constexpr auto ipzVpdInf = "com.ibm.ipzvpd.";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -050093constexpr auto offsetJsonDirectory = "/var/lib/vpd/";
94constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper";
95constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper";
96constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -050097constexpr auto loggerService = "xyz.openbmc_project.Logging";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -050098constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging";
99constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600100constexpr auto errIntfForVPDDefault = "com.ibm.VPD.Error.DefaultValue";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500101constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD";
Priyanga Ramasamy24942232023-01-05 04:54:59 -0600102constexpr auto errIntfForVPDMismatch = "com.ibm.VPD.Error.Mismatch";
SunnySrivastava1984a20be8e2020-08-26 02:00:50 -0500103constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InavlidEepromPath";
104constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed";
105constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson";
106constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure";
Alpana Kumariab1e22c2021-11-24 11:03:38 -0600107constexpr auto errIntfForInvalidSystemType =
108 "com.ibm.VPD.Error.UnknownSytemType";
Sunny Srivastavafdf9ff22022-06-15 11:15:54 -0500109constexpr auto errIntfForEssentialFru = "com.ibm.VPD.Error.RequiredFRUMissing";
Alpana Kumari6bd095f2022-02-23 10:20:20 -0600110constexpr auto errIntfForGpioError = "com.ibm.VPD.Error.GPIOError";
SunnySrivastava19849094d4f2020-08-05 09:32:29 -0500111constexpr auto motherBoardInterface =
112 "xyz.openbmc_project.Inventory.Item.Board.Motherboard";
Priyanga Ramasamyaa8a8932022-01-27 09:12:41 -0600113constexpr auto invItemIntf = "xyz.openbmc_project.Inventory.Item";
jinuthomasf457a3e2023-04-13 12:22:48 -0500114constexpr auto systemVpdFilePath = "/sys/bus/i2c/drivers/at24/8-0050/eeprom";
115constexpr auto i2cPathPrefix = "/sys/bus/i2c/drivers/";
116constexpr auto spiPathPrefix = "/sys/bus/spi/drivers/";
117constexpr auto at24driver = "at24";
118constexpr auto at25driver = "at25";
119constexpr auto ee1004driver = "ee1004";
PriyangaRamasamy647868e2020-09-08 17:03:19 +0530120
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600121namespace lengths
122{
123enum Lengths
124{
125 RECORD_NAME = 4,
126 KW_NAME = 2,
127 RECORD_OFFSET = 2,
128 RECORD_MIN = 44,
129 RECORD_LENGTH = 2,
130 RECORD_ECC_OFFSET = 2,
131 VHDR_ECC_LENGTH = 11,
132 VHDR_RECORD_LENGTH = 44
133}; // enum Lengths
134} // namespace lengths
135
136namespace offsets
137{
138enum Offsets
139{
140 VHDR = 17,
141 VHDR_TOC_ENTRY = 29,
142 VTOC_PTR = 35,
SunnySrivastava1984f6d541e2020-02-04 12:50:40 -0600143 VTOC_REC_LEN = 37,
144 VTOC_ECC_OFF = 39,
145 VTOC_ECC_LEN = 41,
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600146 VTOC_DATA = 13,
147 VHDR_ECC = 0,
148 VHDR_RECORD = 11
149};
150} // namespace offsets
151
152namespace eccStatus
153{
154enum Status
155{
156 SUCCESS = 0,
157 FAILED = -1
158};
159} // namespace eccStatus
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500160
161/**
162 * @brief Types of VPD
163 */
164enum vpdType
165{
jinuthomas6555e7e2023-02-14 21:48:00 -0600166 IPZ_VPD, /**< IPZ VPD type */
167 KEYWORD_VPD, /**< Keyword VPD type */
168 DDR4_DDIMM_MEMORY_VPD, /**< DDR4 DDIMM Memory VPD type */
169 DDR5_DDIMM_MEMORY_VPD, /**< DDR5 DDIMM Memory VPD type */
170 DDR4_ISDIMM_MEMORY_VPD, /**< DDR4 ISDIMM Memory VPD type */
171 DDR5_ISDIMM_MEMORY_VPD, /**< DDR5 ISDIMM Memory VPD type */
jinuthomasf457a3e2023-04-13 12:22:48 -0500172 INVALID_VPD_FORMAT /**< Invalid VPD type Format */
Sunny Srivastava6c71c9d2021-04-15 04:43:54 -0500173};
Sunny Srivastava0746eee2021-03-22 13:36:54 -0500174
175enum PelSeverity
176{
177 NOTICE,
178 INFORMATIONAL,
179 DEBUG,
180 WARNING,
181 CRITICAL,
182 EMERGENCY,
183 ALERT,
184 ERROR
185};
186
SunnySrivastava198419be6d32020-03-03 07:21:45 -0600187} // namespace constants
188} // namespace vpd
189} // namespace openpower