1 /* 2 // Copyright (c) 2018 Intel Corporation 3 // 4 // Licensed under the Apache License, Version 2.0 (the "License"); 5 // you may not use this file except in compliance with the License. 6 // You may obtain a copy of the License at 7 // 8 // http://www.apache.org/licenses/LICENSE-2.0 9 // 10 // Unless required by applicable law or agreed to in writing, software 11 // distributed under the License is distributed on an "AS IS" BASIS, 12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 // See the License for the specific language governing permissions and 14 // limitations under the License. 15 */ 16 17 #pragma once 18 #include "smbios_mdrv2.hpp" 19 20 #include <nlohmann/json.hpp> 21 #include <xyz/openbmc_project/Association/Definitions/server.hpp> 22 #include <xyz/openbmc_project/Inventory/Connector/Slot/server.hpp> 23 #include <xyz/openbmc_project/Inventory/Decorator/Asset/server.hpp> 24 #include <xyz/openbmc_project/Inventory/Decorator/LocationCode/server.hpp> 25 #include <xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation/server.hpp> 26 #include <xyz/openbmc_project/Inventory/Item/Dimm/server.hpp> 27 #include <xyz/openbmc_project/Inventory/Item/server.hpp> 28 #include <xyz/openbmc_project/State/Decorator/OperationalStatus/server.hpp> 29 30 namespace phosphor 31 { 32 33 namespace smbios 34 { 35 36 using DeviceType = 37 sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm::DeviceType; 38 39 using EccType = 40 sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm::Ecc; 41 42 using MemoryTechType = 43 sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm::MemoryTech; 44 45 using FormFactor = 46 sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm::FormFactor; 47 48 using Json = nlohmann::json; 49 50 class Dimm : 51 sdbusplus::server::object_t< 52 sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm>, 53 sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project:: 54 inventory::item::dimm::MemoryLocation>, 55 sdbusplus::server::object_t< 56 sdbusplus::server::xyz::openbmc_project::inventory::decorator::Asset>, 57 sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project:: 58 inventory::decorator::LocationCode>, 59 sdbusplus::server::object_t< 60 sdbusplus::server::xyz::openbmc_project::inventory::connector::Slot>, 61 sdbusplus::server::object_t< 62 sdbusplus::server::xyz::openbmc_project::inventory::Item>, 63 sdbusplus::server::object_t< 64 sdbusplus::server::xyz::openbmc_project::association::Definitions>, 65 sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project::state:: 66 decorator::OperationalStatus> 67 { 68 public: 69 Dimm() = delete; 70 ~Dimm() = default; 71 Dimm(const Dimm&) = delete; 72 Dimm& operator=(const Dimm&) = delete; 73 Dimm(Dimm&&) = default; 74 Dimm& operator=(Dimm&&) = default; 75 Dimm(sdbusplus::bus_t & bus,const std::string & objPath,const uint8_t & dimmId,uint8_t * smbiosTableStorage,const std::string & motherboard)76 Dimm(sdbusplus::bus_t& bus, const std::string& objPath, 77 const uint8_t& dimmId, uint8_t* smbiosTableStorage, 78 const std::string& motherboard) : 79 80 sdbusplus::server::object_t< 81 sdbusplus::server::xyz::openbmc_project::inventory::item::Dimm>( 82 bus, objPath.c_str()), 83 sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project:: 84 inventory::item::dimm::MemoryLocation>( 85 bus, objPath.c_str()), 86 sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project:: 87 inventory::decorator::Asset>( 88 bus, objPath.c_str()), 89 sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project:: 90 inventory::decorator::LocationCode>( 91 bus, objPath.c_str()), 92 sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project:: 93 inventory::connector::Slot>( 94 bus, objPath.c_str()), 95 sdbusplus::server::object_t< 96 sdbusplus::server::xyz::openbmc_project::inventory::Item>( 97 bus, objPath.c_str()), 98 sdbusplus::server::object_t< 99 sdbusplus::server::xyz::openbmc_project::association::Definitions>( 100 bus, objPath.c_str()), 101 sdbusplus::server::object_t<sdbusplus::server::xyz::openbmc_project:: 102 state::decorator::OperationalStatus>( 103 bus, objPath.c_str()), 104 dimmNum(dimmId) 105 { 106 memoryInfoUpdate(smbiosTableStorage, motherboard); 107 } 108 109 void memoryInfoUpdate(uint8_t* smbiosTableStorage, 110 const std::string& motherboard); 111 112 uint16_t memoryDataWidth(uint16_t value) override; 113 uint16_t memoryTotalWidth(uint16_t value) override; 114 size_t memorySizeInKB(size_t value) override; 115 std::string memoryDeviceLocator(std::string value) override; 116 DeviceType memoryType(DeviceType value) override; 117 std::string memoryTypeDetail(std::string value) override; 118 uint16_t maxMemorySpeedInMhz(uint16_t value) override; 119 std::string manufacturer(std::string value) override; 120 bool present(bool value) override; 121 std::string serialNumber(std::string value) override; 122 std::string partNumber(std::string value) override; 123 std::string locationCode(std::string value) override; 124 size_t memoryAttributes(size_t value) override; 125 MemoryTechType memoryMedia(MemoryTechType value) override; 126 uint8_t slot(uint8_t value) override; 127 uint8_t socket(uint8_t value) override; 128 uint8_t memoryController(uint8_t value) override; 129 uint8_t channel(uint8_t value) override; 130 uint16_t memoryConfiguredSpeedInMhz(uint16_t value) override; 131 bool functional(bool value) override; 132 EccType ecc(EccType value) override; 133 FormFactor formFactor(FormFactor value) override; 134 Json parseConfigFile(); 135 136 private: 137 uint8_t dimmNum; 138 139 uint8_t* storage; 140 141 std::string motherboardPath; 142 143 void dimmSize(const uint16_t size); 144 void dimmSizeExt(const uint32_t size); 145 void dimmDeviceLocator(const uint8_t bankLocatorPositionNum, 146 const uint8_t deviceLocatorPositionNum, 147 const uint8_t structLen, uint8_t* dataIn); 148 void dimmType(const uint8_t type); 149 void dimmTypeDetail(const uint16_t detail); 150 void dimmManufacturer(const uint8_t positionNum, const uint8_t structLen, 151 uint8_t* dataIn); 152 void dimmMedia(const uint8_t type); 153 void dimmSerialNum(const uint8_t positionNum, const uint8_t structLen, 154 uint8_t* dataIn); 155 void dimmPartNum(const uint8_t positionNum, const uint8_t structLen, 156 uint8_t* dataIn); 157 void updateEccType(uint16_t exPhyArrayHandle); 158 void updateFormFactor(const uint8_t formFactorKey); 159 }; 160 161 struct MemoryInfo 162 { 163 uint8_t type; 164 uint8_t length; 165 uint16_t handle; 166 uint16_t phyArrayHandle; 167 uint16_t errInfoHandle; 168 uint16_t totalWidth; 169 uint16_t dataWidth; 170 uint16_t size; 171 uint8_t formFactor; 172 uint8_t deviceSet; 173 uint8_t deviceLocator; 174 uint8_t bankLocator; 175 uint8_t memoryType; 176 uint16_t typeDetail; 177 uint16_t speed; 178 uint8_t manufacturer; 179 uint8_t serialNum; 180 uint8_t assetTag; 181 uint8_t partNum; 182 uint8_t attributes; 183 uint32_t extendedSize; 184 uint16_t confClockSpeed; 185 uint16_t minimumVoltage; 186 uint16_t maximumVoltage; 187 uint16_t configuredVoltage; 188 uint8_t memoryTechnology; 189 uint16_t memoryOperatingModeCap; 190 uint8_t firwareVersion; 191 uint16_t modelManufId; 192 uint16_t modelProdId; 193 uint16_t memSubConManufId; 194 uint16_t memSubConProdId; 195 uint64_t nvSize; 196 uint64_t volatileSize; 197 uint64_t cacheSize; 198 uint64_t logicalSize; 199 } __attribute__((packed)); 200 201 /** 202 * @brief Struct to represent SMBIOS 3.2 type-16 (Physical Memory Array) data. 203 */ 204 struct PhysicalMemoryArrayInfo 205 { 206 uint8_t type; 207 uint8_t length; 208 uint16_t handle; 209 uint8_t location; 210 uint8_t use; 211 uint8_t memoryErrorCorrection; 212 uint32_t maximumCapacity; 213 uint16_t memoryErrorInformationHandle; 214 uint16_t numberOfMemoryDevices; 215 uint64_t extendedMaximumCapacity; 216 } __attribute__((packed)); 217 static_assert(sizeof(PhysicalMemoryArrayInfo) == 23, 218 "Size of PhysicalMemoryArrayInfo struct is incorrect."); 219 220 const std::map<uint8_t, DeviceType> dimmTypeTable = { 221 {0x1, DeviceType::Other}, {0x2, DeviceType::Unknown}, 222 {0x3, DeviceType::DRAM}, {0x4, DeviceType::EDRAM}, 223 {0x5, DeviceType::VRAM}, {0x6, DeviceType::SRAM}, 224 {0x7, DeviceType::RAM}, {0x8, DeviceType::ROM}, 225 {0x9, DeviceType::FLASH}, {0xa, DeviceType::EEPROM}, 226 {0xb, DeviceType::FEPROM}, {0xc, DeviceType::EPROM}, 227 {0xd, DeviceType::CDRAM}, {0xe, DeviceType::ThreeDRAM}, 228 {0xf, DeviceType::SDRAM}, {0x10, DeviceType::DDR_SGRAM}, 229 {0x11, DeviceType::RDRAM}, {0x12, DeviceType::DDR}, 230 {0x13, DeviceType::DDR2}, {0x14, DeviceType::DDR2_SDRAM_FB_DIMM}, 231 {0x18, DeviceType::DDR3}, {0x19, DeviceType::FBD2}, 232 {0x1a, DeviceType::DDR4}, {0x1b, DeviceType::LPDDR_SDRAM}, 233 {0x1c, DeviceType::LPDDR2_SDRAM}, {0x1d, DeviceType::LPDDR3_SDRAM}, 234 {0x1e, DeviceType::LPDDR4_SDRAM}, {0x1f, DeviceType::Logical}, 235 {0x20, DeviceType::HBM}, {0x21, DeviceType::HBM2}, 236 {0x22, DeviceType::DDR5}, {0x23, DeviceType::LPDDR5_SDRAM}}; 237 238 const std::array<std::string, 16> detailTable{ 239 "Reserved", "Other", "Unknown", "Fast-paged", 240 "Static column", "Pseudo-static", "RAMBUS", "Synchronous", 241 "CMOS", "EDO", "Window DRAM", "Cache DRAM", 242 "Non-volatile", "Registered", "Unbuffered", "LRDIMM"}; 243 244 /** 245 * @brief Map SMBIOS 3.2 Memory Array Error Correction Types to 246 * xyz.openbmc_project.Inventory.Item.Dimm.Ecc types. 247 * 248 * SMBIOS 3.2 Memory Array Error Correction Types 'Unknown', 'None', 'CRC' are 249 * mapped to EccType::NoECC since the DBUs interface does not support those 250 * representations. 251 */ 252 const std::map<uint8_t, EccType> dimmEccTypeMap = { 253 {0x1, EccType::NoECC}, {0x2, EccType::NoECC}, 254 {0x3, EccType::NoECC}, {0x4, EccType::AddressParity}, 255 {0x5, EccType::SingleBitECC}, {0x6, EccType::MultiBitECC}, 256 {0x7, EccType::NoECC}}; 257 258 const std::map<uint8_t, MemoryTechType> dimmMemoryTechTypeMap = { 259 {0x1, MemoryTechType::Other}, {0x2, MemoryTechType::Unknown}, 260 {0x3, MemoryTechType::DRAM}, {0x4, MemoryTechType::NVDIMM_N}, 261 {0x5, MemoryTechType::NVDIMM_F}, {0x6, MemoryTechType::NVDIMM_P}, 262 {0x7, MemoryTechType::IntelOptane}}; 263 264 struct memoryLocation 265 { 266 uint8_t memoryController; 267 uint8_t socket; 268 uint8_t slot; 269 uint8_t channel; 270 }; 271 272 const std::map<uint8_t, FormFactor> dimmFormFactorMap = { 273 {0x10, FormFactor::Die}}; 274 275 } // namespace smbios 276 277 } // namespace phosphor 278