I2cRequestPortAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  I2cRequestPortAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for I2cRequest port
// ======================================================================

#ifndef Drv_I2cRequestPortAc_HPP
#define Drv_I2cRequestPortAc_HPP

#include "Fw/Buffer/Buffer.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/Serializable.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Comp/PassiveComponentBase.hpp"
#include "Fw/Port/InputPortBase.hpp"
#include "Fw/Port/OutputPortBase.hpp"
#endif

namespace Drv {

  class I2cRequestPortBuffer :
    public Fw::LinearBufferBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constants for I2cRequestPortBuffer
      // ----------------------------------------------------------------------

      static constexpr FwSizeType CAPACITY =
        sizeof(U32) +
        Fw::Buffer::SERIALIZED_SIZE;

    public:

      // ----------------------------------------------------------------------
      // Public member functions for I2cRequestPortBuffer
      // ----------------------------------------------------------------------

      Fw::Serializable::SizeType getCapacity() const override {
        return CAPACITY;
      }

      U8* getBuffAddr() override {
        return m_buff;
      }

      const U8* getBuffAddr() const override {
        return m_buff;
      }

    private:

      // ----------------------------------------------------------------------
      // Private member variables
      // ----------------------------------------------------------------------

      U8 m_buff[CAPACITY];

  };

  class I2cRequestPortSerializer {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for I2cRequestPortSerializer
      // ----------------------------------------------------------------------

      I2cRequestPortSerializer();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for I2cRequestPortSerializer
      // ----------------------------------------------------------------------

      Fw::SerializeStatus deserializePortArgs(
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public static functions for I2cRequestPortSerializer
      // ----------------------------------------------------------------------

      static Fw::SerializeStatus serializePortArgs(
          U32 addr, 
          Fw::Buffer& buffer, 
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public member variables for I2cRequestPortSerializer
      // ----------------------------------------------------------------------

      U32 m_addr;
      Fw::Buffer m_buffer;

  };

#if !FW_DIRECT_PORT_CALLS

  class InputI2cRequestPort :
    public Fw::InputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public types for InputI2cRequestPort
      // ----------------------------------------------------------------------

      typedef void (*CompFuncPtr)(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        U32 addr,
        Fw::Buffer& buffer
      );

    public:

      // ----------------------------------------------------------------------
      // Public constructors for InputI2cRequestPort
      // ----------------------------------------------------------------------

      InputI2cRequestPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for InputI2cRequestPort
      // ----------------------------------------------------------------------

      void init();

      void addCallComp(
          Fw::PassiveComponentBase* callComp, 
          CompFuncPtr funcPtr 
      );

      void invoke(
          U32 addr, 
          Fw::Buffer& buffer 
      );

    private:

      // ----------------------------------------------------------------------
      // Private member functions for InputI2cRequestPort
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION == 1

      Fw::SerializeStatus invokeSerial(
          Fw::LinearBufferBase& _buffer 
      );

#endif

    private:

      // ----------------------------------------------------------------------
      // Private member variables for InputI2cRequestPort
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputI2cRequestPort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for OutputI2cRequestPort
      // ----------------------------------------------------------------------

      OutputI2cRequestPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for OutputI2cRequestPort
      // ----------------------------------------------------------------------

      void init();

      void addCallPort(
          InputI2cRequestPort* callPort 
      );

      void invoke(
          U32 addr, 
          Fw::Buffer& buffer 
      ) const;

    private:

      // ----------------------------------------------------------------------
      // Private member variables for OutputI2cRequestPort
      // ----------------------------------------------------------------------

      InputI2cRequestPort* m_port;

  };

#endif

}

#endif