Detailed Description

Energy Management Unit (EMU) Peripheral API.

This module contains functions to control the EMU peripheral of Silicon Labs 32-bit MCUs and SoCs. The EMU handles the different low energy modes in Silicon Labs microcontrollers.

Data Structures
struct	EMU_EM23Init_TypeDef

Macros
#define	EMU_EM23INIT_DEFAULT

Enumerations
enum	EMU_BODMode_TypeDef { emuBODMode_Active , emuBODMode_Inactive }

enum	EMU_PowerConfig_TypeDef { emuPowerConfig_DcdcToDvdd }

Functions
void	EMU_DCDCConductionModeSet (EMU_DcdcConductionMode_TypeDef conductionMode, bool rcoDefaultSet)
	Set DCDC LN regulator conduction mode.

bool	EMU_DCDCInit (const EMU_DCDCInit_TypeDef *dcdcInit)
	Configure the DCDC regulator.

void	EMU_DCDCLnRcoBandSet (EMU_DcdcLnRcoBand_TypeDef band)
	Set DCDC Low-noise RCO band.

void	EMU_DCDCModeSet (EMU_DcdcMode_TypeDef dcdcMode)
	Set DCDC regulator operating mode.

void	EMU_DCDCOptimizeSlice (uint32_t em0LoadCurrentmA)
	Optimize the DCDC slice count based on the estimated average load current in EM0.

bool	EMU_DCDCOutputVoltageSet (uint32_t mV, bool setLpVoltage, bool setLnVoltage)
	Set the DCDC output voltage.

bool	EMU_DCDCPowerOff (void)
	Power off the DCDC regulator.

void	EMU_EM23Init (const EMU_EM23Init_TypeDef *em23Init)
	Update the EMU module with Energy Mode 2 and 3 configuration.

__STATIC_INLINE void	EMU_EM2Block (void)
	Block entering EM2 or higher number energy modes.

__STATIC_INLINE void	EMU_EM2UnBlock (void)
	Unblock entering EM2 or higher number energy modes.

__STATIC_INLINE void	EMU_EnterEM1 (void)
	Enter energy mode 1 (EM1).

void	EMU_EnterEM2 (bool restore)
	Enter energy mode 2 (EM2).

void	EMU_EnterEM3 (bool restore)
	Enter energy mode 3 (EM3).

void	EMU_EnterEM4 (void)
	Enter energy mode 4 (EM4).

__STATIC_INLINE void	EMU_Lock (void)
	Lock EMU registers in order to protect them against unintended modification.

void	EMU_MemPwrDown (uint32_t blocks)
	Power down memory block.

void	EMU_RamPowerDown (uint32_t start, uint32_t end)
	Power down RAM memory blocks.

void	EMU_RamPowerUp (void)
	Power up all available RAM memory blocks.

void	EMU_Restore (void)
	Restore CMU HF clock select state, oscillator enable, and voltage scaling (if available) after EMU_EnterEM2() or EMU_EnterEM3() are called with the restore parameter set to false. Calling this function is equivalent to calling EMU_EnterEM2() or EMU_EnterEM3() with the restore parameter set to true, but it allows the application to evaluate the wakeup reason before restoring state.

void	EMU_Save (void)
	Save the CMU HF clock select state, oscillator enable, and voltage scaling (if available) before EMU_EnterEM2() or EMU_EnterEM3() are called with the restore parameter set to false. Calling this function is equivalent to calling EMU_EnterEM2() or EMU_EnterEM3() with the restore parameter set to true, but it allows the state to be saved without going to sleep. The state can be restored manually by calling EMU_Restore() .

__STATIC_INLINE void	EMU_Unlock (void)
	Unlock the EMU so that writing to locked registers again is possible.

void	EMU_UpdateOscConfig (void)
	Update EMU module with CMU oscillator selection/enable status.

Macro Definition Documentation

#define EMU_EM23INIT_DEFAULT

Value:

         { \
        
         false,
         
          /* Reduced voltage regulator drive strength in EM2/3.*/
         
         \
        
         }

Default initialization of EM2 and 3 configuration.

Definition at line 458 of file em_emu.h .

Referenced by BSP_initEmu() .

Enumeration Type Documentation

enum EMU_BODMode_TypeDef

BOD threshold setting selector, active or inactive mode.

