LinuxSpiDriverComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Drv_LinuxSpiDriverComponentAc_HPP
#define Drv_LinuxSpiDriverComponentAc_HPP

#include <atomic>

#include "Drv/Ports/SpiReadWritePortAc.hpp"
#include "Drv/Ports/SpiWriteReadPortAc.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 "default/config/FwSizeStoreTypeAliasAc.hpp"
#include "default/config/FwSizeTypeAliasAc.hpp"

namespace Drv {

  class LinuxSpiDriverComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class LinuxSpiDriverTesterBase;
      friend class LinuxSpiDriverTester;

    protected:

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

      enum {
        NUM_SPIREADWRITE_INPUT_PORTS = 1,
        NUM_SPIWRITEREAD_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 {
        EVENTID_SPI_OPENERROR = 0x0, 
        EVENTID_SPI_CONFIGERROR = 0x1, 
        EVENTID_SPI_WRITEERROR = 0x2, 
        EVENTID_SPI_CONFIGMISMATCH = 0x3, 
        EVENTID_SPI_PORTOPENED = 0x4, 
      };

      enum {
        EVENTID_SPI_WRITEERROR_THROTTLE = 5, 
      };

      enum {
        CHANNELID_SPI_BYTES = 0x0, 
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Drv::InputSpiReadWritePort* get_SpiReadWrite_InputPort(
          FwIndexType portNum 
      );

      Drv::InputSpiWriteReadPort* get_SpiWriteRead_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 
      );

#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

    protected:

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

      LinuxSpiDriverComponentBase(
          const char* compName = "" 
      );

      virtual ~LinuxSpiDriverComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_SpiReadWrite_InputPorts() {
        return NUM_SPIREADWRITE_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_SpiWriteRead_InputPorts() {
        return NUM_SPIWRITEREAD_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special 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_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:

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

      virtual void SpiReadWrite_handler(
          FwIndexType portNum, 
          Fw::Buffer& writeBuffer,
          Fw::Buffer& readBuffer
      ) = 0;

      virtual Drv::SpiStatus SpiWriteRead_handler(
          FwIndexType portNum, 
          Fw::Buffer& writeBuffer,
          Fw::Buffer& readBuffer
      ) = 0;

    protected:

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

      void SpiReadWrite_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& writeBuffer,
          Fw::Buffer& readBuffer
      );

      Drv::SpiStatus SpiWriteRead_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& writeBuffer,
          Fw::Buffer& readBuffer
      );

    protected:

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

      void log_WARNING_HI_SPI_OpenError(
          I32 device, 
          I32 select, 
          I32 error 
      ) const;

      void log_WARNING_HI_SPI_ConfigError(
          I32 device, 
          I32 select, 
          I32 error 
      ) const;

      void log_WARNING_HI_SPI_WriteError(
          I32 device, 
          I32 select, 
          I32 error 
      );

      void log_WARNING_LO_SPI_ConfigMismatch(
          I32 device, 
          I32 select, 
          const Fw::StringBase& parameter, 
          U32 write_value, 
          U32 read_value 
      ) const;

      void log_ACTIVITY_HI_SPI_PortOpened(
          I32 device, 
          I32 select 
      ) const;

    protected:

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

      void log_WARNING_HI_SPI_WriteError_ThrottleClear();

    protected:

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

      void tlmWrite_SPI_Bytes(
          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_SpiReadWrite_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& writeBuffer,
          Fw::Buffer& readBuffer
      );

      static Drv::SpiStatus m_p_SpiWriteRead_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& writeBuffer,
          Fw::Buffer& readBuffer
      );

    private:

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

      Drv::InputSpiReadWritePort m_SpiReadWrite_InputPort[NUM_SPIREADWRITE_INPUT_PORTS];

      Drv::InputSpiWriteReadPort m_SpiWriteRead_InputPort[NUM_SPIWRITEREAD_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:

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

      std::atomic<FwIndexType> m_SPI_WriteErrorThrottle;

    private:

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

      Os::Mutex m_guardedPortMutex;

  };

}

#endif