add syrlinks assembly

bsp_q7s/core/CoreController.cpp

@@ -1224,7 +1224,7 @@ ReturnValue_t CoreController::handleProtInfoUpdateLine(std::string nextLine) {
       }
     }
     wordIdx++;
-    if(wordIdx >= 10) {
+    if (wordIdx >= 10) {
       break;
     }
   }

bsp_q7s/core/ObjectFactory.cpp

@@ -8,6 +8,7 @@
 #include <mission/devices/MgmLis3CustomHandler.h>
 #include <mission/devices/MgmRm3100CustomHandler.h>
 #include <mission/system/objects/CamSwitcher.h>
+#include <mission/system/objects/SyrlinksAssembly.h>
 
 #include "OBSWConfig.h"
 #include "bsp_q7s/boardtest/Q7STestTask.h"
@@ -579,12 +580,14 @@ void ObjectFactory::createSyrlinksComponents(PowerSwitchIF* pwrSwitcher) {
                        syrlinks::MAX_REPLY_SIZE, UartModes::NON_CANONICAL);
   syrlinksUartCookie->setParityEven();
 
+  auto* syrlinksAssy = new SyrlinksAssembly(objects::SYRLINKS_ASSY);
+  syrlinksAssy->connectModeTreeParent(satsystem::com::SUBSYSTEM);
   auto syrlinksFdir = new SyrlinksFdir(objects::SYRLINKS_HANDLER);
   auto syrlinksHandler =
       new SyrlinksHandler(objects::SYRLINKS_HANDLER, objects::UART_COM_IF, syrlinksUartCookie,
                           pcdu::PDU1_CH1_SYRLINKS_12V, syrlinksFdir);
   syrlinksHandler->setPowerSwitcher(pwrSwitcher);
-  syrlinksHandler->connectModeTreeParent(satsystem::com::SUBSYSTEM);
+  syrlinksHandler->connectModeTreeParent(*syrlinksAssy);
 #if OBSW_DEBUG_SYRLINKS == 1
   syrlinksHandler->setDebugMode(true);
 #endif

bsp_q7s/core/scheduling.cpp

