Timer StdIf Functions

Collaboration diagram for Timer StdIf Functions:

Functions
IFX_EXTERN boolean	IfxGtm_Atom_Timer_acknowledgeTimerIrq (IfxGtm_Atom_Timer *driver)
	Returns the timer event. More...
IFX_EXTERN boolean	IfxGtm_Atom_Timer_acknowledgeTriggerIrq (IfxGtm_Atom_Timer *driver)
	Returns the trigger event. More...
IFX_EXTERN void	IfxGtm_Atom_Timer_applyUpdate (IfxGtm_Atom_Timer *driver)
	Enables the transfer of the shadow registers. More...
IFX_EXTERN void	IfxGtm_Atom_Timer_disableUpdate (IfxGtm_Atom_Timer *driver)
	Disables the upadte. More...
IFX_EXTERN float32	IfxGtm_Atom_Timer_getFrequency (IfxGtm_Atom_Timer *driver)
	Returns the frequency. More...
IFX_EXTERN float32	IfxGtm_Atom_Timer_getInputFrequency (IfxGtm_Atom_Timer *driver)
	Returns the Input frequncy. More...
IFX_EXTERN Ifx_TimerValue	IfxGtm_Atom_Timer_getPeriod (IfxGtm_Atom_Timer *driver)
	Returns the period of the timer. More...
IFX_EXTERN float32	IfxGtm_Atom_Timer_getResolution (IfxGtm_Atom_Timer *driver)
	Returns the resolution. More...
IFX_EXTERN Ifx_TimerValue	IfxGtm_Atom_Timer_getTrigger (IfxGtm_Atom_Timer *driver)
	Returns the trigger point. More...
IFX_EXTERN void	IfxGtm_Atom_Timer_run (IfxGtm_Atom_Timer *driver)
	Runs the timer. More...
IFX_EXTERN boolean	IfxGtm_Atom_Timer_setFrequency (IfxGtm_Atom_Timer *driver, float32 frequency)
	Sets the frequency. More...
IFX_EXTERN boolean	IfxGtm_Atom_Timer_setPeriod (IfxGtm_Atom_Timer *driver, Ifx_TimerValue period)
	Sets the period for the timer. More...
IFX_EXTERN void	IfxGtm_Atom_Timer_setSingleMode (IfxGtm_Atom_Timer *driver, boolean enabled)
	Sets the single shot mode of the timer. More...
IFX_EXTERN boolean	IfxGtm_Atom_Timer_setTrigger (IfxGtm_Atom_Timer *driver, Ifx_TimerValue triggerPoint)
	Sets the trigger. More...
IFX_EXTERN boolean	IfxGtm_Atom_Timer_stdIfTimerInit (IfxStdIf_Timer *stdif, IfxGtm_Atom_Timer *driver)
	Initializes the standard interface timer. More...
IFX_EXTERN void	IfxGtm_Atom_Timer_stop (IfxGtm_Atom_Timer *driver)
	Stops the timer. More...
IFX_EXTERN void	IfxGtm_Atom_Timer_updateInputFrequency (IfxGtm_Atom_Timer *driver)
	Updates the input frequency. More...

Detailed Description

Function Documentation

IFX_EXTERN boolean IfxGtm_Atom_Timer_acknowledgeTimerIrq

(

IfxGtm_Atom_Timer *

driver)

Returns the timer event.

See Also

IfxStdIf_Timer_AckTimerIrq

Parameters

driver

ATOM Timer interface Handle

Returns

Timer event

Definition at line 38 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN boolean IfxGtm_Atom_Timer_acknowledgeTriggerIrq

(

IfxGtm_Atom_Timer *

driver)

Returns the trigger event.

See Also

IfxStdIf_Timer_AckTriggerIrq

Parameters

driver

ATOM Timer interface Handle

Returns

Trigger event

Definition at line 54 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN void IfxGtm_Atom_Timer_applyUpdate

(

IfxGtm_Atom_Timer *

driver)

Enables the transfer of the shadow registers.

See Also

IfxStdIf_Timer_ApplyUpdate

Parameters

driver

ATOM Timer interface Handle

Returns

None

Definition at line 76 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN void IfxGtm_Atom_Timer_disableUpdate

(

IfxGtm_Atom_Timer *

driver)

Disables the upadte.

See Also

IfxStdIf_Timer_DisableUpdate

Parameters

driver

ATOM Timer interface Handle

Returns

None

Definition at line 82 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN float32 IfxGtm_Atom_Timer_getFrequency

(

IfxGtm_Atom_Timer *

driver)

