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