Collaboration diagram for Comparator Functions:

Functions
IFX_INLINE uint32	IfxStm_getCompare (Ifx_STM *stm, IfxStm_Comparator comparator)
	Returns the updated compare register value. More...

IFX_INLINE sint32	IfxStm_getTicksFromMicroseconds (Ifx_STM *stm, uint32 microSeconds)
	Returns the number of ticks for the selected micro seconds based on the STM frequency. More...

IFX_INLINE sint32	IfxStm_getTicksFromMilliseconds (Ifx_STM *stm, uint32 milliSeconds)
	Returns the number of ticks for the selected milli seconds based on the STM frequency. More...

IFX_INLINE void	IfxStm_increaseCompare (Ifx_STM *stm, IfxStm_Comparator comparator, uint32 ticks)
	Update the compare register value increased with given ticks. More...

IFX_INLINE void	IfxStm_updateCompare (Ifx_STM *stm, IfxStm_Comparator comparator, uint32 ticks)
	Update the compare register value. More...

IFX_EXTERN void	IfxStm_clearCompareFlag (Ifx_STM *stm, IfxStm_Comparator comparator)
	Clear the compare interrupt flag. More...

IFX_EXTERN boolean	IfxStm_initCompare (Ifx_STM stm, const IfxStm_CompareConfig config)
	Initialise stm compare register. More...

IFX_EXTERN void	IfxStm_initCompareConfig (IfxStm_CompareConfig *config)
	Initialise compare configuration with default values. More...

IFX_EXTERN void	IfxStm_enableComparatorInterrupt (Ifx_STM *stm, IfxStm_Comparator comparator)
	Enables the compare interrupt . More...

Detailed Description

Function Documentation

IFX_EXTERN void IfxStm_clearCompareFlag	(	Ifx_STM *	stm,
		IfxStm_Comparator	comparator
	)

Clear the compare interrupt flag.

Parameters

stm	pointer to System timer module registers.
comparator	comparator selection comparator.

Returns: None

Definition at line 35 of file IfxStm.c.

Referenced by IfxStm_initCompare().

IFX_EXTERN void IfxStm_enableComparatorInterrupt	(	Ifx_STM *	stm,
		IfxStm_Comparator	comparator
	)

Enables the compare interrupt .

Parameters

stm	pointer to System timer module registers.
comparator	comparator selection comparator.

Returns: None

Definition at line 177 of file IfxStm.c.

Referenced by IfxStm_initCompare().

IFX_INLINE uint32 IfxStm_getCompare	(	Ifx_STM *	stm,
		IfxStm_Comparator	comparator
	)

Returns the updated compare register value.

Parameters

stm	pointer to System timer module registers.
comparator	comparator selection comparator.

Returns: The compare value

Definition at line 469 of file IfxStm.h.

IFX_INLINE sint32 IfxStm_getTicksFromMicroseconds	(	Ifx_STM *	stm,
		uint32	microSeconds
	)

Returns the number of ticks for the selected micro seconds based on the STM frequency.

Parameters

stm	pointer to System timer module registers.
microSeconds	Number of micro seconds that need to be converted to ticks

Returns: ticks

Definition at line 537 of file IfxStm.h.

IFX_INLINE sint32 IfxStm_getTicksFromMilliseconds	(	Ifx_STM *	stm,
		uint32	milliSeconds
	)

Returns the number of ticks for the selected milli seconds based on the STM frequency.

Parameters

stm	pointer to System timer module registers.
milliSeconds	Number of micro seconds that need to be converted to ticks

Returns: ticks

Definition at line 544 of file IfxStm.h.

IFX_INLINE void IfxStm_increaseCompare	(	Ifx_STM *	stm,
		IfxStm_Comparator	comparator,
		uint32	ticks
	)

Update the compare register value increased with given ticks.

Parameters

stm	pointer to System timer module registers.
comparator	comparator selection comparator.
ticks	count for next comparison from current timer count.

Returns: None

Definition at line 551 of file IfxStm.h.

IFX_EXTERN boolean IfxStm_initCompare	(	Ifx_STM *	stm,
		const IfxStm_CompareConfig *	config
	)

Initialise stm compare register.

Parameters

stm	pointer to System timer module registers.
config	pointer to configuration structure.

Returns: TRUE if Comparator successful otherwise FLASE.

Definition at line 79 of file IfxStm.c.

IFX_EXTERN void IfxStm_initCompareConfig ( IfxStm_CompareConfig * config)

Initialise compare configuration with default values.

Parameters

config pointer to configuration structure.

Returns: None

Definition at line 145 of file IfxStm.c.

IFX_INLINE void IfxStm_updateCompare	(	Ifx_STM *	stm,
		IfxStm_Comparator	comparator,
		uint32	ticks
	)

Update the compare register value.

Parameters

stm	pointer to System timer module registers.
comparator	comparator selection comparator.
ticks	count for next comparison.

Returns: None

Definition at line 566 of file IfxStm.h.