489 lines
16 KiB
C++
489 lines
16 KiB
C++
#include <linux/payload/PlocMpsocHelper.h>
|
|
|
|
#include <filesystem>
|
|
#include <fstream>
|
|
|
|
#ifdef XIPHOS_Q7S
|
|
#include "bsp_q7s/fs/FilesystemHelper.h"
|
|
#endif
|
|
|
|
#include "mission/utility/Timestamp.h"
|
|
|
|
using namespace ploc;
|
|
|
|
PlocMPSoCHelper::PlocMPSoCHelper(object_id_t objectId) : SystemObject(objectId) {
|
|
spParams.buf = commandBuffer;
|
|
spParams.maxSize = sizeof(commandBuffer);
|
|
}
|
|
|
|
PlocMPSoCHelper::~PlocMPSoCHelper() {}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::initialize() {
|
|
#ifdef XIPHOS_Q7S
|
|
sdcMan = SdCardManager::instance();
|
|
if (sdcMan == nullptr) {
|
|
sif::warning << "PlocMPSoCHelper::initialize: Invalid SD Card Manager" << std::endl;
|
|
return returnvalue::FAILED;
|
|
}
|
|
#endif
|
|
return returnvalue::OK;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::performOperation(uint8_t operationCode) {
|
|
ReturnValue_t result = returnvalue::OK;
|
|
semaphore.acquire();
|
|
while (true) {
|
|
#if OBSW_THREAD_TRACING == 1
|
|
trace::threadTrace(opCounter, "PLOC MPSOC Helper");
|
|
#endif
|
|
switch (internalState) {
|
|
case InternalState::IDLE: {
|
|
semaphore.acquire();
|
|
break;
|
|
}
|
|
case InternalState::FLASH_WRITE: {
|
|
result = performFlashWrite();
|
|
if (result == returnvalue::OK) {
|
|
triggerEvent(MPSOC_FLASH_WRITE_SUCCESSFUL);
|
|
} else {
|
|
triggerEvent(MPSOC_FLASH_WRITE_FAILED);
|
|
}
|
|
internalState = InternalState::IDLE;
|
|
break;
|
|
}
|
|
case InternalState::FLASH_READ: {
|
|
result = performFlashRead();
|
|
if (result == returnvalue::OK) {
|
|
triggerEvent(MPSOC_FLASH_READ_SUCCESSFUL);
|
|
} else {
|
|
triggerEvent(MPSOC_FLASH_READ_FAILED);
|
|
}
|
|
internalState = InternalState::IDLE;
|
|
break;
|
|
}
|
|
default:
|
|
sif::debug << "PlocMPSoCHelper::performOperation: Invalid state" << std::endl;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::setComIF(DeviceCommunicationIF* communicationInterface_) {
|
|
uartComIF = dynamic_cast<SerialComIF*>(communicationInterface_);
|
|
if (uartComIF == nullptr) {
|
|
sif::warning << "PlocMPSoCHelper::initialize: Invalid uart com if" << std::endl;
|
|
return returnvalue::FAILED;
|
|
}
|
|
return returnvalue::OK;
|
|
}
|
|
|
|
void PlocMPSoCHelper::setComCookie(CookieIF* comCookie_) { comCookie = comCookie_; }
|
|
|
|
void PlocMPSoCHelper::setSequenceCount(SourceSequenceCounter* sequenceCount_) {
|
|
sequenceCount = sequenceCount_;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::startFlashWrite(std::string obcFile, std::string mpsocFile) {
|
|
ReturnValue_t result = startFlashReadOrWriteBase(std::move(obcFile), std::move(mpsocFile));
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
internalState = InternalState::FLASH_WRITE;
|
|
return result;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::startFlashRead(std::string obcFile, std::string mpsocFile,
|
|
size_t readFileSize) {
|
|
ReturnValue_t result = startFlashReadOrWriteBase(std::move(obcFile), std::move(mpsocFile));
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
flashReadAndWrite.totalReadSize = readFileSize;
|
|
internalState = InternalState::FLASH_READ;
|
|
return result;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::resetHelper() {
|
|
ReturnValue_t result = returnvalue::OK;
|
|
semaphore.release();
|
|
spParams.buf = commandBuffer;
|
|
terminate = false;
|
|
result = uartComIF->flushUartRxBuffer(comCookie);
|
|
return result;
|
|
}
|
|
|
|
void PlocMPSoCHelper::stopProcess() { terminate = true; }
|
|
|
|
ReturnValue_t PlocMPSoCHelper::performFlashWrite() {
|
|
ReturnValue_t result = returnvalue::OK;
|
|
std::ifstream file(flashReadAndWrite.obcFile, std::ifstream::binary);
|
|
if (file.bad()) {
|
|
return returnvalue::FAILED;
|
|
}
|
|
result = flashfopen();
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
// Set position of next character to end of file input stream
|
|
file.seekg(0, file.end);
|
|
// tellg returns position of character in input stream
|
|
size_t remainingSize = file.tellg();
|
|
size_t dataLength = 0;
|
|
size_t bytesRead = 0;
|
|
while (remainingSize > 0) {
|
|
if (terminate) {
|
|
flashfclose();
|
|
return returnvalue::OK;
|
|
}
|
|
if (remainingSize > mpsoc::SP_MAX_DATA_SIZE) {
|
|
dataLength = mpsoc::SP_MAX_DATA_SIZE;
|
|
} else {
|
|
dataLength = remainingSize;
|
|
}
|
|
if (file.bad() or not file.is_open()) {
|
|
flashfclose();
|
|
return FILE_WRITE_ERROR;
|
|
}
|
|
file.seekg(bytesRead, file.beg);
|
|
file.read(reinterpret_cast<char*>(fileBuf.data()), dataLength);
|
|
bytesRead += dataLength;
|
|
remainingSize -= dataLength;
|
|
(*sequenceCount)++;
|
|
mpsoc::TcFlashWrite tc(spParams, *sequenceCount);
|
|
result = tc.buildPacket(fileBuf.data(), dataLength);
|
|
if (result != returnvalue::OK) {
|
|
flashfclose();
|
|
return result;
|
|
}
|
|
result = handlePacketTransmissionNoReply(tc);
|
|
if (result != returnvalue::OK) {
|
|
flashfclose();
|
|
return result;
|
|
}
|
|
}
|
|
result = flashfclose();
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
return result;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::performFlashRead() {
|
|
std::error_code e;
|
|
std::ofstream ofile(flashReadAndWrite.obcFile, std::ios::trunc | std::ios::binary);
|
|
if (ofile.bad()) {
|
|
return returnvalue::FAILED;
|
|
}
|
|
ReturnValue_t result = flashfopen();
|
|
if (result != returnvalue::OK) {
|
|
std::filesystem::remove(flashReadAndWrite.obcFile, e);
|
|
return result;
|
|
}
|
|
size_t readSoFar = 0;
|
|
size_t nextReadSize = mpsoc::MAX_FLASH_READ_DATA_SIZE;
|
|
while (readSoFar < flashReadAndWrite.totalReadSize) {
|
|
if (terminate) {
|
|
std::filesystem::remove(flashReadAndWrite.obcFile, e);
|
|
flashfclose();
|
|
return returnvalue::OK;
|
|
}
|
|
nextReadSize = mpsoc::MAX_FLASH_READ_DATA_SIZE;
|
|
if (flashReadAndWrite.totalReadSize - readSoFar < mpsoc::MAX_FLASH_READ_DATA_SIZE) {
|
|
nextReadSize = flashReadAndWrite.totalReadSize - readSoFar;
|
|
}
|
|
if (ofile.bad() or not ofile.is_open()) {
|
|
std::filesystem::remove(flashReadAndWrite.obcFile, e);
|
|
flashfclose();
|
|
return FILE_READ_ERROR;
|
|
}
|
|
mpsoc::TcFlashRead flashReadRequest(spParams, *sequenceCount);
|
|
result = flashReadRequest.buildPacket(nextReadSize);
|
|
if (result != returnvalue::OK) {
|
|
std::filesystem::remove(flashReadAndWrite.obcFile, e);
|
|
flashfclose();
|
|
return result;
|
|
}
|
|
result = handlePacketTransmissionFlashRead(flashReadRequest);
|
|
if (result != returnvalue::OK) {
|
|
std::filesystem::remove(flashReadAndWrite.obcFile, e);
|
|
flashfclose();
|
|
return result;
|
|
}
|
|
result = handleFlashReadReply(ofile, nextReadSize);
|
|
if (result != returnvalue::OK) {
|
|
std::filesystem::remove(flashReadAndWrite.obcFile, e);
|
|
flashfclose();
|
|
return result;
|
|
}
|
|
(*sequenceCount)++;
|
|
readSoFar += nextReadSize;
|
|
}
|
|
return result;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::flashfopen() {
|
|
spParams.buf = commandBuffer;
|
|
(*sequenceCount)++;
|
|
mpsoc::FlashFopen flashFopen(spParams, *sequenceCount);
|
|
ReturnValue_t result =
|
|
flashFopen.createPacket(flashReadAndWrite.mpsocFile, mpsoc::FlashFopen::APPEND);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
result = handlePacketTransmissionNoReply(flashFopen);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
return returnvalue::OK;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::flashfclose() {
|
|
spParams.buf = commandBuffer;
|
|
(*sequenceCount)++;
|
|
mpsoc::FlashFclose flashFclose(spParams, *sequenceCount);
|
|
ReturnValue_t result = flashFclose.createPacket(flashReadAndWrite.mpsocFile);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
return handlePacketTransmissionNoReply(flashFclose);
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::handlePacketTransmissionFlashRead(mpsoc::TcFlashRead& tc) {
|
|
ReturnValue_t result = sendCommand(tc);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
result = handleAck();
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
result = handleTmReception(ccsds::HEADER_LEN + mpsoc::FLASH_READ_MIN_OVERHEAD + tc.readSize +
|
|
mpsoc::CRC_SIZE);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
return handleExe();
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::handlePacketTransmissionNoReply(ploc::SpTcBase& tc) {
|
|
ReturnValue_t result = sendCommand(tc);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
result = handleAck();
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
return handleExe();
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::sendCommand(ploc::SpTcBase& tc) {
|
|
ReturnValue_t result = returnvalue::OK;
|
|
result = uartComIF->sendMessage(comCookie, tc.getFullPacket(), tc.getFullPacketLen());
|
|
if (result != returnvalue::OK) {
|
|
sif::warning << "PlocMPSoCHelper::sendCommand: Failed to send command" << std::endl;
|
|
triggerEvent(MPSOC_SENDING_COMMAND_FAILED, result, static_cast<uint32_t>(internalState));
|
|
return result;
|
|
}
|
|
return result;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::handleAck() {
|
|
ReturnValue_t result = returnvalue::OK;
|
|
result = handleTmReception(mpsoc::SIZE_ACK_REPORT);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
SpTmReader tmPacket(tmBuf.data(), tmBuf.size());
|
|
result = checkReceivedTm(tmPacket);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
uint16_t apid = tmPacket.getApid();
|
|
if (apid != mpsoc::apid::ACK_SUCCESS) {
|
|
handleAckApidFailure(apid);
|
|
return returnvalue::FAILED;
|
|
}
|
|
return returnvalue::OK;
|
|
}
|
|
|
|
void PlocMPSoCHelper::handleAckApidFailure(uint16_t apid) {
|
|
if (apid == mpsoc::apid::ACK_FAILURE) {
|
|
triggerEvent(MPSOC_ACK_FAILURE_REPORT, static_cast<uint32_t>(internalState));
|
|
sif::warning << "PlocMPSoCHelper::handleAckApidFailure: Received acknowledgement failure "
|
|
<< "report" << std::endl;
|
|
} else {
|
|
triggerEvent(MPSOC_ACK_INVALID_APID, apid, static_cast<uint32_t>(internalState));
|
|
sif::warning << "PlocMPSoCHelper::handleAckApidFailure: Expected acknowledgement report "
|
|
<< "but received space packet with apid " << std::hex << apid << std::endl;
|
|
}
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::handleExe() {
|
|
ReturnValue_t result = returnvalue::OK;
|
|
|
|
result = handleTmReception(mpsoc::SIZE_EXE_REPORT);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
ploc::SpTmReader tmPacket(tmBuf.data(), tmBuf.size());
|
|
result = checkReceivedTm(tmPacket);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
uint16_t apid = tmPacket.getApid();
|
|
if (apid != mpsoc::apid::EXE_SUCCESS) {
|
|
handleExeApidFailure(apid);
|
|
return returnvalue::FAILED;
|
|
}
|
|
return returnvalue::OK;
|
|
}
|
|
|
|
void PlocMPSoCHelper::handleExeApidFailure(uint16_t apid) {
|
|
if (apid == mpsoc::apid::EXE_FAILURE) {
|
|
triggerEvent(MPSOC_EXE_FAILURE_REPORT, static_cast<uint32_t>(internalState));
|
|
sif::warning << "PlocMPSoCHelper::handleExeApidFailure: Received execution failure "
|
|
<< "report" << std::endl;
|
|
} else {
|
|
triggerEvent(MPSOC_EXE_INVALID_APID, apid, static_cast<uint32_t>(internalState));
|
|
sif::warning << "PlocMPSoCHelper::handleExeApidFailure: Expected execution report "
|
|
<< "but received space packet with apid " << std::hex << apid << std::endl;
|
|
}
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::handleTmReception(size_t remainingBytes) {
|
|
ReturnValue_t result = returnvalue::OK;
|
|
size_t readBytes = 0;
|
|
size_t currentBytes = 0;
|
|
for (int retries = 0; retries < RETRIES; retries++) {
|
|
result = receive(tmBuf.data() + readBytes, ¤tBytes, remainingBytes);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
readBytes += currentBytes;
|
|
remainingBytes = remainingBytes - currentBytes;
|
|
if (remainingBytes == 0) {
|
|
break;
|
|
}
|
|
}
|
|
if (remainingBytes != 0) {
|
|
sif::warning << "PlocMPSoCHelper::handleTmReception: Failed to receive reply" << std::endl;
|
|
triggerEvent(MPSOC_MISSING_EXE, remainingBytes, static_cast<uint32_t>(internalState));
|
|
return returnvalue::FAILED;
|
|
}
|
|
return result;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::handleFlashReadReply(std::ofstream& ofile, size_t expectedReadLen) {
|
|
SpTmReader tmPacket(tmBuf.data(), tmBuf.size());
|
|
ReturnValue_t result = checkReceivedTm(tmPacket);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
uint16_t apid = tmPacket.getApid();
|
|
if (apid != mpsoc::apid::TM_FLASH_READ_REPORT) {
|
|
triggerEvent(MPSOC_FLASH_READ_PACKET_ERROR, FlashReadErrorType::FLASH_READ_APID_ERROR);
|
|
sif::warning << "PLOC MPSoC Flash Read: Unexpected APID" << std::endl;
|
|
return result;
|
|
}
|
|
const uint8_t* packetData = tmPacket.getPacketData();
|
|
size_t deserDummy = tmPacket.getPacketDataLen() - mpsoc::CRC_SIZE;
|
|
uint32_t receivedReadLen = 0;
|
|
std::string receivedShortName = std::string(reinterpret_cast<const char*>(packetData), 12);
|
|
if (receivedShortName != flashReadAndWrite.mpsocFile.substr(0, 12)) {
|
|
sif::warning << "PLOC MPSoC Flash Read: Missmatch between request file name and "
|
|
"received file name"
|
|
<< std::endl;
|
|
triggerEvent(MPSOC_FLASH_READ_PACKET_ERROR, FlashReadErrorType::FLASH_READ_FILENAME_ERROR);
|
|
return returnvalue::FAILED;
|
|
}
|
|
packetData += 12;
|
|
result = SerializeAdapter::deSerialize(&receivedReadLen, &packetData, &deserDummy,
|
|
SerializeIF::Endianness::NETWORK);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
if (receivedReadLen != expectedReadLen) {
|
|
sif::warning << "PLOC MPSoC Flash Read: Missmatch between request read length and "
|
|
"received read length"
|
|
<< std::endl;
|
|
triggerEvent(MPSOC_FLASH_READ_PACKET_ERROR, FlashReadErrorType::FLASH_READ_READLEN_ERROR);
|
|
return returnvalue::FAILED;
|
|
}
|
|
ofile.write(reinterpret_cast<const char*>(packetData), receivedReadLen);
|
|
return returnvalue::OK;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::fileCheck(std::string obcFile) {
|
|
#ifdef XIPHOS_Q7S
|
|
ReturnValue_t result = FilesystemHelper::checkPath(obcFile);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
#elif defined(TE0720_1CFA)
|
|
if (not std::filesystem::exists(obcFile)) {
|
|
sif::warning << "PlocMPSoCHelper::startFlashWrite: File " << obcFile << "does not exist"
|
|
<< std::endl;
|
|
return returnvalue::FAILED;
|
|
}
|
|
#endif
|
|
return returnvalue::OK;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::startFlashReadOrWriteBase(std::string obcFile,
|
|
std::string mpsocFile) {
|
|
ReturnValue_t result = fileCheck(obcFile);
|
|
if (result != returnvalue::OK) {
|
|
return result;
|
|
}
|
|
|
|
flashReadAndWrite.obcFile = std::move(obcFile);
|
|
flashReadAndWrite.mpsocFile = std::move(mpsocFile);
|
|
return resetHelper();
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::checkReceivedTm(SpTmReader& reader) {
|
|
ReturnValue_t result = reader.checkSize();
|
|
if (result != returnvalue::OK) {
|
|
sif::error << "PlocMPSoCHelper::handleTmReception: Size check on received TM failed"
|
|
<< std::endl;
|
|
triggerEvent(MPSOC_TM_SIZE_ERROR);
|
|
return result;
|
|
}
|
|
reader.checkCrc();
|
|
if (result != returnvalue::OK) {
|
|
sif::warning << "PlocMPSoCHelper::handleTmReception: CRC check failed" << std::endl;
|
|
triggerEvent(MPSOC_TM_CRC_MISSMATCH, *sequenceCount);
|
|
return result;
|
|
}
|
|
(*sequenceCount)++;
|
|
uint16_t recvSeqCnt = reader.getSequenceCount();
|
|
if (recvSeqCnt != *sequenceCount) {
|
|
triggerEvent(MPSOC_HELPER_SEQ_CNT_MISMATCH, *sequenceCount, recvSeqCnt);
|
|
*sequenceCount = recvSeqCnt;
|
|
}
|
|
return returnvalue::OK;
|
|
}
|
|
|
|
ReturnValue_t PlocMPSoCHelper::receive(uint8_t* data, size_t* readBytes, size_t requestBytes) {
|
|
ReturnValue_t result = returnvalue::OK;
|
|
uint8_t* buffer = nullptr;
|
|
result = uartComIF->requestReceiveMessage(comCookie, requestBytes);
|
|
if (result != returnvalue::OK) {
|
|
sif::warning << "PlocMPSoCHelper::receive: Failed to request reply" << std::endl;
|
|
triggerEvent(MPSOC_HELPER_REQUESTING_REPLY_FAILED, result,
|
|
static_cast<uint32_t>(static_cast<uint32_t>(internalState)));
|
|
return returnvalue::FAILED;
|
|
}
|
|
result = uartComIF->readReceivedMessage(comCookie, &buffer, readBytes);
|
|
if (result != returnvalue::OK) {
|
|
sif::warning << "PlocMPSoCHelper::receive: Failed to read received message" << std::endl;
|
|
triggerEvent(MPSOC_HELPER_READING_REPLY_FAILED, result, static_cast<uint32_t>(internalState));
|
|
return returnvalue::FAILED;
|
|
}
|
|
if (*readBytes > 0) {
|
|
std::memcpy(data, buffer, *readBytes);
|
|
}
|
|
return result;
|
|
}
|