blob: c21cf099f641b90925fd25900daaf3aefe8ea719 [file] [log] [blame]
Sampa Misraaea5dde2020-08-31 08:33:47 -05001#pragma once
2
3#include "common/types.hpp"
4#include "common/utils.hpp"
Sagar Srinivas11ce8d22022-07-28 11:32:34 -05005#include "libpldmresponder/pdr_utils.hpp"
Sampa Misraaea5dde2020-08-31 08:33:47 -05006#include "pldmd/handler.hpp"
7
8namespace pldm
9{
Sampa Misraaea5dde2020-08-31 08:33:47 -050010namespace responder
11{
Sampa Misraaea5dde2020-08-31 08:33:47 -050012namespace oem_platform
13{
Sampa Misraaea5dde2020-08-31 08:33:47 -050014class Handler : public CmdHandler
15{
16 public:
Patrick Williams6da4f912023-05-10 07:50:53 -050017 Handler(const pldm::utils::DBusHandler* dBusIntf) : dBusIntf(dBusIntf) {}
Sampa Misraaea5dde2020-08-31 08:33:47 -050018
19 /** @brief Interface to get the state sensor readings requested by pldm
20 * requester for OEM types. Each specific type should implement a handler
21 * of it's own
22 *
23 * @param[in] entityType - entity type corresponding to the sensor
24 * @param[in] entityInstance - entity instance number
25 * @param[in] stateSetId - state set id
26 * @param[in] compSensorCnt - composite sensor count
27 * @param[out] stateField - The state field data for each of the states,
28 * equal to composite sensor count in number
29 *
30 * @return - Success or failure in getting the states. Returns failure in
31 * terms of PLDM completion codes if fetching atleast one state
32 * fails
33 */
34 virtual int getOemStateSensorReadingsHandler(
Sagar Srinivasd21b57d2023-02-09 22:11:55 -060035 pldm::pdr::EntityType entityType,
36 pldm::pdr::EntityInstance entityInstance,
Brad Bishop5079ac42021-08-19 18:35:06 -040037 pldm::pdr::StateSetId stateSetId,
38 pldm::pdr::CompositeCount compSensorCnt,
Sampa Misraaea5dde2020-08-31 08:33:47 -050039 std::vector<get_sensor_state_field>& stateField) = 0;
40
41 /** @brief Interface to set the effecter requested by pldm requester
42 * for OEM types. Each individual oem type should implement
43 * it's own handler.
44 *
45 * @param[in] entityType - entity type corresponding to the effecter id
46 * @param[in] entityInstance - entity instance
47 * @param[in] stateSetId - state set id
48 * @param[in] compEffecterCnt - composite effecter count
Varsha Kaverappa3fbd39e2020-09-28 01:40:22 -050049 * @param[in] stateField - The state field data for each of the states,
Sampa Misraaea5dde2020-08-31 08:33:47 -050050 * equal to compEffecterCnt in number
Varsha Kaverappa3fbd39e2020-09-28 01:40:22 -050051 * @param[in] effecterId - Effecter id
Sampa Misraaea5dde2020-08-31 08:33:47 -050052 *
53 * @return - Success or failure in setting the states.Returns failure in
54 * terms of PLDM completion codes if atleast one state fails to
55 * be set
56 */
Sampa Misra3a0e3b92020-10-21 05:58:00 -050057 virtual int oemSetStateEffecterStatesHandler(
Varsha Kaverappa3fbd39e2020-09-28 01:40:22 -050058 uint16_t entityType, uint16_t entityInstance, uint16_t stateSetId,
59 uint8_t compEffecterCnt,
60 std::vector<set_effecter_state_field>& stateField,
61 uint16_t effecterId) = 0;
Sampa Misraaea5dde2020-08-31 08:33:47 -050062
Sagar Srinivas78a225a2020-08-27 00:52:20 -050063 /** @brief Interface to generate the OEM PDRs
64 *
65 * @param[in] repo - instance of concrete implementation of Repo
66 */
Sagar Srinivasd21b57d2023-02-09 22:11:55 -060067 virtual void buildOEMPDR(pldm::responder::pdr_utils::Repo& repo) = 0;
Sagar Srinivas78a225a2020-08-27 00:52:20 -050068
Sagar Srinivas7f760b32021-05-12 07:46:56 -050069 /** @brief Interface to check if setEventReceiver is sent to host already.
70 * If sent then then disableWatchDogTimer() would be called to
71 * disable the watchdog timer */
72 virtual void checkAndDisableWatchDog() = 0;
73
Sagar Srinivas79669c92021-04-28 15:43:30 -050074 /** @brief Interface to check if the watchdog timer is running
75 *
76 * @return - true if watchdog is running, false otherwise
77 * */
78 virtual bool watchDogRunning() = 0;
79
80 /** @brief Interface to reset the watchdog timer */
81 virtual void resetWatchDogTimer() = 0;
82
Sagar Srinivas7f760b32021-05-12 07:46:56 -050083 /** @brief Interface to disable the watchdog timer */
84 virtual void disableWatchDogTimer() = 0;
85
86 /** @brief Interface to keep track of how many times setEventReceiver
87 * is sent to host */
88 virtual void countSetEventReceiver() = 0;
89
Pavithra Barithaya99854a72021-09-29 06:58:11 -050090 /** @brief Interface to check the BMC state */
91 virtual int checkBMCState() = 0;
92
Sagar Srinivas3687e2b2023-04-10 05:08:28 -050093 /** @brief Interface to fetch the last BMC record from the PDR repository
94 *
95 * @param[in] repo - pointer to BMC's primary PDR repo
96 *
97 * @return the last BMC record from the repo
98 */
99 virtual const pldm_pdr_record* fetchLastBMCRecord(const pldm_pdr* repo) = 0;
100
101 /** @brief Interface to check if the record handle passed is in remote PDR
102 * record handle range
103 *
104 * @param[in] record_handle - record handle of the PDR
105 *
106 * @return true if record handle passed is in host PDR record handle range
107 */
108 virtual bool checkRecordHandleInRange(const uint32_t& record_handle) = 0;
109
Sampa Misraaea5dde2020-08-31 08:33:47 -0500110 virtual ~Handler() = default;
111
112 protected:
113 const pldm::utils::DBusHandler* dBusIntf;
114};
115
116} // namespace oem_platform
117
Sagar Srinivas11ce8d22022-07-28 11:32:34 -0500118namespace oem_bios
119{
120/** Interface to the oem bios Handler class*/
121class Handler : public CmdHandler
122{
123 public:
124 Handler(const pldm::utils::DBusHandler* dBusIntf) : dBusIntf(dBusIntf) {}
125
126 /** @brief Interface to get the system type information
127 *
128 * @return - the system type information
129 */
130 virtual std::optional<std::string> getPlatformName() = 0;
131
132 virtual ~Handler() = default;
133
134 protected:
135 const pldm::utils::DBusHandler* dBusIntf;
136};
137
138} // namespace oem_bios
139
Sampa Misraaea5dde2020-08-31 08:33:47 -0500140} // namespace responder
141
142} // namespace pldm