LinuxI2cDriverComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Drv_LinuxI2cDriverComponentAc_HPP
#define Drv_LinuxI2cDriverComponentAc_HPP

#include "Drv/Ports/I2cPortAc.hpp"
#include "Drv/Ports/I2cWriteReadPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Os/Mutex.hpp"

namespace Drv {

  class LinuxI2cDriverComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class LinuxI2cDriverTesterBase;
      friend class LinuxI2cDriverTester;

    protected:

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

      enum {
        NUM_READ_INPUT_PORTS = 1,
        NUM_WRITE_INPUT_PORTS = 1,
        NUM_WRITEREAD_INPUT_PORTS = 1,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Drv::InputI2cPort* get_read_InputPort(
          FwIndexType portNum 
      );

      Drv::InputI2cPort* get_write_InputPort(
          FwIndexType portNum 
      );

      Drv::InputI2cWriteReadPort* get_writeRead_InputPort(
          FwIndexType portNum 
      );

    protected:

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

      LinuxI2cDriverComponentBase(
          const char* compName = "" 
      );

      virtual ~LinuxI2cDriverComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_read_InputPorts() {
        return NUM_READ_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_write_InputPorts() {
        return NUM_WRITE_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_writeRead_InputPorts() {
        return NUM_WRITEREAD_INPUT_PORTS;
      }

    protected:

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

      virtual Drv::I2cStatus read_handler(
          FwIndexType portNum, 
          U32 addr, 
          Fw::Buffer& serBuffer 
      ) = 0;

      virtual Drv::I2cStatus write_handler(
          FwIndexType portNum, 
          U32 addr, 
          Fw::Buffer& serBuffer 
      ) = 0;

      virtual Drv::I2cStatus writeRead_handler(
          FwIndexType portNum, 
          U32 addr, 
          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
      // ----------------------------------------------------------------------

      Drv::I2cStatus read_handlerBase(
          FwIndexType portNum, 
          U32 addr, 
          Fw::Buffer& serBuffer 
      );

      Drv::I2cStatus write_handlerBase(
          FwIndexType portNum, 
          U32 addr, 
          Fw::Buffer& serBuffer 
      );

      Drv::I2cStatus writeRead_handlerBase(
          FwIndexType portNum, 
          U32 addr, 
          Fw::Buffer& writeBuffer, 
          Fw::Buffer& readBuffer 
      );

    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 Drv::I2cStatus m_p_read_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 addr, 
          Fw::Buffer& serBuffer 
      );

      static Drv::I2cStatus m_p_write_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 addr, 
          Fw::Buffer& serBuffer 
      );

      static Drv::I2cStatus m_p_writeRead_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 addr, 
          Fw::Buffer& writeBuffer, 
          Fw::Buffer& readBuffer 
      );

    private:

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

      Drv::InputI2cPort m_read_InputPort[NUM_READ_INPUT_PORTS];

      Drv::InputI2cPort m_write_InputPort[NUM_WRITE_INPUT_PORTS];

      Drv::InputI2cWriteReadPort m_writeRead_InputPort[NUM_WRITEREAD_INPUT_PORTS];

    private:

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

      Os::Mutex m_guardedPortMutex;

  };

}

#endif