blob: 224a534a98dbdf3b87e9744a1451303116587cc2 [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
Chris Cain7e374fb2022-04-07 09:47:23 -050039using instanceID = unsigned int;
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +053040
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
Sheldon Bailey373af752022-02-21 15:14:00 -060082 std::function<void(instanceID, 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
Patrick Williams1923a752022-04-05 21:35:45 -050089 Interface(utils::getBus(), getDbusPath(path).c_str(),
90 Interface::action::defer_emit),
Chris Cain1be43372021-12-09 19:29:37 -060091 path(path), managerCallBack(callBack), instance(getInstance(path)),
Chris Cain17257672021-10-22 13:41:03 -050092 manager(managerRef),
Chris Cain36f9cde2021-11-22 11:18:21 -060093#ifdef POWER10
94 pmode(powerModeRef),
95#endif
Gunnar Mills94df8c92018-09-14 14:50:03 -050096 device(event,
Lei YU0ab90ca2017-07-13 17:02:23 +080097#ifdef I2C_OCC
Eddie James774f9af2019-03-19 20:58:53 +000098 fs::path(DEV_PATH) / i2c_occ::getI2cDeviceName(path),
Lei YU0ab90ca2017-07-13 17:02:23 +080099#else
Eddie James774f9af2019-03-19 20:58:53 +0000100 fs::path(DEV_PATH) /
101 fs::path(sysfsName + "." + std::to_string(instance + 1)),
Lei YU0ab90ca2017-07-13 17:02:23 +0800102#endif
Sheldon Baileyea2b22e2022-04-04 12:24:46 -0500103 managerRef, *this,
104#ifdef POWER10
105 powerModeRef,
106#endif
107 instance),
Gunnar Mills94df8c92018-09-14 14:50:03 -0500108 hostControlSignal(
George Liuf3b75142021-06-10 11:22:50 +0800109 utils::getBus(),
Gunnar Mills94df8c92018-09-14 14:50:03 -0500110 sdbusRule::type::signal() + sdbusRule::member("CommandComplete") +
111 sdbusRule::path("/org/open_power/control/host0") +
112 sdbusRule::interface("org.open_power.Control.Host") +
113 sdbusRule::argN(0, Control::convertForMessage(
114 Control::Host::Command::OCCReset)),
115 std::bind(std::mem_fn(&Status::hostControlEvent), this,
Chris Caina8857c52021-01-27 11:53:05 -0600116 std::placeholders::_1)),
George Liuf3b75142021-06-10 11:22:50 +0800117 occCmd(instance, (fs::path(OCC_CONTROL_ROOT) /
118 (std::string(OCC_NAME) + std::to_string(instance)))
119 .c_str())
Chris Caina7b74dc2021-11-10 17:03:43 -0600120#ifdef POWER10
121 ,
122 sdpEvent(sdeventplus::Event::get_default()),
123 safeStateDelayTimer(
124 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>(
Sheldon Bailey373af752022-02-21 15:14:00 -0600125 sdpEvent, std::bind(&Status::safeStateDelayExpired, this))),
126 occReadStateFailTimer(
127 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>(
128 sdpEvent, std::bind(&Status::occReadStateNow, this)))
Chris Caina7b74dc2021-11-10 17:03:43 -0600129#endif
Sheldon Bailey373af752022-02-21 15:14:00 -0600130
Tom Joseph00325232020-07-29 17:51:48 +0530131#ifdef PLDM
132 ,
133 resetCallBack(resetCallBack)
134#endif
Gunnar Mills94df8c92018-09-14 14:50:03 -0500135 {
Gunnar Mills94df8c92018-09-14 14:50:03 -0500136 // Announce that we are ready
137 this->emit_object_added();
138 }
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530139
Gunnar Mills94df8c92018-09-14 14:50:03 -0500140 /** @brief Since we are overriding the setter-occActive but not the
141 * getter-occActive, we need to have this using in order to
142 * allow passthrough usage of the getter-occActive
143 */
144 using Base::Status::occActive;
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530145
Gunnar Mills94df8c92018-09-14 14:50:03 -0500146 /** @brief SET OccActive to True or False
147 *
148 * @param[in] value - Intended value
149 *
150 * @return - Updated value of the property
151 */
152 bool occActive(bool value) override;
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530153
Gunnar Mills94df8c92018-09-14 14:50:03 -0500154 /** @brief Starts OCC error detection */
155 inline void addErrorWatch()
156 {
157 return device.addErrorWatch();
158 }
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530159
Gunnar Mills94df8c92018-09-14 14:50:03 -0500160 /** @brief Stops OCC error detection */
161 inline void removeErrorWatch()
162 {
163 return device.removeErrorWatch();
164 }
Eddie Jamesdae2d942017-12-20 10:50:03 -0600165
Gunnar Mills94df8c92018-09-14 14:50:03 -0500166 /** @brief Starts to watch how many OCCs are present on the master */
167 inline void addPresenceWatchMaster()
168 {
169 return device.addPresenceWatchMaster();
170 }
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530171
Chicago Duanbb895cb2021-06-18 19:37:16 +0800172 /** @brief Gets the occ instance number */
173 unsigned int getOccInstanceID()
174 {
175 return instance;
176 }
177
178 /** @brief Is this OCC the master OCC */
179 bool isMasterOcc()
180 {
181 return device.master();
182 }
183
Chris Caina8857c52021-01-27 11:53:05 -0600184 /** @brief Read OCC state (will trigger kernel to poll the OCC) */
185 void readOccState();
186
Eddie James9789e712022-05-25 15:43:40 -0500187 /** @brief Called when device errors are detected
188 *
189 * @param[in] d - description of the error that occurred
190 */
191 void deviceError(Error::Descriptor d = Error::Descriptor());
Eddie Jamescbad2192021-10-07 09:39:39 -0500192
Chris Cain78e86012021-03-04 16:15:31 -0600193#ifdef POWER10
194 /** @brief Handle additional tasks when the OCCs reach active state */
195 void occsWentActive();
196
Chris Cain17257672021-10-22 13:41:03 -0500197 /** @brief Send Ambient & Altitude data to OCC
198 *
199 * @param[in] ambient - temperature to send (0xFF will force read
200 * of current temperature and altitude)
201 * @param[in] altitude - altitude to send (0xFFFF = unavailable)
202 *
203 * @return SUCCESS on success
204 */
205 CmdStatus sendAmbient(const uint8_t ambient = 0xFF,
206 const uint16_t altitude = 0xFFFF);
Chris Cain733b2012022-05-04 11:54:06 -0500207
208 /** @brief Set flag indicating if PLDM sensor has been received
209 *
210 * @param[in] wasReceived - true if PLDM sensor was read
211 */
212 void setPldmSensorReceived(const bool wasReceived)
213 {
214 pldmSensorStateReceived = wasReceived;
215 }
216
217 /** @brief Read flag indicating if PLDM sensor has been read
218 *
219 * @return true if sensor has been read
220 */
221 bool getPldmSensorReceived()
222 {
223 return pldmSensorStateReceived;
224 }
225
Chris Cain78e86012021-03-04 16:15:31 -0600226#endif // POWER10
227
Chris Cain5d66a0a2022-02-09 08:52:10 -0600228 /** @brief Return the HWMON path for this OCC
229 *
230 * @return path or empty path if not found
231 */
Chris Caine2d0a432022-03-28 11:08:49 -0500232 fs::path getHwmonPath();
Chris Cain5d66a0a2022-02-09 08:52:10 -0600233
Gunnar Mills94df8c92018-09-14 14:50:03 -0500234 private:
Gunnar Mills94df8c92018-09-14 14:50:03 -0500235 /** @brief OCC dbus object path */
236 std::string path;
Vishwanatha Subbanna32e84e92017-06-28 19:17:28 +0530237
Gunnar Mills94df8c92018-09-14 14:50:03 -0500238 /** @brief Callback handler to be invoked during property change.
239 * This is a handler in Manager class
240 */
Sheldon Bailey373af752022-02-21 15:14:00 -0600241 std::function<void(instanceID, bool)> managerCallBack;
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530242
Gunnar Mills94df8c92018-09-14 14:50:03 -0500243 /** @brief OCC instance number. Ex, 0,1, etc */
Chris Caina8857c52021-01-27 11:53:05 -0600244 unsigned int instance;
245
246 /** @brief The last state read from the OCC */
247 unsigned int lastState = 0;
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +0530248
Sheldon Bailey373af752022-02-21 15:14:00 -0600249 /** @brief Number of retry attempts to open file and update state. */
250 const unsigned int occReadRetries = 1;
251
252 /** @brief Current number of retries attempted towards occReadRetries. */
253 size_t currentOccReadRetriesCount = 0;
254
255 /** @brief The Trigger to indicate OCC State is valid or not. */
256 bool stateValid = false;
257
Alexander Filippov1d69e192019-03-21 18:12:07 +0300258 /** @brief OCC instance to Sensor definitions mapping */
259 static const std::map<instanceID, sensorDefs> sensorMap;
Vishwanatha Subbanna6add0b82017-07-21 19:02:37 +0530260
Chris Cain17257672021-10-22 13:41:03 -0500261 /** @brief OCC manager object */
262 const Manager& manager;
263
Chris Cain36f9cde2021-11-22 11:18:21 -0600264#ifdef POWER10
265 /** @brief OCC PowerMode object */
Chris Cain5d66a0a2022-02-09 08:52:10 -0600266 std::unique_ptr<powermode::PowerMode>& pmode;
Chris Cain36f9cde2021-11-22 11:18:21 -0600267#endif
268
Gunnar Mills94df8c92018-09-14 14:50:03 -0500269 /** @brief OCC device object to do bind and unbind */
270 Device device;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530271
Gunnar Mills94df8c92018-09-14 14:50:03 -0500272 /** @brief Subscribe to host control signal
273 *
274 * Once the OCC reset is requested, BMC sends that message to host.
275 * If the host does not ack the message, then there would be a timeout
276 * and we need to catch that to log an error
277 **/
278 sdbusplus::bus::match_t hostControlSignal;
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530279
Chris Caina8857c52021-01-27 11:53:05 -0600280 /** @brief Command object to send commands to the OCC */
281 OccCommand occCmd;
282
Chris Caina7b74dc2021-11-10 17:03:43 -0600283#ifdef POWER10
284 /** @brief timer event */
285 sdeventplus::Event sdpEvent;
286#endif
287
Chris Caine2d0a432022-03-28 11:08:49 -0500288 /** @brief hwmon path for this OCC */
289 fs::path hwmonPath;
290
Chris Cain733b2012022-05-04 11:54:06 -0500291 /** @brief flag indicating if the OCC sensor has been received */
292 bool pldmSensorStateReceived = false;
293
Gunnar Mills94df8c92018-09-14 14:50:03 -0500294 /** @brief Callback function on host control signals
295 *
296 * @param[in] msg - Data associated with subscribed signal
297 */
298 void hostControlEvent(sdbusplus::message::message& msg);
Vishwanatha Subbanna30e329a2017-07-24 23:13:14 +0530299
Gunnar Mills94df8c92018-09-14 14:50:03 -0500300 /** @brief Sends a message to host control command handler to reset OCC
301 */
302 void resetOCC();
Alexander Filippov1d69e192019-03-21 18:12:07 +0300303
304 /** @brief Determines the instance ID by specified object path.
305 * @param[in] path Estimated OCC Dbus object path
306 * @return Instance number
307 */
308 static int getInstance(const std::string& path)
309 {
310 return (path.empty() ? 0 : path.back() - '0');
311 }
312
Chris Cain78e86012021-03-04 16:15:31 -0600313#ifdef POWER10
Chris Caina7b74dc2021-11-10 17:03:43 -0600314 /**
315 * @brief Timer that is started when OCC is detected to be in safe mode
316 */
317 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>
318 safeStateDelayTimer;
319
320 /** @brief Callback for timer that is started when OCC was detected to be in
321 * safe mode. Called to verify and then disable and reset the OCCs.
322 */
323 void safeStateDelayExpired();
Sheldon Bailey373af752022-02-21 15:14:00 -0600324
325 /**
326 * @brief Timer that is started when OCC read Valid state failed.
327 */
328 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>
329 occReadStateFailTimer;
330
Chris Cain78e86012021-03-04 16:15:31 -0600331#endif // POWER10
Sheldon Bailey373af752022-02-21 15:14:00 -0600332 /** @brief Callback for timer that is started when OCC state
333 * was not able to be read. Called to attempt another read when needed.
334 */
335 void occReadStateNow();
Chris Cain78e86012021-03-04 16:15:31 -0600336
Alexander Filippov1d69e192019-03-21 18:12:07 +0300337 /** @brief Override the sensor name with name from the definition.
338 * @param[in] estimatedPath - Estimated OCC Dbus object path
339 * @return Fixed OCC DBus object path
340 */
341 static std::string getDbusPath(const std::string& estimatedPath)
342 {
343 if (!estimatedPath.empty())
344 {
345 auto it = sensorMap.find(getInstance(estimatedPath));
346 if (sensorMap.end() != it)
347 {
348 auto& name = std::get<1>(it->second);
349 if (!name.empty() && name != "None")
350 {
George Liuf3a4a692021-12-28 13:59:51 +0800351 auto objectPath = fs::path(estimatedPath);
352 objectPath.replace_filename(name);
353 return objectPath.string();
Alexander Filippov1d69e192019-03-21 18:12:07 +0300354 }
355 }
356 }
357
358 return estimatedPath;
359 }
Tom Joseph00325232020-07-29 17:51:48 +0530360#ifdef PLDM
361 std::function<void(instanceID)> resetCallBack = nullptr;
362#endif
Vishwanatha Subbanna307d80b2017-06-28 15:56:09 +0530363};
364
365} // namespace occ
366} // namespace open_power