/* // Copyright (c) 2018 Intel Corporation // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. */ #pragma once #include "health.hpp" #include #include #include #include #include #include #include #include #include namespace redfish { inline std::string translateMemoryTypeToRedfish(const std::string& memoryType) { if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR") { return "DDR"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR2") { return "DDR2"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR3") { return "DDR3"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR4") { return "DDR4"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR4E_SDRAM") { return "DDR4E_SDRAM"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR5") { return "DDR5"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.LPDDR4_SDRAM") { return "LPDDR4_SDRAM"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.LPDDR3_SDRAM") { return "LPDDR3_SDRAM"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR2_SDRAM_FB_DIMM") { return "DDR2_SDRAM_FB_DIMM"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR2_SDRAM_FB_DIMM_PROB") { return "DDR2_SDRAM_FB_DIMM_PROBE"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.DDR_SGRAM") { return "DDR_SGRAM"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.ROM") { return "ROM"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.SDRAM") { return "SDRAM"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.EDO") { return "EDO"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.FastPageMode") { return "FastPageMode"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.PipelinedNibble") { return "PipelinedNibble"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.Logical") { return "Logical"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.HBM") { return "HBM"; } if (memoryType == "xyz.openbmc_project.Inventory.Item.Dimm.DeviceType.HBM2") { return "HBM2"; } // This is values like Other or Unknown // Also D-Bus values: // DRAM // EDRAM // VRAM // SRAM // RAM // FLASH // EEPROM // FEPROM // EPROM // CDRAM // ThreeDRAM // RDRAM // FBD2 // LPDDR_SDRAM // LPDDR2_SDRAM // LPDDR5_SDRAM return ""; } inline void dimmPropToHex( const std::shared_ptr& aResp, const char* key, const std::pair& property, const nlohmann::json::json_pointer& jsonPtr) { const uint16_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for " << property.first; return; } aResp->res.jsonValue[jsonPtr][key] = "0x" + intToHexString(*value, 4); } inline void getPersistentMemoryProperties( const std::shared_ptr& aResp, const std::pair& property, const nlohmann::json::json_pointer& jsonPtr) { if (property.first == "ModuleManufacturerID") { dimmPropToHex(aResp, "ModuleManufacturerID", property, jsonPtr); } else if (property.first == "ModuleProductID") { dimmPropToHex(aResp, "ModuleProductID", property, jsonPtr); } else if (property.first == "SubsystemVendorID") { dimmPropToHex(aResp, "MemorySubsystemControllerManufacturerID", property, jsonPtr); } else if (property.first == "SubsystemDeviceID") { dimmPropToHex(aResp, "MemorySubsystemControllerProductID", property, jsonPtr); } else if (property.first == "VolatileRegionSizeLimitInKiB") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for VolatileRegionSizeLimitKiB"; return; } aResp->res.jsonValue[jsonPtr]["VolatileRegionSizeLimitMiB"] = (*value) >> 10; } else if (property.first == "PmRegionSizeLimitInKiB") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for PmRegioSizeLimitKiB"; return; } aResp->res.jsonValue[jsonPtr]["PersistentRegionSizeLimitMiB"] = (*value) >> 10; } else if (property.first == "VolatileSizeInKiB") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for VolatileSizeInKiB"; return; } aResp->res.jsonValue[jsonPtr]["VolatileSizeMiB"] = (*value) >> 10; } else if (property.first == "PmSizeInKiB") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for PmSizeInKiB"; return; } aResp->res.jsonValue[jsonPtr]["NonVolatileSizeMiB"] = (*value) >> 10; } else if (property.first == "CacheSizeInKB") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for CacheSizeInKB"; return; } aResp->res.jsonValue[jsonPtr]["CacheSizeMiB"] = (*value >> 10); } else if (property.first == "VoltaileRegionMaxSizeInKib") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for VolatileRegionMaxSizeInKib"; return; } aResp->res.jsonValue[jsonPtr]["VolatileRegionSizeMaxMiB"] = (*value) >> 10; } else if (property.first == "PmRegionMaxSizeInKiB") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for PmRegionMaxSizeInKiB"; return; } aResp->res.jsonValue[jsonPtr]["PersistentRegionSizeMaxMiB"] = (*value) >> 10; } else if (property.first == "AllocationIncrementInKiB") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for AllocationIncrementInKiB"; return; } aResp->res.jsonValue[jsonPtr]["AllocationIncrementMiB"] = (*value) >> 10; } else if (property.first == "AllocationAlignmentInKiB") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for AllocationAlignmentInKiB"; return; } aResp->res.jsonValue[jsonPtr]["AllocationAlignmentMiB"] = (*value) >> 10; } else if (property.first == "VolatileRegionNumberLimit") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["VolatileRegionNumberLimit"] = *value; } else if (property.first == "PmRegionNumberLimit") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["PersistentRegionNumberLimit"] = *value; } else if (property.first == "SpareDeviceCount") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["SpareDeviceCount"] = *value; } else if (property.first == "IsSpareDeviceInUse") { const bool* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["IsSpareDeviceEnabled"] = *value; } else if (property.first == "IsRankSpareEnabled") { const bool* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["IsRankSpareEnabled"] = *value; } else if (property.first == "MaxAveragePowerLimitmW") { const auto* value = std::get_if>(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for MaxAveragePowerLimitmW"; return; } aResp->res.jsonValue[jsonPtr]["MaxTDPMilliWatts"] = *value; } else if (property.first == "ConfigurationLocked") { const bool* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["ConfigurationLocked"] = *value; } else if (property.first == "AllowedMemoryModes") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for FormFactor"; return; } constexpr const std::array values{"Volatile", "PMEM", "Block"}; for (const char* v : values) { if (boost::ends_with(*value, v)) { aResp->res.jsonValue[jsonPtr]["OperatingMemoryModes"].push_back( v); break; } } } else if (property.first == "MemoryMedia") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for MemoryMedia"; return; } constexpr const std::array values{"DRAM", "NAND", "Intel3DXPoint"}; for (const char* v : values) { if (boost::ends_with(*value, v)) { aResp->res.jsonValue[jsonPtr]["MemoryMedia"].push_back(v); break; } } } // PersistantMemory.SecurityCapabilites interface else if (property.first == "ConfigurationLockCapable" || property.first == "DataLockCapable" || property.first == "PassphraseCapable") { const bool* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["SecurityCapabilities"][property.first] = *value; } else if (property.first == "MaxPassphraseCount" || property.first == "PassphraseLockLimit") { const uint64_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["SecurityCapabilities"][property.first] = *value; } } inline void assembleDimmProperties(std::string_view dimmId, const std::shared_ptr& aResp, const dbus::utility::DBusPropertiesMap& properties, const nlohmann::json::json_pointer& jsonPtr) { aResp->res.jsonValue[jsonPtr]["Id"] = dimmId; aResp->res.jsonValue[jsonPtr]["Name"] = "DIMM Slot"; aResp->res.jsonValue[jsonPtr]["Status"]["State"] = "Enabled"; aResp->res.jsonValue[jsonPtr]["Status"]["Health"] = "OK"; for (const auto& property : properties) { if (property.first == "MemoryDataWidth") { const uint16_t* value = std::get_if(&property.second); if (value == nullptr) { continue; } aResp->res.jsonValue[jsonPtr]["DataWidthBits"] = *value; } else if (property.first == "MemorySizeInKB") { const size_t* memorySize = std::get_if(&property.second); if (memorySize == nullptr) { // Important property not in desired type messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["CapacityMiB"] = (*memorySize >> 10); } else if (property.first == "PartNumber") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { continue; } aResp->res.jsonValue[jsonPtr]["PartNumber"] = *value; } else if (property.first == "SerialNumber") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { continue; } aResp->res.jsonValue[jsonPtr]["SerialNumber"] = *value; } else if (property.first == "Manufacturer") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { continue; } aResp->res.jsonValue[jsonPtr]["Manufacturer"] = *value; } else if (property.first == "RevisionCode") { const uint16_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for RevisionCode"; return; } aResp->res.jsonValue[jsonPtr]["FirmwareRevision"] = std::to_string(*value); } else if (property.first == "Present") { const bool* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for Dimm Presence"; return; } if (!*value) { aResp->res.jsonValue[jsonPtr]["Status"]["State"] = "Absent"; } } else if (property.first == "MemoryTotalWidth") { const uint16_t* value = std::get_if(&property.second); if (value == nullptr) { continue; } aResp->res.jsonValue[jsonPtr]["BusWidthBits"] = *value; } else if (property.first == "ECC") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for ECC"; return; } constexpr const std::array values{ "NoECC", "SingleBitECC", "MultiBitECC", "AddressParity"}; for (const char* v : values) { if (boost::ends_with(*value, v)) { aResp->res.jsonValue[jsonPtr]["ErrorCorrection"] = v; break; } } } else if (property.first == "FormFactor") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for FormFactor"; return; } constexpr const std::array values{ "RDIMM", "UDIMM", "SO_DIMM", "LRDIMM", "Mini_RDIMM", "Mini_UDIMM", "SO_RDIMM_72b", "SO_UDIMM_72b", "SO_DIMM_16b", "SO_DIMM_32b", "Die"}; for (const char* v : values) { if (boost::ends_with(*value, v)) { aResp->res.jsonValue[jsonPtr]["BaseModuleType"] = v; break; } } } else if (property.first == "AllowedSpeedsMT") { const std::vector* value = std::get_if>(&property.second); if (value == nullptr) { continue; } nlohmann::json& jValue = aResp->res.jsonValue[jsonPtr]["AllowedSpeedsMHz"]; jValue = nlohmann::json::array(); for (uint16_t subVal : *value) { jValue.push_back(subVal); } } else if (property.first == "MemoryAttributes") { const uint8_t* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for MemoryAttributes"; return; } aResp->res.jsonValue[jsonPtr]["RankCount"] = static_cast(*value); } else if (property.first == "MemoryConfiguredSpeedInMhz") { const uint16_t* value = std::get_if(&property.second); if (value == nullptr) { continue; } aResp->res.jsonValue[jsonPtr]["OperatingSpeedMhz"] = *value; } else if (property.first == "MemoryType") { const auto* value = std::get_if(&property.second); if (value != nullptr) { std::string memoryDeviceType = translateMemoryTypeToRedfish(*value); // Values like "Unknown" or "Other" will return empty // so just leave off if (!memoryDeviceType.empty()) { aResp->res.jsonValue[jsonPtr]["MemoryDeviceType"] = memoryDeviceType; } if (value->find("DDR") != std::string::npos) { aResp->res.jsonValue[jsonPtr]["MemoryType"] = "DRAM"; } else if (boost::ends_with(*value, "Logical")) { aResp->res.jsonValue[jsonPtr]["MemoryType"] = "IntelOptane"; } } } // memory location interface else if (property.first == "Channel" || property.first == "MemoryController" || property.first == "Slot" || property.first == "Socket") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["MemoryLocation"][property.first] = *value; } else if (property.first == "SparePartNumber") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["SparePartNumber"] = *value; } else if (property.first == "Model") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["Model"] = *value; } else if (property.first == "LocationCode") { const std::string* value = std::get_if(&property.second); if (value == nullptr) { messages::internalError(aResp->res); return; } aResp->res.jsonValue[jsonPtr]["Location"]["PartLocation"] ["ServiceLabel"] = *value; } else { getPersistentMemoryProperties(aResp, property, jsonPtr); } } } inline void getDimmDataByService(std::shared_ptr aResp, const std::string& dimmId, const std::string& service, const std::string& objPath) { auto health = std::make_shared(aResp); health->selfPath = objPath; health->populate(); BMCWEB_LOG_DEBUG << "Get available system components."; crow::connections::systemBus->async_method_call( [dimmId, aResp{std::move(aResp)}]( const boost::system::error_code ec, const dbus::utility::DBusPropertiesMap& properties) { if (ec) { BMCWEB_LOG_DEBUG << "DBUS response error"; messages::internalError(aResp->res); return; } assembleDimmProperties(dimmId, aResp, properties, ""_json_pointer); }, service, objPath, "org.freedesktop.DBus.Properties", "GetAll", ""); } inline void assembleDimmPartitionData( const std::shared_ptr& aResp, const dbus::utility::DBusPropertiesMap& properties, const nlohmann::json::json_pointer& regionPtr) { nlohmann::json::object_t partition; for (const auto& [key, val] : properties) { if (key == "MemoryClassification") { const std::string* value = std::get_if(&val); if (value == nullptr) { messages::internalError(aResp->res); return; } partition[key] = *value; } else if (key == "OffsetInKiB") { const uint64_t* value = std::get_if(&val); if (value == nullptr) { messages::internalError(aResp->res); return; } partition["OffsetMiB"] = (*value >> 10); } else if (key == "PartitionId") { const std::string* value = std::get_if(&val); if (value == nullptr) { messages::internalError(aResp->res); return; } partition["RegionId"] = *value; } else if (key == "PassphraseState") { const bool* value = std::get_if(&val); if (value == nullptr) { messages::internalError(aResp->res); return; } partition["PassphraseEnabled"] = *value; } else if (key == "SizeInKiB") { const uint64_t* value = std::get_if(&val); if (value == nullptr) { messages::internalError(aResp->res); BMCWEB_LOG_DEBUG << "Invalid property type for SizeInKiB"; return; } partition["SizeMiB"] = (*value >> 10); } } aResp->res.jsonValue[regionPtr].emplace_back(std::move(partition)); } inline void getDimmPartitionData(std::shared_ptr aResp, const std::string& service, const std::string& path) { crow::connections::systemBus->async_method_call( [aResp{std::move(aResp)}]( const boost::system::error_code ec, const dbus::utility::DBusPropertiesMap& properties) { if (ec) { BMCWEB_LOG_DEBUG << "DBUS response error"; messages::internalError(aResp->res); return; } nlohmann::json::json_pointer regionPtr = "/Regions"_json_pointer; assembleDimmPartitionData(aResp, properties, regionPtr); }, service, path, "org.freedesktop.DBus.Properties", "GetAll", "xyz.openbmc_project.Inventory.Item.PersistentMemory.Partition"); } inline bool pathContainsDimmId(const std::string& path, std::string_view dimmId) { sdbusplus::message::object_path objectPath(path); // for /xyz/openbmc_project/Inventory/Item/Dimm1/Partition1 or // /xyz/openbmc_project/Inventory/Item/Dimm1 return !dimmId.empty() && (objectPath.filename() == dimmId || objectPath.parent_path().filename() == dimmId); } inline void getDimmData(std::shared_ptr aResp, const std::string& dimmId) { BMCWEB_LOG_DEBUG << "Get available system dimm resources."; crow::connections::systemBus->async_method_call( [dimmId, aResp{std::move(aResp)}]( const boost::system::error_code ec, const dbus::utility::MapperGetSubTreeResponse& subtree) { if (ec) { BMCWEB_LOG_DEBUG << "DBUS response error"; messages::internalError(aResp->res); return; } bool found = false; for (const auto& [path, object] : subtree) { if (pathContainsDimmId(path, dimmId)) { for (const auto& [service, interfaces] : object) { for (const auto& interface : interfaces) { if (interface == "xyz.openbmc_project.Inventory.Item.Dimm") { getDimmDataByService(aResp, dimmId, service, path); found = true; } // partitions are separate as there can be multiple // per // device, i.e. // /xyz/openbmc_project/Inventory/Item/Dimm1/Partition1 // /xyz/openbmc_project/Inventory/Item/Dimm1/Partition2 if (interface == "xyz.openbmc_project.Inventory.Item.PersistentMemory.Partition") { getDimmPartitionData(aResp, service, path); } } } } } // Object not found if (!found) { messages::resourceNotFound(aResp->res, "Memory", dimmId); return; } // Set @odata only if object is found aResp->res.jsonValue["@odata.type"] = "#Memory.v1_11_0.Memory"; aResp->res.jsonValue["@odata.id"] = "/redfish/v1/Systems/system/Memory/" + dimmId; return; }, "xyz.openbmc_project.ObjectMapper", "/xyz/openbmc_project/object_mapper", "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/xyz/openbmc_project/inventory", 0, std::array{ "xyz.openbmc_project.Inventory.Item.Dimm", "xyz.openbmc_project.Inventory.Item.PersistentMemory.Partition"}); } inline void requestRoutesMemoryCollection(App& app) { /** * Functions triggers appropriate requests on DBus */ BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/Memory/") .privileges(redfish::privileges::getMemoryCollection) .methods(boost::beast::http::verb::get)( [&app](const crow::Request& req, const std::shared_ptr& asyncResp) { if (!redfish::setUpRedfishRoute(app, req, asyncResp)) { return; } asyncResp->res.jsonValue["@odata.type"] = "#MemoryCollection.MemoryCollection"; asyncResp->res.jsonValue["Name"] = "Memory Module Collection"; asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Systems/system/Memory"; collection_util::getCollectionMembers( asyncResp, "/redfish/v1/Systems/system/Memory", {"xyz.openbmc_project.Inventory.Item.Dimm"}); }); } inline void requestRoutesMemory(App& app) { /** * Functions triggers appropriate requests on DBus */ BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/Memory//") .privileges(redfish::privileges::getMemory) .methods(boost::beast::http::verb::get)( [&app](const crow::Request& req, const std::shared_ptr& asyncResp, const std::string& dimmId) { if (!redfish::setUpRedfishRoute(app, req, asyncResp)) { return; } getDimmData(asyncResp, dimmId); }); } } // namespace redfish