F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Drv::LinuxI2cDriver Class Reference

#include <Drv/LinuxI2cDriver/LinuxI2cDriver.hpp>

Inheritance diagram for Drv::LinuxI2cDriver:
Drv::LinuxI2cDriverComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 LinuxI2cDriver (const char *const compName)
 
bool open (const char *device)
 
 ~LinuxI2cDriver ()
 
- Public Member Functions inherited from Drv::LinuxI2cDriverComponentBase
void init (FwEnumStoreType instance=0)
 Initialize LinuxI2cDriverComponentBase object. More...
 
Drv::InputI2cPortget_read_InputPort (FwIndexType portNum)
 
Drv::InputI2cPortget_write_InputPort (FwIndexType portNum)
 
Drv::InputI2cWriteReadPortget_writeRead_InputPort (FwIndexType portNum)
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Additional Inherited Members

- Protected Types inherited from Drv::LinuxI2cDriverComponentBase
enum  { NUM_READ_INPUT_PORTS = 1 , NUM_WRITE_INPUT_PORTS = 1 , NUM_WRITEREAD_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
- Protected Member Functions inherited from Drv::LinuxI2cDriverComponentBase
 LinuxI2cDriverComponentBase (const char *compName="")
 Construct LinuxI2cDriverComponentBase object. More...
 
virtual ~LinuxI2cDriverComponentBase ()
 Destroy LinuxI2cDriverComponentBase object. More...
 
FwIndexType getNum_read_InputPorts () const
 
FwIndexType getNum_write_InputPorts () const
 
FwIndexType getNum_writeRead_InputPorts () const
 
Drv::I2cStatus read_handlerBase (FwIndexType portNum, U32 addr, Fw::Buffer &serBuffer)
 Handler base-class function for input port read. More...
 
Drv::I2cStatus write_handlerBase (FwIndexType portNum, U32 addr, Fw::Buffer &serBuffer)
 Handler base-class function for input port write. More...
 
Drv::I2cStatus writeRead_handlerBase (FwIndexType portNum, U32 addr, Fw::Buffer &writeBuffer, Fw::Buffer &readBuffer)
 Handler base-class function for input port writeRead. More...
 
virtual void lock ()
 Lock the guarded mutex. More...
 
virtual void unLock ()
 Unlock the guarded mutex. More...
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor. More...
 
virtual ~PassiveComponentBase ()
 Destructor. More...
 
void init (NATIVE_INT_TYPE instance)
 Initialization function. More...
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor. More...
 
virtual ~ObjBase ()
 Destructor. More...
 
void init ()
 Object initializer. More...
 

Detailed Description

Definition at line 20 of file LinuxI2cDriver.hpp.

Constructor & Destructor Documentation

◆ LinuxI2cDriver()

Drv::LinuxI2cDriver::LinuxI2cDriver ( const char *const  compName)

Construct object LinuxI2cDriver

Definition at line 33 of file LinuxI2cDriver.cpp.

◆ ~LinuxI2cDriver()

Drv::LinuxI2cDriver::~LinuxI2cDriver ( )

Destroy object LinuxI2cDriver

Definition at line 42 of file LinuxI2cDriver.cpp.

Member Function Documentation

◆ open()

bool Drv::LinuxI2cDriver::open ( const char *  device)

Definition at line 50 of file LinuxI2cDriver.cpp.


The documentation for this class was generated from the following files: