ATOM Channel Functions

Collaboration diagram for ATOM Channel Functions:

Functions
IFX_INLINE Ifx_GTM_ATOM_CH *	IfxGtm_Atom_Ch_getChannelPointer (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the base addredd of selected Atom channel. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_clearOneNotification (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Clears the channel One notification. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_clearZeroNotification (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Clears the channel Zero notification. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_configurePwmMode (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, IfxGtm_Cmu_Clk clock, Ifx_ActiveState activeState, IfxGtm_Atom_Ch_ResetEvent resetEvent, IfxGtm_Atom_Ch_OutputTrigger trigger)
IFX_EXTERN float32	IfxGtm_Atom_Ch_getClockFrequency (Ifx_GTM *gtm, Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the ATOM channel input clock frequency in Hz. More...
IFX_EXTERN IfxGtm_Cmu_Clk	IfxGtm_Atom_Ch_getClockSource (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the channel clock source. More...
IFX_EXTERN uint32	IfxGtm_Atom_Ch_getCompareOne (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the compare one value. More...
IFX_EXTERN volatile uint32 *	IfxGtm_Atom_Ch_getCompareOnePointer (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the compare one pointer. More...
IFX_EXTERN uint32	IfxGtm_Atom_Ch_getCompareZero (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the compare zero value. More...
IFX_EXTERN volatile uint32 *	IfxGtm_Atom_Ch_getCompareZeroPointer (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the compare zero pointer. More...
IFX_EXTERN boolean	IfxGtm_Atom_Ch_getOutputLevel (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Gets the ATOM output level. More...
IFX_EXTERN volatile Ifx_SRC_SRCR *	IfxGtm_Atom_Ch_getSrcPointer (Ifx_GTM *gtm, IfxGtm_Atom atom, IfxGtm_Atom_Ch channel)
	Returns a pointer to the ATOM channel SRC. More...
IFX_EXTERN volatile uint32 *	IfxGtm_Atom_Ch_getTimerPointer (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the Timer pointer. More...
IFX_EXTERN boolean	IfxGtm_Atom_Ch_isOneNotification (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the status of channel One notification. More...
IFX_EXTERN boolean	IfxGtm_Atom_Ch_isZeroNotification (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Returns the status of channel Zero notification. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_raiseInterruptOne (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Raises the interrupt for Compare 1. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_raiseInterruptZero (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel)
	Raises the interrupt for Compare 0. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setClockSource (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, IfxGtm_Cmu_Clk clock)
	Sets the channel clock source. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setCompare (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, uint32 compareZero, uint32 compareOne)
	Sets the compare 0 and 1 values. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setCompareOne (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, uint32 compareOne)
	Sets the compare 1 value. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setCompareOneShadow (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, uint32 shadowOne)
	Sets the compare 1 shadow value. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setCompareShadow (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, uint32 shadowZero, uint32 shadowOne)
	Sets the compare 0 and 1 shadow values. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setCompareZero (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, uint32 compareZero)
	Sets the compare 0 value. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setCompareZeroShadow (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, uint32 shadowZero)
	Sets the compare 0 shadow value. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setCounterValue (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, uint32 value)
	Sets the counter value. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setMode (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, IfxGtm_Atom_Mode mode)
	set the Atom operating mode More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setNotification (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, IfxGtm_IrqMode mode, boolean interruptOnCompareZero, boolean interruptOnCompareOne)
	Sets the channel notification. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setOneShotMode (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, boolean enabled)
	Enable/disable the one shot mode. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setResetSource (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, IfxGtm_Atom_Ch_ResetEvent event)
	Sets the channel clock source either from local or from previous channel. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setSignalLevel (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, Ifx_ActiveState activeState)
	Sets the signal level. More...
IFX_EXTERN void	IfxGtm_Atom_Ch_setTriggerOutput (Ifx_GTM_ATOM *atom, IfxGtm_Atom_Ch channel, IfxGtm_Atom_Ch_OutputTrigger trigger)
	Sets the channel trigger output. More...

Detailed Description

Function Documentation

IFX_EXTERN void IfxGtm_Atom_Ch_clearOneNotification	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Clears the channel One notification.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

None

Definition at line 264 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_acknowledgeTriggerIrq().

IFX_EXTERN void IfxGtm_Atom_Ch_clearZeroNotification	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Clears the channel Zero notification.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

None

Definition at line 271 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_acknowledgeTimerIrq().

IFX_EXTERN void IfxGtm_Atom_Ch_configurePwmMode	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		IfxGtm_Cmu_Clk	clock,
		Ifx_ActiveState	activeState,
		IfxGtm_Atom_Ch_ResetEvent	resetEvent,
		IfxGtm_Atom_Ch_OutputTrigger	trigger
	)

Parameters

atom	Pointer to the ATOM object
channel	Channel index
clock	Clock source
activeState	Active State
resetEvent	Channel reset event
trigger	Channel trigger output mode

Returns

None

Definition at line 278 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_PwmHl_init(), and IfxGtm_Atom_Timer_init().

IFX_INLINE Ifx_GTM_ATOM_CH * IfxGtm_Atom_Ch_getChannelPointer	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the base addredd of selected Atom channel.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

Pointer to channel base address

Definition at line 465 of file IfxGtm_Atom.h.

Referenced by IfxGtm_Atom_Ch_clearOneNotification(), IfxGtm_Atom_Ch_clearZeroNotification(), IfxGtm_Atom_Ch_configurePwmMode(), IfxGtm_Atom_Ch_getClockSource(), IfxGtm_Atom_Ch_getCompareOne(), IfxGtm_Atom_Ch_getCompareOnePointer(), IfxGtm_Atom_Ch_getCompareZero(), IfxGtm_Atom_Ch_getCompareZeroPointer(), IfxGtm_Atom_Ch_getOutputLevel(), IfxGtm_Atom_Ch_isOneNotification(), IfxGtm_Atom_Ch_isZeroNotification(), IfxGtm_Atom_Ch_raiseInterruptOne(), IfxGtm_Atom_Ch_raiseInterruptZero(), IfxGtm_Atom_Ch_setClockSource(), IfxGtm_Atom_Ch_setCompare(), IfxGtm_Atom_Ch_setCompareOne(), IfxGtm_Atom_Ch_setCompareOneShadow(), IfxGtm_Atom_Ch_setCompareShadow(), IfxGtm_Atom_Ch_setCompareZero(), IfxGtm_Atom_Ch_setCompareZeroShadow(), IfxGtm_Atom_Ch_setCounterValue(), IfxGtm_Atom_Ch_setNotification(), IfxGtm_Atom_Ch_setOneShotMode(), IfxGtm_Atom_Ch_setResetSource(), IfxGtm_Atom_Ch_setSignalLevel(), and IfxGtm_Atom_Ch_setTriggerOutput().

IFX_EXTERN float32 IfxGtm_Atom_Ch_getClockFrequency	(	Ifx_GTM *	gtm,
		Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the ATOM channel input clock frequency in Hz.

Parameters

gtm	Pointer to GTM module
atom	Pointer to the ATOM object
channel	Channel index

Returns

ATOM channel input clock frequency in Hz

Definition at line 293 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_updateInputFrequency().

IFX_EXTERN IfxGtm_Cmu_Clk IfxGtm_Atom_Ch_getClockSource	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the channel clock source.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

The clock source

Definition at line 303 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Ch_getClockFrequency(), and IfxGtm_Atom_PwmHl_init().

IFX_EXTERN uint32 IfxGtm_Atom_Ch_getCompareOne	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the compare one value.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

compare one value

Definition at line 313 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_getTrigger().

IFX_EXTERN volatile uint32* IfxGtm_Atom_Ch_getCompareOnePointer	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the compare one pointer.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

compare one pointer

Definition at line 321 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_getTriggerPointer().

IFX_EXTERN uint32 IfxGtm_Atom_Ch_getCompareZero	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the compare zero value.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

compare zero value

Definition at line 329 of file IfxGtm_Atom.c.

IFX_EXTERN volatile uint32* IfxGtm_Atom_Ch_getCompareZeroPointer	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the compare zero pointer.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

compare zero pointer

Definition at line 337 of file IfxGtm_Atom.c.

IFX_EXTERN boolean IfxGtm_Atom_Ch_getOutputLevel	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Gets the ATOM output level.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

TRUE the output is high, FALSE the output is low

Definition at line 345 of file IfxGtm_Atom.c.

IFX_EXTERN volatile Ifx_SRC_SRCR* IfxGtm_Atom_Ch_getSrcPointer	(	Ifx_GTM *	gtm,
		IfxGtm_Atom	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns a pointer to the ATOM channel SRC.

Parameters

gtm	Pointer to GTM module
atom	Specifies the atom object
channel	Channel index

Returns

Pointer to the TOM channel SRC

Definition at line 356 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init(), and IfxGtm_Atom_Timer_init().

IFX_EXTERN volatile uint32* IfxGtm_Atom_Ch_getTimerPointer	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the Timer pointer.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

Timer pointer

Definition at line 362 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_getPointer().

IFX_EXTERN boolean IfxGtm_Atom_Ch_isOneNotification	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the status of channel One notification.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

Status of channel One notification

Definition at line 368 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_acknowledgeTriggerIrq().

IFX_EXTERN boolean IfxGtm_Atom_Ch_isZeroNotification	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Returns the status of channel Zero notification.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

Status of channel Zero notification

Definition at line 379 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_acknowledgeTimerIrq().

IFX_EXTERN void IfxGtm_Atom_Ch_raiseInterruptOne	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Raises the interrupt for Compare 1.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

None

Definition at line 390 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Ch_raiseInterruptZero	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel
	)

Raises the interrupt for Compare 0.

Parameters

atom	Pointer to the ATOM object
channel	Channel index

Returns

None

Definition at line 398 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Ch_setClockSource	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		IfxGtm_Cmu_Clk	clock
	)

Sets the channel clock source.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
clock	Channel clock source

Returns

None

Definition at line 406 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Ch_setCompare	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		uint32	compareZero,
		uint32	compareOne
	)

Sets the compare 0 and 1 values.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
compareZero	Compare zero value
compareOne	Compare one value

Returns

None

Definition at line 414 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Ch_setCompareOne	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		uint32	compareOne
	)

Sets the compare 1 value.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
compareOne	Compare one value

Returns

None

Definition at line 423 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init().

IFX_EXTERN void IfxGtm_Atom_Ch_setCompareOneShadow	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		uint32	shadowOne
	)

Sets the compare 1 shadow value.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
shadowOne	Compare one shadow value

Returns

None

Definition at line 431 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init(), and IfxGtm_Atom_Timer_setTrigger().

IFX_EXTERN void IfxGtm_Atom_Ch_setCompareShadow	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		uint32	shadowZero,
		uint32	shadowOne
	)

Sets the compare 0 and 1 shadow values.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
shadowZero	Compare zero shadow value
shadowOne	Compare one shadow value

Returns

None

Definition at line 439 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Ch_setCompareZero	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		uint32	compareZero
	)

Sets the compare 0 value.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
compareZero	Compare zero value

Returns

None

Definition at line 448 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init().

IFX_EXTERN void IfxGtm_Atom_Ch_setCompareZeroShadow	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		uint32	shadowZero
	)

Sets the compare 0 shadow value.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
shadowZero	Compare zero shadow value

Returns

None

Definition at line 456 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init(), and IfxGtm_Atom_Timer_setPeriod().

IFX_EXTERN void IfxGtm_Atom_Ch_setCounterValue	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		uint32	value
	)

Sets the counter value.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
value	Counter value

Returns

None

Definition at line 464 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_init().

IFX_EXTERN void IfxGtm_Atom_Ch_setMode	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		IfxGtm_Atom_Mode	mode
	)

set the Atom operating mode

Parameters

atom	Pointer to the ATOM object
channel	Channel index
mode	Atom operating mode

Returns

None

Definition at line 472 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init().

IFX_EXTERN void IfxGtm_Atom_Ch_setNotification	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		IfxGtm_IrqMode	mode,
		boolean	interruptOnCompareZero,
		boolean	interruptOnCompareOne
	)

Sets the channel notification.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
mode	Interrupt mode
interruptOnCompareZero	If TRUE, an interrupt is generated on compare 0, else no interrupt is generated
interruptOnCompareOne	If TRUE, an interrupt is generated on compare 1, else no interrupt is generated

Returns

None

Definition at line 480 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init(), and IfxGtm_Atom_Timer_init().

IFX_EXTERN void IfxGtm_Atom_Ch_setOneShotMode	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		boolean	enabled
	)

Enable/disable the one shot mode.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
enabled	If TRUE, the feature is enabled, else disabled

Returns

None

Definition at line 499 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_setSingleMode().

IFX_EXTERN void IfxGtm_Atom_Ch_setResetSource	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		IfxGtm_Atom_Ch_ResetEvent	event
	)

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

Parameters

atom	Pointer to the ATOM object
channel	Channel index
event	Channel reset event

Returns

None

Definition at line 507 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Ch_setSignalLevel	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		Ifx_ActiveState	activeState
	)

Sets the signal level.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
activeState	Signal 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 515 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init(), IfxGtm_Atom_PwmHl_setMode(), and IfxGtm_Atom_Timer_init().

IFX_EXTERN void IfxGtm_Atom_Ch_setTriggerOutput	(	Ifx_GTM_ATOM *	atom,
		IfxGtm_Atom_Ch	channel,
		IfxGtm_Atom_Ch_OutputTrigger	trigger
	)

Sets the channel trigger output.

Parameters

atom	Pointer to the ATOM object
channel	Channel index
trigger	Channel trigger output mode

Returns

None

Definition at line 523 of file IfxGtm_Atom.c.