iLLD_TC27xD  1.0
IfxGtm_Tom.h File Reference

GTM basic functionality. More...

#include "_Impl/IfxGtm_cfg.h"
#include "IfxGtm.h"
#include "IfxGtm_Tbu.h"
#include "Src/Std/IfxSrc.h"

Go to the source code of this file.

Enumerations

enum  IfxGtm_Tom_Ch_ClkSrc {
  IfxGtm_Tom_Ch_ClkSrc_cmuFxclk0 = 0,
  IfxGtm_Tom_Ch_ClkSrc_cmuFxclk1 = 1,
  IfxGtm_Tom_Ch_ClkSrc_cmuFxclk2 = 2,
  IfxGtm_Tom_Ch_ClkSrc_cmuFxclk3 = 3,
  IfxGtm_Tom_Ch_ClkSrc_cmuFxclk4 = 4,
  IfxGtm_Tom_Ch_ClkSrc_noClock = 5
}
 Clock source for the TOM channels. More...
 
enum  IfxGtm_Tom_Ch_OutputTrigger {
  IfxGtm_Tom_Ch_OutputTrigger_forward = 0,
  IfxGtm_Tom_Ch_OutputTrigger_generate = 1
}
 Reset source for channel counter CN0. More...
 
enum  IfxGtm_Tom_Ch_ResetEvent {
  IfxGtm_Tom_Ch_ResetEvent_onCm0 = 0,
  IfxGtm_Tom_Ch_ResetEvent_onTrigger = 1
}
 Reset event for channel counter CN0. More...
 

Functions

IFX_INLINE Ifx_GTM_TOM_CH * IfxGtm_Tom_Ch_getChannelPointer (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the base addredd of selected Tom channel. More...
 
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 uint32 IfxGtm_Tom_Ch_getCompareOne (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the compare one value. More...
 
IFX_EXTERN volatile uint32IfxGtm_Tom_Ch_getCompareOnePointer (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the compare one pointer. More...
 
IFX_EXTERN uint32 IfxGtm_Tom_Ch_getCompareZero (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the compare zero value. More...
 
IFX_EXTERN volatile uint32IfxGtm_Tom_Ch_getCompareZeroPointer (Ifx_GTM_TOM *tom, IfxGtm_Tom_Ch channel)
 Returns the compare zero pointer. 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...
 
IFX_INLINE void IfxGtm_Tom_Tgc_writeGlobalControl (Ifx_GTM_TOM_TGC *tgc, uint32 control)
 Sets the tgc global control value. More...
 
IFX_EXTERN uint32 IfxGtm_Tom_Tgc_buildFeature (uint16 enableMask, uint16 disableMask, uint8 bitfieldOffset)
 Builds the register value for the feature enable/disable. More...
 
IFX_EXTERN uint32 IfxGtm_Tom_Tgc_buildFeatureForChannel (IfxGtm_Tom_Ch channel, boolean enabled, uint8 bitfieldOffset)
 Builds the register value for the feature enable/disable for a single channel. More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_enableChannel (Ifx_GTM_TOM_TGC *tgc, IfxGtm_Tom_Ch channel, boolean enabled, boolean immediate)
 Enable/disable one channel (ENDIS) More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_enableChannelOutput (Ifx_GTM_TOM_TGC *tgc, IfxGtm_Tom_Ch channel, boolean enabled, boolean immediate)
 Enable/disable one channel output (OUTEN) More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_enableChannelUpdate (Ifx_GTM_TOM_TGC *tgc, IfxGtm_Tom_Ch channel, boolean enabled)
 Enable/disable one channel for update (UPEN) More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_enableChannels (Ifx_GTM_TOM_TGC *tgc, uint16 enableMask, uint16 disableMask, boolean immediate)
 Enable/disable one or more channels (ENDIS) More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_enableChannelsOutput (Ifx_GTM_TOM_TGC *tgc, uint16 enableMask, uint16 disableMask, boolean immediate)
 Enable/disable one or more channels output (OUTEN) More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_enableChannelsTrigger (Ifx_GTM_TOM_TGC *tgc, uint16 enableMask, uint16 disableMask)
 Enable/disable the TGC channels trigger. More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_enableChannelsUpdate (Ifx_GTM_TOM_TGC *tgc, uint16 enableMask, uint16 disableMask)
 Enable/disable one or more channels for update (UPEN) More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_enableTimeTrigger (Ifx_GTM_TOM_TGC *tgc, boolean enabled)
 Enable/disable the time base trigger. More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_resetChannels (Ifx_GTM_TOM_TGC *tgc, uint32 resetMask)
 Reset one or more channels. More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_setChannelForceUpdate (Ifx_GTM_TOM_TGC *tgc, IfxGtm_Tom_Ch channel, boolean enabled, boolean resetEnabled)
 Enable/disable one channel for update (FUPD) More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_setChannelsForceUpdate (Ifx_GTM_TOM_TGC *tgc, uint16 enableMask, uint16 disableMask, uint16 resetEnableMask, uint16 resetDisableMask)
 Enable/disable one or more channels for the force update feature (FUPD) More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_setTimeTrigger (Ifx_GTM_TOM_TGC *tgc, IfxGtm_Tbu_Ts base, uint32 value)
 Sets the trigger time base and time base value. More...
 
IFX_EXTERN void IfxGtm_Tom_Tgc_trigger (Ifx_GTM_TOM_TGC *tgc)
 Raise the trigger for the channel enable/disable settings, output enable settings, and force update event (CTRL_TRIG) More...
 

Detailed Description

GTM basic functionality.

Version
iLLD_1_0_0_11_0
                            IMPORTANT NOTICE

Infineon Technologies AG (Infineon) is supplying this file for use exclusively with Infineon's microcontroller products. This file can be freely distributed within development tools that are supporting such microcontroller products.

THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. INFINEON SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

Definition in file IfxGtm_Tom.h.