xref: /openbmc/openpower-vpd-parser/const.hpp (revision 45d54976)
1 #pragma once
2 
3 #include <cstdint>
4 #include <iostream>
5 
6 namespace openpower
7 {
8 namespace vpd
9 {
10 namespace constants
11 {
12 
13 using RecordId = uint8_t;
14 using RecordOffset = uint16_t;
15 using RecordSize = uint16_t;
16 using RecordType = uint16_t;
17 using RecordLength = uint16_t;
18 using KwSize = uint8_t;
19 using PoundKwSize = uint16_t;
20 using ECCOffset = uint16_t;
21 using ECCLength = uint16_t;
22 using LE2ByteData = uint16_t;
23 using DataOffset = uint16_t;
24 
25 static constexpr auto NEXT_64_KB = 65536;
26 static constexpr auto MAC_ADDRESS_LEN_BYTES = 6;
27 static constexpr auto LAST_KW = "PF";
28 static constexpr auto POUND_KW = '#';
29 static constexpr auto POUND_KW_PREFIX = "PD_";
30 static constexpr auto NUMERIC_KW_PREFIX = "N_";
31 static constexpr auto UUID_LEN_BYTES = 16;
32 static constexpr auto UUID_TIME_LOW_END = 8;
33 static constexpr auto UUID_TIME_MID_END = 13;
34 static constexpr auto UUID_TIME_HIGH_END = 18;
35 static constexpr auto UUID_CLK_SEQ_END = 23;
36 
37 static constexpr auto MB_RESULT_LEN = 19;
38 static constexpr auto MB_LEN_BYTES = 8;
39 static constexpr auto MB_YEAR_END = 4;
40 static constexpr auto MB_MONTH_END = 7;
41 static constexpr auto MB_DAY_END = 10;
42 static constexpr auto MB_HOUR_END = 13;
43 static constexpr auto MB_MIN_END = 16;
44 static constexpr auto SYSTEM_OBJECT = "/system/chassis/motherboard";
45 static constexpr auto IBM_LOCATION_CODE_INF = "com.ibm.ipzvpd.Location";
46 static constexpr auto XYZ_LOCATION_CODE_INF =
47     "xyz.openbmc_project.Inventory.Decorator.LocationCode";
48 constexpr int IPZ_DATA_START = 11;
49 constexpr uint8_t KW_VAL_PAIR_START_TAG = 0x84;
50 constexpr uint8_t RECORD_END_TAG = 0x78;
51 constexpr int UNEXP_LOCATION_CODE_MIN_LENGTH = 4;
52 constexpr uint8_t EXP_LOCATIN_CODE_MIN_LENGTH = 17;
53 static constexpr auto SE_KWD_LENGTH = 7;
54 static constexpr auto INVALID_NODE_NUMBER = -1;
55 static constexpr auto RAINIER_2U = "50001001.json";
56 static constexpr auto RAINIER_2U_V2 = "50001001_v2.json";
57 static constexpr auto RAINIER_4U = "50001000.json";
58 static constexpr auto RAINIER_4U_V2 = "50001000_v2.json";
59 static constexpr auto RAINIER_1S4U = "50001002.json";
60 static constexpr auto EVEREST = "50003000.json";
61 static constexpr auto EVEREST_V2 = "50003000_v2.json";
62 static constexpr auto BONNELL = "50004000.json";
63 
64 constexpr uint8_t KW_VPD_START_TAG = 0x82;
65 constexpr uint8_t KW_VPD_END_TAG = 0x78;
66 constexpr uint8_t ALT_KW_VAL_PAIR_START_TAG = 0x90;
67 constexpr uint8_t KW_VAL_PAIR_END_TAG = 0x79;
68 constexpr auto MEMORY_VPD_START_TAG = "11S";
69 constexpr int TWO_BYTES = 2;
70 constexpr int KW_VPD_DATA_START = 0;
71 constexpr auto MEMORY_VPD_DATA_START = 416;
72 constexpr auto FORMAT_11S_LEN = 3;
73 static constexpr auto PART_NUM_LEN = 7;
74 static constexpr auto SERIAL_NUM_LEN = 12;
75 static constexpr auto CCIN_LEN = 4;
76 static constexpr auto CONVERT_MB_TO_KB = 1024;
77 
78 static constexpr auto SPD_BYTE_2 = 2;
79 static constexpr auto SPD_BYTE_3 = 3;
80 static constexpr auto SPD_BYTE_4 = 4;
81 static constexpr auto SPD_BYTE_6 = 6;
82 static constexpr auto SPD_BYTE_12 = 12;
83 static constexpr auto SPD_BYTE_13 = 13;
84 static constexpr auto SPD_BYTE_18 = 18;
85 static constexpr auto SPD_BYTE_BIT_0_3_MASK = 0x0F;
86 static constexpr auto SPD_BYTE_MASK = 0xFF;
87 
88 static constexpr auto SPD_MODULE_TYPE_DDIMM = 0x0A;
89 static constexpr auto SPD_DRAM_TYPE_DDR5 = 0x12;
90 static constexpr auto SPD_DRAM_TYPE_DDR4 = 0x0C;
91 
92 constexpr auto pimPath = "/xyz/openbmc_project/inventory";
93 constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager";
94 constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
95 constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI";
96 constexpr auto ipzVpdInf = "com.ibm.ipzvpd.";
97 constexpr auto offsetJsonDirectory = "/var/lib/vpd/";
98 constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper";
99 constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper";
100 constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper";
101 constexpr auto loggerService = "xyz.openbmc_project.Logging";
102 constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging";
103 constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create";
104 constexpr auto errIntfForVPDDefault = "com.ibm.VPD.Error.DefaultValue";
105 constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD";
106 constexpr auto errIntfForVPDMismatch = "com.ibm.VPD.Error.Mismatch";
107 constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InvalidEepromPath";
108 constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed";
109 constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson";
110 constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure";
111 constexpr auto errIntfForInvalidSystemType =
112     "com.ibm.VPD.Error.UnknownSytemType";
113 constexpr auto errIntfForEssentialFru = "com.ibm.VPD.Error.RequiredFRUMissing";
114 constexpr auto errIntfForGpioError = "com.ibm.VPD.Error.GPIOError";
115 constexpr auto motherBoardInterface =
116     "xyz.openbmc_project.Inventory.Item.Board.Motherboard";
117 constexpr auto invItemIntf = "xyz.openbmc_project.Inventory.Item";
118 constexpr auto systemVpdFilePath = "/sys/bus/i2c/drivers/at24/8-0050/eeprom";
119 constexpr auto i2cPathPrefix = "/sys/bus/i2c/drivers/";
120 constexpr auto spiPathPrefix = "/sys/bus/spi/drivers/";
121 constexpr auto at24driver = "at24";
122 constexpr auto at25driver = "at25";
123 constexpr auto ee1004driver = "ee1004";
124 
125 namespace lengths
126 {
127 enum 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 
140 namespace offsets
141 {
142 enum Offsets
143 {
144     VHDR = 17,
145     VHDR_TOC_ENTRY = 29,
146     VTOC_PTR = 35,
147     VTOC_REC_LEN = 37,
148     VTOC_ECC_OFF = 39,
149     VTOC_ECC_LEN = 41,
150     VTOC_DATA = 13,
151     VHDR_ECC = 0,
152     VHDR_RECORD = 11
153 };
154 } // namespace offsets
155 
156 namespace eccStatus
157 {
158 enum Status
159 {
160     SUCCESS = 0,
161     FAILED = -1
162 };
163 } // namespace eccStatus
164 
165 /**
166  * @brief Types of VPD
167  */
168 enum vpdType
169 {
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 */
176     INVALID_VPD_FORMAT      /**< Invalid VPD type Format */
177 };
178 
179 enum PelSeverity
180 {
181     NOTICE,
182     INFORMATIONAL,
183     DEBUG,
184     WARNING,
185     CRITICAL,
186     EMERGENCY,
187     ALERT,
188     ERROR
189 };
190 
191 } // namespace constants
192 } // namespace vpd
193 } // namespace openpower
194