xref: /openbmc/bmcweb/features/redfish/lib/systems.hpp (revision 543f44000a992870ff76e76888dd589a3a31ed4e)
1c5b2abe0SLewanczyk, Dawid /*
2c5b2abe0SLewanczyk, Dawid // Copyright (c) 2018 Intel Corporation
3c5b2abe0SLewanczyk, Dawid //
4c5b2abe0SLewanczyk, Dawid // Licensed under the Apache License, Version 2.0 (the "License");
5c5b2abe0SLewanczyk, Dawid // you may not use this file except in compliance with the License.
6c5b2abe0SLewanczyk, Dawid // You may obtain a copy of the License at
7c5b2abe0SLewanczyk, Dawid //
8c5b2abe0SLewanczyk, Dawid //      http://www.apache.org/licenses/LICENSE-2.0
9c5b2abe0SLewanczyk, Dawid //
10c5b2abe0SLewanczyk, Dawid // Unless required by applicable law or agreed to in writing, software
11c5b2abe0SLewanczyk, Dawid // distributed under the License is distributed on an "AS IS" BASIS,
12c5b2abe0SLewanczyk, Dawid // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13c5b2abe0SLewanczyk, Dawid // See the License for the specific language governing permissions and
14c5b2abe0SLewanczyk, Dawid // limitations under the License.
15c5b2abe0SLewanczyk, Dawid */
16c5b2abe0SLewanczyk, Dawid #pragma once
17c5b2abe0SLewanczyk, Dawid 
181e1e598dSJonathan Doman #include "dbus_singleton.hpp"
19b49ac873SJames Feist #include "health.hpp"
201c8fba97SJames Feist #include "led.hpp"
21f5c9f8bdSJason M. Bills #include "pcie.hpp"
22c5d03ff4SJennifer Lee #include "redfish_util.hpp"
23c5d03ff4SJennifer Lee 
247e860f15SJohn Edward Broadbent #include <app.hpp>
259712f8acSEd Tanous #include <boost/container/flat_map.hpp>
26168e20c1SEd Tanous #include <dbus_utility.hpp>
27ed398213SEd Tanous #include <registries/privilege_registry.hpp>
281e1e598dSJonathan Doman #include <sdbusplus/asio/property.hpp>
29cb7e1e7bSAndrew Geissler #include <utils/fw_utils.hpp>
30c5b2abe0SLewanczyk, Dawid #include <utils/json_utils.hpp>
311214b7e7SGunnar Mills 
32abf2add6SEd Tanous #include <variant>
33c5b2abe0SLewanczyk, Dawid 
341abe55efSEd Tanous namespace redfish
351abe55efSEd Tanous {
36c5b2abe0SLewanczyk, Dawid 
379d3ae10eSAlpana Kumari /**
389d3ae10eSAlpana Kumari  * @brief Updates the Functional State of DIMMs
399d3ae10eSAlpana Kumari  *
409d3ae10eSAlpana Kumari  * @param[in] aResp Shared pointer for completing asynchronous calls
419d3ae10eSAlpana Kumari  * @param[in] dimmState Dimm's Functional state, true/false
429d3ae10eSAlpana Kumari  *
439d3ae10eSAlpana Kumari  * @return None.
449d3ae10eSAlpana Kumari  */
458d1b46d7Szhanghch05 inline void
468d1b46d7Szhanghch05     updateDimmProperties(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
471e1e598dSJonathan Doman                          bool isDimmFunctional)
489d3ae10eSAlpana Kumari {
491e1e598dSJonathan Doman     BMCWEB_LOG_DEBUG << "Dimm Functional: " << isDimmFunctional;
509d3ae10eSAlpana Kumari 
519d3ae10eSAlpana Kumari     // Set it as Enabled if at least one DIMM is functional
529d3ae10eSAlpana Kumari     // Update STATE only if previous State was DISABLED and current Dimm is
539d3ae10eSAlpana Kumari     // ENABLED.
549d3ae10eSAlpana Kumari     nlohmann::json& prevMemSummary =
559d3ae10eSAlpana Kumari         aResp->res.jsonValue["MemorySummary"]["Status"]["State"];
569d3ae10eSAlpana Kumari     if (prevMemSummary == "Disabled")
579d3ae10eSAlpana Kumari     {
581e1e598dSJonathan Doman         if (isDimmFunctional == true)
599d3ae10eSAlpana Kumari         {
609d3ae10eSAlpana Kumari             aResp->res.jsonValue["MemorySummary"]["Status"]["State"] =
619d3ae10eSAlpana Kumari                 "Enabled";
629d3ae10eSAlpana Kumari         }
639d3ae10eSAlpana Kumari     }
649d3ae10eSAlpana Kumari }
659d3ae10eSAlpana Kumari 
6657e8c9beSAlpana Kumari /*
6757e8c9beSAlpana Kumari  * @brief Update "ProcessorSummary" "Count" based on Cpu PresenceState
6857e8c9beSAlpana Kumari  *
6957e8c9beSAlpana Kumari  * @param[in] aResp Shared pointer for completing asynchronous calls
7057e8c9beSAlpana Kumari  * @param[in] cpuPresenceState CPU present or not
7157e8c9beSAlpana Kumari  *
7257e8c9beSAlpana Kumari  * @return None.
7357e8c9beSAlpana Kumari  */
741e1e598dSJonathan Doman inline void
751e1e598dSJonathan Doman     modifyCpuPresenceState(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
761e1e598dSJonathan Doman                            bool isCpuPresent)
7757e8c9beSAlpana Kumari {
781e1e598dSJonathan Doman     BMCWEB_LOG_DEBUG << "Cpu Present: " << isCpuPresent;
7957e8c9beSAlpana Kumari 
801e1e598dSJonathan Doman     if (isCpuPresent == true)
8157e8c9beSAlpana Kumari     {
82b4b9595aSJames Feist         nlohmann::json& procCount =
83b4b9595aSJames Feist             aResp->res.jsonValue["ProcessorSummary"]["Count"];
84b4b9595aSJames Feist         auto procCountPtr =
85b4b9595aSJames Feist             procCount.get_ptr<nlohmann::json::number_integer_t*>();
86b4b9595aSJames Feist         if (procCountPtr != nullptr)
87b4b9595aSJames Feist         {
88b4b9595aSJames Feist             // shouldn't be possible to be nullptr
89b4b9595aSJames Feist             *procCountPtr += 1;
9057e8c9beSAlpana Kumari         }
91b4b9595aSJames Feist     }
9257e8c9beSAlpana Kumari }
9357e8c9beSAlpana Kumari 
9457e8c9beSAlpana Kumari /*
9557e8c9beSAlpana Kumari  * @brief Update "ProcessorSummary" "Status" "State" based on
9657e8c9beSAlpana Kumari  *        CPU Functional State
9757e8c9beSAlpana Kumari  *
9857e8c9beSAlpana Kumari  * @param[in] aResp Shared pointer for completing asynchronous calls
9957e8c9beSAlpana Kumari  * @param[in] cpuFunctionalState is CPU functional true/false
10057e8c9beSAlpana Kumari  *
10157e8c9beSAlpana Kumari  * @return None.
10257e8c9beSAlpana Kumari  */
1031e1e598dSJonathan Doman inline void
1041e1e598dSJonathan Doman     modifyCpuFunctionalState(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
1051e1e598dSJonathan Doman                              bool isCpuFunctional)
10657e8c9beSAlpana Kumari {
1071e1e598dSJonathan Doman     BMCWEB_LOG_DEBUG << "Cpu Functional: " << isCpuFunctional;
10857e8c9beSAlpana Kumari 
10957e8c9beSAlpana Kumari     nlohmann::json& prevProcState =
11057e8c9beSAlpana Kumari         aResp->res.jsonValue["ProcessorSummary"]["Status"]["State"];
11157e8c9beSAlpana Kumari 
11257e8c9beSAlpana Kumari     // Set it as Enabled if at least one CPU is functional
11357e8c9beSAlpana Kumari     // Update STATE only if previous State was Non_Functional and current CPU is
11457e8c9beSAlpana Kumari     // Functional.
11557e8c9beSAlpana Kumari     if (prevProcState == "Disabled")
11657e8c9beSAlpana Kumari     {
1171e1e598dSJonathan Doman         if (isCpuFunctional == true)
11857e8c9beSAlpana Kumari         {
11957e8c9beSAlpana Kumari             aResp->res.jsonValue["ProcessorSummary"]["Status"]["State"] =
12057e8c9beSAlpana Kumari                 "Enabled";
12157e8c9beSAlpana Kumari         }
12257e8c9beSAlpana Kumari     }
12357e8c9beSAlpana Kumari }
12457e8c9beSAlpana Kumari 
12503fbed92SAli Ahmed inline void getProcessorProperties(
12603fbed92SAli Ahmed     const std::shared_ptr<bmcweb::AsyncResp>& aResp, const std::string& service,
12703fbed92SAli Ahmed     const std::string& path,
128168e20c1SEd Tanous     const std::vector<std::pair<std::string, dbus::utility::DbusVariantType>>&
12903fbed92SAli Ahmed         properties)
13003fbed92SAli Ahmed {
13103fbed92SAli Ahmed 
13203fbed92SAli Ahmed     BMCWEB_LOG_DEBUG << "Got " << properties.size() << " Cpu properties.";
13303fbed92SAli Ahmed 
1341e1e598dSJonathan Doman     auto getCpuPresenceState = [aResp](const boost::system::error_code ec3,
1351e1e598dSJonathan Doman                                        const bool cpuPresenceCheck) {
13603fbed92SAli Ahmed         if (ec3)
13703fbed92SAli Ahmed         {
13803fbed92SAli Ahmed             BMCWEB_LOG_ERROR << "DBUS response error " << ec3;
13903fbed92SAli Ahmed             return;
14003fbed92SAli Ahmed         }
14103fbed92SAli Ahmed         modifyCpuPresenceState(aResp, cpuPresenceCheck);
14203fbed92SAli Ahmed     };
14303fbed92SAli Ahmed 
1441e1e598dSJonathan Doman     auto getCpuFunctionalState = [aResp](const boost::system::error_code ec3,
1451e1e598dSJonathan Doman                                          const bool cpuFunctionalCheck) {
14603fbed92SAli Ahmed         if (ec3)
14703fbed92SAli Ahmed         {
14803fbed92SAli Ahmed             BMCWEB_LOG_ERROR << "DBUS response error " << ec3;
14903fbed92SAli Ahmed             return;
15003fbed92SAli Ahmed         }
15103fbed92SAli Ahmed         modifyCpuFunctionalState(aResp, cpuFunctionalCheck);
15203fbed92SAli Ahmed     };
15303fbed92SAli Ahmed 
15403fbed92SAli Ahmed     // Get the Presence of CPU
1551e1e598dSJonathan Doman     sdbusplus::asio::getProperty<bool>(
1561e1e598dSJonathan Doman         *crow::connections::systemBus, service, path,
1571e1e598dSJonathan Doman         "xyz.openbmc_project.Inventory.Item", "Present",
1581e1e598dSJonathan Doman         std::move(getCpuPresenceState));
15903fbed92SAli Ahmed 
16003fbed92SAli Ahmed     // Get the Functional State
1611e1e598dSJonathan Doman     sdbusplus::asio::getProperty<bool>(
1621e1e598dSJonathan Doman         *crow::connections::systemBus, service, path,
1631e1e598dSJonathan Doman         "xyz.openbmc_project.State.Decorator.OperationalStatus", "Functional",
1641e1e598dSJonathan Doman         std::move(getCpuFunctionalState));
16503fbed92SAli Ahmed 
16603fbed92SAli Ahmed     for (const auto& property : properties)
16703fbed92SAli Ahmed     {
16803fbed92SAli Ahmed 
16903fbed92SAli Ahmed         // TODO: Get Model
17003fbed92SAli Ahmed 
17103fbed92SAli Ahmed         // Get CoreCount
17203fbed92SAli Ahmed         if (property.first == "CoreCount")
17303fbed92SAli Ahmed         {
17403fbed92SAli Ahmed 
17503fbed92SAli Ahmed             // Get CPU CoreCount and add it to the total
17603fbed92SAli Ahmed             const uint16_t* coreCountVal =
17703fbed92SAli Ahmed                 std::get_if<uint16_t>(&property.second);
17803fbed92SAli Ahmed 
17903fbed92SAli Ahmed             if (!coreCountVal)
18003fbed92SAli Ahmed             {
18103fbed92SAli Ahmed                 messages::internalError(aResp->res);
18203fbed92SAli Ahmed                 return;
18303fbed92SAli Ahmed             }
18403fbed92SAli Ahmed 
18503fbed92SAli Ahmed             nlohmann::json& coreCount =
18603fbed92SAli Ahmed                 aResp->res.jsonValue["ProcessorSummary"]["CoreCount"];
18703fbed92SAli Ahmed             uint64_t* coreCountPtr = coreCount.get_ptr<uint64_t*>();
18803fbed92SAli Ahmed 
18903fbed92SAli Ahmed             if (coreCountPtr == nullptr)
19003fbed92SAli Ahmed             {
19103fbed92SAli Ahmed                 coreCount = 0;
19203fbed92SAli Ahmed             }
19303fbed92SAli Ahmed             else
19403fbed92SAli Ahmed             {
19503fbed92SAli Ahmed                 *coreCountPtr += *coreCountVal;
19603fbed92SAli Ahmed             }
19703fbed92SAli Ahmed         }
19803fbed92SAli Ahmed     }
19903fbed92SAli Ahmed }
20003fbed92SAli Ahmed 
20103fbed92SAli Ahmed /*
20203fbed92SAli Ahmed  * @brief Get ProcessorSummary fields
20303fbed92SAli Ahmed  *
20403fbed92SAli Ahmed  * @param[in] aResp Shared pointer for completing asynchronous calls
20503fbed92SAli Ahmed  * @param[in] service dbus service for Cpu Information
20603fbed92SAli Ahmed  * @param[in] path dbus path for Cpu
20703fbed92SAli Ahmed  *
20803fbed92SAli Ahmed  * @return None.
20903fbed92SAli Ahmed  */
21003fbed92SAli Ahmed inline void getProcessorSummary(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
21103fbed92SAli Ahmed                                 const std::string& service,
21203fbed92SAli Ahmed                                 const std::string& path)
21303fbed92SAli Ahmed {
21403fbed92SAli Ahmed 
21503fbed92SAli Ahmed     crow::connections::systemBus->async_method_call(
21603fbed92SAli Ahmed         [aResp, service,
21703fbed92SAli Ahmed          path](const boost::system::error_code ec2,
21803fbed92SAli Ahmed                const std::vector<std::pair<
219168e20c1SEd Tanous                    std::string, dbus::utility::DbusVariantType>>& properties) {
22003fbed92SAli Ahmed             if (ec2)
22103fbed92SAli Ahmed             {
22203fbed92SAli Ahmed                 BMCWEB_LOG_ERROR << "DBUS response error " << ec2;
22303fbed92SAli Ahmed                 messages::internalError(aResp->res);
22403fbed92SAli Ahmed                 return;
22503fbed92SAli Ahmed             }
22603fbed92SAli Ahmed             getProcessorProperties(aResp, service, path, properties);
22703fbed92SAli Ahmed         },
22803fbed92SAli Ahmed         service, path, "org.freedesktop.DBus.Properties", "GetAll",
22903fbed92SAli Ahmed         "xyz.openbmc_project.Inventory.Item.Cpu");
23003fbed92SAli Ahmed }
23103fbed92SAli Ahmed 
23257e8c9beSAlpana Kumari /*
233c5b2abe0SLewanczyk, Dawid  * @brief Retrieves computer system properties over dbus
234c5b2abe0SLewanczyk, Dawid  *
235c5b2abe0SLewanczyk, Dawid  * @param[in] aResp Shared pointer for completing asynchronous calls
2368f9ee3cdSGunnar Mills  * @param[in] systemHealth  Shared HealthPopulate pointer
237c5b2abe0SLewanczyk, Dawid  *
238c5b2abe0SLewanczyk, Dawid  * @return None.
239c5b2abe0SLewanczyk, Dawid  */
240b5a76932SEd Tanous inline void
2418d1b46d7Szhanghch05     getComputerSystem(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
242b5a76932SEd Tanous                       const std::shared_ptr<HealthPopulate>& systemHealth)
2431abe55efSEd Tanous {
24455c7b7a2SEd Tanous     BMCWEB_LOG_DEBUG << "Get available system components.";
2459d3ae10eSAlpana Kumari 
24655c7b7a2SEd Tanous     crow::connections::systemBus->async_method_call(
2475bc2dc8eSJames Feist         [aResp, systemHealth](
248c5b2abe0SLewanczyk, Dawid             const boost::system::error_code ec,
249c5b2abe0SLewanczyk, Dawid             const std::vector<std::pair<
2506c34de48SEd Tanous                 std::string,
2511214b7e7SGunnar Mills                 std::vector<std::pair<std::string, std::vector<std::string>>>>>&
2521214b7e7SGunnar Mills                 subtree) {
2531abe55efSEd Tanous             if (ec)
2541abe55efSEd Tanous             {
25555c7b7a2SEd Tanous                 BMCWEB_LOG_DEBUG << "DBUS response error";
256f12894f8SJason M. Bills                 messages::internalError(aResp->res);
257c5b2abe0SLewanczyk, Dawid                 return;
258c5b2abe0SLewanczyk, Dawid             }
259c5b2abe0SLewanczyk, Dawid             // Iterate over all retrieved ObjectPaths.
2606c34de48SEd Tanous             for (const std::pair<std::string,
2616c34de48SEd Tanous                                  std::vector<std::pair<
2621214b7e7SGunnar Mills                                      std::string, std::vector<std::string>>>>&
2631214b7e7SGunnar Mills                      object : subtree)
2641abe55efSEd Tanous             {
265c5b2abe0SLewanczyk, Dawid                 const std::string& path = object.first;
26655c7b7a2SEd Tanous                 BMCWEB_LOG_DEBUG << "Got path: " << path;
2671abe55efSEd Tanous                 const std::vector<
2681214b7e7SGunnar Mills                     std::pair<std::string, std::vector<std::string>>>&
2691214b7e7SGunnar Mills                     connectionNames = object.second;
2701abe55efSEd Tanous                 if (connectionNames.size() < 1)
2711abe55efSEd Tanous                 {
272c5b2abe0SLewanczyk, Dawid                     continue;
273c5b2abe0SLewanczyk, Dawid                 }
274029573d4SEd Tanous 
2755bc2dc8eSJames Feist                 auto memoryHealth = std::make_shared<HealthPopulate>(
2765bc2dc8eSJames Feist                     aResp, aResp->res.jsonValue["MemorySummary"]["Status"]);
2775bc2dc8eSJames Feist 
2785bc2dc8eSJames Feist                 auto cpuHealth = std::make_shared<HealthPopulate>(
2795bc2dc8eSJames Feist                     aResp, aResp->res.jsonValue["ProcessorSummary"]["Status"]);
2805bc2dc8eSJames Feist 
2815bc2dc8eSJames Feist                 systemHealth->children.emplace_back(memoryHealth);
2825bc2dc8eSJames Feist                 systemHealth->children.emplace_back(cpuHealth);
2835bc2dc8eSJames Feist 
2846c34de48SEd Tanous                 // This is not system, so check if it's cpu, dimm, UUID or
2856c34de48SEd Tanous                 // BiosVer
28604a258f4SEd Tanous                 for (const auto& connection : connectionNames)
2871abe55efSEd Tanous                 {
28804a258f4SEd Tanous                     for (const auto& interfaceName : connection.second)
2891abe55efSEd Tanous                     {
29004a258f4SEd Tanous                         if (interfaceName ==
29104a258f4SEd Tanous                             "xyz.openbmc_project.Inventory.Item.Dimm")
2921abe55efSEd Tanous                         {
2931abe55efSEd Tanous                             BMCWEB_LOG_DEBUG
29404a258f4SEd Tanous                                 << "Found Dimm, now get its properties.";
2959d3ae10eSAlpana Kumari 
29655c7b7a2SEd Tanous                             crow::connections::systemBus->async_method_call(
2979d3ae10eSAlpana Kumari                                 [aResp, service{connection.first},
298f23b7296SEd Tanous                                  path](const boost::system::error_code ec2,
299168e20c1SEd Tanous                                        const std::vector<std::pair<
300168e20c1SEd Tanous                                            std::string,
301168e20c1SEd Tanous                                            dbus::utility::DbusVariantType>>&
3021214b7e7SGunnar Mills                                            properties) {
303cb13a392SEd Tanous                                     if (ec2)
3041abe55efSEd Tanous                                     {
3051abe55efSEd Tanous                                         BMCWEB_LOG_ERROR
306cb13a392SEd Tanous                                             << "DBUS response error " << ec2;
307f12894f8SJason M. Bills                                         messages::internalError(aResp->res);
308c5b2abe0SLewanczyk, Dawid                                         return;
309c5b2abe0SLewanczyk, Dawid                                     }
3106c34de48SEd Tanous                                     BMCWEB_LOG_DEBUG << "Got "
3116c34de48SEd Tanous                                                      << properties.size()
312c5b2abe0SLewanczyk, Dawid                                                      << " Dimm properties.";
3139d3ae10eSAlpana Kumari 
3149d3ae10eSAlpana Kumari                                     if (properties.size() > 0)
3159d3ae10eSAlpana Kumari                                     {
316168e20c1SEd Tanous                                         for (const std::pair<
317168e20c1SEd Tanous                                                  std::string,
318168e20c1SEd Tanous                                                  dbus::utility::
319168e20c1SEd Tanous                                                      DbusVariantType>&
3201214b7e7SGunnar Mills                                                  property : properties)
3211abe55efSEd Tanous                                         {
3225fd7ba65SCheng C Yang                                             if (property.first !=
3235fd7ba65SCheng C Yang                                                 "MemorySizeInKB")
3241abe55efSEd Tanous                                             {
3255fd7ba65SCheng C Yang                                                 continue;
3265fd7ba65SCheng C Yang                                             }
3275fd7ba65SCheng C Yang                                             const uint32_t* value =
3288d78b7a9SPatrick Williams                                                 std::get_if<uint32_t>(
3291b6b96c5SEd Tanous                                                     &property.second);
3305fd7ba65SCheng C Yang                                             if (value == nullptr)
3311abe55efSEd Tanous                                             {
3325fd7ba65SCheng C Yang                                                 BMCWEB_LOG_DEBUG
3330fda0f12SGeorge Liu                                                     << "Find incorrect type of MemorySize";
3345fd7ba65SCheng C Yang                                                 continue;
3355fd7ba65SCheng C Yang                                             }
3365fd7ba65SCheng C Yang                                             nlohmann::json& totalMemory =
3370fda0f12SGeorge Liu                                                 aResp->res.jsonValue
3380fda0f12SGeorge Liu                                                     ["MemorySummary"]
3390fda0f12SGeorge Liu                                                     ["TotalSystemMemoryGiB"];
3405fd7ba65SCheng C Yang                                             uint64_t* preValue =
3415fd7ba65SCheng C Yang                                                 totalMemory
3425fd7ba65SCheng C Yang                                                     .get_ptr<uint64_t*>();
3435fd7ba65SCheng C Yang                                             if (preValue == nullptr)
3445fd7ba65SCheng C Yang                                             {
3455fd7ba65SCheng C Yang                                                 continue;
3465fd7ba65SCheng C Yang                                             }
3470fda0f12SGeorge Liu                                             aResp->res.jsonValue
3480fda0f12SGeorge Liu                                                 ["MemorySummary"]
3490fda0f12SGeorge Liu                                                 ["TotalSystemMemoryGiB"] =
3505fd7ba65SCheng C Yang                                                 *value / (1024 * 1024) +
3515fd7ba65SCheng C Yang                                                 *preValue;
3525fd7ba65SCheng C Yang                                             aResp->res
3535fd7ba65SCheng C Yang                                                 .jsonValue["MemorySummary"]
3549d3ae10eSAlpana Kumari                                                           ["Status"]["State"] =
3551abe55efSEd Tanous                                                 "Enabled";
356c5b2abe0SLewanczyk, Dawid                                         }
357c5b2abe0SLewanczyk, Dawid                                     }
3589d3ae10eSAlpana Kumari                                     else
3599d3ae10eSAlpana Kumari                                     {
3601e1e598dSJonathan Doman                                         sdbusplus::asio::getProperty<bool>(
3611e1e598dSJonathan Doman                                             *crow::connections::systemBus,
3621e1e598dSJonathan Doman                                             service, path,
3631e1e598dSJonathan Doman                                             "xyz.openbmc_project.State."
3641e1e598dSJonathan Doman                                             "Decorator.OperationalStatus",
3651e1e598dSJonathan Doman                                             "Functional",
3669d3ae10eSAlpana Kumari                                             [aResp](
3679d3ae10eSAlpana Kumari                                                 const boost::system::error_code
368cb13a392SEd Tanous                                                     ec3,
3691e1e598dSJonathan Doman                                                 bool dimmState) {
370cb13a392SEd Tanous                                                 if (ec3)
3719d3ae10eSAlpana Kumari                                                 {
3729d3ae10eSAlpana Kumari                                                     BMCWEB_LOG_ERROR
3730fda0f12SGeorge Liu                                                         << "DBUS response error "
374cb13a392SEd Tanous                                                         << ec3;
3759d3ae10eSAlpana Kumari                                                     return;
3769d3ae10eSAlpana Kumari                                                 }
3779d3ae10eSAlpana Kumari                                                 updateDimmProperties(aResp,
3789d3ae10eSAlpana Kumari                                                                      dimmState);
3791e1e598dSJonathan Doman                                             });
3809d3ae10eSAlpana Kumari                                     }
381c5b2abe0SLewanczyk, Dawid                                 },
38204a258f4SEd Tanous                                 connection.first, path,
3836c34de48SEd Tanous                                 "org.freedesktop.DBus.Properties", "GetAll",
3846c34de48SEd Tanous                                 "xyz.openbmc_project.Inventory.Item.Dimm");
3855bc2dc8eSJames Feist 
3865bc2dc8eSJames Feist                             memoryHealth->inventory.emplace_back(path);
3871abe55efSEd Tanous                         }
38804a258f4SEd Tanous                         else if (interfaceName ==
38904a258f4SEd Tanous                                  "xyz.openbmc_project.Inventory.Item.Cpu")
3901abe55efSEd Tanous                         {
3911abe55efSEd Tanous                             BMCWEB_LOG_DEBUG
39204a258f4SEd Tanous                                 << "Found Cpu, now get its properties.";
39357e8c9beSAlpana Kumari 
39403fbed92SAli Ahmed                             getProcessorSummary(aResp, connection.first, path);
3955bc2dc8eSJames Feist 
3965bc2dc8eSJames Feist                             cpuHealth->inventory.emplace_back(path);
3971abe55efSEd Tanous                         }
39804a258f4SEd Tanous                         else if (interfaceName ==
39904a258f4SEd Tanous                                  "xyz.openbmc_project.Common.UUID")
4001abe55efSEd Tanous                         {
4011abe55efSEd Tanous                             BMCWEB_LOG_DEBUG
40204a258f4SEd Tanous                                 << "Found UUID, now get its properties.";
40355c7b7a2SEd Tanous                             crow::connections::systemBus->async_method_call(
404168e20c1SEd Tanous                                 [aResp](const boost::system::error_code ec3,
405168e20c1SEd Tanous                                         const std::vector<std::pair<
406168e20c1SEd Tanous                                             std::string,
407168e20c1SEd Tanous                                             dbus::utility::DbusVariantType>>&
4081214b7e7SGunnar Mills                                             properties) {
409cb13a392SEd Tanous                                     if (ec3)
4101abe55efSEd Tanous                                     {
4111abe55efSEd Tanous                                         BMCWEB_LOG_DEBUG
412cb13a392SEd Tanous                                             << "DBUS response error " << ec3;
413f12894f8SJason M. Bills                                         messages::internalError(aResp->res);
414c5b2abe0SLewanczyk, Dawid                                         return;
415c5b2abe0SLewanczyk, Dawid                                     }
4166c34de48SEd Tanous                                     BMCWEB_LOG_DEBUG << "Got "
4176c34de48SEd Tanous                                                      << properties.size()
418c5b2abe0SLewanczyk, Dawid                                                      << " UUID properties.";
419168e20c1SEd Tanous                                     for (const std::pair<
420168e20c1SEd Tanous                                              std::string,
421168e20c1SEd Tanous                                              dbus::utility::DbusVariantType>&
4221214b7e7SGunnar Mills                                              property : properties)
4231abe55efSEd Tanous                                     {
42404a258f4SEd Tanous                                         if (property.first == "UUID")
4251abe55efSEd Tanous                                         {
426c5b2abe0SLewanczyk, Dawid                                             const std::string* value =
4278d78b7a9SPatrick Williams                                                 std::get_if<std::string>(
4281b6b96c5SEd Tanous                                                     &property.second);
42904a258f4SEd Tanous 
4301abe55efSEd Tanous                                             if (value != nullptr)
4311abe55efSEd Tanous                                             {
432029573d4SEd Tanous                                                 std::string valueStr = *value;
43304a258f4SEd Tanous                                                 if (valueStr.size() == 32)
4341abe55efSEd Tanous                                                 {
435029573d4SEd Tanous                                                     valueStr.insert(8, 1, '-');
436029573d4SEd Tanous                                                     valueStr.insert(13, 1, '-');
437029573d4SEd Tanous                                                     valueStr.insert(18, 1, '-');
438029573d4SEd Tanous                                                     valueStr.insert(23, 1, '-');
43904a258f4SEd Tanous                                                 }
440029573d4SEd Tanous                                                 BMCWEB_LOG_DEBUG << "UUID = "
44104a258f4SEd Tanous                                                                  << valueStr;
442029573d4SEd Tanous                                                 aResp->res.jsonValue["UUID"] =
44304a258f4SEd Tanous                                                     valueStr;
444c5b2abe0SLewanczyk, Dawid                                             }
445c5b2abe0SLewanczyk, Dawid                                         }
446c5b2abe0SLewanczyk, Dawid                                     }
447c5b2abe0SLewanczyk, Dawid                                 },
44804a258f4SEd Tanous                                 connection.first, path,
4496c34de48SEd Tanous                                 "org.freedesktop.DBus.Properties", "GetAll",
4501abe55efSEd Tanous                                 "xyz.openbmc_project.Common.UUID");
451c5b2abe0SLewanczyk, Dawid                         }
452029573d4SEd Tanous                         else if (interfaceName ==
453029573d4SEd Tanous                                  "xyz.openbmc_project.Inventory.Item.System")
4541abe55efSEd Tanous                         {
455029573d4SEd Tanous                             crow::connections::systemBus->async_method_call(
456168e20c1SEd Tanous                                 [aResp](const boost::system::error_code ec2,
457168e20c1SEd Tanous                                         const std::vector<std::pair<
458168e20c1SEd Tanous                                             std::string,
459168e20c1SEd Tanous                                             dbus::utility::DbusVariantType>>&
4601214b7e7SGunnar Mills                                             propertiesList) {
461cb13a392SEd Tanous                                     if (ec2)
462029573d4SEd Tanous                                     {
463e4a4b9a9SJames Feist                                         // doesn't have to include this
464e4a4b9a9SJames Feist                                         // interface
465029573d4SEd Tanous                                         return;
466029573d4SEd Tanous                                     }
467698654b6SGunnar Mills                                     BMCWEB_LOG_DEBUG
468698654b6SGunnar Mills                                         << "Got " << propertiesList.size()
469029573d4SEd Tanous                                         << " properties for system";
470168e20c1SEd Tanous                                     for (const std::pair<
471168e20c1SEd Tanous                                              std::string,
472168e20c1SEd Tanous                                              dbus::utility::DbusVariantType>&
4731214b7e7SGunnar Mills                                              property : propertiesList)
474029573d4SEd Tanous                                     {
475fc5afcf9Sbeccabroek                                         const std::string& propertyName =
476fc5afcf9Sbeccabroek                                             property.first;
477fc5afcf9Sbeccabroek                                         if ((propertyName == "PartNumber") ||
478fc5afcf9Sbeccabroek                                             (propertyName == "SerialNumber") ||
479fc5afcf9Sbeccabroek                                             (propertyName == "Manufacturer") ||
4805235d964SSunnySrivastava1984                                             (propertyName == "Model") ||
4815235d964SSunnySrivastava1984                                             (propertyName == "SubModel"))
482fc5afcf9Sbeccabroek                                         {
483029573d4SEd Tanous                                             const std::string* value =
484fc5afcf9Sbeccabroek                                                 std::get_if<std::string>(
485029573d4SEd Tanous                                                     &property.second);
486029573d4SEd Tanous                                             if (value != nullptr)
487029573d4SEd Tanous                                             {
488029573d4SEd Tanous                                                 aResp->res
489fc5afcf9Sbeccabroek                                                     .jsonValue[propertyName] =
490029573d4SEd Tanous                                                     *value;
491029573d4SEd Tanous                                             }
492029573d4SEd Tanous                                         }
493fc5afcf9Sbeccabroek                                     }
494c1e236a6SGunnar Mills 
495cb7e1e7bSAndrew Geissler                                     // Grab the bios version
496f97ddba7SGunnar Mills                                     fw_util::populateFirmwareInformation(
497cb7e1e7bSAndrew Geissler                                         aResp, fw_util::biosPurpose,
49872d566d9SGunnar Mills                                         "BiosVersion", false);
499029573d4SEd Tanous                                 },
500029573d4SEd Tanous                                 connection.first, path,
501029573d4SEd Tanous                                 "org.freedesktop.DBus.Properties", "GetAll",
5020fda0f12SGeorge Liu                                 "xyz.openbmc_project.Inventory.Decorator.Asset");
503e4a4b9a9SJames Feist 
5041e1e598dSJonathan Doman                             sdbusplus::asio::getProperty<std::string>(
5051e1e598dSJonathan Doman                                 *crow::connections::systemBus, connection.first,
5061e1e598dSJonathan Doman                                 path,
5071e1e598dSJonathan Doman                                 "xyz.openbmc_project.Inventory.Decorator."
5081e1e598dSJonathan Doman                                 "AssetTag",
5091e1e598dSJonathan Doman                                 "AssetTag",
510168e20c1SEd Tanous                                 [aResp](const boost::system::error_code ec2,
5111e1e598dSJonathan Doman                                         const std::string& value) {
512cb13a392SEd Tanous                                     if (ec2)
513e4a4b9a9SJames Feist                                     {
514e4a4b9a9SJames Feist                                         // doesn't have to include this
515e4a4b9a9SJames Feist                                         // interface
516e4a4b9a9SJames Feist                                         return;
517e4a4b9a9SJames Feist                                     }
518e4a4b9a9SJames Feist 
5191e1e598dSJonathan Doman                                     aResp->res.jsonValue["AssetTag"] = value;
5201e1e598dSJonathan Doman                                 });
521029573d4SEd Tanous                         }
522029573d4SEd Tanous                     }
523029573d4SEd Tanous                 }
524c5b2abe0SLewanczyk, Dawid             }
525c5b2abe0SLewanczyk, Dawid         },
526c5b2abe0SLewanczyk, Dawid         "xyz.openbmc_project.ObjectMapper",
527c5b2abe0SLewanczyk, Dawid         "/xyz/openbmc_project/object_mapper",
528c5b2abe0SLewanczyk, Dawid         "xyz.openbmc_project.ObjectMapper", "GetSubTree",
5296617338dSEd Tanous         "/xyz/openbmc_project/inventory", int32_t(0),
5306617338dSEd Tanous         std::array<const char*, 5>{
5316617338dSEd Tanous             "xyz.openbmc_project.Inventory.Decorator.Asset",
5326617338dSEd Tanous             "xyz.openbmc_project.Inventory.Item.Cpu",
5336617338dSEd Tanous             "xyz.openbmc_project.Inventory.Item.Dimm",
5346617338dSEd Tanous             "xyz.openbmc_project.Inventory.Item.System",
5356617338dSEd Tanous             "xyz.openbmc_project.Common.UUID",
5366617338dSEd Tanous         });
537c5b2abe0SLewanczyk, Dawid }
538c5b2abe0SLewanczyk, Dawid 
539c5b2abe0SLewanczyk, Dawid /**
540c5b2abe0SLewanczyk, Dawid  * @brief Retrieves host state properties over dbus
541c5b2abe0SLewanczyk, Dawid  *
542c5b2abe0SLewanczyk, Dawid  * @param[in] aResp     Shared pointer for completing asynchronous calls.
543c5b2abe0SLewanczyk, Dawid  *
544c5b2abe0SLewanczyk, Dawid  * @return None.
545c5b2abe0SLewanczyk, Dawid  */
5468d1b46d7Szhanghch05 inline void getHostState(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
5471abe55efSEd Tanous {
54855c7b7a2SEd Tanous     BMCWEB_LOG_DEBUG << "Get host information.";
5491e1e598dSJonathan Doman     sdbusplus::asio::getProperty<std::string>(
5501e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.State.Host",
5511e1e598dSJonathan Doman         "/xyz/openbmc_project/state/host0", "xyz.openbmc_project.State.Host",
5521e1e598dSJonathan Doman         "CurrentHostState",
553c5d03ff4SJennifer Lee         [aResp](const boost::system::error_code ec,
5541e1e598dSJonathan Doman                 const std::string& hostState) {
5551abe55efSEd Tanous             if (ec)
5561abe55efSEd Tanous             {
55755c7b7a2SEd Tanous                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
558f12894f8SJason M. Bills                 messages::internalError(aResp->res);
559c5b2abe0SLewanczyk, Dawid                 return;
560c5b2abe0SLewanczyk, Dawid             }
5616617338dSEd Tanous 
5621e1e598dSJonathan Doman             BMCWEB_LOG_DEBUG << "Host state: " << hostState;
563c5b2abe0SLewanczyk, Dawid             // Verify Host State
5641e1e598dSJonathan Doman             if (hostState == "xyz.openbmc_project.State.Host.HostState.Running")
5651abe55efSEd Tanous             {
56655c7b7a2SEd Tanous                 aResp->res.jsonValue["PowerState"] = "On";
5676617338dSEd Tanous                 aResp->res.jsonValue["Status"]["State"] = "Enabled";
5681abe55efSEd Tanous             }
5691e1e598dSJonathan Doman             else if (hostState ==
5700fda0f12SGeorge Liu                      "xyz.openbmc_project.State.Host.HostState.Quiesced")
5718c888608SGunnar Mills             {
5728c888608SGunnar Mills                 aResp->res.jsonValue["PowerState"] = "On";
5738c888608SGunnar Mills                 aResp->res.jsonValue["Status"]["State"] = "Quiesced";
5748c888608SGunnar Mills             }
5751e1e598dSJonathan Doman             else if (hostState ==
5760fda0f12SGeorge Liu                      "xyz.openbmc_project.State.Host.HostState.DiagnosticMode")
57783935af9SAndrew Geissler             {
57883935af9SAndrew Geissler                 aResp->res.jsonValue["PowerState"] = "On";
57983935af9SAndrew Geissler                 aResp->res.jsonValue["Status"]["State"] = "InTest";
58083935af9SAndrew Geissler             }
5810fda0f12SGeorge Liu             else if (
5821e1e598dSJonathan Doman                 hostState ==
5830fda0f12SGeorge Liu                 "xyz.openbmc_project.State.Host.HostState.TransitioningToRunning")
5841a2a1437SAndrew Geissler             {
5851a2a1437SAndrew Geissler                 aResp->res.jsonValue["PowerState"] = "PoweringOn";
58615c27bf8SNoah Brewer                 aResp->res.jsonValue["Status"]["State"] = "Starting";
5871a2a1437SAndrew Geissler             }
5880fda0f12SGeorge Liu             else if (
5891e1e598dSJonathan Doman                 hostState ==
5900fda0f12SGeorge Liu                 "xyz.openbmc_project.State.Host.HostState.TransitioningToOff")
5911a2a1437SAndrew Geissler             {
5921a2a1437SAndrew Geissler                 aResp->res.jsonValue["PowerState"] = "PoweringOff";
5931a2a1437SAndrew Geissler                 aResp->res.jsonValue["Status"]["State"] = "Disabled";
5941a2a1437SAndrew Geissler             }
5951abe55efSEd Tanous             else
5961abe55efSEd Tanous             {
59755c7b7a2SEd Tanous                 aResp->res.jsonValue["PowerState"] = "Off";
5986617338dSEd Tanous                 aResp->res.jsonValue["Status"]["State"] = "Disabled";
599c5b2abe0SLewanczyk, Dawid             }
6001e1e598dSJonathan Doman         });
601c5b2abe0SLewanczyk, Dawid }
602c5b2abe0SLewanczyk, Dawid 
603c5b2abe0SLewanczyk, Dawid /**
604786d0f60SGunnar Mills  * @brief Translates boot source DBUS property value to redfish.
605491d8ee7SSantosh Puranik  *
606491d8ee7SSantosh Puranik  * @param[in] dbusSource    The boot source in DBUS speak.
607491d8ee7SSantosh Puranik  *
608491d8ee7SSantosh Puranik  * @return Returns as a string, the boot source in Redfish terms. If translation
609491d8ee7SSantosh Puranik  * cannot be done, returns an empty string.
610491d8ee7SSantosh Puranik  */
61123a21a1cSEd Tanous inline std::string dbusToRfBootSource(const std::string& dbusSource)
612491d8ee7SSantosh Puranik {
613491d8ee7SSantosh Puranik     if (dbusSource == "xyz.openbmc_project.Control.Boot.Source.Sources.Default")
614491d8ee7SSantosh Puranik     {
615491d8ee7SSantosh Puranik         return "None";
616491d8ee7SSantosh Puranik     }
6173174e4dfSEd Tanous     if (dbusSource == "xyz.openbmc_project.Control.Boot.Source.Sources.Disk")
618491d8ee7SSantosh Puranik     {
619491d8ee7SSantosh Puranik         return "Hdd";
620491d8ee7SSantosh Puranik     }
6213174e4dfSEd Tanous     if (dbusSource ==
622a71dc0b7SSantosh Puranik         "xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia")
623491d8ee7SSantosh Puranik     {
624491d8ee7SSantosh Puranik         return "Cd";
625491d8ee7SSantosh Puranik     }
6263174e4dfSEd Tanous     if (dbusSource == "xyz.openbmc_project.Control.Boot.Source.Sources.Network")
627491d8ee7SSantosh Puranik     {
628491d8ee7SSantosh Puranik         return "Pxe";
629491d8ee7SSantosh Puranik     }
6303174e4dfSEd Tanous     if (dbusSource ==
631944ffaf9SJohnathan Mantey         "xyz.openbmc_project.Control.Boot.Source.Sources.RemovableMedia")
6329f16b2c1SJennifer Lee     {
6339f16b2c1SJennifer Lee         return "Usb";
6349f16b2c1SJennifer Lee     }
635491d8ee7SSantosh Puranik     return "";
636491d8ee7SSantosh Puranik }
637491d8ee7SSantosh Puranik 
638491d8ee7SSantosh Puranik /**
639cd9a4666SKonstantin Aladyshev  * @brief Translates boot type DBUS property value to redfish.
640cd9a4666SKonstantin Aladyshev  *
641cd9a4666SKonstantin Aladyshev  * @param[in] dbusType    The boot type in DBUS speak.
642cd9a4666SKonstantin Aladyshev  *
643cd9a4666SKonstantin Aladyshev  * @return Returns as a string, the boot type in Redfish terms. If translation
644cd9a4666SKonstantin Aladyshev  * cannot be done, returns an empty string.
645cd9a4666SKonstantin Aladyshev  */
646cd9a4666SKonstantin Aladyshev inline std::string dbusToRfBootType(const std::string& dbusType)
647cd9a4666SKonstantin Aladyshev {
648cd9a4666SKonstantin Aladyshev     if (dbusType == "xyz.openbmc_project.Control.Boot.Type.Types.Legacy")
649cd9a4666SKonstantin Aladyshev     {
650cd9a4666SKonstantin Aladyshev         return "Legacy";
651cd9a4666SKonstantin Aladyshev     }
652cd9a4666SKonstantin Aladyshev     if (dbusType == "xyz.openbmc_project.Control.Boot.Type.Types.EFI")
653cd9a4666SKonstantin Aladyshev     {
654cd9a4666SKonstantin Aladyshev         return "UEFI";
655cd9a4666SKonstantin Aladyshev     }
656cd9a4666SKonstantin Aladyshev     return "";
657cd9a4666SKonstantin Aladyshev }
658cd9a4666SKonstantin Aladyshev 
659cd9a4666SKonstantin Aladyshev /**
660786d0f60SGunnar Mills  * @brief Translates boot mode DBUS property value to redfish.
661491d8ee7SSantosh Puranik  *
662491d8ee7SSantosh Puranik  * @param[in] dbusMode    The boot mode in DBUS speak.
663491d8ee7SSantosh Puranik  *
664491d8ee7SSantosh Puranik  * @return Returns as a string, the boot mode in Redfish terms. If translation
665491d8ee7SSantosh Puranik  * cannot be done, returns an empty string.
666491d8ee7SSantosh Puranik  */
66723a21a1cSEd Tanous inline std::string dbusToRfBootMode(const std::string& dbusMode)
668491d8ee7SSantosh Puranik {
669491d8ee7SSantosh Puranik     if (dbusMode == "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular")
670491d8ee7SSantosh Puranik     {
671491d8ee7SSantosh Puranik         return "None";
672491d8ee7SSantosh Puranik     }
6733174e4dfSEd Tanous     if (dbusMode == "xyz.openbmc_project.Control.Boot.Mode.Modes.Safe")
674491d8ee7SSantosh Puranik     {
675491d8ee7SSantosh Puranik         return "Diags";
676491d8ee7SSantosh Puranik     }
6773174e4dfSEd Tanous     if (dbusMode == "xyz.openbmc_project.Control.Boot.Mode.Modes.Setup")
678491d8ee7SSantosh Puranik     {
679491d8ee7SSantosh Puranik         return "BiosSetup";
680491d8ee7SSantosh Puranik     }
681491d8ee7SSantosh Puranik     return "";
682491d8ee7SSantosh Puranik }
683491d8ee7SSantosh Puranik 
684491d8ee7SSantosh Puranik /**
685e43914b3SAndrew Geissler  * @brief Translates boot progress DBUS property value to redfish.
686e43914b3SAndrew Geissler  *
687e43914b3SAndrew Geissler  * @param[in] dbusBootProgress    The boot progress in DBUS speak.
688e43914b3SAndrew Geissler  *
689e43914b3SAndrew Geissler  * @return Returns as a string, the boot progress in Redfish terms. If
690e43914b3SAndrew Geissler  *         translation cannot be done, returns "None".
691e43914b3SAndrew Geissler  */
692e43914b3SAndrew Geissler inline std::string dbusToRfBootProgress(const std::string& dbusBootProgress)
693e43914b3SAndrew Geissler {
694e43914b3SAndrew Geissler     // Now convert the D-Bus BootProgress to the appropriate Redfish
695e43914b3SAndrew Geissler     // enum
696e43914b3SAndrew Geissler     std::string rfBpLastState = "None";
697e43914b3SAndrew Geissler     if (dbusBootProgress == "xyz.openbmc_project.State.Boot.Progress."
698e43914b3SAndrew Geissler                             "ProgressStages.Unspecified")
699e43914b3SAndrew Geissler     {
700e43914b3SAndrew Geissler         rfBpLastState = "None";
701e43914b3SAndrew Geissler     }
702e43914b3SAndrew Geissler     else if (dbusBootProgress ==
703e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
704e43914b3SAndrew Geissler              "PrimaryProcInit")
705e43914b3SAndrew Geissler     {
706e43914b3SAndrew Geissler         rfBpLastState = "PrimaryProcessorInitializationStarted";
707e43914b3SAndrew Geissler     }
708e43914b3SAndrew Geissler     else if (dbusBootProgress ==
709e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
710e43914b3SAndrew Geissler              "BusInit")
711e43914b3SAndrew Geissler     {
712e43914b3SAndrew Geissler         rfBpLastState = "BusInitializationStarted";
713e43914b3SAndrew Geissler     }
714e43914b3SAndrew Geissler     else if (dbusBootProgress ==
715e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
716e43914b3SAndrew Geissler              "MemoryInit")
717e43914b3SAndrew Geissler     {
718e43914b3SAndrew Geissler         rfBpLastState = "MemoryInitializationStarted";
719e43914b3SAndrew Geissler     }
720e43914b3SAndrew Geissler     else if (dbusBootProgress ==
721e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
722e43914b3SAndrew Geissler              "SecondaryProcInit")
723e43914b3SAndrew Geissler     {
724e43914b3SAndrew Geissler         rfBpLastState = "SecondaryProcessorInitializationStarted";
725e43914b3SAndrew Geissler     }
726e43914b3SAndrew Geissler     else if (dbusBootProgress ==
727e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
728e43914b3SAndrew Geissler              "PCIInit")
729e43914b3SAndrew Geissler     {
730e43914b3SAndrew Geissler         rfBpLastState = "PCIResourceConfigStarted";
731e43914b3SAndrew Geissler     }
732e43914b3SAndrew Geissler     else if (dbusBootProgress ==
733e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
734e43914b3SAndrew Geissler              "SystemSetup")
735e43914b3SAndrew Geissler     {
736e43914b3SAndrew Geissler         rfBpLastState = "SetupEntered";
737e43914b3SAndrew Geissler     }
738e43914b3SAndrew Geissler     else if (dbusBootProgress ==
739e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
740e43914b3SAndrew Geissler              "SystemInitComplete")
741e43914b3SAndrew Geissler     {
742e43914b3SAndrew Geissler         rfBpLastState = "SystemHardwareInitializationComplete";
743e43914b3SAndrew Geissler     }
744e43914b3SAndrew Geissler     else if (dbusBootProgress ==
745e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
746e43914b3SAndrew Geissler              "OSStart")
747e43914b3SAndrew Geissler     {
748e43914b3SAndrew Geissler         rfBpLastState = "OSBootStarted";
749e43914b3SAndrew Geissler     }
750e43914b3SAndrew Geissler     else if (dbusBootProgress ==
751e43914b3SAndrew Geissler              "xyz.openbmc_project.State.Boot.Progress.ProgressStages."
752e43914b3SAndrew Geissler              "OSRunning")
753e43914b3SAndrew Geissler     {
754e43914b3SAndrew Geissler         rfBpLastState = "OSRunning";
755e43914b3SAndrew Geissler     }
756e43914b3SAndrew Geissler     else
757e43914b3SAndrew Geissler     {
758e43914b3SAndrew Geissler         BMCWEB_LOG_DEBUG << "Unsupported D-Bus BootProgress "
759e43914b3SAndrew Geissler                          << dbusBootProgress;
760e43914b3SAndrew Geissler         // Just return the default
761e43914b3SAndrew Geissler     }
762e43914b3SAndrew Geissler     return rfBpLastState;
763e43914b3SAndrew Geissler }
764e43914b3SAndrew Geissler 
765e43914b3SAndrew Geissler /**
766786d0f60SGunnar Mills  * @brief Translates boot source from Redfish to the DBus boot paths.
767491d8ee7SSantosh Puranik  *
768491d8ee7SSantosh Puranik  * @param[in] rfSource    The boot source in Redfish.
769944ffaf9SJohnathan Mantey  * @param[out] bootSource The DBus source
770944ffaf9SJohnathan Mantey  * @param[out] bootMode   the DBus boot mode
771491d8ee7SSantosh Puranik  *
772944ffaf9SJohnathan Mantey  * @return Integer error code.
773491d8ee7SSantosh Puranik  */
7748d1b46d7Szhanghch05 inline int assignBootParameters(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
775944ffaf9SJohnathan Mantey                                 const std::string& rfSource,
776944ffaf9SJohnathan Mantey                                 std::string& bootSource, std::string& bootMode)
777491d8ee7SSantosh Puranik {
778c21865c4SKonstantin Aladyshev     bootSource = "xyz.openbmc_project.Control.Boot.Source.Sources.Default";
779c21865c4SKonstantin Aladyshev     bootMode = "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular";
780944ffaf9SJohnathan Mantey 
781491d8ee7SSantosh Puranik     if (rfSource == "None")
782491d8ee7SSantosh Puranik     {
783944ffaf9SJohnathan Mantey         return 0;
784491d8ee7SSantosh Puranik     }
7853174e4dfSEd Tanous     if (rfSource == "Pxe")
786491d8ee7SSantosh Puranik     {
787944ffaf9SJohnathan Mantey         bootSource = "xyz.openbmc_project.Control.Boot.Source.Sources.Network";
788944ffaf9SJohnathan Mantey     }
789944ffaf9SJohnathan Mantey     else if (rfSource == "Hdd")
790944ffaf9SJohnathan Mantey     {
791944ffaf9SJohnathan Mantey         bootSource = "xyz.openbmc_project.Control.Boot.Source.Sources.Disk";
792944ffaf9SJohnathan Mantey     }
793944ffaf9SJohnathan Mantey     else if (rfSource == "Diags")
794944ffaf9SJohnathan Mantey     {
795944ffaf9SJohnathan Mantey         bootMode = "xyz.openbmc_project.Control.Boot.Mode.Modes.Safe";
796944ffaf9SJohnathan Mantey     }
797944ffaf9SJohnathan Mantey     else if (rfSource == "Cd")
798944ffaf9SJohnathan Mantey     {
799944ffaf9SJohnathan Mantey         bootSource =
800944ffaf9SJohnathan Mantey             "xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia";
801944ffaf9SJohnathan Mantey     }
802944ffaf9SJohnathan Mantey     else if (rfSource == "BiosSetup")
803944ffaf9SJohnathan Mantey     {
804944ffaf9SJohnathan Mantey         bootMode = "xyz.openbmc_project.Control.Boot.Mode.Modes.Setup";
805491d8ee7SSantosh Puranik     }
8069f16b2c1SJennifer Lee     else if (rfSource == "Usb")
8079f16b2c1SJennifer Lee     {
808944ffaf9SJohnathan Mantey         bootSource =
809944ffaf9SJohnathan Mantey             "xyz.openbmc_project.Control.Boot.Source.Sources.RemovableMedia";
8109f16b2c1SJennifer Lee     }
811491d8ee7SSantosh Puranik     else
812491d8ee7SSantosh Puranik     {
8130fda0f12SGeorge Liu         BMCWEB_LOG_DEBUG
8140fda0f12SGeorge Liu             << "Invalid property value for BootSourceOverrideTarget: "
815944ffaf9SJohnathan Mantey             << bootSource;
816944ffaf9SJohnathan Mantey         messages::propertyValueNotInList(aResp->res, rfSource,
817944ffaf9SJohnathan Mantey                                          "BootSourceTargetOverride");
818944ffaf9SJohnathan Mantey         return -1;
819491d8ee7SSantosh Puranik     }
820944ffaf9SJohnathan Mantey     return 0;
821491d8ee7SSantosh Puranik }
8221981771bSAli Ahmed 
823978b8803SAndrew Geissler /**
824978b8803SAndrew Geissler  * @brief Retrieves boot progress of the system
825978b8803SAndrew Geissler  *
826978b8803SAndrew Geissler  * @param[in] aResp  Shared pointer for generating response message.
827978b8803SAndrew Geissler  *
828978b8803SAndrew Geissler  * @return None.
829978b8803SAndrew Geissler  */
8308d1b46d7Szhanghch05 inline void getBootProgress(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
831978b8803SAndrew Geissler {
8321e1e598dSJonathan Doman     sdbusplus::asio::getProperty<std::string>(
8331e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.State.Host",
8341e1e598dSJonathan Doman         "/xyz/openbmc_project/state/host0",
8351e1e598dSJonathan Doman         "xyz.openbmc_project.State.Boot.Progress", "BootProgress",
836978b8803SAndrew Geissler         [aResp](const boost::system::error_code ec,
8371e1e598dSJonathan Doman                 const std::string& bootProgressStr) {
838978b8803SAndrew Geissler             if (ec)
839978b8803SAndrew Geissler             {
840978b8803SAndrew Geissler                 // BootProgress is an optional object so just do nothing if
841978b8803SAndrew Geissler                 // not found
842978b8803SAndrew Geissler                 return;
843978b8803SAndrew Geissler             }
844978b8803SAndrew Geissler 
8451e1e598dSJonathan Doman             BMCWEB_LOG_DEBUG << "Boot Progress: " << bootProgressStr;
846978b8803SAndrew Geissler 
847e43914b3SAndrew Geissler             aResp->res.jsonValue["BootProgress"]["LastState"] =
848e43914b3SAndrew Geissler                 dbusToRfBootProgress(bootProgressStr);
8491e1e598dSJonathan Doman         });
850978b8803SAndrew Geissler }
851491d8ee7SSantosh Puranik 
852491d8ee7SSantosh Puranik /**
853c21865c4SKonstantin Aladyshev  * @brief Retrieves boot override type over DBUS and fills out the response
854cd9a4666SKonstantin Aladyshev  *
855cd9a4666SKonstantin Aladyshev  * @param[in] aResp         Shared pointer for generating response message.
856cd9a4666SKonstantin Aladyshev  *
857cd9a4666SKonstantin Aladyshev  * @return None.
858cd9a4666SKonstantin Aladyshev  */
859cd9a4666SKonstantin Aladyshev 
860c21865c4SKonstantin Aladyshev inline void getBootOverrideType(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
861cd9a4666SKonstantin Aladyshev {
8621e1e598dSJonathan Doman     sdbusplus::asio::getProperty<std::string>(
8631e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
8641e1e598dSJonathan Doman         "/xyz/openbmc_project/control/host0/boot",
8651e1e598dSJonathan Doman         "xyz.openbmc_project.Control.Boot.Type", "BootType",
866cd9a4666SKonstantin Aladyshev         [aResp](const boost::system::error_code ec,
8671e1e598dSJonathan Doman                 const std::string& bootType) {
868cd9a4666SKonstantin Aladyshev             if (ec)
869cd9a4666SKonstantin Aladyshev             {
870cd9a4666SKonstantin Aladyshev                 // not an error, don't have to have the interface
871cd9a4666SKonstantin Aladyshev                 return;
872cd9a4666SKonstantin Aladyshev             }
873cd9a4666SKonstantin Aladyshev 
8741e1e598dSJonathan Doman             BMCWEB_LOG_DEBUG << "Boot type: " << bootType;
875cd9a4666SKonstantin Aladyshev 
8760fda0f12SGeorge Liu             aResp->res
8770fda0f12SGeorge Liu                 .jsonValue["Boot"]
8780fda0f12SGeorge Liu                           ["BootSourceOverrideMode@Redfish.AllowableValues"] = {
8790fda0f12SGeorge Liu                 "Legacy", "UEFI"};
880cd9a4666SKonstantin Aladyshev 
8811e1e598dSJonathan Doman             auto rfType = dbusToRfBootType(bootType);
882cd9a4666SKonstantin Aladyshev             if (rfType.empty())
883cd9a4666SKonstantin Aladyshev             {
884cd9a4666SKonstantin Aladyshev                 messages::internalError(aResp->res);
885cd9a4666SKonstantin Aladyshev                 return;
886cd9a4666SKonstantin Aladyshev             }
887cd9a4666SKonstantin Aladyshev 
888cd9a4666SKonstantin Aladyshev             aResp->res.jsonValue["Boot"]["BootSourceOverrideMode"] = rfType;
8891e1e598dSJonathan Doman         });
890cd9a4666SKonstantin Aladyshev }
891cd9a4666SKonstantin Aladyshev 
892cd9a4666SKonstantin Aladyshev /**
893c21865c4SKonstantin Aladyshev  * @brief Retrieves boot override mode over DBUS and fills out the response
894491d8ee7SSantosh Puranik  *
895491d8ee7SSantosh Puranik  * @param[in] aResp         Shared pointer for generating response message.
896491d8ee7SSantosh Puranik  *
897491d8ee7SSantosh Puranik  * @return None.
898491d8ee7SSantosh Puranik  */
899c21865c4SKonstantin Aladyshev 
900c21865c4SKonstantin Aladyshev inline void getBootOverrideMode(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
901491d8ee7SSantosh Puranik {
9021e1e598dSJonathan Doman     sdbusplus::asio::getProperty<std::string>(
9031e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
9041e1e598dSJonathan Doman         "/xyz/openbmc_project/control/host0/boot",
9051e1e598dSJonathan Doman         "xyz.openbmc_project.Control.Boot.Mode", "BootMode",
906c21865c4SKonstantin Aladyshev         [aResp](const boost::system::error_code ec,
9071e1e598dSJonathan Doman                 const std::string& bootModeStr) {
908491d8ee7SSantosh Puranik             if (ec)
909491d8ee7SSantosh Puranik             {
910491d8ee7SSantosh Puranik                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
911491d8ee7SSantosh Puranik                 messages::internalError(aResp->res);
912491d8ee7SSantosh Puranik                 return;
913491d8ee7SSantosh Puranik             }
914491d8ee7SSantosh Puranik 
9151e1e598dSJonathan Doman             BMCWEB_LOG_DEBUG << "Boot mode: " << bootModeStr;
916491d8ee7SSantosh Puranik 
9170fda0f12SGeorge Liu             aResp->res
9180fda0f12SGeorge Liu                 .jsonValue["Boot"]
9190fda0f12SGeorge Liu                           ["BootSourceOverrideTarget@Redfish.AllowableValues"] =
9200fda0f12SGeorge Liu                 {"None", "Pxe", "Hdd", "Cd", "Diags", "BiosSetup", "Usb"};
921491d8ee7SSantosh Puranik 
9221e1e598dSJonathan Doman             if (bootModeStr !=
923491d8ee7SSantosh Puranik                 "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular")
924491d8ee7SSantosh Puranik             {
9251e1e598dSJonathan Doman                 auto rfMode = dbusToRfBootMode(bootModeStr);
926491d8ee7SSantosh Puranik                 if (!rfMode.empty())
927491d8ee7SSantosh Puranik                 {
928491d8ee7SSantosh Puranik                     aResp->res.jsonValue["Boot"]["BootSourceOverrideTarget"] =
929491d8ee7SSantosh Puranik                         rfMode;
930491d8ee7SSantosh Puranik                 }
931491d8ee7SSantosh Puranik             }
9321e1e598dSJonathan Doman         });
933491d8ee7SSantosh Puranik }
934491d8ee7SSantosh Puranik 
935491d8ee7SSantosh Puranik /**
936c21865c4SKonstantin Aladyshev  * @brief Retrieves boot override source over DBUS
937491d8ee7SSantosh Puranik  *
938491d8ee7SSantosh Puranik  * @param[in] aResp         Shared pointer for generating response message.
939491d8ee7SSantosh Puranik  *
940491d8ee7SSantosh Puranik  * @return None.
941491d8ee7SSantosh Puranik  */
942c21865c4SKonstantin Aladyshev 
943c21865c4SKonstantin Aladyshev inline void
944c21865c4SKonstantin Aladyshev     getBootOverrideSource(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
945491d8ee7SSantosh Puranik {
9461e1e598dSJonathan Doman     sdbusplus::asio::getProperty<std::string>(
9471e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
9481e1e598dSJonathan Doman         "/xyz/openbmc_project/control/host0/boot",
9491e1e598dSJonathan Doman         "xyz.openbmc_project.Control.Boot.Source", "BootSource",
950c21865c4SKonstantin Aladyshev         [aResp](const boost::system::error_code ec,
9511e1e598dSJonathan Doman                 const std::string& bootSourceStr) {
952491d8ee7SSantosh Puranik             if (ec)
953491d8ee7SSantosh Puranik             {
954491d8ee7SSantosh Puranik                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
955491d8ee7SSantosh Puranik                 messages::internalError(aResp->res);
956491d8ee7SSantosh Puranik                 return;
957491d8ee7SSantosh Puranik             }
958491d8ee7SSantosh Puranik 
9591e1e598dSJonathan Doman             BMCWEB_LOG_DEBUG << "Boot source: " << bootSourceStr;
960491d8ee7SSantosh Puranik 
9611e1e598dSJonathan Doman             auto rfSource = dbusToRfBootSource(bootSourceStr);
962491d8ee7SSantosh Puranik             if (!rfSource.empty())
963491d8ee7SSantosh Puranik             {
964491d8ee7SSantosh Puranik                 aResp->res.jsonValue["Boot"]["BootSourceOverrideTarget"] =
965491d8ee7SSantosh Puranik                     rfSource;
966491d8ee7SSantosh Puranik             }
967cd9a4666SKonstantin Aladyshev 
968cd9a4666SKonstantin Aladyshev             // Get BootMode as BootSourceOverrideTarget is constructed
969cd9a4666SKonstantin Aladyshev             // from both BootSource and BootMode
970c21865c4SKonstantin Aladyshev             getBootOverrideMode(aResp);
9711e1e598dSJonathan Doman         });
972491d8ee7SSantosh Puranik }
973491d8ee7SSantosh Puranik 
974491d8ee7SSantosh Puranik /**
975c21865c4SKonstantin Aladyshev  * @brief This functions abstracts all the logic behind getting a
976c21865c4SKonstantin Aladyshev  * "BootSourceOverrideEnabled" property from an overall boot override enable
977c21865c4SKonstantin Aladyshev  * state
978491d8ee7SSantosh Puranik  *
979491d8ee7SSantosh Puranik  * @param[in] aResp     Shared pointer for generating response message.
980491d8ee7SSantosh Puranik  *
981491d8ee7SSantosh Puranik  * @return None.
982491d8ee7SSantosh Puranik  */
983491d8ee7SSantosh Puranik 
984c21865c4SKonstantin Aladyshev inline void
985c21865c4SKonstantin Aladyshev     processBootOverrideEnable(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
986c21865c4SKonstantin Aladyshev                               const bool bootOverrideEnableSetting)
987c21865c4SKonstantin Aladyshev {
988c21865c4SKonstantin Aladyshev     if (!bootOverrideEnableSetting)
989c21865c4SKonstantin Aladyshev     {
990c21865c4SKonstantin Aladyshev         aResp->res.jsonValue["Boot"]["BootSourceOverrideEnabled"] = "Disabled";
991c21865c4SKonstantin Aladyshev         return;
992c21865c4SKonstantin Aladyshev     }
993c21865c4SKonstantin Aladyshev 
994c21865c4SKonstantin Aladyshev     // If boot source override is enabled, we need to check 'one_time'
995c21865c4SKonstantin Aladyshev     // property to set a correct value for the "BootSourceOverrideEnabled"
9961e1e598dSJonathan Doman     sdbusplus::asio::getProperty<bool>(
9971e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
9981e1e598dSJonathan Doman         "/xyz/openbmc_project/control/host0/boot/one_time",
9991e1e598dSJonathan Doman         "xyz.openbmc_project.Object.Enable", "Enabled",
10001e1e598dSJonathan Doman         [aResp](const boost::system::error_code ec, bool oneTimeSetting) {
1001491d8ee7SSantosh Puranik             if (ec)
1002491d8ee7SSantosh Puranik             {
1003491d8ee7SSantosh Puranik                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1004c21865c4SKonstantin Aladyshev                 messages::internalError(aResp->res);
1005491d8ee7SSantosh Puranik                 return;
1006491d8ee7SSantosh Puranik             }
1007491d8ee7SSantosh Puranik 
1008c21865c4SKonstantin Aladyshev             if (oneTimeSetting)
1009c21865c4SKonstantin Aladyshev             {
1010c21865c4SKonstantin Aladyshev                 aResp->res.jsonValue["Boot"]["BootSourceOverrideEnabled"] =
1011c21865c4SKonstantin Aladyshev                     "Once";
1012c21865c4SKonstantin Aladyshev             }
1013c21865c4SKonstantin Aladyshev             else
1014c21865c4SKonstantin Aladyshev             {
1015c21865c4SKonstantin Aladyshev                 aResp->res.jsonValue["Boot"]["BootSourceOverrideEnabled"] =
1016c21865c4SKonstantin Aladyshev                     "Continuous";
1017c21865c4SKonstantin Aladyshev             }
10181e1e598dSJonathan Doman         });
1019491d8ee7SSantosh Puranik }
1020491d8ee7SSantosh Puranik 
1021491d8ee7SSantosh Puranik /**
1022c21865c4SKonstantin Aladyshev  * @brief Retrieves boot override enable over DBUS
1023c21865c4SKonstantin Aladyshev  *
1024c21865c4SKonstantin Aladyshev  * @param[in] aResp     Shared pointer for generating response message.
1025c21865c4SKonstantin Aladyshev  *
1026c21865c4SKonstantin Aladyshev  * @return None.
1027c21865c4SKonstantin Aladyshev  */
1028c21865c4SKonstantin Aladyshev 
1029c21865c4SKonstantin Aladyshev inline void
1030c21865c4SKonstantin Aladyshev     getBootOverrideEnable(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
1031c21865c4SKonstantin Aladyshev {
10321e1e598dSJonathan Doman     sdbusplus::asio::getProperty<bool>(
10331e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
10341e1e598dSJonathan Doman         "/xyz/openbmc_project/control/host0/boot",
10351e1e598dSJonathan Doman         "xyz.openbmc_project.Object.Enable", "Enabled",
1036c21865c4SKonstantin Aladyshev         [aResp](const boost::system::error_code ec,
10371e1e598dSJonathan Doman                 const bool bootOverrideEnable) {
1038c21865c4SKonstantin Aladyshev             if (ec)
1039c21865c4SKonstantin Aladyshev             {
1040c21865c4SKonstantin Aladyshev                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1041c21865c4SKonstantin Aladyshev                 messages::internalError(aResp->res);
1042c21865c4SKonstantin Aladyshev                 return;
1043c21865c4SKonstantin Aladyshev             }
1044c21865c4SKonstantin Aladyshev 
10451e1e598dSJonathan Doman             processBootOverrideEnable(aResp, bootOverrideEnable);
10461e1e598dSJonathan Doman         });
1047c21865c4SKonstantin Aladyshev }
1048c21865c4SKonstantin Aladyshev 
1049c21865c4SKonstantin Aladyshev /**
1050c21865c4SKonstantin Aladyshev  * @brief Retrieves boot source override properties
1051c21865c4SKonstantin Aladyshev  *
1052c21865c4SKonstantin Aladyshev  * @param[in] aResp     Shared pointer for generating response message.
1053c21865c4SKonstantin Aladyshev  *
1054c21865c4SKonstantin Aladyshev  * @return None.
1055c21865c4SKonstantin Aladyshev  */
1056c21865c4SKonstantin Aladyshev inline void getBootProperties(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
1057c21865c4SKonstantin Aladyshev {
1058c21865c4SKonstantin Aladyshev     BMCWEB_LOG_DEBUG << "Get boot information.";
1059c21865c4SKonstantin Aladyshev 
1060c21865c4SKonstantin Aladyshev     getBootOverrideSource(aResp);
1061c21865c4SKonstantin Aladyshev     getBootOverrideType(aResp);
1062c21865c4SKonstantin Aladyshev     getBootOverrideEnable(aResp);
1063c21865c4SKonstantin Aladyshev }
1064c21865c4SKonstantin Aladyshev 
1065c21865c4SKonstantin Aladyshev /**
1066c0557e1aSGunnar Mills  * @brief Retrieves the Last Reset Time
1067c0557e1aSGunnar Mills  *
1068c0557e1aSGunnar Mills  * "Reset" is an overloaded term in Redfish, "Reset" includes power on
1069c0557e1aSGunnar Mills  * and power off. Even though this is the "system" Redfish object look at the
1070c0557e1aSGunnar Mills  * chassis D-Bus interface for the LastStateChangeTime since this has the
1071c0557e1aSGunnar Mills  * last power operation time.
1072c0557e1aSGunnar Mills  *
1073c0557e1aSGunnar Mills  * @param[in] aResp     Shared pointer for generating response message.
1074c0557e1aSGunnar Mills  *
1075c0557e1aSGunnar Mills  * @return None.
1076c0557e1aSGunnar Mills  */
10778d1b46d7Szhanghch05 inline void getLastResetTime(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
1078c0557e1aSGunnar Mills {
1079c0557e1aSGunnar Mills     BMCWEB_LOG_DEBUG << "Getting System Last Reset Time";
1080c0557e1aSGunnar Mills 
10811e1e598dSJonathan Doman     sdbusplus::asio::getProperty<uint64_t>(
10821e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.State.Chassis",
10831e1e598dSJonathan Doman         "/xyz/openbmc_project/state/chassis0",
10841e1e598dSJonathan Doman         "xyz.openbmc_project.State.Chassis", "LastStateChangeTime",
10851e1e598dSJonathan Doman         [aResp](const boost::system::error_code ec, uint64_t lastResetTime) {
1086c0557e1aSGunnar Mills             if (ec)
1087c0557e1aSGunnar Mills             {
1088c0557e1aSGunnar Mills                 BMCWEB_LOG_DEBUG << "D-BUS response error " << ec;
1089c0557e1aSGunnar Mills                 return;
1090c0557e1aSGunnar Mills             }
1091c0557e1aSGunnar Mills 
1092c0557e1aSGunnar Mills             // LastStateChangeTime is epoch time, in milliseconds
1093c0557e1aSGunnar Mills             // https://github.com/openbmc/phosphor-dbus-interfaces/blob/33e8e1dd64da53a66e888d33dc82001305cd0bf9/xyz/openbmc_project/State/Chassis.interface.yaml#L19
10941e1e598dSJonathan Doman             uint64_t lastResetTimeStamp = lastResetTime / 1000;
1095c0557e1aSGunnar Mills 
1096c0557e1aSGunnar Mills             // Convert to ISO 8601 standard
1097c0557e1aSGunnar Mills             aResp->res.jsonValue["LastResetTime"] =
10981d8782e7SNan Zhou                 crow::utility::getDateTimeUint(lastResetTimeStamp);
10991e1e598dSJonathan Doman         });
1100c0557e1aSGunnar Mills }
1101c0557e1aSGunnar Mills 
1102c0557e1aSGunnar Mills /**
11036bd5a8d2SGunnar Mills  * @brief Retrieves Automatic Retry properties. Known on D-Bus as AutoReboot.
11046bd5a8d2SGunnar Mills  *
11056bd5a8d2SGunnar Mills  * @param[in] aResp     Shared pointer for generating response message.
11066bd5a8d2SGunnar Mills  *
11076bd5a8d2SGunnar Mills  * @return None.
11086bd5a8d2SGunnar Mills  */
11098d1b46d7Szhanghch05 inline void getAutomaticRetry(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
11106bd5a8d2SGunnar Mills {
11116bd5a8d2SGunnar Mills     BMCWEB_LOG_DEBUG << "Get Automatic Retry policy";
11126bd5a8d2SGunnar Mills 
11131e1e598dSJonathan Doman     sdbusplus::asio::getProperty<bool>(
11141e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
11151e1e598dSJonathan Doman         "/xyz/openbmc_project/control/host0/auto_reboot",
11161e1e598dSJonathan Doman         "xyz.openbmc_project.Control.Boot.RebootPolicy", "AutoReboot",
11171e1e598dSJonathan Doman         [aResp](const boost::system::error_code ec, bool autoRebootEnabled) {
11186bd5a8d2SGunnar Mills             if (ec)
11196bd5a8d2SGunnar Mills             {
11206bd5a8d2SGunnar Mills                 BMCWEB_LOG_DEBUG << "D-BUS response error " << ec;
11216bd5a8d2SGunnar Mills                 return;
11226bd5a8d2SGunnar Mills             }
11236bd5a8d2SGunnar Mills 
11241e1e598dSJonathan Doman             BMCWEB_LOG_DEBUG << "Auto Reboot: " << autoRebootEnabled;
11251e1e598dSJonathan Doman             if (autoRebootEnabled == true)
11266bd5a8d2SGunnar Mills             {
11276bd5a8d2SGunnar Mills                 aResp->res.jsonValue["Boot"]["AutomaticRetryConfig"] =
11286bd5a8d2SGunnar Mills                     "RetryAttempts";
11296bd5a8d2SGunnar Mills                 // If AutomaticRetry (AutoReboot) is enabled see how many
11306bd5a8d2SGunnar Mills                 // attempts are left
11311e1e598dSJonathan Doman                 sdbusplus::asio::getProperty<uint32_t>(
11321e1e598dSJonathan Doman                     *crow::connections::systemBus,
11331e1e598dSJonathan Doman                     "xyz.openbmc_project.State.Host",
11341e1e598dSJonathan Doman                     "/xyz/openbmc_project/state/host0",
11351e1e598dSJonathan Doman                     "xyz.openbmc_project.Control.Boot.RebootAttempts",
11361e1e598dSJonathan Doman                     "AttemptsLeft",
1137cb13a392SEd Tanous                     [aResp](const boost::system::error_code ec2,
1138914e2d5dSEd Tanous                             const uint32_t autoRebootAttemptsLeft) {
1139cb13a392SEd Tanous                         if (ec2)
11406bd5a8d2SGunnar Mills                         {
1141cb13a392SEd Tanous                             BMCWEB_LOG_DEBUG << "D-BUS response error " << ec2;
11426bd5a8d2SGunnar Mills                             return;
11436bd5a8d2SGunnar Mills                         }
11446bd5a8d2SGunnar Mills 
11456bd5a8d2SGunnar Mills                         BMCWEB_LOG_DEBUG << "Auto Reboot Attempts Left: "
11461e1e598dSJonathan Doman                                          << autoRebootAttemptsLeft;
11476bd5a8d2SGunnar Mills 
11486bd5a8d2SGunnar Mills                         aResp->res
11496bd5a8d2SGunnar Mills                             .jsonValue["Boot"]
11506bd5a8d2SGunnar Mills                                       ["RemainingAutomaticRetryAttempts"] =
11511e1e598dSJonathan Doman                             autoRebootAttemptsLeft;
11521e1e598dSJonathan Doman                     });
11536bd5a8d2SGunnar Mills             }
11546bd5a8d2SGunnar Mills             else
11556bd5a8d2SGunnar Mills             {
11566bd5a8d2SGunnar Mills                 aResp->res.jsonValue["Boot"]["AutomaticRetryConfig"] =
11576bd5a8d2SGunnar Mills                     "Disabled";
11586bd5a8d2SGunnar Mills             }
11596bd5a8d2SGunnar Mills 
11606bd5a8d2SGunnar Mills             // Not on D-Bus. Hardcoded here:
11616bd5a8d2SGunnar Mills             // https://github.com/openbmc/phosphor-state-manager/blob/1dbbef42675e94fb1f78edb87d6b11380260535a/meson_options.txt#L71
11626bd5a8d2SGunnar Mills             aResp->res.jsonValue["Boot"]["AutomaticRetryAttempts"] = 3;
116369f35306SGunnar Mills 
116469f35306SGunnar Mills             // "AutomaticRetryConfig" can be 3 values, Disabled, RetryAlways,
116569f35306SGunnar Mills             // and RetryAttempts. OpenBMC only supports Disabled and
116669f35306SGunnar Mills             // RetryAttempts.
11670fda0f12SGeorge Liu             aResp->res
11680fda0f12SGeorge Liu                 .jsonValue["Boot"]
11690fda0f12SGeorge Liu                           ["AutomaticRetryConfig@Redfish.AllowableValues"] = {
11700fda0f12SGeorge Liu                 "Disabled", "RetryAttempts"};
11711e1e598dSJonathan Doman         });
11726bd5a8d2SGunnar Mills }
11736bd5a8d2SGunnar Mills 
11746bd5a8d2SGunnar Mills /**
1175c6a620f2SGeorge Liu  * @brief Retrieves power restore policy over DBUS.
1176c6a620f2SGeorge Liu  *
1177c6a620f2SGeorge Liu  * @param[in] aResp     Shared pointer for generating response message.
1178c6a620f2SGeorge Liu  *
1179c6a620f2SGeorge Liu  * @return None.
1180c6a620f2SGeorge Liu  */
11818d1b46d7Szhanghch05 inline void
11828d1b46d7Szhanghch05     getPowerRestorePolicy(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
1183c6a620f2SGeorge Liu {
1184c6a620f2SGeorge Liu     BMCWEB_LOG_DEBUG << "Get power restore policy";
1185c6a620f2SGeorge Liu 
11861e1e598dSJonathan Doman     sdbusplus::asio::getProperty<std::string>(
11871e1e598dSJonathan Doman         *crow::connections::systemBus, "xyz.openbmc_project.Settings",
11881e1e598dSJonathan Doman         "/xyz/openbmc_project/control/host0/power_restore_policy",
11891e1e598dSJonathan Doman         "xyz.openbmc_project.Control.Power.RestorePolicy", "PowerRestorePolicy",
11901e1e598dSJonathan Doman         [aResp](const boost::system::error_code ec, const std::string& policy) {
1191c6a620f2SGeorge Liu             if (ec)
1192c6a620f2SGeorge Liu             {
1193c6a620f2SGeorge Liu                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1194c6a620f2SGeorge Liu                 return;
1195c6a620f2SGeorge Liu             }
1196c6a620f2SGeorge Liu 
11970fda0f12SGeorge Liu             const boost::container::flat_map<std::string, std::string> policyMaps = {
11980fda0f12SGeorge Liu                 {"xyz.openbmc_project.Control.Power.RestorePolicy.Policy.AlwaysOn",
1199c6a620f2SGeorge Liu                  "AlwaysOn"},
12000fda0f12SGeorge Liu                 {"xyz.openbmc_project.Control.Power.RestorePolicy.Policy.AlwaysOff",
1201c6a620f2SGeorge Liu                  "AlwaysOff"},
12020fda0f12SGeorge Liu                 {"xyz.openbmc_project.Control.Power.RestorePolicy.Policy.Restore",
1203c6a620f2SGeorge Liu                  "LastState"}};
1204c6a620f2SGeorge Liu 
12051e1e598dSJonathan Doman             auto policyMapsIt = policyMaps.find(policy);
1206c6a620f2SGeorge Liu             if (policyMapsIt == policyMaps.end())
1207c6a620f2SGeorge Liu             {
1208c6a620f2SGeorge Liu                 messages::internalError(aResp->res);
1209c6a620f2SGeorge Liu                 return;
1210c6a620f2SGeorge Liu             }
1211c6a620f2SGeorge Liu 
1212c6a620f2SGeorge Liu             aResp->res.jsonValue["PowerRestorePolicy"] = policyMapsIt->second;
12131e1e598dSJonathan Doman         });
1214c6a620f2SGeorge Liu }
1215c6a620f2SGeorge Liu 
1216c6a620f2SGeorge Liu /**
12171981771bSAli Ahmed  * @brief Get TrustedModuleRequiredToBoot property. Determines whether or not
12181981771bSAli Ahmed  * TPM is required for booting the host.
12191981771bSAli Ahmed  *
12201981771bSAli Ahmed  * @param[in] aResp     Shared pointer for generating response message.
12211981771bSAli Ahmed  *
12221981771bSAli Ahmed  * @return None.
12231981771bSAli Ahmed  */
12241981771bSAli Ahmed inline void getTrustedModuleRequiredToBoot(
12251981771bSAli Ahmed     const std::shared_ptr<bmcweb::AsyncResp>& aResp)
12261981771bSAli Ahmed {
12271981771bSAli Ahmed     BMCWEB_LOG_DEBUG << "Get TPM required to boot.";
12281981771bSAli Ahmed 
12291981771bSAli Ahmed     crow::connections::systemBus->async_method_call(
12301981771bSAli Ahmed         [aResp](
12311981771bSAli Ahmed             const boost::system::error_code ec,
12321981771bSAli Ahmed             std::vector<std::pair<
12331981771bSAli Ahmed                 std::string,
12341981771bSAli Ahmed                 std::vector<std::pair<std::string, std::vector<std::string>>>>>&
12351981771bSAli Ahmed                 subtree) {
12361981771bSAli Ahmed             if (ec)
12371981771bSAli Ahmed             {
12381981771bSAli Ahmed                 BMCWEB_LOG_DEBUG
12391981771bSAli Ahmed                     << "DBUS response error on TPM.Policy GetSubTree" << ec;
12401981771bSAli Ahmed                 // This is an optional D-Bus object so just return if
12411981771bSAli Ahmed                 // error occurs
12421981771bSAli Ahmed                 return;
12431981771bSAli Ahmed             }
12441981771bSAli Ahmed             if (subtree.size() == 0)
12451981771bSAli Ahmed             {
12461981771bSAli Ahmed                 // As noted above, this is an optional interface so just return
12471981771bSAli Ahmed                 // if there is no instance found
12481981771bSAli Ahmed                 return;
12491981771bSAli Ahmed             }
12501981771bSAli Ahmed 
12511981771bSAli Ahmed             /* When there is more than one TPMEnable object... */
12521981771bSAli Ahmed             if (subtree.size() > 1)
12531981771bSAli Ahmed             {
12541981771bSAli Ahmed                 BMCWEB_LOG_DEBUG
12551981771bSAli Ahmed                     << "DBUS response has more than 1 TPM Enable object:"
12561981771bSAli Ahmed                     << subtree.size();
12571981771bSAli Ahmed                 // Throw an internal Error and return
12581981771bSAli Ahmed                 messages::internalError(aResp->res);
12591981771bSAli Ahmed                 return;
12601981771bSAli Ahmed             }
12611981771bSAli Ahmed 
12621981771bSAli Ahmed             // Make sure the Dbus response map has a service and objectPath
12631981771bSAli Ahmed             // field
12641981771bSAli Ahmed             if (subtree[0].first.empty() || subtree[0].second.size() != 1)
12651981771bSAli Ahmed             {
12661981771bSAli Ahmed                 BMCWEB_LOG_DEBUG << "TPM.Policy mapper error!";
12671981771bSAli Ahmed                 messages::internalError(aResp->res);
12681981771bSAli Ahmed                 return;
12691981771bSAli Ahmed             }
12701981771bSAli Ahmed 
12711981771bSAli Ahmed             const std::string& path = subtree[0].first;
12721981771bSAli Ahmed             const std::string& serv = subtree[0].second.begin()->first;
12731981771bSAli Ahmed 
12741981771bSAli Ahmed             // Valid TPM Enable object found, now reading the current value
12751e1e598dSJonathan Doman             sdbusplus::asio::getProperty<bool>(
12761e1e598dSJonathan Doman                 *crow::connections::systemBus, serv, path,
12771e1e598dSJonathan Doman                 "xyz.openbmc_project.Control.TPM.Policy", "TPMEnable",
12781e1e598dSJonathan Doman                 [aResp](const boost::system::error_code ec, bool tpmRequired) {
12791981771bSAli Ahmed                     if (ec)
12801981771bSAli Ahmed                     {
12811981771bSAli Ahmed                         BMCWEB_LOG_DEBUG
12821981771bSAli Ahmed                             << "D-BUS response error on TPM.Policy Get" << ec;
12831981771bSAli Ahmed                         messages::internalError(aResp->res);
12841981771bSAli Ahmed                         return;
12851981771bSAli Ahmed                     }
12861981771bSAli Ahmed 
12871e1e598dSJonathan Doman                     if (tpmRequired)
12881981771bSAli Ahmed                     {
12891981771bSAli Ahmed                         aResp->res
12901981771bSAli Ahmed                             .jsonValue["Boot"]["TrustedModuleRequiredToBoot"] =
12911981771bSAli Ahmed                             "Required";
12921981771bSAli Ahmed                     }
12931981771bSAli Ahmed                     else
12941981771bSAli Ahmed                     {
12951981771bSAli Ahmed                         aResp->res
12961981771bSAli Ahmed                             .jsonValue["Boot"]["TrustedModuleRequiredToBoot"] =
12971981771bSAli Ahmed                             "Disabled";
12981981771bSAli Ahmed                     }
12991e1e598dSJonathan Doman                 });
13001981771bSAli Ahmed         },
13011981771bSAli Ahmed         "xyz.openbmc_project.ObjectMapper",
13021981771bSAli Ahmed         "/xyz/openbmc_project/object_mapper",
13031981771bSAli Ahmed         "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", int32_t(0),
13041981771bSAli Ahmed         std::array<const char*, 1>{"xyz.openbmc_project.Control.TPM.Policy"});
13051981771bSAli Ahmed }
13061981771bSAli Ahmed 
13071981771bSAli Ahmed /**
13081c05dae3SAli Ahmed  * @brief Set TrustedModuleRequiredToBoot property. Determines whether or not
13091c05dae3SAli Ahmed  * TPM is required for booting the host.
13101c05dae3SAli Ahmed  *
13111c05dae3SAli Ahmed  * @param[in] aResp         Shared pointer for generating response message.
13121c05dae3SAli Ahmed  * @param[in] tpmRequired   Value to set TPM Required To Boot property to.
13131c05dae3SAli Ahmed  *
13141c05dae3SAli Ahmed  * @return None.
13151c05dae3SAli Ahmed  */
13161c05dae3SAli Ahmed inline void setTrustedModuleRequiredToBoot(
13171c05dae3SAli Ahmed     const std::shared_ptr<bmcweb::AsyncResp>& aResp, const bool tpmRequired)
13181c05dae3SAli Ahmed {
13191c05dae3SAli Ahmed     BMCWEB_LOG_DEBUG << "Set TrustedModuleRequiredToBoot.";
13201c05dae3SAli Ahmed 
13211c05dae3SAli Ahmed     crow::connections::systemBus->async_method_call(
13221c05dae3SAli Ahmed         [aResp, tpmRequired](
13231c05dae3SAli Ahmed             const boost::system::error_code ec,
13241c05dae3SAli Ahmed             std::vector<std::pair<
13251c05dae3SAli Ahmed                 std::string,
13261c05dae3SAli Ahmed                 std::vector<std::pair<std::string, std::vector<std::string>>>>>&
13271c05dae3SAli Ahmed                 subtree) {
13281c05dae3SAli Ahmed             if (ec)
13291c05dae3SAli Ahmed             {
13301c05dae3SAli Ahmed                 BMCWEB_LOG_DEBUG
13311c05dae3SAli Ahmed                     << "DBUS response error on TPM.Policy GetSubTree" << ec;
13321c05dae3SAli Ahmed                 messages::internalError(aResp->res);
13331c05dae3SAli Ahmed                 return;
13341c05dae3SAli Ahmed             }
13351c05dae3SAli Ahmed             if (subtree.size() == 0)
13361c05dae3SAli Ahmed             {
13371c05dae3SAli Ahmed                 messages::propertyValueNotInList(aResp->res, "ComputerSystem",
13381c05dae3SAli Ahmed                                                  "TrustedModuleRequiredToBoot");
13391c05dae3SAli Ahmed                 return;
13401c05dae3SAli Ahmed             }
13411c05dae3SAli Ahmed 
13421c05dae3SAli Ahmed             /* When there is more than one TPMEnable object... */
13431c05dae3SAli Ahmed             if (subtree.size() > 1)
13441c05dae3SAli Ahmed             {
13451c05dae3SAli Ahmed                 BMCWEB_LOG_DEBUG
13461c05dae3SAli Ahmed                     << "DBUS response has more than 1 TPM Enable object:"
13471c05dae3SAli Ahmed                     << subtree.size();
13481c05dae3SAli Ahmed                 // Throw an internal Error and return
13491c05dae3SAli Ahmed                 messages::internalError(aResp->res);
13501c05dae3SAli Ahmed                 return;
13511c05dae3SAli Ahmed             }
13521c05dae3SAli Ahmed 
13531c05dae3SAli Ahmed             // Make sure the Dbus response map has a service and objectPath
13541c05dae3SAli Ahmed             // field
13551c05dae3SAli Ahmed             if (subtree[0].first.empty() || subtree[0].second.size() != 1)
13561c05dae3SAli Ahmed             {
13571c05dae3SAli Ahmed                 BMCWEB_LOG_DEBUG << "TPM.Policy mapper error!";
13581c05dae3SAli Ahmed                 messages::internalError(aResp->res);
13591c05dae3SAli Ahmed                 return;
13601c05dae3SAli Ahmed             }
13611c05dae3SAli Ahmed 
13621c05dae3SAli Ahmed             const std::string& path = subtree[0].first;
13631c05dae3SAli Ahmed             const std::string& serv = subtree[0].second.begin()->first;
13641c05dae3SAli Ahmed 
13651c05dae3SAli Ahmed             if (serv.empty())
13661c05dae3SAli Ahmed             {
13671c05dae3SAli Ahmed                 BMCWEB_LOG_DEBUG << "TPM.Policy service mapper error!";
13681c05dae3SAli Ahmed                 messages::internalError(aResp->res);
13691c05dae3SAli Ahmed                 return;
13701c05dae3SAli Ahmed             }
13711c05dae3SAli Ahmed 
13721c05dae3SAli Ahmed             // Valid TPM Enable object found, now setting the value
13731c05dae3SAli Ahmed             crow::connections::systemBus->async_method_call(
13741c05dae3SAli Ahmed                 [aResp](const boost::system::error_code ec) {
13751c05dae3SAli Ahmed                     if (ec)
13761c05dae3SAli Ahmed                     {
13770fda0f12SGeorge Liu                         BMCWEB_LOG_DEBUG
13780fda0f12SGeorge Liu                             << "DBUS response error: Set TrustedModuleRequiredToBoot"
13791c05dae3SAli Ahmed                             << ec;
13801c05dae3SAli Ahmed                         messages::internalError(aResp->res);
13811c05dae3SAli Ahmed                         return;
13821c05dae3SAli Ahmed                     }
13831c05dae3SAli Ahmed                     BMCWEB_LOG_DEBUG << "Set TrustedModuleRequiredToBoot done.";
13841c05dae3SAli Ahmed                 },
13851c05dae3SAli Ahmed                 serv, path, "org.freedesktop.DBus.Properties", "Set",
13861c05dae3SAli Ahmed                 "xyz.openbmc_project.Control.TPM.Policy", "TPMEnable",
1387168e20c1SEd Tanous                 dbus::utility::DbusVariantType(tpmRequired));
13881c05dae3SAli Ahmed         },
13891c05dae3SAli Ahmed         "xyz.openbmc_project.ObjectMapper",
13901c05dae3SAli Ahmed         "/xyz/openbmc_project/object_mapper",
13911c05dae3SAli Ahmed         "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", int32_t(0),
13921c05dae3SAli Ahmed         std::array<const char*, 1>{"xyz.openbmc_project.Control.TPM.Policy"});
13931c05dae3SAli Ahmed }
13941c05dae3SAli Ahmed 
13951c05dae3SAli Ahmed /**
1396491d8ee7SSantosh Puranik  * @brief Sets boot properties into DBUS object(s).
1397491d8ee7SSantosh Puranik  *
1398491d8ee7SSantosh Puranik  * @param[in] aResp           Shared pointer for generating response message.
1399cd9a4666SKonstantin Aladyshev  * @param[in] bootType        The boot type to set.
1400cd9a4666SKonstantin Aladyshev  * @return Integer error code.
1401cd9a4666SKonstantin Aladyshev  */
1402cd9a4666SKonstantin Aladyshev inline void setBootType(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
1403cd9a4666SKonstantin Aladyshev                         const std::optional<std::string>& bootType)
1404cd9a4666SKonstantin Aladyshev {
1405c21865c4SKonstantin Aladyshev     std::string bootTypeStr;
1406cd9a4666SKonstantin Aladyshev 
1407c21865c4SKonstantin Aladyshev     if (!bootType)
1408cd9a4666SKonstantin Aladyshev     {
1409c21865c4SKonstantin Aladyshev         return;
1410c21865c4SKonstantin Aladyshev     }
1411c21865c4SKonstantin Aladyshev 
1412cd9a4666SKonstantin Aladyshev     // Source target specified
1413cd9a4666SKonstantin Aladyshev     BMCWEB_LOG_DEBUG << "Boot type: " << *bootType;
1414cd9a4666SKonstantin Aladyshev     // Figure out which DBUS interface and property to use
1415cd9a4666SKonstantin Aladyshev     if (*bootType == "Legacy")
1416cd9a4666SKonstantin Aladyshev     {
1417cd9a4666SKonstantin Aladyshev         bootTypeStr = "xyz.openbmc_project.Control.Boot.Type.Types.Legacy";
1418cd9a4666SKonstantin Aladyshev     }
1419cd9a4666SKonstantin Aladyshev     else if (*bootType == "UEFI")
1420cd9a4666SKonstantin Aladyshev     {
1421cd9a4666SKonstantin Aladyshev         bootTypeStr = "xyz.openbmc_project.Control.Boot.Type.Types.EFI";
1422cd9a4666SKonstantin Aladyshev     }
1423cd9a4666SKonstantin Aladyshev     else
1424cd9a4666SKonstantin Aladyshev     {
1425cd9a4666SKonstantin Aladyshev         BMCWEB_LOG_DEBUG << "Invalid property value for "
1426cd9a4666SKonstantin Aladyshev                             "BootSourceOverrideMode: "
1427cd9a4666SKonstantin Aladyshev                          << *bootType;
1428cd9a4666SKonstantin Aladyshev         messages::propertyValueNotInList(aResp->res, *bootType,
1429cd9a4666SKonstantin Aladyshev                                          "BootSourceOverrideMode");
1430cd9a4666SKonstantin Aladyshev         return;
1431cd9a4666SKonstantin Aladyshev     }
1432cd9a4666SKonstantin Aladyshev 
1433cd9a4666SKonstantin Aladyshev     // Act on validated parameters
1434cd9a4666SKonstantin Aladyshev     BMCWEB_LOG_DEBUG << "DBUS boot type: " << bootTypeStr;
1435cd9a4666SKonstantin Aladyshev 
1436cd9a4666SKonstantin Aladyshev     crow::connections::systemBus->async_method_call(
1437c21865c4SKonstantin Aladyshev         [aResp](const boost::system::error_code ec) {
1438cd9a4666SKonstantin Aladyshev             if (ec)
1439cd9a4666SKonstantin Aladyshev             {
1440cd9a4666SKonstantin Aladyshev                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1441cd9a4666SKonstantin Aladyshev                 if (ec.value() == boost::asio::error::host_unreachable)
1442cd9a4666SKonstantin Aladyshev                 {
1443cd9a4666SKonstantin Aladyshev                     messages::resourceNotFound(aResp->res, "Set", "BootType");
1444cd9a4666SKonstantin Aladyshev                     return;
1445cd9a4666SKonstantin Aladyshev                 }
1446cd9a4666SKonstantin Aladyshev                 messages::internalError(aResp->res);
1447cd9a4666SKonstantin Aladyshev                 return;
1448cd9a4666SKonstantin Aladyshev             }
1449cd9a4666SKonstantin Aladyshev             BMCWEB_LOG_DEBUG << "Boot type update done.";
1450cd9a4666SKonstantin Aladyshev         },
1451c21865c4SKonstantin Aladyshev         "xyz.openbmc_project.Settings",
1452c21865c4SKonstantin Aladyshev         "/xyz/openbmc_project/control/host0/boot",
1453cd9a4666SKonstantin Aladyshev         "org.freedesktop.DBus.Properties", "Set",
1454cd9a4666SKonstantin Aladyshev         "xyz.openbmc_project.Control.Boot.Type", "BootType",
1455168e20c1SEd Tanous         dbus::utility::DbusVariantType(bootTypeStr));
1456cd9a4666SKonstantin Aladyshev }
1457cd9a4666SKonstantin Aladyshev 
1458cd9a4666SKonstantin Aladyshev /**
1459cd9a4666SKonstantin Aladyshev  * @brief Sets boot properties into DBUS object(s).
1460cd9a4666SKonstantin Aladyshev  *
1461cd9a4666SKonstantin Aladyshev  * @param[in] aResp           Shared pointer for generating response message.
1462c21865c4SKonstantin Aladyshev  * @param[in] bootType        The boot type to set.
1463c21865c4SKonstantin Aladyshev  * @return Integer error code.
1464c21865c4SKonstantin Aladyshev  */
1465c21865c4SKonstantin Aladyshev inline void setBootEnable(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
1466c21865c4SKonstantin Aladyshev                           const std::optional<std::string>& bootEnable)
1467c21865c4SKonstantin Aladyshev {
1468c21865c4SKonstantin Aladyshev     if (!bootEnable)
1469c21865c4SKonstantin Aladyshev     {
1470c21865c4SKonstantin Aladyshev         return;
1471c21865c4SKonstantin Aladyshev     }
1472c21865c4SKonstantin Aladyshev     // Source target specified
1473c21865c4SKonstantin Aladyshev     BMCWEB_LOG_DEBUG << "Boot enable: " << *bootEnable;
1474c21865c4SKonstantin Aladyshev 
1475c21865c4SKonstantin Aladyshev     bool bootOverrideEnable = false;
1476c21865c4SKonstantin Aladyshev     bool bootOverridePersistent = false;
1477c21865c4SKonstantin Aladyshev     // Figure out which DBUS interface and property to use
1478c21865c4SKonstantin Aladyshev     if (*bootEnable == "Disabled")
1479c21865c4SKonstantin Aladyshev     {
1480c21865c4SKonstantin Aladyshev         bootOverrideEnable = false;
1481c21865c4SKonstantin Aladyshev     }
1482c21865c4SKonstantin Aladyshev     else if (*bootEnable == "Once")
1483c21865c4SKonstantin Aladyshev     {
1484c21865c4SKonstantin Aladyshev         bootOverrideEnable = true;
1485c21865c4SKonstantin Aladyshev         bootOverridePersistent = false;
1486c21865c4SKonstantin Aladyshev     }
1487c21865c4SKonstantin Aladyshev     else if (*bootEnable == "Continuous")
1488c21865c4SKonstantin Aladyshev     {
1489c21865c4SKonstantin Aladyshev         bootOverrideEnable = true;
1490c21865c4SKonstantin Aladyshev         bootOverridePersistent = true;
1491c21865c4SKonstantin Aladyshev     }
1492c21865c4SKonstantin Aladyshev     else
1493c21865c4SKonstantin Aladyshev     {
14940fda0f12SGeorge Liu         BMCWEB_LOG_DEBUG
14950fda0f12SGeorge Liu             << "Invalid property value for BootSourceOverrideEnabled: "
1496c21865c4SKonstantin Aladyshev             << *bootEnable;
1497c21865c4SKonstantin Aladyshev         messages::propertyValueNotInList(aResp->res, *bootEnable,
1498c21865c4SKonstantin Aladyshev                                          "BootSourceOverrideEnabled");
1499c21865c4SKonstantin Aladyshev         return;
1500c21865c4SKonstantin Aladyshev     }
1501c21865c4SKonstantin Aladyshev 
1502c21865c4SKonstantin Aladyshev     // Act on validated parameters
1503c21865c4SKonstantin Aladyshev     BMCWEB_LOG_DEBUG << "DBUS boot override enable: " << bootOverrideEnable;
1504c21865c4SKonstantin Aladyshev 
1505c21865c4SKonstantin Aladyshev     crow::connections::systemBus->async_method_call(
1506c21865c4SKonstantin Aladyshev         [aResp](const boost::system::error_code ec) {
1507c21865c4SKonstantin Aladyshev             if (ec)
1508c21865c4SKonstantin Aladyshev             {
1509c21865c4SKonstantin Aladyshev                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1510c21865c4SKonstantin Aladyshev                 messages::internalError(aResp->res);
1511c21865c4SKonstantin Aladyshev                 return;
1512c21865c4SKonstantin Aladyshev             }
1513c21865c4SKonstantin Aladyshev             BMCWEB_LOG_DEBUG << "Boot override enable update done.";
1514c21865c4SKonstantin Aladyshev         },
1515c21865c4SKonstantin Aladyshev         "xyz.openbmc_project.Settings",
1516c21865c4SKonstantin Aladyshev         "/xyz/openbmc_project/control/host0/boot",
1517c21865c4SKonstantin Aladyshev         "org.freedesktop.DBus.Properties", "Set",
1518c21865c4SKonstantin Aladyshev         "xyz.openbmc_project.Object.Enable", "Enabled",
1519168e20c1SEd Tanous         dbus::utility::DbusVariantType(bootOverrideEnable));
1520c21865c4SKonstantin Aladyshev 
1521c21865c4SKonstantin Aladyshev     if (!bootOverrideEnable)
1522c21865c4SKonstantin Aladyshev     {
1523c21865c4SKonstantin Aladyshev         return;
1524c21865c4SKonstantin Aladyshev     }
1525c21865c4SKonstantin Aladyshev 
1526c21865c4SKonstantin Aladyshev     // In case boot override is enabled we need to set correct value for the
1527c21865c4SKonstantin Aladyshev     // 'one_time' enable DBus interface
1528c21865c4SKonstantin Aladyshev     BMCWEB_LOG_DEBUG << "DBUS boot override persistent: "
1529c21865c4SKonstantin Aladyshev                      << bootOverridePersistent;
1530c21865c4SKonstantin Aladyshev 
1531c21865c4SKonstantin Aladyshev     crow::connections::systemBus->async_method_call(
1532c21865c4SKonstantin Aladyshev         [aResp](const boost::system::error_code ec) {
1533c21865c4SKonstantin Aladyshev             if (ec)
1534c21865c4SKonstantin Aladyshev             {
1535c21865c4SKonstantin Aladyshev                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1536c21865c4SKonstantin Aladyshev                 messages::internalError(aResp->res);
1537c21865c4SKonstantin Aladyshev                 return;
1538c21865c4SKonstantin Aladyshev             }
1539c21865c4SKonstantin Aladyshev             BMCWEB_LOG_DEBUG << "Boot one_time update done.";
1540c21865c4SKonstantin Aladyshev         },
1541c21865c4SKonstantin Aladyshev         "xyz.openbmc_project.Settings",
1542c21865c4SKonstantin Aladyshev         "/xyz/openbmc_project/control/host0/boot/one_time",
1543c21865c4SKonstantin Aladyshev         "org.freedesktop.DBus.Properties", "Set",
1544c21865c4SKonstantin Aladyshev         "xyz.openbmc_project.Object.Enable", "Enabled",
1545168e20c1SEd Tanous         dbus::utility::DbusVariantType(!bootOverridePersistent));
1546c21865c4SKonstantin Aladyshev }
1547c21865c4SKonstantin Aladyshev 
1548c21865c4SKonstantin Aladyshev /**
1549c21865c4SKonstantin Aladyshev  * @brief Sets boot properties into DBUS object(s).
1550c21865c4SKonstantin Aladyshev  *
1551c21865c4SKonstantin Aladyshev  * @param[in] aResp           Shared pointer for generating response message.
1552491d8ee7SSantosh Puranik  * @param[in] bootSource      The boot source to set.
1553491d8ee7SSantosh Puranik  *
1554265c1602SJohnathan Mantey  * @return Integer error code.
1555491d8ee7SSantosh Puranik  */
1556cd9a4666SKonstantin Aladyshev inline void setBootModeOrSource(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
1557cd9a4666SKonstantin Aladyshev                                 const std::optional<std::string>& bootSource)
1558491d8ee7SSantosh Puranik {
1559c21865c4SKonstantin Aladyshev     std::string bootSourceStr;
1560c21865c4SKonstantin Aladyshev     std::string bootModeStr;
1561944ffaf9SJohnathan Mantey 
1562c21865c4SKonstantin Aladyshev     if (!bootSource)
1563491d8ee7SSantosh Puranik     {
1564c21865c4SKonstantin Aladyshev         return;
1565c21865c4SKonstantin Aladyshev     }
1566c21865c4SKonstantin Aladyshev 
1567491d8ee7SSantosh Puranik     // Source target specified
1568491d8ee7SSantosh Puranik     BMCWEB_LOG_DEBUG << "Boot source: " << *bootSource;
1569491d8ee7SSantosh Puranik     // Figure out which DBUS interface and property to use
1570c21865c4SKonstantin Aladyshev     if (assignBootParameters(aResp, *bootSource, bootSourceStr, bootModeStr))
1571491d8ee7SSantosh Puranik     {
1572944ffaf9SJohnathan Mantey         BMCWEB_LOG_DEBUG
1573944ffaf9SJohnathan Mantey             << "Invalid property value for BootSourceOverrideTarget: "
1574491d8ee7SSantosh Puranik             << *bootSource;
1575491d8ee7SSantosh Puranik         messages::propertyValueNotInList(aResp->res, *bootSource,
1576491d8ee7SSantosh Puranik                                          "BootSourceTargetOverride");
1577491d8ee7SSantosh Puranik         return;
1578491d8ee7SSantosh Puranik     }
1579491d8ee7SSantosh Puranik 
1580944ffaf9SJohnathan Mantey     // Act on validated parameters
1581944ffaf9SJohnathan Mantey     BMCWEB_LOG_DEBUG << "DBUS boot source: " << bootSourceStr;
1582944ffaf9SJohnathan Mantey     BMCWEB_LOG_DEBUG << "DBUS boot mode: " << bootModeStr;
1583944ffaf9SJohnathan Mantey 
1584491d8ee7SSantosh Puranik     crow::connections::systemBus->async_method_call(
1585491d8ee7SSantosh Puranik         [aResp](const boost::system::error_code ec) {
1586491d8ee7SSantosh Puranik             if (ec)
1587491d8ee7SSantosh Puranik             {
1588491d8ee7SSantosh Puranik                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1589491d8ee7SSantosh Puranik                 messages::internalError(aResp->res);
1590491d8ee7SSantosh Puranik                 return;
1591491d8ee7SSantosh Puranik             }
1592491d8ee7SSantosh Puranik             BMCWEB_LOG_DEBUG << "Boot source update done.";
1593491d8ee7SSantosh Puranik         },
1594c21865c4SKonstantin Aladyshev         "xyz.openbmc_project.Settings",
1595c21865c4SKonstantin Aladyshev         "/xyz/openbmc_project/control/host0/boot",
1596491d8ee7SSantosh Puranik         "org.freedesktop.DBus.Properties", "Set",
1597491d8ee7SSantosh Puranik         "xyz.openbmc_project.Control.Boot.Source", "BootSource",
1598168e20c1SEd Tanous         dbus::utility::DbusVariantType(bootSourceStr));
1599944ffaf9SJohnathan Mantey 
1600491d8ee7SSantosh Puranik     crow::connections::systemBus->async_method_call(
1601491d8ee7SSantosh Puranik         [aResp](const boost::system::error_code ec) {
1602491d8ee7SSantosh Puranik             if (ec)
1603491d8ee7SSantosh Puranik             {
1604491d8ee7SSantosh Puranik                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1605491d8ee7SSantosh Puranik                 messages::internalError(aResp->res);
1606491d8ee7SSantosh Puranik                 return;
1607491d8ee7SSantosh Puranik             }
1608491d8ee7SSantosh Puranik             BMCWEB_LOG_DEBUG << "Boot mode update done.";
1609491d8ee7SSantosh Puranik         },
1610c21865c4SKonstantin Aladyshev         "xyz.openbmc_project.Settings",
1611c21865c4SKonstantin Aladyshev         "/xyz/openbmc_project/control/host0/boot",
1612491d8ee7SSantosh Puranik         "org.freedesktop.DBus.Properties", "Set",
1613491d8ee7SSantosh Puranik         "xyz.openbmc_project.Control.Boot.Mode", "BootMode",
1614168e20c1SEd Tanous         dbus::utility::DbusVariantType(bootModeStr));
1615cd9a4666SKonstantin Aladyshev }
1616944ffaf9SJohnathan Mantey 
1617cd9a4666SKonstantin Aladyshev /**
1618c21865c4SKonstantin Aladyshev  * @brief Sets Boot source override properties.
1619491d8ee7SSantosh Puranik  *
1620491d8ee7SSantosh Puranik  * @param[in] aResp      Shared pointer for generating response message.
1621491d8ee7SSantosh Puranik  * @param[in] bootSource The boot source from incoming RF request.
1622cd9a4666SKonstantin Aladyshev  * @param[in] bootType   The boot type from incoming RF request.
1623491d8ee7SSantosh Puranik  * @param[in] bootEnable The boot override enable from incoming RF request.
1624491d8ee7SSantosh Puranik  *
1625265c1602SJohnathan Mantey  * @return Integer error code.
1626491d8ee7SSantosh Puranik  */
1627c21865c4SKonstantin Aladyshev 
1628c21865c4SKonstantin Aladyshev inline void setBootProperties(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
1629c21865c4SKonstantin Aladyshev                               const std::optional<std::string>& bootSource,
1630c21865c4SKonstantin Aladyshev                               const std::optional<std::string>& bootType,
1631c21865c4SKonstantin Aladyshev                               const std::optional<std::string>& bootEnable)
1632491d8ee7SSantosh Puranik {
1633491d8ee7SSantosh Puranik     BMCWEB_LOG_DEBUG << "Set boot information.";
1634491d8ee7SSantosh Puranik 
1635c21865c4SKonstantin Aladyshev     setBootModeOrSource(aResp, bootSource);
1636c21865c4SKonstantin Aladyshev     setBootType(aResp, bootType);
1637c21865c4SKonstantin Aladyshev     setBootEnable(aResp, bootEnable);
1638491d8ee7SSantosh Puranik }
1639491d8ee7SSantosh Puranik 
1640c6a620f2SGeorge Liu /**
164198e386ecSGunnar Mills  * @brief Sets AssetTag
164298e386ecSGunnar Mills  *
164398e386ecSGunnar Mills  * @param[in] aResp   Shared pointer for generating response message.
164498e386ecSGunnar Mills  * @param[in] assetTag  "AssetTag" from request.
164598e386ecSGunnar Mills  *
164698e386ecSGunnar Mills  * @return None.
164798e386ecSGunnar Mills  */
16488d1b46d7Szhanghch05 inline void setAssetTag(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
164998e386ecSGunnar Mills                         const std::string& assetTag)
165098e386ecSGunnar Mills {
165198e386ecSGunnar Mills     crow::connections::systemBus->async_method_call(
165298e386ecSGunnar Mills         [aResp, assetTag](
165398e386ecSGunnar Mills             const boost::system::error_code ec,
165498e386ecSGunnar Mills             const std::vector<std::pair<
165598e386ecSGunnar Mills                 std::string,
165698e386ecSGunnar Mills                 std::vector<std::pair<std::string, std::vector<std::string>>>>>&
165798e386ecSGunnar Mills                 subtree) {
165898e386ecSGunnar Mills             if (ec)
165998e386ecSGunnar Mills             {
166098e386ecSGunnar Mills                 BMCWEB_LOG_DEBUG << "D-Bus response error on GetSubTree " << ec;
166198e386ecSGunnar Mills                 messages::internalError(aResp->res);
166298e386ecSGunnar Mills                 return;
166398e386ecSGunnar Mills             }
166498e386ecSGunnar Mills             if (subtree.size() == 0)
166598e386ecSGunnar Mills             {
166698e386ecSGunnar Mills                 BMCWEB_LOG_DEBUG << "Can't find system D-Bus object!";
166798e386ecSGunnar Mills                 messages::internalError(aResp->res);
166898e386ecSGunnar Mills                 return;
166998e386ecSGunnar Mills             }
167098e386ecSGunnar Mills             // Assume only 1 system D-Bus object
167198e386ecSGunnar Mills             // Throw an error if there is more than 1
167298e386ecSGunnar Mills             if (subtree.size() > 1)
167398e386ecSGunnar Mills             {
167498e386ecSGunnar Mills                 BMCWEB_LOG_DEBUG << "Found more than 1 system D-Bus object!";
167598e386ecSGunnar Mills                 messages::internalError(aResp->res);
167698e386ecSGunnar Mills                 return;
167798e386ecSGunnar Mills             }
167898e386ecSGunnar Mills             if (subtree[0].first.empty() || subtree[0].second.size() != 1)
167998e386ecSGunnar Mills             {
168098e386ecSGunnar Mills                 BMCWEB_LOG_DEBUG << "Asset Tag Set mapper error!";
168198e386ecSGunnar Mills                 messages::internalError(aResp->res);
168298e386ecSGunnar Mills                 return;
168398e386ecSGunnar Mills             }
168498e386ecSGunnar Mills 
168598e386ecSGunnar Mills             const std::string& path = subtree[0].first;
168698e386ecSGunnar Mills             const std::string& service = subtree[0].second.begin()->first;
168798e386ecSGunnar Mills 
168898e386ecSGunnar Mills             if (service.empty())
168998e386ecSGunnar Mills             {
169098e386ecSGunnar Mills                 BMCWEB_LOG_DEBUG << "Asset Tag Set service mapper error!";
169198e386ecSGunnar Mills                 messages::internalError(aResp->res);
169298e386ecSGunnar Mills                 return;
169398e386ecSGunnar Mills             }
169498e386ecSGunnar Mills 
169598e386ecSGunnar Mills             crow::connections::systemBus->async_method_call(
169698e386ecSGunnar Mills                 [aResp](const boost::system::error_code ec2) {
169798e386ecSGunnar Mills                     if (ec2)
169898e386ecSGunnar Mills                     {
169998e386ecSGunnar Mills                         BMCWEB_LOG_DEBUG
170098e386ecSGunnar Mills                             << "D-Bus response error on AssetTag Set " << ec2;
170198e386ecSGunnar Mills                         messages::internalError(aResp->res);
170298e386ecSGunnar Mills                         return;
170398e386ecSGunnar Mills                     }
170498e386ecSGunnar Mills                 },
170598e386ecSGunnar Mills                 service, path, "org.freedesktop.DBus.Properties", "Set",
170698e386ecSGunnar Mills                 "xyz.openbmc_project.Inventory.Decorator.AssetTag", "AssetTag",
1707168e20c1SEd Tanous                 dbus::utility::DbusVariantType(assetTag));
170898e386ecSGunnar Mills         },
170998e386ecSGunnar Mills         "xyz.openbmc_project.ObjectMapper",
171098e386ecSGunnar Mills         "/xyz/openbmc_project/object_mapper",
171198e386ecSGunnar Mills         "xyz.openbmc_project.ObjectMapper", "GetSubTree",
171298e386ecSGunnar Mills         "/xyz/openbmc_project/inventory", int32_t(0),
171398e386ecSGunnar Mills         std::array<const char*, 1>{
171498e386ecSGunnar Mills             "xyz.openbmc_project.Inventory.Item.System"});
171598e386ecSGunnar Mills }
171698e386ecSGunnar Mills 
171798e386ecSGunnar Mills /**
171869f35306SGunnar Mills  * @brief Sets automaticRetry (Auto Reboot)
171969f35306SGunnar Mills  *
172069f35306SGunnar Mills  * @param[in] aResp   Shared pointer for generating response message.
172169f35306SGunnar Mills  * @param[in] automaticRetryConfig  "AutomaticRetryConfig" from request.
172269f35306SGunnar Mills  *
172369f35306SGunnar Mills  * @return None.
172469f35306SGunnar Mills  */
17258d1b46d7Szhanghch05 inline void setAutomaticRetry(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
1726f23b7296SEd Tanous                               const std::string& automaticRetryConfig)
172769f35306SGunnar Mills {
172869f35306SGunnar Mills     BMCWEB_LOG_DEBUG << "Set Automatic Retry.";
172969f35306SGunnar Mills 
173069f35306SGunnar Mills     // OpenBMC only supports "Disabled" and "RetryAttempts".
1731*543f4400SEd Tanous     bool autoRebootEnabled = false;
173269f35306SGunnar Mills 
173369f35306SGunnar Mills     if (automaticRetryConfig == "Disabled")
173469f35306SGunnar Mills     {
173569f35306SGunnar Mills         autoRebootEnabled = false;
173669f35306SGunnar Mills     }
173769f35306SGunnar Mills     else if (automaticRetryConfig == "RetryAttempts")
173869f35306SGunnar Mills     {
173969f35306SGunnar Mills         autoRebootEnabled = true;
174069f35306SGunnar Mills     }
174169f35306SGunnar Mills     else
174269f35306SGunnar Mills     {
17430fda0f12SGeorge Liu         BMCWEB_LOG_DEBUG << "Invalid property value for AutomaticRetryConfig: "
174469f35306SGunnar Mills                          << automaticRetryConfig;
174569f35306SGunnar Mills         messages::propertyValueNotInList(aResp->res, automaticRetryConfig,
174669f35306SGunnar Mills                                          "AutomaticRetryConfig");
174769f35306SGunnar Mills         return;
174869f35306SGunnar Mills     }
174969f35306SGunnar Mills 
175069f35306SGunnar Mills     crow::connections::systemBus->async_method_call(
175169f35306SGunnar Mills         [aResp](const boost::system::error_code ec) {
175269f35306SGunnar Mills             if (ec)
175369f35306SGunnar Mills             {
175469f35306SGunnar Mills                 messages::internalError(aResp->res);
175569f35306SGunnar Mills                 return;
175669f35306SGunnar Mills             }
175769f35306SGunnar Mills         },
175869f35306SGunnar Mills         "xyz.openbmc_project.Settings",
175969f35306SGunnar Mills         "/xyz/openbmc_project/control/host0/auto_reboot",
176069f35306SGunnar Mills         "org.freedesktop.DBus.Properties", "Set",
176169f35306SGunnar Mills         "xyz.openbmc_project.Control.Boot.RebootPolicy", "AutoReboot",
1762168e20c1SEd Tanous         dbus::utility::DbusVariantType(autoRebootEnabled));
176369f35306SGunnar Mills }
176469f35306SGunnar Mills 
176569f35306SGunnar Mills /**
1766c6a620f2SGeorge Liu  * @brief Sets power restore policy properties.
1767c6a620f2SGeorge Liu  *
1768c6a620f2SGeorge Liu  * @param[in] aResp   Shared pointer for generating response message.
1769c6a620f2SGeorge Liu  * @param[in] policy  power restore policy properties from request.
1770c6a620f2SGeorge Liu  *
1771c6a620f2SGeorge Liu  * @return None.
1772c6a620f2SGeorge Liu  */
17738d1b46d7Szhanghch05 inline void
17748d1b46d7Szhanghch05     setPowerRestorePolicy(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
17754e69c904SGunnar Mills                           const std::string& policy)
1776c6a620f2SGeorge Liu {
1777c6a620f2SGeorge Liu     BMCWEB_LOG_DEBUG << "Set power restore policy.";
1778c6a620f2SGeorge Liu 
1779c6a620f2SGeorge Liu     const boost::container::flat_map<std::string, std::string> policyMaps = {
17800fda0f12SGeorge Liu         {"AlwaysOn",
17810fda0f12SGeorge Liu          "xyz.openbmc_project.Control.Power.RestorePolicy.Policy.AlwaysOn"},
17820fda0f12SGeorge Liu         {"AlwaysOff",
17830fda0f12SGeorge Liu          "xyz.openbmc_project.Control.Power.RestorePolicy.Policy.AlwaysOff"},
17840fda0f12SGeorge Liu         {"LastState",
17850fda0f12SGeorge Liu          "xyz.openbmc_project.Control.Power.RestorePolicy.Policy.Restore"}};
1786c6a620f2SGeorge Liu 
1787c6a620f2SGeorge Liu     std::string powerRestorPolicy;
1788c6a620f2SGeorge Liu 
17894e69c904SGunnar Mills     auto policyMapsIt = policyMaps.find(policy);
1790c6a620f2SGeorge Liu     if (policyMapsIt == policyMaps.end())
1791c6a620f2SGeorge Liu     {
17924e69c904SGunnar Mills         messages::propertyValueNotInList(aResp->res, policy,
17934e69c904SGunnar Mills                                          "PowerRestorePolicy");
1794c6a620f2SGeorge Liu         return;
1795c6a620f2SGeorge Liu     }
1796c6a620f2SGeorge Liu 
1797c6a620f2SGeorge Liu     powerRestorPolicy = policyMapsIt->second;
1798c6a620f2SGeorge Liu 
1799c6a620f2SGeorge Liu     crow::connections::systemBus->async_method_call(
1800c6a620f2SGeorge Liu         [aResp](const boost::system::error_code ec) {
1801c6a620f2SGeorge Liu             if (ec)
1802c6a620f2SGeorge Liu             {
1803c6a620f2SGeorge Liu                 messages::internalError(aResp->res);
1804c6a620f2SGeorge Liu                 return;
1805c6a620f2SGeorge Liu             }
1806c6a620f2SGeorge Liu         },
1807c6a620f2SGeorge Liu         "xyz.openbmc_project.Settings",
1808c6a620f2SGeorge Liu         "/xyz/openbmc_project/control/host0/power_restore_policy",
1809c6a620f2SGeorge Liu         "org.freedesktop.DBus.Properties", "Set",
1810c6a620f2SGeorge Liu         "xyz.openbmc_project.Control.Power.RestorePolicy", "PowerRestorePolicy",
1811168e20c1SEd Tanous         dbus::utility::DbusVariantType(powerRestorPolicy));
1812c6a620f2SGeorge Liu }
1813c6a620f2SGeorge Liu 
1814a6349918SAppaRao Puli #ifdef BMCWEB_ENABLE_REDFISH_PROVISIONING_FEATURE
1815a6349918SAppaRao Puli /**
1816a6349918SAppaRao Puli  * @brief Retrieves provisioning status
1817a6349918SAppaRao Puli  *
1818a6349918SAppaRao Puli  * @param[in] aResp     Shared pointer for completing asynchronous calls.
1819a6349918SAppaRao Puli  *
1820a6349918SAppaRao Puli  * @return None.
1821a6349918SAppaRao Puli  */
18228d1b46d7Szhanghch05 inline void getProvisioningStatus(std::shared_ptr<bmcweb::AsyncResp> aResp)
1823a6349918SAppaRao Puli {
1824a6349918SAppaRao Puli     BMCWEB_LOG_DEBUG << "Get OEM information.";
1825a6349918SAppaRao Puli     crow::connections::systemBus->async_method_call(
1826a6349918SAppaRao Puli         [aResp](const boost::system::error_code ec,
18276e3b67ecSAppaRao Puli                 const std::vector<
18286e3b67ecSAppaRao Puli                     std::pair<std::string, dbus::utility::DbusVariantType>>&
18291214b7e7SGunnar Mills                     propertiesList) {
1830b99fb1a9SAppaRao Puli             nlohmann::json& oemPFR =
1831b99fb1a9SAppaRao Puli                 aResp->res.jsonValue["Oem"]["OpenBmc"]["FirmwareProvisioning"];
183250626f4fSJames Feist             aResp->res.jsonValue["Oem"]["OpenBmc"]["@odata.type"] =
183350626f4fSJames Feist                 "#OemComputerSystem.OpenBmc";
183450626f4fSJames Feist             oemPFR["@odata.type"] = "#OemComputerSystem.FirmwareProvisioning";
183550626f4fSJames Feist 
1836a6349918SAppaRao Puli             if (ec)
1837a6349918SAppaRao Puli             {
1838a6349918SAppaRao Puli                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1839b99fb1a9SAppaRao Puli                 // not an error, don't have to have the interface
1840b99fb1a9SAppaRao Puli                 oemPFR["ProvisioningStatus"] = "NotProvisioned";
1841a6349918SAppaRao Puli                 return;
1842a6349918SAppaRao Puli             }
1843a6349918SAppaRao Puli 
1844a6349918SAppaRao Puli             const bool* provState = nullptr;
1845a6349918SAppaRao Puli             const bool* lockState = nullptr;
18466e3b67ecSAppaRao Puli             for (const std::pair<std::string, dbus::utility::DbusVariantType>&
18476e3b67ecSAppaRao Puli                      property : propertiesList)
1848a6349918SAppaRao Puli             {
1849a6349918SAppaRao Puli                 if (property.first == "UfmProvisioned")
1850a6349918SAppaRao Puli                 {
1851a6349918SAppaRao Puli                     provState = std::get_if<bool>(&property.second);
1852a6349918SAppaRao Puli                 }
1853a6349918SAppaRao Puli                 else if (property.first == "UfmLocked")
1854a6349918SAppaRao Puli                 {
1855a6349918SAppaRao Puli                     lockState = std::get_if<bool>(&property.second);
1856a6349918SAppaRao Puli                 }
1857a6349918SAppaRao Puli             }
1858a6349918SAppaRao Puli 
1859a6349918SAppaRao Puli             if ((provState == nullptr) || (lockState == nullptr))
1860a6349918SAppaRao Puli             {
1861a6349918SAppaRao Puli                 BMCWEB_LOG_DEBUG << "Unable to get PFR attributes.";
1862a6349918SAppaRao Puli                 messages::internalError(aResp->res);
1863a6349918SAppaRao Puli                 return;
1864a6349918SAppaRao Puli             }
1865a6349918SAppaRao Puli 
1866a6349918SAppaRao Puli             if (*provState == true)
1867a6349918SAppaRao Puli             {
1868a6349918SAppaRao Puli                 if (*lockState == true)
1869a6349918SAppaRao Puli                 {
1870a6349918SAppaRao Puli                     oemPFR["ProvisioningStatus"] = "ProvisionedAndLocked";
1871a6349918SAppaRao Puli                 }
1872a6349918SAppaRao Puli                 else
1873a6349918SAppaRao Puli                 {
1874a6349918SAppaRao Puli                     oemPFR["ProvisioningStatus"] = "ProvisionedButNotLocked";
1875a6349918SAppaRao Puli                 }
1876a6349918SAppaRao Puli             }
1877a6349918SAppaRao Puli             else
1878a6349918SAppaRao Puli             {
1879a6349918SAppaRao Puli                 oemPFR["ProvisioningStatus"] = "NotProvisioned";
1880a6349918SAppaRao Puli             }
1881a6349918SAppaRao Puli         },
1882a6349918SAppaRao Puli         "xyz.openbmc_project.PFR.Manager", "/xyz/openbmc_project/pfr",
1883a6349918SAppaRao Puli         "org.freedesktop.DBus.Properties", "GetAll",
1884a6349918SAppaRao Puli         "xyz.openbmc_project.PFR.Attributes");
1885a6349918SAppaRao Puli }
1886a6349918SAppaRao Puli #endif
1887a6349918SAppaRao Puli 
1888491d8ee7SSantosh Puranik /**
18893a2d0424SChris Cain  * @brief Translate the PowerMode to a response message.
18903a2d0424SChris Cain  *
18913a2d0424SChris Cain  * @param[in] aResp  Shared pointer for generating response message.
18923a2d0424SChris Cain  * @param[in] modeValue  PowerMode value to be translated
18933a2d0424SChris Cain  *
18943a2d0424SChris Cain  * @return None.
18953a2d0424SChris Cain  */
18963a2d0424SChris Cain inline void translatePowerMode(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
18973a2d0424SChris Cain                                const std::string& modeValue)
18983a2d0424SChris Cain {
18993a2d0424SChris Cain     std::string modeString;
19003a2d0424SChris Cain 
19010fda0f12SGeorge Liu     if (modeValue == "xyz.openbmc_project.Control.Power.Mode.PowerMode.Static")
19023a2d0424SChris Cain     {
19033a2d0424SChris Cain         aResp->res.jsonValue["PowerMode"] = "Static";
19043a2d0424SChris Cain     }
19050fda0f12SGeorge Liu     else if (
19060fda0f12SGeorge Liu         modeValue ==
19070fda0f12SGeorge Liu         "xyz.openbmc_project.Control.Power.Mode.PowerMode.MaximumPerformance")
19083a2d0424SChris Cain     {
19093a2d0424SChris Cain         aResp->res.jsonValue["PowerMode"] = "MaximumPerformance";
19103a2d0424SChris Cain     }
19110fda0f12SGeorge Liu     else if (modeValue ==
19120fda0f12SGeorge Liu              "xyz.openbmc_project.Control.Power.Mode.PowerMode.PowerSaving")
19133a2d0424SChris Cain     {
19143a2d0424SChris Cain         aResp->res.jsonValue["PowerMode"] = "PowerSaving";
19153a2d0424SChris Cain     }
19160fda0f12SGeorge Liu     else if (modeValue ==
19170fda0f12SGeorge Liu              "xyz.openbmc_project.Control.Power.Mode.PowerMode.OEM")
19183a2d0424SChris Cain     {
19193a2d0424SChris Cain         aResp->res.jsonValue["PowerMode"] = "OEM";
19203a2d0424SChris Cain     }
19213a2d0424SChris Cain     else
19223a2d0424SChris Cain     {
19233a2d0424SChris Cain         // Any other values would be invalid
19243a2d0424SChris Cain         BMCWEB_LOG_DEBUG << "PowerMode value was not valid: " << modeValue;
19253a2d0424SChris Cain         messages::internalError(aResp->res);
19263a2d0424SChris Cain     }
19273a2d0424SChris Cain }
19283a2d0424SChris Cain 
19293a2d0424SChris Cain /**
19303a2d0424SChris Cain  * @brief Retrieves system power mode
19313a2d0424SChris Cain  *
19323a2d0424SChris Cain  * @param[in] aResp  Shared pointer for generating response message.
19333a2d0424SChris Cain  *
19343a2d0424SChris Cain  * @return None.
19353a2d0424SChris Cain  */
19363a2d0424SChris Cain inline void getPowerMode(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
19373a2d0424SChris Cain {
19383a2d0424SChris Cain     BMCWEB_LOG_DEBUG << "Get power mode.";
19393a2d0424SChris Cain 
19403a2d0424SChris Cain     // Get Power Mode object path:
19413a2d0424SChris Cain     crow::connections::systemBus->async_method_call(
19423a2d0424SChris Cain         [aResp](
19433a2d0424SChris Cain             const boost::system::error_code ec,
19443a2d0424SChris Cain             const std::vector<std::pair<
19453a2d0424SChris Cain                 std::string,
19463a2d0424SChris Cain                 std::vector<std::pair<std::string, std::vector<std::string>>>>>&
19473a2d0424SChris Cain                 subtree) {
19483a2d0424SChris Cain             if (ec)
19493a2d0424SChris Cain             {
19503a2d0424SChris Cain                 BMCWEB_LOG_DEBUG
19513a2d0424SChris Cain                     << "DBUS response error on Power.Mode GetSubTree " << ec;
19523a2d0424SChris Cain                 // This is an optional D-Bus object so just return if
19533a2d0424SChris Cain                 // error occurs
19543a2d0424SChris Cain                 return;
19553a2d0424SChris Cain             }
19563a2d0424SChris Cain             if (subtree.empty())
19573a2d0424SChris Cain             {
19583a2d0424SChris Cain                 // As noted above, this is an optional interface so just return
19593a2d0424SChris Cain                 // if there is no instance found
19603a2d0424SChris Cain                 return;
19613a2d0424SChris Cain             }
19623a2d0424SChris Cain             if (subtree.size() > 1)
19633a2d0424SChris Cain             {
19643a2d0424SChris Cain                 // More then one PowerMode object is not supported and is an
19653a2d0424SChris Cain                 // error
19663a2d0424SChris Cain                 BMCWEB_LOG_DEBUG
19673a2d0424SChris Cain                     << "Found more than 1 system D-Bus Power.Mode objects: "
19683a2d0424SChris Cain                     << subtree.size();
19693a2d0424SChris Cain                 messages::internalError(aResp->res);
19703a2d0424SChris Cain                 return;
19713a2d0424SChris Cain             }
19723a2d0424SChris Cain             if ((subtree[0].first.empty()) || (subtree[0].second.size() != 1))
19733a2d0424SChris Cain             {
19743a2d0424SChris Cain                 BMCWEB_LOG_DEBUG << "Power.Mode mapper error!";
19753a2d0424SChris Cain                 messages::internalError(aResp->res);
19763a2d0424SChris Cain                 return;
19773a2d0424SChris Cain             }
19783a2d0424SChris Cain             const std::string& path = subtree[0].first;
19793a2d0424SChris Cain             const std::string& service = subtree[0].second.begin()->first;
19803a2d0424SChris Cain             if (service.empty())
19813a2d0424SChris Cain             {
19823a2d0424SChris Cain                 BMCWEB_LOG_DEBUG << "Power.Mode service mapper error!";
19833a2d0424SChris Cain                 messages::internalError(aResp->res);
19843a2d0424SChris Cain                 return;
19853a2d0424SChris Cain             }
19863a2d0424SChris Cain             // Valid Power Mode object found, now read the current value
19871e1e598dSJonathan Doman             sdbusplus::asio::getProperty<std::string>(
19881e1e598dSJonathan Doman                 *crow::connections::systemBus, service, path,
19891e1e598dSJonathan Doman                 "xyz.openbmc_project.Control.Power.Mode", "PowerMode",
19903a2d0424SChris Cain                 [aResp](const boost::system::error_code ec,
19911e1e598dSJonathan Doman                         const std::string& pmode) {
19923a2d0424SChris Cain                     if (ec)
19933a2d0424SChris Cain                     {
19943a2d0424SChris Cain                         BMCWEB_LOG_DEBUG
19953a2d0424SChris Cain                             << "DBUS response error on PowerMode Get: " << ec;
19963a2d0424SChris Cain                         messages::internalError(aResp->res);
19973a2d0424SChris Cain                         return;
19983a2d0424SChris Cain                     }
19993a2d0424SChris Cain 
20003a2d0424SChris Cain                     aResp->res.jsonValue["PowerMode@Redfish.AllowableValues"] =
20013a2d0424SChris Cain                         {"Static", "MaximumPerformance", "PowerSaving"};
20023a2d0424SChris Cain 
20031e1e598dSJonathan Doman                     BMCWEB_LOG_DEBUG << "Current power mode: " << pmode;
20041e1e598dSJonathan Doman                     translatePowerMode(aResp, pmode);
20051e1e598dSJonathan Doman                 });
20063a2d0424SChris Cain         },
20073a2d0424SChris Cain         "xyz.openbmc_project.ObjectMapper",
20083a2d0424SChris Cain         "/xyz/openbmc_project/object_mapper",
20093a2d0424SChris Cain         "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", int32_t(0),
20103a2d0424SChris Cain         std::array<const char*, 1>{"xyz.openbmc_project.Control.Power.Mode"});
20113a2d0424SChris Cain }
20123a2d0424SChris Cain 
20133a2d0424SChris Cain /**
20143a2d0424SChris Cain  * @brief Validate the specified mode is valid and return the PowerMode
20153a2d0424SChris Cain  * name associated with that string
20163a2d0424SChris Cain  *
20173a2d0424SChris Cain  * @param[in] aResp   Shared pointer for generating response message.
20183a2d0424SChris Cain  * @param[in] modeString  String representing the desired PowerMode
20193a2d0424SChris Cain  *
20203a2d0424SChris Cain  * @return PowerMode value or empty string if mode is not valid
20213a2d0424SChris Cain  */
20223a2d0424SChris Cain inline std::string
20233a2d0424SChris Cain     validatePowerMode(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
20243a2d0424SChris Cain                       const std::string& modeString)
20253a2d0424SChris Cain {
20263a2d0424SChris Cain     std::string mode;
20273a2d0424SChris Cain 
20283a2d0424SChris Cain     if (modeString == "Static")
20293a2d0424SChris Cain     {
20303a2d0424SChris Cain         mode = "xyz.openbmc_project.Control.Power.Mode.PowerMode.Static";
20313a2d0424SChris Cain     }
20323a2d0424SChris Cain     else if (modeString == "MaximumPerformance")
20333a2d0424SChris Cain     {
20340fda0f12SGeorge Liu         mode =
20350fda0f12SGeorge Liu             "xyz.openbmc_project.Control.Power.Mode.PowerMode.MaximumPerformance";
20363a2d0424SChris Cain     }
20373a2d0424SChris Cain     else if (modeString == "PowerSaving")
20383a2d0424SChris Cain     {
20393a2d0424SChris Cain         mode = "xyz.openbmc_project.Control.Power.Mode.PowerMode.PowerSaving";
20403a2d0424SChris Cain     }
20413a2d0424SChris Cain     else
20423a2d0424SChris Cain     {
20433a2d0424SChris Cain         messages::propertyValueNotInList(aResp->res, modeString, "PowerMode");
20443a2d0424SChris Cain     }
20453a2d0424SChris Cain     return mode;
20463a2d0424SChris Cain }
20473a2d0424SChris Cain 
20483a2d0424SChris Cain /**
20493a2d0424SChris Cain  * @brief Sets system power mode.
20503a2d0424SChris Cain  *
20513a2d0424SChris Cain  * @param[in] aResp   Shared pointer for generating response message.
20523a2d0424SChris Cain  * @param[in] pmode   System power mode from request.
20533a2d0424SChris Cain  *
20543a2d0424SChris Cain  * @return None.
20553a2d0424SChris Cain  */
20563a2d0424SChris Cain inline void setPowerMode(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
20573a2d0424SChris Cain                          const std::string& pmode)
20583a2d0424SChris Cain {
20593a2d0424SChris Cain     BMCWEB_LOG_DEBUG << "Set power mode.";
20603a2d0424SChris Cain 
20613a2d0424SChris Cain     std::string powerMode = validatePowerMode(aResp, pmode);
20623a2d0424SChris Cain     if (powerMode.empty())
20633a2d0424SChris Cain     {
20643a2d0424SChris Cain         return;
20653a2d0424SChris Cain     }
20663a2d0424SChris Cain 
20673a2d0424SChris Cain     // Get Power Mode object path:
20683a2d0424SChris Cain     crow::connections::systemBus->async_method_call(
20693a2d0424SChris Cain         [aResp, powerMode](
20703a2d0424SChris Cain             const boost::system::error_code ec,
20713a2d0424SChris Cain             const std::vector<std::pair<
20723a2d0424SChris Cain                 std::string,
20733a2d0424SChris Cain                 std::vector<std::pair<std::string, std::vector<std::string>>>>>&
20743a2d0424SChris Cain                 subtree) {
20753a2d0424SChris Cain             if (ec)
20763a2d0424SChris Cain             {
20773a2d0424SChris Cain                 BMCWEB_LOG_DEBUG
20783a2d0424SChris Cain                     << "DBUS response error on Power.Mode GetSubTree " << ec;
20793a2d0424SChris Cain                 // This is an optional D-Bus object, but user attempted to patch
20803a2d0424SChris Cain                 messages::internalError(aResp->res);
20813a2d0424SChris Cain                 return;
20823a2d0424SChris Cain             }
20833a2d0424SChris Cain             if (subtree.empty())
20843a2d0424SChris Cain             {
20853a2d0424SChris Cain                 // This is an optional D-Bus object, but user attempted to patch
20863a2d0424SChris Cain                 messages::resourceNotFound(aResp->res, "ComputerSystem",
20873a2d0424SChris Cain                                            "PowerMode");
20883a2d0424SChris Cain                 return;
20893a2d0424SChris Cain             }
20903a2d0424SChris Cain             if (subtree.size() > 1)
20913a2d0424SChris Cain             {
20923a2d0424SChris Cain                 // More then one PowerMode object is not supported and is an
20933a2d0424SChris Cain                 // error
20943a2d0424SChris Cain                 BMCWEB_LOG_DEBUG
20953a2d0424SChris Cain                     << "Found more than 1 system D-Bus Power.Mode objects: "
20963a2d0424SChris Cain                     << subtree.size();
20973a2d0424SChris Cain                 messages::internalError(aResp->res);
20983a2d0424SChris Cain                 return;
20993a2d0424SChris Cain             }
21003a2d0424SChris Cain             if ((subtree[0].first.empty()) || (subtree[0].second.size() != 1))
21013a2d0424SChris Cain             {
21023a2d0424SChris Cain                 BMCWEB_LOG_DEBUG << "Power.Mode mapper error!";
21033a2d0424SChris Cain                 messages::internalError(aResp->res);
21043a2d0424SChris Cain                 return;
21053a2d0424SChris Cain             }
21063a2d0424SChris Cain             const std::string& path = subtree[0].first;
21073a2d0424SChris Cain             const std::string& service = subtree[0].second.begin()->first;
21083a2d0424SChris Cain             if (service.empty())
21093a2d0424SChris Cain             {
21103a2d0424SChris Cain                 BMCWEB_LOG_DEBUG << "Power.Mode service mapper error!";
21113a2d0424SChris Cain                 messages::internalError(aResp->res);
21123a2d0424SChris Cain                 return;
21133a2d0424SChris Cain             }
21143a2d0424SChris Cain 
21153a2d0424SChris Cain             BMCWEB_LOG_DEBUG << "Setting power mode(" << powerMode << ") -> "
21163a2d0424SChris Cain                              << path;
21173a2d0424SChris Cain 
21183a2d0424SChris Cain             // Set the Power Mode property
21193a2d0424SChris Cain             crow::connections::systemBus->async_method_call(
21203a2d0424SChris Cain                 [aResp](const boost::system::error_code ec) {
21213a2d0424SChris Cain                     if (ec)
21223a2d0424SChris Cain                     {
21233a2d0424SChris Cain                         messages::internalError(aResp->res);
21243a2d0424SChris Cain                         return;
21253a2d0424SChris Cain                     }
21263a2d0424SChris Cain                 },
21273a2d0424SChris Cain                 service, path, "org.freedesktop.DBus.Properties", "Set",
21283a2d0424SChris Cain                 "xyz.openbmc_project.Control.Power.Mode", "PowerMode",
2129168e20c1SEd Tanous                 dbus::utility::DbusVariantType(powerMode));
21303a2d0424SChris Cain         },
21313a2d0424SChris Cain         "xyz.openbmc_project.ObjectMapper",
21323a2d0424SChris Cain         "/xyz/openbmc_project/object_mapper",
21333a2d0424SChris Cain         "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", int32_t(0),
21343a2d0424SChris Cain         std::array<const char*, 1>{"xyz.openbmc_project.Control.Power.Mode"});
21353a2d0424SChris Cain }
21363a2d0424SChris Cain 
21373a2d0424SChris Cain /**
213851709ffdSYong Li  * @brief Translates watchdog timeout action DBUS property value to redfish.
213951709ffdSYong Li  *
214051709ffdSYong Li  * @param[in] dbusAction    The watchdog timeout action in D-BUS.
214151709ffdSYong Li  *
214251709ffdSYong Li  * @return Returns as a string, the timeout action in Redfish terms. If
214351709ffdSYong Li  * translation cannot be done, returns an empty string.
214451709ffdSYong Li  */
214523a21a1cSEd Tanous inline std::string dbusToRfWatchdogAction(const std::string& dbusAction)
214651709ffdSYong Li {
214751709ffdSYong Li     if (dbusAction == "xyz.openbmc_project.State.Watchdog.Action.None")
214851709ffdSYong Li     {
214951709ffdSYong Li         return "None";
215051709ffdSYong Li     }
21513174e4dfSEd Tanous     if (dbusAction == "xyz.openbmc_project.State.Watchdog.Action.HardReset")
215251709ffdSYong Li     {
215351709ffdSYong Li         return "ResetSystem";
215451709ffdSYong Li     }
21553174e4dfSEd Tanous     if (dbusAction == "xyz.openbmc_project.State.Watchdog.Action.PowerOff")
215651709ffdSYong Li     {
215751709ffdSYong Li         return "PowerDown";
215851709ffdSYong Li     }
21593174e4dfSEd Tanous     if (dbusAction == "xyz.openbmc_project.State.Watchdog.Action.PowerCycle")
216051709ffdSYong Li     {
216151709ffdSYong Li         return "PowerCycle";
216251709ffdSYong Li     }
216351709ffdSYong Li 
216451709ffdSYong Li     return "";
216551709ffdSYong Li }
216651709ffdSYong Li 
216751709ffdSYong Li /**
2168c45f0082SYong Li  *@brief Translates timeout action from Redfish to DBUS property value.
2169c45f0082SYong Li  *
2170c45f0082SYong Li  *@param[in] rfAction The timeout action in Redfish.
2171c45f0082SYong Li  *
2172c45f0082SYong Li  *@return Returns as a string, the time_out action as expected by DBUS.
2173c45f0082SYong Li  *If translation cannot be done, returns an empty string.
2174c45f0082SYong Li  */
2175c45f0082SYong Li 
217623a21a1cSEd Tanous inline std::string rfToDbusWDTTimeOutAct(const std::string& rfAction)
2177c45f0082SYong Li {
2178c45f0082SYong Li     if (rfAction == "None")
2179c45f0082SYong Li     {
2180c45f0082SYong Li         return "xyz.openbmc_project.State.Watchdog.Action.None";
2181c45f0082SYong Li     }
21823174e4dfSEd Tanous     if (rfAction == "PowerCycle")
2183c45f0082SYong Li     {
2184c45f0082SYong Li         return "xyz.openbmc_project.State.Watchdog.Action.PowerCycle";
2185c45f0082SYong Li     }
21863174e4dfSEd Tanous     if (rfAction == "PowerDown")
2187c45f0082SYong Li     {
2188c45f0082SYong Li         return "xyz.openbmc_project.State.Watchdog.Action.PowerOff";
2189c45f0082SYong Li     }
21903174e4dfSEd Tanous     if (rfAction == "ResetSystem")
2191c45f0082SYong Li     {
2192c45f0082SYong Li         return "xyz.openbmc_project.State.Watchdog.Action.HardReset";
2193c45f0082SYong Li     }
2194c45f0082SYong Li 
2195c45f0082SYong Li     return "";
2196c45f0082SYong Li }
2197c45f0082SYong Li 
2198c45f0082SYong Li /**
219951709ffdSYong Li  * @brief Retrieves host watchdog timer properties over DBUS
220051709ffdSYong Li  *
220151709ffdSYong Li  * @param[in] aResp     Shared pointer for completing asynchronous calls.
220251709ffdSYong Li  *
220351709ffdSYong Li  * @return None.
220451709ffdSYong Li  */
22058d1b46d7Szhanghch05 inline void
22068d1b46d7Szhanghch05     getHostWatchdogTimer(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
220751709ffdSYong Li {
220851709ffdSYong Li     BMCWEB_LOG_DEBUG << "Get host watchodg";
220951709ffdSYong Li     crow::connections::systemBus->async_method_call(
221051709ffdSYong Li         [aResp](const boost::system::error_code ec,
2211914e2d5dSEd Tanous                 const PropertiesType& properties) {
221251709ffdSYong Li             if (ec)
221351709ffdSYong Li             {
221451709ffdSYong Li                 // watchdog service is stopped
221551709ffdSYong Li                 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
221651709ffdSYong Li                 return;
221751709ffdSYong Li             }
221851709ffdSYong Li 
221951709ffdSYong Li             BMCWEB_LOG_DEBUG << "Got " << properties.size() << " wdt prop.";
222051709ffdSYong Li 
222151709ffdSYong Li             nlohmann::json& hostWatchdogTimer =
222251709ffdSYong Li                 aResp->res.jsonValue["HostWatchdogTimer"];
222351709ffdSYong Li 
222451709ffdSYong Li             // watchdog service is running/enabled
222551709ffdSYong Li             hostWatchdogTimer["Status"]["State"] = "Enabled";
222651709ffdSYong Li 
222751709ffdSYong Li             for (const auto& property : properties)
222851709ffdSYong Li             {
222951709ffdSYong Li                 BMCWEB_LOG_DEBUG << "prop=" << property.first;
223051709ffdSYong Li                 if (property.first == "Enabled")
223151709ffdSYong Li                 {
223251709ffdSYong Li                     const bool* state = std::get_if<bool>(&property.second);
223351709ffdSYong Li 
223451709ffdSYong Li                     if (!state)
223551709ffdSYong Li                     {
223651709ffdSYong Li                         messages::internalError(aResp->res);
2237601af5edSChicago Duan                         return;
223851709ffdSYong Li                     }
223951709ffdSYong Li 
224051709ffdSYong Li                     hostWatchdogTimer["FunctionEnabled"] = *state;
224151709ffdSYong Li                 }
224251709ffdSYong Li                 else if (property.first == "ExpireAction")
224351709ffdSYong Li                 {
224451709ffdSYong Li                     const std::string* s =
224551709ffdSYong Li                         std::get_if<std::string>(&property.second);
224651709ffdSYong Li                     if (!s)
224751709ffdSYong Li                     {
224851709ffdSYong Li                         messages::internalError(aResp->res);
2249601af5edSChicago Duan                         return;
225051709ffdSYong Li                     }
225151709ffdSYong Li 
225251709ffdSYong Li                     std::string action = dbusToRfWatchdogAction(*s);
225351709ffdSYong Li                     if (action.empty())
225451709ffdSYong Li                     {
225551709ffdSYong Li                         messages::internalError(aResp->res);
2256601af5edSChicago Duan                         return;
225751709ffdSYong Li                     }
225851709ffdSYong Li                     hostWatchdogTimer["TimeoutAction"] = action;
225951709ffdSYong Li                 }
226051709ffdSYong Li             }
226151709ffdSYong Li         },
226251709ffdSYong Li         "xyz.openbmc_project.Watchdog", "/xyz/openbmc_project/watchdog/host0",
226351709ffdSYong Li         "org.freedesktop.DBus.Properties", "GetAll",
226451709ffdSYong Li         "xyz.openbmc_project.State.Watchdog");
226551709ffdSYong Li }
226651709ffdSYong Li 
226751709ffdSYong Li /**
2268c45f0082SYong Li  * @brief Sets Host WatchDog Timer properties.
2269c45f0082SYong Li  *
2270c45f0082SYong Li  * @param[in] aResp      Shared pointer for generating response message.
2271c45f0082SYong Li  * @param[in] wdtEnable  The WDTimer Enable value (true/false) from incoming
2272c45f0082SYong Li  *                       RF request.
2273c45f0082SYong Li  * @param[in] wdtTimeOutAction The WDT Timeout action, from incoming RF request.
2274c45f0082SYong Li  *
2275c45f0082SYong Li  * @return None.
2276c45f0082SYong Li  */
22778d1b46d7Szhanghch05 inline void setWDTProperties(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
2278c45f0082SYong Li                              const std::optional<bool> wdtEnable,
2279c45f0082SYong Li                              const std::optional<std::string>& wdtTimeOutAction)
2280c45f0082SYong Li {
2281c45f0082SYong Li     BMCWEB_LOG_DEBUG << "Set host watchdog";
2282c45f0082SYong Li 
2283c45f0082SYong Li     if (wdtTimeOutAction)
2284c45f0082SYong Li     {
2285c45f0082SYong Li         std::string wdtTimeOutActStr = rfToDbusWDTTimeOutAct(*wdtTimeOutAction);
2286c45f0082SYong Li         // check if TimeOut Action is Valid
2287c45f0082SYong Li         if (wdtTimeOutActStr.empty())
2288c45f0082SYong Li         {
2289c45f0082SYong Li             BMCWEB_LOG_DEBUG << "Unsupported value for TimeoutAction: "
2290c45f0082SYong Li                              << *wdtTimeOutAction;
2291c45f0082SYong Li             messages::propertyValueNotInList(aResp->res, *wdtTimeOutAction,
2292c45f0082SYong Li                                              "TimeoutAction");
2293c45f0082SYong Li             return;
2294c45f0082SYong Li         }
2295c45f0082SYong Li 
2296c45f0082SYong Li         crow::connections::systemBus->async_method_call(
2297c45f0082SYong Li             [aResp](const boost::system::error_code ec) {
2298c45f0082SYong Li                 if (ec)
2299c45f0082SYong Li                 {
2300c45f0082SYong Li                     BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
2301c45f0082SYong Li                     messages::internalError(aResp->res);
2302c45f0082SYong Li                     return;
2303c45f0082SYong Li                 }
2304c45f0082SYong Li             },
2305c45f0082SYong Li             "xyz.openbmc_project.Watchdog",
2306c45f0082SYong Li             "/xyz/openbmc_project/watchdog/host0",
2307c45f0082SYong Li             "org.freedesktop.DBus.Properties", "Set",
2308c45f0082SYong Li             "xyz.openbmc_project.State.Watchdog", "ExpireAction",
2309168e20c1SEd Tanous             dbus::utility::DbusVariantType(wdtTimeOutActStr));
2310c45f0082SYong Li     }
2311c45f0082SYong Li 
2312c45f0082SYong Li     if (wdtEnable)
2313c45f0082SYong Li     {
2314c45f0082SYong Li         crow::connections::systemBus->async_method_call(
2315c45f0082SYong Li             [aResp](const boost::system::error_code ec) {
2316c45f0082SYong Li                 if (ec)
2317c45f0082SYong Li                 {
2318c45f0082SYong Li                     BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
2319c45f0082SYong Li                     messages::internalError(aResp->res);
2320c45f0082SYong Li                     return;
2321c45f0082SYong Li                 }
2322c45f0082SYong Li             },
2323c45f0082SYong Li             "xyz.openbmc_project.Watchdog",
2324c45f0082SYong Li             "/xyz/openbmc_project/watchdog/host0",
2325c45f0082SYong Li             "org.freedesktop.DBus.Properties", "Set",
2326c45f0082SYong Li             "xyz.openbmc_project.State.Watchdog", "Enabled",
2327168e20c1SEd Tanous             dbus::utility::DbusVariantType(*wdtEnable));
2328c45f0082SYong Li     }
2329c45f0082SYong Li }
2330c45f0082SYong Li 
233137bbf98cSChris Cain using ipsPropertiesType =
233237bbf98cSChris Cain     std::vector<std::pair<std::string, dbus::utility::DbusVariantType>>;
233337bbf98cSChris Cain /**
233437bbf98cSChris Cain  * @brief Parse the Idle Power Saver properties into json
233537bbf98cSChris Cain  *
233637bbf98cSChris Cain  * @param[in] aResp     Shared pointer for completing asynchronous calls.
233737bbf98cSChris Cain  * @param[in] properties  IPS property data from DBus.
233837bbf98cSChris Cain  *
233937bbf98cSChris Cain  * @return true if successful
234037bbf98cSChris Cain  */
2341f6674220SEd Tanous inline bool parseIpsProperties(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
234237bbf98cSChris Cain                                ipsPropertiesType& properties)
234337bbf98cSChris Cain {
234437bbf98cSChris Cain     for (const auto& property : properties)
234537bbf98cSChris Cain     {
234637bbf98cSChris Cain         if (property.first == "Enabled")
234737bbf98cSChris Cain         {
234837bbf98cSChris Cain             const bool* state = std::get_if<bool>(&property.second);
234937bbf98cSChris Cain             if (!state)
235037bbf98cSChris Cain             {
235137bbf98cSChris Cain                 return false;
235237bbf98cSChris Cain             }
235337bbf98cSChris Cain             aResp->res.jsonValue["IdlePowerSaver"][property.first] = *state;
235437bbf98cSChris Cain         }
235537bbf98cSChris Cain         else if (property.first == "EnterUtilizationPercent")
235637bbf98cSChris Cain         {
235737bbf98cSChris Cain             const uint8_t* util = std::get_if<uint8_t>(&property.second);
235837bbf98cSChris Cain             if (!util)
235937bbf98cSChris Cain             {
236037bbf98cSChris Cain                 return false;
236137bbf98cSChris Cain             }
236237bbf98cSChris Cain             aResp->res.jsonValue["IdlePowerSaver"][property.first] = *util;
236337bbf98cSChris Cain         }
236437bbf98cSChris Cain         else if (property.first == "EnterDwellTime")
236537bbf98cSChris Cain         {
236637bbf98cSChris Cain             // Convert Dbus time from milliseconds to seconds
236737bbf98cSChris Cain             const uint64_t* timeMilliseconds =
236837bbf98cSChris Cain                 std::get_if<uint64_t>(&property.second);
236937bbf98cSChris Cain             if (!timeMilliseconds)
237037bbf98cSChris Cain             {
237137bbf98cSChris Cain                 return false;
237237bbf98cSChris Cain             }
237337bbf98cSChris Cain             const std::chrono::duration<uint64_t, std::milli> ms(
237437bbf98cSChris Cain                 *timeMilliseconds);
237537bbf98cSChris Cain             aResp->res.jsonValue["IdlePowerSaver"]["EnterDwellTimeSeconds"] =
237637bbf98cSChris Cain                 std::chrono::duration_cast<std::chrono::duration<uint64_t>>(ms)
237737bbf98cSChris Cain                     .count();
237837bbf98cSChris Cain         }
237937bbf98cSChris Cain         else if (property.first == "ExitUtilizationPercent")
238037bbf98cSChris Cain         {
238137bbf98cSChris Cain             const uint8_t* util = std::get_if<uint8_t>(&property.second);
238237bbf98cSChris Cain             if (!util)
238337bbf98cSChris Cain             {
238437bbf98cSChris Cain                 return false;
238537bbf98cSChris Cain             }
238637bbf98cSChris Cain             aResp->res.jsonValue["IdlePowerSaver"][property.first] = *util;
238737bbf98cSChris Cain         }
238837bbf98cSChris Cain         else if (property.first == "ExitDwellTime")
238937bbf98cSChris Cain         {
239037bbf98cSChris Cain             // Convert Dbus time from milliseconds to seconds
239137bbf98cSChris Cain             const uint64_t* timeMilliseconds =
239237bbf98cSChris Cain                 std::get_if<uint64_t>(&property.second);
239337bbf98cSChris Cain             if (!timeMilliseconds)
239437bbf98cSChris Cain             {
239537bbf98cSChris Cain                 return false;
239637bbf98cSChris Cain             }
239737bbf98cSChris Cain             const std::chrono::duration<uint64_t, std::milli> ms(
239837bbf98cSChris Cain                 *timeMilliseconds);
239937bbf98cSChris Cain             aResp->res.jsonValue["IdlePowerSaver"]["ExitDwellTimeSeconds"] =
240037bbf98cSChris Cain                 std::chrono::duration_cast<std::chrono::duration<uint64_t>>(ms)
240137bbf98cSChris Cain                     .count();
240237bbf98cSChris Cain         }
240337bbf98cSChris Cain         else
240437bbf98cSChris Cain         {
240537bbf98cSChris Cain             BMCWEB_LOG_WARNING << "Unexpected IdlePowerSaver property: "
240637bbf98cSChris Cain                                << property.first;
240737bbf98cSChris Cain         }
240837bbf98cSChris Cain     }
240937bbf98cSChris Cain 
241037bbf98cSChris Cain     return true;
241137bbf98cSChris Cain }
241237bbf98cSChris Cain 
241337bbf98cSChris Cain /**
241437bbf98cSChris Cain  * @brief Retrieves host watchdog timer properties over DBUS
241537bbf98cSChris Cain  *
241637bbf98cSChris Cain  * @param[in] aResp     Shared pointer for completing asynchronous calls.
241737bbf98cSChris Cain  *
241837bbf98cSChris Cain  * @return None.
241937bbf98cSChris Cain  */
242037bbf98cSChris Cain inline void getIdlePowerSaver(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
242137bbf98cSChris Cain {
242237bbf98cSChris Cain     BMCWEB_LOG_DEBUG << "Get idle power saver parameters";
242337bbf98cSChris Cain 
242437bbf98cSChris Cain     // Get IdlePowerSaver object path:
242537bbf98cSChris Cain     crow::connections::systemBus->async_method_call(
242637bbf98cSChris Cain         [aResp](
242737bbf98cSChris Cain             const boost::system::error_code ec,
242837bbf98cSChris Cain             const std::vector<std::pair<
242937bbf98cSChris Cain                 std::string,
243037bbf98cSChris Cain                 std::vector<std::pair<std::string, std::vector<std::string>>>>>&
243137bbf98cSChris Cain                 subtree) {
243237bbf98cSChris Cain             if (ec)
243337bbf98cSChris Cain             {
243437bbf98cSChris Cain                 BMCWEB_LOG_DEBUG
243537bbf98cSChris Cain                     << "DBUS response error on Power.IdlePowerSaver GetSubTree "
243637bbf98cSChris Cain                     << ec;
243737bbf98cSChris Cain                 messages::internalError(aResp->res);
243837bbf98cSChris Cain                 return;
243937bbf98cSChris Cain             }
244037bbf98cSChris Cain             if (subtree.empty())
244137bbf98cSChris Cain             {
244237bbf98cSChris Cain                 // This is an optional interface so just return
244337bbf98cSChris Cain                 // if there is no instance found
244437bbf98cSChris Cain                 BMCWEB_LOG_DEBUG << "No instances found";
244537bbf98cSChris Cain                 return;
244637bbf98cSChris Cain             }
244737bbf98cSChris Cain             if (subtree.size() > 1)
244837bbf98cSChris Cain             {
244937bbf98cSChris Cain                 // More then one PowerIdlePowerSaver object is not supported and
245037bbf98cSChris Cain                 // is an error
245137bbf98cSChris Cain                 BMCWEB_LOG_DEBUG << "Found more than 1 system D-Bus "
245237bbf98cSChris Cain                                     "Power.IdlePowerSaver objects: "
245337bbf98cSChris Cain                                  << subtree.size();
245437bbf98cSChris Cain                 messages::internalError(aResp->res);
245537bbf98cSChris Cain                 return;
245637bbf98cSChris Cain             }
245737bbf98cSChris Cain             if ((subtree[0].first.empty()) || (subtree[0].second.size() != 1))
245837bbf98cSChris Cain             {
245937bbf98cSChris Cain                 BMCWEB_LOG_DEBUG << "Power.IdlePowerSaver mapper error!";
246037bbf98cSChris Cain                 messages::internalError(aResp->res);
246137bbf98cSChris Cain                 return;
246237bbf98cSChris Cain             }
246337bbf98cSChris Cain             const std::string& path = subtree[0].first;
246437bbf98cSChris Cain             const std::string& service = subtree[0].second.begin()->first;
246537bbf98cSChris Cain             if (service.empty())
246637bbf98cSChris Cain             {
246737bbf98cSChris Cain                 BMCWEB_LOG_DEBUG
246837bbf98cSChris Cain                     << "Power.IdlePowerSaver service mapper error!";
246937bbf98cSChris Cain                 messages::internalError(aResp->res);
247037bbf98cSChris Cain                 return;
247137bbf98cSChris Cain             }
247237bbf98cSChris Cain 
247337bbf98cSChris Cain             // Valid IdlePowerSaver object found, now read the current values
247437bbf98cSChris Cain             crow::connections::systemBus->async_method_call(
247537bbf98cSChris Cain                 [aResp](const boost::system::error_code ec,
247637bbf98cSChris Cain                         ipsPropertiesType& properties) {
247737bbf98cSChris Cain                     if (ec)
247837bbf98cSChris Cain                     {
247937bbf98cSChris Cain                         BMCWEB_LOG_ERROR
248037bbf98cSChris Cain                             << "DBUS response error on IdlePowerSaver GetAll: "
248137bbf98cSChris Cain                             << ec;
248237bbf98cSChris Cain                         messages::internalError(aResp->res);
248337bbf98cSChris Cain                         return;
248437bbf98cSChris Cain                     }
248537bbf98cSChris Cain 
248637bbf98cSChris Cain                     if (parseIpsProperties(aResp, properties) == false)
248737bbf98cSChris Cain                     {
248837bbf98cSChris Cain                         messages::internalError(aResp->res);
248937bbf98cSChris Cain                         return;
249037bbf98cSChris Cain                     }
249137bbf98cSChris Cain                 },
249237bbf98cSChris Cain                 service, path, "org.freedesktop.DBus.Properties", "GetAll",
249337bbf98cSChris Cain                 "xyz.openbmc_project.Control.Power.IdlePowerSaver");
249437bbf98cSChris Cain         },
249537bbf98cSChris Cain         "xyz.openbmc_project.ObjectMapper",
249637bbf98cSChris Cain         "/xyz/openbmc_project/object_mapper",
249737bbf98cSChris Cain         "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", int32_t(0),
249837bbf98cSChris Cain         std::array<const char*, 1>{
249937bbf98cSChris Cain             "xyz.openbmc_project.Control.Power.IdlePowerSaver"});
250037bbf98cSChris Cain 
250137bbf98cSChris Cain     BMCWEB_LOG_DEBUG << "EXIT: Get idle power saver parameters";
250237bbf98cSChris Cain }
250337bbf98cSChris Cain 
250437bbf98cSChris Cain /**
250537bbf98cSChris Cain  * @brief Sets Idle Power Saver properties.
250637bbf98cSChris Cain  *
250737bbf98cSChris Cain  * @param[in] aResp      Shared pointer for generating response message.
250837bbf98cSChris Cain  * @param[in] ipsEnable  The IPS Enable value (true/false) from incoming
250937bbf98cSChris Cain  *                       RF request.
251037bbf98cSChris Cain  * @param[in] ipsEnterUtil The utilization limit to enter idle state.
251137bbf98cSChris Cain  * @param[in] ipsEnterTime The time the utilization must be below ipsEnterUtil
251237bbf98cSChris Cain  * before entering idle state.
251337bbf98cSChris Cain  * @param[in] ipsExitUtil The utilization limit when exiting idle state.
251437bbf98cSChris Cain  * @param[in] ipsExitTime The time the utilization must be above ipsExutUtil
251537bbf98cSChris Cain  * before exiting idle state
251637bbf98cSChris Cain  *
251737bbf98cSChris Cain  * @return None.
251837bbf98cSChris Cain  */
251937bbf98cSChris Cain inline void setIdlePowerSaver(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
252037bbf98cSChris Cain                               const std::optional<bool> ipsEnable,
252137bbf98cSChris Cain                               const std::optional<uint8_t> ipsEnterUtil,
252237bbf98cSChris Cain                               const std::optional<uint64_t> ipsEnterTime,
252337bbf98cSChris Cain                               const std::optional<uint8_t> ipsExitUtil,
252437bbf98cSChris Cain                               const std::optional<uint64_t> ipsExitTime)
252537bbf98cSChris Cain {
252637bbf98cSChris Cain     BMCWEB_LOG_DEBUG << "Set idle power saver properties";
252737bbf98cSChris Cain 
252837bbf98cSChris Cain     // Get IdlePowerSaver object path:
252937bbf98cSChris Cain     crow::connections::systemBus->async_method_call(
253037bbf98cSChris Cain         [aResp, ipsEnable, ipsEnterUtil, ipsEnterTime, ipsExitUtil,
253137bbf98cSChris Cain          ipsExitTime](
253237bbf98cSChris Cain             const boost::system::error_code ec,
253337bbf98cSChris Cain             const std::vector<std::pair<
253437bbf98cSChris Cain                 std::string,
253537bbf98cSChris Cain                 std::vector<std::pair<std::string, std::vector<std::string>>>>>&
253637bbf98cSChris Cain                 subtree) {
253737bbf98cSChris Cain             if (ec)
253837bbf98cSChris Cain             {
253937bbf98cSChris Cain                 BMCWEB_LOG_DEBUG
254037bbf98cSChris Cain                     << "DBUS response error on Power.IdlePowerSaver GetSubTree "
254137bbf98cSChris Cain                     << ec;
254237bbf98cSChris Cain                 messages::internalError(aResp->res);
254337bbf98cSChris Cain                 return;
254437bbf98cSChris Cain             }
254537bbf98cSChris Cain             if (subtree.empty())
254637bbf98cSChris Cain             {
254737bbf98cSChris Cain                 // This is an optional D-Bus object, but user attempted to patch
254837bbf98cSChris Cain                 messages::resourceNotFound(aResp->res, "ComputerSystem",
254937bbf98cSChris Cain                                            "IdlePowerSaver");
255037bbf98cSChris Cain                 return;
255137bbf98cSChris Cain             }
255237bbf98cSChris Cain             if (subtree.size() > 1)
255337bbf98cSChris Cain             {
255437bbf98cSChris Cain                 // More then one PowerIdlePowerSaver object is not supported and
255537bbf98cSChris Cain                 // is an error
25560fda0f12SGeorge Liu                 BMCWEB_LOG_DEBUG
25570fda0f12SGeorge Liu                     << "Found more than 1 system D-Bus Power.IdlePowerSaver objects: "
255837bbf98cSChris Cain                     << subtree.size();
255937bbf98cSChris Cain                 messages::internalError(aResp->res);
256037bbf98cSChris Cain                 return;
256137bbf98cSChris Cain             }
256237bbf98cSChris Cain             if ((subtree[0].first.empty()) || (subtree[0].second.size() != 1))
256337bbf98cSChris Cain             {
256437bbf98cSChris Cain                 BMCWEB_LOG_DEBUG << "Power.IdlePowerSaver mapper error!";
256537bbf98cSChris Cain                 messages::internalError(aResp->res);
256637bbf98cSChris Cain                 return;
256737bbf98cSChris Cain             }
256837bbf98cSChris Cain             const std::string& path = subtree[0].first;
256937bbf98cSChris Cain             const std::string& service = subtree[0].second.begin()->first;
257037bbf98cSChris Cain             if (service.empty())
257137bbf98cSChris Cain             {
257237bbf98cSChris Cain                 BMCWEB_LOG_DEBUG
257337bbf98cSChris Cain                     << "Power.IdlePowerSaver service mapper error!";
257437bbf98cSChris Cain                 messages::internalError(aResp->res);
257537bbf98cSChris Cain                 return;
257637bbf98cSChris Cain             }
257737bbf98cSChris Cain 
257837bbf98cSChris Cain             // Valid Power IdlePowerSaver object found, now set any values that
257937bbf98cSChris Cain             // need to be updated
258037bbf98cSChris Cain 
258137bbf98cSChris Cain             if (ipsEnable)
258237bbf98cSChris Cain             {
258337bbf98cSChris Cain                 crow::connections::systemBus->async_method_call(
258437bbf98cSChris Cain                     [aResp](const boost::system::error_code ec) {
258537bbf98cSChris Cain                         if (ec)
258637bbf98cSChris Cain                         {
258737bbf98cSChris Cain                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
258837bbf98cSChris Cain                             messages::internalError(aResp->res);
258937bbf98cSChris Cain                             return;
259037bbf98cSChris Cain                         }
259137bbf98cSChris Cain                     },
259237bbf98cSChris Cain                     service, path, "org.freedesktop.DBus.Properties", "Set",
259337bbf98cSChris Cain                     "xyz.openbmc_project.Control.Power.IdlePowerSaver",
2594168e20c1SEd Tanous                     "Enabled", dbus::utility::DbusVariantType(*ipsEnable));
259537bbf98cSChris Cain             }
259637bbf98cSChris Cain             if (ipsEnterUtil)
259737bbf98cSChris Cain             {
259837bbf98cSChris Cain                 crow::connections::systemBus->async_method_call(
259937bbf98cSChris Cain                     [aResp](const boost::system::error_code ec) {
260037bbf98cSChris Cain                         if (ec)
260137bbf98cSChris Cain                         {
260237bbf98cSChris Cain                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
260337bbf98cSChris Cain                             messages::internalError(aResp->res);
260437bbf98cSChris Cain                             return;
260537bbf98cSChris Cain                         }
260637bbf98cSChris Cain                     },
260737bbf98cSChris Cain                     service, path, "org.freedesktop.DBus.Properties", "Set",
260837bbf98cSChris Cain                     "xyz.openbmc_project.Control.Power.IdlePowerSaver",
260937bbf98cSChris Cain                     "EnterUtilizationPercent",
2610168e20c1SEd Tanous                     dbus::utility::DbusVariantType(*ipsEnterUtil));
261137bbf98cSChris Cain             }
261237bbf98cSChris Cain             if (ipsEnterTime)
261337bbf98cSChris Cain             {
261437bbf98cSChris Cain                 // Convert from seconds into milliseconds for DBus
261537bbf98cSChris Cain                 const uint64_t timeMilliseconds = *ipsEnterTime * 1000;
261637bbf98cSChris Cain                 crow::connections::systemBus->async_method_call(
261737bbf98cSChris Cain                     [aResp](const boost::system::error_code ec) {
261837bbf98cSChris Cain                         if (ec)
261937bbf98cSChris Cain                         {
262037bbf98cSChris Cain                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
262137bbf98cSChris Cain                             messages::internalError(aResp->res);
262237bbf98cSChris Cain                             return;
262337bbf98cSChris Cain                         }
262437bbf98cSChris Cain                     },
262537bbf98cSChris Cain                     service, path, "org.freedesktop.DBus.Properties", "Set",
262637bbf98cSChris Cain                     "xyz.openbmc_project.Control.Power.IdlePowerSaver",
2627168e20c1SEd Tanous                     "EnterDwellTime",
2628168e20c1SEd Tanous                     dbus::utility::DbusVariantType(timeMilliseconds));
262937bbf98cSChris Cain             }
263037bbf98cSChris Cain             if (ipsExitUtil)
263137bbf98cSChris Cain             {
263237bbf98cSChris Cain                 crow::connections::systemBus->async_method_call(
263337bbf98cSChris Cain                     [aResp](const boost::system::error_code ec) {
263437bbf98cSChris Cain                         if (ec)
263537bbf98cSChris Cain                         {
263637bbf98cSChris Cain                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
263737bbf98cSChris Cain                             messages::internalError(aResp->res);
263837bbf98cSChris Cain                             return;
263937bbf98cSChris Cain                         }
264037bbf98cSChris Cain                     },
264137bbf98cSChris Cain                     service, path, "org.freedesktop.DBus.Properties", "Set",
264237bbf98cSChris Cain                     "xyz.openbmc_project.Control.Power.IdlePowerSaver",
264337bbf98cSChris Cain                     "ExitUtilizationPercent",
2644168e20c1SEd Tanous                     dbus::utility::DbusVariantType(*ipsExitUtil));
264537bbf98cSChris Cain             }
264637bbf98cSChris Cain             if (ipsExitTime)
264737bbf98cSChris Cain             {
264837bbf98cSChris Cain                 // Convert from seconds into milliseconds for DBus
264937bbf98cSChris Cain                 const uint64_t timeMilliseconds = *ipsExitTime * 1000;
265037bbf98cSChris Cain                 crow::connections::systemBus->async_method_call(
265137bbf98cSChris Cain                     [aResp](const boost::system::error_code ec) {
265237bbf98cSChris Cain                         if (ec)
265337bbf98cSChris Cain                         {
265437bbf98cSChris Cain                             BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
265537bbf98cSChris Cain                             messages::internalError(aResp->res);
265637bbf98cSChris Cain                             return;
265737bbf98cSChris Cain                         }
265837bbf98cSChris Cain                     },
265937bbf98cSChris Cain                     service, path, "org.freedesktop.DBus.Properties", "Set",
266037bbf98cSChris Cain                     "xyz.openbmc_project.Control.Power.IdlePowerSaver",
2661168e20c1SEd Tanous                     "ExitDwellTime",
2662168e20c1SEd Tanous                     dbus::utility::DbusVariantType(timeMilliseconds));
266337bbf98cSChris Cain             }
266437bbf98cSChris Cain         },
266537bbf98cSChris Cain         "xyz.openbmc_project.ObjectMapper",
266637bbf98cSChris Cain         "/xyz/openbmc_project/object_mapper",
266737bbf98cSChris Cain         "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", int32_t(0),
266837bbf98cSChris Cain         std::array<const char*, 1>{
266937bbf98cSChris Cain             "xyz.openbmc_project.Control.Power.IdlePowerSaver"});
267037bbf98cSChris Cain 
267137bbf98cSChris Cain     BMCWEB_LOG_DEBUG << "EXIT: Set idle power saver parameters";
267237bbf98cSChris Cain }
267337bbf98cSChris Cain 
2674c45f0082SYong Li /**
2675c5b2abe0SLewanczyk, Dawid  * SystemsCollection derived class for delivering ComputerSystems Collection
2676c5b2abe0SLewanczyk, Dawid  * Schema
2677c5b2abe0SLewanczyk, Dawid  */
26787e860f15SJohn Edward Broadbent inline void requestRoutesSystemsCollection(App& app)
26791abe55efSEd Tanous {
26807e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/")
2681ed398213SEd Tanous         .privileges(redfish::privileges::getComputerSystemCollection)
26827e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
26834f48d5f6SEd Tanous             [](const crow::Request& /*req*/,
26847e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
26858d1b46d7Szhanghch05                 asyncResp->res.jsonValue["@odata.type"] =
26860f74e643SEd Tanous                     "#ComputerSystemCollection.ComputerSystemCollection";
26878d1b46d7Szhanghch05                 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Systems";
26888d1b46d7Szhanghch05                 asyncResp->res.jsonValue["Name"] = "Computer System Collection";
2689462023adSSunitha Harish 
26901e1e598dSJonathan Doman                 sdbusplus::asio::getProperty<std::string>(
26911e1e598dSJonathan Doman                     *crow::connections::systemBus,
26921e1e598dSJonathan Doman                     "xyz.openbmc_project.Settings",
26931e1e598dSJonathan Doman                     "/xyz/openbmc_project/network/hypervisor",
26941e1e598dSJonathan Doman                     "xyz.openbmc_project.Network.SystemConfiguration",
26951e1e598dSJonathan Doman                     "HostName",
26961e1e598dSJonathan Doman                     [asyncResp](const boost::system::error_code ec,
26971e1e598dSJonathan Doman                                 const std::string& /*hostName*/) {
26982c70f800SEd Tanous                         nlohmann::json& ifaceArray =
2699462023adSSunitha Harish                             asyncResp->res.jsonValue["Members"];
27002c70f800SEd Tanous                         ifaceArray = nlohmann::json::array();
27017e860f15SJohn Edward Broadbent                         auto& count =
27027e860f15SJohn Edward Broadbent                             asyncResp->res.jsonValue["Members@odata.count"];
27032c70f800SEd Tanous                         ifaceArray.push_back(
2704cb13a392SEd Tanous                             {{"@odata.id", "/redfish/v1/Systems/system"}});
270594bda602STim Lee                         count = ifaceArray.size();
2706cb13a392SEd Tanous                         if (!ec)
2707462023adSSunitha Harish                         {
2708462023adSSunitha Harish                             BMCWEB_LOG_DEBUG << "Hypervisor is available";
27092c70f800SEd Tanous                             ifaceArray.push_back(
27107e860f15SJohn Edward Broadbent                                 {{"@odata.id",
27117e860f15SJohn Edward Broadbent                                   "/redfish/v1/Systems/hypervisor"}});
27122c70f800SEd Tanous                             count = ifaceArray.size();
2713cb13a392SEd Tanous                         }
27141e1e598dSJonathan Doman                     });
27157e860f15SJohn Edward Broadbent             });
2716c5b2abe0SLewanczyk, Dawid }
27177e860f15SJohn Edward Broadbent 
27187e860f15SJohn Edward Broadbent /**
27197e860f15SJohn Edward Broadbent  * Function transceives data with dbus directly.
27207e860f15SJohn Edward Broadbent  */
27214f48d5f6SEd Tanous inline void doNMI(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
27227e860f15SJohn Edward Broadbent {
27237e860f15SJohn Edward Broadbent     constexpr char const* serviceName = "xyz.openbmc_project.Control.Host.NMI";
27247e860f15SJohn Edward Broadbent     constexpr char const* objectPath = "/xyz/openbmc_project/control/host0/nmi";
27257e860f15SJohn Edward Broadbent     constexpr char const* interfaceName =
27267e860f15SJohn Edward Broadbent         "xyz.openbmc_project.Control.Host.NMI";
27277e860f15SJohn Edward Broadbent     constexpr char const* method = "NMI";
27287e860f15SJohn Edward Broadbent 
27297e860f15SJohn Edward Broadbent     crow::connections::systemBus->async_method_call(
27307e860f15SJohn Edward Broadbent         [asyncResp](const boost::system::error_code ec) {
27317e860f15SJohn Edward Broadbent             if (ec)
27327e860f15SJohn Edward Broadbent             {
27337e860f15SJohn Edward Broadbent                 BMCWEB_LOG_ERROR << " Bad D-Bus request error: " << ec;
27347e860f15SJohn Edward Broadbent                 messages::internalError(asyncResp->res);
27357e860f15SJohn Edward Broadbent                 return;
27367e860f15SJohn Edward Broadbent             }
27377e860f15SJohn Edward Broadbent             messages::success(asyncResp->res);
27387e860f15SJohn Edward Broadbent         },
27397e860f15SJohn Edward Broadbent         serviceName, objectPath, interfaceName, method);
27407e860f15SJohn Edward Broadbent }
2741c5b2abe0SLewanczyk, Dawid 
2742c5b2abe0SLewanczyk, Dawid /**
2743cc340dd9SEd Tanous  * SystemActionsReset class supports handle POST method for Reset action.
2744cc340dd9SEd Tanous  * The class retrieves and sends data directly to D-Bus.
2745cc340dd9SEd Tanous  */
27467e860f15SJohn Edward Broadbent inline void requestRoutesSystemActionsReset(App& app)
2747cc340dd9SEd Tanous {
2748cc340dd9SEd Tanous     /**
2749cc340dd9SEd Tanous      * Function handles POST method request.
2750cc340dd9SEd Tanous      * Analyzes POST body message before sends Reset request data to D-Bus.
2751cc340dd9SEd Tanous      */
27527e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app,
27537e860f15SJohn Edward Broadbent                  "/redfish/v1/Systems/system/Actions/ComputerSystem.Reset/")
2754ed398213SEd Tanous         .privileges(redfish::privileges::postComputerSystem)
27557e860f15SJohn Edward Broadbent         .methods(
27567e860f15SJohn Edward Broadbent             boost::beast::http::verb::
27577e860f15SJohn Edward Broadbent                 post)([](const crow::Request& req,
27587e860f15SJohn Edward Broadbent                          const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
27599712f8acSEd Tanous             std::string resetType;
27607e860f15SJohn Edward Broadbent             if (!json_util::readJson(req, asyncResp->res, "ResetType",
27617e860f15SJohn Edward Broadbent                                      resetType))
2762cc340dd9SEd Tanous             {
2763cc340dd9SEd Tanous                 return;
2764cc340dd9SEd Tanous             }
2765cc340dd9SEd Tanous 
2766d22c8396SJason M. Bills             // Get the command and host vs. chassis
2767cc340dd9SEd Tanous             std::string command;
2768*543f4400SEd Tanous             bool hostCommand = true;
2769d4d25793SEd Tanous             if ((resetType == "On") || (resetType == "ForceOn"))
2770cc340dd9SEd Tanous             {
2771cc340dd9SEd Tanous                 command = "xyz.openbmc_project.State.Host.Transition.On";
2772d22c8396SJason M. Bills                 hostCommand = true;
2773d22c8396SJason M. Bills             }
2774d22c8396SJason M. Bills             else if (resetType == "ForceOff")
2775d22c8396SJason M. Bills             {
2776d22c8396SJason M. Bills                 command = "xyz.openbmc_project.State.Chassis.Transition.Off";
2777d22c8396SJason M. Bills                 hostCommand = false;
2778d22c8396SJason M. Bills             }
2779d22c8396SJason M. Bills             else if (resetType == "ForceRestart")
2780d22c8396SJason M. Bills             {
278186a0851aSJason M. Bills                 command =
278286a0851aSJason M. Bills                     "xyz.openbmc_project.State.Host.Transition.ForceWarmReboot";
278386a0851aSJason M. Bills                 hostCommand = true;
2784cc340dd9SEd Tanous             }
27859712f8acSEd Tanous             else if (resetType == "GracefulShutdown")
2786cc340dd9SEd Tanous             {
2787cc340dd9SEd Tanous                 command = "xyz.openbmc_project.State.Host.Transition.Off";
2788d22c8396SJason M. Bills                 hostCommand = true;
2789cc340dd9SEd Tanous             }
27909712f8acSEd Tanous             else if (resetType == "GracefulRestart")
2791cc340dd9SEd Tanous             {
27920fda0f12SGeorge Liu                 command =
27930fda0f12SGeorge Liu                     "xyz.openbmc_project.State.Host.Transition.GracefulWarmReboot";
2794d22c8396SJason M. Bills                 hostCommand = true;
2795d22c8396SJason M. Bills             }
2796d22c8396SJason M. Bills             else if (resetType == "PowerCycle")
2797d22c8396SJason M. Bills             {
279886a0851aSJason M. Bills                 command = "xyz.openbmc_project.State.Host.Transition.Reboot";
279986a0851aSJason M. Bills                 hostCommand = true;
2800cc340dd9SEd Tanous             }
2801bfd5b826SLakshminarayana R. Kammath             else if (resetType == "Nmi")
2802bfd5b826SLakshminarayana R. Kammath             {
2803bfd5b826SLakshminarayana R. Kammath                 doNMI(asyncResp);
2804bfd5b826SLakshminarayana R. Kammath                 return;
2805bfd5b826SLakshminarayana R. Kammath             }
2806cc340dd9SEd Tanous             else
2807cc340dd9SEd Tanous             {
28088d1b46d7Szhanghch05                 messages::actionParameterUnknown(asyncResp->res, "Reset",
28098d1b46d7Szhanghch05                                                  resetType);
2810cc340dd9SEd Tanous                 return;
2811cc340dd9SEd Tanous             }
2812cc340dd9SEd Tanous 
2813d22c8396SJason M. Bills             if (hostCommand)
2814d22c8396SJason M. Bills             {
2815cc340dd9SEd Tanous                 crow::connections::systemBus->async_method_call(
2816d22c8396SJason M. Bills                     [asyncResp, resetType](const boost::system::error_code ec) {
2817cc340dd9SEd Tanous                         if (ec)
2818cc340dd9SEd Tanous                         {
2819cc340dd9SEd Tanous                             BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
28207e860f15SJohn Edward Broadbent                             if (ec.value() ==
28217e860f15SJohn Edward Broadbent                                 boost::asio::error::invalid_argument)
2822d22c8396SJason M. Bills                             {
2823d22c8396SJason M. Bills                                 messages::actionParameterNotSupported(
2824d22c8396SJason M. Bills                                     asyncResp->res, resetType, "Reset");
2825d22c8396SJason M. Bills                             }
2826d22c8396SJason M. Bills                             else
2827d22c8396SJason M. Bills                             {
2828f12894f8SJason M. Bills                                 messages::internalError(asyncResp->res);
2829d22c8396SJason M. Bills                             }
2830cc340dd9SEd Tanous                             return;
2831cc340dd9SEd Tanous                         }
2832f12894f8SJason M. Bills                         messages::success(asyncResp->res);
2833cc340dd9SEd Tanous                     },
2834cc340dd9SEd Tanous                     "xyz.openbmc_project.State.Host",
2835cc340dd9SEd Tanous                     "/xyz/openbmc_project/state/host0",
2836cc340dd9SEd Tanous                     "org.freedesktop.DBus.Properties", "Set",
28379712f8acSEd Tanous                     "xyz.openbmc_project.State.Host", "RequestedHostTransition",
2838168e20c1SEd Tanous                     dbus::utility::DbusVariantType{command});
2839cc340dd9SEd Tanous             }
2840d22c8396SJason M. Bills             else
2841d22c8396SJason M. Bills             {
2842d22c8396SJason M. Bills                 crow::connections::systemBus->async_method_call(
2843d22c8396SJason M. Bills                     [asyncResp, resetType](const boost::system::error_code ec) {
2844d22c8396SJason M. Bills                         if (ec)
2845d22c8396SJason M. Bills                         {
2846d22c8396SJason M. Bills                             BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
28477e860f15SJohn Edward Broadbent                             if (ec.value() ==
28487e860f15SJohn Edward Broadbent                                 boost::asio::error::invalid_argument)
2849d22c8396SJason M. Bills                             {
2850d22c8396SJason M. Bills                                 messages::actionParameterNotSupported(
2851d22c8396SJason M. Bills                                     asyncResp->res, resetType, "Reset");
2852d22c8396SJason M. Bills                             }
2853d22c8396SJason M. Bills                             else
2854d22c8396SJason M. Bills                             {
2855d22c8396SJason M. Bills                                 messages::internalError(asyncResp->res);
2856d22c8396SJason M. Bills                             }
2857d22c8396SJason M. Bills                             return;
2858d22c8396SJason M. Bills                         }
2859d22c8396SJason M. Bills                         messages::success(asyncResp->res);
2860d22c8396SJason M. Bills                     },
2861d22c8396SJason M. Bills                     "xyz.openbmc_project.State.Chassis",
2862d22c8396SJason M. Bills                     "/xyz/openbmc_project/state/chassis0",
2863d22c8396SJason M. Bills                     "org.freedesktop.DBus.Properties", "Set",
28647e860f15SJohn Edward Broadbent                     "xyz.openbmc_project.State.Chassis",
28657e860f15SJohn Edward Broadbent                     "RequestedPowerTransition",
2866168e20c1SEd Tanous                     dbus::utility::DbusVariantType{command});
2867d22c8396SJason M. Bills             }
28687e860f15SJohn Edward Broadbent         });
2869d22c8396SJason M. Bills }
2870cc340dd9SEd Tanous 
2871cc340dd9SEd Tanous /**
28726617338dSEd Tanous  * Systems derived class for delivering Computer Systems Schema.
2873c5b2abe0SLewanczyk, Dawid  */
28747e860f15SJohn Edward Broadbent inline void requestRoutesSystems(App& app)
28751abe55efSEd Tanous {
2876c5b2abe0SLewanczyk, Dawid 
2877c5b2abe0SLewanczyk, Dawid     /**
2878c5b2abe0SLewanczyk, Dawid      * Functions triggers appropriate requests on DBus
2879c5b2abe0SLewanczyk, Dawid      */
28807e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/")
2881ed398213SEd Tanous         .privileges(redfish::privileges::getComputerSystem)
28827e860f15SJohn Edward Broadbent         .methods(
28837e860f15SJohn Edward Broadbent             boost::beast::http::verb::
28847e860f15SJohn Edward Broadbent                 get)([](const crow::Request&,
28857e860f15SJohn Edward Broadbent                         const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
28868d1b46d7Szhanghch05             asyncResp->res.jsonValue["@odata.type"] =
288737bbf98cSChris Cain                 "#ComputerSystem.v1_16_0.ComputerSystem";
28888d1b46d7Szhanghch05             asyncResp->res.jsonValue["Name"] = "system";
28898d1b46d7Szhanghch05             asyncResp->res.jsonValue["Id"] = "system";
28908d1b46d7Szhanghch05             asyncResp->res.jsonValue["SystemType"] = "Physical";
28918d1b46d7Szhanghch05             asyncResp->res.jsonValue["Description"] = "Computer System";
28928d1b46d7Szhanghch05             asyncResp->res.jsonValue["ProcessorSummary"]["Count"] = 0;
28938d1b46d7Szhanghch05             asyncResp->res.jsonValue["ProcessorSummary"]["Status"]["State"] =
28948d1b46d7Szhanghch05                 "Disabled";
28958d1b46d7Szhanghch05             asyncResp->res.jsonValue["MemorySummary"]["TotalSystemMemoryGiB"] =
28968d1b46d7Szhanghch05                 uint64_t(0);
28978d1b46d7Szhanghch05             asyncResp->res.jsonValue["MemorySummary"]["Status"]["State"] =
28988d1b46d7Szhanghch05                 "Disabled";
28997e860f15SJohn Edward Broadbent             asyncResp->res.jsonValue["@odata.id"] =
29007e860f15SJohn Edward Broadbent                 "/redfish/v1/Systems/system";
290104a258f4SEd Tanous 
29028d1b46d7Szhanghch05             asyncResp->res.jsonValue["Processors"] = {
2903029573d4SEd Tanous                 {"@odata.id", "/redfish/v1/Systems/system/Processors"}};
29048d1b46d7Szhanghch05             asyncResp->res.jsonValue["Memory"] = {
2905029573d4SEd Tanous                 {"@odata.id", "/redfish/v1/Systems/system/Memory"}};
29068d1b46d7Szhanghch05             asyncResp->res.jsonValue["Storage"] = {
2907a25aeccfSNikhil Potade                 {"@odata.id", "/redfish/v1/Systems/system/Storage"}};
2908029573d4SEd Tanous 
29098d1b46d7Szhanghch05             asyncResp->res.jsonValue["Actions"]["#ComputerSystem.Reset"] = {
2910cc340dd9SEd Tanous                 {"target",
2911029573d4SEd Tanous                  "/redfish/v1/Systems/system/Actions/ComputerSystem.Reset"},
29121cb1a9e6SAppaRao Puli                 {"@Redfish.ActionInfo",
29131cb1a9e6SAppaRao Puli                  "/redfish/v1/Systems/system/ResetActionInfo"}};
2914c5b2abe0SLewanczyk, Dawid 
29158d1b46d7Szhanghch05             asyncResp->res.jsonValue["LogServices"] = {
2916029573d4SEd Tanous                 {"@odata.id", "/redfish/v1/Systems/system/LogServices"}};
2917c4bf6374SJason M. Bills 
29188d1b46d7Szhanghch05             asyncResp->res.jsonValue["Bios"] = {
2919d82a3acdSCarol Wang                 {"@odata.id", "/redfish/v1/Systems/system/Bios"}};
2920d82a3acdSCarol Wang 
29218d1b46d7Szhanghch05             asyncResp->res.jsonValue["Links"]["ManagedBy"] = {
2922c5d03ff4SJennifer Lee                 {{"@odata.id", "/redfish/v1/Managers/bmc"}}};
2923c5d03ff4SJennifer Lee 
29248d1b46d7Szhanghch05             asyncResp->res.jsonValue["Status"] = {
2925c5d03ff4SJennifer Lee                 {"Health", "OK"},
2926c5d03ff4SJennifer Lee                 {"State", "Enabled"},
2927c5d03ff4SJennifer Lee             };
29280e8ac5e7SGunnar Mills 
29290e8ac5e7SGunnar Mills             // Fill in SerialConsole info
29300e8ac5e7SGunnar Mills             asyncResp->res.jsonValue["SerialConsole"]["MaxConcurrentSessions"] =
29310e8ac5e7SGunnar Mills                 15;
29320e8ac5e7SGunnar Mills             asyncResp->res.jsonValue["SerialConsole"]["IPMI"] = {
29330e8ac5e7SGunnar Mills                 {"ServiceEnabled", true},
29340e8ac5e7SGunnar Mills             };
29350e8ac5e7SGunnar Mills             // TODO (Gunnar): Should look for obmc-console-ssh@2200.service
29360e8ac5e7SGunnar Mills             asyncResp->res.jsonValue["SerialConsole"]["SSH"] = {
29370e8ac5e7SGunnar Mills                 {"ServiceEnabled", true},
29380e8ac5e7SGunnar Mills                 {"Port", 2200},
29390e8ac5e7SGunnar Mills                 // https://github.com/openbmc/docs/blob/master/console.md
29400e8ac5e7SGunnar Mills                 {"HotKeySequenceDisplay", "Press ~. to exit console"},
29410e8ac5e7SGunnar Mills             };
29420e8ac5e7SGunnar Mills 
29430e8ac5e7SGunnar Mills #ifdef BMCWEB_ENABLE_KVM
29440e8ac5e7SGunnar Mills             // Fill in GraphicalConsole info
29450e8ac5e7SGunnar Mills             asyncResp->res.jsonValue["GraphicalConsole"] = {
29460e8ac5e7SGunnar Mills                 {"ServiceEnabled", true},
29470e8ac5e7SGunnar Mills                 {"MaxConcurrentSessions", 4},
29480e8ac5e7SGunnar Mills                 {"ConnectTypesSupported", {"KVMIP"}},
29490e8ac5e7SGunnar Mills             };
29500e8ac5e7SGunnar Mills #endif // BMCWEB_ENABLE_KVM
2951e284a7c1SJames Feist             constexpr const std::array<const char*, 4> inventoryForSystems = {
2952b49ac873SJames Feist                 "xyz.openbmc_project.Inventory.Item.Dimm",
29532ad9c2f6SJames Feist                 "xyz.openbmc_project.Inventory.Item.Cpu",
2954e284a7c1SJames Feist                 "xyz.openbmc_project.Inventory.Item.Drive",
2955e284a7c1SJames Feist                 "xyz.openbmc_project.Inventory.Item.StorageController"};
2956b49ac873SJames Feist 
2957b49ac873SJames Feist             auto health = std::make_shared<HealthPopulate>(asyncResp);
2958b49ac873SJames Feist             crow::connections::systemBus->async_method_call(
2959b49ac873SJames Feist                 [health](const boost::system::error_code ec,
2960914e2d5dSEd Tanous                          const std::vector<std::string>& resp) {
2961b49ac873SJames Feist                     if (ec)
2962b49ac873SJames Feist                     {
2963b49ac873SJames Feist                         // no inventory
2964b49ac873SJames Feist                         return;
2965b49ac873SJames Feist                     }
2966b49ac873SJames Feist 
2967914e2d5dSEd Tanous                     health->inventory = resp;
2968b49ac873SJames Feist                 },
2969b49ac873SJames Feist                 "xyz.openbmc_project.ObjectMapper",
2970b49ac873SJames Feist                 "/xyz/openbmc_project/object_mapper",
2971b49ac873SJames Feist                 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/",
2972b49ac873SJames Feist                 int32_t(0), inventoryForSystems);
2973b49ac873SJames Feist 
2974b49ac873SJames Feist             health->populate();
2975b49ac873SJames Feist 
29768d1b46d7Szhanghch05             getMainChassisId(
29778d1b46d7Szhanghch05                 asyncResp, [](const std::string& chassisId,
29788d1b46d7Szhanghch05                               const std::shared_ptr<bmcweb::AsyncResp>& aRsp) {
2979c5d03ff4SJennifer Lee                     aRsp->res.jsonValue["Links"]["Chassis"] = {
2980c5d03ff4SJennifer Lee                         {{"@odata.id", "/redfish/v1/Chassis/" + chassisId}}};
2981c5d03ff4SJennifer Lee                 });
2982a3002228SAppaRao Puli 
29839f8bfa7cSGunnar Mills             getLocationIndicatorActive(asyncResp);
29849f8bfa7cSGunnar Mills             // TODO (Gunnar): Remove IndicatorLED after enough time has passed
2985a3002228SAppaRao Puli             getIndicatorLedState(asyncResp);
29865bc2dc8eSJames Feist             getComputerSystem(asyncResp, health);
29876c34de48SEd Tanous             getHostState(asyncResp);
2988491d8ee7SSantosh Puranik             getBootProperties(asyncResp);
2989978b8803SAndrew Geissler             getBootProgress(asyncResp);
2990adbe192aSJason M. Bills             getPCIeDeviceList(asyncResp, "PCIeDevices");
299151709ffdSYong Li             getHostWatchdogTimer(asyncResp);
2992c6a620f2SGeorge Liu             getPowerRestorePolicy(asyncResp);
29936bd5a8d2SGunnar Mills             getAutomaticRetry(asyncResp);
2994c0557e1aSGunnar Mills             getLastResetTime(asyncResp);
2995a6349918SAppaRao Puli #ifdef BMCWEB_ENABLE_REDFISH_PROVISIONING_FEATURE
2996a6349918SAppaRao Puli             getProvisioningStatus(asyncResp);
2997a6349918SAppaRao Puli #endif
29981981771bSAli Ahmed             getTrustedModuleRequiredToBoot(asyncResp);
29993a2d0424SChris Cain             getPowerMode(asyncResp);
300037bbf98cSChris Cain             getIdlePowerSaver(asyncResp);
30017e860f15SJohn Edward Broadbent         });
30027e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/")
3003ed398213SEd Tanous         .privileges(redfish::privileges::patchComputerSystem)
30047e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::patch)(
30057e860f15SJohn Edward Broadbent             [](const crow::Request& req,
30067e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
30079f8bfa7cSGunnar Mills                 std::optional<bool> locationIndicatorActive;
3008cde19e5fSSantosh Puranik                 std::optional<std::string> indicatorLed;
3009491d8ee7SSantosh Puranik                 std::optional<nlohmann::json> bootProps;
3010c45f0082SYong Li                 std::optional<nlohmann::json> wdtTimerProps;
301198e386ecSGunnar Mills                 std::optional<std::string> assetTag;
3012c6a620f2SGeorge Liu                 std::optional<std::string> powerRestorePolicy;
30133a2d0424SChris Cain                 std::optional<std::string> powerMode;
301437bbf98cSChris Cain                 std::optional<nlohmann::json> ipsProps;
30159f8bfa7cSGunnar Mills                 if (!json_util::readJson(
30168d1b46d7Szhanghch05                         req, asyncResp->res, "IndicatorLED", indicatorLed,
30177e860f15SJohn Edward Broadbent                         "LocationIndicatorActive", locationIndicatorActive,
30187e860f15SJohn Edward Broadbent                         "Boot", bootProps, "WatchdogTimer", wdtTimerProps,
30197e860f15SJohn Edward Broadbent                         "PowerRestorePolicy", powerRestorePolicy, "AssetTag",
302037bbf98cSChris Cain                         assetTag, "PowerMode", powerMode, "IdlePowerSaver",
302137bbf98cSChris Cain                         ipsProps))
30226617338dSEd Tanous                 {
30236617338dSEd Tanous                     return;
30246617338dSEd Tanous                 }
3025491d8ee7SSantosh Puranik 
30268d1b46d7Szhanghch05                 asyncResp->res.result(boost::beast::http::status::no_content);
3027c45f0082SYong Li 
302898e386ecSGunnar Mills                 if (assetTag)
302998e386ecSGunnar Mills                 {
303098e386ecSGunnar Mills                     setAssetTag(asyncResp, *assetTag);
303198e386ecSGunnar Mills                 }
303298e386ecSGunnar Mills 
3033c45f0082SYong Li                 if (wdtTimerProps)
3034c45f0082SYong Li                 {
3035c45f0082SYong Li                     std::optional<bool> wdtEnable;
3036c45f0082SYong Li                     std::optional<std::string> wdtTimeOutAction;
3037c45f0082SYong Li 
3038c45f0082SYong Li                     if (!json_util::readJson(*wdtTimerProps, asyncResp->res,
3039c45f0082SYong Li                                              "FunctionEnabled", wdtEnable,
3040c45f0082SYong Li                                              "TimeoutAction", wdtTimeOutAction))
3041c45f0082SYong Li                     {
3042c45f0082SYong Li                         return;
3043c45f0082SYong Li                     }
3044f23b7296SEd Tanous                     setWDTProperties(asyncResp, wdtEnable, wdtTimeOutAction);
3045c45f0082SYong Li                 }
3046c45f0082SYong Li 
3047491d8ee7SSantosh Puranik                 if (bootProps)
3048491d8ee7SSantosh Puranik                 {
3049491d8ee7SSantosh Puranik                     std::optional<std::string> bootSource;
3050cd9a4666SKonstantin Aladyshev                     std::optional<std::string> bootType;
3051491d8ee7SSantosh Puranik                     std::optional<std::string> bootEnable;
305269f35306SGunnar Mills                     std::optional<std::string> automaticRetryConfig;
3053ac7e1e0bSAli Ahmed                     std::optional<bool> trustedModuleRequiredToBoot;
3054491d8ee7SSantosh Puranik 
305569f35306SGunnar Mills                     if (!json_util::readJson(
30567e860f15SJohn Edward Broadbent                             *bootProps, asyncResp->res,
30577e860f15SJohn Edward Broadbent                             "BootSourceOverrideTarget", bootSource,
3058cd9a4666SKonstantin Aladyshev                             "BootSourceOverrideMode", bootType,
30597e860f15SJohn Edward Broadbent                             "BootSourceOverrideEnabled", bootEnable,
3060ac7e1e0bSAli Ahmed                             "AutomaticRetryConfig", automaticRetryConfig,
3061ac7e1e0bSAli Ahmed                             "TrustedModuleRequiredToBoot",
3062ac7e1e0bSAli Ahmed                             trustedModuleRequiredToBoot))
3063491d8ee7SSantosh Puranik                     {
3064491d8ee7SSantosh Puranik                         return;
3065491d8ee7SSantosh Puranik                     }
3066c21865c4SKonstantin Aladyshev 
3067cd9a4666SKonstantin Aladyshev                     if (bootSource || bootType || bootEnable)
306869f35306SGunnar Mills                     {
3069c21865c4SKonstantin Aladyshev                         setBootProperties(asyncResp, bootSource, bootType,
3070c21865c4SKonstantin Aladyshev                                           bootEnable);
3071491d8ee7SSantosh Puranik                     }
307269f35306SGunnar Mills                     if (automaticRetryConfig)
307369f35306SGunnar Mills                     {
3074f23b7296SEd Tanous                         setAutomaticRetry(asyncResp, *automaticRetryConfig);
307569f35306SGunnar Mills                     }
3076ac7e1e0bSAli Ahmed 
3077ac7e1e0bSAli Ahmed                     if (trustedModuleRequiredToBoot)
3078ac7e1e0bSAli Ahmed                     {
3079ac7e1e0bSAli Ahmed                         setTrustedModuleRequiredToBoot(
3080ac7e1e0bSAli Ahmed                             asyncResp, *trustedModuleRequiredToBoot);
3081ac7e1e0bSAli Ahmed                     }
308269f35306SGunnar Mills                 }
3083265c1602SJohnathan Mantey 
30849f8bfa7cSGunnar Mills                 if (locationIndicatorActive)
30859f8bfa7cSGunnar Mills                 {
30867e860f15SJohn Edward Broadbent                     setLocationIndicatorActive(asyncResp,
30877e860f15SJohn Edward Broadbent                                                *locationIndicatorActive);
30889f8bfa7cSGunnar Mills                 }
30899f8bfa7cSGunnar Mills 
30907e860f15SJohn Edward Broadbent                 // TODO (Gunnar): Remove IndicatorLED after enough time has
30917e860f15SJohn Edward Broadbent                 // passed
30929712f8acSEd Tanous                 if (indicatorLed)
30936617338dSEd Tanous                 {
3094f23b7296SEd Tanous                     setIndicatorLedState(asyncResp, *indicatorLed);
30957e860f15SJohn Edward Broadbent                     asyncResp->res.addHeader(
30967e860f15SJohn Edward Broadbent                         boost::beast::http::field::warning,
3097d6aa0093SGunnar Mills                         "299 - \"IndicatorLED is deprecated. Use "
3098d6aa0093SGunnar Mills                         "LocationIndicatorActive instead.\"");
30996617338dSEd Tanous                 }
3100c6a620f2SGeorge Liu 
3101c6a620f2SGeorge Liu                 if (powerRestorePolicy)
3102c6a620f2SGeorge Liu                 {
31034e69c904SGunnar Mills                     setPowerRestorePolicy(asyncResp, *powerRestorePolicy);
3104c6a620f2SGeorge Liu                 }
31053a2d0424SChris Cain 
31063a2d0424SChris Cain                 if (powerMode)
31073a2d0424SChris Cain                 {
31083a2d0424SChris Cain                     setPowerMode(asyncResp, *powerMode);
31093a2d0424SChris Cain                 }
311037bbf98cSChris Cain 
311137bbf98cSChris Cain                 if (ipsProps)
311237bbf98cSChris Cain                 {
311337bbf98cSChris Cain                     std::optional<bool> ipsEnable;
311437bbf98cSChris Cain                     std::optional<uint8_t> ipsEnterUtil;
311537bbf98cSChris Cain                     std::optional<uint64_t> ipsEnterTime;
311637bbf98cSChris Cain                     std::optional<uint8_t> ipsExitUtil;
311737bbf98cSChris Cain                     std::optional<uint64_t> ipsExitTime;
311837bbf98cSChris Cain 
311937bbf98cSChris Cain                     if (!json_util::readJson(
312037bbf98cSChris Cain                             *ipsProps, asyncResp->res, "Enabled", ipsEnable,
312137bbf98cSChris Cain                             "EnterUtilizationPercent", ipsEnterUtil,
312237bbf98cSChris Cain                             "EnterDwellTimeSeconds", ipsEnterTime,
312337bbf98cSChris Cain                             "ExitUtilizationPercent", ipsExitUtil,
312437bbf98cSChris Cain                             "ExitDwellTimeSeconds", ipsExitTime))
312537bbf98cSChris Cain                     {
312637bbf98cSChris Cain                         return;
312737bbf98cSChris Cain                     }
312837bbf98cSChris Cain                     setIdlePowerSaver(asyncResp, ipsEnable, ipsEnterUtil,
312937bbf98cSChris Cain                                       ipsEnterTime, ipsExitUtil, ipsExitTime);
313037bbf98cSChris Cain                 }
31317e860f15SJohn Edward Broadbent             });
3132c5b2abe0SLewanczyk, Dawid }
31331cb1a9e6SAppaRao Puli 
31341cb1a9e6SAppaRao Puli /**
31351cb1a9e6SAppaRao Puli  * SystemResetActionInfo derived class for delivering Computer Systems
31361cb1a9e6SAppaRao Puli  * ResetType AllowableValues using ResetInfo schema.
31371cb1a9e6SAppaRao Puli  */
31387e860f15SJohn Edward Broadbent inline void requestRoutesSystemResetActionInfo(App& app)
31391cb1a9e6SAppaRao Puli {
31401cb1a9e6SAppaRao Puli 
31411cb1a9e6SAppaRao Puli     /**
31421cb1a9e6SAppaRao Puli      * Functions triggers appropriate requests on DBus
31431cb1a9e6SAppaRao Puli      */
31447e860f15SJohn Edward Broadbent     BMCWEB_ROUTE(app, "/redfish/v1/Systems/system/ResetActionInfo/")
3145ed398213SEd Tanous         .privileges(redfish::privileges::getActionInfo)
31467e860f15SJohn Edward Broadbent         .methods(boost::beast::http::verb::get)(
31477e860f15SJohn Edward Broadbent             [](const crow::Request&,
31487e860f15SJohn Edward Broadbent                const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
31498d1b46d7Szhanghch05                 asyncResp->res.jsonValue = {
31501cb1a9e6SAppaRao Puli                     {"@odata.type", "#ActionInfo.v1_1_2.ActionInfo"},
31511cb1a9e6SAppaRao Puli                     {"@odata.id", "/redfish/v1/Systems/system/ResetActionInfo"},
31521cb1a9e6SAppaRao Puli                     {"Name", "Reset Action Info"},
31531cb1a9e6SAppaRao Puli                     {"Id", "ResetActionInfo"},
31541cb1a9e6SAppaRao Puli                     {"Parameters",
31551cb1a9e6SAppaRao Puli                      {{{"Name", "ResetType"},
31561cb1a9e6SAppaRao Puli                        {"Required", true},
31571cb1a9e6SAppaRao Puli                        {"DataType", "String"},
31581cb1a9e6SAppaRao Puli                        {"AllowableValues",
31597e860f15SJohn Edward Broadbent                         {"On", "ForceOff", "ForceOn", "ForceRestart",
31607e860f15SJohn Edward Broadbent                          "GracefulRestart", "GracefulShutdown", "PowerCycle",
31617e860f15SJohn Edward Broadbent                          "Nmi"}}}}}};
31627e860f15SJohn Edward Broadbent             });
31631cb1a9e6SAppaRao Puli }
3164c5b2abe0SLewanczyk, Dawid } // namespace redfish
3165