blob: 0d22c4949bbb0016e7507cec67f460bfe5f5ea88 [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 Cain5d66a0a2022-02-09 08:52:10 -06008#include "powercap.hpp"
Chris Cain36f9cde2021-11-22 11:18:21 -06009#include "powermode.hpp"
George Liuf3b75142021-06-10 11:22:50 +080010#include "utils.hpp"
Gunnar Mills94df8c92018-09-14 14:50:03 -050011
Gunnar Mills94df8c92018-09-14 14:50:03 -050012#include <org/open_power/Control/Host/server.hpp>
13#include <org/open_power/OCC/Status/server.hpp>
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053014#include <sdbusplus/bus.hpp>
15#include <sdbusplus/server/object.hpp>
Chris Caina7b74dc2021-11-10 17:03:43 -060016#ifdef POWER10
17#include <sdeventplus/event.hpp>
18#include <sdeventplus/utility/timer.hpp>
19#endif
Lei YU0ab90ca2017-07-13 17:02:23 +080020
George Liub5ca1012021-09-10 12:53:11 +080021#include <functional>
22
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053023namespace open_power
24{
25namespace occ
26{
27
Edward A. James636577f2017-10-06 10:53:55 -050028class Manager;
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053029namespace Base = sdbusplus::org::open_power::OCC::server;
30using Interface = sdbusplus::server::object::object<Base::Status>;
31
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +053032// IPMID's host control application
33namespace Control = sdbusplus::org::open_power::Control::server;
34
35// For waiting on signals
36namespace sdbusRule = sdbusplus::bus::match::rules;
37
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +053038// OCC status instance. Ex. for "occ0", the instance is 0
39using instanceID = int;
40
41// IPMI sensor ID for a given OCC instance
42using sensorID = uint8_t;
43
Alexander Filippov1d69e192019-03-21 18:12:07 +030044// Human readable sensor name for DBus tree. E.g. "CPU0_OCC"
45using sensorName = std::string;
46
47// OCC sensors definitions in the map
48using sensorDefs = std::tuple<sensorID, sensorName>;
49
Eddie Jamese7d976b2018-02-26 13:42:45 -060050// OCC sysfs name prefix
51const std::string sysfsName = "occ-hwmon";
52
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053053/** @class Status
54 * @brief Implementation of OCC Active Status
55 */
56class Status : public Interface
57{
Gunnar Mills94df8c92018-09-14 14:50:03 -050058 public:
59 Status() = delete;
60 ~Status() = default;
61 Status(const Status&) = delete;
62 Status& operator=(const Status&) = delete;
63 Status(Status&&) = default;
64 Status& operator=(Status&&) = default;
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +053065
Gunnar Mills94df8c92018-09-14 14:50:03 -050066 /** @brief Constructs the Status object and
67 * the underlying device object
68 *
Gunnar Mills94df8c92018-09-14 14:50:03 -050069 * @param[in] event - sd_event unique pointer reference
70 * @param[in] path - DBus object path
71 * @param[in] manager - OCC manager instance
72 * @param[in] callBack - Callback handler to invoke during
73 * property change
Tom Joseph00325232020-07-29 17:51:48 +053074 * @param[in] resetCallBack - callback handler to invoke for resetting the
75 * OCC if PLDM is the host communication
76 * protocol
Gunnar Mills94df8c92018-09-14 14:50:03 -050077 */
Chris Cain17257672021-10-22 13:41:03 -050078 Status(EventPtr& event, const char* path, Manager& managerRef,
Chris Cain36f9cde2021-11-22 11:18:21 -060079#ifdef POWER10
Chris Cain5d66a0a2022-02-09 08:52:10 -060080 std::unique_ptr<powermode::PowerMode>& powerModeRef,
Chris Cain36f9cde2021-11-22 11:18:21 -060081#endif
George Liuf3b75142021-06-10 11:22:50 +080082 std::function<void(bool)> callBack = nullptr
Tom Joseph00325232020-07-29 17:51:48 +053083#ifdef PLDM
84 ,
85 std::function<void(instanceID)> resetCallBack = nullptr
86#endif
87 ) :
88
George Liuf3b75142021-06-10 11:22:50 +080089 Interface(utils::getBus(), getDbusPath(path).c_str(), true),
Chris Cain1be43372021-12-09 19:29:37 -060090 path(path), managerCallBack(callBack), instance(getInstance(path)),
Chris Cain17257672021-10-22 13:41:03 -050091 manager(managerRef),
Chris Cain36f9cde2021-11-22 11:18:21 -060092#ifdef POWER10
93 pmode(powerModeRef),
94#endif
Gunnar Mills94df8c92018-09-14 14:50:03 -050095 device(event,
Lei YU0ab90ca2017-07-13 17:02:23 +080096#ifdef I2C_OCC
Eddie James774f9af2019-03-19 20:58:53 +000097 fs::path(DEV_PATH) / i2c_occ::getI2cDeviceName(path),
Lei YU0ab90ca2017-07-13 17:02:23 +080098#else
Eddie James774f9af2019-03-19 20:58:53 +000099 fs::path(DEV_PATH) /
100 fs::path(sysfsName + "." + std::to_string(instance + 1)),
Lei YU0ab90ca2017-07-13 17:02:23 +0800101#endif
Chris Cain17257672021-10-22 13:41:03 -0500102 managerRef, *this, instance),
Gunnar Mills94df8c92018-09-14 14:50:03 -0500103 hostControlSignal(
George Liuf3b75142021-06-10 11:22:50 +0800104 utils::getBus(),
Gunnar Mills94df8c92018-09-14 14:50:03 -0500105 sdbusRule::type::signal() + sdbusRule::member("CommandComplete") +
106 sdbusRule::path("/org/open_power/control/host0") +
107 sdbusRule::interface("org.open_power.Control.Host") +
108 sdbusRule::argN(0, Control::convertForMessage(
109 Control::Host::Command::OCCReset)),
110 std::bind(std::mem_fn(&Status::hostControlEvent), this,
Chris Caina8857c52021-01-27 11:53:05 -0600111 std::placeholders::_1)),
George Liuf3b75142021-06-10 11:22:50 +0800112 occCmd(instance, (fs::path(OCC_CONTROL_ROOT) /
113 (std::string(OCC_NAME) + std::to_string(instance)))
114 .c_str())
Chris Caina7b74dc2021-11-10 17:03:43 -0600115#ifdef POWER10
116 ,
117 sdpEvent(sdeventplus::Event::get_default()),
118 safeStateDelayTimer(
119 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>(
120 sdpEvent, std::bind(&Status::safeStateDelayExpired, this)))
121#endif
Tom Joseph00325232020-07-29 17:51:48 +0530122#ifdef PLDM
123 ,
124 resetCallBack(resetCallBack)
125#endif
Gunnar Mills94df8c92018-09-14 14:50:03 -0500126 {
127 // Check to see if we have OCC already bound. If so, just set it
128 if (device.bound())
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +0530129 {
Gunnar Mills94df8c92018-09-14 14:50:03 -0500130 this->occActive(true);
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +0530131 }
132
Gunnar Mills94df8c92018-09-14 14:50:03 -0500133 // Announce that we are ready
134 this->emit_object_added();
135 }
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530136
Gunnar Mills94df8c92018-09-14 14:50:03 -0500137 /** @brief Since we are overriding the setter-occActive but not the
138 * getter-occActive, we need to have this using in order to
139 * allow passthrough usage of the getter-occActive
140 */
141 using Base::Status::occActive;
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530142
Gunnar Mills94df8c92018-09-14 14:50:03 -0500143 /** @brief SET OccActive to True or False
144 *
145 * @param[in] value - Intended value
146 *
147 * @return - Updated value of the property
148 */
149 bool occActive(bool value) override;
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530150
Gunnar Mills94df8c92018-09-14 14:50:03 -0500151 /** @brief Starts OCC error detection */
152 inline void addErrorWatch()
153 {
154 return device.addErrorWatch();
155 }
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530156
Gunnar Mills94df8c92018-09-14 14:50:03 -0500157 /** @brief Stops OCC error detection */
158 inline void removeErrorWatch()
159 {
160 return device.removeErrorWatch();
161 }
Eddie Jamesdae2d942017-12-20 10:50:03 -0600162
Gunnar Mills94df8c92018-09-14 14:50:03 -0500163 /** @brief Starts to watch how many OCCs are present on the master */
164 inline void addPresenceWatchMaster()
165 {
166 return device.addPresenceWatchMaster();
167 }
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530168
Chicago Duanbb895cb2021-06-18 19:37:16 +0800169 /** @brief Gets the occ instance number */
170 unsigned int getOccInstanceID()
171 {
172 return instance;
173 }
174
175 /** @brief Is this OCC the master OCC */
176 bool isMasterOcc()
177 {
178 return device.master();
179 }
180
Chris Caina8857c52021-01-27 11:53:05 -0600181 /** @brief Read OCC state (will trigger kernel to poll the OCC) */
182 void readOccState();
183
Eddie Jamescbad2192021-10-07 09:39:39 -0500184 /** @brief Called when device errors are detected */
185 void deviceError();
186
Chris Cain78e86012021-03-04 16:15:31 -0600187#ifdef POWER10
188 /** @brief Handle additional tasks when the OCCs reach active state */
189 void occsWentActive();
190
Chris Cain17257672021-10-22 13:41:03 -0500191 /** @brief Send Ambient & Altitude data to OCC
192 *
193 * @param[in] ambient - temperature to send (0xFF will force read
194 * of current temperature and altitude)
195 * @param[in] altitude - altitude to send (0xFFFF = unavailable)
196 *
197 * @return SUCCESS on success
198 */
199 CmdStatus sendAmbient(const uint8_t ambient = 0xFF,
200 const uint16_t altitude = 0xFFFF);
Chris Cain78e86012021-03-04 16:15:31 -0600201#endif // POWER10
202
Chris Cain5d66a0a2022-02-09 08:52:10 -0600203 /** @brief Return the HWMON path for this OCC
204 *
205 * @return path or empty path if not found
206 */
207 fs::path getHwmonPath() const;
208
Gunnar Mills94df8c92018-09-14 14:50:03 -0500209 private:
Gunnar Mills94df8c92018-09-14 14:50:03 -0500210 /** @brief OCC dbus object path */
211 std::string path;
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530212
Gunnar Mills94df8c92018-09-14 14:50:03 -0500213 /** @brief Callback handler to be invoked during property change.
214 * This is a handler in Manager class
215 */
Chris Cain1be43372021-12-09 19:29:37 -0600216 std::function<void(bool)> managerCallBack;
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530217
Gunnar Mills94df8c92018-09-14 14:50:03 -0500218 /** @brief OCC instance number. Ex, 0,1, etc */
Chris Caina8857c52021-01-27 11:53:05 -0600219 unsigned int instance;
220
221 /** @brief The last state read from the OCC */
222 unsigned int lastState = 0;
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +0530223
Alexander Filippov1d69e192019-03-21 18:12:07 +0300224 /** @brief OCC instance to Sensor definitions mapping */
225 static const std::map<instanceID, sensorDefs> sensorMap;
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +0530226
Chris Cain17257672021-10-22 13:41:03 -0500227 /** @brief OCC manager object */
228 const Manager& manager;
229
Chris Cain5d66a0a2022-02-09 08:52:10 -0600230 /** @brief Power cap monitor and occ notification object */
231 std::unique_ptr<powercap::PowerCap> pcap;
232
Chris Cain36f9cde2021-11-22 11:18:21 -0600233#ifdef POWER10
234 /** @brief OCC PowerMode object */
Chris Cain5d66a0a2022-02-09 08:52:10 -0600235 std::unique_ptr<powermode::PowerMode>& pmode;
Chris Cain36f9cde2021-11-22 11:18:21 -0600236#endif
237
Gunnar Mills94df8c92018-09-14 14:50:03 -0500238 /** @brief OCC device object to do bind and unbind */
239 Device device;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530240
Gunnar Mills94df8c92018-09-14 14:50:03 -0500241 /** @brief Subscribe to host control signal
242 *
243 * Once the OCC reset is requested, BMC sends that message to host.
244 * If the host does not ack the message, then there would be a timeout
245 * and we need to catch that to log an error
246 **/
247 sdbusplus::bus::match_t hostControlSignal;
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530248
Chris Caina8857c52021-01-27 11:53:05 -0600249 /** @brief Command object to send commands to the OCC */
250 OccCommand occCmd;
251
Chris Caina7b74dc2021-11-10 17:03:43 -0600252#ifdef POWER10
253 /** @brief timer event */
254 sdeventplus::Event sdpEvent;
255#endif
256
Gunnar Mills94df8c92018-09-14 14:50:03 -0500257 /** @brief Callback function on host control signals
258 *
259 * @param[in] msg - Data associated with subscribed signal
260 */
261 void hostControlEvent(sdbusplus::message::message& msg);
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530262
Gunnar Mills94df8c92018-09-14 14:50:03 -0500263 /** @brief Sends a message to host control command handler to reset OCC
264 */
265 void resetOCC();
Alexander Filippov1d69e192019-03-21 18:12:07 +0300266
267 /** @brief Determines the instance ID by specified object path.
268 * @param[in] path Estimated OCC Dbus object path
269 * @return Instance number
270 */
271 static int getInstance(const std::string& path)
272 {
273 return (path.empty() ? 0 : path.back() - '0');
274 }
275
Chris Cain78e86012021-03-04 16:15:31 -0600276#ifdef POWER10
Chris Caina7b74dc2021-11-10 17:03:43 -0600277 /**
278 * @brief Timer that is started when OCC is detected to be in safe mode
279 */
280 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>
281 safeStateDelayTimer;
282
283 /** @brief Callback for timer that is started when OCC was detected to be in
284 * safe mode. Called to verify and then disable and reset the OCCs.
285 */
286 void safeStateDelayExpired();
Chris Cain78e86012021-03-04 16:15:31 -0600287#endif // POWER10
288
Alexander Filippov1d69e192019-03-21 18:12:07 +0300289 /** @brief Override the sensor name with name from the definition.
290 * @param[in] estimatedPath - Estimated OCC Dbus object path
291 * @return Fixed OCC DBus object path
292 */
293 static std::string getDbusPath(const std::string& estimatedPath)
294 {
295 if (!estimatedPath.empty())
296 {
297 auto it = sensorMap.find(getInstance(estimatedPath));
298 if (sensorMap.end() != it)
299 {
300 auto& name = std::get<1>(it->second);
301 if (!name.empty() && name != "None")
302 {
George Liuf3a4a692021-12-28 13:59:51 +0800303 auto objectPath = fs::path(estimatedPath);
304 objectPath.replace_filename(name);
305 return objectPath.string();
Alexander Filippov1d69e192019-03-21 18:12:07 +0300306 }
307 }
308 }
309
310 return estimatedPath;
311 }
Tom Joseph00325232020-07-29 17:51:48 +0530312#ifdef PLDM
313 std::function<void(instanceID)> resetCallBack = nullptr;
314#endif
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +0530315};
316
317} // namespace occ
318} // namespace open_power