iLLD_TC27xC  1.0
TOM Channel Functions
Collaboration diagram for TOM Channel Functions:

Functions

IFX_EXTERN void IfxGtm_Tom_Ch_clearOneNotification (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Clears the channel One notification. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_clearZeroNotification (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Clears the channel Zero notification. More...
 
IFX_EXTERN float32 IfxGtm_Tom_Ch_getClockFrequency (Ifx_GTM *gtm, Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the TOM channel input clock frequency in Hz. More...
 
IFX_EXTERN IfxGtm_Tom_Ch_ClkSrc IfxGtm_Tom_Ch_getClockSource (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the channel clock source. More...
 
IFX_EXTERN boolean IfxGtm_Tom_Ch_getOutputLevel (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Gets the TOM output level. More...
 
IFX_EXTERN volatile Ifx_SRC_SRCR * IfxGtm_Tom_Ch_getSrcPointer (Ifx_GTM *gtm, IfxGtm_Tom tom, IfxGtm_Tom_Ch channel)
 Returns a pointer to the TOM channel SRC. More...
 
IFX_EXTERN Ifx_GTM_TOM_TGCIfxGtm_Tom_Ch_getTgcPointer (Ifx_GTM_TOM *tom, uint32 tgcIndex)
 Returns the TGC pointer. More...
 
IFX_EXTERN volatile uint32IfxGtm_Tom_Ch_getTimerPointer (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the Timer pointer. More...
 
IFX_EXTERN boolean IfxGtm_Tom_Ch_isOneNotification (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the status of channel One notification. More...
 
IFX_EXTERN boolean IfxGtm_Tom_Ch_isZeroNotification (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the status of channel Zero notification. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_raiseInterruptOne (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Raises the interrupt for Compare 1. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_raiseInterruptZero (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Raises the interrupt for Compare 0. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setClockSource (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, IfxGtm_Tom_Ch_ClkSrc clock)
 Sets the channel clock source. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setCompare (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, uint32 compareZero, uint32 compareOne)
 Sets the compare 0 and 1 values. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setCompareOne (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, uint32 compareOne)
 Sets the compare 1 value. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setCompareOneShadow (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, uint32 shadowOne)
 Sets the compare 1 shadow value. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setCompareShadow (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, uint32 shadowZero, uint32 shadowOne)
 Sets the compare 0 and 1 shadow values. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setCompareZero (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, uint32 compareZero)
 Sets the compare 0 value. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setCompareZeroShadow (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, uint32 shadowZero)
 Sets the compare 0 shadow value. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setCounterValue (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, uint32 value)
 Sets the counter value. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setGatedCounter (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, boolean enabled)
 Enable/disable the gated counter mode (channel 0 to 7 only) More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setNotification (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, IfxGtm_IrqMode mode, boolean interruptOnCompareZero, boolean interruptOnCompareOne)
 Sets the channel notification. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setOneShotMode (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, boolean enabled)
 Enable/disable the one shot mode. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setPcm (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, boolean enabled)
 Enable/disable the PCM mode (channel 15 only) More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setResetSource (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, IfxGtm_Tom_Ch_ResetEvent event)
 Sets the channel clock source either from local or from previous channel. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setSignalLevel (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, Ifx_ActiveState activeState)
 Sets the signal level. More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setSpe (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, boolean enabled)
 Enable/disable the SPE mode (channel 0 to 7 only) More...
 
IFX_EXTERN void IfxGtm_Tom_Ch_setTriggerOutput (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel, IfxGtm_Tom_Ch_OutputTrigger trigger)
 Sets the channel trigger output. More...
 

Detailed Description

Function Documentation

IFX_EXTERN void IfxGtm_Tom_Ch_clearOneNotification ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Clears the channel One notification.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
None

Definition at line 62 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_acknowledgeTriggerIrq().

IFX_EXTERN void IfxGtm_Tom_Ch_clearZeroNotification ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Clears the channel Zero notification.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
None

Definition at line 70 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_acknowledgeTimerIrq().

IFX_EXTERN float32 IfxGtm_Tom_Ch_getClockFrequency ( Ifx_GTM *  gtm,
Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Returns the TOM channel input clock frequency in Hz.

Parameters
gtmPointer to GTM module
tomPointer to the TOM object
channelChannel index
Returns
TOM channel input clock frequency in Hz

Definition at line 78 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_updateInputFrequency().

IFX_EXTERN IfxGtm_Tom_Ch_ClkSrc IfxGtm_Tom_Ch_getClockSource ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Returns the channel clock source.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
The clock source

Definition at line 102 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Ch_getClockFrequency(), and IfxGtm_Tom_PwmHl_init().

IFX_EXTERN boolean IfxGtm_Tom_Ch_getOutputLevel ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Gets the TOM output level.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
TRUE the output is high, FALSE the output is low

Definition at line 113 of file IfxGtm_Tom.c.

IFX_EXTERN volatile Ifx_SRC_SRCR* IfxGtm_Tom_Ch_getSrcPointer ( Ifx_GTM *  gtm,
IfxGtm_Tom  tom,
IfxGtm_Tom_Ch  channel 
)

Returns a pointer to the TOM channel SRC.

Parameters
gtmPointer to GTM module
tomSpecifies the tom object
channelChannel index
Returns
Pointer to the TOM channel SRC

Definition at line 124 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_init().

IFX_EXTERN Ifx_GTM_TOM_TGC* IfxGtm_Tom_Ch_getTgcPointer ( Ifx_GTM_TOM *  tom,
uint32  tgcIndex 
)

Returns the TGC pointer.

Parameters
tomPointer to the TOM object
tgcIndexTGC index
Returns
TOM TGC object pointer

Definition at line 130 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_PwmHl_init(), and IfxGtm_Tom_Timer_init().

IFX_EXTERN volatile uint32* IfxGtm_Tom_Ch_getTimerPointer ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Returns the Timer pointer.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
Timer pointer

Definition at line 147 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_getPointer().

IFX_EXTERN boolean IfxGtm_Tom_Ch_isOneNotification ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Returns the status of channel One notification.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
Status of channel One notification

Definition at line 154 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_acknowledgeTriggerIrq().

IFX_EXTERN boolean IfxGtm_Tom_Ch_isZeroNotification ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Returns the status of channel Zero notification.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
Status of channel Zero notification

Definition at line 165 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_acknowledgeTimerIrq().

IFX_EXTERN void IfxGtm_Tom_Ch_raiseInterruptOne ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Raises the interrupt for Compare 1.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
None

Definition at line 176 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_raiseInterruptZero ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel 
)

Raises the interrupt for Compare 0.

Parameters
tomPointer to the TOM object
channelChannel index
Returns
None

Definition at line 184 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setClockSource ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
IfxGtm_Tom_Ch_ClkSrc  clock 
)

Sets the channel clock source.

Parameters
tomPointer to the TOM object
channelChannel index
clockChannel clock source
Returns
None

Definition at line 192 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_PwmHl_init(), and IfxGtm_Tom_Timer_init().

IFX_EXTERN void IfxGtm_Tom_Ch_setCompare ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
uint32  compareZero,
uint32  compareOne 
)

Sets the compare 0 and 1 values.

Parameters
tomPointer to the TOM object
channelChannel index
compareZeroCompare zero value
compareOneCompare one value
Returns
None

Definition at line 200 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setCompareOne ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
uint32  compareOne 
)

Sets the compare 1 value.

Parameters
tomPointer to the TOM object
channelChannel index
compareOneCompare one value
Returns
None

Definition at line 209 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setCompareOneShadow ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
uint32  shadowOne 
)

Sets the compare 1 shadow value.

Parameters
tomPointer to the TOM object
channelChannel index
shadowOneCompare one shadow value
Returns
None

Definition at line 217 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_setTrigger().

IFX_EXTERN void IfxGtm_Tom_Ch_setCompareShadow ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
uint32  shadowZero,
uint32  shadowOne 
)

Sets the compare 0 and 1 shadow values.

Parameters
tomPointer to the TOM object
channelChannel index
shadowZeroCompare zero shadow value
shadowOneCompare one shadow value
Returns
None

Definition at line 225 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setCompareZero ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
uint32  compareZero 
)

Sets the compare 0 value.

Parameters
tomPointer to the TOM object
channelChannel index
compareZeroCompare zero value
Returns
None

Definition at line 234 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setCompareZeroShadow ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
uint32  shadowZero 
)

Sets the compare 0 shadow value.

Parameters
tomPointer to the TOM object
channelChannel index
shadowZeroCompare zero shadow value
Returns
None

Definition at line 242 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_setPeriod().

IFX_EXTERN void IfxGtm_Tom_Ch_setCounterValue ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
uint32  value 
)

Sets the counter value.

Parameters
tomPointer to the TOM object
channelChannel index
valueCounter value
Returns
None

Definition at line 250 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setGatedCounter ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
boolean  enabled 
)

Enable/disable the gated counter mode (channel 0 to 7 only)

Parameters
tomPointer to the TOM object
channelChannel index
enabledIf TRUE, the feature is enabled, else disabled
Returns
None

Definition at line 258 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setNotification ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
IfxGtm_IrqMode  mode,
boolean  interruptOnCompareZero,
boolean  interruptOnCompareOne 
)

