blob: c6f74328e5b06a68762d000556697e90550d308b [file] [log] [blame]
#pragma once
#include "common/utils.hpp"
#include "libpldmresponder/pdr.hpp"
#include "pdr_utils.hpp"
#include "pldmd/handler.hpp"
#include <libpldm/platform.h>
#include <libpldm/states.h>
#include <phosphor-logging/lg2.hpp>
#include <cstdint>
#include <map>
PHOSPHOR_LOG2_USING;
namespace pldm
{
namespace responder
{
namespace platform_state_effecter
{
/** @brief Function to set the effecter requested by pldm requester
*
* @tparam[in] DBusInterface - DBus interface type
* @tparam[in] Handler - pldm::responder::platform::Handler
* @param[in] dBusIntf - The interface object of DBusInterface
* @param[in] handler - The interface object of
* pldm::responder::platform::Handler
* @param[in] effecterId - Effecter ID sent by the requester to act on
* @param[in] stateField - The state field data for each of the states,
* equal to composite effecter count in number
* @return - Success or failure in setting the states. Returns failure in
* terms of PLDM completion codes if at least one state fails to be set
*/
template <class DBusInterface, class Handler>
int setStateEffecterStatesHandler(
const DBusInterface& dBusIntf, Handler& handler, uint16_t effecterId,
const std::vector<set_effecter_state_field>& stateField)
{
using namespace pldm::responder::pdr;
using namespace pldm::utils;
using StateSetNum = uint8_t;
state_effecter_possible_states* states = nullptr;
pldm_state_effecter_pdr* pdr = nullptr;
uint8_t compEffecterCnt = stateField.size();
std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> stateEffecterPdrRepo(
pldm_pdr_init(), pldm_pdr_destroy);
if (!stateEffecterPdrRepo)
{
throw std::runtime_error(
"Failed to instantiate state effecter PDR repository");
}
pldm::responder::pdr_utils::Repo stateEffecterPDRs(
stateEffecterPdrRepo.get());
getRepoByType(handler.getRepo(), stateEffecterPDRs,
PLDM_STATE_EFFECTER_PDR);
if (stateEffecterPDRs.empty())
{
error("Failed to get StateEffecterPDR record");
return PLDM_PLATFORM_INVALID_EFFECTER_ID;
}
pldm::responder::pdr_utils::PdrEntry pdrEntry{};
auto pdrRecord = stateEffecterPDRs.getFirstRecord(pdrEntry);
while (pdrRecord)
{
pdr = reinterpret_cast<pldm_state_effecter_pdr*>(pdrEntry.data);
if (pdr->effecter_id != effecterId)
{
pdr = nullptr;
pdrRecord = stateEffecterPDRs.getNextRecord(pdrRecord, pdrEntry);
continue;
}
states = reinterpret_cast<state_effecter_possible_states*>(
pdr->possible_states);
if (compEffecterCnt > pdr->composite_effecter_count)
{
error(
"The requester sent wrong composite effecter count '{COMPOSITE_EFFECTER_COUNT}' for the effecter ID '{EFFECTERID}'",
"EFFECTERID", effecterId, "COMPOSITE_EFFECTER_COUNT",
compEffecterCnt);
return PLDM_ERROR_INVALID_DATA;
}
break;
}
if (!pdr)
{
return PLDM_PLATFORM_INVALID_EFFECTER_ID;
}
int rc = PLDM_SUCCESS;
try
{
const auto& [dbusMappings, dbusValMaps] =
handler.getDbusObjMaps(effecterId);
if (dbusMappings.empty() || dbusValMaps.empty())
{
error("DbusMappings for effecter ID '{EFFECTER_ID}' is missing",
"EFFECTER_ID", effecterId);
return PLDM_ERROR;
}
for (uint8_t currState = 0;
currState < compEffecterCnt && currState < dbusMappings.size() &&
currState < dbusValMaps.size();
++currState)
{
std::vector<StateSetNum> allowed{};
// computation is based on table 79 from DSP0248 v1.1.1
uint8_t bitfieldIndex = stateField[currState].effecter_state / 8;
uint8_t bit = stateField[currState].effecter_state -
(8 * bitfieldIndex);
if (states->possible_states_size < bitfieldIndex ||
!(states->states[bitfieldIndex].byte & (1 << bit)))
{
rc = PLDM_PLATFORM_SET_EFFECTER_UNSUPPORTED_SENSORSTATE;
error(
"Invalid state set value for effecter ID '{EFFECTER_ID}', effecter state '{EFFECTER_STATE}', composite effecter ID '{COMPOSITE_EFFECTER_ID}' and path '{PATH}', response code '{RC}'",
"EFFECTER_ID", effecterId, "EFFECTER_STATE",
stateField[currState].effecter_state,
"COMPOSITE_EFFECTER_ID", currState, "PATH",
dbusMappings[currState].objectPath, "RC", rc);
break;
}
const DBusMapping& dbusMapping = dbusMappings[currState];
const pldm::responder::pdr_utils::StatestoDbusVal& dbusValToMap =
dbusValMaps[currState];
if (stateField[currState].set_request == PLDM_REQUEST_SET)
{
try
{
dBusIntf.setDbusProperty(
dbusMapping,
dbusValToMap.at(stateField[currState].effecter_state));
}
catch (const std::exception& e)
{
error(
"Failed to set property '{PROPERTY}', interface '{INTERFACE}' and path '{PATH}', error - '{ERROR}'",
"PROPERTY", dbusMapping.propertyName, "INTERFACE",
dbusMapping.interface, "PATH", dbusMapping.objectPath,
"ERROR", e);
return PLDM_ERROR;
}
}
uint8_t* nextState =
reinterpret_cast<uint8_t*>(states) +
sizeof(state_effecter_possible_states) -
sizeof(states->states) +
(states->possible_states_size * sizeof(states->states));
states =
reinterpret_cast<state_effecter_possible_states*>(nextState);
}
}
catch (const std::out_of_range& e)
{
error("Unknown effecter ID '{EFFECTERID}', error - {ERROR}",
"EFFECTERID", effecterId, "ERROR", e);
return PLDM_ERROR;
}
return rc;
}
} // namespace platform_state_effecter
} // namespace responder
} // namespace pldm