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(), true), 90 path(path), managerCallBack(callBack), instance(getInstance(path)), 91 manager(managerRef), 92 #ifdef POWER10 93 pmode(powerModeRef), 94 #endif 95 device(event, 96 #ifdef I2C_OCC 97 fs::path(DEV_PATH) / i2c_occ::getI2cDeviceName(path), 98 #else 99 fs::path(DEV_PATH) / 100 fs::path(sysfsName + "." + std::to_string(instance + 1)), 101 #endif 102 managerRef, *this, instance), 103 hostControlSignal( 104 utils::getBus(), 105 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, 111 std::placeholders::_1)), 112 occCmd(instance, (fs::path(OCC_CONTROL_ROOT) / 113 (std::string(OCC_NAME) + std::to_string(instance))) 114 .c_str()) 115 #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 occReadStateFailTimer( 122 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>( 123 sdpEvent, std::bind(&Status::occReadStateNow, this))) 124 #endif 125 126 #ifdef PLDM 127 , 128 resetCallBack(resetCallBack) 129 #endif 130 { 131 // Check to see if we have OCC already bound. If so, just set it 132 if (device.bound()) 133 { 134 this->occActive(true); 135 } 136 137 // Announce that we are ready 138 this->emit_object_added(); 139 } 140 141 /** @brief Since we are overriding the setter-occActive but not the 142 * getter-occActive, we need to have this using in order to 143 * allow passthrough usage of the getter-occActive 144 */ 145 using Base::Status::occActive; 146 147 /** @brief SET OccActive to True or False 148 * 149 * @param[in] value - Intended value 150 * 151 * @return - Updated value of the property 152 */ 153 bool occActive(bool value) override; 154 155 /** @brief Starts OCC error detection */ 156 inline void addErrorWatch() 157 { 158 return device.addErrorWatch(); 159 } 160 161 /** @brief Stops OCC error detection */ 162 inline void removeErrorWatch() 163 { 164 return device.removeErrorWatch(); 165 } 166 167 /** @brief Starts to watch how many OCCs are present on the master */ 168 inline void addPresenceWatchMaster() 169 { 170 return device.addPresenceWatchMaster(); 171 } 172 173 /** @brief Gets the occ instance number */ 174 unsigned int getOccInstanceID() 175 { 176 return instance; 177 } 178 179 /** @brief Is this OCC the master OCC */ 180 bool isMasterOcc() 181 { 182 return device.master(); 183 } 184 185 /** @brief Read OCC state (will trigger kernel to poll the OCC) */ 186 void readOccState(); 187 188 /** @brief Called when device errors are detected */ 189 void deviceError(); 190 191 #ifdef POWER10 192 /** @brief Handle additional tasks when the OCCs reach active state */ 193 void occsWentActive(); 194 195 /** @brief Send Ambient & Altitude data to OCC 196 * 197 * @param[in] ambient - temperature to send (0xFF will force read 198 * of current temperature and altitude) 199 * @param[in] altitude - altitude to send (0xFFFF = unavailable) 200 * 201 * @return SUCCESS on success 202 */ 203 CmdStatus sendAmbient(const uint8_t ambient = 0xFF, 204 const uint16_t altitude = 0xFFFF); 205 #endif // POWER10 206 207 /** @brief Return the HWMON path for this OCC 208 * 209 * @return path or empty path if not found 210 */ 211 fs::path getHwmonPath(); 212 213 private: 214 /** @brief OCC dbus object path */ 215 std::string path; 216 217 /** @brief Callback handler to be invoked during property change. 218 * This is a handler in Manager class 219 */ 220 std::function<void(instanceID, bool)> managerCallBack; 221 222 /** @brief OCC instance number. Ex, 0,1, etc */ 223 unsigned int instance; 224 225 /** @brief The last state read from the OCC */ 226 unsigned int lastState = 0; 227 228 /** @brief Number of retry attempts to open file and update state. */ 229 const unsigned int occReadRetries = 1; 230 231 /** @brief Current number of retries attempted towards occReadRetries. */ 232 size_t currentOccReadRetriesCount = 0; 233 234 /** @brief The Trigger to indicate OCC State is valid or not. */ 235 bool stateValid = false; 236 237 /** @brief OCC instance to Sensor definitions mapping */ 238 static const std::map<instanceID, sensorDefs> sensorMap; 239 240 /** @brief OCC manager object */ 241 const Manager& manager; 242 243 #ifdef POWER10 244 /** @brief OCC PowerMode object */ 245 std::unique_ptr<powermode::PowerMode>& pmode; 246 #endif 247 248 /** @brief OCC device object to do bind and unbind */ 249 Device device; 250 251 /** @brief Subscribe to host control signal 252 * 253 * Once the OCC reset is requested, BMC sends that message to host. 254 * If the host does not ack the message, then there would be a timeout 255 * and we need to catch that to log an error 256 **/ 257 sdbusplus::bus::match_t hostControlSignal; 258 259 /** @brief Command object to send commands to the OCC */ 260 OccCommand occCmd; 261 262 #ifdef POWER10 263 /** @brief timer event */ 264 sdeventplus::Event sdpEvent; 265 #endif 266 267 /** @brief hwmon path for this OCC */ 268 fs::path hwmonPath; 269 270 /** @brief Callback function on host control signals 271 * 272 * @param[in] msg - Data associated with subscribed signal 273 */ 274 void hostControlEvent(sdbusplus::message::message& msg); 275 276 /** @brief Sends a message to host control command handler to reset OCC 277 */ 278 void resetOCC(); 279 280 /** @brief Determines the instance ID by specified object path. 281 * @param[in] path Estimated OCC Dbus object path 282 * @return Instance number 283 */ 284 static int getInstance(const std::string& path) 285 { 286 return (path.empty() ? 0 : path.back() - '0'); 287 } 288 289 #ifdef POWER10 290 /** 291 * @brief Timer that is started when OCC is detected to be in safe mode 292 */ 293 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic> 294 safeStateDelayTimer; 295 296 /** @brief Callback for timer that is started when OCC was detected to be in 297 * safe mode. Called to verify and then disable and reset the OCCs. 298 */ 299 void safeStateDelayExpired(); 300 301 /** 302 * @brief Timer that is started when OCC read Valid state failed. 303 */ 304 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic> 305 occReadStateFailTimer; 306 307 #endif // POWER10 308 /** @brief Callback for timer that is started when OCC state 309 * was not able to be read. Called to attempt another read when needed. 310 */ 311 void occReadStateNow(); 312 313 /** @brief Override the sensor name with name from the definition. 314 * @param[in] estimatedPath - Estimated OCC Dbus object path 315 * @return Fixed OCC DBus object path 316 */ 317 static std::string getDbusPath(const std::string& estimatedPath) 318 { 319 if (!estimatedPath.empty()) 320 { 321 auto it = sensorMap.find(getInstance(estimatedPath)); 322 if (sensorMap.end() != it) 323 { 324 auto& name = std::get<1>(it->second); 325 if (!name.empty() && name != "None") 326 { 327 auto objectPath = fs::path(estimatedPath); 328 objectPath.replace_filename(name); 329 return objectPath.string(); 330 } 331 } 332 } 333 334 return estimatedPath; 335 } 336 #ifdef PLDM 337 std::function<void(instanceID)> resetCallBack = nullptr; 338 #endif 339 }; 340 341 } // namespace occ 342 } // namespace open_power 343