F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Public Member Functions | Protected Types | Protected Member Functions | Friends | List of all members
Drv::LinuxGpioDriverComponentBase Class Referenceabstract

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

#include <Drv/LinuxGpioDriver/LinuxGpioDriverComponentAc.hpp>

Inheritance diagram for Drv::LinuxGpioDriverComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Drv::LinuxGpioDriverComponentImpl

Public Member Functions

void init (NATIVE_INT_TYPE instance=0)
 Initialize LinuxGpioDriverComponentBase object. More...
 
Drv::InputGpioReadPort * get_gpioRead_InputPort (NATIVE_INT_TYPE portNum)
 
Drv::InputGpioWritePort * get_gpioWrite_InputPort (NATIVE_INT_TYPE portNum)
 
void set_Log_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
 Connect port to Log[portNum]. More...
 
void set_Time_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum]. More...
 
void set_intOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputCyclePort *port)
 Connect port to intOut[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_GPIOREAD_INPUT_PORTS = 1 , NUM_GPIOWRITE_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 }
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_INTOUT_OUTPUT_PORTS = 2 }
 Enumerations for numbers of typed output ports. More...
 
enum  {
  EVENTID_GP_OPENERROR = 0x0 , EVENTID_GP_CONFIGERROR = 0x1 , EVENTID_GP_WRITEERROR = 0x2 , EVENTID_GP_READERROR = 0x3 ,
  EVENTID_GP_PORTOPENED = 0x4 , EVENTID_GP_INTSTARTERROR = 0x5 , EVENTID_GP_INTWAITERROR = 0x6
}
 Event IDs. More...
 
enum  { EVENTID_GP_WRITEERROR_THROTTLE = 5 , EVENTID_GP_READERROR_THROTTLE = 5 }
 Event throttle values: sets initial value of countdown variables. More...
 

Protected Member Functions

 LinuxGpioDriverComponentBase (const char *compName="")
 Construct LinuxGpioDriverComponentBase object. More...
 
virtual ~LinuxGpioDriverComponentBase ()
 Destroy LinuxGpioDriverComponentBase object. More...
 
NATIVE_INT_TYPE getNum_gpioRead_InputPorts () const
 
NATIVE_INT_TYPE getNum_gpioWrite_InputPorts () const
 
NATIVE_INT_TYPE getNum_Log_OutputPorts () const
 
NATIVE_INT_TYPE getNum_Time_OutputPorts () const
 
NATIVE_INT_TYPE getNum_intOut_OutputPorts () const
 
bool isConnected_Log_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_Time_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_intOut_OutputPort (NATIVE_INT_TYPE portNum)
 
virtual void gpioRead_handler (NATIVE_INT_TYPE portNum, Fw::Logic &state)=0
 Handler for input port gpioRead. More...
 
virtual void gpioWrite_handler (NATIVE_INT_TYPE portNum, const Fw::Logic &state)=0
 Handler for input port gpioWrite. More...
 
void gpioRead_handlerBase (NATIVE_INT_TYPE portNum, Fw::Logic &state)
 Handler base-class function for input port gpioRead. More...
 
void gpioWrite_handlerBase (NATIVE_INT_TYPE portNum, const Fw::Logic &state)
 Handler base-class function for input port gpioWrite. More...
 
void intOut_out (NATIVE_INT_TYPE portNum, Svc::TimerVal &cycleStart)
 Invoke output port intOut. More...
 
void log_WARNING_HI_GP_OpenError (I32 gpio, I32 error, const Fw::LogStringArg &msg)
 
void log_WARNING_HI_GP_ConfigError (I32 gpio, I32 error)
 
void log_WARNING_HI_GP_WriteError (I32 gpio, I32 error)
 
void log_WARNING_HI_GP_ReadError (I32 gpio, I32 error)
 
void log_ACTIVITY_HI_GP_PortOpened (I32 gpio)
 
void log_WARNING_HI_GP_IntStartError (I32 gpio)
 
