1 /**
2  * Copyright © 2016 IBM Corporation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #include "config.h"
17 
18 #include "softoff.hpp"
19 
20 #include <chrono>
21 #include <phosphor-logging/log.hpp>
22 #include <utils.hpp>
23 #include <xyz/openbmc_project/Control/Host/server.hpp>
24 namespace phosphor
25 {
26 namespace ipmi
27 {
28 
29 using namespace phosphor::logging;
30 using namespace sdbusplus::xyz::openbmc_project::Control::server;
31 
32 void SoftPowerOff::sendHostShutDownCmd()
33 {
34     auto ctrlHostPath =
35         std::string{CONTROL_HOST_OBJ_MGR} + '/' + HOST_NAME + '0';
36     auto host = ::ipmi::getService(this->bus, CONTROL_HOST_BUSNAME,
37                                    ctrlHostPath.c_str());
38 
39     auto method = bus.new_method_call(host.c_str(), ctrlHostPath.c_str(),
40                                       CONTROL_HOST_BUSNAME, "Execute");
41 
42     method.append(convertForMessage(Host::Command::SoftOff).c_str());
43 
44     auto reply = bus.call(method);
45     if (reply.is_method_error())
46     {
47         log<level::ERR>("Error in call to control host Execute");
48         // TODO openbmc/openbmc#851 - Once available, throw returned error
49         throw std::runtime_error("Error in call to control host Execute");
50     }
51 
52     return;
53 }
54 
55 // Function called on host control signals
56 void SoftPowerOff::hostControlEvent(sdbusplus::message::message& msg)
57 {
58     std::string cmdCompleted{};
59     std::string cmdStatus{};
60 
61     msg.read(cmdCompleted, cmdStatus);
62 
63     log<level::DEBUG>("Host control signal values",
64                       entry("COMMAND=%s", cmdCompleted.c_str()),
65                       entry("STATUS=%s", cmdStatus.c_str()));
66 
67     if (Host::convertResultFromString(cmdStatus) == Host::Result::Success)
68     {
69         // Set our internal property indicating we got host attention
70         sdbusplus::xyz::openbmc_project::Ipmi::Internal ::server::SoftPowerOff::
71             responseReceived(HostResponse::SoftOffReceived);
72 
73         // Start timer for host shutdown
74         using namespace std::chrono;
75         auto time = duration_cast<microseconds>(
76             seconds(IPMI_HOST_SHUTDOWN_COMPLETE_TIMEOUT_SECS));
77         auto r = startTimer(time);
78         if (r < 0)
79         {
80             log<level::ERR>("Failure to start Host shutdown wait timer",
81                             entry("ERRNO=0x%X", -r));
82         }
83         else
84         {
85             log<level::INFO>(
86                 "Timer started waiting for host to shutdown",
87                 entry("TIMEOUT_IN_MSEC=%llu",
88                       (duration_cast<milliseconds>(
89                            seconds(IPMI_HOST_SHUTDOWN_COMPLETE_TIMEOUT_SECS)))
90                           .count()));
91         }
92     }
93     else
94     {
95         // An error on the initial attention is not considered an error, just
96         // exit normally and allow remaining shutdown targets to run
97         log<level::INFO>("Timeout on host attention, continue with power down");
98         completed = true;
99     }
100     return;
101 }
102 
103 // Starts a timer
104 int SoftPowerOff::startTimer(const std::chrono::microseconds& usec)
105 {
106     return timer.start(usec);
107 }
108 
109 // Host Response handler
110 auto SoftPowerOff::responseReceived(HostResponse response) -> HostResponse
111 {
112     using namespace std::chrono;
113 
114     if (response == HostResponse::HostShutdown)
115     {
116         // Disable the timer since Host has quiesced and we are
117         // done with soft power off part
118         auto r = timer.stop();
119         if (r < 0)
120         {
121             log<level::ERR>("Failure to STOP the timer",
122                             entry("ERRNO=0x%X", -r));
123         }
124 
125         // This marks the completion of soft power off sequence.
126         completed = true;
127     }
128 
129     return sdbusplus::xyz::openbmc_project::Ipmi::Internal ::server::
130         SoftPowerOff::responseReceived(response);
131 }
132 
133 } // namespace ipmi
134 } // namespace phosphor
135