1 #pragma once 2 #include "config.h" 3 4 #include "i2c_occ.hpp" 5 #include "occ_command.hpp" 6 #include "occ_device.hpp" 7 #include "occ_events.hpp" 8 #include "powercap.hpp" 9 #include "powermode.hpp" 10 #include "utils.hpp" 11 12 #include <org/open_power/Control/Host/server.hpp> 13 #include <org/open_power/OCC/Status/server.hpp> 14 #include <sdbusplus/bus.hpp> 15 #include <sdbusplus/server/object.hpp> 16 #ifdef POWER10 17 #include <sdeventplus/event.hpp> 18 #include <sdeventplus/utility/timer.hpp> 19 #endif 20 21 #include <functional> 22 23 namespace open_power 24 { 25 namespace occ 26 { 27 28 class Manager; 29 namespace Base = sdbusplus::org::open_power::OCC::server; 30 using Interface = sdbusplus::server::object::object<Base::Status>; 31 32 // IPMID's host control application 33 namespace Control = sdbusplus::org::open_power::Control::server; 34 35 // For waiting on signals 36 namespace sdbusRule = sdbusplus::bus::match::rules; 37 38 // OCC status instance. Ex. for "occ0", the instance is 0 39 using instanceID = unsigned int; 40 41 // IPMI sensor ID for a given OCC instance 42 using sensorID = uint8_t; 43 44 // Human readable sensor name for DBus tree. E.g. "CPU0_OCC" 45 using sensorName = std::string; 46 47 // OCC sensors definitions in the map 48 using sensorDefs = std::tuple<sensorID, sensorName>; 49 50 // OCC sysfs name prefix 51 const std::string sysfsName = "occ-hwmon"; 52 53 /** @class Status 54 * @brief Implementation of OCC Active Status 55 */ 56 class Status : public Interface 57 { 58 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; 65 66 /** @brief Constructs the Status object and 67 * the underlying device object 68 * 69 * @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 74 * @param[in] resetCallBack - callback handler to invoke for resetting the 75 * OCC if PLDM is the host communication 76 * protocol 77 */ 78 Status(EventPtr& event, const char* path, Manager& managerRef, 79 #ifdef POWER10 80 std::unique_ptr<powermode::PowerMode>& powerModeRef, 81 #endif 82 std::function<void(instanceID, bool)> callBack = nullptr 83 #ifdef PLDM 84 , 85 std::function<void(instanceID)> resetCallBack = nullptr 86 #endif 87 ) : 88 89 Interface(utils::getBus(), getDbusPath(path).c_str(), 90 Interface::action::defer_emit), 91 path(path), managerCallBack(callBack), instance(getInstance(path)), 92 manager(managerRef), 93 #ifdef POWER10 94 pmode(powerModeRef), 95 #endif 96 device(event, 97 #ifdef I2C_OCC 98 fs::path(DEV_PATH) / i2c_occ::getI2cDeviceName(path), 99 #else 100 fs::path(DEV_PATH) / 101 fs::path(sysfsName + "." + std::to_string(instance + 1)), 102 #endif 103 managerRef, *this, instance), 104 hostControlSignal( 105 utils::getBus(), 106 sdbusRule::type::signal() + sdbusRule::member("CommandComplete") + 107 sdbusRule::path("/org/open_power/control/host0") + 108 sdbusRule::interface("org.open_power.Control.Host") + 109 sdbusRule::argN(0, Control::convertForMessage( 110 Control::Host::Command::OCCReset)), 111 std::bind(std::mem_fn(&Status::hostControlEvent), this, 112 std::placeholders::_1)), 113 occCmd(instance, (fs::path(OCC_CONTROL_ROOT) / 114 (std::string(OCC_NAME) + std::to_string(instance))) 115 .c_str()) 116 #ifdef POWER10 117 , 118 sdpEvent(sdeventplus::Event::get_default()), 119 safeStateDelayTimer( 120 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>( 121 sdpEvent, std::bind(&Status::safeStateDelayExpired, this))), 122 occReadStateFailTimer( 123 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>( 124 sdpEvent, std::bind(&Status::occReadStateNow, this))) 125 #endif 126 127 #ifdef PLDM 128 , 129 resetCallBack(resetCallBack) 130 #endif 131 { 132 // Check to see if we have OCC already bound. If so, just set it 133 if (device.bound()) 134 { 135 this->occActive(true); 136 } 137 138 // Announce that we are ready 139 this->emit_object_added(); 140 } 141 142 /** @brief Since we are overriding the setter-occActive but not the 143 * getter-occActive, we need to have this using in order to 144 * allow passthrough usage of the getter-occActive 145 */ 146 using Base::Status::occActive; 147 148 /** @brief SET OccActive to True or False 149 * 150 * @param[in] value - Intended value 151 * 152 * @return - Updated value of the property 153 */ 154 bool occActive(bool value) override; 155 156 /** @brief Starts OCC error detection */ 157 inline void addErrorWatch() 158 { 159 return device.addErrorWatch(); 160 } 161 162 /** @brief Stops OCC error detection */ 163 inline void removeErrorWatch() 164 { 165 return device.removeErrorWatch(); 166 } 167 168 /** @brief Starts to watch how many OCCs are present on the master */ 169 inline void addPresenceWatchMaster() 170 { 171 return device.addPresenceWatchMaster(); 172 } 173 174 /** @brief Gets the occ instance number */ 175 unsigned int getOccInstanceID() 176 { 177 return instance; 178 } 179 180 /** @brief Is this OCC the master OCC */ 181 bool isMasterOcc() 182 { 183 return device.master(); 184 } 185 186 /** @brief Read OCC state (will trigger kernel to poll the OCC) */ 187 void readOccState(); 188 189 /** @brief Called when device errors are detected */ 190 void deviceError(); 191 192 #ifdef POWER10 193 /** @brief Handle additional tasks when the OCCs reach active state */ 194 void occsWentActive(); 195 196 /** @brief Send Ambient & Altitude data to OCC 197 * 198 * @param[in] ambient - temperature to send (0xFF will force read 199 * of current temperature and altitude) 200 * @param[in] altitude - altitude to send (0xFFFF = unavailable) 201 * 202 * @return SUCCESS on success 203 */ 204 CmdStatus sendAmbient(const uint8_t ambient = 0xFF, 205 const uint16_t altitude = 0xFFFF); 206 #endif // POWER10 207 208 /** @brief Return the HWMON path for this OCC 209 * 210 * @return path or empty path if not found 211 */ 212 fs::path getHwmonPath(); 213 214 private: 215 /** @brief OCC dbus object path */ 216 std::string path; 217 218 /** @brief Callback handler to be invoked during property change. 219 * This is a handler in Manager class 220 */ 221 std::function<void(instanceID, bool)> managerCallBack; 222 223 /** @brief OCC instance number. Ex, 0,1, etc */ 224 unsigned int instance; 225 226 /** @brief The last state read from the OCC */ 227 unsigned int lastState = 0; 228 229 /** @brief Number of retry attempts to open file and update state. */ 230 const unsigned int occReadRetries = 1; 231 232 /** @brief Current number of retries attempted towards occReadRetries. */ 233 size_t currentOccReadRetriesCount = 0; 234 235 /** @brief The Trigger to indicate OCC State is valid or not. */ 236 bool stateValid = false; 237 238 /** @brief OCC instance to Sensor definitions mapping */ 239 static const std::map<instanceID, sensorDefs> sensorMap; 240 241 /** @brief OCC manager object */ 242 const Manager& manager; 243 244 #ifdef POWER10 245 /** @brief OCC PowerMode object */ 246 std::unique_ptr<powermode::PowerMode>& pmode; 247 #endif 248 249 /** @brief OCC device object to do bind and unbind */ 250 Device device; 251 252 /** @brief Subscribe to host control signal 253 * 254 * Once the OCC reset is requested, BMC sends that message to host. 255 * If the host does not ack the message, then there would be a timeout 256 * and we need to catch that to log an error 257 **/ 258 sdbusplus::bus::match_t hostControlSignal; 259 260 /** @brief Command object to send commands to the OCC */ 261 OccCommand occCmd; 262 263 #ifdef POWER10 264 /** @brief timer event */ 265 sdeventplus::Event sdpEvent; 266 #endif 267 268 /** @brief hwmon path for this OCC */ 269 fs::path hwmonPath; 270 271 /** @brief Callback function on host control signals 272 * 273 * @param[in] msg - Data associated with subscribed signal 274 */ 275 void hostControlEvent(sdbusplus::message::message& msg); 276 277 /** @brief Sends a message to host control command handler to reset OCC 278 */ 279 void resetOCC(); 280 281 /** @brief Determines the instance ID by specified object path. 282 * @param[in] path Estimated OCC Dbus object path 283 * @return Instance number 284 */ 285 static int getInstance(const std::string& path) 286 { 287 return (path.empty() ? 0 : path.back() - '0'); 288 } 289 290 #ifdef POWER10 291 /** 292 * @brief Timer that is started when OCC is detected to be in safe mode 293 */ 294 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic> 295 safeStateDelayTimer; 296 297 /** @brief Callback for timer that is started when OCC was detected to be in 298 * safe mode. Called to verify and then disable and reset the OCCs. 299 */ 300 void safeStateDelayExpired(); 301 302 /** 303 * @brief Timer that is started when OCC read Valid state failed. 304 */ 305 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic> 306 occReadStateFailTimer; 307 308 #endif // POWER10 309 /** @brief Callback for timer that is started when OCC state 310 * was not able to be read. Called to attempt another read when needed. 311 */ 312 void occReadStateNow(); 313 314 /** @brief Override the sensor name with name from the definition. 315 * @param[in] estimatedPath - Estimated OCC Dbus object path 316 * @return Fixed OCC DBus object path 317 */ 318 static std::string getDbusPath(const std::string& estimatedPath) 319 { 320 if (!estimatedPath.empty()) 321 { 322 auto it = sensorMap.find(getInstance(estimatedPath)); 323 if (sensorMap.end() != it) 324 { 325 auto& name = std::get<1>(it->second); 326 if (!name.empty() && name != "None") 327 { 328 auto objectPath = fs::path(estimatedPath); 329 objectPath.replace_filename(name); 330 return objectPath.string(); 331 } 332 } 333 } 334 335 return estimatedPath; 336 } 337 #ifdef PLDM 338 std::function<void(instanceID)> resetCallBack = nullptr; 339 #endif 340 }; 341 342 } // namespace occ 343 } // namespace open_power 344