ATOM AGC Functions

Collaboration diagram for ATOM AGC Functions:

Functions
IFX_EXTERN uint32	IfxGtm_Atom_Agc_buildFeatureForChannel (IfxGtm_Atom_Ch channel, boolean enabled, uint8 bitfieldOffset)
	Builds the register value for the feature enable/disable for a single channel. More...
IFX_EXTERN void	IfxGtm_Atom_Agc_enableChannel (Ifx_GTM_ATOM_AGC *agc, IfxGtm_Atom_Ch channel, boolean enabled, boolean immediate)
	Enable/disable one channel (ENDIS) More...
IFX_EXTERN void	IfxGtm_Atom_Agc_enableChannelOutput (Ifx_GTM_ATOM_AGC *agc, IfxGtm_Atom_Ch channel, boolean enabled, boolean immediate)
	Enable/disable one channel output (OUTEN) More...
IFX_EXTERN void	IfxGtm_Atom_Agc_enableChannelUpdate (Ifx_GTM_ATOM_AGC *agc, IfxGtm_Atom_Ch channel, boolean enabled)
	Enable/disable one channel for update (UPEN) More...
IFX_EXTERN void	IfxGtm_Atom_Agc_enableChannels (Ifx_GTM_ATOM_AGC *agc, uint16 enableMask, uint16 disableMask, boolean immediate)
	Enable/disable one or more channels (ENDIS) More...
IFX_EXTERN void	IfxGtm_Atom_Agc_enableChannelsOutput (Ifx_GTM_ATOM_AGC *agc, uint16 enableMask, uint16 disableMask, boolean immediate)
	Enable/disable one or more channels output (OUTEN) More...
IFX_EXTERN void	IfxGtm_Atom_Agc_enableChannelsTrigger (Ifx_GTM_ATOM_AGC *agc, uint16 enableMask, uint16 disableMask)
	Enable/disable the TGC channels trigger. More...
IFX_EXTERN void	IfxGtm_Atom_Agc_enableChannelsUpdate (Ifx_GTM_ATOM_AGC *agc, uint16 enableMask, uint16 disableMask)
	Enable/disable one or more channels for update (UPEN) More...
IFX_EXTERN void	IfxGtm_Atom_Agc_enableTimeTrigger (Ifx_GTM_ATOM_AGC *agc, boolean enabled)
	Enable/disable the time base trigger. More...
IFX_EXTERN void	IfxGtm_Atom_Agc_resetChannels (Ifx_GTM_ATOM_AGC *agc, uint32 resetMask)
	Reset one or more channels. More...
IFX_EXTERN void	IfxGtm_Atom_Agc_setChannelForceUpdate (Ifx_GTM_ATOM_AGC *agc, IfxGtm_Atom_Ch channel, boolean enabled, boolean resetEnabled)
	Enable/disable one channel for update (FUPD) More...
