LinuxI2cDriver.hpp

Go to the documentation of this file.

// ======================================================================
// \title  LinuxI2cDriver.hpp
// \author tcanham
// \brief  hpp file for LinuxI2cDriver component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef LinuxI2cDriver_HPP
#define LinuxI2cDriver_HPP

#include "Drv/LinuxI2cDriver/LinuxI2cDriverComponentAc.hpp"

namespace Drv {

  class LinuxI2cDriver :
    public LinuxI2cDriverComponentBase
  {

    public:

      // ----------------------------------------------------------------------
      // Construction, initialization, and destruction
      // ----------------------------------------------------------------------

      LinuxI2cDriver(const char *const compName);

      bool open(const char* device);
      ~LinuxI2cDriver();

    PRIVATE:

      // ----------------------------------------------------------------------
      // Handler implementations for user-defined typed input ports
      // ----------------------------------------------------------------------

      I2cStatus write_handler(
          const NATIVE_INT_TYPE portNum, 
          U32 addr,
          Fw::Buffer &serBuffer
      );

      I2cStatus read_handler(
          const NATIVE_INT_TYPE portNum, 
          U32 addr,
          Fw::Buffer &serBuffer
      );

      I2cStatus  writeRead_handler(
          const NATIVE_INT_TYPE portNum, 
          U32 addr,
          Fw::Buffer &writeBuffer,
          Fw::Buffer &readBuffer
      );

      // Prevent unused field error when using stub
      #ifndef STUBBED_LINUX_I2C_DRIVER
      NATIVE_INT_TYPE m_fd; 
      #endif
    };

} // end namespace Drv

#endif