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 static constexpr auto BLUERIDGE_2U = "60001001.json"; 65 static constexpr auto BLUERIDGE_2U_V2 = "60001001_v2.json"; 66 static constexpr auto BLUERIDGE_4U = "60001000.json"; 67 static constexpr auto BLUERIDGE_4U_V2 = "60001000_v2.json"; 68 static constexpr auto BLUERIDGE_1S4U = "60001002.json"; 69 static constexpr auto FUJI = "60002000.json"; 70 static constexpr auto FUJI_V2 = "60002000_v2.json"; 71 72 constexpr uint8_t KW_VPD_START_TAG = 0x82; 73 constexpr uint8_t KW_VPD_END_TAG = 0x78; 74 constexpr uint8_t ALT_KW_VAL_PAIR_START_TAG = 0x90; 75 constexpr uint8_t KW_VAL_PAIR_END_TAG = 0x79; 76 constexpr auto MEMORY_VPD_START_TAG = "11S"; 77 constexpr int TWO_BYTES = 2; 78 constexpr int KW_VPD_DATA_START = 0; 79 constexpr auto MEMORY_VPD_DATA_START = 416; 80 constexpr auto FORMAT_11S_LEN = 3; 81 static constexpr auto PART_NUM_LEN = 7; 82 static constexpr auto SERIAL_NUM_LEN = 12; 83 static constexpr auto CCIN_LEN = 4; 84 static constexpr auto CONVERT_MB_TO_KB = 1024; 85 static constexpr auto CONVERT_GB_TO_KB = 1024 * 1024; 86 87 static constexpr auto SPD_BYTE_2 = 2; 88 static constexpr auto SPD_BYTE_3 = 3; 89 static constexpr auto SPD_BYTE_4 = 4; 90 static constexpr auto SPD_BYTE_6 = 6; 91 static constexpr auto SPD_BYTE_12 = 12; 92 static constexpr auto SPD_BYTE_13 = 13; 93 static constexpr auto SPD_BYTE_18 = 18; 94 static constexpr auto SPD_BYTE_234 = 234; 95 static constexpr auto SPD_BYTE_235 = 235; 96 static constexpr auto SPD_BYTE_BIT_0_3_MASK = 0x0F; 97 static constexpr auto SPD_BYTE_MASK = 0xFF; 98 99 static constexpr auto VALUE_0 = 0; 100 static constexpr auto VALUE_1 = 1; 101 static constexpr auto VALUE_2 = 2; 102 static constexpr auto VALUE_3 = 3; 103 static constexpr auto VALUE_4 = 4; 104 static constexpr auto VALUE_5 = 5; 105 static constexpr auto VALUE_6 = 6; 106 static constexpr auto VALUE_7 = 7; 107 static constexpr auto VALUE_8 = 8; 108 static constexpr auto VALUE_10 = 10; 109 static constexpr auto VALUE_100000 = 100000; 110 111 static constexpr auto MASK_BYTE_BITS_6 = 0x40; 112 static constexpr auto MASK_BYTE_BITS_7 = 0x80; 113 static constexpr auto MASK_BYTE_BITS_01 = 0x03; 114 static constexpr auto MASK_BYTE_BITS_345 = 0x38; 115 static constexpr auto MASK_BYTE_BITS_012 = 0x07; 116 static constexpr auto MASK_BYTE_BITS_567 = 0xE0; 117 static constexpr auto MASK_BYTE_BITS_0123 = 0x0F; 118 static constexpr auto MASK_BYTE_BITS_01234 = 0x1F; 119 120 static constexpr auto SHIFT_BITS_0 = 0; 121 static constexpr auto SHIFT_BITS_3 = 3; 122 static constexpr auto SHIFT_BITS_5 = 5; 123 124 static constexpr auto SPD_MODULE_TYPE_DDIMM = 0x0A; 125 static constexpr auto SPD_DRAM_TYPE_DDR5 = 0x12; 126 static constexpr auto SPD_DRAM_TYPE_DDR4 = 0x0C; 127 128 constexpr auto pimPath = "/xyz/openbmc_project/inventory"; 129 constexpr auto pimIntf = "xyz.openbmc_project.Inventory.Manager"; 130 constexpr auto pimService = "xyz.openbmc_project.Inventory.Manager"; 131 constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI"; 132 constexpr auto memVpdInf = "com.ibm.ipzvpd.VINI"; 133 constexpr auto ipzVpdInf = "com.ibm.ipzvpd."; 134 constexpr auto offsetJsonDirectory = "/var/lib/vpd/"; 135 constexpr auto mapperObjectPath = "/xyz/openbmc_project/object_mapper"; 136 constexpr auto mapperInterface = "xyz.openbmc_project.ObjectMapper"; 137 constexpr auto mapperDestination = "xyz.openbmc_project.ObjectMapper"; 138 constexpr auto loggerService = "xyz.openbmc_project.Logging"; 139 constexpr auto loggerObjectPath = "/xyz/openbmc_project/logging"; 140 constexpr auto loggerCreateInterface = "xyz.openbmc_project.Logging.Create"; 141 constexpr auto errIntfForVPDDefault = "com.ibm.VPD.Error.DefaultValue"; 142 constexpr auto errIntfForInvalidVPD = "com.ibm.VPD.Error.InvalidVPD"; 143 constexpr auto errIntfForVPDMismatch = "com.ibm.VPD.Error.Mismatch"; 144 constexpr auto errIntfForStreamFail = "com.ibm.VPD.Error.InvalidEepromPath"; 145 constexpr auto errIntfForEccCheckFail = "com.ibm.VPD.Error.EccCheckFailed"; 146 constexpr auto errIntfForJsonFailure = "com.ibm.VPD.Error.InvalidJson"; 147 constexpr auto errIntfForBusFailure = "com.ibm.VPD.Error.DbusFailure"; 148 constexpr auto errIntfForInvalidSystemType = 149 "com.ibm.VPD.Error.UnknownSytemType"; 150 constexpr auto errIntfForEssentialFru = "com.ibm.VPD.Error.RequiredFRUMissing"; 151 constexpr auto errIntfForGpioError = "com.ibm.VPD.Error.GPIOError"; 152 constexpr auto motherBoardInterface = 153 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"; 154 constexpr auto systemVpdFilePath = "/sys/bus/i2c/drivers/at24/8-0050/eeprom"; 155 constexpr auto i2cPathPrefix = "/sys/bus/i2c/drivers/"; 156 constexpr auto spiPathPrefix = "/sys/bus/spi/drivers/"; 157 constexpr auto at24driver = "at24"; 158 constexpr auto at25driver = "at25"; 159 constexpr auto ee1004driver = "ee1004"; 160 constexpr auto invItemIntf = "xyz.openbmc_project.Inventory.Item"; 161 constexpr auto invAssetIntf = "xyz.openbmc_project.Inventory.Decorator.Asset"; 162 constexpr auto invOperationalStatusIntf = 163 "xyz.openbmc_project.State.Decorator.OperationalStatus"; 164 static constexpr std::uintmax_t MAX_VPD_SIZE = 65504; 165 166 namespace lengths 167 { 168 enum Lengths 169 { 170 RECORD_NAME = 4, 171 KW_NAME = 2, 172 RECORD_OFFSET = 2, 173 RECORD_MIN = 44, 174 RECORD_LENGTH = 2, 175 RECORD_ECC_OFFSET = 2, 176 VHDR_ECC_LENGTH = 11, 177 VHDR_RECORD_LENGTH = 44 178 }; // enum Lengths 179 } // namespace lengths 180 181 namespace offsets 182 { 183 enum Offsets 184 { 185 VHDR = 17, 186 VHDR_TOC_ENTRY = 29, 187 VTOC_PTR = 35, 188 VTOC_REC_LEN = 37, 189 VTOC_ECC_OFF = 39, 190 VTOC_ECC_LEN = 41, 191 VTOC_DATA = 13, 192 VHDR_ECC = 0, 193 VHDR_RECORD = 11 194 }; 195 } // namespace offsets 196 197 namespace eccStatus 198 { 199 enum Status 200 { 201 SUCCESS = 0, 202 FAILED = -1 203 }; 204 } // namespace eccStatus 205 206 /** 207 * @brief Types of VPD 208 */ 209 enum vpdType 210 { 211 IPZ_VPD, /**< IPZ VPD type */ 212 KEYWORD_VPD, /**< Keyword VPD type */ 213 DDR4_DDIMM_MEMORY_VPD, /**< DDR4 DDIMM Memory VPD type */ 214 DDR5_DDIMM_MEMORY_VPD, /**< DDR5 DDIMM Memory VPD type */ 215 DDR4_ISDIMM_MEMORY_VPD, /**< DDR4 ISDIMM Memory VPD type */ 216 DDR5_ISDIMM_MEMORY_VPD, /**< DDR5 ISDIMM Memory VPD type */ 217 INVALID_VPD_FORMAT /**< Invalid VPD type Format */ 218 }; 219 220 enum PelSeverity 221 { 222 NOTICE, 223 INFORMATIONAL, 224 DEBUG, 225 WARNING, 226 CRITICAL, 227 EMERGENCY, 228 ALERT, 229 ERROR 230 }; 231 232 } // namespace constants 233 } // namespace vpd 234 } // namespace openpower 235