IFX_EXTERN void	IfxGtm_Atom_Agc_setChannelsForceUpdate (Ifx_GTM_ATOM_AGC *agc, 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_Atom_Agc_setTimeTrigger (Ifx_GTM_ATOM_AGC *agc, IfxGtm_Tbu_Ts base, uint32 value)
	Sets the trigger time base and time base value. More...
IFX_EXTERN void	IfxGtm_Atom_Agc_trigger (Ifx_GTM_ATOM_AGC *agc)
	Raise the trigger for the channel enable/disable settings, output enable settings, and force update event (CTRL_TRIG) More...

Detailed Description

Function Documentation

IFX_EXTERN uint32 IfxGtm_Atom_Agc_buildFeatureForChannel	(	IfxGtm_Atom_Ch	channel,
		boolean	enabled,
		uint8	bitfieldOffset
	)

Builds the register value for the feature enable/disable for a single channel.

Parameters

channel	Channel index
enabled	Enable/ Disable choise of the feature
bitfieldOffset	Offset of the channel 0 bitfield in the register

Returns

The register value

Definition at line 89 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Agc_enableChannel(), IfxGtm_Atom_Agc_enableChannelOutput(), IfxGtm_Atom_Agc_enableChannelUpdate(), and IfxGtm_Atom_Agc_setChannelForceUpdate().

IFX_EXTERN void IfxGtm_Atom_Agc_enableChannel	(	Ifx_GTM_ATOM_AGC *	agc,
		IfxGtm_Atom_Ch	channel,
		boolean	enabled,
		boolean	immediate
	)

Enable/disable one channel (ENDIS)

Parameters

agc	Pointer to the AGC object
channel	Channel index
enabled	Enable/ Disable choise of the feature
immediate	If TRUE, the action is done immediately else, the action is done on AGC trigger (CTRL_TRIG)

Returns

None

Definition at line 109 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init().

IFX_EXTERN void IfxGtm_Atom_Agc_enableChannelOutput	(	Ifx_GTM_ATOM_AGC *	agc,
		IfxGtm_Atom_Ch	channel,
		boolean	enabled,
		boolean	immediate
	)

Enable/disable one channel output (OUTEN)

Parameters

agc	Pointer to the AGC object
channel	Channel index
enabled	Enable/ Disable choise of the feature
immediate	If TRUE, the action is done immediately else, the action is done on TGC trigger (CTRL_TRIG)

Returns

None

Definition at line 127 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init().

IFX_EXTERN void IfxGtm_Atom_Agc_enableChannels	(	Ifx_GTM_ATOM_AGC *	agc,
		uint16	enableMask,
		uint16	disableMask,
		boolean	immediate
	)

Enable/disable one or more channels (ENDIS)

Parameters

agc	Pointer to the AGC object
enableMask	Mask for the channel feature enable (bit 0: Channel 0, bit 1: channel 1, ...)
disableMask	Mask for the channel feature disable (bit 0: Channel 0, bit 1: channel 1, ...)
immediate	If TRUE, the action is done immediately else, the action is done on TGC trigger (CTRL_TRIG)

Returns

None

Definition at line 151 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_PwmHl_init(), IfxGtm_Atom_Timer_init(), IfxGtm_Atom_Timer_run(), and IfxGtm_Atom_Timer_stop().

IFX_EXTERN void IfxGtm_Atom_Agc_enableChannelsOutput	(	Ifx_GTM_ATOM_AGC *	agc,
		uint16	enableMask,
		uint16	disableMask,
		boolean	immediate
	)

Enable/disable one or more channels output (OUTEN)

Parameters

agc	Pointer to the TGC object
enableMask	Mask for the channel feature enable (bit 0: Channel 0, bit 1: channel 1, ...)
disableMask	Mask for the channel feature disable (bit 0: Channel 0, bit 1: channel 1, ...)
immediate	If TRUE, the action is done immediately else, the action is done on TGC trigger (CTRL_TRIG)

Returns

None

Definition at line 171 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_PwmHl_init(), and IfxGtm_Atom_Timer_init().

IFX_EXTERN void IfxGtm_Atom_Agc_enableChannelsTrigger	(	Ifx_GTM_ATOM_AGC *	agc,
		uint16	enableMask,
		uint16	disableMask
	)

Enable/disable the TGC channels trigger.

Parameters

agc	Pointer to the AGC object
enableMask	Mask for the channel feature enable (bit 0: Channel 0, bit 1: channel 1, ...)
disableMask	Mask for the channel feature disable (bit 0: Channel 0, bit 1: channel 1, ...)

Returns

None

Definition at line 189 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Agc_enableChannelsUpdate	(	Ifx_GTM_ATOM_AGC *	agc,
		uint16	enableMask,
		uint16	disableMask
	)

Enable/disable one or more channels for update (UPEN)

Parameters

agc	Pointer to the AGC object
enableMask	Mask for the channel feature enable (bit 0: Channel 0, bit 1: channel 1, ...)
disableMask	Mask for the channel feature disable (bit 0: Channel 0, bit 1: channel 1, ...)

Returns

None

Definition at line 195 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Timer_applyUpdate(), and IfxGtm_Atom_Timer_disableUpdate().

IFX_EXTERN void IfxGtm_Atom_Agc_enableChannelUpdate	(	Ifx_GTM_ATOM_AGC *	agc,
		IfxGtm_Atom_Ch	channel,
		boolean	enabled
	)

Enable/disable one channel for update (UPEN)

Parameters

agc	Pointer to the AGC object
channel	Channel index
enabled	Enable/ Disable choise of the feature

Returns

None

Definition at line 145 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init().

IFX_EXTERN void IfxGtm_Atom_Agc_enableTimeTrigger	(	Ifx_GTM_ATOM_AGC *	agc,
		boolean	enabled
	)

Enable/disable the time base trigger.

Parameters

agc	Pointer to the AGC object
enabled	If TRUE, the trigger is enabled else disabled

Returns

None

Definition at line 201 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Agc_resetChannels	(	Ifx_GTM_ATOM_AGC *	agc,
		uint32	resetMask
	)

Reset one or more channels.

Parameters

agc	Pointer to the AGC object
resetMask	Mask for the channel reset (bit 0: Channel 0, bit 1: channel 1, ...)

Returns

None

Definition at line 207 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Agc_setChannelForceUpdate	(	Ifx_GTM_ATOM_AGC *	agc,
		IfxGtm_Atom_Ch	channel,
		boolean	enabled,
		boolean	resetEnabled
	)

Enable/disable one channel for update (FUPD)

Parameters

agc	Pointer to the AGC object
channel	Channel index
enabled	Enable/ Disable choise of the feature
resetEnabled	Enable/ Disable reset choise of the feature

Returns

None

Definition at line 226 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_Pwm_init().

IFX_EXTERN void IfxGtm_Atom_Agc_setChannelsForceUpdate	(	Ifx_GTM_ATOM_AGC *	agc,
		uint16	enableMask,
		uint16	disableMask,
		uint16	resetEnableMask,
		uint16	resetDisableMask
	)

Enable/disable one or more channels for the force update feature (FUPD)

Parameters

agc	Pointer to the AGC object
enableMask	Mask for the channel feature enable (bit 0: Channel 0, bit 1: channel 1, ...)
disableMask	Mask for the channel feature disable (bit 0: Channel 0, bit 1: channel 1, ...)
resetEnableMask	Mask for the enabled channels counter reset on force update (bit 0: Channel 0, bit 1: channel 1, ...) Channel 0, bit 1: channel 1, ...)
resetDisableMask	Mask for the disabled channels with no counter reset on force update (bit 0: Channel 0, bit 1: channel 1, ...)

Returns

None

Definition at line 237 of file IfxGtm_Atom.c.

Referenced by IfxGtm_Atom_PwmHl_init(), and IfxGtm_Atom_Timer_init().

IFX_EXTERN void IfxGtm_Atom_Agc_setTimeTrigger	(	Ifx_GTM_ATOM_AGC *	agc,
		IfxGtm_Tbu_Ts	base,
		uint32	value
	)

Sets the trigger time base and time base value.

Parameters

agc	Pointer to the AGC object
base	Time base used for comparison
value	Compare value that raise the trigger

Returns

None

Definition at line 247 of file IfxGtm_Atom.c.

IFX_EXTERN void IfxGtm_Atom_Agc_trigger

(

Ifx_GTM_ATOM_AGC *

agc)

Raise the trigger for the channel enable/disable settings, output enable settings, and force update event (CTRL_TRIG)

Parameters

agc	Pointer to the AGC object

Returns

None

Definition at line 258 of file IfxGtm_Atom.c.

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