1 #pragma once 2 #include "occ_events.hpp" 3 #include "occ_status.hpp" 4 #include "utils.hpp" 5 6 #include <libpldm/pldm.h> 7 8 #include <sdbusplus/bus/match.hpp> 9 #include <sdeventplus/event.hpp> 10 #include <sdeventplus/utility/timer.hpp> 11 12 namespace pldm 13 { 14 15 namespace MatchRules = sdbusplus::bus::match::rules; 16 using namespace open_power::occ; 17 18 using CompositeEffecterCount = uint8_t; 19 using EffecterID = uint16_t; 20 using EntityType = uint16_t; 21 using EntityInstance = uint16_t; 22 using EventState = uint8_t; 23 using InstanceToEffecter = std::map<open_power::occ::instanceID, EffecterID>; 24 using PdrList = std::vector<std::vector<uint8_t>>; 25 using SensorID = uint16_t; 26 using SensorOffset = uint8_t; 27 using SensorToInstance = std::map<SensorID, open_power::occ::instanceID>; 28 using TerminusID = uint8_t; 29 30 /** @brief Hardcoded TID */ 31 constexpr TerminusID tid = 0; 32 33 /** @brief OCC instance starts with 0 for example "occ0" */ 34 constexpr open_power::occ::instanceID start = 0; 35 36 /** @brief Hardcoded mctpEid for HBRT */ 37 constexpr mctp_eid_t mctpEid = 10; 38 39 /** @class Interface 40 * 41 * @brief Abstracts the PLDM details related to the OCC 42 */ 43 class Interface 44 { 45 public: 46 Interface() = delete; 47 ~Interface() = default; 48 Interface(const Interface&) = delete; 49 Interface& operator=(const Interface&) = delete; 50 Interface(Interface&&) = delete; 51 Interface& operator=(Interface&&) = delete; 52 53 /** @brief Constructs the PLDM Interface object for OCC functions 54 * 55 * @param[in] callBack - callBack handler to invoke when the OCC state 56 * changes. 57 */ 58 explicit Interface( 59 std::function<bool(open_power::occ::instanceID, bool)> callBack, 60 std::function<void(open_power::occ::instanceID, bool)> sbeCallBack, 61 std::function<void(bool)> safeModeCallBack, EventPtr& event) : 62 callBack(callBack), 63 sbeCallBack(sbeCallBack), safeModeCallBack(safeModeCallBack), 64 event(event), 65 pldmEventSignal( 66 open_power::occ::utils::getBus(), 67 MatchRules::type::signal() + 68 MatchRules::member("StateSensorEvent") + 69 MatchRules::path("/xyz/openbmc_project/pldm") + 70 MatchRules::interface("xyz.openbmc_project.PLDM.Event"), 71 std::bind(std::mem_fn(&Interface::sensorEvent), this, 72 std::placeholders::_1)), 73 hostStateSignal( 74 open_power::occ::utils::getBus(), 75 MatchRules::propertiesChanged("/xyz/openbmc_project/state/host0", 76 "xyz.openbmc_project.State.Host"), 77 std::bind(std::mem_fn(&Interface::hostStateEvent), this, 78 std::placeholders::_1)), 79 sdpEvent(sdeventplus::Event::get_default()), 80 pldmRspTimer( 81 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic>( 82 sdpEvent, std::bind(&Interface::pldmRspExpired, this))) 83 {} 84 85 /** @brief Fetch the state sensor PDRs and populate the cache with 86 * sensorId to OCC/SBE instance mapping information and the sensor 87 * offset for the relevent state set. 88 * 89 * @param[in] stateSetId - the state set ID to look for 90 * @param[out] sensorInstanceMap - map of sensorID to instance 91 * @param[out] sensorOffset - sensor offset of interested state set ID 92 */ 93 void fetchSensorInfo(uint16_t stateSetId, 94 SensorToInstance& sensorInstanceMap, 95 SensorOffset& sensorOffset); 96 97 /** @brief Fetch the OCC/SBE state effecter PDRs and populate the cache 98 * with OCC/SBE instance to EffecterID information. 99 * 100 * @param[in] stateSetId - the state set ID to look for 101 * @param[out] instanceToEffecterMap - map of instance to effecterID 102 * @param[out] count - sensor offset of interested state set ID 103 * @param[out] stateIdPos - position of the stateSetID 104 */ 105 void fetchEffecterInfo(uint16_t stateSetId, 106 InstanceToEffecter& instanceToEffecterMap, 107 CompositeEffecterCount& count, uint8_t& stateIdPos); 108 109 /** @brief Prepare the request for SetStateEffecterStates command 110 * 111 * @param[in] instanceId - PLDM instanceID 112 * @param[in] effecterId - the instance effecter ID 113 * @param[in] effecterCount - compositeEffecterCount for the effecter PDR 114 * @param[in] stateIdPos - position of the stateSetID 115 * @param[in] stateSetValue - the value to set the state set to 116 * 117 * @return PLDM request message to be sent to host for OCC reset or SBE 118 * HRESET, empty response in the case of failure. 119 */ 120 std::vector<uint8_t> 121 prepareSetEffecterReq(uint8_t instanceId, EffecterID effecterId, 122 CompositeEffecterCount effecterCount, 123 uint8_t stateIdPos, uint8_t stateSetValue); 124 125 /** @brief Send the PLDM message to reset the OCC 126 * 127 * @param[in] instanceId - OCC instance to reset 128 * 129 */ 130 void resetOCC(open_power::occ::instanceID occInstanceId); 131 132 /** @brief Send the PLDM message to perform the HRESET 133 * 134 * @param[in] instanceID - SBE instance to HRESET 135 */ 136 void sendHRESET(open_power::occ::instanceID sbeInstanceId); 137 138 /** @brief Check if the OCC active sensor is available 139 * On successful read, the Manager callback will be called to update 140 * the status 141 * 142 * @param[in] instance - OCC instance to check 143 */ 144 void checkActiveSensor(uint8_t instance); 145 146 private: 147 /** @brief Callback handler to be invoked when the state of the OCC 148 * changes 149 */ 150 std::function<bool(open_power::occ::instanceID, bool)> callBack = nullptr; 151 152 /** @brief Callback handler to be invoked when the maintenance state of the 153 * SBE changes 154 */ 155 std::function<void(open_power::occ::instanceID, bool)> sbeCallBack = 156 nullptr; 157 158 /** @brief Callback handler to be invoked when the OCC is in SAFE Mode = 159 * true or when OCCs are in_service = false. 160 */ 161 std::function<void(bool)> safeModeCallBack = nullptr; 162 163 /** @brief reference to sd_event wrapped in unique_ptr */ 164 EventPtr& event; 165 166 /** @brief event source wrapped in unique_ptr */ 167 EventSourcePtr eventSource; 168 169 /** @brief Used to subscribe to D-Bus PLDM StateSensorEvent signal and 170 * processes if the event corresponds to OCC state change. 171 */ 172 sdbusplus::bus::match_t pldmEventSignal; 173 174 /** @brief Used to subscribe for host state change signal */ 175 sdbusplus::bus::match_t hostStateSignal; 176 177 /** @brief PLDM Sensor ID to OCC Instance mapping 178 */ 179 SensorToInstance sensorToOCCInstance; 180 181 /** @brief PLDM Sensor ID to SBE Instance mapping 182 */ 183 SensorToInstance sensorToSBEInstance; 184 185 /** @brief Sensor offset of OCC state set ID 186 * PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS in state sensor PDR. 187 */ 188 SensorOffset OCCSensorOffset = 0; 189 190 /** @brief Sensor offset of the SBE state set ID 191 * PLDM_OEM_IBM_SBE_HRESET_STATE in state sensor PDR. 192 */ 193 SensorOffset SBESensorOffset = 0; 194 195 /** @brief OCC Instance mapping to PLDM Effecter ID 196 */ 197 InstanceToEffecter occInstanceToEffecter; 198 199 /** @brief SBE instance mapping to PLDM Effecter ID 200 */ 201 InstanceToEffecter sbeInstanceToEffecter; 202 203 /** @brief compositeEffecterCount for OCC reset state effecter PDR */ 204 CompositeEffecterCount OCCEffecterCount = 0; 205 206 /** @brief compositeEffecterCount for SBE HRESET state effecter PDR */ 207 CompositeEffecterCount SBEEffecterCount = 0; 208 209 /** @brief Position of Boot/Restart Cause stateSetID in OCC state 210 * effecter PDR 211 */ 212 uint8_t bootRestartPosition = 0; 213 214 /** @brief Position of the SBE maintenance stateSetID in the state 215 * effecter PDR 216 */ 217 uint8_t sbeMaintenanceStatePosition = 0; 218 219 /** @brief OCC instance number for the PLDM message */ 220 uint8_t pldmResponseOcc = 0; 221 222 /** @brief File descriptor for PLDM messages */ 223 int pldmFd = -1; 224 225 /** @brief MCTP instance number used in PLDM requests 226 */ 227 uint8_t mctpInstance{}; 228 229 /** @brief The response for the PLDM request msg is received flag. 230 */ 231 bool pldmResponseReceived = false; 232 233 /** @brief The response for the PLDM request has timed out. 234 */ 235 bool pldmResponseTimeout = false; 236 237 /** @brief timer event */ 238 sdeventplus::Event sdpEvent; 239 240 /** @brief Timer that is started when PLDM command is sent 241 */ 242 sdeventplus::utility::Timer<sdeventplus::ClockId::Monotonic> pldmRspTimer; 243 244 std::set<uint8_t> outstandingHResets; 245 246 /** @brief Callback when PLDM response has not been received within the 247 * timeout period. 248 */ 249 void pldmRspExpired(); 250 251 /** @brief Close the MCTP file */ 252 void pldmClose(); 253 254 /** @brief When the OCC state changes host sends PlatformEventMessage 255 * StateSensorEvent, this function processes the D-Bus signal 256 * with the sensor event information and invokes the callback 257 * to change the OCC state. 258 * 259 * @param[in] msg - data associated with the subscribed signal 260 */ 261 void sensorEvent(sdbusplus::message::message& msg); 262 263 /** @brief When the host state changes and if the CurrentHostState is 264 * xyz.openbmc_project.State.Host.HostState.Off then 265 * the cache of OCC sensors and effecters mapping is cleared. 266 * 267 * @param[in] msg - data associated with the subscribed signal 268 */ 269 void hostStateEvent(sdbusplus::message::message& msg); 270 271 /** @brief Called when it is determined that the Host is not running. 272 * The cache of OCC sensors and effecters mapping is cleared. 273 */ 274 void clearData(); 275 276 /** @brief Check if the PDR cache for PLDM OCC sensors is valid 277 * 278 * @return true if cache is populated and false if the cache is not 279 * populated. 280 */ 281 auto isOCCSensorCacheValid() 282 { 283 return (sensorToOCCInstance.empty() ? false : true); 284 } 285 286 /** @brief Check if the PDR cache for PLDM OCC effecters is valid 287 * 288 * @return true if cache is populated and false if the cache is not 289 * populated. 290 */ 291 auto isPDREffecterCacheValid() 292 { 293 return (occInstanceToEffecter.empty() ? false : true); 294 } 295 296 /** @brief Query PLDM for the MCTP requester instance id 297 * 298 * @param[out] - the instance id 299 * 300 * @return true if the id was found and false if not 301 */ 302 bool getMctpInstanceId(uint8_t& instanceId); 303 304 /** @brief Encode a GetStateSensor command into a PLDM request 305 * @param[in] instance - OCC instance number 306 * @param[in] sensorId - OCC Active sensor ID number 307 * 308 * @return request - The encoded PLDM messsage to be sent 309 */ 310 std::vector<uint8_t> encodeGetStateSensorRequest(uint8_t instance, 311 uint16_t sensorId); 312 /** @brief Send the PLDM request 313 * 314 * @param[in] request - the request data 315 * @param[in] rspExpected - false: no need to wait for the response 316 * true: will need to process response in callback 317 */ 318 void sendPldm(const std::vector<uint8_t>& request, const uint8_t instance, 319 const bool rspExpected = false); 320 321 /** @brief Register a callback function to handle the PLDM response */ 322 void registerPldmRspCallback(); 323 324 /** @brief callback for the PLDM response event 325 * 326 * @param[in] es - Populated event source 327 * @param[in] fd - Associated File descriptor 328 * @param[in] revents - Type of event 329 * @param[in] userData - User data that was passed during registration 330 * 331 * @return - 0 or positive number on success and negative 332 * errno otherwise 333 */ 334 static int pldmRspCallback(sd_event_source* es, int fd, uint32_t revents, 335 void* userData); 336 }; 337 338 } // namespace pldm 339