SystemResourcesComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  SystemResourcesComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for SystemResources component base class
// ======================================================================

#ifndef Svc_SystemResourcesComponentAc_HPP
#define Svc_SystemResourcesComponentAc_HPP

#include "Fw/Cmd/CmdPortAc.hpp"
#include "Fw/Cmd/CmdRegPortAc.hpp"
#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Cmd/CmdString.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogTextPortAc.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/InputSerializePort.hpp"
#endif
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/OutputSerializePort.hpp"
#endif
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
#include "Svc/SystemResources/SystemResourceEnabledEnumAc.hpp"

namespace Svc {

  class SystemResourcesComponentBase :
    public Fw::PassiveComponentBase
  {

      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------

      friend class SystemResourcesTesterBase;
      friend class SystemResourcesTester;

    protected:

      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------

      enum {
        NUM_CMDDISP_INPUT_PORTS = 1,
      };

      enum {
        NUM_RUN_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREG_OUTPUT_PORTS = 1,
        NUM_CMDSTATUS_OUTPUT_PORTS = 1,
        NUM_LOG_OUTPUT_PORTS = 1,
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_TIME_OUTPUT_PORTS = 1,
        NUM_TLM_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_ENABLE = 0x0, 
      };

      enum {
        CHANNELID_MEMORY_TOTAL = 0x0, 
        CHANNELID_MEMORY_USED = 0x1, 
        CHANNELID_NON_VOLATILE_TOTAL = 0x2, 
        CHANNELID_NON_VOLATILE_FREE = 0x3, 
        CHANNELID_CPU = 0x4, 
        CHANNELID_CPU_00 = 0x5, 
        CHANNELID_CPU_01 = 0x6, 
        CHANNELID_CPU_02 = 0x7, 
        CHANNELID_CPU_03 = 0x8, 
        CHANNELID_CPU_04 = 0x9, 
        CHANNELID_CPU_05 = 0xa, 
        CHANNELID_CPU_06 = 0xb, 
        CHANNELID_CPU_07 = 0xc, 
        CHANNELID_CPU_08 = 0xd, 
        CHANNELID_CPU_09 = 0xe, 
        CHANNELID_CPU_10 = 0xf, 
        CHANNELID_CPU_11 = 0x10, 
        CHANNELID_CPU_12 = 0x11, 
        CHANNELID_CPU_13 = 0x12, 
        CHANNELID_CPU_14 = 0x13, 
        CHANNELID_CPU_15 = 0x14, 
      };

    public:

      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------

      void init(
          FwEnumStoreType instance = 0 
      );

#if !FW_DIRECT_PORT_CALLS

    public:

      // ----------------------------------------------------------------------
      // Getters for special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort* get_CmdDisp_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------

      Svc::InputSchedPort* get_run_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

      // ----------------------------------------------------------------------
      // Connect input ports to special output ports
      // ----------------------------------------------------------------------

      void set_CmdReg_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdRegPort* port 
      );

      void set_CmdStatus_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdResponsePort* port 
      );

      void set_Log_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );

#endif

      void set_Time_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );

      void set_Tlm_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

#endif

