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