void log_WARNING_HI_GP_IntWaitError (I32 gpio)
 
void log_WARNING_HI_GP_WriteError_ThrottleClear ()
 Reset throttle value for GP_WriteError. More...
 
void log_WARNING_HI_GP_ReadError_ThrottleClear ()
 Reset throttle value for GP_ReadError. More...
 
Fw::Time getTime ()
 
- 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 LinuxGpioDriverComponentBaseFriend
 Friend class for white-box testing. More...
 

Detailed Description

Auto-generated base for LinuxGpioDriver component.

Definition at line 28 of file LinuxGpioDriverComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_GPIOREAD_INPUT_PORTS 
NUM_GPIOWRITE_INPUT_PORTS 

Definition at line 46 of file LinuxGpioDriverComponentAc.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 

Definition at line 52 of file LinuxGpioDriverComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_INTOUT_OUTPUT_PORTS 

Definition at line 59 of file LinuxGpioDriverComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_GP_OPENERROR 

Open error.

EVENTID_GP_CONFIGERROR 

GPIO configure error.

EVENTID_GP_WRITEERROR 

GPIO write error.

EVENTID_GP_READERROR 

GPIO read error.

EVENTID_GP_PORTOPENED 

GPIO opened notification.

EVENTID_GP_INTSTARTERROR 

GPIO interrupt start error notification.

EVENTID_GP_INTWAITERROR 

GPIO interrupt wait error notification.

Definition at line 64 of file LinuxGpioDriverComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_GP_WRITEERROR_THROTTLE 

Throttle reset count for GP_WriteError.

EVENTID_GP_READERROR_THROTTLE 

Throttle reset count for GP_ReadError.

Definition at line 75 of file LinuxGpioDriverComponentAc.hpp.

Constructor & Destructor Documentation

◆ LinuxGpioDriverComponentBase()

Drv::LinuxGpioDriverComponentBase::LinuxGpioDriverComponentBase ( const char *  compName = "")
protected

Construct LinuxGpioDriverComponentBase object.

Parameters
compNameThe component name

Definition at line 376 of file LinuxGpioDriverComponentAc.cpp.

◆ ~LinuxGpioDriverComponentBase()

Drv::LinuxGpioDriverComponentBase::~LinuxGpioDriverComponentBase ( )
protectedvirtual

Destroy LinuxGpioDriverComponentBase object.

Definition at line 384 of file LinuxGpioDriverComponentAc.cpp.

Member Function Documentation

◆ get_gpioRead_InputPort()

Drv::InputGpioReadPort * Drv::LinuxGpioDriverComponentBase::get_gpioRead_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
gpioRead[portNum]
Parameters
portNumThe port number

Definition at line 206 of file LinuxGpioDriverComponentAc.cpp.

◆ get_gpioWrite_InputPort()

Drv::InputGpioWritePort * Drv::LinuxGpioDriverComponentBase::get_gpioWrite_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
gpioWrite[portNum]
Parameters
portNumThe port number

Definition at line 217 of file LinuxGpioDriverComponentAc.cpp.

◆ getNum_gpioRead_InputPorts()

NATIVE_INT_TYPE Drv::LinuxGpioDriverComponentBase::getNum_gpioRead_InputPorts ( ) const
protected

Get the number of gpioRead input ports

Returns
The number of gpioRead input ports

Definition at line 394 of file LinuxGpioDriverComponentAc.cpp.

◆ getNum_gpioWrite_InputPorts()

NATIVE_INT_TYPE Drv::LinuxGpioDriverComponentBase::getNum_gpioWrite_InputPorts ( ) const
protected

Get the number of gpioWrite input ports

Returns
The number of gpioWrite input ports

Definition at line 400 of file LinuxGpioDriverComponentAc.cpp.

◆ getNum_intOut_OutputPorts()

NATIVE_INT_TYPE Drv::LinuxGpioDriverComponentBase::getNum_intOut_OutputPorts ( ) const
protected