Sets the channel notification.

Parameters
tomPointer to the TOM object
channelChannel index
modeInterrupt mode
interruptOnCompareZeroIf TRUE, an interrupt is generated on compare 0, else no interrupt is generated
interruptOnCompareOneIf TRUE, an interrupt is generated on compare 1, else no interrupt is generated
Returns
None

Definition at line 270 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_init().

IFX_EXTERN void IfxGtm_Tom_Ch_setOneShotMode ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
boolean  enabled 
)

Enable/disable the one shot mode.

Parameters
tomPointer to the TOM object
channelChannel index
enabledIf TRUE, the feature is enabled, else disabled
Returns
None

Definition at line 289 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_Timer_setSingleMode().

IFX_EXTERN void IfxGtm_Tom_Ch_setPcm ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
boolean  enabled 
)

Enable/disable the PCM mode (channel 15 only)

Parameters
tomPointer to the TOM object
channelChannel index
enabledIf TRUE, the feature is enabled, else disabled
Returns
None

Definition at line 297 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setResetSource ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
IfxGtm_Tom_Ch_ResetEvent  event 
)

Sets the channel clock source either from local or from previous channel.

Parameters
tomPointer to the TOM object
channelChannel index
eventChannel reset event
Returns
None

Definition at line 308 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_PwmHl_init(), and IfxGtm_Tom_Timer_init().

