2021-07-13 20:22:54 +02:00
|
|
|
#include "fsfw/tmtcservices/PusServiceBase.h"
|
2020-12-14 21:30:39 +01:00
|
|
|
|
2022-02-02 10:29:30 +01:00
|
|
|
#include "fsfw/ipc/QueueFactory.h"
|
2021-07-13 20:22:54 +02:00
|
|
|
#include "fsfw/objectmanager/ObjectManager.h"
|
|
|
|
#include "fsfw/serviceinterface/ServiceInterface.h"
|
|
|
|
#include "fsfw/tcdistribution/PUSDistributorIF.h"
|
2022-02-02 10:29:30 +01:00
|
|
|
#include "fsfw/tmtcservices/AcceptsTelemetryIF.h"
|
|
|
|
#include "fsfw/tmtcservices/PusVerificationReport.h"
|
|
|
|
#include "fsfw/tmtcservices/TmTcMessage.h"
|
2022-07-21 13:48:58 +02:00
|
|
|
#include "fsfw/tmtcservices/tcHelpers.h"
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2018-07-12 16:29:32 +02:00
|
|
|
object_id_t PusServiceBase::packetSource = 0;
|
|
|
|
object_id_t PusServiceBase::packetDestination = 0;
|
|
|
|
|
2022-07-26 13:59:09 +02:00
|
|
|
PusServiceBase::PusServiceBase(object_id_t setObjectId, uint16_t setApid, uint8_t setServiceId,
|
|
|
|
VerificationReporterIF* verifyReporter)
|
|
|
|
: SystemObject(setObjectId),
|
|
|
|
apid(setApid),
|
|
|
|
serviceId(setServiceId),
|
|
|
|
verifyReporter(verifyReporter) {
|
2022-02-02 10:29:30 +01:00
|
|
|
requestQueue = QueueFactory::instance()->createMessageQueue(PUS_SERVICE_MAX_RECEPTION);
|
2016-06-15 23:48:41 +02:00
|
|
|
}
|
|
|
|
|
2022-02-02 10:29:30 +01:00
|
|
|
PusServiceBase::~PusServiceBase() { QueueFactory::instance()->deleteMessageQueue(requestQueue); }
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2018-07-12 16:29:32 +02:00
|
|
|
ReturnValue_t PusServiceBase::performOperation(uint8_t opCode) {
|
2022-02-02 10:29:30 +01:00
|
|
|
handleRequestQueue();
|
2022-07-26 14:14:00 +02:00
|
|
|
ReturnValue_t result = performService();
|
2022-02-02 10:29:30 +01:00
|
|
|
if (result != RETURN_OK) {
|
2021-01-03 14:16:52 +01:00
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::error << "PusService " << (uint16_t)this->serviceId << ": performService returned with "
|
|
|
|
<< (int16_t)result << std::endl;
|
2021-01-03 13:58:18 +01:00
|
|
|
#endif
|
2022-02-02 10:29:30 +01:00
|
|
|
return RETURN_FAILED;
|
|
|
|
}
|
|
|
|
return RETURN_OK;
|
2020-06-10 20:49:30 +02:00
|
|
|
}
|
|
|
|
|
2022-07-19 18:13:25 +02:00
|
|
|
void PusServiceBase::setTaskIF(PeriodicTaskIF* taskHandle_) { this->taskHandle = taskHandle_; }
|
2020-06-29 16:57:00 +02:00
|
|
|
|
2020-06-10 20:49:30 +02:00
|
|
|
void PusServiceBase::handleRequestQueue() {
|
2022-02-02 10:29:30 +01:00
|
|
|
TmTcMessage message;
|
2022-07-20 22:21:15 +02:00
|
|
|
ReturnValue_t result;
|
2022-02-02 10:29:30 +01:00
|
|
|
for (uint8_t count = 0; count < PUS_SERVICE_MAX_RECEPTION; count++) {
|
|
|
|
ReturnValue_t status = this->requestQueue->receiveMessage(&message);
|
2022-07-21 11:34:11 +02:00
|
|
|
if (status == MessageQueueIF::EMPTY) {
|
2022-02-02 10:29:30 +01:00
|
|
|
break;
|
2022-07-21 11:34:11 +02:00
|
|
|
} else if (status != HasReturnvaluesIF::RETURN_OK) {
|
2021-01-03 14:16:52 +01:00
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::error << "PusServiceBase::performOperation: Service " << this->serviceId
|
|
|
|
<< ": Error receiving packet. Code: " << std::hex << status << std::dec
|
|
|
|
<< std::endl;
|
2022-07-21 11:34:11 +02:00
|
|
|
#else
|
|
|
|
sif::printError(
|
|
|
|
"PusServiceBase::performOperation: Service %d. Error receiving packet. Code: %04x\n",
|
|
|
|
serviceId, status);
|
2021-01-03 13:58:18 +01:00
|
|
|
#endif
|
2022-07-21 11:34:11 +02:00
|
|
|
break;
|
|
|
|
}
|
2022-07-21 13:48:58 +02:00
|
|
|
result = tc::prepareTcReader(tcStore, message.getStorageId(), currentPacket);
|
2022-07-21 11:34:11 +02:00
|
|
|
if (result != HasReturnvaluesIF::RETURN_OK) {
|
2022-07-26 13:59:09 +02:00
|
|
|
auto params = VerifFailureParams(tcverif::START_FAILURE, currentPacket, result);
|
|
|
|
params.errorParam1 = errorParameter1;
|
|
|
|
params.errorParam2 = errorParameter2;
|
|
|
|
verifyReporter->sendFailureReport(params);
|
2022-07-21 11:34:11 +02:00
|
|
|
continue;
|
|
|
|
}
|
2022-07-26 13:59:09 +02:00
|
|
|
result = handleRequest(currentPacket.getSubService());
|
2022-07-21 11:34:11 +02:00
|
|
|
if (result == RETURN_OK) {
|
2022-07-26 13:59:09 +02:00
|
|
|
verifyReporter->sendSuccessReport(
|
|
|
|
VerifSuccessParams(tcverif::COMPLETION_SUCCESS, currentPacket));
|
2022-07-21 11:34:11 +02:00
|
|
|
} else {
|
2022-07-26 13:59:09 +02:00
|
|
|
auto params = VerifFailureParams(tcverif::COMPLETION_FAILURE, currentPacket, result);
|
|
|
|
params.errorParam1 = errorParameter1;
|
|
|
|
params.errorParam2 = errorParameter2;
|
|
|
|
verifyReporter->sendFailureReport(params);
|
2021-12-03 15:37:49 +01:00
|
|
|
}
|
2022-07-21 13:48:58 +02:00
|
|
|
tcStore->deleteData(message.getStorageId());
|
2022-07-21 11:34:11 +02:00
|
|
|
errorParameter1 = 0;
|
|
|
|
errorParameter2 = 0;
|
2022-02-02 10:29:30 +01:00
|
|
|
}
|
2016-06-15 23:48:41 +02:00
|
|
|
}
|
|
|
|
|
2022-02-02 10:29:30 +01:00
|
|
|
uint16_t PusServiceBase::getIdentifier() { return this->serviceId; }
|
2016-06-15 23:48:41 +02:00
|
|
|
|
2022-02-02 10:29:30 +01:00
|
|
|
MessageQueueId_t PusServiceBase::getRequestQueue() { return this->requestQueue->getId(); }
|
2016-06-15 23:48:41 +02:00
|
|
|
|
|
|
|
ReturnValue_t PusServiceBase::initialize() {
|
2022-02-02 10:29:30 +01:00
|
|
|
ReturnValue_t result = SystemObject::initialize();
|
|
|
|
if (result != RETURN_OK) {
|
|
|
|
return result;
|
|
|
|
}
|
2022-07-19 18:13:25 +02:00
|
|
|
auto* destService = ObjectManager::instance()->get<AcceptsTelemetryIF>(packetDestination);
|
|
|
|
auto* distributor = ObjectManager::instance()->get<PUSDistributorIF>(packetSource);
|
2022-02-02 10:29:30 +01:00
|
|
|
if (destService == nullptr or distributor == nullptr) {
|
2021-01-03 14:16:52 +01:00
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
2022-02-02 10:29:30 +01:00
|
|
|
sif::error << "PusServiceBase::PusServiceBase: Service " << this->serviceId
|
|
|
|
<< ": Configuration error. Make sure "
|
|
|
|
<< "packetSource and packetDestination are defined correctly" << std::endl;
|
2021-01-03 13:58:18 +01:00
|
|
|
#endif
|
2022-02-02 10:29:30 +01:00
|
|
|
return ObjectManagerIF::CHILD_INIT_FAILED;
|
|
|
|
}
|
|
|
|
this->requestQueue->setDefaultDestination(destService->getReportReceptionQueue());
|
|
|
|
distributor->registerService(this);
|
2022-07-21 13:48:58 +02:00
|
|
|
if (tcStore == nullptr) {
|
|
|
|
tcStore = ObjectManager::instance()->get<StorageManagerIF>(objects::IPC_STORE);
|
|
|
|
if (tcStore == nullptr) {
|
2022-07-20 11:43:16 +02:00
|
|
|
return ObjectManagerIF::CHILD_INIT_FAILED;
|
|
|
|
}
|
|
|
|
}
|
2022-07-26 13:59:09 +02:00
|
|
|
if (verifyReporter == nullptr) {
|
|
|
|
verifyReporter =
|
|
|
|
ObjectManager::instance()->get<VerificationReporterIF>(objects::TC_VERIFICATOR);
|
|
|
|
if (verifyReporter == nullptr) {
|
|
|
|
return ObjectManagerIF::CHILD_INIT_FAILED;
|
|
|
|
}
|
|
|
|
}
|
2022-02-02 10:29:30 +01:00
|
|
|
return HasReturnvaluesIF::RETURN_OK;
|
2016-06-15 23:48:41 +02:00
|
|
|
}
|
2020-06-29 16:57:00 +02:00
|
|
|
|
|
|
|
ReturnValue_t PusServiceBase::initializeAfterTaskCreation() {
|
2022-02-02 10:29:30 +01:00
|
|
|
// If task parameters, for example task frequency are required, this
|
|
|
|
// function should be overriden and the system object task IF can
|
|
|
|
// be used to get those parameters.
|
|
|
|
return HasReturnvaluesIF::RETURN_OK;
|
2020-06-29 16:57:00 +02:00
|
|
|
}
|
2022-07-20 22:21:15 +02:00
|
|
|
|
2022-07-21 13:48:58 +02:00
|
|
|
void PusServiceBase::setCustomTcStore(StorageManagerIF* tcStore_) { tcStore = tcStore_; }
|
2022-07-20 22:21:15 +02:00
|
|
|
|
|
|
|
void PusServiceBase::setCustomErrorReporter(InternalErrorReporterIF* errReporter_) {
|
|
|
|
errReporter = errReporter_;
|
|
|
|
}
|
|
|
|
|
|
|
|
void PusServiceBase::initializeTmHelpers(TmSendHelper& tmSendHelper, TmStoreHelper& tmStoreHelper) {
|
|
|
|
initializeTmSendHelper(tmSendHelper);
|
|
|
|
initializeTmStoreHelper(tmStoreHelper);
|
|
|
|
}
|
|
|
|
|
|
|
|
void PusServiceBase::initializeTmSendHelper(TmSendHelper& tmSendHelper) {
|
2022-07-25 20:31:06 +02:00
|
|
|
tmSendHelper.setMsgQueue(*requestQueue);
|
|
|
|
tmSendHelper.setDefaultDestination(requestQueue->getDefaultDestination());
|
2022-07-20 22:21:15 +02:00
|
|
|
if (errReporter == nullptr) {
|
|
|
|
errReporter =
|
|
|
|
ObjectManager::instance()->get<InternalErrorReporterIF>(objects::INTERNAL_ERROR_REPORTER);
|
|
|
|
if (errReporter != nullptr) {
|
|
|
|
tmSendHelper.setInternalErrorReporter(errReporter);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void PusServiceBase::initializeTmStoreHelper(TmStoreHelper& tmStoreHelper) const {
|
|
|
|
tmStoreHelper.setApid(apid);
|
|
|
|
}
|
2022-07-26 13:59:09 +02:00
|
|
|
|
|
|
|
void PusServiceBase::setVerificationReporter(VerificationReporterIF* reporter) {
|
|
|
|
verifyReporter = reporter;
|
|
|
|
}
|