Auto-generated base for LinuxI2cDriver component. More...

#include <Drv/LinuxI2cDriver/LinuxI2cDriverComponentAc.hpp>

Inheritance diagram for Drv::LinuxI2cDriverComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize LinuxI2cDriverComponentBase object. More...

Drv::InputI2cPort *	get_read_InputPort (FwIndexType portNum)

Drv::InputI2cPort *	get_write_InputPort (FwIndexType portNum)

Drv::InputI2cWriteReadPort *	get_writeRead_InputPort (FwIndexType portNum)

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...

U32	getIdBase () const

Protected Types
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
	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

virtual Drv::I2cStatus	read_handler (FwIndexType portNum, U32 addr, Fw::Buffer &serBuffer)=0
	Handler for input port read. More...

virtual Drv::I2cStatus	write_handler (FwIndexType portNum, U32 addr, Fw::Buffer &serBuffer)=0
	Handler for input port write. More...

virtual Drv::I2cStatus	writeRead_handler (FwIndexType portNum, U32 addr, Fw::Buffer &writeBuffer, Fw::Buffer &readBuffer)=0
	Handler for input port writeRead. More...

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...

Friends
class	LinuxI2cDriverComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for LinuxI2cDriver component.

Definition at line 22 of file LinuxI2cDriverComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_READ_INPUT_PORTS
NUM_WRITE_INPUT_PORTS
NUM_WRITEREAD_INPUT_PORTS

Definition at line 40 of file LinuxI2cDriverComponentAc.hpp.

Constructor & Destructor Documentation

◆ LinuxI2cDriverComponentBase()

Drv::LinuxI2cDriverComponentBase::LinuxI2cDriverComponentBase ( const char * compName = "" )

protected

Construct LinuxI2cDriverComponentBase object.

Parameters

compName The component name

Definition at line 140 of file LinuxI2cDriverComponentAc.cpp.

◆ ~LinuxI2cDriverComponentBase()

Drv::LinuxI2cDriverComponentBase::~LinuxI2cDriverComponentBase ( )

protectedvirtual

Destroy LinuxI2cDriverComponentBase object.

Definition at line 147 of file LinuxI2cDriverComponentAc.cpp.

Member Function Documentation

◆ get_read_InputPort()

Drv::InputI2cPort * Drv::LinuxI2cDriverComponentBase::get_read_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: read[portNum]

Parameters

portNum The port number

Definition at line 103 of file LinuxI2cDriverComponentAc.cpp.

◆ get_write_InputPort()

Drv::InputI2cPort * Drv::LinuxI2cDriverComponentBase::get_write_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: write[portNum]

Parameters

portNum The port number

Definition at line 114 of file LinuxI2cDriverComponentAc.cpp.

◆ get_writeRead_InputPort()

Drv::InputI2cWriteReadPort * Drv::LinuxI2cDriverComponentBase::get_writeRead_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: writeRead[portNum]

Parameters

portNum The port number

Definition at line 125 of file LinuxI2cDriverComponentAc.cpp.

◆ getNum_read_InputPorts()

FwIndexType Drv::LinuxI2cDriverComponentBase::getNum_read_InputPorts ( ) const

protected

Get the number of read input ports

Returns: The number of read input ports

Definition at line 157 of file LinuxI2cDriverComponentAc.cpp.

◆ getNum_write_InputPorts()

FwIndexType Drv::LinuxI2cDriverComponentBase::getNum_write_InputPorts ( ) const

protected

Get the number of write input ports

Returns: The number of write input ports

Definition at line 163 of file LinuxI2cDriverComponentAc.cpp.

◆ getNum_writeRead_InputPorts()

FwIndexType Drv::LinuxI2cDriverComponentBase::getNum_writeRead_InputPorts ( ) const

protected

Get the number of writeRead input ports

Returns: The number of writeRead input ports

Definition at line 169 of file LinuxI2cDriverComponentAc.cpp.

◆ init()

void Drv::LinuxI2cDriverComponentBase::init ( FwEnumStoreType instance = 0 )

Initialize LinuxI2cDriverComponentBase object.

Parameters

instance The instance number

Definition at line 20 of file LinuxI2cDriverComponentAc.cpp.

◆ lock()

void Drv::LinuxI2cDriverComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 283 of file LinuxI2cDriverComponentAc.cpp.

◆ read_handler()

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

protectedpure virtual

Handler for input port read.

Parameters

portNum	The port number
addr	I2C slave device address
serBuffer	Buffer with data to read/write to/from

◆ read_handlerBase()

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

protected

Handler base-class function for input port read.

Parameters

portNum	The port number
addr	I2C slave device address
serBuffer	Buffer with data to read/write to/from

Definition at line 181 of file LinuxI2cDriverComponentAc.cpp.

◆ unLock()

void Drv::LinuxI2cDriverComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 289 of file LinuxI2cDriverComponentAc.cpp.

◆ write_handler()

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

protectedpure virtual

Handler for input port write.

Parameters

portNum	The port number
addr	I2C slave device address
serBuffer	Buffer with data to read/write to/from

◆ write_handlerBase()

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

protected

Handler base-class function for input port write.

Parameters

portNum	The port number
addr	I2C slave device address
serBuffer	Buffer with data to read/write to/from

Definition at line 212 of file LinuxI2cDriverComponentAc.cpp.

◆ writeRead_handler()

virtual Drv::I2cStatus Drv::LinuxI2cDriverComponentBase::writeRead_handler	(	FwIndexType	portNum,
		U32	addr,
		Fw::Buffer &	writeBuffer,
		Fw::Buffer &	readBuffer
	)

protectedpure virtual

Handler for input port writeRead.

Parameters

portNum	The port number
addr	I2C slave device address
writeBuffer	Buffer to write data to the i2c device
readBuffer	Buffer to read back data from the i2c device, must set size when passing in read buffer

◆ writeRead_handlerBase()

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

protected

Handler base-class function for input port writeRead.

Parameters

portNum	The port number
addr	I2C slave device address
writeBuffer	Buffer to write data to the i2c device
readBuffer	Buffer to read back data from the i2c device, must set size when passing in read buffer

Definition at line 243 of file LinuxI2cDriverComponentAc.cpp.

Friends And Related Function Documentation

◆ LinuxI2cDriverComponentBaseFriend

friend class LinuxI2cDriverComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 31 of file LinuxI2cDriverComponentAc.hpp.

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

Drv/LinuxI2cDriver/LinuxI2cDriverComponentAc.hpp
Drv/LinuxI2cDriver/LinuxI2cDriverComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ LinuxI2cDriverComponentBase()

◆ ~LinuxI2cDriverComponentBase()

Member Function Documentation

◆ get_read_InputPort()

◆ get_write_InputPort()

◆ get_writeRead_InputPort()

◆ getNum_read_InputPorts()

◆ getNum_write_InputPorts()

◆ getNum_writeRead_InputPorts()

◆ init()

◆ lock()

◆ read_handler()

◆ read_handlerBase()

◆ unLock()

◆ write_handler()

◆ write_handlerBase()

◆ writeRead_handler()

◆ writeRead_handlerBase()

Friends And Related Function Documentation

◆ LinuxI2cDriverComponentBaseFriend