Drv::LinuxUartDriverComponentBase Class Reference

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

#include <Drv/LinuxUartDriver/LinuxUartDriverComponentAc.hpp>

Inheritance diagram for Drv::LinuxUartDriverComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize LinuxUartDriverComponentBase object. More...
Drv::InputByteStreamSendPort *	get_send_InputPort (FwIndexType portNum)
void	set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to Log[portNum]. More...
void	set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to Time[portNum]. More...
void	set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
	Connect port to Tlm[portNum]. More...
void	set_allocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
	Connect port to allocate[portNum]. More...
void	set_deallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to deallocate[portNum]. More...
void	set_ready_OutputPort (FwIndexType portNum, Drv::InputByteStreamReadyPort *port)
	Connect port to ready[portNum]. More...
void	set_recv_OutputPort (FwIndexType portNum, Drv::InputByteStreamRecvPort *port)
	Connect port to recv[portNum]. More...
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...
U32	getIdBase () const

Protected Types
enum	{ NUM_SEND_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...
enum	{ NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_TIME_OUTPUT_PORTS = 1 , NUM_TLM_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ NUM_ALLOCATE_OUTPUT_PORTS = 1 , NUM_DEALLOCATE_OUTPUT_PORTS = 1 , NUM_READY_OUTPUT_PORTS = 1 , NUM_RECV_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
enum	{   EVENTID_OPENERROR = 0x0 , EVENTID_CONFIGERROR = 0x1 , EVENTID_WRITEERROR = 0x2 , EVENTID_READERROR = 0x3 ,   EVENTID_PORTOPENED = 0x4 , EVENTID_NOBUFFERS = 0x5 , EVENTID_BUFFERTOOSMALL = 0x6 }
	Event IDs. More...
enum	{ EVENTID_WRITEERROR_THROTTLE = 5 , EVENTID_READERROR_THROTTLE = 5 , EVENTID_NOBUFFERS_THROTTLE = 20 }
	Event throttle values: sets initial value of countdown variables. More...
enum	{ CHANNELID_BYTESSENT = 0x0 , CHANNELID_BYTESRECV = 0x1 }
	Channel IDs. More...

Protected Member Functions
	LinuxUartDriverComponentBase (const char *compName="")
	Construct LinuxUartDriverComponentBase object. More...
virtual	~LinuxUartDriverComponentBase ()
	Destroy LinuxUartDriverComponentBase object. More...
FwIndexType	getNum_send_InputPorts () const
FwIndexType	getNum_Log_OutputPorts () const
FwIndexType	getNum_Time_OutputPorts () const
FwIndexType	getNum_Tlm_OutputPorts () const
FwIndexType	getNum_allocate_OutputPorts () const
FwIndexType	getNum_deallocate_OutputPorts () const
FwIndexType	getNum_ready_OutputPorts () const
FwIndexType	getNum_recv_OutputPorts () const
bool	isConnected_Log_OutputPort (FwIndexType portNum)
bool	isConnected_Time_OutputPort (FwIndexType portNum)
bool	isConnected_Tlm_OutputPort (FwIndexType portNum)
bool	isConnected_allocate_OutputPort (FwIndexType portNum)
bool	isConnected_deallocate_OutputPort (FwIndexType portNum)
bool	isConnected_ready_OutputPort (FwIndexType portNum)
bool	isConnected_recv_OutputPort (FwIndexType portNum)
virtual Drv::SendStatus	send_handler (FwIndexType portNum, Fw::Buffer &sendBuffer)=0
	Handler for input port send. More...
Drv::SendStatus	send_handlerBase (FwIndexType portNum, Fw::Buffer &sendBuffer)
	Handler base-class function for input port send. More...
Fw::Buffer	allocate_out (FwIndexType portNum, U32 size)
	Invoke output port allocate. More...
void	deallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port deallocate. More...
void	ready_out (FwIndexType portNum)
	Invoke output port ready. More...
void	recv_out (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
	Invoke output port recv. More...
void	log_WARNING_HI_OpenError (const Fw::StringBase &device, I32 error, const Fw::StringBase &name)
void	log_WARNING_HI_ConfigError (const Fw::StringBase &device, I32 error)
void	log_WARNING_HI_WriteError (const Fw::StringBase &device, I32 error)
void	log_WARNING_HI_ReadError (const Fw::StringBase &device, I32 error)
void	log_ACTIVITY_HI_PortOpened (const Fw::StringBase &device)
void	log_WARNING_HI_NoBuffers (const Fw::StringBase &device)
void	log_WARNING_HI_BufferTooSmall (const Fw::StringBase &device, U32 size, U32 needed)
void	log_WARNING_HI_WriteError_ThrottleClear ()
	Reset throttle value for WriteError. More...
void	log_WARNING_HI_ReadError_ThrottleClear ()
	Reset throttle value for ReadError. More...
void	log_WARNING_HI_NoBuffers_ThrottleClear ()
	Reset throttle value for NoBuffers. More...
void	tlmWrite_BytesSent (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_BytesRecv (U32 arg, Fw::Time _tlmTime=Fw::Time())
Fw::Time	getTime ()
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	LinuxUartDriverComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for LinuxUartDriver component.

Definition at line 33 of file LinuxUartDriverComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_SEND_INPUT_PORTS

Definition at line 51 of file LinuxUartDriverComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOG_OUTPUT_PORTS
NUM_LOGTEXT_OUTPUT_PORTS
NUM_TIME_OUTPUT_PORTS
NUM_TLM_OUTPUT_PORTS

Definition at line 56 of file LinuxUartDriverComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_ALLOCATE_OUTPUT_PORTS
NUM_DEALLOCATE_OUTPUT_PORTS
NUM_READY_OUTPUT_PORTS
NUM_RECV_OUTPUT_PORTS

Definition at line 64 of file LinuxUartDriverComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_OPENERROR	UART open error.
EVENTID_CONFIGERROR	UART config error.
EVENTID_WRITEERROR	UART write error.
EVENTID_READERROR	UART read error.
EVENTID_PORTOPENED	UART port opened event.
EVENTID_NOBUFFERS	UART ran out of buffers.
EVENTID_BUFFERTOOSMALL	UART ran out of buffers.

Definition at line 72 of file LinuxUartDriverComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_WRITEERROR_THROTTLE	Throttle reset count for WriteError.
EVENTID_READERROR_THROTTLE	Throttle reset count for ReadError.
EVENTID_NOBUFFERS_THROTTLE	Throttle reset count for NoBuffers.

Definition at line 83 of file LinuxUartDriverComponentAc.hpp.

anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_BYTESSENT	Channel ID for BytesSent.
CHANNELID_BYTESRECV	Channel ID for BytesRecv.

Definition at line 90 of file LinuxUartDriverComponentAc.hpp.

Constructor & Destructor Documentation

LinuxUartDriverComponentBase()

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

protected

Construct LinuxUartDriverComponentBase object.

Parameters

compName

The component name

Definition at line 466 of file LinuxUartDriverComponentAc.cpp.

~LinuxUartDriverComponentBase()

Drv::LinuxUartDriverComponentBase::~LinuxUartDriverComponentBase ( )

protectedvirtual

Destroy LinuxUartDriverComponentBase object.

Definition at line 475 of file LinuxUartDriverComponentAc.cpp.

Member Function Documentation

allocate_out()

Fw::Buffer Drv::LinuxUartDriverComponentBase::allocate_out ( FwIndexType  portNum, U32  size  )

protected

Invoke output port allocate.

Parameters

portNum	The port number
size	The requested size

Definition at line 690 of file LinuxUartDriverComponentAc.cpp.

deallocate_out()

void Drv::LinuxUartDriverComponentBase::deallocate_out ( FwIndexType  portNum, Fw::Buffer &  fwBuffer  )

protected

Invoke output port deallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 705 of file LinuxUartDriverComponentAc.cpp.

get_send_InputPort()

Drv::InputByteStreamSendPort * Drv::LinuxUartDriverComponentBase::get_send_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

send[portNum]

Parameters

portNum

The port number

Definition at line 209 of file LinuxUartDriverComponentAc.cpp.

getNum_allocate_OutputPorts()

FwIndexType Drv::LinuxUartDriverComponentBase::getNum_allocate_OutputPorts ( ) const

protected

Get the number of allocate output ports

Returns

The number of allocate output ports

Definition at line 527 of file LinuxUartDriverComponentAc.cpp.

getNum_deallocate_OutputPorts()

FwIndexType Drv::LinuxUartDriverComponentBase::getNum_deallocate_OutputPorts ( ) const

protected

Get the number of deallocate output ports

Returns

The number of deallocate output ports

Definition at line 533 of file LinuxUartDriverComponentAc.cpp.

getNum_Log_OutputPorts()

FwIndexType Drv::LinuxUartDriverComponentBase::getNum_Log_OutputPorts ( ) const

protected

Get the number of Log output ports

Returns

The number of Log output ports

Definition at line 495 of file LinuxUartDriverComponentAc.cpp.

getNum_ready_OutputPorts()

FwIndexType Drv::LinuxUartDriverComponentBase::getNum_ready_OutputPorts ( ) const

protected

Get the number of ready output ports

Returns

The number of ready output ports

Definition at line 539 of file LinuxUartDriverComponentAc.cpp.

getNum_recv_OutputPorts()

FwIndexType Drv::LinuxUartDriverComponentBase::getNum_recv_OutputPorts ( ) const

protected

Get the number of recv output ports

Returns

The number of recv output ports

Definition at line 545 of file LinuxUartDriverComponentAc.cpp.

getNum_send_InputPorts()

FwIndexType Drv::LinuxUartDriverComponentBase::getNum_send_InputPorts ( ) const

protected

Get the number of send input ports

Returns

The number of send input ports

Definition at line 485 of file LinuxUartDriverComponentAc.cpp.

getNum_Time_OutputPorts()

FwIndexType Drv::LinuxUartDriverComponentBase::getNum_Time_OutputPorts ( ) const

protected

Get the number of Time output ports

Returns

The number of Time output ports

Definition at line 511 of file LinuxUartDriverComponentAc.cpp.

getNum_Tlm_OutputPorts()

FwIndexType Drv::LinuxUartDriverComponentBase::getNum_Tlm_OutputPorts ( ) const

protected

Get the number of Tlm output ports

Returns

The number of Tlm output ports

Definition at line 517 of file LinuxUartDriverComponentAc.cpp.

getTime()

Fw::Time Drv::LinuxUartDriverComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 1504 of file LinuxUartDriverComponentAc.cpp.

init()

void Drv::LinuxUartDriverComponentBase::init

(

FwEnumStoreType

instance = 0

)

Initialize LinuxUartDriverComponentBase object.

Parameters

instance

The instance number

Definition at line 20 of file LinuxUartDriverComponentAc.cpp.

isConnected_allocate_OutputPort()

bool Drv::LinuxUartDriverComponentBase::isConnected_allocate_OutputPort ( FwIndexType  portNum )

protected

Check whether port allocate is connected

Returns

Whether port allocate is connected

Parameters

portNum

The port number

Definition at line 607 of file LinuxUartDriverComponentAc.cpp.

isConnected_deallocate_OutputPort()

bool Drv::LinuxUartDriverComponentBase::isConnected_deallocate_OutputPort ( FwIndexType  portNum )

protected

Check whether port deallocate is connected

Returns

Whether port deallocate is connected

Parameters

portNum

The port number

Definition at line 618 of file LinuxUartDriverComponentAc.cpp.

isConnected_Log_OutputPort()

bool Drv::LinuxUartDriverComponentBase::isConnected_Log_OutputPort ( FwIndexType  portNum )

protected

Check whether port Log is connected

Returns

Whether port Log is connected

Parameters

portNum

The port number

Definition at line 555 of file LinuxUartDriverComponentAc.cpp.

isConnected_ready_OutputPort()

bool Drv::LinuxUartDriverComponentBase::isConnected_ready_OutputPort ( FwIndexType  portNum )

protected

Check whether port ready is connected

Returns

Whether port ready is connected

Parameters

portNum

The port number

Definition at line 629 of file LinuxUartDriverComponentAc.cpp.

isConnected_recv_OutputPort()

bool Drv::LinuxUartDriverComponentBase::isConnected_recv_OutputPort ( FwIndexType  portNum )

protected

Check whether port recv is connected

Returns

Whether port recv is connected

Parameters

portNum

The port number

Definition at line 640 of file LinuxUartDriverComponentAc.cpp.

isConnected_Time_OutputPort()

bool Drv::LinuxUartDriverComponentBase::isConnected_Time_OutputPort ( FwIndexType  portNum )

protected

Check whether port Time is connected

Returns

Whether port Time is connected

Parameters

portNum

The port number

Definition at line 581 of file LinuxUartDriverComponentAc.cpp.

isConnected_Tlm_OutputPort()

bool Drv::LinuxUartDriverComponentBase::isConnected_Tlm_OutputPort ( FwIndexType  portNum )

protected

Check whether port Tlm is connected

Returns

Whether port Tlm is connected

Parameters

portNum

The port number

Definition at line 592 of file LinuxUartDriverComponentAc.cpp.

lock()

void Drv::LinuxUartDriverComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 1524 of file LinuxUartDriverComponentAc.cpp.

log_ACTIVITY_HI_PortOpened()

void Drv::LinuxUartDriverComponentBase::log_ACTIVITY_HI_PortOpened ( const Fw::StringBase &  device )

protected

Log event PortOpened

UART port opened event

Parameters

device

The device

Definition at line 1143 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_BufferTooSmall()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_BufferTooSmall ( const Fw::StringBase &  device, U32  size, U32  needed  )

protected

Log event BufferTooSmall

UART ran out of buffers

Parameters

device	The device
size	The provided buffer size
needed	The buffer size needed

Definition at line 1295 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_ConfigError()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_ConfigError ( const Fw::StringBase &  device, I32  error  )

protected

Log event ConfigError

UART config error

Parameters

device	The device
error	The error code

Definition at line 851 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_NoBuffers()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_NoBuffers ( const Fw::StringBase &  device )

protected

Log event NoBuffers

UART ran out of buffers

Parameters

device

The device

Definition at line 1215 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_NoBuffers_ThrottleClear()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_NoBuffers_ThrottleClear ( )

protected

Reset throttle value for NoBuffers.

Definition at line 1423 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_OpenError()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_OpenError ( const Fw::StringBase &  device, I32  error, const Fw::StringBase &  name  )

protected

Log event OpenError

UART open error

Parameters

device	The device
error	The error code
name	error string

Definition at line 751 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_ReadError()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_ReadError ( const Fw::StringBase &  device, I32  error  )

protected

Log event ReadError

UART read error

Parameters

device	The device
error	The error code

Definition at line 1043 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_ReadError_ThrottleClear()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_ReadError_ThrottleClear ( )

protected

Reset throttle value for ReadError.

Definition at line 1416 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_WriteError()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_WriteError ( const Fw::StringBase &  device, I32  error  )

protected

Log event WriteError

UART write error

Parameters

device	The device
error	The error code

Definition at line 943 of file LinuxUartDriverComponentAc.cpp.

log_WARNING_HI_WriteError_ThrottleClear()

void Drv::LinuxUartDriverComponentBase::log_WARNING_HI_WriteError_ThrottleClear ( )

protected

Reset throttle value for WriteError.

Definition at line 1409 of file LinuxUartDriverComponentAc.cpp.

ready_out()

void Drv::LinuxUartDriverComponentBase::ready_out ( FwIndexType  portNum )

protected

Invoke output port ready.

Parameters

portNum

The port number

Definition at line 720 of file LinuxUartDriverComponentAc.cpp.

recv_out()

void Drv::LinuxUartDriverComponentBase::recv_out ( FwIndexType  portNum, Fw::Buffer &  recvBuffer, const Drv::RecvStatus &  recvStatus  )

protected

Invoke output port recv.

Parameters

portNum

The port number

Definition at line 730 of file LinuxUartDriverComponentAc.cpp.

send_handler()

virtual Drv::SendStatus Drv::LinuxUartDriverComponentBase::send_handler ( FwIndexType  portNum, Fw::Buffer &  sendBuffer  )

protectedpure virtual

Handler for input port send.

Parameters

portNum	The port number
sendBuffer	Data to send

send_handlerBase()

Drv::SendStatus Drv::LinuxUartDriverComponentBase::send_handlerBase ( FwIndexType  portNum, Fw::Buffer &  sendBuffer  )

protected

Handler base-class function for input port send.

Parameters

portNum	The port number
sendBuffer	Data to send

Definition at line 657 of file LinuxUartDriverComponentAc.cpp.

set_allocate_OutputPort()

void Drv::LinuxUartDriverComponentBase::set_allocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferGetPort *	port
	)

Connect port to allocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 288 of file LinuxUartDriverComponentAc.cpp.

set_deallocate_OutputPort()

void Drv::LinuxUartDriverComponentBase::set_deallocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to deallocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 302 of file LinuxUartDriverComponentAc.cpp.

set_Log_OutputPort()

void Drv::LinuxUartDriverComponentBase::set_Log_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to Log[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 224 of file LinuxUartDriverComponentAc.cpp.

set_ready_OutputPort()

void Drv::LinuxUartDriverComponentBase::set_ready_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamReadyPort *	port
	)

Connect port to ready[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 316 of file LinuxUartDriverComponentAc.cpp.

set_recv_OutputPort()

void Drv::LinuxUartDriverComponentBase::set_recv_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamRecvPort *	port
	)

Connect port to recv[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 330 of file LinuxUartDriverComponentAc.cpp.

set_Time_OutputPort()

void Drv::LinuxUartDriverComponentBase::set_Time_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to Time[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 256 of file LinuxUartDriverComponentAc.cpp.

set_Tlm_OutputPort()

void Drv::LinuxUartDriverComponentBase::set_Tlm_OutputPort	(	FwIndexType	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to Tlm[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 270 of file LinuxUartDriverComponentAc.cpp.

tlmWrite_BytesRecv()

void Drv::LinuxUartDriverComponentBase::tlmWrite_BytesRecv ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel BytesRecv

Bytes Received

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1467 of file LinuxUartDriverComponentAc.cpp.

tlmWrite_BytesSent()

void Drv::LinuxUartDriverComponentBase::tlmWrite_BytesSent ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel BytesSent

Bytes Sent

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1434 of file LinuxUartDriverComponentAc.cpp.

unLock()

void Drv::LinuxUartDriverComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 1530 of file LinuxUartDriverComponentAc.cpp.

Friends And Related Function Documentation

LinuxUartDriverComponentBaseFriend

friend class LinuxUartDriverComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 42 of file LinuxUartDriverComponentAc.hpp.

---

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

• Drv/LinuxUartDriver/LinuxUartDriverComponentAc.hpp
• Drv/LinuxUartDriver/LinuxUartDriverComponentAc.cpp