LinuxUartDriverComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Drv_LinuxUartDriverComponentAc_HPP
#define Drv_LinuxUartDriverComponentAc_HPP

#include <atomic>

#include "Drv/ByteStreamDriverModel/ByteStreamDataPortAc.hpp"
#include "Drv/ByteStreamDriverModel/ByteStreamReadyPortAc.hpp"
#include "Drv/ByteStreamDriverModel/ByteStreamSendPortAc.hpp"
#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#if FW_ENABLE_TEXT_LOGGING == 1
#include "Fw/Log/LogTextPortAc.hpp"
#endif
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#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 "default/config/FwSizeTypeAliasAc.hpp"

namespace Drv {

  class LinuxUartDriverComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class LinuxUartDriverTesterBase;
      friend class LinuxUartDriverTester;

    protected:

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

      enum {
        NUM_RECVRETURNIN_INPUT_PORTS = 1,
        NUM_RUN_INPUT_PORTS = 1,
        NUM_SEND_INPUT_PORTS = 1,
      };

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

      enum {
        NUM_ALLOCATE_OUTPUT_PORTS = 1,
        NUM_DEALLOCATE_OUTPUT_PORTS = 1,
        NUM_READY_OUTPUT_PORTS = 1,
        NUM_RECV_OUTPUT_PORTS = 1,
      };

      enum {
        EVENTID_OPENERROR = 0x0, 
        EVENTID_CONFIGERROR = 0x1, 
        EVENTID_WRITEERROR = 0x2, 
        EVENTID_READERROR = 0x3, 
        EVENTID_PORTOPENED = 0x4, 
        EVENTID_NOBUFFERS = 0x5, 
        EVENTID_BUFFERTOOSMALL = 0x6, 
      };

      enum {
        EVENTID_WRITEERROR_THROTTLE = 5, 
        EVENTID_READERROR_THROTTLE = 5, 
        EVENTID_NOBUFFERS_THROTTLE = 20, 
      };

      enum {
        CHANNELID_BYTESSENT = 0x0, 
        CHANNELID_BYTESRECV = 0x1, 
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Fw::InputBufferSendPort* get_recvReturnIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSchedPort* get_run_InputPort(
          FwIndexType portNum 
      );

      Drv::InputByteStreamSendPort* get_send_InputPort(
          FwIndexType portNum 
      );

    public:

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

      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 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_allocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferGetPort* port 
      );

      void set_deallocate_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );

      void set_ready_OutputPort(
          FwIndexType portNum, 
          Drv::InputByteStreamReadyPort* port 
      );

      void set_recv_OutputPort(
          FwIndexType portNum, 
          Drv::InputByteStreamDataPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

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

      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

#if FW_PORT_SERIALIZATION

    public:

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

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

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

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

#endif

    protected:

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

      LinuxUartDriverComponentBase(
          const char* compName = "" 
      );

      virtual ~LinuxUartDriverComponentBase();

    protected:

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

      FwIndexType getNum_recvReturnIn_InputPorts() const;

      FwIndexType getNum_run_InputPorts() const;

      FwIndexType getNum_send_InputPorts() const;

    protected:

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

      FwIndexType getNum_Log_OutputPorts() const;

#if FW_ENABLE_TEXT_LOGGING == 1

      FwIndexType getNum_LogText_OutputPorts() const;

#endif

      FwIndexType getNum_Time_OutputPorts() const;

      FwIndexType getNum_Tlm_OutputPorts() const;

    protected:

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

      FwIndexType getNum_allocate_OutputPorts() const;

      FwIndexType getNum_deallocate_OutputPorts() const;

      FwIndexType getNum_ready_OutputPorts() const;

      FwIndexType getNum_recv_OutputPorts() const;

    protected:

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

      bool isConnected_Log_OutputPort(
          FwIndexType portNum 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_Time_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_Tlm_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      bool isConnected_allocate_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_deallocate_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_ready_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_recv_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      virtual void recvReturnIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;

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

      virtual Drv::ByteStreamStatus send_handler(
          FwIndexType portNum, 
          Fw::Buffer& sendBuffer 
      ) = 0;

    protected:

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

      void recvReturnIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      void run_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

      Drv::ByteStreamStatus send_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& sendBuffer 
      );

    protected:

      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------

      Fw::Buffer allocate_out(
          FwIndexType portNum, 
          FwSizeType size 
      );

      void deallocate_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      void ready_out(
          FwIndexType portNum 
      );

      void recv_out(
          FwIndexType portNum, 
          Fw::Buffer& buffer,
          const Drv::ByteStreamStatus& status
      );

    protected:

      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_OpenError(
          const Fw::StringBase& device, 
          I32 error, 
          const Fw::StringBase& name 
      ) const;

      void log_WARNING_HI_ConfigError(
          const Fw::StringBase& device, 
          I32 error 
      ) const;

      void log_WARNING_HI_WriteError(
          const Fw::StringBase& device, 
          I32 error 
      );

      void log_WARNING_HI_ReadError(
          const Fw::StringBase& device, 
          I32 error 
      );

      void log_ACTIVITY_HI_PortOpened(
          const Fw::StringBase& device 
      ) const;

      void log_WARNING_HI_NoBuffers(
          const Fw::StringBase& device 
      );

      void log_WARNING_HI_BufferTooSmall(
          const Fw::StringBase& device, 
          U32 size, 
          U32 needed 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Event throttle reset functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_WriteError_ThrottleClear();

      void log_WARNING_HI_ReadError_ThrottleClear();

      void log_WARNING_HI_NoBuffers_ThrottleClear();

    protected:

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

      void tlmWrite_BytesSent(
          FwSizeType arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_BytesRecv(
          FwSizeType 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 typed input ports
      // ----------------------------------------------------------------------

      static void m_p_recvReturnIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

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

      static Drv::ByteStreamStatus m_p_send_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& sendBuffer 
      );

    private:

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

      Fw::InputBufferSendPort m_recvReturnIn_InputPort[NUM_RECVRETURNIN_INPUT_PORTS];

      Svc::InputSchedPort m_run_InputPort[NUM_RUN_INPUT_PORTS];

      Drv::InputByteStreamSendPort m_send_InputPort[NUM_SEND_INPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Special 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];

    private:

      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------

      Fw::OutputBufferGetPort m_allocate_OutputPort[NUM_ALLOCATE_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_deallocate_OutputPort[NUM_DEALLOCATE_OUTPUT_PORTS];

      Drv::OutputByteStreamReadyPort m_ready_OutputPort[NUM_READY_OUTPUT_PORTS];

      Drv::OutputByteStreamDataPort m_recv_OutputPort[NUM_RECV_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Counter values for event throttling
      // ----------------------------------------------------------------------

      std::atomic<FwIndexType> m_WriteErrorThrottle;

      std::atomic<FwIndexType> m_ReadErrorThrottle;

      std::atomic<FwIndexType> m_NoBuffersThrottle;

    private:

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

      Os::Mutex m_guardedPortMutex;

  };

}

#endif