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 "utils.hpp" 9 10 #include <org/open_power/Control/Host/server.hpp> 11 #include <org/open_power/OCC/Status/server.hpp> 12 #include <sdbusplus/bus.hpp> 13 #include <sdbusplus/server/object.hpp> 14 15 #include <functional> 16 17 namespace open_power 18 { 19 namespace occ 20 { 21 22 class Manager; 23 namespace Base = sdbusplus::org::open_power::OCC::server; 24 using Interface = sdbusplus::server::object::object<Base::Status>; 25 26 // IPMID's host control application 27 namespace Control = sdbusplus::org::open_power::Control::server; 28 29 // For waiting on signals 30 namespace sdbusRule = sdbusplus::bus::match::rules; 31 32 // OCC status instance. Ex. for "occ0", the instance is 0 33 using instanceID = int; 34 35 // IPMI sensor ID for a given OCC instance 36 using sensorID = uint8_t; 37 38 // Human readable sensor name for DBus tree. E.g. "CPU0_OCC" 39 using sensorName = std::string; 40 41 // OCC sensors definitions in the map 42 using sensorDefs = std::tuple<sensorID, sensorName>; 43 44 // OCC sysfs name prefix 45 const std::string sysfsName = "occ-hwmon"; 46 47 /** @class Status 48 * @brief Implementation of OCC Active Status 49 */ 50 class Status : public Interface 51 { 52 public: 53 Status() = delete; 54 ~Status() = default; 55 Status(const Status&) = delete; 56 Status& operator=(const Status&) = delete; 57 Status(Status&&) = default; 58 Status& operator=(Status&&) = default; 59 60 /** @brief Constructs the Status object and 61 * the underlying device object 62 * 63 * @param[in] event - sd_event unique pointer reference 64 * @param[in] path - DBus object path 65 * @param[in] manager - OCC manager instance 66 * @param[in] callBack - Callback handler to invoke during 67 * property change 68 * @param[in] resetCallBack - callback handler to invoke for resetting the 69 * OCC if PLDM is the host communication 70 * protocol 71 */ 72 Status(EventPtr& event, const char* path, Manager& manager, 73 std::function<void(bool)> callBack = nullptr 74 #ifdef PLDM 75 , 76 std::function<void(instanceID)> resetCallBack = nullptr 77 #endif 78 ) : 79 80 Interface(utils::getBus(), getDbusPath(path).c_str(), true), 81 path(path), callBack(callBack), instance(getInstance(path)), 82 device(event, 83 #ifdef I2C_OCC 84 fs::path(DEV_PATH) / i2c_occ::getI2cDeviceName(path), 85 #else 86 fs::path(DEV_PATH) / 87 fs::path(sysfsName + "." + std::to_string(instance + 1)), 88 #endif 89 manager, *this, instance), 90 hostControlSignal( 91 utils::getBus(), 92 sdbusRule::type::signal() + sdbusRule::member("CommandComplete") + 93 sdbusRule::path("/org/open_power/control/host0") + 94 sdbusRule::interface("org.open_power.Control.Host") + 95 sdbusRule::argN(0, Control::convertForMessage( 96 Control::Host::Command::OCCReset)), 97 std::bind(std::mem_fn(&Status::hostControlEvent), this, 98 std::placeholders::_1)), 99 occCmd(instance, (fs::path(OCC_CONTROL_ROOT) / 100 (std::string(OCC_NAME) + std::to_string(instance))) 101 .c_str()) 102 #ifdef PLDM 103 , 104 resetCallBack(resetCallBack) 105 #endif 106 { 107 // Check to see if we have OCC already bound. If so, just set it 108 if (device.bound()) 109 { 110 this->occActive(true); 111 } 112 113 // Announce that we are ready 114 this->emit_object_added(); 115 } 116 117 /** @brief Since we are overriding the setter-occActive but not the 118 * getter-occActive, we need to have this using in order to 119 * allow passthrough usage of the getter-occActive 120 */ 121 using Base::Status::occActive; 122 123 /** @brief SET OccActive to True or False 124 * 125 * @param[in] value - Intended value 126 * 127 * @return - Updated value of the property 128 */ 129 bool occActive(bool value) override; 130 131 /** @brief Starts OCC error detection */ 132 inline void addErrorWatch() 133 { 134 return device.addErrorWatch(); 135 } 136 137 /** @brief Stops OCC error detection */ 138 inline void removeErrorWatch() 139 { 140 return device.removeErrorWatch(); 141 } 142 143 /** @brief Starts to watch how many OCCs are present on the master */ 144 inline void addPresenceWatchMaster() 145 { 146 return device.addPresenceWatchMaster(); 147 } 148 149 /** @brief Gets the occ instance number */ 150 unsigned int getOccInstanceID() 151 { 152 return instance; 153 } 154 155 /** @brief Is this OCC the master OCC */ 156 bool isMasterOcc() 157 { 158 return device.master(); 159 } 160 161 /** @brief Read OCC state (will trigger kernel to poll the OCC) */ 162 void readOccState(); 163 164 /** @brief Called when device errors are detected */ 165 void deviceError(); 166 167 #ifdef POWER10 168 /** @brief Handle additional tasks when the OCCs reach active state */ 169 void occsWentActive(); 170 171 /** @brief Send mode change command to the master OCC 172 * @return SUCCESS on success 173 */ 174 CmdStatus sendModeChange(); 175 176 /** @brief Send Idle Power Saver config data to the master OCC 177 * @return SUCCESS on success 178 */ 179 CmdStatus sendIpsData(); 180 #endif // POWER10 181 182 private: 183 /** @brief OCC dbus object path */ 184 std::string path; 185 186 /** @brief Callback handler to be invoked during property change. 187 * This is a handler in Manager class 188 */ 189 std::function<void(bool)> callBack; 190 191 /** @brief OCC instance number. Ex, 0,1, etc */ 192 unsigned int instance; 193 194 /** @brief The last state read from the OCC */ 195 unsigned int lastState = 0; 196 197 /** @brief OCC instance to Sensor definitions mapping */ 198 static const std::map<instanceID, sensorDefs> sensorMap; 199 200 /** @brief OCC device object to do bind and unbind */ 201 Device device; 202 203 /** @brief Subscribe to host control signal 204 * 205 * Once the OCC reset is requested, BMC sends that message to host. 206 * If the host does not ack the message, then there would be a timeout 207 * and we need to catch that to log an error 208 **/ 209 sdbusplus::bus::match_t hostControlSignal; 210 211 /** @brief Command object to send commands to the OCC */ 212 OccCommand occCmd; 213 214 /** @brief Callback function on host control signals 215 * 216 * @param[in] msg - Data associated with subscribed signal 217 */ 218 void hostControlEvent(sdbusplus::message::message& msg); 219 220 /** @brief Sends a message to host control command handler to reset OCC 221 */ 222 void resetOCC(); 223 224 /** @brief Determines the instance ID by specified object path. 225 * @param[in] path Estimated OCC Dbus object path 226 * @return Instance number 227 */ 228 static int getInstance(const std::string& path) 229 { 230 return (path.empty() ? 0 : path.back() - '0'); 231 } 232 233 #ifdef POWER10 234 /** @brief Query the current Hypervisor target 235 * @return true if the current Hypervisor target is PowerVM 236 */ 237 bool isPowerVM(); 238 239 /** @brief Get the requested power mode property 240 * @return Power mode 241 */ 242 SysPwrMode getMode(); 243 244 /** @brief Get the Idle Power Saver properties 245 * @return true if IPS is enabled 246 */ 247 bool getIPSParms(uint8_t& enterUtil, uint16_t& enterTime, uint8_t& exitUtil, 248 uint16_t& exitTime); 249 #endif // POWER10 250 251 /** @brief Override the sensor name with name from the definition. 252 * @param[in] estimatedPath - Estimated OCC Dbus object path 253 * @return Fixed OCC DBus object path 254 */ 255 static std::string getDbusPath(const std::string& estimatedPath) 256 { 257 if (!estimatedPath.empty()) 258 { 259 auto it = sensorMap.find(getInstance(estimatedPath)); 260 if (sensorMap.end() != it) 261 { 262 auto& name = std::get<1>(it->second); 263 if (!name.empty() && name != "None") 264 { 265 auto path = fs::path(estimatedPath); 266 path.replace_filename(name); 267 return path.string(); 268 } 269 } 270 } 271 272 return estimatedPath; 273 } 274 #ifdef PLDM 275 std::function<void(instanceID)> resetCallBack = nullptr; 276 #endif 277 }; 278 279 } // namespace occ 280 } // namespace open_power 281