2023-11-09 10:36:45 +01:00
|
|
|
#include "FreshDeviceHandlerBase.h"
|
|
|
|
|
2023-11-09 11:04:45 +01:00
|
|
|
#include "fsfw/devicehandlers/DeviceHandlerFailureIsolation.h"
|
2023-11-09 10:36:45 +01:00
|
|
|
#include "fsfw/ipc/QueueFactory.h"
|
|
|
|
#include "fsfw/subsystem/helper.h"
|
|
|
|
|
|
|
|
FreshDeviceHandlerBase::FreshDeviceHandlerBase(DhbConfig config)
|
|
|
|
: SystemObject(config.objectId),
|
|
|
|
actionHelper(this, nullptr),
|
|
|
|
modeHelper(this),
|
|
|
|
healthHelper(this, getObjectId()),
|
2023-11-15 10:03:56 +01:00
|
|
|
paramHelper(this),
|
2023-11-09 11:04:45 +01:00
|
|
|
poolManager(this, nullptr),
|
|
|
|
defaultFdirParent(config.defaultFdirParent) {
|
2023-11-09 10:36:45 +01:00
|
|
|
auto mqArgs = MqArgs(config.objectId, static_cast<void*>(this));
|
|
|
|
messageQueue = QueueFactory::instance()->createMessageQueue(
|
|
|
|
config.msgQueueDepth, MessageQueueMessage::MAX_MESSAGE_SIZE, &mqArgs);
|
|
|
|
}
|
|
|
|
FreshDeviceHandlerBase::~FreshDeviceHandlerBase() {
|
|
|
|
QueueFactory::instance()->deleteMessageQueue(messageQueue);
|
2023-11-09 11:04:45 +01:00
|
|
|
if (not hasCustomFdir) {
|
|
|
|
delete fdirInstance;
|
|
|
|
}
|
2023-11-09 10:36:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
[[nodiscard]] object_id_t FreshDeviceHandlerBase::getObjectId() const {
|
|
|
|
return SystemObject::getObjectId();
|
|
|
|
}
|
|
|
|
|
|
|
|
ReturnValue_t FreshDeviceHandlerBase::performOperation(uint8_t opCode) {
|
2023-11-21 17:40:06 +01:00
|
|
|
performDeviceOperationPreQueueHandling(opCode);
|
2023-11-09 10:36:45 +01:00
|
|
|
handleQueue();
|
|
|
|
performDeviceOperation(opCode);
|
2023-11-15 11:39:04 +01:00
|
|
|
poolManager.performHkOperation();
|
2023-11-09 10:36:45 +01:00
|
|
|
return returnvalue::OK;
|
2023-11-21 17:37:02 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
ReturnValue_t FreshDeviceHandlerBase::performDeviceOperationPreQueueHandling(uint8_t opCode) {
|
|
|
|
return returnvalue::OK;
|
2023-11-09 10:36:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
void FreshDeviceHandlerBase::startTransition(Mode_t mode_, Submode_t submode_) {
|
|
|
|
triggerEvent(CHANGING_MODE, mode_, submode_);
|
2023-11-09 17:18:33 +01:00
|
|
|
// Complete mode transition immediately by default.
|
|
|
|
setMode(mode_, submode_);
|
|
|
|
}
|
|
|
|
|
|
|
|
void FreshDeviceHandlerBase::setMode(Mode_t newMode, Submode_t newSubmode) {
|
|
|
|
mode = newMode;
|
|
|
|
submode = newSubmode;
|
2023-11-09 10:36:45 +01:00
|
|
|
modeHelper.modeChanged(mode, submode);
|
|
|
|
modeChanged(mode, submode);
|
|
|
|
announceMode(false);
|
|
|
|
}
|
|
|
|
|
2023-11-09 17:18:33 +01:00
|
|
|
void FreshDeviceHandlerBase::setMode(Mode_t newMode) { setMode(newMode, submode); }
|
|
|
|
|
2023-11-09 10:36:45 +01:00
|
|
|
void FreshDeviceHandlerBase::getMode(Mode_t* mode_, Submode_t* submode_) {
|
|
|
|
*mode_ = this->mode;
|
|
|
|
*submode_ = this->submode;
|
|
|
|
}
|
|
|
|
|
|
|
|
void FreshDeviceHandlerBase::announceMode(bool recursive) {
|
|
|
|
triggerEvent(MODE_INFO, mode, submode);
|
|
|
|
}
|
|
|
|
|
|
|
|
void FreshDeviceHandlerBase::modeChanged(Mode_t mode_, Submode_t submode_) {}
|
|
|
|
|
|
|
|
[[nodiscard]] MessageQueueId_t FreshDeviceHandlerBase::getCommandQueue() const {
|
|
|
|
return messageQueue->getId();
|
|
|
|
}
|
|
|
|
|
|
|
|
ReturnValue_t FreshDeviceHandlerBase::handleQueue() {
|
|
|
|
CommandMessage command;
|
|
|
|
ReturnValue_t result;
|
|
|
|
for (result = messageQueue->receiveMessage(&command); result == returnvalue::OK;
|
|
|
|
result = messageQueue->receiveMessage(&command)) {
|
|
|
|
result = actionHelper.handleActionMessage(&command);
|
|
|
|
if (result == returnvalue::OK) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
result = modeHelper.handleModeCommand(&command);
|
|
|
|
if (result == returnvalue::OK) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
result = healthHelper.handleHealthCommand(&command);
|
|
|
|
if (result == returnvalue::OK) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2023-11-15 10:03:56 +01:00
|
|
|
result = paramHelper.handleParameterMessage(&command);
|
|
|
|
if (result == returnvalue::OK) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2023-11-09 10:36:45 +01:00
|
|
|
result = poolManager.handleHousekeepingMessage(&command);
|
|
|
|
if (result == returnvalue::OK) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
result = handleCommandMessage(&command);
|
|
|
|
if (result == returnvalue::OK) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
command.setToUnknownCommand();
|
|
|
|
messageQueue->reply(&command);
|
|
|
|
}
|
2023-11-09 10:45:21 +01:00
|
|
|
return result;
|
2023-11-09 10:36:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
HasHealthIF::HealthState FreshDeviceHandlerBase::getHealth() { return healthHelper.getHealth(); }
|
|
|
|
|
|
|
|
const HasHealthIF* FreshDeviceHandlerBase::getOptHealthIF() const { return this; }
|
|
|
|
|
|
|
|
const HasModesIF& FreshDeviceHandlerBase::getModeIF() const { return *this; }
|
|
|
|
|
|
|
|
ModeTreeChildIF& FreshDeviceHandlerBase::getModeTreeChildIF() { return *this; }
|
|
|
|
|
|
|
|
ReturnValue_t FreshDeviceHandlerBase::connectModeTreeParent(HasModeTreeChildrenIF& parent) {
|
|
|
|
return modetree::connectModeTreeParent(parent, *this, &healthHelper, modeHelper);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Executable Overrides.
|
|
|
|
void FreshDeviceHandlerBase::setTaskIF(PeriodicTaskIF* task_) { executingTask = task_; }
|
|
|
|
|
|
|
|
// Pool Manager overrides.
|
|
|
|
LocalDataPoolManager* FreshDeviceHandlerBase::getHkManagerHandle() { return &poolManager; }
|
|
|
|
|
|
|
|
[[nodiscard]] uint32_t FreshDeviceHandlerBase::getPeriodicOperationFrequency() const {
|
|
|
|
return this->executingTask->getPeriodMs();
|
|
|
|
}
|
|
|
|
|
|
|
|
ReturnValue_t FreshDeviceHandlerBase::initializeAfterTaskCreation() {
|
|
|
|
return poolManager.initializeAfterTaskCreation();
|
|
|
|
}
|
|
|
|
|
|
|
|
ReturnValue_t FreshDeviceHandlerBase::setHealth(HasHealthIF::HealthState health) {
|
2023-11-09 10:45:21 +01:00
|
|
|
// Assembly should handle commanding to OFF.
|
2023-11-09 10:36:45 +01:00
|
|
|
healthHelper.setHealth(health);
|
|
|
|
return returnvalue::OK;
|
|
|
|
}
|
|
|
|
|
2023-11-09 11:04:45 +01:00
|
|
|
void FreshDeviceHandlerBase::triggerEvent(Event event, uint32_t parameter1, uint32_t parameter2) {
|
|
|
|
fdirInstance->triggerEvent(event, parameter1, parameter2);
|
|
|
|
}
|
|
|
|
|
|
|
|
void FreshDeviceHandlerBase::forwardEvent(Event event, uint32_t parameter1,
|
|
|
|
uint32_t parameter2) const {
|
|
|
|
fdirInstance->triggerEvent(event, parameter1, parameter2);
|
|
|
|
}
|
|
|
|
|
|
|
|
void FreshDeviceHandlerBase::setToExternalControl() { setHealth(HealthState::EXTERNAL_CONTROL); }
|
|
|
|
|
2023-11-09 10:36:45 +01:00
|
|
|
// System Object overrides.
|
|
|
|
ReturnValue_t FreshDeviceHandlerBase::initialize() {
|
|
|
|
ReturnValue_t result = modeHelper.initialize();
|
|
|
|
if (result != returnvalue::OK) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
result = healthHelper.initialize();
|
|
|
|
if (result != returnvalue::OK) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
result = actionHelper.initialize(messageQueue);
|
|
|
|
if (result != returnvalue::OK) {
|
|
|
|
return result;
|
|
|
|
}
|
2023-11-15 10:03:56 +01:00
|
|
|
result = paramHelper.initialize();
|
|
|
|
if (result != returnvalue::OK) {
|
|
|
|
return result;
|
|
|
|
}
|
2023-11-09 10:36:45 +01:00
|
|
|
|
|
|
|
result = poolManager.initialize(messageQueue);
|
|
|
|
if (result != returnvalue::OK) {
|
|
|
|
return result;
|
|
|
|
}
|
2023-11-09 11:04:45 +01:00
|
|
|
if (fdirInstance == nullptr) {
|
|
|
|
hasCustomFdir = false;
|
|
|
|
fdirInstance = new DeviceHandlerFailureIsolation(getObjectId(), defaultFdirParent);
|
|
|
|
}
|
|
|
|
|
|
|
|
result = fdirInstance->initialize();
|
|
|
|
if (result != returnvalue::OK) {
|
|
|
|
return result;
|
|
|
|
}
|
2023-11-09 10:36:45 +01:00
|
|
|
return SystemObject::initialize();
|
|
|
|
}
|
2023-11-15 10:03:56 +01:00
|
|
|
|
2023-11-09 11:04:45 +01:00
|
|
|
ReturnValue_t FreshDeviceHandlerBase::getParameter(uint8_t domainId, uint8_t uniqueId,
|
|
|
|
ParameterWrapper* parameterWrapper,
|
|
|
|
const ParameterWrapper* newValues,
|
|
|
|
uint16_t startAtIndex) {
|
|
|
|
ReturnValue_t result =
|
|
|
|
fdirInstance->getParameter(domainId, uniqueId, parameterWrapper, newValues, startAtIndex);
|
|
|
|
if (result != INVALID_DOMAIN_ID) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
return INVALID_DOMAIN_ID;
|
2023-11-09 17:18:33 +01:00
|
|
|
}
|