Module Functions

Collaboration diagram for Module Functions:

Functions
IFX_INLINE void	IfxVadc_disableModule (Ifx_VADC *vadc)
	Disable VADC Module. More...
IFX_INLINE void	IfxVadc_enableModule (Ifx_VADC *vadc)
	Enable VADC kernel. More...
IFX_INLINE uint8	IfxVadc_getAdcCalibrationActiveState (Ifx_VADC *vadc, uint8 adcCalGroupNum)
	gets ADC Calibration Flag CAL status. More...
IFX_INLINE Ifx_VADC_GLOBCFG	IfxVadc_getGlobalConfigValue (Ifx_VADC *vadc)
	Gets the global control configuration value. More...
IFX_INLINE boolean	IfxVadc_getStartupCalibration (Ifx_VADC *vadc)
	get SUCAL bit field status More...
IFX_INLINE void	IfxVadc_initiateStartupCalibration (Ifx_VADC *vadc)
	initiates the calibration pulse phase. More...
IFX_INLINE void	IfxVadc_setGlobalResolution (Ifx_VADC *vadc, uint8 inputClassNum, IfxVadc_ChannelResolution resolution)
	Sets the channel conversion mode. More...
IFX_INLINE void	IfxVadc_setGlobalSampleTime (Ifx_VADC *vadc, uint8 inputClassNum, float32 analogFrequency, float32 sampleTime)
	Sets the sample time of ADC global class. More...
IFX_INLINE void	IfxVadc_setSleepMode (Ifx_VADC *vadc, IfxVadc_SleepMode mode)
	Sets the sensitivity of the module to sleep signal. More...
IFX_EXTERN void	IfxVadc_disableAccess (Ifx_VADC *vadc, IfxVadc_Protection protectionSet)
	Disable write access to the VADC config/control registers. More...
IFX_EXTERN void	IfxVadc_disablePostCalibration (Ifx_VADC *vadc, IfxVadc_GroupId group, boolean disable)
	Disables the post calibration. More...
IFX_EXTERN void	IfxVadc_enableAccess (Ifx_VADC *vadc, IfxVadc_Protection protectionSet)
	Enable write access to the VADC config/control registers. More...
IFX_EXTERN void	IfxVadc_enableGroupSync (Ifx_VADC *vadc, uint32 ccu6Num)
	Enables the CCU6 based ADC group synchronisation as workaround for Erratum ADC_TC.068. More...
IFX_EXTERN float32	IfxVadc_getAdcModuleFrequency (void)
	Module Frequency in Hz. More...
IFX_EXTERN volatile Ifx_SRC_SRCR *	IfxVadc_getSrcAddress (IfxVadc_GroupId group, IfxVadc_SrcNr index)
	Gives the SRC source address. More...
IFX_EXTERN void	IfxVadc_initialiseAdcArbiterClock (Ifx_VADC *vadc, uint32 arbiterClockDivider)
	Initialises ADC arbiter clock. More...
IFX_EXTERN void	IfxVadc_initialiseAdcConverterClock (Ifx_VADC *vadc, uint32 converterClockDivider)
	Initialises the ADC Converter clock. More...
IFX_EXTERN uint32	IfxVadc_initializeFAdcD (Ifx_VADC *vadc, uint32 fAdcD)
	Configure the FadcD vadc digital clock. More...
IFX_EXTERN uint32	IfxVadc_initializeFAdcI (Ifx_VADC *vadc, uint32 fAdcI)
	Configure the ADC analog clock. More...
IFX_EXTERN boolean	IfxVadc_isPostCalibration (Ifx_VADC *vadc, IfxVadc_GroupId group)
	Return the post calibration status. More...
IFX_EXTERN void	IfxVadc_resetKernel (Ifx_VADC *vadc)
	Resets the kernel. More...
IFX_EXTERN void	IfxVadc_selectPowerSupplyVoltage (Ifx_VADC *vadc, IfxVadc_LowSupplyVoltageSelect supplyVoltage)
	Select Low Power Supply Voltage. More...
IFX_EXTERN void	IfxVadc_startupCalibration (Ifx_VADC *vadc)
	Starts ADC calibration and wait for the end of the calibration process. More...

Detailed Description

Function Documentation

IFX_EXTERN void IfxVadc_disableAccess	(	Ifx_VADC *	vadc,
		IfxVadc_Protection	protectionSet
	)

Disable write access to the VADC config/control registers.

Parameters

vadc	pointer to the base of VADC registers.
protectionSet	Index of the bit in the ACCPROTx {x=0/1} for which write access is to be disabled.

Returns

None

Definition at line 54 of file IfxVadc.c.

