1ac19bd68SDeepak Kodihalli #pragma once 2ac19bd68SDeepak Kodihalli 3ac19bd68SDeepak Kodihalli #include "libpldm/base.h" 4ac19bd68SDeepak Kodihalli #include "libpldm/platform.h" 5ac19bd68SDeepak Kodihalli 6d130e1a3SDeepak Kodihalli #include "common/types.hpp" 7d130e1a3SDeepak Kodihalli #include "common/utils.hpp" 83aec997cSPavithra Barithaya #include "libpldmresponder/event_parser.hpp" 9ac19bd68SDeepak Kodihalli #include "libpldmresponder/pdr_utils.hpp" 101521f6d1SDeepak Kodihalli #include "pldmd/dbus_impl_requester.hpp" 1174f27c73STom Joseph #include "requester/handler.hpp" 12ac19bd68SDeepak Kodihalli 13ac19bd68SDeepak Kodihalli #include <sdeventplus/event.hpp> 14ac19bd68SDeepak Kodihalli #include <sdeventplus/source/event.hpp> 15ac19bd68SDeepak Kodihalli 167246e0cdSDeepak Kodihalli #include <deque> 17ac19bd68SDeepak Kodihalli #include <map> 18ac19bd68SDeepak Kodihalli #include <memory> 19ac19bd68SDeepak Kodihalli #include <vector> 20ac19bd68SDeepak Kodihalli 21ac19bd68SDeepak Kodihalli namespace pldm 22ac19bd68SDeepak Kodihalli { 23ac19bd68SDeepak Kodihalli 24ac19bd68SDeepak Kodihalli using EntityType = uint16_t; 25ac19bd68SDeepak Kodihalli // vector which would hold the PDR record handle data returned by 26ac19bd68SDeepak Kodihalli // pldmPDRRepositoryChgEvent event data 27ac19bd68SDeepak Kodihalli using ChangeEntry = uint32_t; 287246e0cdSDeepak Kodihalli using PDRRecordHandles = std::deque<ChangeEntry>; 29ac19bd68SDeepak Kodihalli 30ac19bd68SDeepak Kodihalli /** @struct SensorEntry 31ac19bd68SDeepak Kodihalli * 32ac19bd68SDeepak Kodihalli * SensorEntry is a unique key which maps a sensorEventType request in the 33ac19bd68SDeepak Kodihalli * PlatformEventMessage command to a host sensor PDR. This struct is a key 34ac19bd68SDeepak Kodihalli * in a std::map, so implemented operator==and operator<. 35ac19bd68SDeepak Kodihalli */ 36ac19bd68SDeepak Kodihalli struct SensorEntry 37ac19bd68SDeepak Kodihalli { 38ac19bd68SDeepak Kodihalli pdr::TerminusID terminusID; 39ac19bd68SDeepak Kodihalli pdr::SensorID sensorID; 40ac19bd68SDeepak Kodihalli 41ac19bd68SDeepak Kodihalli bool operator==(const SensorEntry& e) const 42ac19bd68SDeepak Kodihalli { 43ac19bd68SDeepak Kodihalli return ((terminusID == e.terminusID) && (sensorID == e.sensorID)); 44ac19bd68SDeepak Kodihalli } 45ac19bd68SDeepak Kodihalli 46ac19bd68SDeepak Kodihalli bool operator<(const SensorEntry& e) const 47ac19bd68SDeepak Kodihalli { 48ac19bd68SDeepak Kodihalli return ((terminusID < e.terminusID) || 49ac19bd68SDeepak Kodihalli ((terminusID == e.terminusID) && (sensorID < e.sensorID))); 50ac19bd68SDeepak Kodihalli } 51ac19bd68SDeepak Kodihalli }; 52ac19bd68SDeepak Kodihalli 53ac19bd68SDeepak Kodihalli using HostStateSensorMap = std::map<SensorEntry, pdr::SensorInfo>; 54868c879aSSampa Misra using PDRList = std::vector<std::vector<uint8_t>>; 55ac19bd68SDeepak Kodihalli 56ac19bd68SDeepak Kodihalli /** @class HostPDRHandler 57ac19bd68SDeepak Kodihalli * @brief This class can fetch and process PDRs from host firmware 58ac19bd68SDeepak Kodihalli * @details Provides an API to fetch PDRs from the host firmware. Upon 59ac19bd68SDeepak Kodihalli * receiving the PDRs, they are stored into the BMC's primary PDR repo. 60ac19bd68SDeepak Kodihalli * Adjustments are made to entity association PDRs received from the host, 61ac19bd68SDeepak Kodihalli * because they need to be assimilated into the BMC's entity association 62ac19bd68SDeepak Kodihalli * tree. A PLDM event containing the record handles of the updated entity 63ac19bd68SDeepak Kodihalli * association PDRs is sent to the host. 64ac19bd68SDeepak Kodihalli */ 65ac19bd68SDeepak Kodihalli class HostPDRHandler 66ac19bd68SDeepak Kodihalli { 67ac19bd68SDeepak Kodihalli public: 68ac19bd68SDeepak Kodihalli HostPDRHandler() = delete; 69ac19bd68SDeepak Kodihalli HostPDRHandler(const HostPDRHandler&) = delete; 70ac19bd68SDeepak Kodihalli HostPDRHandler(HostPDRHandler&&) = delete; 71ac19bd68SDeepak Kodihalli HostPDRHandler& operator=(const HostPDRHandler&) = delete; 72ac19bd68SDeepak Kodihalli HostPDRHandler& operator=(HostPDRHandler&&) = delete; 73ac19bd68SDeepak Kodihalli ~HostPDRHandler() = default; 74ac19bd68SDeepak Kodihalli 75*60e1fe91SManojkiran Eda using TerminusInfo = 76*60e1fe91SManojkiran Eda std::tuple<pdr::TerminusID, pdr::EID, pdr::TerminusValidity>; 77*60e1fe91SManojkiran Eda using TLPDRMap = std::map<pdr::TerminusHandle, TerminusInfo>; 78868c879aSSampa Misra 79ac19bd68SDeepak Kodihalli /** @brief Constructor 80ac19bd68SDeepak Kodihalli * @param[in] mctp_fd - fd of MCTP communications socket 81ac19bd68SDeepak Kodihalli * @param[in] mctp_eid - MCTP EID of host firmware 82ac19bd68SDeepak Kodihalli * @param[in] event - reference of main event loop of pldmd 83ac19bd68SDeepak Kodihalli * @param[in] repo - pointer to BMC's primary PDR repo 843aec997cSPavithra Barithaya * @param[in] eventsJsonDir - directory path which has the config JSONs 8574f27c73STom Joseph * @param[in] entityTree - Pointer to BMC and Host entity association tree 8674f27c73STom Joseph * @param[in] bmcEntityTree - pointer to BMC's entity association tree 87ac19bd68SDeepak Kodihalli * @param[in] requester - reference to Requester object 8874f27c73STom Joseph * @param[in] handler - PLDM request handler 89ac19bd68SDeepak Kodihalli */ 9074f27c73STom Joseph explicit HostPDRHandler( 9174f27c73STom Joseph int mctp_fd, uint8_t mctp_eid, sdeventplus::Event& event, 9274f27c73STom Joseph pldm_pdr* repo, const std::string& eventsJsonsDir, 93ac19bd68SDeepak Kodihalli pldm_entity_association_tree* entityTree, 945079ac4aSBrad Bishop pldm_entity_association_tree* bmcEntityTree, 955079ac4aSBrad Bishop pldm::dbus_api::Requester& requester, 96e5268cdaSTom Joseph pldm::requester::Handler<pldm::requester::Request>* handler); 97ac19bd68SDeepak Kodihalli 98ac19bd68SDeepak Kodihalli /** @brief fetch PDRs from host firmware. See @class. 99ac19bd68SDeepak Kodihalli * @param[in] recordHandles - list of record handles pointing to host's 100ac19bd68SDeepak Kodihalli * PDRs that need to be fetched. 101ac19bd68SDeepak Kodihalli */ 102ac19bd68SDeepak Kodihalli 1037246e0cdSDeepak Kodihalli void fetchPDR(PDRRecordHandles&& recordHandles); 104ac19bd68SDeepak Kodihalli 105ac19bd68SDeepak Kodihalli /** @brief Send a PLDM event to host firmware containing a list of record 106ac19bd68SDeepak Kodihalli * handles of PDRs that the host firmware has to fetch. 107ac19bd68SDeepak Kodihalli * @param[in] pdrTypes - list of PDR types that need to be looked up in the 108ac19bd68SDeepak Kodihalli * BMC repo 109ac19bd68SDeepak Kodihalli * @param[in] eventDataFormat - format for PDRRepositoryChgEvent in DSP0248 110ac19bd68SDeepak Kodihalli */ 111ac19bd68SDeepak Kodihalli void sendPDRRepositoryChgEvent(std::vector<uint8_t>&& pdrTypes, 112ac19bd68SDeepak Kodihalli uint8_t eventDataFormat); 113ac19bd68SDeepak Kodihalli 114ac19bd68SDeepak Kodihalli /** @brief Lookup host sensor info corresponding to requested SensorEntry 115ac19bd68SDeepak Kodihalli * 116ac19bd68SDeepak Kodihalli * @param[in] entry - TerminusID and SensorID 117ac19bd68SDeepak Kodihalli * 118ac19bd68SDeepak Kodihalli * @return SensorInfo corresponding to the input paramter SensorEntry 119ac19bd68SDeepak Kodihalli * throw std::out_of_range exception if not found 120ac19bd68SDeepak Kodihalli */ 121ac19bd68SDeepak Kodihalli const pdr::SensorInfo& lookupSensorInfo(const SensorEntry& entry) const 122ac19bd68SDeepak Kodihalli { 123ac19bd68SDeepak Kodihalli return sensorMap.at(entry); 124ac19bd68SDeepak Kodihalli } 125ac19bd68SDeepak Kodihalli 1263aec997cSPavithra Barithaya /** @brief Handles state sensor event 1273aec997cSPavithra Barithaya * 1283aec997cSPavithra Barithaya * @param[in] entry - state sensor entry 1293aec997cSPavithra Barithaya * @param[in] state - event state 1303aec997cSPavithra Barithaya * 1313aec997cSPavithra Barithaya * @return PLDM completion code 1323aec997cSPavithra Barithaya */ 1335079ac4aSBrad Bishop int handleStateSensorEvent( 1345079ac4aSBrad Bishop const pldm::responder::events::StateSensorEntry& entry, 1353aec997cSPavithra Barithaya pdr::EventState state); 1363aec997cSPavithra Barithaya 137868c879aSSampa Misra /** @brief Parse state sensor PDRs and populate the sensorMap lookup data 138868c879aSSampa Misra * structure 139868c879aSSampa Misra * 140868c879aSSampa Misra * @param[in] stateSensorPDRs - host state sensor PDRs 141868c879aSSampa Misra * 142868c879aSSampa Misra */ 143*60e1fe91SManojkiran Eda void parseStateSensorPDRs(const PDRList& stateSensorPDRs); 144868c879aSSampa Misra 145c0c79481SSampa Misra /** @brief this function sends a GetPDR request to Host firmware. 146c0c79481SSampa Misra * And processes the PDRs based on type 147c0c79481SSampa Misra * 148c0c79481SSampa Misra * @param[in] - nextRecordHandle - the next record handle to ask for 149c0c79481SSampa Misra */ 150c0c79481SSampa Misra void getHostPDR(uint32_t nextRecordHandle = 0); 151c0c79481SSampa Misra 152f9ba8c19SSampa Misra /** @brief set the Host firmware condition when pldmd starts 1536decfc18Ssampmisr */ 154f9ba8c19SSampa Misra void setHostFirmwareCondition(); 1556decfc18Ssampmisr 1564f2538a6SPavithra Barithaya /** @brief set HostSensorStates when pldmd starts or restarts 1574f2538a6SPavithra Barithaya * and updates the D-Bus property 1584f2538a6SPavithra Barithaya * @param[in] stateSensorPDRs - host state sensor PDRs 1594f2538a6SPavithra Barithaya */ 160*60e1fe91SManojkiran Eda void setHostSensorState(const PDRList& stateSensorPDRs); 1614f2538a6SPavithra Barithaya 1626decfc18Ssampmisr /** @brief check whether Host is running when pldmd starts 1636decfc18Ssampmisr */ 1646decfc18Ssampmisr bool isHostUp(); 1656decfc18Ssampmisr 166*60e1fe91SManojkiran Eda /** @brief map that captures various terminus information **/ 167*60e1fe91SManojkiran Eda TLPDRMap tlPDRInfo; 168*60e1fe91SManojkiran Eda 1696decfc18Ssampmisr private: 1706decfc18Ssampmisr /** @brief deferred function to fetch PDR from Host, scheduled to work on 1716decfc18Ssampmisr * the event loop. The PDR exchg with the host is async. 1726decfc18Ssampmisr * @param[in] source - sdeventplus event source 1736decfc18Ssampmisr */ 1746decfc18Ssampmisr void _fetchPDR(sdeventplus::source::EventBase& source); 1756decfc18Ssampmisr 176ac19bd68SDeepak Kodihalli /** @brief Merge host firmware's entity association PDRs into BMC's 177ac19bd68SDeepak Kodihalli * @details A merge operation involves adding a pldm_entity under the 178ac19bd68SDeepak Kodihalli * appropriate parent, and updating container ids. 179ac19bd68SDeepak Kodihalli * @param[in] pdr - entity association pdr 180ac19bd68SDeepak Kodihalli */ 181ac19bd68SDeepak Kodihalli void mergeEntityAssociations(const std::vector<uint8_t>& pdr); 182ac19bd68SDeepak Kodihalli 183ac19bd68SDeepak Kodihalli /** @brief Find parent of input entity type, from the entity association 184ac19bd68SDeepak Kodihalli * tree 185ac19bd68SDeepak Kodihalli * @param[in] type - PLDM entity type 186ac19bd68SDeepak Kodihalli * @param[out] parent - PLDM entity information of parent 187ac19bd68SDeepak Kodihalli * @return bool - true if parent found, false otherwise 188ac19bd68SDeepak Kodihalli */ 189ac19bd68SDeepak Kodihalli bool getParent(EntityType type, pldm_entity& parent); 190ac19bd68SDeepak Kodihalli 191c0c79481SSampa Misra /** @brief process the Host's PDR and add to BMC's PDR repo 192c0c79481SSampa Misra * @param[in] eid - MCTP id of Host 193c0c79481SSampa Misra * @param[in] response - response from Host for GetPDR 194c0c79481SSampa Misra * @param[in] respMsgLen - response message length 195c0c79481SSampa Misra */ 196c0c79481SSampa Misra void processHostPDRs(mctp_eid_t eid, const pldm_msg* response, 197c0c79481SSampa Misra size_t respMsgLen); 198c0c79481SSampa Misra 199c0c79481SSampa Misra /** @brief send PDR Repo change after merging Host's PDR to BMC PDR repo 200c0c79481SSampa Misra * @param[in] source - sdeventplus event source 201c0c79481SSampa Misra */ 202c0c79481SSampa Misra void _processPDRRepoChgEvent(sdeventplus::source::EventBase& source); 203c0c79481SSampa Misra 204c0c79481SSampa Misra /** @brief fetch the next PDR based on the record handle sent by Host 205c0c79481SSampa Misra * @param[in] nextRecordHandle - next record handle 206c0c79481SSampa Misra * @param[in] source - sdeventplus event source 207c0c79481SSampa Misra */ 208c0c79481SSampa Misra void _processFetchPDREvent(uint32_t nextRecordHandle, 209c0c79481SSampa Misra sdeventplus::source::EventBase& source); 210c0c79481SSampa Misra 211ac19bd68SDeepak Kodihalli /** @brief fd of MCTP communications socket */ 212ac19bd68SDeepak Kodihalli int mctp_fd; 213ac19bd68SDeepak Kodihalli /** @brief MCTP EID of host firmware */ 214ac19bd68SDeepak Kodihalli uint8_t mctp_eid; 215ac19bd68SDeepak Kodihalli /** @brief reference of main event loop of pldmd, primarily used to schedule 216ac19bd68SDeepak Kodihalli * work. 217ac19bd68SDeepak Kodihalli */ 218ac19bd68SDeepak Kodihalli sdeventplus::Event& event; 219ac19bd68SDeepak Kodihalli /** @brief pointer to BMC's primary PDR repo, host PDRs are added here */ 220ac19bd68SDeepak Kodihalli pldm_pdr* repo; 2213aec997cSPavithra Barithaya 2225079ac4aSBrad Bishop pldm::responder::events::StateSensorHandler stateSensorHandler; 223c073a20eSSampa Misra /** @brief Pointer to BMC's and Host's entity association tree */ 224ac19bd68SDeepak Kodihalli pldm_entity_association_tree* entityTree; 225c073a20eSSampa Misra 226c073a20eSSampa Misra /** @brief Pointer to BMC's entity association tree */ 227c073a20eSSampa Misra pldm_entity_association_tree* bmcEntityTree; 228c073a20eSSampa Misra 229ac19bd68SDeepak Kodihalli /** @brief reference to Requester object, primarily used to access API to 230ac19bd68SDeepak Kodihalli * obtain PLDM instance id. 231ac19bd68SDeepak Kodihalli */ 2325079ac4aSBrad Bishop pldm::dbus_api::Requester& requester; 23374f27c73STom Joseph 23474f27c73STom Joseph /** @brief PLDM request handler */ 235c0c79481SSampa Misra pldm::requester::Handler<pldm::requester::Request>* handler; 23674f27c73STom Joseph 237ac19bd68SDeepak Kodihalli /** @brief sdeventplus event source */ 238ac19bd68SDeepak Kodihalli std::unique_ptr<sdeventplus::source::Defer> pdrFetchEvent; 239c0c79481SSampa Misra std::unique_ptr<sdeventplus::source::Defer> deferredFetchPDREvent; 240c0c79481SSampa Misra std::unique_ptr<sdeventplus::source::Defer> deferredPDRRepoChgEvent; 241c0c79481SSampa Misra 242ac19bd68SDeepak Kodihalli /** @brief list of PDR record handles pointing to host's PDRs */ 243ac19bd68SDeepak Kodihalli PDRRecordHandles pdrRecordHandles; 244ac19bd68SDeepak Kodihalli /** @brief maps an entity type to parent pldm_entity from the BMC's entity 245ac19bd68SDeepak Kodihalli * association tree 246ac19bd68SDeepak Kodihalli */ 247ac19bd68SDeepak Kodihalli std::map<EntityType, pldm_entity> parents; 248ac19bd68SDeepak Kodihalli /** @brief D-Bus property changed signal match */ 249ac19bd68SDeepak Kodihalli std::unique_ptr<sdbusplus::bus::match::match> hostOffMatch; 250ac19bd68SDeepak Kodihalli 251ac19bd68SDeepak Kodihalli /** @brief sensorMap is a lookup data structure that is build from the 252ac19bd68SDeepak Kodihalli * hostPDR that speeds up the lookup of <TerminusID, SensorID> in 253ac19bd68SDeepak Kodihalli * PlatformEventMessage command request. 254ac19bd68SDeepak Kodihalli */ 255ac19bd68SDeepak Kodihalli HostStateSensorMap sensorMap; 2566decfc18Ssampmisr 2576decfc18Ssampmisr /** @brief whether response received from Host */ 2586decfc18Ssampmisr bool responseReceived; 259ac19bd68SDeepak Kodihalli }; 260ac19bd68SDeepak Kodihalli 261ac19bd68SDeepak Kodihalli } // namespace pldm 262