openbmc/openpower-occ-control/pldm.hpp

29 using namespace open_power::occ;
36 using InstanceToEffecter = std::map<open_power::occ::instanceID, EffecterID>;
40 using SensorToInstance = std::map<SensorID, open_power::occ::instanceID>;
43 /** @brief OCC instance starts with 0 for example "occ0" */
44 constexpr open_power::occ::instanceID start = 0;
54  *  @brief Abstracts the PLDM details related to the OCC
66     /** @brief Constructs the PLDM Interface object for OCC functions
68      *  @param[in] occActiveCallBack - callBack handler to invoke when the OCC
76         std::function<bool(open_power::occ::instanceID, bool)>  in Interface()
78         std::function<void(open_power::occ::instanceID, bool)> sbeCallBack,  in Interface()
83             open_power::occ::utils::getBus(),  in Interface()
91             open_power::occ::utils::getBus(),  in Interface()
118      *         sensorId to OCC/SBE instance mapping information and the sensor
129     /** @brief Fetch the OCC/SBE state effecter PDRs and populate the cache
130      *         with OCC/SBE instance to EffecterID information.
148      *  @return PLDM request message to be sent to host for OCC reset or SBE
155     /** @brief Send the PLDM message to reset the OCC
157      *  @param[in] instanceId - OCC instance to reset
160     void resetOCC(open_power::occ::instanceID occInstanceId);
166     void sendHRESET(open_power::occ::instanceID sbeInstanceId);
168     /** @brief Check if the OCC active sensor is available
172      *  @param[in] instance  - OCC instance to check
191     /** @brief Callback handler to be invoked when the state of the OCC
194     std::function<bool(open_power::occ::instanceID, bool)> occActiveCallBack =
200     std::function<void(open_power::occ::instanceID, bool)> sbeCallBack =
203     /** @brief Callback handler to be invoked when the OCC is in SAFE Mode =
215      *         processes if the event corresponds to OCC state change.
222     /** @brief PLDM Sensor ID to OCC Instance mapping
230     /** @brief Sensor offset of OCC state set ID
240     /** @brief OCC Instance mapping to PLDM Effecter ID
248     /** @brief compositeEffecterCount for OCC reset state effecter PDR */
254     /** @brief Position of Boot/Restart Cause stateSetID in OCC state
264     /** @brief OCC instance number for the PLDM message */
291     /** @brief The instance ID for the OCC/HRESET request */
292     static open_power::occ::instanceID resetInstance;
304                Used to limit traces when there are issues getting OCC status.
316     /** @brief When the OCC state changes host sends PlatformEventMessage
319      *         to change the OCC state.
327      *         the cache of OCC sensors and effecters mapping is cleared.
334      *         The cache of OCC sensors and effecters mapping is cleared.
338     /** @brief Check if the PDR cache for PLDM OCC sensors is valid
348     /** @brief Check if the PDR cache for PLDM OCC effecters is valid
368      *  @param[in] instance - OCC instance number
369      *  @param[in] sensorId - OCC Active sensor ID number
419     /** @brief callback for a OCC / HRESET response event