IFX_EXTERN void IfxGtm_Tom_Ch_setSignalLevel ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
Ifx_ActiveState  activeState 
)

Sets the signal level.

Parameters
tomPointer to the TOM object
channelChannel index
activeStateSignal level active state. In case the channel is reset, the output is set to not active. The signal is active between 0 and the leading edge (CM1) and inactive between the leading edge and the trailing edge (CM0).
Returns
None

Definition at line 316 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_PwmHl_init(), IfxGtm_Tom_PwmHl_setMode(), and IfxGtm_Tom_Timer_init().

IFX_EXTERN void IfxGtm_Tom_Ch_setSpe ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
boolean  enabled 
)

Enable/disable the SPE mode (channel 0 to 7 only)

Parameters
tomPointer to the TOM object
channelChannel index
enabledIf TRUE, the feature is enabled, else disabled
Returns
None

Definition at line 324 of file IfxGtm_Tom.c.

IFX_EXTERN void IfxGtm_Tom_Ch_setTriggerOutput ( Ifx_GTM_TOM *  tom,
IfxGtm_Tom_Ch  channel,
IfxGtm_Tom_Ch_OutputTrigger  trigger 
)

Sets the channel trigger output.

Parameters
tomPointer to the TOM object
channelChannel index
triggerChannel trigger output mode
Returns
None

Definition at line 336 of file IfxGtm_Tom.c.

Referenced by IfxGtm_Tom_PwmHl_init(), and IfxGtm_Tom_Timer_init().