eive-obsw/linux/devices/ploc/PlocMPSoCHandler.cpp

1090 lines
36 KiB
C++
Raw Normal View History

2022-01-06 18:05:21 +01:00
#include "PlocMPSoCHandler.h"
2022-03-22 11:35:44 +01:00
#include "OBSWConfig.h"
2022-01-06 18:05:21 +01:00
#include "fsfw/datapool/PoolReadGuard.h"
2022-03-22 11:35:44 +01:00
#include "fsfw/globalfunctions/CRC.h"
2022-04-04 13:40:45 +02:00
#include "linux/devices/devicedefinitions/PlocSupervisorDefinitions.h"
2021-03-29 14:37:52 +02:00
2022-01-03 08:01:55 +01:00
PlocMPSoCHandler::PlocMPSoCHandler(object_id_t objectId, object_id_t uartComIFid,
2022-03-27 14:42:20 +02:00
CookieIF* comCookie, PlocMPSoCHelper* plocMPSoCHelper,
2022-03-30 09:19:30 +02:00
Gpio uartIsolatorSwitch, object_id_t supervisorHandler)
2022-03-27 14:42:20 +02:00
: DeviceHandlerBase(objectId, uartComIFid, comCookie),
plocMPSoCHelper(plocMPSoCHelper),
2022-03-30 09:19:30 +02:00
uartIsolatorSwitch(uartIsolatorSwitch),
supervisorHandler(supervisorHandler),
commandActionHelper(this) {
2022-03-27 14:42:20 +02:00
if (comCookie == nullptr) {
sif::error << "PlocMPSoCHandler: Invalid communication cookie" << std::endl;
}
2022-03-22 11:35:44 +01:00
eventQueue = QueueFactory::instance()->createMessageQueue(EventMessage::EVENT_MESSAGE_SIZE * 5);
2022-03-30 09:19:30 +02:00
commandActionHelperQueue =
QueueFactory::instance()->createMessageQueue(EventMessage::EVENT_MESSAGE_SIZE * 5);
2022-08-15 18:53:25 +02:00
spParams.maxSize = sizeof(commandBuffer);
spParams.buf = commandBuffer;
2021-03-29 14:37:52 +02:00
}
2022-03-22 11:35:44 +01:00
PlocMPSoCHandler::~PlocMPSoCHandler() {}
2021-03-29 14:37:52 +02:00
2022-01-03 08:01:55 +01:00
ReturnValue_t PlocMPSoCHandler::initialize() {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2022-03-22 11:35:44 +01:00
result = DeviceHandlerBase::initialize();
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
2022-11-10 18:07:59 +01:00
uartComIf = dynamic_cast<SerialComIF*>(communicationInterface);
2022-03-22 11:35:44 +01:00
if (uartComIf == nullptr) {
sif::warning << "PlocMPSoCHandler::initialize: Invalid uart com if" << std::endl;
return ObjectManagerIF::CHILD_INIT_FAILED;
}
2022-01-06 18:05:21 +01:00
2022-03-22 11:35:44 +01:00
EventManagerIF* manager = ObjectManager::instance()->get<EventManagerIF>(objects::EVENT_MANAGER);
if (manager == nullptr) {
2022-01-06 18:05:21 +01:00
#if FSFW_CPP_OSTREAM_ENABLED == 1
2022-03-22 11:35:44 +01:00
sif::error << "PlocMPSoCHandler::initialize: Invalid event manager" << std::endl;
2022-01-06 18:05:21 +01:00
#endif
2022-03-22 11:35:44 +01:00
return ObjectManagerIF::CHILD_INIT_FAILED;
;
}
result = manager->registerListener(eventQueue->getId());
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
result = manager->subscribeToEventRange(
eventQueue->getId(), event::getEventId(PlocMPSoCHelper::MPSOC_FLASH_WRITE_FAILED),
event::getEventId(PlocMPSoCHelper::MPSOC_FLASH_WRITE_SUCCESSFUL));
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-01-06 18:05:21 +01:00
#if FSFW_CPP_OSTREAM_ENABLED == 1
2022-03-22 11:35:44 +01:00
sif::warning << "PlocMPSoCHandler::initialize: Failed to subscribe to events from "
" ploc mpsoc helper"
<< std::endl;
2022-01-06 18:05:21 +01:00
#endif
2022-03-22 11:35:44 +01:00
return ObjectManagerIF::CHILD_INIT_FAILED;
}
2022-01-06 18:05:21 +01:00
2022-03-22 11:35:44 +01:00
result = plocMPSoCHelper->setComIF(communicationInterface);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return ObjectManagerIF::CHILD_INIT_FAILED;
}
plocMPSoCHelper->setComCookie(comCookie);
plocMPSoCHelper->setSequenceCount(&sequenceCount);
2022-03-30 09:19:30 +02:00
result = commandActionHelper.initialize();
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-30 09:19:30 +02:00
return ObjectManagerIF::CHILD_INIT_FAILED;
}
2022-03-22 11:35:44 +01:00
return result;
2022-01-03 08:01:55 +01:00
}
2022-01-07 09:50:04 +01:00
void PlocMPSoCHandler::performOperationHook() {
2022-03-22 11:35:44 +01:00
EventMessage event;
2022-08-24 17:27:47 +02:00
for (ReturnValue_t result = eventQueue->receiveMessage(&event); result == returnvalue::OK;
2022-03-22 11:35:44 +01:00
result = eventQueue->receiveMessage(&event)) {
switch (event.getMessageId()) {
case EventMessage::EVENT_MESSAGE:
handleEvent(&event);
break;
default:
sif::debug << "PlocMPSoCHandler::performOperationHook: Did not subscribe to this event"
<< " message" << std::endl;
break;
2022-01-07 09:50:04 +01:00
}
2022-03-22 11:35:44 +01:00
}
2022-03-30 09:19:30 +02:00
CommandMessage message;
2022-04-04 13:40:45 +02:00
for (ReturnValue_t result = commandActionHelperQueue->receiveMessage(&message);
2022-08-24 17:27:47 +02:00
result == returnvalue::OK; result = commandActionHelperQueue->receiveMessage(&message)) {
2022-03-30 09:19:30 +02:00
result = commandActionHelper.handleReply(&message);
2022-08-24 17:27:47 +02:00
if (result == returnvalue::OK) {
2022-03-30 09:19:30 +02:00
continue;
}
}
2022-01-07 09:50:04 +01:00
}
2022-01-06 18:05:21 +01:00
ReturnValue_t PlocMPSoCHandler::executeAction(ActionId_t actionId, MessageQueueId_t commandedBy,
2022-03-22 11:35:44 +01:00
const uint8_t* data, size_t size) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2022-04-30 16:21:59 +02:00
switch (actionId) {
case mpsoc::SET_UART_TX_TRISTATE: {
uartIsolatorSwitch.pullLow();
return EXECUTION_FINISHED;
break;
}
case mpsoc::RELEASE_UART_TX: {
uartIsolatorSwitch.pullHigh();
return EXECUTION_FINISHED;
break;
default:
break;
}
2022-04-29 22:55:01 +02:00
}
2022-01-06 18:05:21 +01:00
2022-03-22 11:35:44 +01:00
if (plocMPSoCHelperExecuting) {
return MPSoCReturnValuesIF::MPSOC_HELPER_EXECUTING;
}
2022-01-06 18:05:21 +01:00
2022-03-22 11:35:44 +01:00
switch (actionId) {
2022-01-06 18:05:21 +01:00
case mpsoc::TC_FLASHWRITE: {
2022-03-22 11:35:44 +01:00
if (size > config::MAX_PATH_SIZE + config::MAX_FILENAME_SIZE) {
return MPSoCReturnValuesIF::FILENAME_TOO_LONG;
}
mpsoc::FlashWritePusCmd flashWritePusCmd;
result = flashWritePusCmd.extractFields(data, size);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-25 09:08:01 +01:00
return result;
}
2022-03-22 11:35:44 +01:00
result = plocMPSoCHelper->startFlashWrite(flashWritePusCmd.getObcFile(),
2022-03-25 09:08:01 +01:00
flashWritePusCmd.getMPSoCFile());
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
plocMPSoCHelperExecuting = true;
return EXECUTION_FINISHED;
}
case (mpsoc::OBSW_RESET_SEQ_COUNT): {
sequenceCount = 0;
return EXECUTION_FINISHED;
2022-01-06 18:05:21 +01:00
}
default:
2022-03-22 11:35:44 +01:00
break;
}
return DeviceHandlerBase::executeAction(actionId, commandedBy, data, size);
2022-01-06 18:05:21 +01:00
}
2022-03-22 11:35:44 +01:00
void PlocMPSoCHandler::doStartUp() {
2022-04-20 21:33:39 +02:00
#ifdef XIPHOS_Q7S
#if not OBSW_MPSOC_JTAG_BOOT == 1
2022-04-04 13:40:45 +02:00
switch (powerState) {
case PowerState::OFF:
2022-03-30 09:19:30 +02:00
commandActionHelper.commandAction(supervisorHandler, supv::START_MPSOC);
powerState = PowerState::BOOTING;
break;
2022-04-04 13:40:45 +02:00
case PowerState::ON:
2022-03-30 09:19:30 +02:00
setMode(_MODE_TO_ON);
uartIsolatorSwitch.pullHigh();
break;
2022-04-04 13:40:45 +02:00
default:
2022-03-30 09:19:30 +02:00
break;
}
2022-04-20 21:33:39 +02:00
#else
powerState = PowerState::ON;
setMode(_MODE_TO_ON);
uartIsolatorSwitch.pullHigh();
2022-04-30 16:21:59 +02:00
#endif /* not MSPOC_JTAG_BOOT == 1 */
#else
powerState = PowerState::ON;
2022-04-20 21:33:39 +02:00
setMode(_MODE_TO_ON);
#endif /* XIPHOS_Q7S */
2021-03-29 14:37:52 +02:00
}
2022-03-27 14:42:20 +02:00
void PlocMPSoCHandler::doShutDown() {
#ifdef XIPHOS_Q7S
#if not OBSW_MPSOC_JTAG_BOOT == 1
2022-04-04 13:40:45 +02:00
switch (powerState) {
case PowerState::ON:
2022-03-30 09:19:30 +02:00
uartIsolatorSwitch.pullLow();
commandActionHelper.commandAction(supervisorHandler, supv::SHUTDOWN_MPSOC);
powerState = PowerState::SHUTDOWN;
break;
2022-04-04 13:40:45 +02:00
case PowerState::OFF:
2022-12-22 17:17:23 +01:00
sequenceCount = 0;
2022-03-30 09:19:30 +02:00
setMode(_MODE_POWER_DOWN);
break;
2022-04-04 13:40:45 +02:00
default:
2022-03-30 09:19:30 +02:00
break;
}
#else
2022-12-22 17:17:23 +01:00
sequenceCount = 0;
uartIsolatorSwitch.pullLow();
setMode(_MODE_POWER_DOWN);
powerState = PowerState::OFF;
#endif
#endif
2022-03-27 14:42:20 +02:00
}
2022-03-22 11:35:44 +01:00
ReturnValue_t PlocMPSoCHandler::buildNormalDeviceCommand(DeviceCommandId_t* id) {
return NOTHING_TO_SEND;
}
ReturnValue_t PlocMPSoCHandler::buildTransitionDeviceCommand(DeviceCommandId_t* id) {
return NOTHING_TO_SEND;
2022-03-22 11:35:44 +01:00
}
ReturnValue_t PlocMPSoCHandler::buildCommandFromCommand(DeviceCommandId_t deviceCommand,
const uint8_t* commandData,
size_t commandDataLen) {
spParams.buf = commandBuffer;
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2022-03-22 11:35:44 +01:00
switch (deviceCommand) {
case (mpsoc::TC_MEM_WRITE): {
result = prepareTcMemWrite(commandData, commandDataLen);
break;
}
case (mpsoc::TC_MEM_READ): {
result = prepareTcMemRead(commandData, commandDataLen);
break;
}
case (mpsoc::TC_FLASHDELETE): {
result = prepareTcFlashDelete(commandData, commandDataLen);
break;
}
case (mpsoc::TC_REPLAY_START): {
result = prepareTcReplayStart(commandData, commandDataLen);
break;
}
case (mpsoc::TC_REPLAY_STOP): {
result = prepareTcReplayStop();
break;
2022-01-03 08:01:55 +01:00
}
2022-03-22 11:35:44 +01:00
case (mpsoc::TC_DOWNLINK_PWR_ON): {
result = prepareTcDownlinkPwrOn(commandData, commandDataLen);
break;
}
case (mpsoc::TC_DOWNLINK_PWR_OFF): {
result = prepareTcDownlinkPwrOff();
break;
}
case (mpsoc::TC_REPLAY_WRITE_SEQUENCE): {
result = prepareTcReplayWriteSequence(commandData, commandDataLen);
break;
}
2022-03-24 17:39:50 +01:00
case (mpsoc::TC_MODE_REPLAY): {
2022-03-25 09:08:01 +01:00
result = prepareTcModeReplay();
break;
}
2022-04-20 21:33:39 +02:00
case (mpsoc::TC_MODE_IDLE): {
result = prepareTcModeIdle();
break;
}
case (mpsoc::TC_CAM_CMD_SEND): {
result = prepareTcCamCmdSend(commandData, commandDataLen);
break;
}
2022-03-22 11:35:44 +01:00
default:
sif::debug << "PlocMPSoCHandler::buildCommandFromCommand: Command not implemented"
<< std::endl;
result = DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
break;
}
2022-01-03 08:01:55 +01:00
2022-08-24 17:27:47 +02:00
if (result == returnvalue::OK) {
2022-03-22 11:35:44 +01:00
/**
* Flushing the receive buffer to make sure there are no data left from a faulty reply.
*/
uartComIf->flushUartRxBuffer(comCookie);
}
return result;
2021-03-29 14:37:52 +02:00
}
void PlocMPSoCHandler::fillCommandAndReplyMap() {
2022-03-22 11:35:44 +01:00
this->insertInCommandMap(mpsoc::TC_MEM_WRITE);
this->insertInCommandMap(mpsoc::TC_MEM_READ);
this->insertInCommandMap(mpsoc::TC_FLASHDELETE);
this->insertInCommandMap(mpsoc::TC_REPLAY_START);
this->insertInCommandMap(mpsoc::TC_REPLAY_STOP);
this->insertInCommandMap(mpsoc::TC_DOWNLINK_PWR_ON);
this->insertInCommandMap(mpsoc::TC_DOWNLINK_PWR_OFF);
this->insertInCommandMap(mpsoc::TC_REPLAY_WRITE_SEQUENCE);
2022-03-24 17:39:50 +01:00
this->insertInCommandMap(mpsoc::TC_MODE_REPLAY);
2022-04-20 21:33:39 +02:00
this->insertInCommandMap(mpsoc::TC_MODE_IDLE);
this->insertInCommandMap(mpsoc::TC_CAM_CMD_SEND);
2022-04-29 22:55:01 +02:00
this->insertInCommandMap(mpsoc::RELEASE_UART_TX);
this->insertInCommandMap(mpsoc::SET_UART_TX_TRISTATE);
2022-04-20 21:33:39 +02:00
this->insertInReplyMap(mpsoc::ACK_REPORT, 3, nullptr, mpsoc::SIZE_ACK_REPORT);
2022-03-22 11:35:44 +01:00
this->insertInReplyMap(mpsoc::EXE_REPORT, 3, nullptr, mpsoc::SIZE_EXE_REPORT);
this->insertInReplyMap(mpsoc::TM_MEMORY_READ_REPORT, 2, nullptr, mpsoc::SIZE_TM_MEM_READ_REPORT);
this->insertInReplyMap(mpsoc::TM_CAM_CMD_RPT, 2, nullptr, mpsoc::SP_MAX_SIZE);
2022-03-22 11:35:44 +01:00
}
ReturnValue_t PlocMPSoCHandler::scanForReply(const uint8_t* start, size_t remainingSize,
DeviceCommandId_t* foundId, size_t* foundLen) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
SpacePacketReader spacePacket;
spacePacket.setReadOnlyData(start, remainingSize);
if (spacePacket.isNull()) {
2022-08-24 17:27:47 +02:00
return returnvalue::FAILED;
}
auto res = spacePacket.checkSize();
2022-08-24 17:27:47 +02:00
if (res != returnvalue::OK) {
return res;
}
uint16_t apid = spacePacket.getApid();
2022-03-22 11:35:44 +01:00
switch (apid) {
case (mpsoc::apid::ACK_SUCCESS):
*foundLen = mpsoc::SIZE_ACK_REPORT;
*foundId = mpsoc::ACK_REPORT;
break;
case (mpsoc::apid::ACK_FAILURE):
*foundLen = mpsoc::SIZE_ACK_REPORT;
*foundId = mpsoc::ACK_REPORT;
break;
case (mpsoc::apid::TM_MEMORY_READ_REPORT):
*foundLen = tmMemReadReport.rememberRequestedSize;
*foundId = mpsoc::TM_MEMORY_READ_REPORT;
break;
2022-04-20 21:33:39 +02:00
case (mpsoc::apid::TM_CAM_CMD_RPT):
*foundLen = spacePacket.getFullPacketLen();
2022-04-20 21:33:39 +02:00
tmCamCmdRpt.rememberSpacePacketSize = *foundLen;
*foundId = mpsoc::TM_CAM_CMD_RPT;
break;
2022-03-22 11:35:44 +01:00
case (mpsoc::apid::EXE_SUCCESS):
*foundLen = mpsoc::SIZE_EXE_REPORT;
*foundId = mpsoc::EXE_REPORT;
break;
case (mpsoc::apid::EXE_FAILURE):
*foundLen = mpsoc::SIZE_EXE_REPORT;
*foundId = mpsoc::EXE_REPORT;
break;
default: {
sif::debug << "PlocMPSoCHandler::scanForReply: Reply has invalid apid" << std::endl;
*foundLen = remainingSize;
return MPSoCReturnValuesIF::INVALID_APID;
}
}
2022-04-20 21:33:39 +02:00
2022-03-22 11:35:44 +01:00
uint16_t recvSeqCnt = (*(start + 2) << 8 | *(start + 3)) & PACKET_SEQUENCE_COUNT_MASK;
if (recvSeqCnt != sequenceCount) {
2022-05-03 14:59:23 +02:00
triggerEvent(MPSOC_HANDLER_SEQUENCE_COUNT_MISMATCH, sequenceCount, recvSeqCnt);
2022-03-22 11:35:44 +01:00
sequenceCount = recvSeqCnt;
}
return result;
}
2022-03-22 11:35:44 +01:00
ReturnValue_t PlocMPSoCHandler::interpretDeviceReply(DeviceCommandId_t id, const uint8_t* packet) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2022-03-22 11:35:44 +01:00
switch (id) {
2022-01-05 11:26:01 +01:00
case mpsoc::ACK_REPORT: {
2022-03-22 11:35:44 +01:00
result = handleAckReport(packet);
break;
}
2022-01-05 11:26:01 +01:00
case (mpsoc::TM_MEMORY_READ_REPORT): {
2022-03-22 11:35:44 +01:00
result = handleMemoryReadReport(packet);
break;
}
2022-04-20 21:33:39 +02:00
case (mpsoc::TM_CAM_CMD_RPT): {
result = handleCamCmdRpt(packet);
break;
}
2022-01-05 11:26:01 +01:00
case (mpsoc::EXE_REPORT): {
2022-03-22 11:35:44 +01:00
result = handleExecutionReport(packet);
break;
}
default: {
2022-03-22 11:35:44 +01:00
sif::debug << "PlocMPSoCHandler::interpretDeviceReply: Unknown device reply id" << std::endl;
return DeviceHandlerIF::UNKNOWN_DEVICE_REPLY;
}
2022-03-22 11:35:44 +01:00
}
2022-03-22 11:35:44 +01:00
return result;
}
2022-03-22 11:35:44 +01:00
void PlocMPSoCHandler::setNormalDatapoolEntriesInvalid() {}
uint32_t PlocMPSoCHandler::getTransitionDelayMs(Mode_t modeFrom, Mode_t modeTo) { return 5000; }
ReturnValue_t PlocMPSoCHandler::initializeLocalDataPool(localpool::DataPool& localDataPoolMap,
2022-03-22 11:35:44 +01:00
LocalDataPoolManager& poolManager) {
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
}
2022-01-07 09:50:04 +01:00
void PlocMPSoCHandler::handleEvent(EventMessage* eventMessage) {
2022-03-22 11:35:44 +01:00
object_id_t objectId = eventMessage->getReporter();
switch (objectId) {
2022-01-07 09:50:04 +01:00
case objects::PLOC_MPSOC_HELPER: {
2022-03-22 11:35:44 +01:00
plocMPSoCHelperExecuting = false;
break;
2022-01-07 09:50:04 +01:00
}
default:
2022-03-22 11:35:44 +01:00
sif::debug << "PlocMPSoCHandler::handleEvent: Did not subscribe to this event" << std::endl;
break;
}
2022-01-07 09:50:04 +01:00
}
2022-03-22 11:35:44 +01:00
ReturnValue_t PlocMPSoCHandler::prepareTcMemWrite(const uint8_t* commandData,
size_t commandDataLen) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcMemWrite tcMemWrite(spParams, sequenceCount);
result = tcMemWrite.buildPacket(commandData, commandDataLen);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcMemWrite.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2021-04-15 13:17:15 +02:00
}
2022-03-22 11:35:44 +01:00
ReturnValue_t PlocMPSoCHandler::prepareTcMemRead(const uint8_t* commandData,
size_t commandDataLen) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcMemRead tcMemRead(spParams, sequenceCount);
result = tcMemRead.buildPacket(commandData, commandDataLen);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcMemRead.getFullPacketLen());
2022-03-22 11:35:44 +01:00
tmMemReadReport.rememberRequestedSize = tcMemRead.getMemLen() * 4 + TmMemReadReport::FIX_SIZE;
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-03-21 08:35:28 +01:00
}
2022-03-22 11:35:44 +01:00
ReturnValue_t PlocMPSoCHandler::prepareTcFlashDelete(const uint8_t* commandData,
size_t commandDataLen) {
if (commandDataLen > config::MAX_PATH_SIZE + config::MAX_FILENAME_SIZE) {
2022-03-30 09:19:30 +02:00
return MPSoCReturnValuesIF::NAME_TOO_LONG;
2022-03-22 11:35:44 +01:00
}
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcFlashDelete tcFlashDelete(spParams, sequenceCount);
result = tcFlashDelete.buildPacket(
2022-03-22 11:35:44 +01:00
std::string(reinterpret_cast<const char*>(commandData), commandDataLen));
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcFlashDelete.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-03-22 11:35:44 +01:00
}
ReturnValue_t PlocMPSoCHandler::prepareTcReplayStart(const uint8_t* commandData,
size_t commandDataLen) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcReplayStart tcReplayStart(spParams, sequenceCount);
result = tcReplayStart.buildPacket(commandData, commandDataLen);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcReplayStart.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-03-21 11:05:41 +01:00
}
2022-03-21 16:21:51 +01:00
ReturnValue_t PlocMPSoCHandler::prepareTcReplayStop() {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcReplayStop tcReplayStop(spParams, sequenceCount);
result = tcReplayStop.buildPacket();
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcReplayStop.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-03-22 11:35:44 +01:00
}
ReturnValue_t PlocMPSoCHandler::prepareTcDownlinkPwrOn(const uint8_t* commandData,
size_t commandDataLen) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcDownlinkPwrOn tcDownlinkPwrOn(spParams, sequenceCount);
result = tcDownlinkPwrOn.buildPacket(commandData, commandDataLen);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcDownlinkPwrOn.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-03-21 16:21:51 +01:00
}
ReturnValue_t PlocMPSoCHandler::prepareTcDownlinkPwrOff() {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcDownlinkPwrOff tcDownlinkPwrOff(spParams, sequenceCount);
result = tcDownlinkPwrOff.buildPacket();
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcDownlinkPwrOff.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-03-21 16:21:51 +01:00
}
ReturnValue_t PlocMPSoCHandler::prepareTcReplayWriteSequence(const uint8_t* commandData,
size_t commandDataLen) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcReplayWriteSeq tcReplayWriteSeq(spParams, sequenceCount);
result = tcReplayWriteSeq.buildPacket(commandData, commandDataLen);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-21 16:21:51 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcReplayWriteSeq.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-03-21 16:21:51 +01:00
}
2022-03-24 17:39:50 +01:00
ReturnValue_t PlocMPSoCHandler::prepareTcModeReplay() {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcModeReplay tcModeReplay(spParams, sequenceCount);
result = tcModeReplay.buildPacket();
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-25 09:08:01 +01:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcModeReplay.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-03-24 17:39:50 +01:00
}
2022-04-20 21:33:39 +02:00
ReturnValue_t PlocMPSoCHandler::prepareTcModeIdle() {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcModeIdle tcModeIdle(spParams, sequenceCount);
result = tcModeIdle.buildPacket();
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-04-20 21:33:39 +02:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcModeIdle.getFullPacketLen());
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-04-20 21:33:39 +02:00
}
ReturnValue_t PlocMPSoCHandler::prepareTcCamCmdSend(const uint8_t* commandData,
size_t commandDataLen) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
mpsoc::TcCamcmdSend tcCamCmdSend(spParams, sequenceCount);
result = tcCamCmdSend.buildPacket(commandData, commandDataLen);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-04-20 21:33:39 +02:00
return result;
}
2022-08-19 15:49:22 +02:00
finishTcPrep(tcCamCmdSend.getFullPacketLen());
2022-04-20 21:33:39 +02:00
nextReplyId = mpsoc::TM_CAM_CMD_RPT;
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2022-04-20 21:33:39 +02:00
}
2022-08-19 15:49:22 +02:00
void PlocMPSoCHandler::finishTcPrep(size_t packetLen) {
nextReplyId = mpsoc::ACK_REPORT;
rawPacket = commandBuffer;
rawPacketLen = packetLen;
2022-12-22 17:17:23 +01:00
sequenceCount++;
2022-08-19 15:49:22 +02:00
}
2022-01-05 11:26:01 +01:00
ReturnValue_t PlocMPSoCHandler::verifyPacket(const uint8_t* start, size_t foundLen) {
2022-08-19 15:49:22 +02:00
if (CRC::crc16ccitt(start, foundLen) != 0) {
2022-03-22 11:35:44 +01:00
return MPSoCReturnValuesIF::CRC_FAILURE;
}
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
2021-04-11 12:04:13 +02:00
}
ReturnValue_t PlocMPSoCHandler::handleAckReport(const uint8_t* data) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2021-04-15 13:17:15 +02:00
2022-03-22 11:35:44 +01:00
result = verifyPacket(data, mpsoc::SIZE_ACK_REPORT);
if (result == MPSoCReturnValuesIF::CRC_FAILURE) {
sif::warning << "PlocMPSoCHandler::handleAckReport: CRC failure" << std::endl;
2022-03-22 11:35:44 +01:00
nextReplyId = mpsoc::NONE;
replyRawReplyIfnotWiretapped(data, mpsoc::SIZE_ACK_REPORT);
triggerEvent(MPSOC_HANDLER_CRC_FAILURE);
sendFailureReport(mpsoc::ACK_REPORT, MPSoCReturnValuesIF::CRC_FAILURE);
disableAllReplies();
return IGNORE_REPLY_DATA;
}
2021-04-15 13:17:15 +02:00
2022-03-22 11:35:44 +01:00
uint16_t apid = (*(data) << 8 | *(data + 1)) & APID_MASK;
switch (apid) {
case mpsoc::apid::ACK_FAILURE: {
sif::debug << "PlocMPSoCHandler::handleAckReport: Received Ack failure report" << std::endl;
DeviceCommandId_t commandId = getPendingCommand();
2022-03-25 09:08:01 +01:00
uint16_t status = getStatus(data);
printStatus(data);
2022-03-22 11:35:44 +01:00
if (commandId != DeviceHandlerIF::NO_COMMAND_ID) {
2022-03-25 09:08:01 +01:00
triggerEvent(ACK_FAILURE, commandId, status);
2022-03-22 11:35:44 +01:00
}
sendFailureReport(mpsoc::ACK_REPORT, status);
2022-03-22 11:35:44 +01:00
disableAllReplies();
nextReplyId = mpsoc::NONE;
result = IGNORE_REPLY_DATA;
break;
}
case mpsoc::apid::ACK_SUCCESS: {
setNextReplyId();
break;
}
default: {
sif::debug << "PlocMPSoCHandler::handleAckReport: Invalid APID in Ack report" << std::endl;
2022-08-24 17:27:47 +02:00
result = returnvalue::FAILED;
2022-03-22 11:35:44 +01:00
break;
}
}
2021-03-29 14:37:52 +02:00
2022-03-22 11:35:44 +01:00
return result;
2021-03-29 14:37:52 +02:00
}
ReturnValue_t PlocMPSoCHandler::handleExecutionReport(const uint8_t* data) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2021-04-15 13:17:15 +02:00
2022-03-22 11:35:44 +01:00
result = verifyPacket(data, mpsoc::SIZE_EXE_REPORT);
if (result == MPSoCReturnValuesIF::CRC_FAILURE) {
sif::warning << "PlocMPSoCHandler::handleExecutionReport: CRC failure" << std::endl;
2022-03-22 11:35:44 +01:00
nextReplyId = mpsoc::NONE;
return result;
}
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
uint16_t apid = (*(data) << 8 | *(data + 1)) & APID_MASK;
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
switch (apid) {
2022-01-05 11:26:01 +01:00
case (mpsoc::apid::EXE_SUCCESS): {
2022-03-22 11:35:44 +01:00
break;
2021-04-11 12:04:13 +02:00
}
2022-01-05 11:26:01 +01:00
case (mpsoc::apid::EXE_FAILURE): {
2022-03-22 11:35:44 +01:00
// TODO: Interpretation of status field in execution report
sif::warning << "PlocMPSoCHandler::handleExecutionReport: Received execution failure report"
2022-03-26 20:47:25 +01:00
<< std::endl;
2022-03-22 11:35:44 +01:00
DeviceCommandId_t commandId = getPendingCommand();
if (commandId != DeviceHandlerIF::NO_COMMAND_ID) {
2022-03-26 20:47:25 +01:00
uint16_t status = getStatus(data);
triggerEvent(EXE_FAILURE, commandId, status);
2022-03-22 11:35:44 +01:00
} else {
sif::debug << "PlocMPSoCHandler::handleExecutionReport: Unknown command id" << std::endl;
}
2022-03-24 17:39:50 +01:00
printStatus(data);
2022-03-22 11:35:44 +01:00
sendFailureReport(mpsoc::EXE_REPORT, MPSoCReturnValuesIF::RECEIVED_EXE_FAILURE);
disableExeReportReply();
result = IGNORE_REPLY_DATA;
break;
2021-04-11 12:04:13 +02:00
}
default: {
sif::warning << "PlocMPSoCHandler::handleExecutionReport: Unknown APID" << std::endl;
2022-08-24 17:27:47 +02:00
result = returnvalue::FAILED;
2022-03-22 11:35:44 +01:00
break;
}
2022-03-22 11:35:44 +01:00
}
nextReplyId = mpsoc::NONE;
return result;
2021-04-11 12:04:13 +02:00
}
ReturnValue_t PlocMPSoCHandler::handleMemoryReadReport(const uint8_t* data) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2022-03-22 11:35:44 +01:00
result = verifyPacket(data, tmMemReadReport.rememberRequestedSize);
if (result == MPSoCReturnValuesIF::CRC_FAILURE) {
sif::warning << "PlocMPSoCHandler::handleMemoryReadReport: Memory read report has invalid crc"
2022-03-26 20:47:25 +01:00
<< std::endl;
2022-03-22 11:35:44 +01:00
}
uint16_t memLen =
*(data + mpsoc::MEM_READ_RPT_LEN_OFFSET) << 8 | *(data + mpsoc::MEM_READ_RPT_LEN_OFFSET + 1);
/** Send data to commanding queue */
handleDeviceTM(data + mpsoc::DATA_FIELD_OFFSET, mpsoc::SIZE_MEM_READ_RPT_FIX + memLen * 4,
mpsoc::TM_MEMORY_READ_REPORT);
nextReplyId = mpsoc::EXE_REPORT;
return result;
}
2022-04-20 21:33:39 +02:00
ReturnValue_t PlocMPSoCHandler::handleCamCmdRpt(const uint8_t* data) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2022-04-20 21:33:39 +02:00
result = verifyPacket(data, tmCamCmdRpt.rememberSpacePacketSize);
if (result == MPSoCReturnValuesIF::CRC_FAILURE) {
sif::warning << "PlocMPSoCHandler::handleCamCmdRpt: CRC failure" << std::endl;
}
2022-08-15 18:34:26 +02:00
SpacePacketReader packetReader(data, tmCamCmdRpt.rememberSpacePacketSize);
const uint8_t* dataFieldPtr = data + mpsoc::SPACE_PACKET_HEADER_SIZE + sizeof(uint16_t);
2022-04-22 14:09:08 +02:00
std::string camCmdRptMsg(
reinterpret_cast<const char*>(dataFieldPtr),
tmCamCmdRpt.rememberSpacePacketSize - mpsoc::SPACE_PACKET_HEADER_SIZE - sizeof(uint16_t) - 3);
2022-05-04 19:08:37 +02:00
#if OBSW_DEBUG_PLOC_MPSOC == 1
2022-08-19 21:41:24 +02:00
uint8_t ackValue = *(packetReader.getFullData() + packetReader.getFullPacketLen() - 2);
2022-05-04 19:08:37 +02:00
sif::info << "PlocMPSoCHandler: CamCmdRpt message: " << camCmdRptMsg << std::endl;
sif::info << "PlocMPSoCHandler: CamCmdRpt Ack value: 0x" << std::hex
<< static_cast<unsigned int>(ackValue) << std::endl;
#endif /* OBSW_DEBUG_PLOC_MPSOC == 1 */
2022-08-15 18:34:26 +02:00
handleDeviceTM(packetReader.getPacketData() + sizeof(uint16_t),
packetReader.getPacketDataLen() - 1, mpsoc::TM_CAM_CMD_RPT);
2022-04-20 21:33:39 +02:00
return result;
}
ReturnValue_t PlocMPSoCHandler::enableReplyInReplyMap(DeviceCommandMap::iterator command,
2022-03-22 11:35:44 +01:00
uint8_t expectedReplies, bool useAlternateId,
DeviceCommandId_t alternateReplyID) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2022-03-22 11:35:44 +01:00
uint8_t enabledReplies = 0;
2022-03-22 11:35:44 +01:00
switch (command->first) {
2022-01-05 11:26:01 +01:00
case mpsoc::TC_MEM_WRITE:
2022-03-21 08:35:28 +01:00
case mpsoc::TC_FLASHDELETE:
2022-03-21 16:21:51 +01:00
case mpsoc::TC_REPLAY_START:
case mpsoc::TC_REPLAY_STOP:
case mpsoc::TC_DOWNLINK_PWR_ON:
case mpsoc::TC_DOWNLINK_PWR_OFF:
case mpsoc::TC_REPLAY_WRITE_SEQUENCE:
2022-03-24 17:39:50 +01:00
case mpsoc::TC_MODE_REPLAY:
2022-04-20 21:33:39 +02:00
case mpsoc::TC_MODE_IDLE:
2022-03-22 11:35:44 +01:00
enabledReplies = 2;
break;
2022-01-05 11:26:01 +01:00
case mpsoc::TC_MEM_READ: {
2022-03-22 11:35:44 +01:00
enabledReplies = 3;
result = DeviceHandlerBase::enableReplyInReplyMap(command, enabledReplies, true,
mpsoc::TM_MEMORY_READ_REPORT);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
sif::debug << "PlocMPSoCHandler::enableReplyInReplyMap: Reply with id "
<< mpsoc::TM_MEMORY_READ_REPORT << " not in replyMap" << std::endl;
2022-04-20 21:33:39 +02:00
return result;
}
break;
}
case mpsoc::TC_CAM_CMD_SEND: {
enabledReplies = 3;
result = DeviceHandlerBase::enableReplyInReplyMap(command, enabledReplies, true,
mpsoc::TM_CAM_CMD_RPT);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-04-20 21:33:39 +02:00
sif::debug << "PlocMPSoCHandler::enableReplyInReplyMap: Reply with id "
<< mpsoc::TM_CAM_CMD_RPT << " not in replyMap" << std::endl;
return result;
2022-03-22 11:35:44 +01:00
}
break;
}
2022-03-25 09:08:01 +01:00
case mpsoc::OBSW_RESET_SEQ_COUNT:
break;
default:
2022-03-22 11:35:44 +01:00
sif::debug << "PlocMPSoCHandler::enableReplyInReplyMap: Unknown command id" << std::endl;
break;
}
2022-03-22 11:35:44 +01:00
/**
* Every command causes at least one acknowledgment and one execution report. Therefore both
* replies will be enabled here.
*/
result =
DeviceHandlerBase::enableReplyInReplyMap(command, enabledReplies, true, mpsoc::ACK_REPORT);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
sif::debug << "PlocMPSoCHandler::enableReplyInReplyMap: Reply with id " << mpsoc::ACK_REPORT
<< " not in replyMap" << std::endl;
}
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
result =
DeviceHandlerBase::enableReplyInReplyMap(command, enabledReplies, true, mpsoc::EXE_REPORT);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
sif::debug << "PlocMPSoCHandler::enableReplyInReplyMap: Reply with id " << mpsoc::EXE_REPORT
<< " not in replyMap" << std::endl;
}
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
switch (command->first) {
2022-03-21 16:21:51 +01:00
case mpsoc::TC_REPLAY_WRITE_SEQUENCE: {
2022-03-22 11:35:44 +01:00
DeviceReplyIter iter = deviceReplyMap.find(mpsoc::EXE_REPORT);
2022-03-26 20:47:25 +01:00
// Overwrite delay cycles because replay write sequence command can required up to
// 30 seconds for execution
iter->second.delayCycles = mpsoc::TC_WRITE_SEQ_EXECUTION_DELAY;
break;
}
case mpsoc::TC_DOWNLINK_PWR_ON: {
DeviceReplyIter iter = deviceReplyMap.find(mpsoc::EXE_REPORT);
//
iter->second.delayCycles = mpsoc::TC_DOWNLINK_PWR_ON;
2022-03-22 11:35:44 +01:00
break;
2022-03-21 16:21:51 +01:00
}
default:
2022-03-22 11:35:44 +01:00
break;
}
2022-03-21 16:21:51 +01:00
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
}
void PlocMPSoCHandler::setNextReplyId() {
2022-03-22 11:35:44 +01:00
switch (getPendingCommand()) {
2022-01-05 11:26:01 +01:00
case mpsoc::TC_MEM_READ:
2022-03-22 11:35:44 +01:00
nextReplyId = mpsoc::TM_MEMORY_READ_REPORT;
break;
default:
2022-03-22 11:35:44 +01:00
/* If no telemetry is expected the next reply is always the execution report */
nextReplyId = mpsoc::EXE_REPORT;
break;
}
}
2022-03-22 11:35:44 +01:00
size_t PlocMPSoCHandler::getNextReplyLength(DeviceCommandId_t commandId) {
size_t replyLen = 0;
2022-03-22 11:35:44 +01:00
if (nextReplyId == mpsoc::NONE) {
return replyLen;
}
2022-03-22 11:35:44 +01:00
DeviceReplyIter iter = deviceReplyMap.find(nextReplyId);
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
if (iter != deviceReplyMap.end()) {
if (iter->second.delayCycles == 0) {
/* Reply inactive */
return replyLen;
}
2022-03-22 11:35:44 +01:00
switch (nextReplyId) {
case mpsoc::TM_MEMORY_READ_REPORT: {
replyLen = tmMemReadReport.rememberRequestedSize;
break;
}
2022-04-20 21:33:39 +02:00
case mpsoc::TM_CAM_CMD_RPT:
2022-04-21 09:31:52 +02:00
// Read acknowledgment, camera and execution report in one go because length of camera
// report is not fixed
replyLen = mpsoc::SP_MAX_SIZE;
2022-04-20 21:33:39 +02:00
break;
2022-03-22 11:35:44 +01:00
default: {
replyLen = iter->second.replyLen;
break;
}
}
2022-03-22 11:35:44 +01:00
} else {
sif::debug << "PlocMPSoCHandler::getNextReplyLength: No entry for reply with reply id "
<< std::hex << nextReplyId << " in deviceReplyMap" << std::endl;
}
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
return replyLen;
2021-04-11 12:04:13 +02:00
}
ReturnValue_t PlocMPSoCHandler::doSendReadHook() {
// Prevent DHB from polling UART during commands executed by the mpsoc helper task
if (plocMPSoCHelperExecuting) {
2022-08-24 17:27:47 +02:00
return returnvalue::FAILED;
}
2022-08-24 17:27:47 +02:00
return returnvalue::OK;
}
2022-04-04 13:40:45 +02:00
MessageQueueIF* PlocMPSoCHandler::getCommandQueuePtr() { return commandActionHelperQueue; }
2022-03-30 09:19:30 +02:00
2022-04-04 13:40:45 +02:00
void PlocMPSoCHandler::stepSuccessfulReceived(ActionId_t actionId, uint8_t step) { return; }
2022-03-30 09:19:30 +02:00
void PlocMPSoCHandler::stepFailedReceived(ActionId_t actionId, uint8_t step,
2022-04-04 13:40:45 +02:00
ReturnValue_t returnCode) {
switch (actionId) {
2022-05-03 14:59:23 +02:00
case supv::START_MPSOC: {
2022-04-04 13:40:45 +02:00
sif::warning << "PlocMPSoCHandler::stepFailedReceived: Failed to start MPSoC" << std::endl;
2022-05-03 14:59:23 +02:00
// This usually happens when the supervisor handler is in off mode
2022-04-04 13:40:45 +02:00
powerState = PowerState::OFF;
2022-05-03 14:59:23 +02:00
setMode(MODE_OFF);
2022-04-04 13:40:45 +02:00
break;
2022-05-03 14:59:23 +02:00
}
case supv::SHUTDOWN_MPSOC: {
2022-04-04 13:40:45 +02:00
triggerEvent(MPSOC_SHUTDOWN_FAILED);
sif::warning << "PlocMPSoCHandler::stepFailedReceived: Failed to shutdown MPSoC" << std::endl;
powerState = PowerState::OFF;
2022-04-04 13:40:45 +02:00
break;
2022-05-03 14:59:23 +02:00
}
2022-04-04 13:40:45 +02:00
default:
sif::debug << "PlocMPSoCHandler::stepFailedReceived: Received unexpected action reply"
<< std::endl;
break;
}
2022-03-30 09:19:30 +02:00
}
void PlocMPSoCHandler::dataReceived(ActionId_t actionId, const uint8_t* data, uint32_t size) {
2022-04-04 13:40:45 +02:00
return;
2022-03-30 09:19:30 +02:00
}
void PlocMPSoCHandler::completionSuccessfulReceived(ActionId_t actionId) {
2022-04-04 13:40:45 +02:00
if (actionId != supv::EXE_REPORT) {
sif::debug << "PlocMPSoCHandler::completionSuccessfulReceived: Did not expect this action "
<< "ID" << std::endl;
return;
}
switch (powerState) {
case PowerState::BOOTING: {
2022-04-04 13:40:45 +02:00
powerState = PowerState::ON;
break;
2022-03-30 09:19:30 +02:00
}
case PowerState::SHUTDOWN: {
2022-04-04 13:40:45 +02:00
powerState = PowerState::OFF;
break;
}
default: {
2022-03-30 09:19:30 +02:00
break;
}
2022-04-04 13:40:45 +02:00
}
2022-03-30 09:19:30 +02:00
}
void PlocMPSoCHandler::completionFailedReceived(ActionId_t actionId, ReturnValue_t returnCode) {
2022-04-04 13:40:45 +02:00
handleActionCommandFailure(actionId);
2022-03-30 09:19:30 +02:00
}
2022-03-22 11:35:44 +01:00
void PlocMPSoCHandler::handleDeviceTM(const uint8_t* data, size_t dataSize,
DeviceCommandId_t replyId) {
2022-08-24 17:27:47 +02:00
ReturnValue_t result = returnvalue::OK;
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
if (wiretappingMode == RAW) {
/* Data already sent in doGetRead() */
return;
}
2022-03-22 11:35:44 +01:00
DeviceReplyMap::iterator iter = deviceReplyMap.find(replyId);
if (iter == deviceReplyMap.end()) {
sif::debug << "PlocMPSoCHandler::handleDeviceTM: Unknown reply id" << std::endl;
return;
}
MessageQueueId_t queueId = iter->second.command->second.sendReplyTo;
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
if (queueId == NO_COMMANDER) {
return;
}
2021-04-11 12:04:13 +02:00
2022-03-22 11:35:44 +01:00
result = actionHelper.reportData(queueId, replyId, data, dataSize);
2022-08-24 17:27:47 +02:00
if (result != returnvalue::OK) {
2022-03-22 11:35:44 +01:00
sif::debug << "PlocMPSoCHandler::handleDeviceTM: Failed to report data" << std::endl;
}
2021-03-29 14:37:52 +02:00
}
void PlocMPSoCHandler::disableAllReplies() {
2022-05-04 19:08:37 +02:00
using namespace mpsoc;
2022-03-22 11:35:44 +01:00
DeviceReplyMap::iterator iter;
2021-03-29 14:37:52 +02:00
2022-03-22 11:35:44 +01:00
/* Disable ack reply */
2022-05-04 19:08:37 +02:00
iter = deviceReplyMap.find(ACK_REPORT);
2022-03-22 11:35:44 +01:00
DeviceReplyInfo* info = &(iter->second);
info->delayCycles = 0;
info->command = deviceCommandMap.end();
2021-03-29 14:37:52 +02:00
2022-03-22 11:35:44 +01:00
DeviceCommandId_t commandId = getPendingCommand();
2021-03-29 14:37:52 +02:00
2022-03-22 11:35:44 +01:00
/* If the command expects a telemetry packet the appropriate tm reply will be disabled here */
switch (commandId) {
2022-05-04 19:08:37 +02:00
case TC_MEM_WRITE:
2022-03-22 11:35:44 +01:00
break;
2022-05-04 19:08:37 +02:00
case TC_MEM_READ: {
iter = deviceReplyMap.find(TM_MEMORY_READ_REPORT);
info = &(iter->second);
info->delayCycles = 0;
info->active = false;
info->command = deviceCommandMap.end();
break;
}
case TC_CAM_CMD_SEND: {
iter = deviceReplyMap.find(TM_CAM_CMD_RPT);
2022-03-22 11:35:44 +01:00
info = &(iter->second);
info->delayCycles = 0;
2022-05-04 19:08:37 +02:00
info->active = false;
2022-03-22 11:35:44 +01:00
info->command = deviceCommandMap.end();
break;
}
default: {
2022-05-04 19:08:37 +02:00
sif::debug << "PlocMPSoCHandler::disableAllReplies: Unknown command id: " << commandId
2022-03-22 11:35:44 +01:00
<< std::endl;
break;
}
2022-03-22 11:35:44 +01:00
}
/* We always need to disable the execution report reply here */
2022-03-22 11:35:44 +01:00
disableExeReportReply();
2022-03-26 20:47:25 +01:00
nextReplyId = mpsoc::NONE;
2021-03-29 14:37:52 +02:00
}
void PlocMPSoCHandler::sendFailureReport(DeviceCommandId_t replyId, ReturnValue_t status) {
2022-03-22 11:35:44 +01:00
DeviceReplyIter iter = deviceReplyMap.find(replyId);
if (iter == deviceReplyMap.end()) {
sif::debug << "PlocMPSoCHandler::sendFailureReport: Reply not in reply map" << std::endl;
return;
}
DeviceCommandInfo* info = &(iter->second.command->second);
if (info == nullptr) {
sif::debug << "PlocMPSoCHandler::sendFailureReport: Reply has no active command" << std::endl;
return;
}
if (info->sendReplyTo != NO_COMMANDER) {
actionHelper.finish(false, info->sendReplyTo, iter->first, status);
}
info->isExecuting = false;
2021-03-29 14:37:52 +02:00
}
void PlocMPSoCHandler::disableExeReportReply() {
2022-03-22 11:35:44 +01:00
DeviceReplyIter iter = deviceReplyMap.find(mpsoc::EXE_REPORT);
DeviceReplyInfo* info = &(iter->second);
info->delayCycles = 0;
info->command = deviceCommandMap.end();
2022-03-26 20:47:25 +01:00
/* Expected replies is set to one here. The value will be set to 0 in replyToReply() */
2022-03-22 11:35:44 +01:00
info->command->second.expectedReplies = 0;
}
2022-03-24 17:39:50 +01:00
void PlocMPSoCHandler::printStatus(const uint8_t* data) {
2022-03-25 09:08:01 +01:00
uint16_t status = *(data + STATUS_OFFSET) << 8 | *(data + STATUS_OFFSET + 1);
2022-06-17 08:31:36 +02:00
sif::info << "Verification report status: " << getStatusString(status) << std::endl;
2022-03-24 17:39:50 +01:00
}
uint16_t PlocMPSoCHandler::getStatus(const uint8_t* data) {
2022-03-26 20:47:25 +01:00
return *(data + STATUS_OFFSET) << 8 | *(data + STATUS_OFFSET + 1);
2022-03-25 09:08:01 +01:00
}
2022-03-30 09:19:30 +02:00
void PlocMPSoCHandler::handleActionCommandFailure(ActionId_t actionId) {
switch (actionId) {
case supv::ACK_REPORT:
case supv::EXE_REPORT:
2022-04-04 13:40:45 +02:00
break;
default:
sif::debug << "PlocMPSoCHandler::handleActionCommandFailure: Did not expect this action ID "
<< std::endl;
return;
}
switch (powerState) {
case PowerState::BOOTING: {
2022-05-03 14:59:23 +02:00
sif::info << "PlocMPSoCHandler::handleActionCommandFailure: MPSoC boot command failed"
2022-05-06 19:53:33 +02:00
<< std::endl;
2022-05-03 14:59:23 +02:00
// This is commonly the case when the MPSoC is already operational. Thus the power state is
// set to on here
powerState = PowerState::ON;
2022-04-04 13:40:45 +02:00
break;
}
case PowerState::SHUTDOWN: {
2022-05-03 14:59:23 +02:00
// FDIR will intercept event and switch PLOC power off
triggerEvent(MPSOC_SHUTDOWN_FAILED);
2022-04-04 13:40:45 +02:00
sif::warning << "PlocMPSoCHandler::handleActionCommandFailure: Failed to shutdown MPSoC"
<< std::endl;
2022-05-03 14:59:23 +02:00
powerState = PowerState::OFF;
2022-04-04 13:40:45 +02:00
break;
}
2022-03-30 09:19:30 +02:00
default:
2022-04-04 13:40:45 +02:00
break;
2022-03-30 09:19:30 +02:00
}
return;
2022-03-30 09:19:30 +02:00
}
std::string PlocMPSoCHandler::getStatusString(uint16_t status) {
2022-06-17 08:31:36 +02:00
switch (status) {
case (mpsoc::status_code::UNKNOWN_APID): {
return "Unknown APID";
break;
}
case (mpsoc::status_code::INCORRECT_LENGTH): {
return "Incorrect length";
break;
}
case (mpsoc::status_code::INCORRECT_CRC): {
return "Incorrect crc";
break;
}
case (mpsoc::status_code::INCORRECT_PKT_SEQ_CNT): {
return "Incorrect packet sequence count";
break;
}
case (mpsoc::status_code::TC_NOT_ALLOWED_IN_MODE): {
return "TC not allowed in this mode";
break;
}
case (mpsoc::status_code::TC_EXEUTION_DISABLED): {
return "TC execution disabled";
break;
}
case (mpsoc::status_code::FLASH_MOUNT_FAILED): {
return "Flash mount failed";
break;
}
case (mpsoc::status_code::FLASH_FILE_ALREADY_CLOSED): {
return "Flash file already closed";
break;
}
case (mpsoc::status_code::FLASH_FILE_NOT_OPEN): {
return "Flash file not open";
break;
}
case (mpsoc::status_code::FLASH_UNMOUNT_FAILED): {
return "Flash unmount failed";
break;
}
case (mpsoc::status_code::HEAP_ALLOCATION_FAILED): {
return "Heap allocation failed";
break;
}
case (mpsoc::status_code::INVALID_PARAMETER): {
return "Invalid parameter";
break;
}
case (mpsoc::status_code::NOT_INITIALIZED): {
return "Not initialized";
break;
}
case (mpsoc::status_code::REBOOT_IMMINENT): {
return "Reboot imminent";
break;
}
case (mpsoc::status_code::CORRUPT_DATA): {
return "Corrupt data";
break;
}
case (mpsoc::status_code::FLASH_CORRECTABLE_MISMATCH): {
return "Flash correctable mismatch";
break;
}
case (mpsoc::status_code::FLASH_UNCORRECTABLE_MISMATCH): {
return "Flash uncorrectable mismatch";
break;
}
default:
break;
}
return "";
}