@@ -150,6 +150,10 @@ void scheduling::initTasks() {
   if (result != returnvalue::OK) {
     scheduling::printAddObjectError("COM_SUBSYSTEM", objects::COM_SUBSYSTEM);
   }
+  result = genericSysTask->addComponent(objects::SYRLINKS_ASSY);
+  if (result != returnvalue::OK) {
+    scheduling::printAddObjectError("SYRLINKS_ASSY", objects::SYRLINKS_ASSY);
+  }
   result = genericSysTask->addComponent(objects::PL_SUBSYSTEM);
   if (result != returnvalue::OK) {
     scheduling::printAddObjectError("PL_SUBSYSTEM", objects::PL_SUBSYSTEM);

bsp_q7s/memory/LocalParameterHandler.h

@@ -19,8 +19,8 @@ class LocalParameterHandler : public NVMParameterBase {
    * @brief	Constructor
    *
    * @param sdRelativeName	Absolute name of json file relative to mount
-   * 												directory	of SD card.
-   * E.g. conf/example.json
+   * 												directory	of
+   * SD card. E.g. conf/example.json
    * @param sdcMan	Pointer to SD card manager
    */
   LocalParameterHandler(std::string sdRelativeName, SdCardMountedIF* sdcMan);

common/config/eive/objects.h

@@ -143,6 +143,7 @@ enum commonObjects : uint32_t {
   TCS_BOARD_ASS = 0x73000003,
   RW_ASS = 0x73000004,
   CAM_SWITCHER = 0x73000006,
+  SYRLINKS_ASSY = 0x73000007,
   EIVE_SYSTEM = 0x73010000,
   ACS_SUBSYSTEM = 0x73010001,
   PL_SUBSYSTEM = 0x73010002,

common/config/eive/resultClassIds.h

@@ -40,8 +40,8 @@ enum commonClassIds : uint8_t {
   ACS_SAFE,                 // ACSSAF
   ACS_PTG,                  // ACSPTG
   ACS_DETUMBLE,             // ACSDTB
-	SD_CARD_MANAGER,          // SDMA
-	LOCAL_PARAM_HANDLER,      // LPH
+  SD_CARD_MANAGER,          // SDMA
+  LOCAL_PARAM_HANDLER,      // LPH
   COMMON_CLASS_ID_END       // [EXPORT] : [END]
 };
 }

linux/fsfwconfig/returnvalues/classIds.h

@@ -13,8 +13,8 @@
 namespace CLASS_ID {
 enum {
   CLASS_ID_START = COMMON_CLASS_ID_END,
-  SCRATCH_BUFFER,       // SCBU
-  CLASS_ID_END          // [EXPORT] : [END]
+  SCRATCH_BUFFER,  // SCBU
+  CLASS_ID_END     // [EXPORT] : [END]
 };
 }
 

linux/ipcore/PdecHandler.cpp

@@ -164,8 +164,8 @@ ReturnValue_t PdecHandler::polledOperation() {
 
 // See https://yurovsky.github.io/2014/10/10/linux-uio-gpio-interrupt.html for more information.
 ReturnValue_t PdecHandler::irqOperation() {
-	ReturnValue_t result = returnvalue::OK;
-	int fd = -1;
+  ReturnValue_t result = returnvalue::OK;
+  int fd = -1;
   // Used to unmask IRQ
   uint32_t info = 1;
 
@@ -183,7 +183,7 @@ ReturnValue_t PdecHandler::irqOperation() {
       case State::INIT: {
         result = handleInitState();
         if (result == returnvalue::OK) {
-        	openIrqFile(&fd);
+          openIrqFile(&fd);
         }
         break;
       }
@@ -196,7 +196,7 @@ ReturnValue_t PdecHandler::irqOperation() {
         break;
       }
       case State::RUNNING: {
-      	checkLocks();
+        checkLocks();
         checkAndHandleIrqs(fd, info);
         break;
       }
@@ -238,13 +238,13 @@ ReturnValue_t PdecHandler::handleInitState() {
 }
 
 void PdecHandler::openIrqFile(int* fd) {
-	*fd = open(uioNames.irq, O_RDWR);
-	if (*fd < 0) {
-		sif::error << "PdecHandler::irqOperation: Opening UIO IRQ file" << uioNames.irq << " failed"
-							 << std::endl;
-		triggerEvent(OPEN_IRQ_FILE_FAILED);
-		state = State::WAIT_FOR_RECOVERY;
-	}
+  *fd = open(uioNames.irq, O_RDWR);
+  if (*fd < 0) {
+    sif::error << "PdecHandler::irqOperation: Opening UIO IRQ file" << uioNames.irq << " failed"
+               << std::endl;
+    triggerEvent(OPEN_IRQ_FILE_FAILED);
+    state = State::WAIT_FOR_RECOVERY;
+  }
 }
 
 ReturnValue_t PdecHandler::checkAndHandleIrqs(int fd, uint32_t& info) {

linux/ipcore/PdecHandler.h

@@ -105,8 +105,7 @@ class PdecHandler : public SystemObject,
   //! [EXPORT] : [COMMENT] Failed to pull PDEC reset to low
   static constexpr Event PDEC_RESET_FAILED = event::makeEvent(SUBSYSTEM_ID, 10, severity::HIGH);
   //! [EXPORT] : [COMMENT] Failed to open the IRQ uio file
-  static constexpr Event OPEN_IRQ_FILE_FAILED =
-      event::makeEvent(SUBSYSTEM_ID, 11, severity::HIGH);
+  static constexpr Event OPEN_IRQ_FILE_FAILED = event::makeEvent(SUBSYSTEM_ID, 11, severity::HIGH);
 
  private:
   static const uint8_t INTERFACE_ID = CLASS_ID::PDEC_HANDLER;

mission/system/objects/CMakeLists.txt

@@ -7,6 +7,7 @@ target_sources(
           TcsSubsystem.cpp
           PayloadSubsystem.cpp
           AcsBoardAssembly.cpp
+          SyrlinksAssembly.cpp
           Stack5VHandler.cpp
           SusAssembly.cpp
           RwAssembly.cpp

mission/system/objects/ComSubsystem.cpp

@@ -30,6 +30,7 @@ void ComSubsystem::performChildOperation() {
   if (countdownActive) {
     checkTransmitterCountdown();
   }
+
   Subsystem::performChildOperation();
 }
 
@@ -184,7 +185,7 @@ void ComSubsystem::startRxAndTxLowRateSeq() {
 
 void ComSubsystem::checkTransmitterCountdown() {
   if (transmitterCountdown.hasTimedOut()) {
-  	triggerEvent(TX_TIMER_EXPIRED, transmitterTimeout);
+    triggerEvent(TX_TIMER_EXPIRED, transmitterTimeout);
     startTransition(com::Submode::RX_ONLY, SUBMODE_NONE);
     countdownActive = false;
   }

mission/system/objects/ComSubsystem.h

@@ -1,24 +1,23 @@
 #ifndef MISSION_SYSTEM_COMSUBSYSTEM_H_
 #define MISSION_SYSTEM_COMSUBSYSTEM_H_
 
+#include <common/config/eive/eventSubsystemIds.h>
 #include <fsfw/events/EventMessage.h>
 #include <fsfw/parameters/HasParametersIF.h>
 #include <fsfw/parameters/ParameterHelper.h>
 #include <fsfw/subsystem/Subsystem.h>
-#include <common/config/eive/eventSubsystemIds.h>
 
 #include "mission/comDefs.h"
 
 class ComSubsystem : public Subsystem, public ReceivesParameterMessagesIF {
  public:
+  static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::COM_SUBSYSTEM;
 
-	static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::COM_SUBSYSTEM;
-
-	//! [EXPORT] : [COMMENT] The transmit timer to protect the Syrlinks expired
-	//! P1: The current timer value
-	static const Event TX_TIMER_EXPIRED = MAKE_EVENT(1, severity::INFO);
-	//! [EXPORT] : [COMMENT] Transmitter will be turned on due to detection of bitlock
-	static const Event BIT_LOCK_TX_ON = MAKE_EVENT(2, severity::INFO);
+  //! [EXPORT] : [COMMENT] The transmit timer to protect the Syrlinks expired
+  //! P1: The current timer value
+  static const Event TX_TIMER_EXPIRED = MAKE_EVENT(1, severity::INFO);
+  //! [EXPORT] : [COMMENT] Transmitter will be turned on due to detection of bitlock
+  static const Event BIT_LOCK_TX_ON = MAKE_EVENT(2, severity::INFO);
 
   /**
    * @brief Constructor
@@ -27,7 +26,8 @@ class ComSubsystem : public Subsystem, public ReceivesParameterMessagesIF {
    * @param maxNumberOfSequences
    * @param maxNumberOfTables
    * @param transmitterTimeout	Maximum time the transmitter of the syrlinks
-   * 														will be enabled
+   * 														will
+   * be enabled
    */
   ComSubsystem(object_id_t setObjectId, uint32_t maxNumberOfSequences, uint32_t maxNumberOfTables,
                uint32_t transmitterTimeout);

mission/system/objects/DualLaneAssemblyBase.cpp

@@ -235,3 +235,8 @@ void DualLaneAssemblyBase::setPreferredSide(duallane::Submodes submode) {
   }
   this->defaultSubmode = submode;
 }
+
+ReturnValue_t DualLaneAssemblyBase::checkAndHandleHealthState(Mode_t deviceMode,
+                                                              Submode_t deviceSubmode) {
+  return returnvalue::OK;
+}

mission/system/objects/DualLaneAssemblyBase.h

@@ -74,6 +74,7 @@ class DualLaneAssemblyBase : public AssemblyBase, public ConfirmsFailuresIF {
   MessageQueueId_t getEventReceptionQueue() override;
 
   bool sideSwitchTransition(Mode_t mode, Submode_t submode);
+  ReturnValue_t checkAndHandleHealthState(Mode_t deviceMode, Submode_t deviceSubmode);
 
   /**
    * Implemented by user. Will be called if a full mode operation has finished.

mission/system/objects/SyrlinksAssembly.cpp

@@ -0,0 +1,29 @@
+#include "SyrlinksAssembly.h"
+
+#include <eive/objects.h>
+
+using namespace returnvalue;
+
+SyrlinksAssembly::SyrlinksAssembly(object_id_t objectId) : AssemblyBase(objectId) {}
+
+ReturnValue_t SyrlinksAssembly::commandChildren(Mode_t mode, Submode_t submode) {
+  commandTable[0].setMode(mode);
+  commandTable[0].setSubmode(submode);
+  HybridIterator<ModeListEntry> iter(commandTable.begin(), commandTable.end());
+  executeTable(iter);
+  return returnvalue::OK;
+}
+
+ReturnValue_t SyrlinksAssembly::checkChildrenStateOn(Mode_t wantedMode, Submode_t wantedSubmode) {
+  if (childrenMap[objects::SYRLINKS_HANDLER].mode != wantedMode) {
+    return NOT_ENOUGH_CHILDREN_IN_CORRECT_STATE;
+  }
+  return returnvalue::OK;
+}
+
+ReturnValue_t SyrlinksAssembly::isModeCombinationValid(Mode_t mode, Submode_t submode) {
+  if (mode == MODE_ON or mode == DeviceHandlerIF::MODE_NORMAL or mode == MODE_OFF) {
+    return returnvalue::OK;
+  }
+  return returnvalue::FAILED;
+}

mission/system/objects/SyrlinksAssembly.h

@@ -0,0 +1,17 @@
+#ifndef MISSION_SYSTEM_OBJECTS_SYRLINKSASSEMBLY_H_
+#define MISSION_SYSTEM_OBJECTS_SYRLINKSASSEMBLY_H_
+#include <fsfw/devicehandlers/AssemblyBase.h>
+
+class SyrlinksAssembly : public AssemblyBase {
+ public:
+  SyrlinksAssembly(object_id_t objectId);
+
+ private:
+  FixedArrayList<ModeListEntry, 1> commandTable;
+
+  ReturnValue_t commandChildren(Mode_t mode, Submode_t submode) override;
+  ReturnValue_t checkChildrenStateOn(Mode_t wantedMode, Submode_t wantedSubmode) override;
+  ReturnValue_t isModeCombinationValid(Mode_t mode, Submode_t submode) override;
+};
+
+#endif /* MISSION_SYSTEM_OBJECTS_SYRLINKSASSEMBLY_H_ */

mission/system/tree/comModeTree.cpp

@@ -105,11 +105,11 @@ void buildRxOnlySequence(Subsystem& ss, ModeListEntry& eh) {
   // Build RX Only table. We could track the state of the CCSDS IP core handler
   // as well but I do not think this is necessary because enabling that should
   // not interfere with the Syrlinks Handler.
-  iht(objects::SYRLINKS_HANDLER, NML, ::com::Submode::RX_ONLY, COM_TABLE_RX_ONLY_TGT.second);
+  iht(objects::SYRLINKS_ASSY, NML, ::com::Submode::RX_ONLY, COM_TABLE_RX_ONLY_TGT.second);
   check(ss.addTable(TableEntry(COM_TABLE_RX_ONLY_TGT.first, &COM_TABLE_RX_ONLY_TGT.second)), ctxc);
 
   // Build RX Only transition 0
-  iht(objects::SYRLINKS_HANDLER, NML, ::com::Submode::RX_ONLY, COM_TABLE_RX_ONLY_TRANS_0.second);
+  iht(objects::SYRLINKS_ASSY, NML, ::com::Submode::RX_ONLY, COM_TABLE_RX_ONLY_TRANS_0.second);
   check(ss.addTable(TableEntry(COM_TABLE_RX_ONLY_TRANS_0.first, &COM_TABLE_RX_ONLY_TRANS_0.second)),
         ctxc);
 
@@ -147,7 +147,7 @@ void buildTxAndRxLowRateSequence(Subsystem& ss, ModeListEntry& eh) {
   };
 
   // Build RX and TX low datarate table.
-  iht(objects::SYRLINKS_HANDLER, NML, ::com::Submode::RX_AND_TX_LOW_DATARATE,
+  iht(objects::SYRLINKS_ASSY, NML, ::com::Submode::RX_AND_TX_LOW_DATARATE,
       COM_TABLE_RX_AND_TX_LOW_RATE_TGT.second);
   iht(objects::CCSDS_HANDLER, ON, static_cast<Submode_t>(::com::CcsdsSubmode::DATARATE_LOW),
       COM_TABLE_RX_AND_TX_LOW_RATE_TGT.second);
@@ -163,7 +163,7 @@ void buildTxAndRxLowRateSequence(Subsystem& ss, ModeListEntry& eh) {
         ctxc);
 
   // Build TX and RX low transition 1
-  iht(objects::SYRLINKS_HANDLER, NML, ::com::Submode::RX_AND_TX_LOW_DATARATE,
+  iht(objects::SYRLINKS_ASSY, NML, ::com::Submode::RX_AND_TX_LOW_DATARATE,
       COM_TABLE_RX_AND_TX_LOW_RATE_TRANS_1.second);
   check(ss.addTable(TableEntry(COM_TABLE_RX_AND_TX_LOW_RATE_TRANS_1.first,
                                &COM_TABLE_RX_AND_TX_LOW_RATE_TRANS_1.second)),
@@ -199,7 +199,7 @@ void buildTxAndRxHighRateSequence(Subsystem& ss, ModeListEntry& eh) {
   };
 
   // Build RX and TX high datarate table.
-  iht(objects::SYRLINKS_HANDLER, NML, ::com::Submode::RX_AND_TX_HIGH_DATARATE,
+  iht(objects::SYRLINKS_ASSY, NML, ::com::Submode::RX_AND_TX_HIGH_DATARATE,
       COM_TABLE_RX_AND_TX_HIGH_RATE_TGT.second);
   iht(objects::CCSDS_HANDLER, ON, static_cast<Submode_t>(::com::CcsdsSubmode::DATARATE_HIGH),
       COM_TABLE_RX_AND_TX_HIGH_RATE_TGT.second);
@@ -215,7 +215,7 @@ void buildTxAndRxHighRateSequence(Subsystem& ss, ModeListEntry& eh) {
         ctxc);
 
   // Build TX and RX high transition 1
-  iht(objects::SYRLINKS_HANDLER, NML, ::com::Submode::RX_AND_TX_HIGH_DATARATE,
+  iht(objects::SYRLINKS_ASSY, NML, ::com::Submode::RX_AND_TX_HIGH_DATARATE,
       COM_TABLE_RX_AND_TX_HIGH_RATE_TRANS_1.second);
   check(ss.addTable(TableEntry(COM_TABLE_RX_AND_TX_HIGH_RATE_TRANS_1.first,
                                &COM_TABLE_RX_AND_TX_HIGH_RATE_TRANS_1.second)),
@@ -253,7 +253,7 @@ void buildTxAndRxDefaultRateSequence(Subsystem& ss, ModeListEntry& eh) {
   };
 
   // Build RX and TX default datarate table.
-  iht(objects::SYRLINKS_HANDLER, NML, ::com::Submode::RX_AND_TX_DEFAULT_DATARATE,
+  iht(objects::SYRLINKS_ASSY, NML, ::com::Submode::RX_AND_TX_DEFAULT_DATARATE,
       COM_TABLE_RX_AND_TX_DEFAULT_RATE_TGT.second);
   iht(objects::CCSDS_HANDLER, ON, static_cast<Submode_t>(::com::CcsdsSubmode::DATARATE_DEFAULT),
       COM_TABLE_RX_AND_TX_DEFAULT_RATE_TGT.second);
@@ -269,7 +269,7 @@ void buildTxAndRxDefaultRateSequence(Subsystem& ss, ModeListEntry& eh) {
         ctxc);
 
   // Build TX and RX default transition 1
-  iht(objects::SYRLINKS_HANDLER, NML, ::com::Submode::RX_AND_TX_DEFAULT_DATARATE,
+  iht(objects::SYRLINKS_ASSY, NML, ::com::Submode::RX_AND_TX_DEFAULT_DATARATE,
       COM_TABLE_RX_AND_TX_DEFAULT_RATE_TRANS_1.second);
   check(ss.addTable(TableEntry(COM_TABLE_RX_AND_TX_DEFAULT_RATE_TRANS_1.first,
                                &COM_TABLE_RX_AND_TX_DEFAULT_RATE_TRANS_1.second)),