| /* |
| // 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 <boost/container/flat_map.hpp> |
| #include <node.hpp> |
| #include <utils/fw_utils.hpp> |
| #include <utils/json_utils.hpp> |
| #include <variant> |
| |
| namespace redfish |
| { |
| |
| /** |
| * @brief Retrieves computer system properties over dbus |
| * |
| * @param[in] aResp Shared pointer for completing asynchronous calls |
| * @param[in] name Computer system name from request |
| * |
| * @return None. |
| */ |
| void getComputerSystem(std::shared_ptr<AsyncResp> aResp) |
| { |
| BMCWEB_LOG_DEBUG << "Get available system components."; |
| crow::connections::systemBus->async_method_call( |
| [aResp{std::move(aResp)}]( |
| const boost::system::error_code ec, |
| const std::vector<std::pair< |
| std::string, |
| std::vector<std::pair<std::string, std::vector<std::string>>>>> |
| &subtree) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error"; |
| messages::internalError(aResp->res); |
| return; |
| } |
| // Iterate over all retrieved ObjectPaths. |
| for (const std::pair<std::string, |
| std::vector<std::pair< |
| std::string, std::vector<std::string>>>> |
| &object : subtree) |
| { |
| const std::string &path = object.first; |
| BMCWEB_LOG_DEBUG << "Got path: " << path; |
| const std::vector< |
| std::pair<std::string, std::vector<std::string>>> |
| &connectionNames = object.second; |
| if (connectionNames.size() < 1) |
| { |
| continue; |
| } |
| |
| // This is not system, so check if it's cpu, dimm, UUID or |
| // BiosVer |
| for (const auto &connection : connectionNames) |
| { |
| for (const auto &interfaceName : connection.second) |
| { |
| if (interfaceName == |
| "xyz.openbmc_project.Inventory.Item.Dimm") |
| { |
| BMCWEB_LOG_DEBUG |
| << "Found Dimm, now get its properties."; |
| crow::connections::systemBus->async_method_call( |
| [aResp](const boost::system::error_code ec, |
| const std::vector< |
| std::pair<std::string, VariantType>> |
| &properties) { |
| if (ec) |
| { |
| BMCWEB_LOG_ERROR |
| << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Got " |
| << properties.size() |
| << "Dimm properties."; |
| for (const std::pair<std::string, |
| VariantType> |
| &property : properties) |
| { |
| if (property.first == "MemorySizeInKb") |
| { |
| const uint64_t *value = |
| sdbusplus::message::variant_ns:: |
| get_if<uint64_t>( |
| &property.second); |
| if (value != nullptr) |
| { |
| aResp->res.jsonValue |
| ["TotalSystemMemoryGi" |
| "B"] += |
| *value / (1024 * 1024); |
| aResp->res |
| .jsonValue["MemorySummary"] |
| ["Status"] |
| ["State"] = |
| "Enabled"; |
| } |
| } |
| } |
| }, |
| connection.first, path, |
| "org.freedesktop.DBus.Properties", "GetAll", |
| "xyz.openbmc_project.Inventory.Item.Dimm"); |
| } |
| else if (interfaceName == |
| "xyz.openbmc_project.Inventory.Item.Cpu") |
| { |
| BMCWEB_LOG_DEBUG |
| << "Found Cpu, now get its properties."; |
| crow::connections::systemBus->async_method_call( |
| [aResp](const boost::system::error_code ec, |
| const std::vector< |
| std::pair<std::string, VariantType>> |
| &properties) { |
| if (ec) |
| { |
| BMCWEB_LOG_ERROR |
| << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Got " |
| << properties.size() |
| << "Cpu properties."; |
| for (const auto &property : properties) |
| { |
| if (property.first == "ProcessorFamily") |
| { |
| const std::string *value = |
| sdbusplus::message::variant_ns:: |
| get_if<std::string>( |
| &property.second); |
| if (value != nullptr) |
| { |
| nlohmann::json &procSummary = |
| aResp->res.jsonValue |
| ["ProcessorSumm" |
| "ary"]; |
| nlohmann::json &procCount = |
| procSummary["Count"]; |
| |
| procCount = |
| procCount.get<int>() + 1; |
| procSummary["Status"]["State"] = |
| "Enabled"; |
| procSummary["Model"] = *value; |
| } |
| } |
| } |
| }, |
| connection.first, path, |
| "org.freedesktop.DBus.Properties", "GetAll", |
| "xyz.openbmc_project.Inventory.Item.Cpu"); |
| } |
| else if (interfaceName == |
| "xyz.openbmc_project.Common.UUID") |
| { |
| BMCWEB_LOG_DEBUG |
| << "Found UUID, now get its properties."; |
| crow::connections::systemBus->async_method_call( |
| [aResp](const boost::system::error_code ec, |
| const std::vector< |
| std::pair<std::string, VariantType>> |
| &properties) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG |
| << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Got " |
| << properties.size() |
| << "UUID properties."; |
| for (const std::pair<std::string, |
| VariantType> |
| &property : properties) |
| { |
| if (property.first == "UUID") |
| { |
| const std::string *value = |
| sdbusplus::message::variant_ns:: |
| get_if<std::string>( |
| &property.second); |
| |
| if (value != nullptr) |
| { |
| std::string valueStr = *value; |
| if (valueStr.size() == 32) |
| { |
| valueStr.insert(8, 1, '-'); |
| valueStr.insert(13, 1, '-'); |
| valueStr.insert(18, 1, '-'); |
| valueStr.insert(23, 1, '-'); |
| } |
| BMCWEB_LOG_DEBUG << "UUID = " |
| << valueStr; |
| aResp->res.jsonValue["UUID"] = |
| valueStr; |
| } |
| } |
| } |
| }, |
| connection.first, path, |
| "org.freedesktop.DBus.Properties", "GetAll", |
| "xyz.openbmc_project.Common.UUID"); |
| } |
| else if (interfaceName == |
| "xyz.openbmc_project.Inventory.Item.System") |
| { |
| crow::connections::systemBus->async_method_call( |
| [aResp](const boost::system::error_code ec, |
| const std::vector< |
| std::pair<std::string, VariantType>> |
| &propertiesList) { |
| if (ec) |
| { |
| BMCWEB_LOG_ERROR |
| << "DBUS response error: " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Got " |
| << propertiesList.size() |
| << "properties for system"; |
| for (const std::pair<std::string, |
| VariantType> |
| &property : propertiesList) |
| { |
| const std::string &propertyName = |
| property.first; |
| if ((propertyName == "PartNumber") || |
| (propertyName == "SerialNumber") || |
| (propertyName == "Manufacturer") || |
| (propertyName == "Model")) |
| { |
| const std::string *value = |
| std::get_if<std::string>( |
| &property.second); |
| if (value != nullptr) |
| { |
| aResp->res |
| .jsonValue[propertyName] = |
| *value; |
| } |
| } |
| } |
| aResp->res.jsonValue["Name"] = "system"; |
| aResp->res.jsonValue["Id"] = |
| aResp->res.jsonValue["SerialNumber"]; |
| // Grab the bios version |
| fw_util::getActiveFwVersion( |
| aResp, fw_util::biosPurpose, |
| "BiosVersion"); |
| }, |
| connection.first, path, |
| "org.freedesktop.DBus.Properties", "GetAll", |
| "xyz.openbmc_project.Inventory.Decorator." |
| "Asset"); |
| } |
| } |
| } |
| } |
| }, |
| "xyz.openbmc_project.ObjectMapper", |
| "/xyz/openbmc_project/object_mapper", |
| "xyz.openbmc_project.ObjectMapper", "GetSubTree", |
| "/xyz/openbmc_project/inventory", int32_t(0), |
| std::array<const char *, 5>{ |
| "xyz.openbmc_project.Inventory.Decorator.Asset", |
| "xyz.openbmc_project.Inventory.Item.Cpu", |
| "xyz.openbmc_project.Inventory.Item.Dimm", |
| "xyz.openbmc_project.Inventory.Item.System", |
| "xyz.openbmc_project.Common.UUID", |
| }); |
| } |
| |
| /** |
| * @brief Retrieves identify led group properties over dbus |
| * |
| * @param[in] aResp Shared pointer for generating response message. |
| * @param[in] callback Callback for process retrieved data. |
| * |
| * @return None. |
| */ |
| template <typename CallbackFunc> |
| void getLedGroupIdentify(std::shared_ptr<AsyncResp> aResp, |
| CallbackFunc &&callback) |
| { |
| BMCWEB_LOG_DEBUG << "Get led groups"; |
| crow::connections::systemBus->async_method_call( |
| [aResp{std::move(aResp)}, |
| callback{std::move(callback)}](const boost::system::error_code &ec, |
| const ManagedObjectsType &resp) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Got " << resp.size() << "led group objects."; |
| for (const auto &objPath : resp) |
| { |
| const std::string &path = objPath.first; |
| if (path.rfind("enclosure_identify") != std::string::npos) |
| { |
| for (const auto &interface : objPath.second) |
| { |
| if (interface.first == "xyz.openbmc_project.Led.Group") |
| { |
| for (const auto &property : interface.second) |
| { |
| if (property.first == "Asserted") |
| { |
| const bool *asserted = |
| std::get_if<bool>(&property.second); |
| if (nullptr != asserted) |
| { |
| callback(*asserted, aResp); |
| } |
| else |
| { |
| callback(false, aResp); |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "xyz.openbmc_project.LED.GroupManager", |
| "/xyz/openbmc_project/led/groups", "org.freedesktop.DBus.ObjectManager", |
| "GetManagedObjects"); |
| } |
| |
| template <typename CallbackFunc> |
| void getLedIdentify(std::shared_ptr<AsyncResp> aResp, CallbackFunc &&callback) |
| { |
| BMCWEB_LOG_DEBUG << "Get identify led properties"; |
| crow::connections::systemBus->async_method_call( |
| [aResp, |
| callback{std::move(callback)}](const boost::system::error_code ec, |
| const PropertiesType &properties) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Got " << properties.size() |
| << "led properties."; |
| std::string output; |
| for (const auto &property : properties) |
| { |
| if (property.first == "State") |
| { |
| const std::string *s = |
| std::get_if<std::string>(&property.second); |
| if (nullptr != s) |
| { |
| BMCWEB_LOG_DEBUG << "Identify Led State: " << *s; |
| const auto pos = s->rfind('.'); |
| if (pos != std::string::npos) |
| { |
| auto led = s->substr(pos + 1); |
| for (const std::pair<const char *, const char *> |
| &p : |
| std::array< |
| std::pair<const char *, const char *>, 3>{ |
| {{"On", "Lit"}, |
| {"Blink", "Blinking"}, |
| {"Off", "Off"}}}) |
| { |
| if (led == p.first) |
| { |
| output = p.second; |
| } |
| } |
| } |
| } |
| } |
| } |
| callback(output, aResp); |
| }, |
| "xyz.openbmc_project.LED.Controller.identify", |
| "/xyz/openbmc_project/led/physical/identify", |
| "org.freedesktop.DBus.Properties", "GetAll", |
| "xyz.openbmc_project.Led.Physical"); |
| } |
| |
| /** |
| * @brief Retrieves host state properties over dbus |
| * |
| * @param[in] aResp Shared pointer for completing asynchronous calls. |
| * |
| * @return None. |
| */ |
| void getHostState(std::shared_ptr<AsyncResp> aResp) |
| { |
| BMCWEB_LOG_DEBUG << "Get host information."; |
| crow::connections::systemBus->async_method_call( |
| [aResp{std::move(aResp)}](const boost::system::error_code ec, |
| const std::variant<std::string> &hostState) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| |
| const std::string *s = std::get_if<std::string>(&hostState); |
| BMCWEB_LOG_DEBUG << "Host state: " << *s; |
| if (s != nullptr) |
| { |
| // Verify Host State |
| if (*s == "xyz.openbmc_project.State.Host.HostState.Running") |
| { |
| aResp->res.jsonValue["PowerState"] = "On"; |
| aResp->res.jsonValue["Status"]["State"] = "Enabled"; |
| } |
| else |
| { |
| aResp->res.jsonValue["PowerState"] = "Off"; |
| aResp->res.jsonValue["Status"]["State"] = "Disabled"; |
| } |
| } |
| }, |
| "xyz.openbmc_project.State.Host", "/xyz/openbmc_project/state/host0", |
| "org.freedesktop.DBus.Properties", "Get", |
| "xyz.openbmc_project.State.Host", "CurrentHostState"); |
| } |
| |
| /** |
| * @brief Traslates boot source DBUS property value to redfish. |
| * |
| * @param[in] dbusSource The boot source in DBUS speak. |
| * |
| * @return Returns as a string, the boot source in Redfish terms. If translation |
| * cannot be done, returns an empty string. |
| */ |
| static std::string dbusToRfBootSource(const std::string &dbusSource) |
| { |
| if (dbusSource == "xyz.openbmc_project.Control.Boot.Source.Sources.Default") |
| { |
| return "None"; |
| } |
| else if (dbusSource == |
| "xyz.openbmc_project.Control.Boot.Source.Sources.Disk") |
| { |
| return "Hdd"; |
| } |
| else if (dbusSource == |
| "xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia") |
| { |
| return "Cd"; |
| } |
| else if (dbusSource == |
| "xyz.openbmc_project.Control.Boot.Source.Sources.Network") |
| { |
| return "Pxe"; |
| } |
| else |
| { |
| return ""; |
| } |
| } |
| |
| /** |
| * @brief Traslates boot mode DBUS property value to redfish. |
| * |
| * @param[in] dbusMode The boot mode in DBUS speak. |
| * |
| * @return Returns as a string, the boot mode in Redfish terms. If translation |
| * cannot be done, returns an empty string. |
| */ |
| static std::string dbusToRfBootMode(const std::string &dbusMode) |
| { |
| if (dbusMode == "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular") |
| { |
| return "None"; |
| } |
| else if (dbusMode == "xyz.openbmc_project.Control.Boot.Mode.Modes.Safe") |
| { |
| return "Diags"; |
| } |
| else if (dbusMode == "xyz.openbmc_project.Control.Boot.Mode.Modes.Setup") |
| { |
| return "BiosSetup"; |
| } |
| else |
| { |
| return ""; |
| } |
| } |
| |
| /** |
| * @brief Traslates boot source from Redfish to DBUS property value. |
| * |
| * @param[in] rfSource The boot source in Redfish. |
| * |
| * @return Returns as a string, the boot source as expected by DBUS. |
| * If translation cannot be done, returns an empty string. |
| */ |
| static std::string rfToDbusBootSource(const std::string &rfSource) |
| { |
| if (rfSource == "None") |
| { |
| return "xyz.openbmc_project.Control.Boot.Source.Sources.Default"; |
| } |
| else if (rfSource == "Hdd") |
| { |
| return "xyz.openbmc_project.Control.Boot.Source.Sources.Disk"; |
| } |
| else if (rfSource == "Cd") |
| { |
| return "xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia"; |
| } |
| else if (rfSource == "Pxe") |
| { |
| return "xyz.openbmc_project.Control.Boot.Source.Sources.Network"; |
| } |
| else |
| { |
| return ""; |
| } |
| } |
| |
| /** |
| * @brief Traslates boot mode from Redfish to DBUS property value. |
| * |
| * @param[in] rfMode The boot mode in Redfish. |
| * |
| * @return Returns as a string, the boot mode as expected by DBUS. |
| * If translation cannot be done, returns an empty string. |
| */ |
| static std::string rfToDbusBootMode(const std::string &rfMode) |
| { |
| if (rfMode == "None") |
| { |
| return "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"; |
| } |
| else if (rfMode == "Diags") |
| { |
| return "xyz.openbmc_project.Control.Boot.Mode.Modes.Safe"; |
| } |
| else if (rfMode == "BiosSetup") |
| { |
| return "xyz.openbmc_project.Control.Boot.Mode.Modes.Setup"; |
| } |
| else |
| { |
| return ""; |
| } |
| } |
| |
| /** |
| * @brief Retrieves boot mode over DBUS and fills out the response |
| * |
| * @param[in] aResp Shared pointer for generating response message. |
| * @param[in] bootDbusObj The dbus object to query for boot properties. |
| * |
| * @return None. |
| */ |
| static void getBootMode(std::shared_ptr<AsyncResp> aResp, |
| std::string bootDbusObj) |
| { |
| crow::connections::systemBus->async_method_call( |
| [aResp](const boost::system::error_code ec, |
| const std::variant<std::string> &bootMode) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| |
| const std::string *bootModeStr = |
| std::get_if<std::string>(&bootMode); |
| |
| if (!bootModeStr) |
| { |
| messages::internalError(aResp->res); |
| return; |
| } |
| |
| BMCWEB_LOG_DEBUG << "Boot mode: " << *bootModeStr; |
| |
| // TODO (Santosh): Do we need to support override mode? |
| aResp->res.jsonValue["Boot"]["BootSourceOverrideMode"] = "Legacy"; |
| aResp->res.jsonValue["Boot"]["BootSourceOverrideTarget@Redfish." |
| "AllowableValues"] = { |
| "None", "Pxe", "Hdd", "Cd", "Diags", "BiosSetup"}; |
| |
| if (*bootModeStr != |
| "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular") |
| { |
| auto rfMode = dbusToRfBootMode(*bootModeStr); |
| if (!rfMode.empty()) |
| { |
| aResp->res.jsonValue["Boot"]["BootSourceOverrideTarget"] = |
| rfMode; |
| } |
| } |
| |
| // If the BootSourceOverrideTarget is still "None" at the end, |
| // reset the BootSourceOverrideEnabled to indicate that |
| // overrides are disabled |
| if (aResp->res.jsonValue["Boot"]["BootSourceOverrideTarget"] == |
| "None") |
| { |
| aResp->res.jsonValue["Boot"]["BootSourceOverrideEnabled"] = |
| "Disabled"; |
| } |
| }, |
| "xyz.openbmc_project.Settings", bootDbusObj, |
| "org.freedesktop.DBus.Properties", "Get", |
| "xyz.openbmc_project.Control.Boot.Mode", "BootMode"); |
| } |
| |
| /** |
| * @brief Retrieves boot source over DBUS |
| * |
| * @param[in] aResp Shared pointer for generating response message. |
| * @param[in] oneTimeEnable Boolean to indicate boot properties are one-time. |
| * |
| * @return None. |
| */ |
| static void getBootSource(std::shared_ptr<AsyncResp> aResp, bool oneTimeEnabled) |
| { |
| std::string bootDbusObj = |
| oneTimeEnabled ? "/xyz/openbmc_project/control/host0/boot/one_time" |
| : "/xyz/openbmc_project/control/host0/boot"; |
| |
| BMCWEB_LOG_DEBUG << "Is one time: " << oneTimeEnabled; |
| aResp->res.jsonValue["Boot"]["BootSourceOverrideEnabled"] = |
| (oneTimeEnabled) ? "Once" : "Continuous"; |
| |
| crow::connections::systemBus->async_method_call( |
| [aResp, bootDbusObj](const boost::system::error_code ec, |
| const std::variant<std::string> &bootSource) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| |
| const std::string *bootSourceStr = |
| std::get_if<std::string>(&bootSource); |
| |
| if (!bootSourceStr) |
| { |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Boot source: " << *bootSourceStr; |
| |
| auto rfSource = dbusToRfBootSource(*bootSourceStr); |
| if (!rfSource.empty()) |
| { |
| aResp->res.jsonValue["Boot"]["BootSourceOverrideTarget"] = |
| rfSource; |
| } |
| }, |
| "xyz.openbmc_project.Settings", bootDbusObj, |
| "org.freedesktop.DBus.Properties", "Get", |
| "xyz.openbmc_project.Control.Boot.Source", "BootSource"); |
| getBootMode(std::move(aResp), std::move(bootDbusObj)); |
| } |
| |
| /** |
| * @brief Retrieves "One time" enabled setting over DBUS and calls function to |
| * get boot source and boot mode. |
| * |
| * @param[in] aResp Shared pointer for generating response message. |
| * |
| * @return None. |
| */ |
| static void getBootProperties(std::shared_ptr<AsyncResp> aResp) |
| { |
| BMCWEB_LOG_DEBUG << "Get boot information."; |
| |
| crow::connections::systemBus->async_method_call( |
| [aResp{std::move(aResp)}]( |
| const boost::system::error_code ec, |
| const sdbusplus::message::variant<bool> &oneTime) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| |
| const bool *oneTimePtr = std::get_if<bool>(&oneTime); |
| |
| if (!oneTimePtr) |
| { |
| messages::internalError(aResp->res); |
| return; |
| } |
| getBootSource(aResp, *oneTimePtr); |
| }, |
| "xyz.openbmc_project.Settings", |
| "/xyz/openbmc_project/control/host0/boot/one_time", |
| "org.freedesktop.DBus.Properties", "Get", |
| "xyz.openbmc_project.Object.Enable", "Enabled"); |
| } |
| |
| /** |
| * @brief Sets boot properties into DBUS object(s). |
| * |
| * @param[in] aResp Shared pointer for generating response message. |
| * @param[in] oneTimeEnabled Is "one-time" setting already enabled. |
| * @param[in] bootSource The boot source to set. |
| * @param[in] bootEnable The source override "enable" to set. |
| * |
| * @return None. |
| */ |
| static void setBootModeOrSource(std::shared_ptr<AsyncResp> aResp, |
| bool oneTimeEnabled, |
| std::optional<std::string> bootSource, |
| std::optional<std::string> bootEnable) |
| { |
| if (bootEnable && (bootEnable != "Once") && (bootEnable != "Continuous") && |
| (bootEnable != "Disabled")) |
| { |
| BMCWEB_LOG_DEBUG << "Unsupported value for BootSourceOverrideEnabled: " |
| << *bootEnable; |
| messages::propertyValueNotInList(aResp->res, *bootEnable, |
| "BootSourceOverrideEnabled"); |
| return; |
| } |
| |
| bool oneTimeSetting = oneTimeEnabled; |
| // Validate incoming parameters |
| if (bootEnable) |
| { |
| if (*bootEnable == "Once") |
| { |
| oneTimeSetting = true; |
| } |
| else if (*bootEnable == "Continuous") |
| { |
| oneTimeSetting = false; |
| } |
| else if (*bootEnable == "Disabled") |
| { |
| oneTimeSetting = false; |
| } |
| else |
| { |
| |
| BMCWEB_LOG_DEBUG << "Unsupported value for " |
| "BootSourceOverrideEnabled: " |
| << *bootEnable; |
| messages::propertyValueNotInList(aResp->res, *bootEnable, |
| "BootSourceOverrideEnabled"); |
| return; |
| } |
| } |
| std::string bootSourceStr; |
| std::string bootModeStr; |
| if (bootSource) |
| { |
| bootSourceStr = rfToDbusBootSource(*bootSource); |
| bootModeStr = rfToDbusBootMode(*bootSource); |
| |
| BMCWEB_LOG_DEBUG << "DBUS boot source: " << bootSourceStr; |
| BMCWEB_LOG_DEBUG << "DBUS boot mode: " << bootModeStr; |
| |
| if (bootSourceStr.empty() && bootModeStr.empty()) |
| { |
| BMCWEB_LOG_DEBUG << "Invalid property value for " |
| "BootSourceOverrideTarget: " |
| << *bootSource; |
| messages::propertyValueNotInList(aResp->res, *bootSource, |
| "BootSourceTargetOverride"); |
| return; |
| } |
| } |
| const char *bootObj = |
| oneTimeSetting ? "/xyz/openbmc_project/control/host0/boot/one_time" |
| : "/xyz/openbmc_project/control/host0/boot"; |
| // Figure out what properties to set |
| if (bootEnable && (*bootEnable == "Disabled")) |
| { |
| BMCWEB_LOG_DEBUG << "Boot source override will be disabled"; |
| // Request to only turn OFF/ON enabled, if turning enabled OFF, need |
| // to reset the source and mode too. If turning it ON, we only need |
| // to set the enabled property |
| bootSourceStr = |
| "xyz.openbmc_project.Control.Boot.Source.Sources.Default"; |
| bootModeStr = "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"; |
| } |
| else if (bootSource) |
| { |
| // Source target specified |
| BMCWEB_LOG_DEBUG << "Boot source: " << *bootSource; |
| // Figure out which DBUS interface and property to use |
| bootSourceStr = rfToDbusBootSource(*bootSource); |
| bootModeStr = rfToDbusBootMode(*bootSource); |
| |
| BMCWEB_LOG_DEBUG << "DBUS boot source: " << bootSourceStr; |
| BMCWEB_LOG_DEBUG << "DBUS boot mode: " << bootModeStr; |
| |
| if (bootSourceStr.empty() && bootModeStr.empty()) |
| { |
| BMCWEB_LOG_DEBUG << "Invalid property value for " |
| "BootSourceOverrideTarget: " |
| << *bootSource; |
| messages::propertyValueNotInList(aResp->res, *bootSource, |
| "BootSourceTargetOverride"); |
| return; |
| } |
| |
| if (!bootSourceStr.empty()) |
| { |
| // If setting to anything other than default, also reset boot |
| // mode property |
| if (bootSourceStr != |
| "xyz.openbmc_project.Control.Boot.Source.Sources.Default") |
| { |
| bootModeStr = |
| "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"; |
| } |
| } |
| else // if (!bootModeStr.empty()) |
| { |
| // If setting to anything other than default, also reset boot |
| // source property |
| if (bootModeStr != |
| "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular") |
| { |
| bootSourceStr = |
| "xyz.openbmc_project.Control.Boot.Source.Sources.Default"; |
| } |
| } |
| } |
| if (!bootSourceStr.empty()) |
| { |
| crow::connections::systemBus->async_method_call( |
| [aResp](const boost::system::error_code ec) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Boot source update done."; |
| }, |
| "xyz.openbmc_project.Settings", bootObj, |
| "org.freedesktop.DBus.Properties", "Set", |
| "xyz.openbmc_project.Control.Boot.Source", "BootSource", |
| std::variant<std::string>(bootSourceStr)); |
| } |
| if (!bootModeStr.empty()) |
| { |
| crow::connections::systemBus->async_method_call( |
| [aResp](const boost::system::error_code ec) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Boot mode update done."; |
| }, |
| "xyz.openbmc_project.Settings", bootObj, |
| "org.freedesktop.DBus.Properties", "Set", |
| "xyz.openbmc_project.Control.Boot.Mode", "BootMode", |
| std::variant<std::string>(bootModeStr)); |
| } |
| crow::connections::systemBus->async_method_call( |
| [aResp{std::move(aResp)}](const boost::system::error_code ec) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Boot enable update done."; |
| }, |
| "xyz.openbmc_project.Settings", |
| "/xyz/openbmc_project/control/host0/boot/one_time", |
| "org.freedesktop.DBus.Properties", "Set", |
| "xyz.openbmc_project.Object.Enable", "Enabled", |
| std::variant<bool>(oneTimeSetting)); |
| } |
| |
| /** |
| * @brief Retrieves "One time" enabled setting over DBUS and calls function to |
| * set boot source/boot mode properties. |
| * |
| * @param[in] aResp Shared pointer for generating response message. |
| * @param[in] bootSource The boot source from incoming RF request. |
| * @param[in] bootEnable The boot override enable from incoming RF request. |
| * |
| * @return None. |
| */ |
| static void setBootProperties(std::shared_ptr<AsyncResp> aResp, |
| std::optional<std::string> bootSource, |
| std::optional<std::string> bootEnable) |
| { |
| BMCWEB_LOG_DEBUG << "Set boot information."; |
| |
| crow::connections::systemBus->async_method_call( |
| [aResp{std::move(aResp)}, bootSource{std::move(bootSource)}, |
| bootEnable{std::move(bootEnable)}]( |
| const boost::system::error_code ec, |
| const sdbusplus::message::variant<bool> &oneTime) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(aResp->res); |
| return; |
| } |
| |
| const bool *oneTimePtr = std::get_if<bool>(&oneTime); |
| |
| if (!oneTimePtr) |
| { |
| messages::internalError(aResp->res); |
| return; |
| } |
| |
| BMCWEB_LOG_DEBUG << "Got one time: " << *oneTimePtr; |
| |
| setBootModeOrSource(aResp, *oneTimePtr, std::move(bootSource), |
| std::move(bootEnable)); |
| }, |
| "xyz.openbmc_project.Settings", |
| "/xyz/openbmc_project/control/host0/boot/one_time", |
| "org.freedesktop.DBus.Properties", "Get", |
| "xyz.openbmc_project.Object.Enable", "Enabled"); |
| } |
| |
| /** |
| * SystemsCollection derived class for delivering ComputerSystems Collection |
| * Schema |
| */ |
| class SystemsCollection : public Node |
| { |
| public: |
| SystemsCollection(CrowApp &app) : Node(app, "/redfish/v1/Systems/") |
| { |
| entityPrivileges = { |
| {boost::beast::http::verb::get, {{"Login"}}}, |
| {boost::beast::http::verb::head, {{"Login"}}}, |
| {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, |
| {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, |
| {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, |
| {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
| } |
| |
| private: |
| void doGet(crow::Response &res, const crow::Request &req, |
| const std::vector<std::string> ¶ms) override |
| { |
| res.jsonValue["@odata.type"] = |
| "#ComputerSystemCollection.ComputerSystemCollection"; |
| res.jsonValue["@odata.id"] = "/redfish/v1/Systems"; |
| res.jsonValue["@odata.context"] = |
| "/redfish/v1/" |
| "$metadata#ComputerSystemCollection.ComputerSystemCollection"; |
| res.jsonValue["Name"] = "Computer System Collection"; |
| res.jsonValue["Members"] = { |
| {{"@odata.id", "/redfish/v1/Systems/system"}}}; |
| res.jsonValue["Members@odata.count"] = 1; |
| res.end(); |
| } |
| }; |
| |
| /** |
| * SystemActionsReset class supports handle POST method for Reset action. |
| * The class retrieves and sends data directly to D-Bus. |
| */ |
| class SystemActionsReset : public Node |
| { |
| public: |
| SystemActionsReset(CrowApp &app) : |
| Node(app, "/redfish/v1/Systems/system/Actions/ComputerSystem.Reset/") |
| { |
| entityPrivileges = { |
| {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
| } |
| |
| private: |
| /** |
| * Function handles POST method request. |
| * Analyzes POST body message before sends Reset request data to D-Bus. |
| */ |
| void doPost(crow::Response &res, const crow::Request &req, |
| const std::vector<std::string> ¶ms) override |
| { |
| auto asyncResp = std::make_shared<AsyncResp>(res); |
| |
| std::string resetType; |
| if (!json_util::readJson(req, res, "ResetType", resetType)) |
| { |
| return; |
| } |
| |
| if (resetType == "ForceOff") |
| { |
| // Force off acts on the chassis |
| crow::connections::systemBus->async_method_call( |
| [asyncResp](const boost::system::error_code ec) { |
| if (ec) |
| { |
| BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; |
| messages::internalError(asyncResp->res); |
| return; |
| } |
| // TODO Consider support polling mechanism to verify |
| // status of host and chassis after execute the |
| // requested action. |
| messages::success(asyncResp->res); |
| }, |
| "xyz.openbmc_project.State.Chassis", |
| "/xyz/openbmc_project/state/chassis0", |
| "org.freedesktop.DBus.Properties", "Set", |
| "xyz.openbmc_project.State.Chassis", "RequestedPowerTransition", |
| std::variant<std::string>{ |
| "xyz.openbmc_project.State.Chassis.Transition.Off"}); |
| return; |
| } |
| // all other actions operate on the host |
| std::string command; |
| // Execute Reset Action regarding to each reset type. |
| if (resetType == "On") |
| { |
| command = "xyz.openbmc_project.State.Host.Transition.On"; |
| } |
| else if (resetType == "GracefulShutdown") |
| { |
| command = "xyz.openbmc_project.State.Host.Transition.Off"; |
| } |
| else if (resetType == "GracefulRestart") |
| { |
| command = "xyz.openbmc_project.State.Host.Transition.Reboot"; |
| } |
| else |
| { |
| messages::actionParameterUnknown(res, "Reset", resetType); |
| return; |
| } |
| |
| crow::connections::systemBus->async_method_call( |
| [asyncResp](const boost::system::error_code ec) { |
| if (ec) |
| { |
| BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; |
| messages::internalError(asyncResp->res); |
| return; |
| } |
| // TODO Consider support polling mechanism to verify |
| // status of host and chassis after execute the |
| // requested action. |
| messages::success(asyncResp->res); |
| }, |
| "xyz.openbmc_project.State.Host", |
| "/xyz/openbmc_project/state/host0", |
| "org.freedesktop.DBus.Properties", "Set", |
| "xyz.openbmc_project.State.Host", "RequestedHostTransition", |
| std::variant<std::string>{command}); |
| } |
| }; |
| |
| /** |
| * Systems derived class for delivering Computer Systems Schema. |
| */ |
| class Systems : public Node |
| { |
| public: |
| /* |
| * Default Constructor |
| */ |
| Systems(CrowApp &app) : Node(app, "/redfish/v1/Systems/system/") |
| { |
| entityPrivileges = { |
| {boost::beast::http::verb::get, {{"Login"}}}, |
| {boost::beast::http::verb::head, {{"Login"}}}, |
| {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, |
| {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, |
| {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, |
| {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
| } |
| |
| private: |
| /** |
| * Functions triggers appropriate requests on DBus |
| */ |
| void doGet(crow::Response &res, const crow::Request &req, |
| const std::vector<std::string> ¶ms) override |
| { |
| res.jsonValue["@odata.type"] = "#ComputerSystem.v1_6_0.ComputerSystem"; |
| res.jsonValue["@odata.context"] = |
| "/redfish/v1/$metadata#ComputerSystem.ComputerSystem"; |
| res.jsonValue["Name"] = "Computer System"; |
| res.jsonValue["Id"] = "system"; |
| res.jsonValue["SystemType"] = "Physical"; |
| res.jsonValue["Description"] = "Computer System"; |
| res.jsonValue["ProcessorSummary"]["Count"] = 0; |
| res.jsonValue["ProcessorSummary"]["Status"]["State"] = "Disabled"; |
| res.jsonValue["MemorySummary"]["TotalSystemMemoryGiB"] = int(0); |
| res.jsonValue["MemorySummary"]["Status"]["State"] = "Disabled"; |
| res.jsonValue["@odata.id"] = "/redfish/v1/Systems/system"; |
| |
| res.jsonValue["Processors"] = { |
| {"@odata.id", "/redfish/v1/Systems/system/Processors"}}; |
| res.jsonValue["Memory"] = { |
| {"@odata.id", "/redfish/v1/Systems/system/Memory"}}; |
| |
| // TODO Need to support ForceRestart. |
| res.jsonValue["Actions"]["#ComputerSystem.Reset"] = { |
| {"target", |
| "/redfish/v1/Systems/system/Actions/ComputerSystem.Reset"}, |
| {"ResetType@Redfish.AllowableValues", |
| {"On", "ForceOff", "GracefulRestart", "GracefulShutdown"}}}; |
| |
| res.jsonValue["LogServices"] = { |
| {"@odata.id", "/redfish/v1/Systems/system/LogServices"}}; |
| |
| #ifdef BMCWEB_ENABLE_REDFISH_ONE_CHASSIS |
| res.jsonValue["Links"]["Chassis"] = { |
| {{"@odata.id", "/redfish/v1/Chassis/chassis"}}}; |
| #endif |
| |
| auto asyncResp = std::make_shared<AsyncResp>(res); |
| |
| getLedGroupIdentify( |
| asyncResp, |
| [&](const bool &asserted, const std::shared_ptr<AsyncResp> &aResp) { |
| if (asserted) |
| { |
| // If led group is asserted, then another call is needed to |
| // get led status |
| getLedIdentify( |
| aResp, [](const std::string &ledStatus, |
| const std::shared_ptr<AsyncResp> &aResp) { |
| if (!ledStatus.empty()) |
| { |
| aResp->res.jsonValue["IndicatorLED"] = |
| ledStatus; |
| } |
| }); |
| } |
| else |
| { |
| aResp->res.jsonValue["IndicatorLED"] = "Off"; |
| } |
| }); |
| getComputerSystem(asyncResp); |
| getHostState(asyncResp); |
| getBootProperties(asyncResp); |
| } |
| |
| void doPatch(crow::Response &res, const crow::Request &req, |
| const std::vector<std::string> ¶ms) override |
| { |
| std::optional<std::string> indicatorLed; |
| std::optional<nlohmann::json> bootProps; |
| if (!json_util::readJson(req, res, "IndicatorLED", indicatorLed, "Boot", |
| bootProps)) |
| { |
| return; |
| } |
| |
| auto asyncResp = std::make_shared<AsyncResp>(res); |
| messages::success(asyncResp->res); |
| |
| if (bootProps) |
| { |
| std::optional<std::string> bootSource; |
| std::optional<std::string> bootEnable; |
| |
| if (!json_util::readJson(*bootProps, asyncResp->res, |
| "BootSourceOverrideTarget", bootSource, |
| "BootSourceOverrideEnabled", bootEnable)) |
| { |
| return; |
| } |
| setBootProperties(asyncResp, std::move(bootSource), |
| std::move(bootEnable)); |
| } |
| if (indicatorLed) |
| { |
| std::string dbusLedState; |
| if (*indicatorLed == "On") |
| { |
| dbusLedState = "xyz.openbmc_project.Led.Physical.Action.Lit"; |
| } |
| else if (*indicatorLed == "Blinking") |
| { |
| dbusLedState = "xyz.openbmc_project.Led.Physical.Action.Blink"; |
| } |
| else if (*indicatorLed == "Off") |
| { |
| dbusLedState = "xyz.openbmc_project.Led.Physical.Action.Off"; |
| } |
| else |
| { |
| messages::propertyValueNotInList(res, *indicatorLed, |
| "IndicatorLED"); |
| return; |
| } |
| |
| getHostState(asyncResp); |
| getComputerSystem(asyncResp); |
| |
| // Update led group |
| BMCWEB_LOG_DEBUG << "Update led group."; |
| crow::connections::systemBus->async_method_call( |
| [asyncResp](const boost::system::error_code ec) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(asyncResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Led group update done."; |
| }, |
| "xyz.openbmc_project.LED.GroupManager", |
| "/xyz/openbmc_project/led/groups/enclosure_identify", |
| "org.freedesktop.DBus.Properties", "Set", |
| "xyz.openbmc_project.Led.Group", "Asserted", |
| std::variant<bool>( |
| (dbusLedState == |
| "xyz.openbmc_project.Led.Physical.Action.Off" |
| ? false |
| : true))); |
| // Update identify led status |
| BMCWEB_LOG_DEBUG << "Update led SoftwareInventoryCollection."; |
| crow::connections::systemBus->async_method_call( |
| [asyncResp{std::move(asyncResp)}, |
| indicatorLed{std::move(*indicatorLed)}]( |
| const boost::system::error_code ec) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(asyncResp->res); |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "Led state update done."; |
| }, |
| "xyz.openbmc_project.LED.Controller.identify", |
| "/xyz/openbmc_project/led/physical/identify", |
| "org.freedesktop.DBus.Properties", "Set", |
| "xyz.openbmc_project.Led.Physical", "State", |
| std::variant<std::string>(dbusLedState)); |
| } |
| } |
| }; |
| } // namespace redfish |