blob: 73274ac552552eebbf3822e818ceee23c9c8869f [file] [log] [blame]
Deepak Kodihalli557dfb02019-05-12 13:11:17 +05301
2#include "platform.hpp"
3
Sampa Misraaea5dde2020-08-31 08:33:47 -05004#include "libpldm/entity.h"
5#include "libpldm/state_set.h"
6
Tom Josephb70a1962020-07-13 12:56:31 +05307#include "common/types.hpp"
Deepak Kodihallid130e1a2020-06-17 05:55:32 -05008#include "common/utils.hpp"
Tom Josephc4959c32020-04-20 19:50:16 +05309#include "event_parser.hpp"
Sampa Misra12afe112020-05-25 11:40:44 -050010#include "pdr.hpp"
George Liu456c9a22020-01-13 11:36:22 +080011#include "pdr_numeric_effecter.hpp"
George Liua2870722020-02-11 11:09:30 +080012#include "pdr_state_effecter.hpp"
George Liuadbe1722020-05-09 19:20:19 +080013#include "pdr_state_sensor.hpp"
George Liu362c18d2020-05-14 09:46:36 +080014#include "pdr_utils.hpp"
George Liueccb0c52020-01-14 11:09:56 +080015#include "platform_numeric_effecter.hpp"
George Liu0d7aca82020-03-30 15:01:36 +080016#include "platform_state_effecter.hpp"
George Liu362c18d2020-05-14 09:46:36 +080017#include "platform_state_sensor.hpp"
George Liu83409572019-12-24 18:42:54 +080018
Brad Bishop5079ac42021-08-19 18:35:06 -040019using namespace pldm::utils;
20using namespace pldm::responder::pdr;
21using namespace pldm::responder::pdr_utils;
22
Deepak Kodihalli557dfb02019-05-12 13:11:17 +053023namespace pldm
24{
Deepak Kodihalli557dfb02019-05-12 13:11:17 +053025namespace responder
26{
Sampa Misraa2fa0702019-05-31 01:28:55 -050027namespace platform
28{
29
Deepak Kodihallic682fe22020-03-04 00:42:54 -060030using InternalFailure =
31 sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
32
George Liu1ec85d42020-02-12 16:05:32 +080033static const Json empty{};
34
George Liua2870722020-02-11 11:09:30 +080035void Handler::addDbusObjMaps(
George Liuadbe1722020-05-09 19:20:19 +080036 uint16_t id,
37 std::tuple<pdr_utils::DbusMappings, pdr_utils::DbusValMaps> dbusObj,
38 TypeId typeId)
George Liu1ec85d42020-02-12 16:05:32 +080039{
George Liuadbe1722020-05-09 19:20:19 +080040 if (typeId == TypeId::PLDM_SENSOR_ID)
41 {
42 sensorDbusObjMaps.emplace(id, dbusObj);
43 }
44 else
45 {
46 effecterDbusObjMaps.emplace(id, dbusObj);
47 }
George Liu1ec85d42020-02-12 16:05:32 +080048}
49
George Liua2870722020-02-11 11:09:30 +080050const std::tuple<pdr_utils::DbusMappings, pdr_utils::DbusValMaps>&
George Liuadbe1722020-05-09 19:20:19 +080051 Handler::getDbusObjMaps(uint16_t id, TypeId typeId) const
George Liu1ec85d42020-02-12 16:05:32 +080052{
George Liuadbe1722020-05-09 19:20:19 +080053 if (typeId == TypeId::PLDM_SENSOR_ID)
54 {
55 return sensorDbusObjMaps.at(id);
56 }
57 else
58 {
59 return effecterDbusObjMaps.at(id);
60 }
George Liu1ec85d42020-02-12 16:05:32 +080061}
62
George Liu36e81352020-07-01 14:40:30 +080063void Handler::generate(const pldm::utils::DBusHandler& dBusIntf,
64 const std::string& dir, Repo& repo)
Deepak Kodihallic682fe22020-03-04 00:42:54 -060065{
Deepak Kodihallic6e49c42020-07-01 03:39:27 -050066 if (!fs::exists(dir))
67 {
68 return;
69 }
70
Deepak Kodihallic682fe22020-03-04 00:42:54 -060071 // A map of PDR type to a lambda that handles creation of that PDR type.
72 // The lambda essentially would parse the platform specific PDR JSONs to
73 // generate the PDR structures. This function iterates through the map to
74 // invoke all lambdas, so that all PDR types can be created.
George Liua2870722020-02-11 11:09:30 +080075
76 const std::map<Type, generatePDR> generateHandlers = {
77 {PLDM_STATE_EFFECTER_PDR,
George Liu36e81352020-07-01 14:40:30 +080078 [this](const DBusHandler& dBusIntf, const auto& json,
79 RepoInterface& repo) {
80 pdr_state_effecter::generateStateEffecterPDR<
81 pldm::utils::DBusHandler, Handler>(dBusIntf, json, *this,
82 repo);
George Liu456c9a22020-01-13 11:36:22 +080083 }},
84 {PLDM_NUMERIC_EFFECTER_PDR,
George Liu36e81352020-07-01 14:40:30 +080085 [this](const DBusHandler& dBusIntf, const auto& json,
86 RepoInterface& repo) {
87 pdr_numeric_effecter::generateNumericEffecterPDR<
88 pldm::utils::DBusHandler, Handler>(dBusIntf, json, *this,
89 repo);
George Liuadbe1722020-05-09 19:20:19 +080090 }},
91 {PLDM_STATE_SENSOR_PDR, [this](const DBusHandler& dBusIntf,
92 const auto& json, RepoInterface& repo) {
93 pdr_state_sensor::generateStateSensorPDR<pldm::utils::DBusHandler,
94 Handler>(dBusIntf, json,
95 *this, repo);
George Liua2870722020-02-11 11:09:30 +080096 }}};
Deepak Kodihallic682fe22020-03-04 00:42:54 -060097
98 Type pdrType{};
99 for (const auto& dirEntry : fs::directory_iterator(dir))
100 {
101 try
102 {
103 auto json = readJson(dirEntry.path().string());
104 if (!json.empty())
105 {
George Liu1ec85d42020-02-12 16:05:32 +0800106 auto effecterPDRs = json.value("effecterPDRs", empty);
107 for (const auto& effecter : effecterPDRs)
108 {
109 pdrType = effecter.value("pdrType", 0);
George Liu36e81352020-07-01 14:40:30 +0800110 generateHandlers.at(pdrType)(dBusIntf, effecter, repo);
George Liu1ec85d42020-02-12 16:05:32 +0800111 }
George Liuadbe1722020-05-09 19:20:19 +0800112
113 auto sensorPDRs = json.value("sensorPDRs", empty);
114 for (const auto& sensor : sensorPDRs)
115 {
116 pdrType = sensor.value("pdrType", 0);
117 generateHandlers.at(pdrType)(dBusIntf, sensor, repo);
118 }
Deepak Kodihallic682fe22020-03-04 00:42:54 -0600119 }
120 }
121 catch (const InternalFailure& e)
122 {
123 std::cerr << "PDR config directory does not exist or empty, TYPE= "
124 << pdrType << "PATH= " << dirEntry
125 << " ERROR=" << e.what() << "\n";
126 }
127 catch (const Json::exception& e)
128 {
129 std::cerr << "Failed parsing PDR JSON file, TYPE= " << pdrType
130 << " ERROR=" << e.what() << "\n";
131 pldm::utils::reportError(
132 "xyz.openbmc_project.bmc.pldm.InternalFailure");
133 }
134 catch (const std::exception& e)
135 {
136 std::cerr << "Failed parsing PDR JSON file, TYPE= " << pdrType
137 << " ERROR=" << e.what() << "\n";
138 pldm::utils::reportError(
139 "xyz.openbmc_project.bmc.pldm.InternalFailure");
140 }
141 }
142}
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530143
Deepak Kodihallibc669f12019-11-28 08:52:07 -0600144Response Handler::getPDR(const pldm_msg* request, size_t payloadLength)
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530145{
Tom Joseph33e9c7e2020-06-11 22:09:52 +0530146 // Build FRU table if not built, since entity association PDR's are built
147 // when the FRU table is constructed.
148 if (fruHandler)
149 {
150 fruHandler->buildFRUTable();
151 }
152
George Liud680ae02020-07-17 09:11:14 +0800153 if (!pdrCreated)
154 {
155 generateTerminusLocatorPDR(pdrRepo);
156 generate(*dBusIntf, pdrJsonsDir, pdrRepo);
Sagar Srinivas78a225a2020-08-27 00:52:20 -0500157 if (oemPlatformHandler != nullptr)
158 {
159 oemPlatformHandler->buildOEMPDR(pdrRepo);
160 }
161
George Liud680ae02020-07-17 09:11:14 +0800162 pdrCreated = true;
George Liu5eed8e52020-12-18 11:24:37 +0800163
164 if (dbusToPLDMEventHandler)
165 {
Sampa Misra5fb37d52021-03-06 07:26:00 -0600166 deferredGetPDREvent = std::make_unique<sdeventplus::source::Defer>(
167 event,
168 std::bind(std::mem_fn(&pldm::responder::platform::Handler::
169 _processPostGetPDRActions),
170 this, std::placeholders::_1));
George Liu5eed8e52020-12-18 11:24:37 +0800171 }
George Liud680ae02020-07-17 09:11:14 +0800172 }
173
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530174 Response response(sizeof(pldm_msg_hdr) + PLDM_GET_PDR_MIN_RESP_BYTES, 0);
175 auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
176
177 if (payloadLength != PLDM_GET_PDR_REQ_BYTES)
178 {
George Liufb8611d2019-12-06 10:14:15 +0800179 return CmdHandler::ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530180 }
181
182 uint32_t recordHandle{};
183 uint32_t dataTransferHandle{};
184 uint8_t transferOpFlag{};
185 uint16_t reqSizeBytes{};
186 uint16_t recordChangeNum{};
187
George Liufb8611d2019-12-06 10:14:15 +0800188 auto rc = decode_get_pdr_req(request, payloadLength, &recordHandle,
189 &dataTransferHandle, &transferOpFlag,
190 &reqSizeBytes, &recordChangeNum);
191 if (rc != PLDM_SUCCESS)
192 {
193 return CmdHandler::ccOnlyResponse(request, rc);
194 }
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530195
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530196 uint16_t respSizeBytes{};
197 uint8_t* recordData = nullptr;
198 try
199 {
George Liue53193f2020-02-24 09:23:26 +0800200 pdr_utils::PdrEntry e;
201 auto record = pdr::getRecordByHandle(pdrRepo, recordHandle, e);
202 if (record == NULL)
203 {
204 return CmdHandler::ccOnlyResponse(
205 request, PLDM_PLATFORM_INVALID_RECORD_HANDLE);
206 }
207
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530208 if (reqSizeBytes)
209 {
George Liue53193f2020-02-24 09:23:26 +0800210 respSizeBytes = e.size;
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530211 if (respSizeBytes > reqSizeBytes)
212 {
213 respSizeBytes = reqSizeBytes;
214 }
George Liue53193f2020-02-24 09:23:26 +0800215 recordData = e.data;
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530216 }
217 response.resize(sizeof(pldm_msg_hdr) + PLDM_GET_PDR_MIN_RESP_BYTES +
218 respSizeBytes,
219 0);
220 responsePtr = reinterpret_cast<pldm_msg*>(response.data());
Deepak Kodihalli22b5a7d2020-03-17 23:28:41 -0500221 rc = encode_get_pdr_resp(
222 request->hdr.instance_id, PLDM_SUCCESS, e.handle.nextRecordHandle,
223 0, PLDM_START_AND_END, respSizeBytes, recordData, 0, responsePtr);
George Liufb8611d2019-12-06 10:14:15 +0800224 if (rc != PLDM_SUCCESS)
225 {
226 return ccOnlyResponse(request, rc);
227 }
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530228 }
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530229 catch (const std::exception& e)
230 {
Sampa Misraaa8ae722019-12-12 03:20:40 -0600231 std::cerr << "Error accessing PDR, HANDLE=" << recordHandle
232 << " ERROR=" << e.what() << "\n";
George Liufb8611d2019-12-06 10:14:15 +0800233 return CmdHandler::ccOnlyResponse(request, PLDM_ERROR);
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530234 }
235 return response;
236}
237
Deepak Kodihallibc669f12019-11-28 08:52:07 -0600238Response Handler::setStateEffecterStates(const pldm_msg* request,
239 size_t payloadLength)
Sampa Misraa2fa0702019-05-31 01:28:55 -0500240{
241 Response response(
242 sizeof(pldm_msg_hdr) + PLDM_SET_STATE_EFFECTER_STATES_RESP_BYTES, 0);
243 auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
244 uint16_t effecterId;
245 uint8_t compEffecterCnt;
246 constexpr auto maxCompositeEffecterCnt = 8;
247 std::vector<set_effecter_state_field> stateField(maxCompositeEffecterCnt,
248 {0, 0});
249
250 if ((payloadLength > PLDM_SET_STATE_EFFECTER_STATES_REQ_BYTES) ||
251 (payloadLength < sizeof(effecterId) + sizeof(compEffecterCnt) +
252 sizeof(set_effecter_state_field)))
253 {
George Liufb8611d2019-12-06 10:14:15 +0800254 return CmdHandler::ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
Sampa Misraa2fa0702019-05-31 01:28:55 -0500255 }
256
257 int rc = decode_set_state_effecter_states_req(request, payloadLength,
258 &effecterId, &compEffecterCnt,
259 stateField.data());
260
George Liufb8611d2019-12-06 10:14:15 +0800261 if (rc != PLDM_SUCCESS)
Sampa Misraa2fa0702019-05-31 01:28:55 -0500262 {
George Liufb8611d2019-12-06 10:14:15 +0800263 return CmdHandler::ccOnlyResponse(request, rc);
Sampa Misraa2fa0702019-05-31 01:28:55 -0500264 }
265
George Liufb8611d2019-12-06 10:14:15 +0800266 stateField.resize(compEffecterCnt);
267 const pldm::utils::DBusHandler dBusIntf;
Sampa Misraaea5dde2020-08-31 08:33:47 -0500268 uint16_t entityType{};
269 uint16_t entityInstance{};
270 uint16_t stateSetId{};
271
272 if (isOemStateEffecter(*this, effecterId, compEffecterCnt, entityType,
273 entityInstance, stateSetId) &&
274 oemPlatformHandler != nullptr)
275 {
Sampa Misra3a0e3b92020-10-21 05:58:00 -0500276 rc = oemPlatformHandler->oemSetStateEffecterStatesHandler(
Varsha Kaverappa3fbd39e2020-09-28 01:40:22 -0500277 entityType, entityInstance, stateSetId, compEffecterCnt, stateField,
278 effecterId);
Sampa Misraaea5dde2020-08-31 08:33:47 -0500279 }
280 else
281 {
282 rc = platform_state_effecter::setStateEffecterStatesHandler<
283 pldm::utils::DBusHandler, Handler>(dBusIntf, *this, effecterId,
284 stateField);
285 }
George Liufb8611d2019-12-06 10:14:15 +0800286 if (rc != PLDM_SUCCESS)
287 {
288 return CmdHandler::ccOnlyResponse(request, rc);
289 }
290
291 rc = encode_set_state_effecter_states_resp(request->hdr.instance_id, rc,
292 responsePtr);
293 if (rc != PLDM_SUCCESS)
294 {
295 return ccOnlyResponse(request, rc);
296 }
297
Sampa Misraa2fa0702019-05-31 01:28:55 -0500298 return response;
299}
300
Tom Joseph56e45c52020-03-16 10:01:45 +0530301Response Handler::platformEventMessage(const pldm_msg* request,
302 size_t payloadLength)
303{
304 uint8_t formatVersion{};
305 uint8_t tid{};
306 uint8_t eventClass{};
307 size_t offset{};
308
309 auto rc = decode_platform_event_message_req(
310 request, payloadLength, &formatVersion, &tid, &eventClass, &offset);
311 if (rc != PLDM_SUCCESS)
312 {
313 return CmdHandler::ccOnlyResponse(request, rc);
314 }
315
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500316 if (eventClass == PLDM_HEARTBEAT_TIMER_ELAPSED_EVENT)
Tom Joseph56e45c52020-03-16 10:01:45 +0530317 {
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500318 rc = PLDM_SUCCESS;
319 }
320 else
321 {
322 try
Tom Joseph56e45c52020-03-16 10:01:45 +0530323 {
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500324 const auto& handlers = eventHandlers.at(eventClass);
325 for (const auto& handler : handlers)
Tom Joseph56e45c52020-03-16 10:01:45 +0530326 {
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500327 auto rc =
328 handler(request, payloadLength, formatVersion, tid, offset);
329 if (rc != PLDM_SUCCESS)
330 {
331 return CmdHandler::ccOnlyResponse(request, rc);
332 }
Tom Joseph56e45c52020-03-16 10:01:45 +0530333 }
334 }
Sagar Srinivasa6a8ccd2021-04-01 07:58:33 -0500335 catch (const std::out_of_range& e)
336 {
337 return CmdHandler::ccOnlyResponse(request, PLDM_ERROR_INVALID_DATA);
338 }
Tom Joseph56e45c52020-03-16 10:01:45 +0530339 }
Tom Joseph56e45c52020-03-16 10:01:45 +0530340 Response response(
341 sizeof(pldm_msg_hdr) + PLDM_PLATFORM_EVENT_MESSAGE_RESP_BYTES, 0);
342 auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
343
344 rc = encode_platform_event_message_resp(request->hdr.instance_id, rc,
345 PLDM_EVENT_NO_LOGGING, responsePtr);
346 if (rc != PLDM_SUCCESS)
347 {
348 return ccOnlyResponse(request, rc);
349 }
350
351 return response;
352}
353
354int Handler::sensorEvent(const pldm_msg* request, size_t payloadLength,
Tom Josephc4959c32020-04-20 19:50:16 +0530355 uint8_t /*formatVersion*/, uint8_t tid,
Tom Joseph56e45c52020-03-16 10:01:45 +0530356 size_t eventDataOffset)
357{
358 uint16_t sensorId{};
359 uint8_t eventClass{};
360 size_t eventClassDataOffset{};
361 auto eventData =
362 reinterpret_cast<const uint8_t*>(request->payload) + eventDataOffset;
363 auto eventDataSize = payloadLength - eventDataOffset;
364
365 auto rc = decode_sensor_event_data(eventData, eventDataSize, &sensorId,
366 &eventClass, &eventClassDataOffset);
367 if (rc != PLDM_SUCCESS)
368 {
369 return rc;
370 }
371
Zahed Hossain75330f32020-03-24 02:15:03 -0500372 auto eventClassData = reinterpret_cast<const uint8_t*>(request->payload) +
373 eventDataOffset + eventClassDataOffset;
374 auto eventClassDataSize =
375 payloadLength - eventDataOffset - eventClassDataOffset;
376
Tom Joseph56e45c52020-03-16 10:01:45 +0530377 if (eventClass == PLDM_STATE_SENSOR_STATE)
378 {
379 uint8_t sensorOffset{};
380 uint8_t eventState{};
381 uint8_t previousEventState{};
382
Zahed Hossain75330f32020-03-24 02:15:03 -0500383 rc = decode_state_sensor_data(eventClassData, eventClassDataSize,
Tom Joseph56e45c52020-03-16 10:01:45 +0530384 &sensorOffset, &eventState,
385 &previousEventState);
Zahed Hossain75330f32020-03-24 02:15:03 -0500386 if (rc != PLDM_SUCCESS)
387 {
388 return PLDM_ERROR;
389 }
390
Chicago Duanfe4d88b2020-06-12 16:44:13 +0800391 // Emitting state sensor event signal
392 emitStateSensorEventSignal(tid, sensorId, sensorOffset, eventState,
393 previousEventState);
394
Tom Josephc4959c32020-04-20 19:50:16 +0530395 // If there are no HOST PDR's, there is no further action
396 if (hostPDRHandler == NULL)
397 {
398 return PLDM_SUCCESS;
399 }
400
401 // Handle PLDM events for which PDR is available
402 SensorEntry sensorEntry{tid, sensorId};
Tom Josephb70a1962020-07-13 12:56:31 +0530403
404 pldm::pdr::EntityInfo entityInfo{};
405 pldm::pdr::CompositeSensorStates compositeSensorStates{};
406
Tom Josephc4959c32020-04-20 19:50:16 +0530407 try
408 {
Tom Josephb70a1962020-07-13 12:56:31 +0530409 std::tie(entityInfo, compositeSensorStates) =
Tom Josephc4959c32020-04-20 19:50:16 +0530410 hostPDRHandler->lookupSensorInfo(sensorEntry);
Tom Josephc4959c32020-04-20 19:50:16 +0530411 }
Tom Josephc4959c32020-04-20 19:50:16 +0530412 catch (const std::out_of_range& e)
413 {
Tom Josephb70a1962020-07-13 12:56:31 +0530414 // If there is no mapping for tid, sensorId combination, try
415 // PLDM_TID_RESERVED, sensorId for terminus that is yet to
416 // implement TL PDR.
417 try
418 {
419 sensorEntry.terminusID = PLDM_TID_RESERVED;
420 std::tie(entityInfo, compositeSensorStates) =
421 hostPDRHandler->lookupSensorInfo(sensorEntry);
422 }
423 // If there is no mapping for events return PLDM_SUCCESS
424 catch (const std::out_of_range& e)
425 {
426 return PLDM_SUCCESS;
427 }
Zahed Hossain75330f32020-03-24 02:15:03 -0500428 }
Tom Josephb70a1962020-07-13 12:56:31 +0530429
430 if (sensorOffset >= compositeSensorStates.size())
431 {
432 return PLDM_ERROR_INVALID_DATA;
433 }
434
435 const auto& possibleStates = compositeSensorStates[sensorOffset];
436 if (possibleStates.find(eventState) == possibleStates.end())
437 {
438 return PLDM_ERROR_INVALID_DATA;
439 }
440
441 const auto& [containerId, entityType, entityInstance] = entityInfo;
442 events::StateSensorEntry stateSensorEntry{containerId, entityType,
443 entityInstance, sensorOffset};
Pavithra Barithaya3aec9972020-12-14 01:55:44 -0600444 return hostPDRHandler->handleStateSensorEvent(stateSensorEntry,
445 eventState);
Tom Joseph56e45c52020-03-16 10:01:45 +0530446 }
447 else
448 {
449 return PLDM_ERROR_INVALID_DATA;
450 }
451
452 return PLDM_SUCCESS;
453}
454
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500455int Handler::pldmPDRRepositoryChgEvent(const pldm_msg* request,
456 size_t payloadLength,
457 uint8_t /*formatVersion*/,
458 uint8_t /*tid*/, size_t eventDataOffset)
459{
460 uint8_t eventDataFormat{};
461 uint8_t numberOfChangeRecords{};
462 size_t dataOffset{};
463
464 auto eventData =
465 reinterpret_cast<const uint8_t*>(request->payload) + eventDataOffset;
466 auto eventDataSize = payloadLength - eventDataOffset;
467
468 auto rc = decode_pldm_pdr_repository_chg_event_data(
469 eventData, eventDataSize, &eventDataFormat, &numberOfChangeRecords,
470 &dataOffset);
471 if (rc != PLDM_SUCCESS)
472 {
473 return rc;
474 }
475
476 PDRRecordHandles pdrRecordHandles;
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -0500477
478 if (eventDataFormat == FORMAT_IS_PDR_TYPES)
479 {
480 return PLDM_ERROR_INVALID_DATA;
481 }
482
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500483 if (eventDataFormat == FORMAT_IS_PDR_HANDLES)
484 {
485 uint8_t eventDataOperation{};
486 uint8_t numberOfChangeEntries{};
487
488 auto changeRecordData = eventData + dataOffset;
489 auto changeRecordDataSize = eventDataSize - dataOffset;
490
491 while (changeRecordDataSize)
492 {
493 rc = decode_pldm_pdr_repository_change_record_data(
494 changeRecordData, changeRecordDataSize, &eventDataOperation,
495 &numberOfChangeEntries, &dataOffset);
496
497 if (rc != PLDM_SUCCESS)
498 {
499 return rc;
500 }
501
502 if (eventDataOperation == PLDM_RECORDS_ADDED)
503 {
504 rc = getPDRRecordHandles(
505 reinterpret_cast<const ChangeEntry*>(changeRecordData +
506 dataOffset),
507 changeRecordDataSize - dataOffset,
508 static_cast<size_t>(numberOfChangeEntries),
509 pdrRecordHandles);
510
511 if (rc != PLDM_SUCCESS)
512 {
513 return rc;
514 }
515 }
516
Pavithra Barithaya841ee3d2021-09-09 04:08:34 -0500517 if (eventDataOperation == PLDM_RECORDS_MODIFIED)
518 {
519 return PLDM_ERROR_UNSUPPORTED_PLDM_CMD;
520 }
521
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500522 changeRecordData +=
523 dataOffset + (numberOfChangeEntries * sizeof(ChangeEntry));
524 changeRecordDataSize -=
525 dataOffset + (numberOfChangeEntries * sizeof(ChangeEntry));
526 }
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500527 }
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -0500528 if (hostPDRHandler)
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500529 {
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -0500530 hostPDRHandler->fetchPDR(std::move(pdrRecordHandles));
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500531 }
532
533 return PLDM_SUCCESS;
534}
535
536int Handler::getPDRRecordHandles(const ChangeEntry* changeEntryData,
537 size_t changeEntryDataSize,
538 size_t numberOfChangeEntries,
539 PDRRecordHandles& pdrRecordHandles)
540{
541 if (numberOfChangeEntries > (changeEntryDataSize / sizeof(ChangeEntry)))
542 {
543 return PLDM_ERROR_INVALID_DATA;
544 }
545 for (size_t i = 0; i < numberOfChangeEntries; i++)
546 {
547 pdrRecordHandles.push_back(changeEntryData[i]);
548 }
549 return PLDM_SUCCESS;
550}
551
George Liueccb0c52020-01-14 11:09:56 +0800552Response Handler::setNumericEffecterValue(const pldm_msg* request,
553 size_t payloadLength)
554{
555 Response response(sizeof(pldm_msg_hdr) +
556 PLDM_SET_NUMERIC_EFFECTER_VALUE_RESP_BYTES);
557 uint16_t effecterId{};
558 uint8_t effecterDataSize{};
559 uint8_t effecterValue[4] = {};
560
561 if ((payloadLength > sizeof(effecterId) + sizeof(effecterDataSize) +
562 sizeof(union_effecter_data_size)) ||
563 (payloadLength < sizeof(effecterId) + sizeof(effecterDataSize) + 1))
564 {
565 return ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
566 }
567
568 int rc = decode_set_numeric_effecter_value_req(
569 request, payloadLength, &effecterId, &effecterDataSize,
570 reinterpret_cast<uint8_t*>(&effecterValue));
571
572 if (rc == PLDM_SUCCESS)
573 {
574 const pldm::utils::DBusHandler dBusIntf;
575 rc = platform_numeric_effecter::setNumericEffecterValueHandler<
576 pldm::utils::DBusHandler, Handler>(dBusIntf, *this, effecterId,
577 effecterDataSize, effecterValue,
578 sizeof(effecterValue));
579 }
580
581 return ccOnlyResponse(request, rc);
582}
583
Sampa Misra12afe112020-05-25 11:40:44 -0500584void Handler::generateTerminusLocatorPDR(Repo& repo)
585{
586 std::vector<uint8_t> pdrBuffer(sizeof(pldm_terminus_locator_pdr));
587
588 auto pdr = reinterpret_cast<pldm_terminus_locator_pdr*>(pdrBuffer.data());
589
590 pdr->hdr.record_handle = 0;
591 pdr->hdr.version = 1;
592 pdr->hdr.type = PLDM_TERMINUS_LOCATOR_PDR;
593 pdr->hdr.record_change_num = 0;
594 pdr->hdr.length = sizeof(pldm_terminus_locator_pdr) - sizeof(pldm_pdr_hdr);
595 pdr->terminus_handle = BmcPldmTerminusHandle;
596 pdr->validity = PLDM_TL_PDR_VALID;
597 pdr->tid = BmcTerminusId;
598 pdr->container_id = 0x0;
599 pdr->terminus_locator_type = PLDM_TERMINUS_LOCATOR_TYPE_MCTP_EID;
600 pdr->terminus_locator_value_size =
601 sizeof(pldm_terminus_locator_type_mctp_eid);
602 auto locatorValue = reinterpret_cast<pldm_terminus_locator_type_mctp_eid*>(
603 pdr->terminus_locator_value);
604 locatorValue->eid = BmcMctpEid;
605
606 PdrEntry pdrEntry{};
607 pdrEntry.data = pdrBuffer.data();
608 pdrEntry.size = pdrBuffer.size();
609 repo.addRecord(pdrEntry);
610}
George Liu362c18d2020-05-14 09:46:36 +0800611
612Response Handler::getStateSensorReadings(const pldm_msg* request,
613 size_t payloadLength)
614{
615 uint16_t sensorId{};
616 bitfield8_t sensorRearm{};
617 uint8_t reserved{};
618
619 if (payloadLength != PLDM_GET_SENSOR_READING_REQ_BYTES)
620 {
621 return ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
622 }
623
624 int rc = decode_get_state_sensor_readings_req(
625 request, payloadLength, &sensorId, &sensorRearm, &reserved);
626
627 if (rc != PLDM_SUCCESS)
628 {
629 return ccOnlyResponse(request, rc);
630 }
631
632 // 0x01 to 0x08
George Liuc1230ca2021-08-03 16:06:50 +0800633 uint8_t sensorRearmCount = std::popcount(sensorRearm.byte);
Sampa Misraaea5dde2020-08-31 08:33:47 -0500634 std::vector<get_sensor_state_field> stateField(sensorRearmCount);
George Liu362c18d2020-05-14 09:46:36 +0800635 uint8_t comSensorCnt{};
636 const pldm::utils::DBusHandler dBusIntf;
Sampa Misraaea5dde2020-08-31 08:33:47 -0500637
638 uint16_t entityType{};
639 uint16_t entityInstance{};
640 uint16_t stateSetId{};
641
642 if (isOemStateSensor(*this, sensorId, sensorRearmCount, comSensorCnt,
643 entityType, entityInstance, stateSetId) &&
644 oemPlatformHandler != nullptr)
645 {
646 rc = oemPlatformHandler->getOemStateSensorReadingsHandler(
647 entityType, entityInstance, stateSetId, comSensorCnt, stateField);
648 }
649 else
650 {
651 rc = platform_state_sensor::getStateSensorReadingsHandler<
652 pldm::utils::DBusHandler, Handler>(dBusIntf, *this, sensorId,
653 sensorRearmCount, comSensorCnt,
654 stateField);
655 }
George Liu362c18d2020-05-14 09:46:36 +0800656
657 if (rc != PLDM_SUCCESS)
658 {
659 return ccOnlyResponse(request, rc);
660 }
661
662 Response response(sizeof(pldm_msg_hdr) +
663 PLDM_GET_STATE_SENSOR_READINGS_MIN_RESP_BYTES +
664 sizeof(get_sensor_state_field) * comSensorCnt);
665 auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
666 rc = encode_get_state_sensor_readings_resp(request->hdr.instance_id, rc,
667 comSensorCnt, stateField.data(),
668 responsePtr);
669 if (rc != PLDM_SUCCESS)
670 {
671 return ccOnlyResponse(request, rc);
672 }
673
674 return response;
675}
676
Sampa Misra5fb37d52021-03-06 07:26:00 -0600677void Handler::_processPostGetPDRActions(
678 sdeventplus::source::EventBase& /*source */)
679{
680 deferredGetPDREvent.reset();
681 dbusToPLDMEventHandler->listenSensorEvent(pdrRepo, sensorDbusObjMaps);
682}
683
Sampa Misraaea5dde2020-08-31 08:33:47 -0500684bool isOemStateSensor(Handler& handler, uint16_t sensorId,
685 uint8_t sensorRearmCount, uint8_t& compSensorCnt,
686 uint16_t& entityType, uint16_t& entityInstance,
687 uint16_t& stateSetId)
688{
689 pldm_state_sensor_pdr* pdr = nullptr;
690
691 std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> stateSensorPdrRepo(
692 pldm_pdr_init(), pldm_pdr_destroy);
693 Repo stateSensorPDRs(stateSensorPdrRepo.get());
694 getRepoByType(handler.getRepo(), stateSensorPDRs, PLDM_STATE_SENSOR_PDR);
695 if (stateSensorPDRs.empty())
696 {
697 std::cerr << "Failed to get record by PDR type\n";
698 return false;
699 }
700
701 PdrEntry pdrEntry{};
702 auto pdrRecord = stateSensorPDRs.getFirstRecord(pdrEntry);
703 while (pdrRecord)
704 {
705 pdr = reinterpret_cast<pldm_state_sensor_pdr*>(pdrEntry.data);
706 assert(pdr != NULL);
707 if (pdr->sensor_id != sensorId)
708 {
709 pdr = nullptr;
710 pdrRecord = stateSensorPDRs.getNextRecord(pdrRecord, pdrEntry);
711 continue;
712 }
713 auto tmpEntityType = pdr->entity_type;
714 auto tmpEntityInstance = pdr->entity_instance;
715 auto tmpCompSensorCnt = pdr->composite_sensor_count;
716 auto tmpPossibleStates =
717 reinterpret_cast<state_sensor_possible_states*>(
718 pdr->possible_states);
719 auto tmpStateSetId = tmpPossibleStates->state_set_id;
720
721 if (sensorRearmCount > tmpCompSensorCnt)
722 {
723 std::cerr << "The requester sent wrong sensorRearm"
724 << " count for the sensor, SENSOR_ID=" << sensorId
725 << "SENSOR_REARM_COUNT=" << (uint16_t)sensorRearmCount
726 << "\n";
727 break;
728 }
729
730 if ((tmpEntityType >= PLDM_OEM_ENTITY_TYPE_START &&
731 tmpEntityType <= PLDM_OEM_ENTITY_TYPE_END) ||
732 (tmpStateSetId >= PLDM_OEM_STATE_SET_ID_START &&
733 tmpStateSetId < PLDM_OEM_STATE_SET_ID_END))
734 {
735 entityType = tmpEntityType;
736 entityInstance = tmpEntityInstance;
737 stateSetId = tmpStateSetId;
738 compSensorCnt = tmpCompSensorCnt;
739 return true;
740 }
741 else
742 {
743 return false;
744 }
745 }
746 return false;
747}
748
749bool isOemStateEffecter(Handler& handler, uint16_t effecterId,
750 uint8_t compEffecterCnt, uint16_t& entityType,
751 uint16_t& entityInstance, uint16_t& stateSetId)
752{
753 pldm_state_effecter_pdr* pdr = nullptr;
754
755 std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> stateEffecterPdrRepo(
756 pldm_pdr_init(), pldm_pdr_destroy);
757 Repo stateEffecterPDRs(stateEffecterPdrRepo.get());
758 getRepoByType(handler.getRepo(), stateEffecterPDRs,
759 PLDM_STATE_EFFECTER_PDR);
760 if (stateEffecterPDRs.empty())
761 {
762 std::cerr << "Failed to get record by PDR type\n";
763 return false;
764 }
765
766 PdrEntry pdrEntry{};
767 auto pdrRecord = stateEffecterPDRs.getFirstRecord(pdrEntry);
768 while (pdrRecord)
769 {
770 pdr = reinterpret_cast<pldm_state_effecter_pdr*>(pdrEntry.data);
771 assert(pdr != NULL);
772 if (pdr->effecter_id != effecterId)
773 {
774 pdr = nullptr;
775 pdrRecord = stateEffecterPDRs.getNextRecord(pdrRecord, pdrEntry);
776 continue;
777 }
778
779 auto tmpEntityType = pdr->entity_type;
780 auto tmpEntityInstance = pdr->entity_instance;
781 auto tmpPossibleStates =
782 reinterpret_cast<state_effecter_possible_states*>(
783 pdr->possible_states);
784 auto tmpStateSetId = tmpPossibleStates->state_set_id;
785
786 if (compEffecterCnt > pdr->composite_effecter_count)
787 {
788 std::cerr << "The requester sent wrong composite effecter"
789 << " count for the effecter, EFFECTER_ID=" << effecterId
790 << "COMP_EFF_CNT=" << (uint16_t)compEffecterCnt << "\n";
791 return false;
792 }
793
794 if ((tmpEntityType >= PLDM_OEM_ENTITY_TYPE_START &&
795 tmpEntityType <= PLDM_OEM_ENTITY_TYPE_END) ||
796 (tmpStateSetId >= PLDM_OEM_STATE_SET_ID_START &&
797 tmpStateSetId < PLDM_OEM_STATE_SET_ID_END))
798 {
799 entityType = tmpEntityType;
800 entityInstance = tmpEntityInstance;
801 stateSetId = tmpStateSetId;
802 return true;
803 }
804 else
805 {
806 return false;
807 }
808 }
809 return false;
810}
811
Deepak Kodihallibc669f12019-11-28 08:52:07 -0600812} // namespace platform
Deepak Kodihalli557dfb02019-05-12 13:11:17 +0530813} // namespace responder
814} // namespace pldm