Referenced by IfxVadc_Adc_deInitGroup(), IfxVadc_Adc_initChannel(), IfxVadc_Adc_initGroup(), IfxVadc_Adc_initModule(), IfxVadc_configExternalMultiplexerMode(), IfxVadc_disablePostCalibration(), IfxVadc_enableGroupSync(), IfxVadc_initialiseAdcArbiterClock(), IfxVadc_initialiseAdcConverterClock(), IfxVadc_resetKernel(), IfxVadc_selectPowerSupplyVoltage(), and IfxVadc_startupCalibration().

IFX_INLINE void IfxVadc_disableModule

(

Ifx_VADC *

vadc)

Disable VADC Module.

Parameters

vadc	Pointer to VADC Module

Returns

None

Definition at line 1733 of file IfxVadc.h.

Referenced by IfxVadc_Adc_disableModule().

IFX_EXTERN void IfxVadc_disablePostCalibration	(	Ifx_VADC *	vadc,
		IfxVadc_GroupId	group,
		boolean	disable
	)

Disables the post calibration.

Parameters

vadc	pointer to the base of VADC registers.
group	Index of the group.
disable	disable or not.

Returns

None

Definition at line 72 of file IfxVadc.c.

Referenced by IfxVadc_Adc_initGroup().

IFX_EXTERN void IfxVadc_enableAccess	(	Ifx_VADC *	vadc,
		IfxVadc_Protection	protectionSet
	)

Enable write access to the VADC config/control registers.

Parameters

vadc	pointer to the base of VADC registers.
protectionSet	Index of the bit in the ACCPROTx {x=0/1} for which write access is to be enabled.

Returns

None

Definition at line 94 of file IfxVadc.c.

Referenced by IfxVadc_Adc_deInitGroup(), IfxVadc_Adc_initChannel(), IfxVadc_Adc_initGroup(), IfxVadc_Adc_initModule(), IfxVadc_configExternalMultiplexerMode(), IfxVadc_disablePostCalibration(), IfxVadc_enableGroupSync(), IfxVadc_initialiseAdcArbiterClock(), IfxVadc_initialiseAdcConverterClock(), IfxVadc_resetKernel(), IfxVadc_selectPowerSupplyVoltage(), and IfxVadc_startupCalibration().

IFX_EXTERN void IfxVadc_enableGroupSync	(	Ifx_VADC *	vadc,
		uint32	ccu6Num
	)

Enables the CCU6 based ADC group synchronisation as workaround for Erratum ADC_TC.068.

Parameters

vadc	pointer to the base of VADC registers.
ccu6Num	selects CCU60 or CCU61

Returns

None

Definition at line 112 of file IfxVadc.c.

IFX_INLINE void IfxVadc_enableModule

(

Ifx_VADC *

vadc)

Enable VADC kernel.

Parameters

vadc	pointer to the base of VADC registers.

Returns

None

Definition at line 1766 of file IfxVadc.h.

Referenced by IfxVadc_Adc_initModule().

IFX_INLINE uint8 IfxVadc_getAdcCalibrationActiveState	(	Ifx_VADC *	vadc,
		uint8	adcCalGroupNum
	)

gets ADC Calibration Flag CAL status.

Parameters

vadc	pointer to VADC group registers.
adcCalGroupNum	ADC CAL group number.

Returns

CAL group status.

Definition at line 1794 of file IfxVadc.h.

Referenced by IfxVadc_startupCalibration().

IFX_EXTERN float32 IfxVadc_getAdcModuleFrequency

(

void

)

Module Frequency in Hz.

Returns

Module Frequency in Hz.

Definition at line 175 of file IfxVadc.c.

Referenced by IfxVadc_Adc_getChannelConversionTime(), and IfxVadc_Adc_getModuleConfig().

IFX_INLINE Ifx_VADC_GLOBCFG IfxVadc_getGlobalConfigValue

(

Ifx_VADC *

vadc)

Gets the global control configuration value.

Parameters

vadc	pointer to the base of VADC registers.

Returns

global control configuration value.

Definition at line 1914 of file IfxVadc.h.

Referenced by IfxVadc_Adc_getGroupConfig().

IFX_EXTERN volatile Ifx_SRC_SRCR* IfxVadc_getSrcAddress	(	IfxVadc_GroupId	group,
		IfxVadc_SrcNr	index
	)

Gives the SRC source address.

Parameters

group	Index of the group
index	SRC number

Returns

SRC source address

Definition at line 345 of file IfxVadc.c.

Referenced by IfxVadc_Adc_getChannelConfig(), and IfxVadc_Adc_initChannel().

IFX_INLINE boolean IfxVadc_getStartupCalibration

(

Ifx_VADC *

vadc)

get SUCAL bit field status

Parameters

vadc	Pointer to VADC Module

Returns

Indicate the start-up calibration phase

Definition at line 2071 of file IfxVadc.h.

Referenced by IfxVadc_Adc_getModuleConfig().

IFX_EXTERN void IfxVadc_initialiseAdcArbiterClock	(	Ifx_VADC *	vadc,
		uint32	arbiterClockDivider
	)

