blob: 6dab7dd513c722a4331963e955f5c75196b89d38 [file] [log] [blame]
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +05301#pragma once
George Liubddcf852021-09-08 08:46:22 +08002#include "config.h"
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +05303
Gunnar Mills94df8c92018-09-14 14:50:03 -05004#include "i2c_occ.hpp"
Chris Caina8857c52021-01-27 11:53:05 -06005#include "occ_command.hpp"
Gunnar Mills94df8c92018-09-14 14:50:03 -05006#include "occ_device.hpp"
7#include "occ_events.hpp"
Chris Cain36f9cde2021-11-22 11:18:21 -06008#include "powermode.hpp"
George Liuf3b75142021-06-10 11:22:50 +08009#include "utils.hpp"
Gunnar Mills94df8c92018-09-14 14:50:03 -050010
Gunnar Mills94df8c92018-09-14 14:50:03 -050011#include <org/open_power/Control/Host/server.hpp>
12#include <org/open_power/OCC/Status/server.hpp>
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053013#include <sdbusplus/bus.hpp>
14#include <sdbusplus/server/object.hpp>
Chris Caina7b74dc2021-11-10 17:03:43 -060015#ifdef POWER10
16#include <sdeventplus/event.hpp>
17#include <sdeventplus/utility/timer.hpp>
18#endif
Lei YU0ab90ca2017-07-13 17:02:23 +080019
George Liub5ca1012021-09-10 12:53:11 +080020#include <functional>
21
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053022namespace open_power
23{
24namespace occ
25{
26
Edward A. James636577f2017-10-06 10:53:55 -050027class Manager;
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053028namespace Base = sdbusplus::org::open_power::OCC::server;
29using Interface = sdbusplus::server::object::object<Base::Status>;
30
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +053031// IPMID's host control application
32namespace Control = sdbusplus::org::open_power::Control::server;
33
34// For waiting on signals
35namespace sdbusRule = sdbusplus::bus::match::rules;
36
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +053037// OCC status instance. Ex. for "occ0", the instance is 0
38using instanceID = int;
39
40// IPMI sensor ID for a given OCC instance
41using sensorID = uint8_t;
42
Alexander Filippov1d69e192019-03-21 18:12:07 +030043// Human readable sensor name for DBus tree. E.g. "CPU0_OCC"
44using sensorName = std::string;
45
46// OCC sensors definitions in the map
47using sensorDefs = std::tuple<sensorID, sensorName>;
48
Eddie Jamese7d976b2018-02-26 13:42:45 -060049// OCC sysfs name prefix
50const std::string sysfsName = "occ-hwmon";
51
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053052/** @class Status
53 * @brief Implementation of OCC Active Status
54 */
55class Status : public Interface
56{
Gunnar Mills94df8c92018-09-14 14:50:03 -050057 public:
58 Status() = delete;
59 ~Status() = default;
60 Status(const Status&) = delete;
61 Status& operator=(const Status&) = delete;
62 Status(Status&&) = default;
63 Status& operator=(Status&&) = default;
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053064
Gunnar Mills94df8c92018-09-14 14:50:03 -050065 /** @brief Constructs the Status object and
66 * the underlying device object
67 *
Gunnar Mills94df8c92018-09-14 14:50:03 -050068 * @param[in] event - sd_event unique pointer reference
69 * @param[in] path - DBus object path
70 * @param[in] manager - OCC manager instance
71 * @param[in] callBack - Callback handler to invoke during
72 * property change
Tom Joseph00325232020-07-29 17:51:48 +053073 * @param[in] resetCallBack - callback handler to invoke for resetting the
74 * OCC if PLDM is the host communication
75 * protocol
Gunnar Mills94df8c92018-09-14 14:50:03 -050076 */
Chris Cain17257672021-10-22 13:41:03 -050077 Status(EventPtr& event, const char* path, Manager& managerRef,
Chris Cain36f9cde2021-11-22 11:18:21 -060078#ifdef POWER10
79 std::unique_ptr<open_power::occ::powermode::PowerMode>& powerModeRef,
80#endif
George Liuf3b75142021-06-10 11:22:50 +080081 std::function<void(bool)> callBack = nullptr
Tom Joseph00325232020-07-29 17:51:48 +053082#ifdef PLDM
83 ,
84 std::function<void(instanceID)> resetCallBack = nullptr
85#endif
86 ) :
87
George Liuf3b75142021-06-10 11:22:50 +080088 Interface(utils::getBus(), getDbusPath(path).c_str(), true),
Chris Cain1be43372021-12-09 19:29:37 -060089 path(path), managerCallBack(callBack), instance(getInstance(path)),
Chris Cain17257672021-10-22 13:41:03 -050090 manager(managerRef),
Chris Cain36f9cde2021-11-22 11:18:21 -060091#ifdef POWER10
92 pmode(powerModeRef),
93#endif
Gunnar Mills94df8c92018-09-14 14:50:03 -050094 device(event,
Lei YU0ab90ca2017-07-13 17:02:23 +080095#ifdef I2C_OCC
Eddie James774f9af2019-03-19 20:58:53 +000096 fs::path(DEV_PATH) / i2c_occ::getI2cDeviceName(path),
Lei YU0ab90ca2017-07-13 17:02:23 +080097#else
Eddie James774f9af2019-03-19 20:58:53 +000098 fs::path(DEV_PATH) /
99 fs::path(sysfsName + "." + std::to_string(instance + 1)),
Lei YU0ab90ca2017-07-13 17:02:23 +0800100#endif
Chris Cain17257672021-10-22 13:41:03 -0500101 managerRef, *this, instance),
Gunnar Mills94df8c92018-09-14 14:50:03 -0500102 hostControlSignal(
George Liuf3b75142021-06-10 11:22:50 +0800103 utils::getBus(),
Gunnar Mills94df8c92018-09-14 14:50:03 -0500104 sdbusRule::type::signal() + sdbusRule::member("CommandComplete") +
105 sdbusRule::path("/org/open_power/control/host0") +
106 sdbusRule::interface("org.open_power.Control.Host") +
107 sdbusRule::argN(0, Control::convertForMessage(
108 Control::Host::Command::OCCReset)),
109 std::bind(std::mem_fn(&Status::hostControlEvent), this,
Chris Caina8857c52021-01-27 11:53:05 -0600110 std::placeholders::_1)),
George Liuf3b75142021-06-10 11:22:50 +0800111 occCmd(instance, (fs::path(OCC_CONTROL_ROOT) /
112 (std::string(OCC_NAME) + std::to_string(instance)))
113 .c_str())
Chris Caina7b74dc2021-11-10 17:03:43 -0600114#ifdef POWER10
115 ,
116 sdpEvent(sdeventplus::Event::get_default()),
117 safeStateDelayTimer(
118 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>(
119 sdpEvent, std::bind(&Status::safeStateDelayExpired, this)))
120#endif
Tom Joseph00325232020-07-29 17:51:48 +0530121#ifdef PLDM
122 ,
123 resetCallBack(resetCallBack)
124#endif
Gunnar Mills94df8c92018-09-14 14:50:03 -0500125 {
126 // Check to see if we have OCC already bound. If so, just set it
127 if (device.bound())
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +0530128 {
Gunnar Mills94df8c92018-09-14 14:50:03 -0500129 this->occActive(true);
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +0530130 }
131
Gunnar Mills94df8c92018-09-14 14:50:03 -0500132 // Announce that we are ready
133 this->emit_object_added();
134 }
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530135
Gunnar Mills94df8c92018-09-14 14:50:03 -0500136 /** @brief Since we are overriding the setter-occActive but not the
137 * getter-occActive, we need to have this using in order to
138 * allow passthrough usage of the getter-occActive
139 */
140 using Base::Status::occActive;
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530141
Gunnar Mills94df8c92018-09-14 14:50:03 -0500142 /** @brief SET OccActive to True or False
143 *
144 * @param[in] value - Intended value
145 *
146 * @return - Updated value of the property
147 */
148 bool occActive(bool value) override;
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530149
Gunnar Mills94df8c92018-09-14 14:50:03 -0500150 /** @brief Starts OCC error detection */
151 inline void addErrorWatch()
152 {
153 return device.addErrorWatch();
154 }
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530155
Gunnar Mills94df8c92018-09-14 14:50:03 -0500156 /** @brief Stops OCC error detection */
157 inline void removeErrorWatch()
158 {
159 return device.removeErrorWatch();
160 }
Eddie Jamesdae2d942017-12-20 10:50:03 -0600161
Gunnar Mills94df8c92018-09-14 14:50:03 -0500162 /** @brief Starts to watch how many OCCs are present on the master */
163 inline void addPresenceWatchMaster()
164 {
165 return device.addPresenceWatchMaster();
166 }
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530167
Chicago Duanbb895cb2021-06-18 19:37:16 +0800168 /** @brief Gets the occ instance number */
169 unsigned int getOccInstanceID()
170 {
171 return instance;
172 }
173
174 /** @brief Is this OCC the master OCC */
175 bool isMasterOcc()
176 {
177 return device.master();
178 }
179
Chris Caina8857c52021-01-27 11:53:05 -0600180 /** @brief Read OCC state (will trigger kernel to poll the OCC) */
181 void readOccState();
182
Eddie Jamescbad2192021-10-07 09:39:39 -0500183 /** @brief Called when device errors are detected */
184 void deviceError();
185
Chris Cain78e86012021-03-04 16:15:31 -0600186#ifdef POWER10
187 /** @brief Handle additional tasks when the OCCs reach active state */
188 void occsWentActive();
189
Chris Cain17257672021-10-22 13:41:03 -0500190 /** @brief Send Ambient & Altitude data to OCC
191 *
192 * @param[in] ambient - temperature to send (0xFF will force read
193 * of current temperature and altitude)
194 * @param[in] altitude - altitude to send (0xFFFF = unavailable)
195 *
196 * @return SUCCESS on success
197 */
198 CmdStatus sendAmbient(const uint8_t ambient = 0xFF,
199 const uint16_t altitude = 0xFFFF);
Chris Cain78e86012021-03-04 16:15:31 -0600200#endif // POWER10
201
Gunnar Mills94df8c92018-09-14 14:50:03 -0500202 private:
Gunnar Mills94df8c92018-09-14 14:50:03 -0500203 /** @brief OCC dbus object path */
204 std::string path;
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530205
Gunnar Mills94df8c92018-09-14 14:50:03 -0500206 /** @brief Callback handler to be invoked during property change.
207 * This is a handler in Manager class
208 */
Chris Cain1be43372021-12-09 19:29:37 -0600209 std::function<void(bool)> managerCallBack;
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530210
Gunnar Mills94df8c92018-09-14 14:50:03 -0500211 /** @brief OCC instance number. Ex, 0,1, etc */
Chris Caina8857c52021-01-27 11:53:05 -0600212 unsigned int instance;
213
214 /** @brief The last state read from the OCC */
215 unsigned int lastState = 0;
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +0530216
Alexander Filippov1d69e192019-03-21 18:12:07 +0300217 /** @brief OCC instance to Sensor definitions mapping */
218 static const std::map<instanceID, sensorDefs> sensorMap;
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +0530219
Chris Cain17257672021-10-22 13:41:03 -0500220 /** @brief OCC manager object */
221 const Manager& manager;
222
Chris Cain36f9cde2021-11-22 11:18:21 -0600223#ifdef POWER10
224 /** @brief OCC PowerMode object */
225 std::unique_ptr<open_power::occ::powermode::PowerMode>& pmode;
226#endif
227
Gunnar Mills94df8c92018-09-14 14:50:03 -0500228 /** @brief OCC device object to do bind and unbind */
229 Device device;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530230
Gunnar Mills94df8c92018-09-14 14:50:03 -0500231 /** @brief Subscribe to host control signal
232 *
233 * Once the OCC reset is requested, BMC sends that message to host.
234 * If the host does not ack the message, then there would be a timeout
235 * and we need to catch that to log an error
236 **/
237 sdbusplus::bus::match_t hostControlSignal;
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530238
Chris Caina8857c52021-01-27 11:53:05 -0600239 /** @brief Command object to send commands to the OCC */
240 OccCommand occCmd;
241
Chris Caina7b74dc2021-11-10 17:03:43 -0600242#ifdef POWER10
243 /** @brief timer event */
244 sdeventplus::Event sdpEvent;
245#endif
246
Gunnar Mills94df8c92018-09-14 14:50:03 -0500247 /** @brief Callback function on host control signals
248 *
249 * @param[in] msg - Data associated with subscribed signal
250 */
251 void hostControlEvent(sdbusplus::message::message& msg);
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530252
Gunnar Mills94df8c92018-09-14 14:50:03 -0500253 /** @brief Sends a message to host control command handler to reset OCC
254 */
255 void resetOCC();
Alexander Filippov1d69e192019-03-21 18:12:07 +0300256
257 /** @brief Determines the instance ID by specified object path.
258 * @param[in] path Estimated OCC Dbus object path
259 * @return Instance number
260 */
261 static int getInstance(const std::string& path)
262 {
263 return (path.empty() ? 0 : path.back() - '0');
264 }
265
Chris Cain78e86012021-03-04 16:15:31 -0600266#ifdef POWER10
Chris Caina7b74dc2021-11-10 17:03:43 -0600267 /**
268 * @brief Timer that is started when OCC is detected to be in safe mode
269 */
270 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>
271 safeStateDelayTimer;
272
273 /** @brief Callback for timer that is started when OCC was detected to be in
274 * safe mode. Called to verify and then disable and reset the OCCs.
275 */
276 void safeStateDelayExpired();
Chris Cain78e86012021-03-04 16:15:31 -0600277#endif // POWER10
278
Alexander Filippov1d69e192019-03-21 18:12:07 +0300279 /** @brief Override the sensor name with name from the definition.
280 * @param[in] estimatedPath - Estimated OCC Dbus object path
281 * @return Fixed OCC DBus object path
282 */
283 static std::string getDbusPath(const std::string& estimatedPath)
284 {
285 if (!estimatedPath.empty())
286 {
287 auto it = sensorMap.find(getInstance(estimatedPath));
288 if (sensorMap.end() != it)
289 {
290 auto& name = std::get<1>(it->second);
291 if (!name.empty() && name != "None")
292 {
George Liuf3a4a692021-12-28 13:59:51 +0800293 auto objectPath = fs::path(estimatedPath);
294 objectPath.replace_filename(name);
295 return objectPath.string();
Alexander Filippov1d69e192019-03-21 18:12:07 +0300296 }
297 }
298 }
299
300 return estimatedPath;
301 }
Tom Joseph00325232020-07-29 17:51:48 +0530302#ifdef PLDM
303 std::function<void(instanceID)> resetCallBack = nullptr;
304#endif
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +0530305};
306
307} // namespace occ
308} // namespace open_power