LinuxGpioDriverComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Drv_LinuxGpioDriverComponentAc_HPP
#define Drv_LinuxGpioDriverComponentAc_HPP

#include <atomic>

#include "Drv/Ports/GpioReadPortAc.hpp"
#include "Drv/Ports/GpioWritePortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.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 "Os/Models/FileStatusEnumAc.hpp"
#include "Os/Models/RawTimeStatusEnumAc.hpp"
#include "Svc/Cycle/CyclePortAc.hpp"
#include "default/config/FwSizeStoreTypeAliasAc.hpp"

namespace Drv {

  class LinuxGpioDriverComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class LinuxGpioDriverTesterBase;
      friend class LinuxGpioDriverTester;

    protected:

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

      enum {
        NUM_GPIOREAD_INPUT_PORTS = 1,
        NUM_GPIOWRITE_INPUT_PORTS = 1,
      };

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

      enum {
        NUM_GPIOINTERRUPT_OUTPUT_PORTS = 1,
      };

      enum {
        EVENTID_OPENCHIP = 0x0,
        EVENTID_OPENCHIPERROR = 0x1,
        EVENTID_OPENPINERROR = 0x2,
        EVENTID_INTERRUPTREADERROR = 0x3,
        EVENTID_POLLINGERROR = 0x4,
        EVENTID_INTERRUPTTIMEERROR = 0x5,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

#if !FW_DIRECT_PORT_CALLS

    public:

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

      Drv::InputGpioReadPort* get_gpioRead_InputPort(
          FwIndexType portNum 
      );

      Drv::InputGpioWritePort* get_gpioWrite_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

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

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

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

      void set_gpioInterrupt_OutputPort(
          FwIndexType portNum, 
          Svc::InputCyclePort* port 
      );

#endif

#if !FW_DIRECT_PORT_CALLS && 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 
      );

#endif

#if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION

    public:

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

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

#endif

    protected:

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

      LinuxGpioDriverComponentBase(
          const char* compName = "" 
      );

      virtual ~LinuxGpioDriverComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_gpioRead_InputPorts() {
        return NUM_GPIOREAD_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_gpioWrite_InputPorts() {
        return NUM_GPIOWRITE_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;
      }

    protected:

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

      static constexpr FwIndexType getNum_gpioInterrupt_OutputPorts() {
        return NUM_GPIOINTERRUPT_OUTPUT_PORTS;
      }

    protected:

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

      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;

    protected:

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

      bool isConnected_gpioInterrupt_OutputPort(
          FwIndexType portNum 
      ) const;

    protected:

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

      virtual Drv::GpioStatus gpioRead_handler(
          FwIndexType portNum, 
          Fw::Logic& state
      ) = 0;

      virtual Drv::GpioStatus gpioWrite_handler(
          FwIndexType portNum, 
          const Fw::Logic& state
      ) = 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
      // ----------------------------------------------------------------------

      Drv::GpioStatus gpioRead_handlerBase(
          FwIndexType portNum, 
          Fw::Logic& state
      );

      Drv::GpioStatus gpioWrite_handlerBase(
          FwIndexType portNum, 
          const Fw::Logic& state
      );

    protected:

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

      void gpioInterrupt_out(
          FwIndexType portNum, 
          Os::RawTime& cycleStart 
      ) const;

    protected:

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

      void log_DIAGNOSTIC_OpenChip(
          const Fw::StringBase& chip,
          const Fw::StringBase& chipLabel,
          U32 pin,
          const Fw::StringBase& pinMessage
      ) const;

      void log_WARNING_HI_OpenChipError(
          const Fw::StringBase& chip,
          const Os::FileStatus& status
      ) const;

      void log_WARNING_HI_OpenPinError(
          const Fw::StringBase& chip,
          U32 pin,
          const Fw::StringBase& pinMessage,
          const Os::FileStatus& status
      ) const;

      void log_WARNING_HI_InterruptReadError(
          U32 expected,
          U32 got
      ) const;

      void log_WARNING_HI_PollingError(I32 error_number) const;

      void log_WARNING_HI_InterruptTimeError(const Os::RawTimeStatus& status) const;

    protected:

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

      Fw::Time getTime() const;

    private:

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

      static Drv::GpioStatus m_p_gpioRead_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Logic& state
      );

      static Drv::GpioStatus m_p_gpioWrite_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Fw::Logic& state
      );

    private:

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

      void Log_out(
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::LogBuffer& args 
      ) const;

#if FW_ENABLE_TEXT_LOGGING

      void LogText_out(
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::TextLogString& text 
      ) const;

#endif

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

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Drv::InputGpioReadPort m_gpioRead_InputPort[NUM_GPIOREAD_INPUT_PORTS];

      Drv::InputGpioWritePort m_gpioWrite_InputPort[NUM_GPIOWRITE_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

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

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Svc::OutputCyclePort m_gpioInterrupt_OutputPort[NUM_GPIOINTERRUPT_OUTPUT_PORTS];

#endif

  };

}

#endif