Initialises ADC arbiter clock.

Parameters

vadc	pointer to the base of VADC registers
arbiterClockDivider	ADC arbiter clock divider.

Returns

None

Definition at line 373 of file IfxVadc.c.

Referenced by IfxVadc_initializeFAdcD().

IFX_EXTERN void IfxVadc_initialiseAdcConverterClock	(	Ifx_VADC *	vadc,
		uint32	converterClockDivider
	)

Initialises the ADC Converter clock.

Parameters

vadc	pointer to the base of VADC registers
converterClockDivider	ADC converter clock divider.

Returns

None

Definition at line 385 of file IfxVadc.c.

Referenced by IfxVadc_initializeFAdcI().

IFX_EXTERN uint32 IfxVadc_initializeFAdcD	(	Ifx_VADC *	vadc,
		uint32	fAdcD
	)

Configure the FadcD vadc digital clock.

Parameters

vadc	pointer to the base of VADC registers.
fAdcD	ADC digital clock frequency in Hz.

Returns

calculated ADC digital clock frequency in Hz.

Definition at line 397 of file IfxVadc.c.

Referenced by IfxVadc_Adc_initModule().

IFX_EXTERN uint32 IfxVadc_initializeFAdcI	(	Ifx_VADC *	vadc,
		uint32	fAdcI
	)

Configure the ADC analog clock.

Parameters

vadc	pointer to the base of VADC registers.
fAdcI	ADC analog clock clock frequency in Hz. Range = [5000000, 10000000].

Returns

ADC analog clock frequency in Hz.

Definition at line 413 of file IfxVadc.c.

Referenced by IfxVadc_Adc_initModule().

IFX_INLINE void IfxVadc_initiateStartupCalibration

(

Ifx_VADC *

vadc)

initiates the calibration pulse phase.

Parameters

vadc	pointer to the base of VADC registers

Returns

None

Definition at line 2091 of file IfxVadc.h.

Referenced by IfxVadc_startupCalibration().

IFX_EXTERN boolean IfxVadc_isPostCalibration	(	Ifx_VADC *	vadc,
		IfxVadc_GroupId	group
	)

Return the post calibration status.

Parameters

vadc	Pointer to VADC module
group	specifies Group ID

Returns

TRUE if the post calibration is enabled for the group else false

Definition at line 450 of file IfxVadc.c.

Referenced by IfxVadc_getChannelConversionTime().

IFX_EXTERN void IfxVadc_resetKernel

(

Ifx_VADC *

vadc)

Resets the kernel.

Parameters

vadc	pointer to the base of VADC registers.

Returns

None

Definition at line 480 of file IfxVadc.c.

Referenced by IfxVadc_Adc_deInitModule().

IFX_EXTERN void IfxVadc_selectPowerSupplyVoltage	(	Ifx_VADC *	vadc,
		IfxVadc_LowSupplyVoltageSelect	supplyVoltage
	)

Select Low Power Supply Voltage.

Parameters

vadc	Pointer to Module space
supplyVoltage	Select Supply Voltage

Returns

None

Definition at line 501 of file IfxVadc.c.

Referenced by IfxVadc_Adc_initModule().

IFX_INLINE void IfxVadc_setGlobalResolution	(	Ifx_VADC *	vadc,
		uint8	inputClassNum,
		IfxVadc_ChannelResolution	resolution
	)

Sets the channel conversion mode.

Parameters

vadc	pointer to VADC module registers.
inputClassNum	global input class number.
resolution	ADC channel resolution.

Returns

None

Definition at line 2260 of file IfxVadc.h.

Referenced by IfxVadc_Adc_initModule().

IFX_INLINE void IfxVadc_setGlobalSampleTime	(	Ifx_VADC *	vadc,
		uint8	inputClassNum,
		float32	analogFrequency,
		float32	sampleTime
	)

Sets the sample time of ADC global class.

Parameters

vadc	pointer to VADC module registers.
inputClassNum	global input class number.
analogFrequency	ADC analog frequency in Hz.
sampleTime	the requested sample time for input class in sec.

Returns

None

Definition at line 2266 of file IfxVadc.h.

Referenced by IfxVadc_Adc_initModule().

IFX_INLINE void IfxVadc_setSleepMode	(	Ifx_VADC *	vadc,
		IfxVadc_SleepMode	mode
	)

Sets the sensitivity of the module to sleep signal.

Parameters

vadc	pointer to VADC registers
mode	mode selection (enable/disable)

Returns

None

Definition at line 2373 of file IfxVadc.h.

IFX_EXTERN void IfxVadc_startupCalibration

(

Ifx_VADC *

vadc)

Starts ADC calibration and wait for the end of the calibration process.

Parameters

vadc	pointer to the base of VADC registers.

Returns

None

Definition at line 545 of file IfxVadc.c.

Referenced by IfxVadc_Adc_initModule().