blob: 387f03f98eac7d823aaa72359bcfa8b1223b7ca7 [file] [log] [blame]
#include "pldm_cmd_helper.hpp"
namespace pldmtool
{
namespace platform
{
namespace
{
using namespace pldmtool::helper;
std::vector<std::unique_ptr<CommandInterface>> commands;
} // namespace
class GetPDR : public CommandInterface
{
public:
~GetPDR() = default;
GetPDR() = delete;
GetPDR(const GetPDR&) = delete;
GetPDR(GetPDR&&) = default;
GetPDR& operator=(const GetPDR&) = delete;
GetPDR& operator=(GetPDR&&) = default;
using CommandInterface::CommandInterface;
// The maximum number of record bytes requested to be returned in the
// response to this instance of the GetPDR command.
static constexpr uint16_t requestCount = 128;
explicit GetPDR(const char* type, const char* name, CLI::App* app) :
CommandInterface(type, name, app)
{
app->add_option(
"-d,--data", recordHandle,
"retrieve individual PDRs from a PDR Repository\n"
"eg: The recordHandle value for the PDR to be retrieved and 0 "
"means get first PDR in the repository.")
->required();
}
std::pair<int, std::vector<uint8_t>> createRequestMsg() override
{
std::vector<uint8_t> requestMsg(sizeof(pldm_msg_hdr) +
PLDM_GET_PDR_REQ_BYTES);
auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
auto rc = encode_get_pdr_req(instanceId, recordHandle, 0,
PLDM_GET_FIRSTPART, requestCount, 0,
request, PLDM_GET_PDR_REQ_BYTES);
return {rc, requestMsg};
}
void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
{
uint8_t completionCode = 0;
uint8_t recordData[255] = {0};
uint32_t nextRecordHndl = 0;
uint32_t nextDataTransferHndl = 0;
uint8_t transferFlag = 0;
uint16_t respCnt = 0;
uint8_t transferCRC = 0;
auto rc = decode_get_pdr_resp(
responsePtr, payloadLength, &completionCode, &nextRecordHndl,
&nextDataTransferHndl, &transferFlag, &respCnt, recordData,
sizeof(recordData), &transferCRC);
if (rc != PLDM_SUCCESS || completionCode != PLDM_SUCCESS)
{
std::cerr << "Response Message Error: "
<< "rc=" << rc << ",cc=" << (int)completionCode
<< std::endl;
return;
}
printPDRMsg(nextRecordHndl, respCnt, recordData, sizeof(recordData));
}
private:
const std::map<uint16_t, std::string> entityType = {
{64, "System Board"},
{137, "Management Controller"},
{69, "Chassis front panel board (control panel)"},
{123, "Power converter"},
{45, "System chassis (main enclosure)"},
{11521, "System (logical)"},
};
std::string getEntityName(uint16_t type)
{
try
{
return entityType.at(type);
}
catch (const std::out_of_range& e)
{
return std::to_string(static_cast<unsigned>(type)) + "(OEM)";
}
}
void printPDRFruRecordSet(uint8_t* data, size_t len)
{
if (data == NULL || len == 0)
{
return;
}
data += sizeof(pldm_pdr_hdr);
pldm_pdr_fru_record_set* pdr =
reinterpret_cast<pldm_pdr_fru_record_set*>(data);
std::cout << "PLDMTerminusHandle: " << pdr->terminus_handle
<< std::endl;
std::cout << "FRURecordSetIdentifier: " << pdr->fru_rsi << std::endl;
std::cout << "entityType: " << getEntityName(pdr->entity_type)
<< std::endl;
std::cout << "entityInstanceNumber: " << pdr->entity_instance_num
<< std::endl;
std::cout << "containerID: " << pdr->container_id << std::endl;
}
void printPDREntityAssociation(uint8_t* data, size_t len)
{
const std::map<uint8_t, const char*> assocationType = {
{PLDM_ENTITY_ASSOCIAION_PHYSICAL, "Physical"},
{PLDM_ENTITY_ASSOCIAION_LOGICAL, "Logical"},
};
if (data == NULL || len == 0)
{
return;
}
data += sizeof(pldm_pdr_hdr);
pldm_pdr_entity_association* pdr =
reinterpret_cast<pldm_pdr_entity_association*>(data);
std::cout << "containerID: " << pdr->container_id << std::endl;
std::cout << "associationType: "
<< assocationType.at(pdr->association_type) << std::endl
<< std::endl;
std::cout << "containerEntityType: "
<< getEntityName(pdr->container.entity_type) << std::endl;
std::cout << "containerEntityInstanceNumber: "
<< pdr->container.entity_instance_num << std::endl;
std::cout << "containerEntityContainerID: "
<< pdr->container.entity_container_id << std::endl;
std::cout << "containedEntityCount: "
<< static_cast<unsigned>(pdr->num_children) << std::endl
<< std::endl;
auto child = reinterpret_cast<pldm_entity*>(&pdr->children[0]);
for (int i = 0; i < pdr->num_children; ++i)
{
std::cout << "containedEntityType[" << i + 1
<< "]: " << getEntityName(child->entity_type)
<< std::endl;
std::cout << "containedEntityInstanceNumber[" << i + 1
<< "]: " << child->entity_instance_num << std::endl;
std::cout << "containedEntityContainerID[" << i + 1
<< "]: " << child->entity_container_id << std::endl
<< std::endl;
++child;
}
}
void printPDR11(uint8_t* data, size_t len)
{
if (data == NULL || len == 0)
{
return;
}
struct pldm_state_effecter_pdr* pdr =
(struct pldm_state_effecter_pdr*)data;
std::cout << "PLDMTerminusHandle: " << pdr->terminus_handle
<< std::endl;
std::cout << "effecterID: " << pdr->effecter_id << std::endl;
std::cout << "entityType: " << pdr->entity_type << std::endl;
std::cout << "entityInstanceNumber: " << pdr->entity_instance
<< std::endl;
std::cout << "containerID: " << pdr->container_id << std::endl;
std::cout << "effecterSemanticID: " << pdr->effecter_semantic_id
<< std::endl;
std::cout << "effecterInit: " << unsigned(pdr->effecter_init)
<< std::endl;
std::cout << "effecterDescriptionPDR: "
<< (unsigned(pdr->has_description_pdr) ? "true" : "false")
<< std::endl;
std::cout << "compositeEffecterCount: "
<< unsigned(pdr->composite_effecter_count) << std::endl;
for (size_t i = 0; i < pdr->composite_effecter_count; ++i)
{
struct state_effecter_possible_states* state =
(struct state_effecter_possible_states*)pdr->possible_states +
i * sizeof(state_effecter_possible_states);
std::cout << "stateSetID: " << state->state_set_id << std::endl;
std::cout << "possibleStatesSize: "
<< unsigned(state->possible_states_size) << std::endl;
bitfield8_t* bf = reinterpret_cast<bitfield8_t*>(state->states);
std::cout << "possibleStates: " << unsigned(bf->byte) << std::endl;
}
}
void printPDRMsg(const uint32_t nextRecordHndl, const uint16_t respCnt,
uint8_t* data, size_t len)
{
if (data == NULL || len == 0)
{
return;
}
std::cout << "nextRecordHandle: " << nextRecordHndl << std::endl;
std::cout << "responseCount: " << respCnt << std::endl;
struct pldm_pdr_hdr* pdr = (struct pldm_pdr_hdr*)data;
std::cout << "recordHandle: " << pdr->record_handle << std::endl;
std::cout << "PDRHeaderVersion: " << unsigned(pdr->version)
<< std::endl;
std::cout << "PDRType: " << unsigned(pdr->type) << std::endl;
std::cout << "recordChangeNumber: " << pdr->record_change_num
<< std::endl;
std::cout << "dataLength: " << pdr->length << std::endl << std::endl;
switch (pdr->type)
{
case PLDM_STATE_EFFECTER_PDR:
printPDR11(data, len);
break;
case PLDM_PDR_ENTITY_ASSOCIATION:
printPDREntityAssociation(data, len);
break;
case PLDM_PDR_FRU_RECORD_SET:
printPDRFruRecordSet(data, len);
break;
default:
break;
}
}
private:
uint32_t recordHandle;
};
class SetStateEffecter : public CommandInterface
{
public:
~SetStateEffecter() = default;
SetStateEffecter() = delete;
SetStateEffecter(const SetStateEffecter&) = delete;
SetStateEffecter(SetStateEffecter&&) = default;
SetStateEffecter& operator=(const SetStateEffecter&) = delete;
SetStateEffecter& operator=(SetStateEffecter&&) = default;
// compositeEffecterCount(value: 0x01 to 0x08) * stateField(2)
static constexpr auto maxEffecterDataSize = 16;
// compositeEffecterCount(value: 0x01 to 0x08)
static constexpr auto minEffecterCount = 1;
static constexpr auto maxEffecterCount = 8;
explicit SetStateEffecter(const char* type, const char* name,
CLI::App* app) :
CommandInterface(type, name, app)
{
app->add_option(
"-i, --id", effecterId,
"A handle that is used to identify and access the effecter")
->required();
app->add_option("-c, --count", effecterCount,
"The number of individual sets of effecter information")
->required();
app->add_option(
"-d,--data", effecterData,
"Set effecter state data\n"
"eg: requestSet0 effecterState0 noChange1 dummyState1 ...")
->required();
}
std::pair<int, std::vector<uint8_t>> createRequestMsg() override
{
std::vector<uint8_t> requestMsg(
sizeof(pldm_msg_hdr) + PLDM_SET_STATE_EFFECTER_STATES_REQ_BYTES);
auto request = reinterpret_cast<pldm_msg*>(requestMsg.data());
if (effecterCount > maxEffecterCount ||
effecterCount < minEffecterCount)
{
std::cerr << "Request Message Error: effecterCount size "
<< effecterCount << "is invalid\n";
auto rc = PLDM_ERROR_INVALID_DATA;
return {rc, requestMsg};
}
if (effecterData.size() > maxEffecterDataSize)
{
std::cerr << "Request Message Error: effecterData size "
<< effecterData.size() << "is invalid\n";
auto rc = PLDM_ERROR_INVALID_DATA;
return {rc, requestMsg};
}
auto stateField = parseEffecterData(effecterData, effecterCount);
if (!stateField)
{
std::cerr << "Failed to parse effecter data, effecterCount size "
<< effecterCount << "\n";
auto rc = PLDM_ERROR_INVALID_DATA;
return {rc, requestMsg};
}
auto rc = encode_set_state_effecter_states_req(
instanceId, effecterId, effecterCount, stateField->data(), request);
return {rc, requestMsg};
}
void parseResponseMsg(pldm_msg* responsePtr, size_t payloadLength) override
{
uint8_t completionCode = 0;
auto rc = decode_set_state_effecter_states_resp(
responsePtr, payloadLength, &completionCode);
if (rc != PLDM_SUCCESS || completionCode != PLDM_SUCCESS)
{
std::cerr << "Response Message Error: "
<< "rc=" << rc << ",cc=" << (int)completionCode << "\n";
return;
}
std::cout << "SetStateEffecterStates: SUCCESS" << std::endl;
}
private:
uint16_t effecterId;
uint8_t effecterCount;
std::vector<uint8_t> effecterData;
};
void registerCommand(CLI::App& app)
{
auto platform = app.add_subcommand("platform", "platform type command");
platform->require_subcommand(1);
auto getPDR =
platform->add_subcommand("GetPDR", "get platform descriptor records");
commands.push_back(std::make_unique<GetPDR>("platform", "getPDR", getPDR));
auto setStateEffecterStates = platform->add_subcommand(
"SetStateEffecterStates", "set effecter states");
commands.push_back(std::make_unique<SetStateEffecter>(
"platform", "setStateEffecterStates", setStateEffecterStates));
}
} // namespace platform
} // namespace pldmtool