blob: 9cdc6fd3cf86d83a21140d75dd66df80e3b5838c [file] [log] [blame]
Deepak Kodihalli557dfb02019-05-12 13:11:17 +05301#include "platform.hpp"
2
Sampa Misraaea5dde2020-08-31 08:33:47 -05003#include "libpldm/entity.h"
4#include "libpldm/state_set.h"
5
Tom Josephb70a1962020-07-13 12:56:31 +05306#include "common/types.hpp"
Deepak Kodihallid130e1a2020-06-17 05:55:32 -05007#include "common/utils.hpp"
Tom Josephc4959c32020-04-20 19:50:16 +05308#include "event_parser.hpp"
Sampa Misra12afe112020-05-25 11:40:44 -05009#include "pdr.hpp"
George Liu456c9a22020-01-13 11:36:22 +080010#include "pdr_numeric_effecter.hpp"
George Liua2870722020-02-11 11:09:30 +080011#include "pdr_state_effecter.hpp"
George Liuadbe1722020-05-09 19:20:19 +080012#include "pdr_state_sensor.hpp"
George Liu362c18d2020-05-14 09:46:36 +080013#include "pdr_utils.hpp"
George Liueccb0c52020-01-14 11:09:56 +080014#include "platform_numeric_effecter.hpp"
George Liu0d7aca82020-03-30 15:01:36 +080015#include "platform_state_effecter.hpp"
George Liu362c18d2020-05-14 09:46:36 +080016#include "platform_state_sensor.hpp"
George Liu83409572019-12-24 18:42:54 +080017
Manojkiran Edacc5f1582021-09-29 17:03:06 +053018#include <config.h>
19
Brad Bishop5079ac42021-08-19 18:35:06 -040020using namespace pldm::utils;
21using namespace pldm::responder::pdr;
22using namespace pldm::responder::pdr_utils;
23
Deepak Kodihalli557dfb02019-05-12 13:11:17 +053024namespace pldm
25{
Deepak Kodihalli557dfb02019-05-12 13:11:17 +053026namespace responder
27{
Sampa Misraa2fa0702019-05-31 01:28:55 -050028namespace platform
29{
30
Deepak Kodihallic682fe22020-03-04 00:42:54 -060031using InternalFailure =
32 sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
33
George Liu1ec85d42020-02-12 16:05:32 +080034static const Json empty{};
35
George Liua2870722020-02-11 11:09:30 +080036void Handler::addDbusObjMaps(
George Liuadbe1722020-05-09 19:20:19 +080037 uint16_t id,
38 std::tuple<pdr_utils::DbusMappings, pdr_utils::DbusValMaps> dbusObj,
39 TypeId typeId)
George Liu1ec85d42020-02-12 16:05:32 +080040{
George Liuadbe1722020-05-09 19:20:19 +080041 if (typeId == TypeId::PLDM_SENSOR_ID)
42 {
43 sensorDbusObjMaps.emplace(id, dbusObj);
44 }
45 else
46 {
47 effecterDbusObjMaps.emplace(id, dbusObj);
48 }
George Liu1ec85d42020-02-12 16:05:32 +080049}
50
George Liua2870722020-02-11 11:09:30 +080051const std::tuple<pdr_utils::DbusMappings, pdr_utils::DbusValMaps>&
George Liuadbe1722020-05-09 19:20:19 +080052 Handler::getDbusObjMaps(uint16_t id, TypeId typeId) const
George Liu1ec85d42020-02-12 16:05:32 +080053{
George Liuadbe1722020-05-09 19:20:19 +080054 if (typeId == TypeId::PLDM_SENSOR_ID)
55 {
56 return sensorDbusObjMaps.at(id);
57 }
58 else
59 {
60 return effecterDbusObjMaps.at(id);
61 }
George Liu1ec85d42020-02-12 16:05:32 +080062}
63
George Liu36e81352020-07-01 14:40:30 +080064void Handler::generate(const pldm::utils::DBusHandler& dBusIntf,
65 const std::string& dir, Repo& repo)
Deepak Kodihallic682fe22020-03-04 00:42:54 -060066{
Deepak Kodihallic6e49c42020-07-01 03:39:27 -050067 if (!fs::exists(dir))
68 {
69 return;
70 }
71
Deepak Kodihallic682fe22020-03-04 00:42:54 -060072 // A map of PDR type to a lambda that handles creation of that PDR type.
73 // The lambda essentially would parse the platform specific PDR JSONs to
74 // generate the PDR structures. This function iterates through the map to
75 // invoke all lambdas, so that all PDR types can be created.
George Liua2870722020-02-11 11:09:30 +080076
77 const std::map<Type, generatePDR> generateHandlers = {
78 {PLDM_STATE_EFFECTER_PDR,
George Liu36e81352020-07-01 14:40:30 +080079 [this](const DBusHandler& dBusIntf, const auto& json,
80 RepoInterface& repo) {
81 pdr_state_effecter::generateStateEffecterPDR<
82 pldm::utils::DBusHandler, Handler>(dBusIntf, json, *this,
83 repo);
George Liu456c9a22020-01-13 11:36:22 +080084 }},
85 {PLDM_NUMERIC_EFFECTER_PDR,
George Liu36e81352020-07-01 14:40:30 +080086 [this](const DBusHandler& dBusIntf, const auto& json,
87 RepoInterface& repo) {
88 pdr_numeric_effecter::generateNumericEffecterPDR<
89 pldm::utils::DBusHandler, Handler>(dBusIntf, json, *this,
90 repo);
George Liuadbe1722020-05-09 19:20:19 +080091 }},
92 {PLDM_STATE_SENSOR_PDR, [this](const DBusHandler& dBusIntf,
93 const auto& json, RepoInterface& repo) {
94 pdr_state_sensor::generateStateSensorPDR<pldm::utils::DBusHandler,
95 Handler>(dBusIntf, json,
96 *this, repo);
George Liua2870722020-02-11 11:09:30 +080097 }}};
Deepak Kodihallic682fe22020-03-04 00:42:54 -060098
99 Type pdrType{};
100 for (const auto& dirEntry : fs::directory_iterator(dir))
101 {
102 try
103 {
104 auto json = readJson(dirEntry.path().string());
105 if (!json.empty())
106 {
George Liu1ec85d42020-02-12 16:05:32 +0800107 auto effecterPDRs = json.value("effecterPDRs", empty);
108 for (const auto& effecter : effecterPDRs)
109 {
110 pdrType = effecter.value("pdrType", 0);
George Liu36e81352020-07-01 14:40:30 +0800111 generateHandlers.at(pdrType)(dBusIntf, effecter, repo);
George Liu1ec85d42020-02-12 16:05:32 +0800112 }
George Liuadbe1722020-05-09 19:20:19 +0800113
114 auto sensorPDRs = json.value("sensorPDRs", empty);
115 for (const auto& sensor : sensorPDRs)
116 {
117 pdrType = sensor.value("pdrType", 0);
118 generateHandlers.at(pdrType)(dBusIntf, sensor, repo);
119 }
Deepak Kodihallic682fe22020-03-04 00:42:54 -0600120 }
121 }
122 catch (const InternalFailure& e)
123 {
124 std::cerr << "PDR config directory does not exist or empty, TYPE= "
125 << pdrType << "PATH= " << dirEntry
126 << " ERROR=" << e.what() << "\n";
127 }
128 catch (const Json::exception& e)
129 {
130 std::cerr << "Failed parsing PDR JSON file, TYPE= " << pdrType
131 << " ERROR=" << e.what() << "\n";
132 pldm::utils::reportError(
133 "xyz.openbmc_project.bmc.pldm.InternalFailure");
134 }
135 catch (const std::exception& e)
136 {
137 std::cerr << "Failed parsing PDR JSON file, TYPE= " << pdrType
138 << " ERROR=" << e.what() << "\n";
139 pldm::utils::reportError(
140 "xyz.openbmc_project.bmc.pldm.InternalFailure");
141 }
142 }
143}
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530144
Deepak Kodihallibc669f12019-11-28 08:52:07 -0600145Response Handler::getPDR(const pldm_msg* request, size_t payloadLength)
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530146{
Pavithra Barithaya99854a72021-09-29 06:58:11 -0500147 if (hostPDRHandler)
148 {
149 if (hostPDRHandler->isHostUp() && oemPlatformHandler != nullptr)
150 {
151 auto rc = oemPlatformHandler->checkBMCState();
152 if (rc != PLDM_SUCCESS)
153 {
154 return ccOnlyResponse(request, PLDM_ERROR_NOT_READY);
155 }
156 }
157 }
158
159 // Build FRU table if not built, since entity association PDR's
160 // are built when the FRU table is constructed.
Tom Joseph33e9c7e2020-06-11 22:09:52 +0530161 if (fruHandler)
162 {
163 fruHandler->buildFRUTable();
164 }
165
George Liud680ae02020-07-17 09:11:14 +0800166 if (!pdrCreated)
167 {
168 generateTerminusLocatorPDR(pdrRepo);
169 generate(*dBusIntf, pdrJsonsDir, pdrRepo);
Sagar Srinivas78a225a2020-08-27 00:52:20 -0500170 if (oemPlatformHandler != nullptr)
171 {
172 oemPlatformHandler->buildOEMPDR(pdrRepo);
173 }
174
George Liud680ae02020-07-17 09:11:14 +0800175 pdrCreated = true;
George Liu5eed8e52020-12-18 11:24:37 +0800176
177 if (dbusToPLDMEventHandler)
178 {
Sampa Misra5fb37d52021-03-06 07:26:00 -0600179 deferredGetPDREvent = std::make_unique<sdeventplus::source::Defer>(
180 event,
181 std::bind(std::mem_fn(&pldm::responder::platform::Handler::
182 _processPostGetPDRActions),
183 this, std::placeholders::_1));
George Liu5eed8e52020-12-18 11:24:37 +0800184 }
George Liud680ae02020-07-17 09:11:14 +0800185 }
186
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530187 Response response(sizeof(pldm_msg_hdr) + PLDM_GET_PDR_MIN_RESP_BYTES, 0);
188 auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
189
190 if (payloadLength != PLDM_GET_PDR_REQ_BYTES)
191 {
George Liufb8611d2019-12-06 10:14:15 +0800192 return CmdHandler::ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530193 }
194
195 uint32_t recordHandle{};
196 uint32_t dataTransferHandle{};
197 uint8_t transferOpFlag{};
198 uint16_t reqSizeBytes{};
199 uint16_t recordChangeNum{};
200
George Liufb8611d2019-12-06 10:14:15 +0800201 auto rc = decode_get_pdr_req(request, payloadLength, &recordHandle,
202 &dataTransferHandle, &transferOpFlag,
203 &reqSizeBytes, &recordChangeNum);
204 if (rc != PLDM_SUCCESS)
205 {
206 return CmdHandler::ccOnlyResponse(request, rc);
207 }
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530208
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530209 uint16_t respSizeBytes{};
210 uint8_t* recordData = nullptr;
211 try
212 {
George Liue53193f2020-02-24 09:23:26 +0800213 pdr_utils::PdrEntry e;
214 auto record = pdr::getRecordByHandle(pdrRepo, recordHandle, e);
215 if (record == NULL)
216 {
217 return CmdHandler::ccOnlyResponse(
218 request, PLDM_PLATFORM_INVALID_RECORD_HANDLE);
219 }
220
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530221 if (reqSizeBytes)
222 {
George Liue53193f2020-02-24 09:23:26 +0800223 respSizeBytes = e.size;
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530224 if (respSizeBytes > reqSizeBytes)
225 {
226 respSizeBytes = reqSizeBytes;
227 }
George Liue53193f2020-02-24 09:23:26 +0800228 recordData = e.data;
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530229 }
230 response.resize(sizeof(pldm_msg_hdr) + PLDM_GET_PDR_MIN_RESP_BYTES +
231 respSizeBytes,
232 0);
233 responsePtr = reinterpret_cast<pldm_msg*>(response.data());
Deepak Kodihalli22b5a7d2020-03-17 23:28:41 -0500234 rc = encode_get_pdr_resp(
235 request->hdr.instance_id, PLDM_SUCCESS, e.handle.nextRecordHandle,
236 0, PLDM_START_AND_END, respSizeBytes, recordData, 0, responsePtr);
George Liufb8611d2019-12-06 10:14:15 +0800237 if (rc != PLDM_SUCCESS)
238 {
239 return ccOnlyResponse(request, rc);
240 }
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530241 }
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530242 catch (const std::exception& e)
243 {
Sampa Misraaa8ae722019-12-12 03:20:40 -0600244 std::cerr << "Error accessing PDR, HANDLE=" << recordHandle
245 << " ERROR=" << e.what() << "\n";
George Liufb8611d2019-12-06 10:14:15 +0800246 return CmdHandler::ccOnlyResponse(request, PLDM_ERROR);
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530247 }
248 return response;
249}
250
Deepak Kodihallibc669f12019-11-28 08:52:07 -0600251Response Handler::setStateEffecterStates(const pldm_msg* request,
252 size_t payloadLength)
Sampa Misraa2fa0702019-05-31 01:28:55 -0500253{
254 Response response(
255 sizeof(pldm_msg_hdr) + PLDM_SET_STATE_EFFECTER_STATES_RESP_BYTES, 0);
256 auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
257 uint16_t effecterId;
258 uint8_t compEffecterCnt;
259 constexpr auto maxCompositeEffecterCnt = 8;
260 std::vector<set_effecter_state_field> stateField(maxCompositeEffecterCnt,
261 {0, 0});
262
263 if ((payloadLength > PLDM_SET_STATE_EFFECTER_STATES_REQ_BYTES) ||
264 (payloadLength < sizeof(effecterId) + sizeof(compEffecterCnt) +
265 sizeof(set_effecter_state_field)))
266 {
George Liufb8611d2019-12-06 10:14:15 +0800267 return CmdHandler::ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
Sampa Misraa2fa0702019-05-31 01:28:55 -0500268 }
269
270 int rc = decode_set_state_effecter_states_req(request, payloadLength,
271 &effecterId, &compEffecterCnt,
272 stateField.data());
273
George Liufb8611d2019-12-06 10:14:15 +0800274 if (rc != PLDM_SUCCESS)
Sampa Misraa2fa0702019-05-31 01:28:55 -0500275 {
George Liufb8611d2019-12-06 10:14:15 +0800276 return CmdHandler::ccOnlyResponse(request, rc);
Sampa Misraa2fa0702019-05-31 01:28:55 -0500277 }
278
George Liufb8611d2019-12-06 10:14:15 +0800279 stateField.resize(compEffecterCnt);
280 const pldm::utils::DBusHandler dBusIntf;
Sampa Misraaea5dde2020-08-31 08:33:47 -0500281 uint16_t entityType{};
282 uint16_t entityInstance{};
283 uint16_t stateSetId{};
284
285 if (isOemStateEffecter(*this, effecterId, compEffecterCnt, entityType,
286 entityInstance, stateSetId) &&
287 oemPlatformHandler != nullptr)
288 {
Sampa Misra3a0e3b92020-10-21 05:58:00 -0500289 rc = oemPlatformHandler->oemSetStateEffecterStatesHandler(
Varsha Kaverappa3fbd39e2020-09-28 01:40:22 -0500290 entityType, entityInstance, stateSetId, compEffecterCnt, stateField,
291 effecterId);
Sampa Misraaea5dde2020-08-31 08:33:47 -0500292 }
293 else
294 {
295 rc = platform_state_effecter::setStateEffecterStatesHandler<
296 pldm::utils::DBusHandler, Handler>(dBusIntf, *this, effecterId,
297 stateField);
298 }
George Liufb8611d2019-12-06 10:14:15 +0800299 if (rc != PLDM_SUCCESS)
300 {
301 return CmdHandler::ccOnlyResponse(request, rc);
302 }
303
304 rc = encode_set_state_effecter_states_resp(request->hdr.instance_id, rc,
305 responsePtr);
306 if (rc != PLDM_SUCCESS)
307 {
308 return ccOnlyResponse(request, rc);
309 }
310
Sampa Misraa2fa0702019-05-31 01:28:55 -0500311 return response;
312}
313
Tom Joseph56e45c52020-03-16 10:01:45 +0530314Response Handler::platformEventMessage(const pldm_msg* request,
315 size_t payloadLength)
316{
317 uint8_t formatVersion{};
318 uint8_t tid{};
319 uint8_t eventClass{};
320 size_t offset{};
321
322 auto rc = decode_platform_event_message_req(
323 request, payloadLength, &formatVersion, &tid, &eventClass, &offset);
324 if (rc != PLDM_SUCCESS)
325 {
326 return CmdHandler::ccOnlyResponse(request, rc);
327 }
328
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500329 if (eventClass == PLDM_HEARTBEAT_TIMER_ELAPSED_EVENT)
Tom Joseph56e45c52020-03-16 10:01:45 +0530330 {
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500331 rc = PLDM_SUCCESS;
Sagar Srinivas79669c92021-04-28 15:43:30 -0500332 if (oemPlatformHandler)
333 {
334 oemPlatformHandler->resetWatchDogTimer();
335 }
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500336 }
337 else
338 {
339 try
Tom Joseph56e45c52020-03-16 10:01:45 +0530340 {
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500341 const auto& handlers = eventHandlers.at(eventClass);
342 for (const auto& handler : handlers)
Tom Joseph56e45c52020-03-16 10:01:45 +0530343 {
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500344 auto rc =
345 handler(request, payloadLength, formatVersion, tid, offset);
346 if (rc != PLDM_SUCCESS)
347 {
348 return CmdHandler::ccOnlyResponse(request, rc);
349 }
Tom Joseph56e45c52020-03-16 10:01:45 +0530350 }
351 }
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500352 catch (const std::out_of_range& e)
353 {
354 return CmdHandler::ccOnlyResponse(request, PLDM_ERROR_INVALID_DATA);
355 }
Tom Joseph56e45c52020-03-16 10:01:45 +0530356 }
Tom Joseph56e45c52020-03-16 10:01:45 +0530357 Response response(
358 sizeof(pldm_msg_hdr) + PLDM_PLATFORM_EVENT_MESSAGE_RESP_BYTES, 0);
359 auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
360
361 rc = encode_platform_event_message_resp(request->hdr.instance_id, rc,
362 PLDM_EVENT_NO_LOGGING, responsePtr);
363 if (rc != PLDM_SUCCESS)
364 {
365 return ccOnlyResponse(request, rc);
366 }
367
368 return response;
369}
370
371int Handler::sensorEvent(const pldm_msg* request, size_t payloadLength,
Tom Josephc4959c32020-04-20 19:50:16 +0530372 uint8_t /*formatVersion*/, uint8_t tid,
Tom Joseph56e45c52020-03-16 10:01:45 +0530373 size_t eventDataOffset)
374{
375 uint16_t sensorId{};
376 uint8_t eventClass{};
377 size_t eventClassDataOffset{};
378 auto eventData =
379 reinterpret_cast<const uint8_t*>(request->payload) + eventDataOffset;
380 auto eventDataSize = payloadLength - eventDataOffset;
381
382 auto rc = decode_sensor_event_data(eventData, eventDataSize, &sensorId,
383 &eventClass, &eventClassDataOffset);
384 if (rc != PLDM_SUCCESS)
385 {
386 return rc;
387 }
388
Zahed Hossain75330f32020-03-24 02:15:03 -0500389 auto eventClassData = reinterpret_cast<const uint8_t*>(request->payload) +
390 eventDataOffset + eventClassDataOffset;
391 auto eventClassDataSize =
392 payloadLength - eventDataOffset - eventClassDataOffset;
393
Tom Joseph56e45c52020-03-16 10:01:45 +0530394 if (eventClass == PLDM_STATE_SENSOR_STATE)
395 {
396 uint8_t sensorOffset{};
397 uint8_t eventState{};
398 uint8_t previousEventState{};
399
Zahed Hossain75330f32020-03-24 02:15:03 -0500400 rc = decode_state_sensor_data(eventClassData, eventClassDataSize,
Tom Joseph56e45c52020-03-16 10:01:45 +0530401 &sensorOffset, &eventState,
402 &previousEventState);
Zahed Hossain75330f32020-03-24 02:15:03 -0500403 if (rc != PLDM_SUCCESS)
404 {
405 return PLDM_ERROR;
406 }
407
Chicago Duanfe4d88b2020-06-12 16:44:13 +0800408 // Emitting state sensor event signal
409 emitStateSensorEventSignal(tid, sensorId, sensorOffset, eventState,
410 previousEventState);
411
Tom Josephc4959c32020-04-20 19:50:16 +0530412 // If there are no HOST PDR's, there is no further action
413 if (hostPDRHandler == NULL)
414 {
415 return PLDM_SUCCESS;
416 }
417
418 // Handle PLDM events for which PDR is available
419 SensorEntry sensorEntry{tid, sensorId};
Tom Josephb70a1962020-07-13 12:56:31 +0530420
421 pldm::pdr::EntityInfo entityInfo{};
422 pldm::pdr::CompositeSensorStates compositeSensorStates{};
423
Tom Josephc4959c32020-04-20 19:50:16 +0530424 try
425 {
Tom Josephb70a1962020-07-13 12:56:31 +0530426 std::tie(entityInfo, compositeSensorStates) =
Tom Josephc4959c32020-04-20 19:50:16 +0530427 hostPDRHandler->lookupSensorInfo(sensorEntry);
Tom Josephc4959c32020-04-20 19:50:16 +0530428 }
Tom Josephc4959c32020-04-20 19:50:16 +0530429 catch (const std::out_of_range& e)
430 {
Tom Josephb70a1962020-07-13 12:56:31 +0530431 // If there is no mapping for tid, sensorId combination, try
432 // PLDM_TID_RESERVED, sensorId for terminus that is yet to
433 // implement TL PDR.
434 try
435 {
436 sensorEntry.terminusID = PLDM_TID_RESERVED;
437 std::tie(entityInfo, compositeSensorStates) =
438 hostPDRHandler->lookupSensorInfo(sensorEntry);
439 }
440 // If there is no mapping for events return PLDM_SUCCESS
441 catch (const std::out_of_range& e)
442 {
443 return PLDM_SUCCESS;
444 }
Zahed Hossain75330f32020-03-24 02:15:03 -0500445 }
Tom Josephb70a1962020-07-13 12:56:31 +0530446
447 if (sensorOffset >= compositeSensorStates.size())
448 {
449 return PLDM_ERROR_INVALID_DATA;
450 }
451
452 const auto& possibleStates = compositeSensorStates[sensorOffset];
453 if (possibleStates.find(eventState) == possibleStates.end())
454 {
455 return PLDM_ERROR_INVALID_DATA;
456 }
457
458 const auto& [containerId, entityType, entityInstance] = entityInfo;
459 events::StateSensorEntry stateSensorEntry{containerId, entityType,
460 entityInstance, sensorOffset};
Pavithra Barithaya3aec9972020-12-14 01:55:44 -0600461 return hostPDRHandler->handleStateSensorEvent(stateSensorEntry,
462 eventState);
Tom Joseph56e45c52020-03-16 10:01:45 +0530463 }
464 else
465 {
466 return PLDM_ERROR_INVALID_DATA;
467 }
468
469 return PLDM_SUCCESS;
470}
471
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500472int Handler::pldmPDRRepositoryChgEvent(const pldm_msg* request,
473 size_t payloadLength,
474 uint8_t /*formatVersion*/,
475 uint8_t /*tid*/, size_t eventDataOffset)
476{
477 uint8_t eventDataFormat{};
478 uint8_t numberOfChangeRecords{};
479 size_t dataOffset{};
480
481 auto eventData =
482 reinterpret_cast<const uint8_t*>(request->payload) + eventDataOffset;
483 auto eventDataSize = payloadLength - eventDataOffset;
484
485 auto rc = decode_pldm_pdr_repository_chg_event_data(
486 eventData, eventDataSize, &eventDataFormat, &numberOfChangeRecords,
487 &dataOffset);
488 if (rc != PLDM_SUCCESS)
489 {
490 return rc;
491 }
492
493 PDRRecordHandles pdrRecordHandles;
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -0500494
495 if (eventDataFormat == FORMAT_IS_PDR_TYPES)
496 {
497 return PLDM_ERROR_INVALID_DATA;
498 }
499
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500500 if (eventDataFormat == FORMAT_IS_PDR_HANDLES)
501 {
502 uint8_t eventDataOperation{};
503 uint8_t numberOfChangeEntries{};
504
505 auto changeRecordData = eventData + dataOffset;
506 auto changeRecordDataSize = eventDataSize - dataOffset;
507
508 while (changeRecordDataSize)
509 {
510 rc = decode_pldm_pdr_repository_change_record_data(
511 changeRecordData, changeRecordDataSize, &eventDataOperation,
512 &numberOfChangeEntries, &dataOffset);
513
514 if (rc != PLDM_SUCCESS)
515 {
516 return rc;
517 }
518
519 if (eventDataOperation == PLDM_RECORDS_ADDED)
520 {
521 rc = getPDRRecordHandles(
522 reinterpret_cast<const ChangeEntry*>(changeRecordData +
523 dataOffset),
524 changeRecordDataSize - dataOffset,
525 static_cast<size_t>(numberOfChangeEntries),
526 pdrRecordHandles);
527
528 if (rc != PLDM_SUCCESS)
529 {
530 return rc;
531 }
532 }
533
Pavithra Barithaya841ee3d2021-09-09 04:08:34 -0500534 if (eventDataOperation == PLDM_RECORDS_MODIFIED)
535 {
536 return PLDM_ERROR_UNSUPPORTED_PLDM_CMD;
537 }
538
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500539 changeRecordData +=
540 dataOffset + (numberOfChangeEntries * sizeof(ChangeEntry));
541 changeRecordDataSize -=
542 dataOffset + (numberOfChangeEntries * sizeof(ChangeEntry));
543 }
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500544 }
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -0500545 if (hostPDRHandler)
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500546 {
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -0500547 hostPDRHandler->fetchPDR(std::move(pdrRecordHandles));
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500548 }
549
550 return PLDM_SUCCESS;
551}
552
553int Handler::getPDRRecordHandles(const ChangeEntry* changeEntryData,
554 size_t changeEntryDataSize,
555 size_t numberOfChangeEntries,
556 PDRRecordHandles& pdrRecordHandles)
557{
558 if (numberOfChangeEntries > (changeEntryDataSize / sizeof(ChangeEntry)))
559 {
560 return PLDM_ERROR_INVALID_DATA;
561 }
562 for (size_t i = 0; i < numberOfChangeEntries; i++)
563 {
564 pdrRecordHandles.push_back(changeEntryData[i]);
565 }
566 return PLDM_SUCCESS;
567}
568
George Liueccb0c52020-01-14 11:09:56 +0800569Response Handler::setNumericEffecterValue(const pldm_msg* request,
570 size_t payloadLength)
571{
572 Response response(sizeof(pldm_msg_hdr) +
573 PLDM_SET_NUMERIC_EFFECTER_VALUE_RESP_BYTES);
574 uint16_t effecterId{};
575 uint8_t effecterDataSize{};
576 uint8_t effecterValue[4] = {};
577
578 if ((payloadLength > sizeof(effecterId) + sizeof(effecterDataSize) +
579 sizeof(union_effecter_data_size)) ||
580 (payloadLength < sizeof(effecterId) + sizeof(effecterDataSize) + 1))
581 {
582 return ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
583 }
584
585 int rc = decode_set_numeric_effecter_value_req(
586 request, payloadLength, &effecterId, &effecterDataSize,
587 reinterpret_cast<uint8_t*>(&effecterValue));
588
589 if (rc == PLDM_SUCCESS)
590 {
591 const pldm::utils::DBusHandler dBusIntf;
592 rc = platform_numeric_effecter::setNumericEffecterValueHandler<
593 pldm::utils::DBusHandler, Handler>(dBusIntf, *this, effecterId,
594 effecterDataSize, effecterValue,
595 sizeof(effecterValue));
596 }
597
598 return ccOnlyResponse(request, rc);
599}
600
Sampa Misra12afe112020-05-25 11:40:44 -0500601void Handler::generateTerminusLocatorPDR(Repo& repo)
602{
603 std::vector<uint8_t> pdrBuffer(sizeof(pldm_terminus_locator_pdr));
604
605 auto pdr = reinterpret_cast<pldm_terminus_locator_pdr*>(pdrBuffer.data());
606
607 pdr->hdr.record_handle = 0;
608 pdr->hdr.version = 1;
609 pdr->hdr.type = PLDM_TERMINUS_LOCATOR_PDR;
610 pdr->hdr.record_change_num = 0;
611 pdr->hdr.length = sizeof(pldm_terminus_locator_pdr) - sizeof(pldm_pdr_hdr);
Manojkiran Edacc5f1582021-09-29 17:03:06 +0530612 pdr->terminus_handle = TERMINUS_HANDLE;
Sampa Misra12afe112020-05-25 11:40:44 -0500613 pdr->validity = PLDM_TL_PDR_VALID;
Manojkiran Edacc5f1582021-09-29 17:03:06 +0530614 pdr->tid = TERMINUS_ID;
Sampa Misra12afe112020-05-25 11:40:44 -0500615 pdr->container_id = 0x0;
616 pdr->terminus_locator_type = PLDM_TERMINUS_LOCATOR_TYPE_MCTP_EID;
617 pdr->terminus_locator_value_size =
618 sizeof(pldm_terminus_locator_type_mctp_eid);
619 auto locatorValue = reinterpret_cast<pldm_terminus_locator_type_mctp_eid*>(
620 pdr->terminus_locator_value);
621 locatorValue->eid = BmcMctpEid;
622
623 PdrEntry pdrEntry{};
624 pdrEntry.data = pdrBuffer.data();
625 pdrEntry.size = pdrBuffer.size();
626 repo.addRecord(pdrEntry);
627}
George Liu362c18d2020-05-14 09:46:36 +0800628
629Response Handler::getStateSensorReadings(const pldm_msg* request,
630 size_t payloadLength)
631{
632 uint16_t sensorId{};
633 bitfield8_t sensorRearm{};
634 uint8_t reserved{};
635
636 if (payloadLength != PLDM_GET_SENSOR_READING_REQ_BYTES)
637 {
638 return ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
639 }
640
641 int rc = decode_get_state_sensor_readings_req(
642 request, payloadLength, &sensorId, &sensorRearm, &reserved);
643
644 if (rc != PLDM_SUCCESS)
645 {
646 return ccOnlyResponse(request, rc);
647 }
648
649 // 0x01 to 0x08
George Liuc1230ca2021-08-03 16:06:50 +0800650 uint8_t sensorRearmCount = std::popcount(sensorRearm.byte);
Sampa Misraaea5dde2020-08-31 08:33:47 -0500651 std::vector<get_sensor_state_field> stateField(sensorRearmCount);
George Liu362c18d2020-05-14 09:46:36 +0800652 uint8_t comSensorCnt{};
653 const pldm::utils::DBusHandler dBusIntf;
Sampa Misraaea5dde2020-08-31 08:33:47 -0500654
655 uint16_t entityType{};
656 uint16_t entityInstance{};
657 uint16_t stateSetId{};
658
659 if (isOemStateSensor(*this, sensorId, sensorRearmCount, comSensorCnt,
660 entityType, entityInstance, stateSetId) &&
661 oemPlatformHandler != nullptr)
662 {
663 rc = oemPlatformHandler->getOemStateSensorReadingsHandler(
664 entityType, entityInstance, stateSetId, comSensorCnt, stateField);
665 }
666 else
667 {
668 rc = platform_state_sensor::getStateSensorReadingsHandler<
669 pldm::utils::DBusHandler, Handler>(dBusIntf, *this, sensorId,
670 sensorRearmCount, comSensorCnt,
671 stateField);
672 }
George Liu362c18d2020-05-14 09:46:36 +0800673
674 if (rc != PLDM_SUCCESS)
675 {
676 return ccOnlyResponse(request, rc);
677 }
678
679 Response response(sizeof(pldm_msg_hdr) +
680 PLDM_GET_STATE_SENSOR_READINGS_MIN_RESP_BYTES +
681 sizeof(get_sensor_state_field) * comSensorCnt);
682 auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
683 rc = encode_get_state_sensor_readings_resp(request->hdr.instance_id, rc,
684 comSensorCnt, stateField.data(),
685 responsePtr);
686 if (rc != PLDM_SUCCESS)
687 {
688 return ccOnlyResponse(request, rc);
689 }
690
691 return response;
692}
693
Pavithra Barithaya99854a72021-09-29 06:58:11 -0500694void Handler::_processPostGetPDRActions(sdeventplus::source::EventBase&
695 /*source */)
Sampa Misra5fb37d52021-03-06 07:26:00 -0600696{
697 deferredGetPDREvent.reset();
698 dbusToPLDMEventHandler->listenSensorEvent(pdrRepo, sensorDbusObjMaps);
699}
700
Sampa Misraaea5dde2020-08-31 08:33:47 -0500701bool isOemStateSensor(Handler& handler, uint16_t sensorId,
702 uint8_t sensorRearmCount, uint8_t& compSensorCnt,
703 uint16_t& entityType, uint16_t& entityInstance,
704 uint16_t& stateSetId)
705{
706 pldm_state_sensor_pdr* pdr = nullptr;
707
708 std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> stateSensorPdrRepo(
709 pldm_pdr_init(), pldm_pdr_destroy);
710 Repo stateSensorPDRs(stateSensorPdrRepo.get());
711 getRepoByType(handler.getRepo(), stateSensorPDRs, PLDM_STATE_SENSOR_PDR);
712 if (stateSensorPDRs.empty())
713 {
714 std::cerr << "Failed to get record by PDR type\n";
715 return false;
716 }
717
718 PdrEntry pdrEntry{};
719 auto pdrRecord = stateSensorPDRs.getFirstRecord(pdrEntry);
720 while (pdrRecord)
721 {
722 pdr = reinterpret_cast<pldm_state_sensor_pdr*>(pdrEntry.data);
723 assert(pdr != NULL);
724 if (pdr->sensor_id != sensorId)
725 {
726 pdr = nullptr;
727 pdrRecord = stateSensorPDRs.getNextRecord(pdrRecord, pdrEntry);
728 continue;
729 }
730 auto tmpEntityType = pdr->entity_type;
731 auto tmpEntityInstance = pdr->entity_instance;
732 auto tmpCompSensorCnt = pdr->composite_sensor_count;
733 auto tmpPossibleStates =
734 reinterpret_cast<state_sensor_possible_states*>(
735 pdr->possible_states);
736 auto tmpStateSetId = tmpPossibleStates->state_set_id;
737
738 if (sensorRearmCount > tmpCompSensorCnt)
739 {
740 std::cerr << "The requester sent wrong sensorRearm"
741 << " count for the sensor, SENSOR_ID=" << sensorId
742 << "SENSOR_REARM_COUNT=" << (uint16_t)sensorRearmCount
743 << "\n";
744 break;
745 }
746
747 if ((tmpEntityType >= PLDM_OEM_ENTITY_TYPE_START &&
748 tmpEntityType <= PLDM_OEM_ENTITY_TYPE_END) ||
749 (tmpStateSetId >= PLDM_OEM_STATE_SET_ID_START &&
750 tmpStateSetId < PLDM_OEM_STATE_SET_ID_END))
751 {
752 entityType = tmpEntityType;
753 entityInstance = tmpEntityInstance;
754 stateSetId = tmpStateSetId;
755 compSensorCnt = tmpCompSensorCnt;
756 return true;
757 }
758 else
759 {
760 return false;
761 }
762 }
763 return false;
764}
765
766bool isOemStateEffecter(Handler& handler, uint16_t effecterId,
767 uint8_t compEffecterCnt, uint16_t& entityType,
768 uint16_t& entityInstance, uint16_t& stateSetId)
769{
770 pldm_state_effecter_pdr* pdr = nullptr;
771
772 std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> stateEffecterPdrRepo(
773 pldm_pdr_init(), pldm_pdr_destroy);
774 Repo stateEffecterPDRs(stateEffecterPdrRepo.get());
775 getRepoByType(handler.getRepo(), stateEffecterPDRs,
776 PLDM_STATE_EFFECTER_PDR);
777 if (stateEffecterPDRs.empty())
778 {
779 std::cerr << "Failed to get record by PDR type\n";
780 return false;
781 }
782
783 PdrEntry pdrEntry{};
784 auto pdrRecord = stateEffecterPDRs.getFirstRecord(pdrEntry);
785 while (pdrRecord)
786 {
787 pdr = reinterpret_cast<pldm_state_effecter_pdr*>(pdrEntry.data);
788 assert(pdr != NULL);
789 if (pdr->effecter_id != effecterId)
790 {
791 pdr = nullptr;
792 pdrRecord = stateEffecterPDRs.getNextRecord(pdrRecord, pdrEntry);
793 continue;
794 }
795
796 auto tmpEntityType = pdr->entity_type;
797 auto tmpEntityInstance = pdr->entity_instance;
798 auto tmpPossibleStates =
799 reinterpret_cast<state_effecter_possible_states*>(
800 pdr->possible_states);
801 auto tmpStateSetId = tmpPossibleStates->state_set_id;
802
803 if (compEffecterCnt > pdr->composite_effecter_count)
804 {
805 std::cerr << "The requester sent wrong composite effecter"
806 << " count for the effecter, EFFECTER_ID=" << effecterId
807 << "COMP_EFF_CNT=" << (uint16_t)compEffecterCnt << "\n";
808 return false;
809 }
810
811 if ((tmpEntityType >= PLDM_OEM_ENTITY_TYPE_START &&
812 tmpEntityType <= PLDM_OEM_ENTITY_TYPE_END) ||
813 (tmpStateSetId >= PLDM_OEM_STATE_SET_ID_START &&
814 tmpStateSetId < PLDM_OEM_STATE_SET_ID_END))
815 {
816 entityType = tmpEntityType;
817 entityInstance = tmpEntityInstance;
818 stateSetId = tmpStateSetId;
819 return true;
820 }
821 else
822 {
823 return false;
824 }
825 }
826 return false;
827}
828
Deepak Kodihallibc669f12019-11-28 08:52:07 -0600829} // namespace platform
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530830} // namespace responder
831} // namespace pldm