Detailed Description

Voltage Comparator (VCMP) Peripheral API.

This module contains functions to control the VCMP peripheral of Silicon Labs 32-bit MCUs and SoCs. The VCMP monitors the input voltage supply and generates interrupts on events using as little as 100 nA.

Data Structures
struct	VCMP_Init_TypeDef

Macros
#define	VCMP_INIT_DEFAULT

Enumerations
enum	VCMP_Hysteresis_TypeDef { vcmpHystNone, vcmpHyst20mV }

enum	VCMP_WarmTime_TypeDef { vcmpWarmTime4Cycles = _VCMP_CTRL_WARMTIME_4CYCLES, vcmpWarmTime8Cycles = _VCMP_CTRL_WARMTIME_8CYCLES, vcmpWarmTime16Cycles = _VCMP_CTRL_WARMTIME_16CYCLES, vcmpWarmTime32Cycles = _VCMP_CTRL_WARMTIME_32CYCLES, vcmpWarmTime64Cycles = _VCMP_CTRL_WARMTIME_64CYCLES, vcmpWarmTime128Cycles = _VCMP_CTRL_WARMTIME_128CYCLES, vcmpWarmTime256Cycles = _VCMP_CTRL_WARMTIME_256CYCLES, vcmpWarmTime512Cycles = _VCMP_CTRL_WARMTIME_512CYCLES }

Functions
__STATIC_INLINE void	VCMP_Disable (void)
	Disable Voltage Comparator.

__STATIC_INLINE void	VCMP_Enable (void)
	Enable Voltage Comparator.

void	VCMP_Init (const VCMP_Init_TypeDef *vcmpInit)
	Configure and enable Voltage Comparator. More...

__STATIC_INLINE void	VCMP_IntClear (uint32_t flags)
	Clear one or more pending VCMP interrupts. More...

__STATIC_INLINE void	VCMP_IntDisable (uint32_t flags)
	Disable one or more VCMP interrupts. More...

__STATIC_INLINE void	VCMP_IntEnable (uint32_t flags)
	Enable one or more VCMP interrupts. More...

__STATIC_INLINE uint32_t	VCMP_IntGet (void)
	Get pending VCMP interrupt flags. More...

__STATIC_INLINE uint32_t	VCMP_IntGetEnabled (void)
	Get enabled and pending VCMP interrupt flags. More...

__STATIC_INLINE void	VCMP_IntSet (uint32_t flags)
	Set one or more pending VCMP interrupts from SW. More...

void	VCMP_LowPowerRefSet (bool enable)
	Enable or disable Low Power Reference setting. More...

__STATIC_INLINE bool	VCMP_Ready (void)
	VCMP output is ready.

void	VCMP_TriggerSet (int level)
	Configure trigger level of voltage comparator. More...

__STATIC_INLINE bool	VCMP_VDDHigher (void)
	Returns true, if Voltage Comparator indicated VDD > trigger level, else false.

__STATIC_INLINE bool	VCMP_VDDLower (void)
	Returns true, if Voltage Comparator indicated VDD < trigger level, else false.

__STATIC_INLINE uint32_t	VCMP_VoltageToLevel (float v)
	Calculate voltage to trigger level. More...

Macro Definition Documentation

#define VCMP_INIT_DEFAULT

Value:

{                                                                        \
  true,                                          \
  0x7,                  \
  false,                            \
  false,                             \
  vcmpWarmTime4Cycles,                 \
  vcmpHystNone,                                      \
  0,                              \
  true,                             \
  39,                                  \
  true,                                          \
}

Default VCMP initialization structure

Definition at line 123 of file em_vcmp.h.

Referenced by VDDCHECK_LowVoltage().

Enumeration Type Documentation

enum VCMP_Hysteresis_TypeDef

Hyseresis configuration

Enumerator
vcmpHystNone	Normal operation, no hysteresis
vcmpHyst20mV	Digital output will not toggle until positive edge is at least 20mV above or below negative input voltage

Definition at line 82 of file em_vcmp.h.

enum VCMP_WarmTime_TypeDef

Warm-up Time in High Frequency Peripheral Clock cycles

Enumerator
vcmpWarmTime4Cycles	4 cycles
vcmpWarmTime8Cycles	8 cycles
vcmpWarmTime16Cycles	16 cycles
vcmpWarmTime32Cycles	32 cycles
vcmpWarmTime64Cycles	64 cycles
vcmpWarmTime128Cycles	128 cycles
vcmpWarmTime256Cycles	256 cycles
vcmpWarmTime512Cycles	512 cycles

Definition at line 61 of file em_vcmp.h.

Function Documentation

void VCMP_Init ( const VCMP_Init_TypeDef * vcmpInit )

Configure and enable Voltage Comparator.

Parameters

[in] vcmpInit VCMP Initialization structure

Definition at line 60 of file em_vcmp.c.