Get the number of intOut output ports

Returns
The number of intOut output ports

Definition at line 436 of file LinuxGpioDriverComponentAc.cpp.

◆ getNum_Log_OutputPorts()

NATIVE_INT_TYPE Drv::LinuxGpioDriverComponentBase::getNum_Log_OutputPorts ( ) const
protected

Get the number of Log output ports

Returns
The number of Log output ports

Definition at line 410 of file LinuxGpioDriverComponentAc.cpp.

◆ getNum_Time_OutputPorts()

NATIVE_INT_TYPE Drv::LinuxGpioDriverComponentBase::getNum_Time_OutputPorts ( ) const
protected

Get the number of Time output ports

Returns
The number of Time output ports

Definition at line 426 of file LinuxGpioDriverComponentAc.cpp.

◆ getTime()

Fw::Time Drv::LinuxGpioDriverComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 1307 of file LinuxGpioDriverComponentAc.cpp.

◆ gpioRead_handler()

virtual void Drv::LinuxGpioDriverComponentBase::gpioRead_handler ( NATIVE_INT_TYPE  portNum,
Fw::Logic &  state 
)
protectedpure virtual

Handler for input port gpioRead.

Parameters
portNumThe port number

◆ gpioRead_handlerBase()

void Drv::LinuxGpioDriverComponentBase::gpioRead_handlerBase ( NATIVE_INT_TYPE  portNum,
Fw::Logic &  state 
)
protected

Handler base-class function for input port gpioRead.

Parameters
portNumThe port number

Definition at line 504 of file LinuxGpioDriverComponentAc.cpp.

◆ gpioWrite_handler()

virtual void Drv::LinuxGpioDriverComponentBase::gpioWrite_handler ( NATIVE_INT_TYPE  portNum,
const Fw::Logic &  state 
)
protectedpure virtual

Handler for input port gpioWrite.

Parameters
portNumThe port number

◆ gpioWrite_handlerBase()

void Drv::LinuxGpioDriverComponentBase::gpioWrite_handlerBase ( NATIVE_INT_TYPE  portNum,
const Fw::Logic &  state 
)
protected

Handler base-class function for input port gpioWrite.

Parameters
portNumThe port number

Definition at line 523 of file LinuxGpioDriverComponentAc.cpp.

◆ init()

void Drv::LinuxGpioDriverComponentBase::init ( NATIVE_INT_TYPE  instance = 0)

Initialize LinuxGpioDriverComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file LinuxGpioDriverComponentAc.cpp.

◆ intOut_out()

void Drv::LinuxGpioDriverComponentBase::intOut_out ( NATIVE_INT_TYPE  portNum,
Svc::TimerVal &  cycleStart 
)
protected

Invoke output port intOut.

Parameters
portNumThe port number
cycleStartCycle start timer value

Definition at line 546 of file LinuxGpioDriverComponentAc.cpp.

◆ isConnected_intOut_OutputPort()

bool Drv::LinuxGpioDriverComponentBase::isConnected_intOut_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port intOut is connected

Returns
Whether port intOut is connected
Parameters
portNumThe port number

Definition at line 487 of file LinuxGpioDriverComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Drv::LinuxGpioDriverComponentBase::isConnected_Log_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port Log is connected

Returns
Whether port Log is connected
Parameters
portNumThe port number

Definition at line 446 of file LinuxGpioDriverComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Drv::LinuxGpioDriverComponentBase::isConnected_Time_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port Time is connected

Returns
Whether port Time is connected
Parameters
portNumThe port number

Definition at line 472 of file LinuxGpioDriverComponentAc.cpp.

◆ log_ACTIVITY_HI_GP_PortOpened()

void Drv::LinuxGpioDriverComponentBase::log_ACTIVITY_HI_GP_PortOpened ( I32  gpio)
protected

Log event GP_PortOpened

GPIO opened notification

Parameters
gpioThe device

Definition at line 1021 of file LinuxGpioDriverComponentAc.cpp.