Enumerator
emuBODMode_Active	Configure BOD threshold for active mode.
emuBODMode_Inactive	Configure BOD threshold for inactive mode.

Definition at line 117 of file em_emu.h .

enum EMU_PowerConfig_TypeDef

Power configurations. DCDC-to-DVDD is currently the only supported mode.

Enumerator
emuPowerConfig_DcdcToDvdd	DCDC is connected to DVDD.

Definition at line 147 of file em_emu.h .

Function Documentation

void EMU_DCDCConductionModeSet	(	EMU_DcdcConductionMode_TypeDef	`conductionMode,`
		bool	`rcoDefaultSet`
	)

Set DCDC LN regulator conduction mode.

Parameters

[in]	`conductionMode`	DCDC LN conduction mode.
[in]	`rcoDefaultSet`	The default DCDC RCO band for the conductionMode will be used if true. Otherwise, the current RCO configuration is used.

Definition at line 1940 of file em_emu.c .

References EMU , EMU_DCDCLnRcoBandSet() , EMU_DCDCModeSet() , and EMU_DCDCOptimizeSlice() .

bool EMU_DCDCInit ( const EMU_DCDCInit_TypeDef * dcdcInit )

Configure the DCDC regulator.

Note: Do not call this function if the power circuit is configured for NODCDC as described in the Power Configurations section of the Reference Manual. Instead, call EMU_DCDCPowerOff() .

Parameters

[in] dcdcInit The DCDC initialization structure.

Returns: True if initialization parameters are valid.

Definition at line 1994 of file em_emu.c .

References BUS_RegBitWrite() , EMU , EMU_DCDCModeSet() , EMU_DCDCOptimizeSlice() , and EMU_DCDCOutputVoltageSet() .

void EMU_DCDCLnRcoBandSet ( EMU_DcdcLnRcoBand_TypeDef band )

Set DCDC Low-noise RCO band.

Parameters

[in] band RCO band to set.

Definition at line 2348 of file em_emu.c .

References BUS_RegBitRead() , EMU , and EMU_DCDCOptimizeSlice() .

Referenced by EMU_DCDCConductionModeSet() .

void EMU_DCDCModeSet ( EMU_DcdcMode_TypeDef dcdcMode )

Set DCDC regulator operating mode.

Parameters

[in] dcdcMode DCDC mode.

Definition at line 1868 of file em_emu.c .

References BUS_RegBitWrite() , and EMU .

Referenced by EMU_DCDCConductionModeSet() , EMU_DCDCInit() , and EMU_EnterEM4() .

void EMU_DCDCOptimizeSlice ( uint32_t em0LoadCurrentmA )

Optimize the DCDC slice count based on the estimated average load current in EM0.

Parameters

[in] em0LoadCurrent_mA Estimated average EM0 load current in mA.

Definition at line 2289 of file em_emu.c .

References EMU .

Referenced by EMU_DCDCConductionModeSet() , EMU_DCDCInit() , and EMU_DCDCLnRcoBandSet() .

bool EMU_DCDCOutputVoltageSet	(	uint32_t	`mV,`
		bool	`setLpVoltage,`
		bool	`setLnVoltage`
	)

Set the DCDC output voltage.

Parameters

[in] mV Target DCDC output voltage in mV.

Returns: True if the mV parameter is valid.

Definition at line 2138 of file em_emu.c .

References DEVINFO , EMU , SL_MAX , and SL_MIN .

Referenced by EMU_DCDCInit() .

bool EMU_DCDCPowerOff ( void )

Power off the DCDC regulator.

This function powers off the DCDC controller. This function should only be used if the external power circuit is wired for no DCDC. If the external power circuit is wired for DCDC usage, use EMU_DCDCInit() and set the DCDC in bypass mode to disable DCDC.

Returns: Return false if the DCDC could not be disabled.

Definition at line 2377 of file em_emu.c .

References EMU .

void EMU_EM23Init ( const EMU_EM23Init_TypeDef * em23Init )

Update the EMU module with Energy Mode 2 and 3 configuration.

Parameters

[in] em23Init Energy Mode 2 and 3 configuration structure.

Definition at line 1213 of file em_emu.c .

References EMU_EM23Init_TypeDef::em23VregFullEn , EMU , and EMU_CTRL_EMVREG .

Referenced by BSP_initEmu() .