#if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to special output ports
      // ----------------------------------------------------------------------

      void set_CmdReg_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_CmdStatus_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_Log_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

      void set_Time_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_Tlm_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

    public:

      // ----------------------------------------------------------------------
      // Command registration
      // ----------------------------------------------------------------------

      void regCommands();

    protected:

      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------

      SystemResourcesComponentBase(
          const char* compName = "" 
      );

      virtual ~SystemResourcesComponentBase();

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special input ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_CmdDisp_InputPorts() {
        return NUM_CMDDISP_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_run_InputPorts() {
        return NUM_RUN_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_CmdReg_OutputPorts() {
        return NUM_CMDREG_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_CmdStatus_OutputPorts() {
        return NUM_CMDSTATUS_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_Log_OutputPorts() {
        return NUM_LOG_OUTPUT_PORTS;
      }

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_LogText_OutputPorts() {
        return NUM_LOGTEXT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_Time_OutputPorts() {
        return NUM_TIME_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_Tlm_OutputPorts() {
        return NUM_TLM_OUTPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Connection status queries for special output ports
      // ----------------------------------------------------------------------

      bool isConnected_CmdReg_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_CmdStatus_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_Log_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      ) const;

#endif

      bool isConnected_Time_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_Tlm_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_DIRECT_PORT_CALLS
    public:
#else
    protected:
#endif

      // ----------------------------------------------------------------------
      // Port handler base-class functions for special input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------

      void CmdDisp_handlerBase(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    protected:

      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------

      virtual void run_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 0;

#if FW_DIRECT_PORT_CALLS
    public:
#else
    protected:
#endif

      // ----------------------------------------------------------------------
      // Port handler base-class functions for typed input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------

      void run_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

    protected:

      // ----------------------------------------------------------------------
      // Command response
      // ----------------------------------------------------------------------

      void cmdResponse_out(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdResponse response 
      );

    protected:

      // ----------------------------------------------------------------------
      // Command handlers to implement
      // ----------------------------------------------------------------------

      virtual void ENABLE_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Svc::SystemResourceEnabled enable 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Command handler base-class functions
      //
      // Call these functions directly to bypass the command input port
      // ----------------------------------------------------------------------

      void ENABLE_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    protected:

      // ----------------------------------------------------------------------
      // Telemetry serialized write
      // ----------------------------------------------------------------------

      void tlmWrite(
          FwChanIdType id, 
          Fw::TlmBuffer& _tlmBuff, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------

      void tlmWrite_MEMORY_TOTAL(
          U64 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_MEMORY_USED(
          U64 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_NON_VOLATILE_TOTAL(
          U64 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_NON_VOLATILE_FREE(
          U64 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_00(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_01(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_02(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_03(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_04(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_05(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_06(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_07(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_08(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_09(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_10(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_11(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_12(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_13(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_14(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CPU_15(
          F32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------

      Fw::Time getTime() const;

    protected:

      // ----------------------------------------------------------------------
      // Mutex operations for guarded ports
      //
      // You can override these operations to provide more sophisticated
      // synchronization
      // ----------------------------------------------------------------------

      virtual void lock();

      virtual void unLock();

    private:

      // ----------------------------------------------------------------------
      // Calls for messages received on special input ports
      // ----------------------------------------------------------------------

      static void m_p_CmdDisp_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    private:

      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------

      static void m_p_run_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );

    private:

      // ----------------------------------------------------------------------
      // Invocation functions for special output ports
      // ----------------------------------------------------------------------

      void CmdReg_out(
          FwIndexType portNum, 
          FwOpcodeType opCode 
      ) const;

      void CmdStatus_out(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      ) const;

      void Time_out(
          FwIndexType portNum, 
          Fw::Time& time 
      ) const;

      void Tlm_out(
          FwIndexType portNum, 
          FwChanIdType id, 
          Fw::Time& timeTag, 
          Fw::TlmBuffer& val 
      ) const;

#if !FW_DIRECT_PORT_CALLS

    private:

      // ----------------------------------------------------------------------
      // Special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort m_CmdDisp_InputPort[NUM_CMDDISP_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------

      Svc::InputSchedPort m_run_InputPort[NUM_RUN_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

      // ----------------------------------------------------------------------
      // Special output ports
      // ----------------------------------------------------------------------

      Fw::OutputCmdRegPort m_CmdReg_OutputPort[NUM_CMDREG_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_CmdStatus_OutputPort[NUM_CMDSTATUS_OUTPUT_PORTS];

      Fw::OutputLogPort m_Log_OutputPort[NUM_LOG_OUTPUT_PORTS];

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];

#endif

      Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS];

      Fw::OutputTlmPort m_Tlm_OutputPort[NUM_TLM_OUTPUT_PORTS];

#endif

    private:

      // ----------------------------------------------------------------------
      // Mutexes
      // ----------------------------------------------------------------------

      Os::Mutex m_guardedPortMutex;

  };

}

#endif