◆ log_WARNING_HI_GP_ConfigError()

void Drv::LinuxGpioDriverComponentBase::log_WARNING_HI_GP_ConfigError ( I32  gpio,
I32  error 
)
protected

Log event GP_ConfigError

GPIO configure error

Parameters
gpioThe device
errorThe error code

Definition at line 681 of file LinuxGpioDriverComponentAc.cpp.

◆ log_WARNING_HI_GP_IntStartError()

void Drv::LinuxGpioDriverComponentBase::log_WARNING_HI_GP_IntStartError ( I32  gpio)
protected

Log event GP_IntStartError

GPIO interrupt start error notification

Parameters
gpioThe device

Definition at line 1109 of file LinuxGpioDriverComponentAc.cpp.

◆ log_WARNING_HI_GP_IntWaitError()

void Drv::LinuxGpioDriverComponentBase::log_WARNING_HI_GP_IntWaitError ( I32  gpio)
protected

Log event GP_IntWaitError

GPIO interrupt wait error notification

Parameters
gpioThe device

Definition at line 1197 of file LinuxGpioDriverComponentAc.cpp.

◆ log_WARNING_HI_GP_OpenError()

void Drv::LinuxGpioDriverComponentBase::log_WARNING_HI_GP_OpenError ( I32  gpio,
I32  error,
const Fw::LogStringArg &  msg 
)
protected

Log event GP_OpenError

Open error

Parameters
gpioThe device
errorThe error code
msgThe error string

Definition at line 565 of file LinuxGpioDriverComponentAc.cpp.

◆ log_WARNING_HI_GP_ReadError()

void Drv::LinuxGpioDriverComponentBase::log_WARNING_HI_GP_ReadError ( I32  gpio,
I32  error 
)
protected

Log event GP_ReadError

GPIO read error

Parameters
gpioThe device
errorThe error code

Definition at line 905 of file LinuxGpioDriverComponentAc.cpp.

◆ log_WARNING_HI_GP_ReadError_ThrottleClear()

void Drv::LinuxGpioDriverComponentBase::log_WARNING_HI_GP_ReadError_ThrottleClear ( )
protected

Reset throttle value for GP_ReadError.

Definition at line 1296 of file LinuxGpioDriverComponentAc.cpp.

◆ log_WARNING_HI_GP_WriteError()

void Drv::LinuxGpioDriverComponentBase::log_WARNING_HI_GP_WriteError ( I32  gpio,
I32  error 
)
protected

Log event GP_WriteError

GPIO write error

Parameters
gpioThe device
errorThe error code

Definition at line 789 of file LinuxGpioDriverComponentAc.cpp.

◆ log_WARNING_HI_GP_WriteError_ThrottleClear()

void Drv::LinuxGpioDriverComponentBase::log_WARNING_HI_GP_WriteError_ThrottleClear ( )
protected

Reset throttle value for GP_WriteError.

Definition at line 1289 of file LinuxGpioDriverComponentAc.cpp.

◆ set_intOut_OutputPort()

void Drv::LinuxGpioDriverComponentBase::set_intOut_OutputPort ( NATIVE_INT_TYPE  portNum,
Svc::InputCyclePort *  port 
)

Connect port to intOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 282 of file LinuxGpioDriverComponentAc.cpp.

◆ set_Log_OutputPort()

void Drv::LinuxGpioDriverComponentBase::set_Log_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputLogPort *  port 
)

Connect port to Log[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 232 of file LinuxGpioDriverComponentAc.cpp.

◆ set_Time_OutputPort()

void Drv::LinuxGpioDriverComponentBase::set_Time_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputTimePort *  port 
)

Connect port to Time[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 264 of file LinuxGpioDriverComponentAc.cpp.

Friends And Related Function Documentation

◆ LinuxGpioDriverComponentBaseFriend

friend class LinuxGpioDriverComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 37 of file LinuxGpioDriverComponentAc.hpp.

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