Returns the frequency.

See Also

IfxStdIf_Timer_GetFrequency

Parameters

driver

ATOM Timer interface Handle

Returns

Frequency

Definition at line 88 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN float32 IfxGtm_Atom_Timer_getInputFrequency

(

IfxGtm_Atom_Timer *

driver)

Returns the Input frequncy.

See Also

IfxStdIf_Timer_GetInputFrequency

Parameters

driver

ATOM Timer interface Handle

Returns

Frequency

Definition at line 94 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN Ifx_TimerValue IfxGtm_Atom_Timer_getPeriod

(

IfxGtm_Atom_Timer *

driver)

Returns the period of the timer.

See Also

IfxStdIf_Timer_GetPeriod

Parameters

driver

ATOM Timer interface Handle

Returns

Period

Definition at line 106 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_PwmHl_init(), and IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN float32 IfxGtm_Atom_Timer_getResolution

(

IfxGtm_Atom_Timer *

driver)

Returns the resolution.

See Also

IfxStdIf_Timer_GetResolution

Parameters

driver

ATOM Timer interface Handle

Returns

Resolution

Definition at line 118 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN Ifx_TimerValue IfxGtm_Atom_Timer_getTrigger

(

IfxGtm_Atom_Timer *

driver)

Returns the trigger point.

Parameters

driver

ATOM Timer interface Handle

Returns

Trigger point

Definition at line 124 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN void IfxGtm_Atom_Timer_run

(

IfxGtm_Atom_Timer *

driver)

Runs the timer.

See Also

IfxStdIf_Timer_Run

Parameters

driver

ATOM Timer interface Handle

Returns

None

Definition at line 283 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN boolean IfxGtm_Atom_Timer_setFrequency	(	IfxGtm_Atom_Timer *	driver,
		float32	frequency
	)

Sets the frequency.

See Also

IfxStdIf_Timer_SetFrequency

Parameters

driver	ATOM Timer interface Handle
frequency	Frequency

Returns

TRUE on success else FALSE

Definition at line 289 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_init(), and IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN boolean IfxGtm_Atom_Timer_setPeriod	(	IfxGtm_Atom_Timer *	driver,
		Ifx_TimerValue	period
	)

Sets the period for the timer.

See Also

IfxStdIf_Timer_SetPeriod

Parameters

driver	ATOM Timer interface Handle
period	Period value

Returns

TRUE on success else FALSE

Definition at line 297 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_setFrequency(), and IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN void IfxGtm_Atom_Timer_setSingleMode	(	IfxGtm_Atom_Timer *	driver,
		boolean	enabled
	)

Sets the single shot mode of the timer.

See Also

IfxStdIf_Timer_SetSingleMode

Parameters

driver	ATOM Timer interface Handle
enabled	If TRUE, sets the single shot mode

Returns

None

Definition at line 322 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN boolean IfxGtm_Atom_Timer_setTrigger	(	IfxGtm_Atom_Timer *	driver,
		Ifx_TimerValue	triggerPoint
	)

Sets the trigger.

See Also

IfxStdIf_Timer_SetTrigger

Parameters

driver	ATOM Timer interface Handle
triggerPoint	Trigger point value

Returns

TRUE on success else FALSE

Definition at line 328 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_init(), and IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN boolean IfxGtm_Atom_Timer_stdIfTimerInit	(	IfxStdIf_Timer *	stdif,
		IfxGtm_Atom_Timer *	driver
	)

Initializes the standard interface timer.

Parameters

stdif	Standard interface object, will be initialized by the function
driver	Interface driver to be used by the standard interface. must be initialised separately

Returns

TRUE on success else FALSE

Definition at line 347 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_PwmHl_stdIfPwmHlInit().

IFX_EXTERN void IfxGtm_Atom_Timer_stop

(

IfxGtm_Atom_Timer *

driver)

Stops the timer.

See Also

IfxStdIf_Timer_Stop

Parameters

driver

ATOM Timer interface Handle

Returns

None

Definition at line 374 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_stdIfTimerInit().

IFX_EXTERN void IfxGtm_Atom_Timer_updateInputFrequency

(

IfxGtm_Atom_Timer *

driver)

Updates the input frequency.

See Also

IfxStdIf_Timer_UpdateInputFrequency

Parameters

driver

ATOM Timer interface Handle

Returns

None

Definition at line 380 of file IfxGtm_Atom_Timer.c.

Referenced by IfxGtm_Atom_Timer_init(), and IfxGtm_Atom_Timer_stdIfTimerInit().