References _VCMP_CTRL_BIASPROG_MASK, _VCMP_CTRL_BIASPROG_SHIFT, _VCMP_CTRL_INACTVAL_SHIFT, _VCMP_CTRL_WARMTIME_MASK, _VCMP_CTRL_WARMTIME_SHIFT, VCMP_Init_TypeDef::biasProg, VCMP_Init_TypeDef::enable, VCMP_Init_TypeDef::halfBias, VCMP_Init_TypeDef::hyst, VCMP_Init_TypeDef::inactive, VCMP_Init_TypeDef::irqFalling, VCMP_Init_TypeDef::irqRising, VCMP_Init_TypeDef::lowPowerRef, VCMP_Init_TypeDef::triggerLevel, VCMP, VCMP_CTRL_EN, VCMP_CTRL_HALFBIAS, VCMP_CTRL_HYSTEN, VCMP_CTRL_IFALL, VCMP_CTRL_IRISE, VCMP_IF_EDGE, VCMP_IntClear(), VCMP_LowPowerRefSet(), VCMP_Ready(), VCMP_TriggerSet(), vcmpHyst20mV, vcmpHystNone, and VCMP_Init_TypeDef::warmup.

Referenced by VDDCHECK_LowVoltage().

__STATIC_INLINE void VCMP_IntClear ( uint32_t flags )

Clear one or more pending VCMP interrupts.

Parameters

[in] flags VCMP interrupt sources to clear. Use a set of interrupt flags OR-ed together to clear multiple interrupt sources for the VCMP module (VCMP_IFS_nnn).

Definition at line 243 of file em_vcmp.h.

References VCMP.

Referenced by VCMP_Init().

__STATIC_INLINE void VCMP_IntDisable ( uint32_t flags )

Disable one or more VCMP interrupts.

Parameters

[in] flags VCMP interrupt sources to enable. Use a set of interrupt flags OR-ed together to set multiple interrupt sources for the VCMP module (VCMP_IFS_nnn).

Definition at line 273 of file em_vcmp.h.

References VCMP.

__STATIC_INLINE void VCMP_IntEnable ( uint32_t flags )

Enable one or more VCMP interrupts.

Parameters

[in] flags VCMP interrupt sources to enable. Use a set of interrupt flags OR-ed together to set multiple interrupt sources for the VCMP module (VCMP_IFS_nnn).

Definition at line 288 of file em_vcmp.h.

References VCMP.

__STATIC_INLINE uint32_t VCMP_IntGet ( void )

Get pending VCMP interrupt flags.

Note: The event bits are not cleared by the use of this function

Returns: Pending VCMP interrupt sources. Returns a set of interrupt flags OR-ed together for multiple interrupt sources in the VCMP module (VCMP_IFS_nnn).

Definition at line 305 of file em_vcmp.h.

References VCMP.

__STATIC_INLINE uint32_t VCMP_IntGetEnabled ( void )

Get enabled and pending VCMP interrupt flags.

Useful for handling more interrupt sources in the same interrupt handler.

Note: The event bits are not cleared by the use of this function.

Returns

Pending and enabled VCMP interrupt sources. The return value is the bitwise AND combination of

the OR combination of enabled interrupt sources in VCMP_IEN_nnn register (VCMP_IEN_nnn) and
the OR combination of valid interrupt flags of the VCMP module (VCMP_IF_nnn).

Definition at line 329 of file em_vcmp.h.

References VCMP.

__STATIC_INLINE void VCMP_IntSet ( uint32_t flags )

Set one or more pending VCMP interrupts from SW.

Parameters

[in] flags VCMP interrupt sources to set to pending. Use a set of interrupt flags OR-ed together to set multiple interrupt sources for the VCMP module (VCMP_IFS_nnn).

Definition at line 258 of file em_vcmp.h.

References VCMP.

void VCMP_LowPowerRefSet ( bool enable )

Enable or disable Low Power Reference setting.

Parameters

[in] enable If true, enables low power reference, if false disable low power reference

Definition at line 155 of file em_vcmp.c.

References VCMP, and VCMP_INPUTSEL_LPREF.

Referenced by VCMP_Init().

void VCMP_TriggerSet ( int level )

Configure trigger level of voltage comparator.

Parameters

[in] level Trigger value, in range 0-63

Definition at line 175 of file em_vcmp.c.

References _VCMP_INPUTSEL_TRIGLEVEL_MASK, _VCMP_INPUTSEL_TRIGLEVEL_SHIFT, and VCMP.

Referenced by VCMP_Init().

__STATIC_INLINE uint32_t VCMP_VoltageToLevel ( float v )

Calculate voltage to trigger level.

Note: You need soft float support for this function to be working

Parameters

[in] v Voltage Level for trigger

Definition at line 175 of file em_vcmp.h.

Referenced by VDDCHECK_LowVoltage().

Detailed Description

Data Structures

Macros

Enumerations

Functions

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation