iLLD_TC27xD  1.0
Single Pin Functions
Collaboration diagram for Single Pin Functions:

Functions

IFX_INLINE boolean IfxPort_getPinState (Ifx_P *port, uint8 pinIndex)
 Return the port state. More...
 
IFX_INLINE void IfxPort_setPinHigh (Ifx_P *port, uint8 pinIndex)
 Set the port output. More...
 
IFX_INLINE void IfxPort_setPinLow (Ifx_P *port, uint8 pinIndex)
 Reset the port output. More...
 
IFX_INLINE void IfxPort_setPinModeInput (Ifx_P *port, uint8 pinIndex, IfxPort_InputMode mode)
 Configure the port input / output mode. More...
 
IFX_INLINE void IfxPort_setPinModeOutput (Ifx_P *port, uint8 pinIndex, IfxPort_OutputMode mode, IfxPort_OutputIdx index)
 Configure the port input / output mode. More...
 
IFX_INLINE void IfxPort_setPinState (Ifx_P *port, uint8 pinIndex, IfxPort_State action)
 Set / Resets / Toggle the port output. More...
 
IFX_INLINE void IfxPort_togglePin (Ifx_P *port, uint8 pinIndex)
 Toggle the port output. More...
 
IFX_EXTERN boolean IfxPort_disableEmergencyStop (Ifx_P *port, uint8 pinIndex)
 Disable the emergency stop function. This function disables the emergency stop function. A check is done on port functionality. More...
 
IFX_EXTERN boolean IfxPort_enableEmergencyStop (Ifx_P *port, uint8 pinIndex)
 Enable the emergency stop function. This function enables the emergency stop function. A check is done on port functionality. More...
 
IFX_EXTERN void IfxPort_setPinMode (Ifx_P *port, uint8 pinIndex, IfxPort_Mode mode)
 Configure the port input / output mode. Also Configures the P40/P41 Port for digital functionality which bydefault support analog functionality. More...
 
IFX_EXTERN void IfxPort_setPinPadDriver (Ifx_P *port, uint8 pinIndex, IfxPort_PadDriver padDriver)
 Configure the pad driver mode. More...
 

Detailed Description

Function Documentation

IFX_EXTERN boolean IfxPort_disableEmergencyStop ( Ifx_P *  port,
uint8  pinIndex 
)

Disable the emergency stop function. This function disables the emergency stop function. A check is done on port functionality.

Parameters
portPointer to the port which should be accessed.
pinIndexSpecifies the pin for which the emergency stop function should be disabled.
Returns
Returns TRUE if the emergency stop function has been disabled; FALSE if the emergency stop function could not be disabled

Coding example: /code if( !IfxPort_disableEmergencyStop(&MODULE_P33, 0) ) { // failed to disable emergency stop for P33.0 } /endcode

See Also
IfxPort_disableEmergencyStop(), IfxPort_resetESR()

Definition at line 35 of file IfxPort.c.

IFX_EXTERN boolean IfxPort_enableEmergencyStop ( Ifx_P *  port,
uint8  pinIndex 
)

Enable the emergency stop function. This function enables the emergency stop function. A check is done on port functionality.

Parameters
portPointer to the port which should be accessed.
pinIndexSpecifies the pin for which the emergency stop function should be enabled.
Returns
Returns TRUE if the emergency stop function has been enabled; FALSE if the emergency stop function could not be enabled

Coding example:

if( !IfxPort_enableEmergencyStop(&MODULE_P33, 0) ) {
// failed to enable emergency stop for P33.0
}
See Also
IfxPort_disableEmergencyStop(), IfxPort_setESR()

Definition at line 58 of file IfxPort.c.

IFX_INLINE boolean IfxPort_getPinState ( Ifx_P *  port,
uint8  pinIndex 
)

Return the port state.

Parameters
portPointer to the port which should be accessed.
pinIndexSpecifies the pin for which the state should be returned.
Returns
Returns TRUE the pin is high; FALSE the pin is low

Coding example:

if( IfxPort_getPinState(&MODULE_P33, 0) ) {
// ...
}

Definition at line 530 of file IfxPort.h.

IFX_INLINE void IfxPort_setPinHigh ( Ifx_P *  port,
uint8  pinIndex 
)

Set the port output.

Parameters
portPointer to the port which should be accessed.
pinIndexSpecifies the pin to be set.
Returns
None

Coding example:

IfxPort_setPinHigh(&MODULE_P33, 0);
See Also
IfxPort_setPinState(), IfxPort_setPinLow(), IfxPort_togglePin()

Definition at line 542 of file IfxPort.h.

IFX_INLINE void IfxPort_setPinLow ( Ifx_P *  port,
uint8  pinIndex 
)

Reset the port output.

Parameters
portPointer to the port which should be accessed.
pinIndexSpecifies the pin to be reset.
Returns
None

Coding example:

IfxPort_setPinLow(&MODULE_P33, 0);
See Also
IfxPort_setPinState(), IfxPort_setPinHigh(), IfxPort_togglePin()

Definition at line 548 of file IfxPort.h.

IFX_EXTERN void IfxPort_setPinMode ( Ifx_P *  port,
uint8  pinIndex,
IfxPort_Mode  mode 
)

Configure the port input / output mode. Also Configures the P40/P41 Port for digital functionality which bydefault support analog functionality.

Parameters
portPointer to the port which should be accessed.
pinIndexSpecifies the pin to be configured.
modeSpecifies the port pin mode.
Returns
None

Coding example:

Definition at line 236 of file IfxPort.c.

Referenced by IfxPort_Io_initModule(), IfxPort_setPinModeInput(), and IfxPort_setPinModeOutput().

IFX_EXTERN void IfxPort_setPinPadDriver ( Ifx_P *  port,
uint8  pinIndex,
IfxPort_PadDriver  padDriver 
)
IFX_INLINE void IfxPort_setPinState ( Ifx_P *  port,
uint8  pinIndex,
IfxPort_State  action 
)

Set / Resets / Toggle the port output.

Parameters
portPointer to the port which should be accessed.
pinIndexSpecifies the pin to modify.
actionSpecifies the action: set, reset, toggle.
Returns
None

Coding example:

Definition at line 566 of file IfxPort.h.

Referenced by IfxGtm_Tom_PwmHl_init(), IfxPort_setPinHigh(), IfxPort_setPinLow(), and IfxPort_togglePin().

IFX_INLINE void IfxPort_togglePin ( Ifx_P *  port,
uint8  pinIndex 
)

Toggle the port output.

Parameters
portPointer to the port which should be accessed.
pinIndexSpecifies the pin to be toggled.
Returns
None

Coding example:

IfxPort_togglePin(&MODULE_P33, 0);
See Also
IfxPort_setPinState(), IfxPort_setPinLow(), IfxPort_setPinHigh()

Definition at line 572 of file IfxPort.h.