void EMU_EnterEM2 ( bool restore )

Enter energy mode 2 (EM2).

When entering EM2, high-frequency clocks are disabled, i.e., HFXO, HFRCO and AUXHFRCO (for AUXHFRCO, see exception note below). When re-entering EM0, HFRCO is re-enabled and the core will be clocked by the configured HFRCO band. This ensures a quick wakeup from EM2.

However, prior to entering EM2, the core may have been using another oscillator than HFRCO. The restore parameter gives the user the option to restore all HF oscillators according to state prior to entering EM2, as well as the clock used to clock the core. This restore procedure is handled by SW. However, since handled by SW, it will not be restored before completing the interrupt function(s) waking up the core!

Note: If restoring core clock to use the HFXO oscillator, which has been disabled during EM2 mode, this function will stall until the oscillator has stabilized. Stalling time can be reduced by adding interrupt support detecting stable oscillator, and an asynchronous switch to the original oscillator. See CMU documentation. Such a feature is however outside the scope of the implementation in this function.; If ERRATA_FIX_EMU_E110_ENABLE is active, the core's SLEEPONEXIT feature can not be used.

: If HFXO is re-enabled by this function, and NOT used to clock the core, this function will not wait for HFXO to stabilize. This must be considered by the application if trying to use features relying on that oscillator upon return.

: If a debugger is attached, the AUXHFRCO will not be disabled if enabled upon entering EM2. It will thus remain enabled when returning to EM0 regardless of the restore parameter.

: If HFXO autostart and select is enabled by using CMU_HFXOAutostartEnable(), the starting and selecting of the core clocks will be identical to the user independently of the value of the restore parameter when waking up on the wakeup sources corresponding to the autostart and select setting.

: If voltage scaling is supported, the restore parameter is true and the EM0 voltage scaling level is set higher than the EM2 level, then the EM0 level is also restored.

Note that the hardware will automatically update the HFRCO frequency in the case where voltage scaling is used in EM2/EM3 and not in EM0/EM1. When the restore argument to this function is true then software will restore the original HFRCO frequency after EM2/EM3 wake up. If the restore argument is false then the HFRCO frequency is 19 MHz when coming out of EM2/EM3 and all wait states are at a safe value.

Parameters

[in]


              restore

true - save and restore oscillators, clocks and voltage scaling, see function details.
false - do not save and restore oscillators and clocks, see function details.

: The restore option should only be used if all clock control is done via the CMU API.

Definition at line 545 of file em_emu.c .

References CORE_CRITICAL_SECTION , and SystemCoreClockUpdate() .

Referenced by CAPLESENSE_Sleep() , UTIL_sleep() , and UTIL_waitForEvent() .

void EMU_EnterEM3 ( bool restore )

Enter energy mode 3 (EM3).

When entering EM3, the high-frequency clocks are disabled by hardware, i.e., HFXO, HFRCO, and AUXHFRCO (for AUXHFRCO, see exception note below). In addition, the low-frequency clocks, i.e., LFXO and LFRCO are disabled by software. When re-entering EM0, HFRCO is re-enabled and the core will be clocked by the configured HFRCO band. This ensures a quick wakeup from EM3.

However, prior to entering EM3, the core may have been using an oscillator other than HFRCO. The restore parameter gives the user the option to restore all HF/LF oscillators according to state prior to entering EM3, as well as the clock used to clock the core. This restore procedure is handled by software. However, since it is handled by software, it will not be restored before completing the interrupt function(s) waking up the core!

Note: If restoring core clock to use an oscillator other than HFRCO, this function will stall until the oscillator has stabilized. Stalling time can be reduced by adding interrupt support detecting stable oscillator, and an asynchronous switch to the original oscillator. See CMU documentation. This feature is, however, outside the scope of the implementation in this function.; If ERRATA_FIX_EMU_E110_ENABLE is active, the core's SLEEPONEXIT feature can't be used.

: If HFXO/LFXO/LFRCO are re-enabled by this function, and NOT used to clock the core, this function will not wait for those oscillators to stabilize. This must be considered by the application if trying to use features relying on those oscillators upon return.

: If a debugger is attached, the AUXHFRCO will not be disabled if enabled upon entering EM3. It will, therefore, remain enabled when returning to EM0 regardless of the restore parameter.

: If voltage scaling is supported, the restore parameter is true and the EM0 voltage scaling level is set higher than the EM3 level, then the EM0 level is also restored.

Parameters

[in]


              restore

true - save and restore oscillators, clocks and voltage scaling, see function details.
false - do not save and restore oscillators and clocks, see function details.

: The restore option should only be used if all clock control is done via the CMU API.

Definition at line 670 of file em_emu.c .

References CMU , CMU_Lock() , CMU_LOCK_LOCKKEY_LOCKED , CMU_OSCENCMD_LFRCODIS , CMU_OSCENCMD_LFXODIS , CMU_Unlock() , CORE_CRITICAL_SECTION , and SystemCoreClockUpdate() .

void EMU_EnterEM4 ( void )

Enter energy mode 4 (EM4).

Note: Only a power on reset or external reset pin can wake the device from EM4.

Definition at line 794 of file em_emu.c .

References _EMU_CTRL_EM4CTRL_MASK , _EMU_CTRL_EM4CTRL_SHIFT , BUS_RegMaskedClear() , CMU , CMU_OSCENCMD_HFRCOEN , CMU_STATUS_HFRCORDY , DEVINFO , EMU , EMU_BASE , EMU_DCDCModeSet() , and EMU_Unlock() .

Referenced by UTIL_shutdown() .

__STATIC_INLINE void EMU_Lock ( void )

Lock EMU registers in order to protect them against unintended modification.

Note: If locking EMU registers, they must be unlocked prior to using any EMU API functions modifying EMU registers, excluding interrupt control and regulator control if the architecture has a EMU_PWRCTRL register. An exception to this is the energy mode entering API (EMU_EnterEMn()), which can be used when the EMU registers are locked.

Definition at line 962 of file em_emu.h .

References EMU , and EMU_LOCK_LOCKKEY_LOCK .

Referenced by RMU_ResetCauseClear() .

void EMU_MemPwrDown ( uint32_t blocks )

Power down memory block.

Parameters

[in] blocks Specifies a logical OR of bits indicating memory blocks to power down. Bit 0 selects block 1, bit 1 selects block 2, and so on. Memory block 0 cannot be disabled. See the reference manual for available memory blocks for a device.

Note: Only a POR reset can power up the specified memory block(s) after power down.

Deprecated:: This function is deprecated, use EMU_RamPowerDown() instead which maps a user provided memory range into RAM blocks to power down.

Definition at line 932 of file em_emu.c .

References EMU .

void EMU_RamPowerDown	(	uint32_t	`start,`
		uint32_t	`end`
	)

Power down RAM memory blocks.

This function will power down all the RAM blocks that are within a given range. The RAM block layout is different between device families, so this function can be used in a generic way to power down a RAM memory region which is known to be unused.

This function will only power down blocks which are completely enclosed by the memory range given by [start, end).

This is an example to power down all RAM blocks except the first one. The first RAM block is special in that it cannot be powered down by the hardware. The size of the first RAM block is device-specific. See the reference manual to find the RAM block sizes.

1 EMU_RamPowerDown(SRAM_BASE, SRAM_BASE + SRAM_SIZE);

Note: Only a reset can power up the specified memory block(s) after power down on a series 0 device.

Parameters

[in]	`start`	The start address of the RAM region to power down. This address is inclusive.
[in]	`end`	The end address of the RAM region to power down. This address is exclusive. If this parameter is 0, all RAM blocks contained in the region from start to the upper RAM address will be powered down.

Definition at line 978 of file em_emu.c .

References EMU , RAM_MEM_BASE , SRAM_BASE , and SRAM_SIZE .

void EMU_RamPowerUp ( void )

Power up all available RAM memory blocks.

This function will power up all the RAM blocks on a device, this means that the RAM blocks are retained in EM2/EM3. Note that this functionality is not supported on Series 0 devices. Only a reset will power up the RAM blocks on a series 0 device.

Definition at line 1050 of file em_emu.c .

References EMU .

void EMU_UpdateOscConfig ( void )

Update EMU module with CMU oscillator selection/enable status.

Deprecated:: Oscillator status is saved in EMU_EnterEM2() and EMU_EnterEM3() .

Definition at line 1094 of file em_emu.c .

EMUEMLIB

Detailed Description

Data Structures

Macros

Enumerations

Functions

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation