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_EM01Init_TypeDef
	EM0 and 1 initialization structure.

struct	EMU_EM23Init_TypeDef
	EM2 and 3 initialization structure.

struct	EMU_EM4Init_TypeDef
	EM4 initialization structure.

struct	EMU_DCDCInit_TypeDef
	DCDC regulator initialization structure.

Functions
void	EMU_EM01Init (const EMU_EM01Init_TypeDef *em01Init)
	Update the EMU module with Energy Mode 0 and 1 configuration.

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

void	EMU_EM23PresleepHook (void)
	Energy mode 2/3 pre-sleep hook function.

void	EMU_EM23PostsleepHook (void)
	Energy mode 2/3 post-sleep hook function.

void	EMU_EM4Init (const EMU_EM4Init_TypeDef *em4Init)
	Update the EMU module with Energy Mode 4 configuration.

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

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

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.

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.

void	EMU_EM4PresleepHook (void)
	Energy mode 4 pre-sleep hook function.

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

void	EMU_EnterEM4H (void)
	Enter energy mode 4 hibernate (EM4H).

void	EMU_EnterEM4S (void)
	Enter energy mode 4 shutoff (EM4S).

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_UpdateOscConfig (void)
	Update EMU module with CMU oscillator selection/enable status.

void	EMU_EFPEM01VScale ( EMU_VScaleEM01_TypeDef voltage)
	Energy mode 01 voltage scaling hook function.

void	EMU_VScaleEM01ByClock (uint32_t clockFrequency, bool wait)
	Voltage scale in EM0 and 1 by clock frequency.

void	EMU_VScaleEM01 ( EMU_VScaleEM01_TypeDef voltage, bool wait)
	Force voltage scaling in EM0 and 1 to a specific voltage level.

void	EMU_EFPEM23PresleepHook (void)
	EFP's Energy mode 2/3 pre-sleep hook function.

void	EMU_EFPEM23PostsleepHook (void)
	EFP's Energy mode 2/3 post-sleep hook function.

void	EMU_EFPEM4PresleepHook (void)
	EFP's Energy mode 4 pre-sleep hook function.

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

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

bool	EMU_DCDCPowerOff (void)
	Power off the DCDC regulator.

void	EMU_DCDCSetPFMXModePeakCurrent (uint32_t value)
	Set PFMX mode Peak Current setting.

void	EMU_DCDCSetPFMXTimeoutMaxCtrl ( EMU_DcdcTonMaxTimeout_TypeDef value)
	Set Ton_max timeout control.

void	EMU_EM01PeakCurrentSet (const EMU_DcdcPeakCurrent_TypeDef peakCurrentEM01)
	Set EMO1 mode Peak Current setting.

float	EMU_TemperatureGet (void)
	Get temperature in degrees Celcius.

void	EMU_EFPDirectModeEnable (bool enable)
	Enable/disable EFP Direct Mode.

void	EMU_EFPDriveDecoupleSet (bool enable)
	Set to enable EFP to drive Decouple voltage.

void	EMU_EFPDriveDvddSet (bool enable)
	Set to enable EFP to drive DVDD voltage.

void	EMU_DCDCLock (void)
	Lock DCDC registers in order to protect them against unintended modification.

void	EMU_DCDCUnlock (void)
	Unlock the DCDC so that writing to locked registers again is possible.

void	EMU_DCDCSync (uint32_t mask)
	Wait for the DCDC to complete all synchronization of register changes.

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

void	EMU_VScaleWait (void)
	Wait for voltage scaling to complete.

EMU_VScaleEM01_TypeDef	EMU_VScaleGet (void)
	Get current voltage scaling level.

void	EMU_IntClear (uint32_t flags)
	Clear one or more pending EMU interrupts.

void	EMU_IntDisable (uint32_t flags)
	Disable one or more EMU interrupts.

void	EMU_IntEnable (uint32_t flags)
	Enable one or more EMU interrupts.

void	EMU_EFPIntEnable (uint32_t flags)
	Enable EFP interrupts.

uint32_t	EMU_EFPIntGet (void)
	Get pending EMU EFP interrupt flags.

void	EMU_EFPIntClear (uint32_t flags)
	Clear one or more pending EMU EFP interrupts.

uint32_t	EMU_IntGet (void)
	Get pending EMU interrupt flags.

uint32_t	EMU_IntGetEnabled (void)
	Get enabled and pending EMU interrupt flags.

void	EMU_IntSet (uint32_t flags)
	Set one or more pending EMU interrupts.

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

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

void	EMU_UnlatchPinRetention (void)
	When EM4 pin retention is set to emuPinRetentionLatch, then pins are retained through EM4 entry and wakeup.

bool	EMU_TemperatureReady (void)
	Temperature measurement ready status.

float	EMU_TemperatureAvgGet (void)
	Get averaged temperature in degrees Celcius.

void	EMU_TemperatureAvgRequest ( EMU_TempAvgNum_TypeDef numSamples)
	Request averaged temperature.

Macros
#define	EMU_VSCALE_PRESENT
	Voltage scaling present.

#define	EMU_EM01INIT_DEFAULT
	Default initialization of EM0 and 1 configuration.

#define	EMU_EM23INIT_DEFAULT
	Default initialization of EM2 and 3 configuration.

#define	EMU_EM4INIT_DEFAULT
	Default initialization of EM4 configuration (Series 1 without VSCALE).

#define	EMU_DCDCINIT_DEFAULT
	Default DCDC initialization.

#define	EMU_TEMP_ZERO_C_IN_KELVIN (273.15f)
	Zero degrees Celcius in Kelvin.

#define	EMU_TEMPCO_CONST (0.273f)
	As we do not know what energy mode a temperature measurement was taken at, we choose a constant for the TEMPCO calculation that is midway between the EM0/EM1 constant and the EM2/EM3/EM4 constant.

Enumerations
enum	EMU_BODMode_TypeDef { emuBODMode_Active , emuBODMode_Inactive }
	BOD threshold setting selector, active or inactive mode.

enum	EMU_EM4State_TypeDef { emuEM4Shutoff = 0, emuEM4Hibernate = 1 }
	EM4 modes.

enum	EMU_EM4PinRetention_TypeDef { emuPinRetentionDisable = EMU_EM4CTRL_EM4IORETMODE_DISABLE, emuPinRetentionEm4Exit = EMU_EM4CTRL_EM4IORETMODE_EM4EXIT, emuPinRetentionLatch = EMU_EM4CTRL_EM4IORETMODE_SWUNLATCH }
	EM4 Pin Retention Type.

enum	EMU_PowerConfig_TypeDef { emuPowerConfig_DcdcToDvdd }
	Power configurations.

enum	EMU_DcdcMode_TypeDef { emuDcdcMode_Bypass = _DCDC_CTRL_MODE_BYPASS, emuDcdcMode_Regulation = _DCDC_CTRL_MODE_DCDCREGULATION }
	DCDC mode.

enum	EMU_VreginCmpThreshold_TypeDef { emuVreginCmpThreshold_2v0 = 0, emuVreginCmpThreshold_2v1 = 1, emuVreginCmpThreshold_2v2 = 2, emuVreginCmpThreshold_2v3 = 3 }
	VREGIN comparator threshold.

enum	EMU_DcdcTonMaxTimeout_TypeDef { emuDcdcTonMaxTimeout_Off = 0, emuDcdcTonMaxTimeout_0P14us = 1, emuDcdcTonMaxTimeout_0P21us = 2, emuDcdcTonMaxTimeout_0P28us = 3, emuDcdcTonMaxTimeout_0P35us = 4, emuDcdcTonMaxTimeout_0P42us = 5, emuDcdcTonMaxTimeout_0P49us = 6, emuDcdcTonMaxTimeout_0P56us = 7, emuDcdcTonMaxTimeout_0P63us = 8, emuDcdcTonMaxTimeout_0P70us = 9, emuDcdcTonMaxTimeout_0P77us = 10, emuDcdcTonMaxTimeout_0P84us = 11, emuDcdcTonMaxTimeout_0P91us = 12, emuDcdcTonMaxTimeout_0P98us = 13, emuDcdcTonMaxTimeout_1P05us = 14, emuDcdcTonMaxTimeout_1P12us = 15, emuDcdcTonMaxTimeout_1P19us = 16, emuDcdcTonMaxTimeout_1P26us = 17, emuDcdcTonMaxTimeout_1P33us = 18, emuDcdcTonMaxTimeout_1P40us = 19, emuDcdcTonMaxTimeout_1P47us = 20, emuDcdcTonMaxTimeout_1P54us = 21, emuDcdcTonMaxTimeout_1P61us = 22, emuDcdcTonMaxTimeout_1P68us = 23, emuDcdcTonMaxTimeout_1P75us = 24, emuDcdcTonMaxTimeout_1P82us = 25, emuDcdcTonMaxTimeout_1P89us = 26, emuDcdcTonMaxTimeout_1P96us = 27, emuDcdcTonMaxTimeout_2P03us = 28, emuDcdcTonMaxTimeout_2P10us = 29, emuDcdcTonMaxTimeout_2P17us = 30, emuDcdcTonMaxTimeout_2P24us = 31 }
	DCDC Ton max timeout.

enum	EMU_DcdcDriveSpeed_TypeDef { emuDcdcDriveSpeed_BestEmi = _DCDC_EM01CTRL0_DRVSPEED_BEST_EMI, emuDcdcDriveSpeed_Default = _DCDC_EM01CTRL0_DRVSPEED_DEFAULT_SETTING, emuDcdcDriveSpeed_Intermediate = _DCDC_EM01CTRL0_DRVSPEED_INTERMEDIATE, emuDcdcDriveSpeed_BestEfficiency = _DCDC_EM01CTRL0_DRVSPEED_BEST_EFFICIENCY }
	DCDC drive speed.

enum	EMU_DcdcPeakCurrent_TypeDef { emuDcdcPeakCurrent_Load36mA = _DCDC_EM01CTRL0_IPKVAL_Load36mA, emuDcdcPeakCurrent_Load40mA = _DCDC_EM01CTRL0_IPKVAL_Load40mA, emuDcdcPeakCurrent_Load44mA = _DCDC_EM01CTRL0_IPKVAL_Load44mA, emuDcdcPeakCurrent_Load48mA = _DCDC_EM01CTRL0_IPKVAL_Load48mA, emuDcdcPeakCurrent_Load52mA = _DCDC_EM01CTRL0_IPKVAL_Load52mA, emuDcdcPeakCurrent_Load56mA = _DCDC_EM01CTRL0_IPKVAL_Load56mA, emuDcdcPeakCurrent_Load60mA = _DCDC_EM01CTRL0_IPKVAL_Load60mA }
	DCDC peak current setting.

enum	EMU_VScaleEM01_TypeDef { emuVScaleEM01_HighPerformance = _EMU_STATUS_VSCALE_VSCALE2, emuVScaleEM01_LowPower = _EMU_STATUS_VSCALE_VSCALE1 }
	Supported EM0/1 Voltage Scaling Levels.

enum	EMU_VScaleEM23_TypeDef { emuVScaleEM23_FastWakeup = _EMU_CTRL_EM23VSCALE_VSCALE2, emuVScaleEM23_LowPower = _EMU_CTRL_EM23VSCALE_VSCALE0 }
	Supported EM2/3 Voltage Scaling Levels.

enum	EMU_TempAvgNum_TypeDef { emuTempAvgNum_16 = _EMU_CTRL_TEMPAVGNUM_N16, emuTempAvgNum_64 = _EMU_CTRL_TEMPAVGNUM_N64 }
	Number of samples to use for temperature averaging.

Function Documentation

◆ EMU_EM01Init()

void EMU_EM01Init ( const EMU_EM01Init_TypeDef * em01Init )

Update the EMU module with Energy Mode 0 and 1 configuration.

Parameters

[in] em01Init Energy Mode 0 and 1 configuration structure.

◆ EMU_EM23Init()

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.

◆ EMU_EM23PresleepHook()

void EMU_EM23PresleepHook ( void )

Energy mode 2/3 pre-sleep hook function.

This function is called by EMU_EnterEM2() and EMU_EnterEM3() functions just prior to execution of the WFI instruction. The function implementation does not perform anything, but it is SL_WEAK so that it can be re- implemented in application code if actions are needed.

◆ EMU_EM23PostsleepHook()

void EMU_EM23PostsleepHook ( void )

Energy mode 2/3 post-sleep hook function.

This function is called by EMU_EnterEM2() and EMU_EnterEM3() functions just after wakeup from the WFI instruction. The function implementation does not perform anything, but it is SL_WEAK so that it can be re- implemented in application code if actions are needed.

◆ EMU_EM4Init()

void EMU_EM4Init ( const EMU_EM4Init_TypeDef * em4Init )

Update the EMU module with Energy Mode 4 configuration.

Parameters

[in] em4Init Energy Mode 4 configuration structure.

◆ EMU_EnterEM2()

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 automatic starting and selecting of the core clocks will be done, regardless 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.

: On Series 2 Config 2 devices (EFRxG22), this function will also relock the DPLL if the DPLL is used and restore is true.

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.

◆ EMU_EnterEM3()

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.

: On Series 2 Config 2 devices (EFRxG22), this function will also relock the DPLL if the DPLL is used and restore is true.

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.

◆ EMU_Save()

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() .

◆ EMU_Restore()

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.

◆ EMU_EM4PresleepHook()

void EMU_EM4PresleepHook ( void )

Energy mode 4 pre-sleep hook function.

This function is called by EMU_EnterEM4() just prior to the sequence of writes to put the device in EM4. The function implementation does not perform anything, but it is SL_WEAK so that it can be re-implemented in application code if actions are needed.

◆ EMU_EnterEM4()

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.

◆ EMU_EnterEM4H()

void EMU_EnterEM4H ( void )

Enter energy mode 4 hibernate (EM4H).

Note: Retention of clocks and GPIO in EM4 can be configured using EMU_EM4Init before calling this function.

◆ EMU_EnterEM4S()

void EMU_EnterEM4S ( void )

Enter energy mode 4 shutoff (EM4S).

Note: Retention of clocks and GPIO in EM4 can be configured using EMU_EM4Init before calling this function.

◆ EMU_MemPwrDown()

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.

◆ EMU_RamPowerDown()

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.

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. The specified memory block(s) will stay off until a call to EMU_RamPowerUp() is done on series 1/2.

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.

◆ EMU_RamPowerUp()

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.

◆ EMU_UpdateOscConfig()

void EMU_UpdateOscConfig ( void )

Update EMU module with CMU oscillator selection/enable status.

◆ EMU_EFPEM01VScale()

void EMU_EFPEM01VScale ( EMU_VScaleEM01_TypeDef voltage )

Energy mode 01 voltage scaling hook function.

This function is called by EMU_VScaleEM01 to let EFP know that voltage scaling is requested.

Parameters

[in] voltage Voltage to set in EFP.

◆ EMU_VScaleEM01ByClock()

void EMU_VScaleEM01ByClock	(	uint32_t	`clockFrequency,`
		bool	`wait`
	)

Voltage scale in EM0 and 1 by clock frequency.

Parameters

[in]	`clockFrequency`	Use CMSIS HF clock if 0 or override to custom clock. Providing a custom clock frequency is required if using a non-standard HFXO frequency.
[in]	`wait`	Wait for scaling to complete.

Note: This function is primarily needed by the CMU - Clock Management Unit .

◆ EMU_VScaleEM01()

void EMU_VScaleEM01	(	EMU_VScaleEM01_TypeDef	`voltage,`
		bool	`wait`
	)

Force voltage scaling in EM0 and 1 to a specific voltage level.

Parameters

[in]	`voltage`	Target VSCALE voltage level.
[in]	`wait`	Wait for scaling to complete.

Note: This function is useful for upscaling before programming Flash from MSC - Memory System Controller and downscaling after programming is done. Flash programming is only supported at emuVScaleEM01_HighPerformance .; This function ignores vScaleEM01LowPowerVoltageEnable set from EMU_EM01Init() .

◆ EMU_EFPEM23PresleepHook()

void EMU_EFPEM23PresleepHook ( void )

EFP's Energy mode 2/3 pre-sleep hook function.

This function is similar to EMU_EM23PresleepHook() but is reserved for EFP usage.

Note: The function is primarily meant to be used in systems with EFP circuitry. (EFP = Energy Friendly Pmic (PMIC = Power Management IC)). In such systems there is a need to drive certain signals to EFP pins to notify about energy mode transitions.

◆ EMU_EFPEM23PostsleepHook()

void EMU_EFPEM23PostsleepHook ( void )

EFP's Energy mode 2/3 post-sleep hook function.

This function is similar to EMU_EM23PostsleepHook() but is reserved for EFP usage.

Note: The function is primarily meant to be used in systems with EFP circuitry. (EFP = Energy Friendly Pmic (PMIC = Power Management IC)). In such systems there is a need to drive certain signals to EFP pins to notify about energy mode transitions.

◆ EMU_EFPEM4PresleepHook()

void EMU_EFPEM4PresleepHook ( void )

EFP's Energy mode 4 pre-sleep hook function.

This function is similar to EMU_EM4PresleepHook() but is reserved for EFP usage.

Note: The function is primarily meant to be used in systems with EFP circuitry. (EFP = Energy Friendly Pmic (PMIC = Power Management IC)). In such systems there is a need to drive certain signals to EFP pins to notify about energy mode transitions.

◆ EMU_DCDCInit()

bool EMU_DCDCInit ( const EMU_DCDCInit_TypeDef * dcdcInit )

Configure the DCDC regulator.

Parameters

[in] dcdcInit The DCDC initialization structure.

Returns: True if initialization parameters are valid.

◆ EMU_DCDCModeSet()

void EMU_DCDCModeSet ( EMU_DcdcMode_TypeDef dcdcMode )

Set DCDC regulator operating mode.

Parameters

[in] dcdcMode DCDC mode.

◆ EMU_DCDCPowerOff()

bool EMU_DCDCPowerOff ( void )

Power off the DCDC regulator.

Returns: Returns true.

◆ EMU_DCDCSetPFMXModePeakCurrent()

void EMU_DCDCSetPFMXModePeakCurrent ( uint32_t value )

Set PFMX mode Peak Current setting.

Parameters

[in] value Peak load current coefficient in PFMX mode.

◆ EMU_DCDCSetPFMXTimeoutMaxCtrl()

void EMU_DCDCSetPFMXTimeoutMaxCtrl ( EMU_DcdcTonMaxTimeout_TypeDef value )

Set Ton_max timeout control.

Parameters

[in] value Maximum time for peak current detection.

◆ EMU_EM01PeakCurrentSet()

void EMU_EM01PeakCurrentSet ( const EMU_DcdcPeakCurrent_TypeDef peakCurrentEM01 )

Set EMO1 mode Peak Current setting.

Parameters

[in] peakCurrentEM01 Peak load current coefficient in EM01 mode.

◆ EMU_TemperatureGet()

float EMU_TemperatureGet ( void )

Get temperature in degrees Celcius.

Returns: Temperature in degrees Celcius

◆ EMU_EFPDirectModeEnable()

void EMU_EFPDirectModeEnable ( bool enable )

Enable/disable EFP Direct Mode.

Parameters

[in] enable True to enable direct mode.

◆ EMU_EFPDriveDecoupleSet()

void EMU_EFPDriveDecoupleSet ( bool enable )

Set to enable EFP to drive Decouple voltage.

Once set, internal LDO will be disabled, and the EMU will control EFP for voltage-scaling. Note that because this bit disables the internal LDO powering the core, it should not be set until after EFP's DECOUPLE output has been configured and enabled.

Parameters

[in] enable True to enable EFP to drive Decouple voltage.

◆ EMU_EFPDriveDvddSet()

void EMU_EFPDriveDvddSet ( bool enable )

Set to enable EFP to drive DVDD voltage.

Set this if EFP's DCDC output is powering DVDD supply. This mode assumes that internal DCDC is not being used.

Parameters

[in] enable True to enable EFP to drive DVDD voltage.

◆ EMU_DCDCLock()

void EMU_DCDCLock ( void )

inline

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

◆ EMU_DCDCUnlock()

void EMU_DCDCUnlock ( void )

inline

Unlock the DCDC so that writing to locked registers again is possible.

◆ EMU_DCDCSync()

void EMU_DCDCSync ( uint32_t mask )

inline

Wait for the DCDC to complete all synchronization of register changes.

Parameters

[in] mask A bitmask corresponding to SYNCBUSY register defined bits indicating registers that must complete any ongoing synchronization.

◆ EMU_EnterEM1()

void EMU_EnterEM1 ( void )

inline

Enter energy mode 1 (EM1).

◆ EMU_VScaleWait()

void EMU_VScaleWait ( void )

inline

Wait for voltage scaling to complete.

◆ EMU_VScaleGet()

EMU_VScaleEM01_TypeDef EMU_VScaleGet ( void )

inline

Get current voltage scaling level.

Returns: Current voltage scaling level.

◆ EMU_IntClear()

void EMU_IntClear ( uint32_t flags )

inline

Clear one or more pending EMU interrupts.

Parameters

[in] flags Pending EMU interrupt sources to clear. Use one or more valid interrupt flags for the EMU module (EMU_IFC_nnn).

◆ EMU_IntDisable()

void EMU_IntDisable ( uint32_t flags )

inline

Disable one or more EMU interrupts.

Parameters

[in] flags EMU interrupt sources to disable. Use one or more valid interrupt flags for the EMU module (EMU_IEN_nnn).

◆ EMU_IntEnable()

void EMU_IntEnable ( uint32_t flags )

inline

Enable one or more EMU interrupts.

Note: Depending on the use, a pending interrupt may already be set prior to enabling the interrupt. To ignore a pending interrupt, consider using EMU_IntClear() prior to enabling the interrupt.

Parameters

[in] flags EMU interrupt sources to enable. Use one or more valid interrupt flags for the EMU module (EMU_IEN_nnn).

◆ EMU_EFPIntEnable()

void EMU_EFPIntEnable ( uint32_t flags )

inline

Enable EFP interrupts.

Parameters

[in] flags Enable/disable EFP interrupts.

◆ EMU_EFPIntGet()

uint32_t EMU_EFPIntGet ( void )

inline

Get pending EMU EFP interrupt flags.

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

Returns: EMU EFP interrupt sources pending. .

◆ EMU_EFPIntClear()

void EMU_EFPIntClear ( uint32_t flags )

inline

Clear one or more pending EMU EFP interrupts.

Parameters

[in] flags Pending EMU EFP interrupt sources to clear. Use one or more valid interrupt flags for the EMU EFP module.

◆ EMU_IntGet()

uint32_t EMU_IntGet ( void )

inline

Get pending EMU interrupt flags.

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

Returns: EMU interrupt sources pending. Returns one or more valid interrupt flags for the EMU module (EMU_IF_nnn).

◆ EMU_IntGetEnabled()

uint32_t EMU_IntGetEnabled ( void )

inline

Get enabled and pending EMU interrupt flags.

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

Note: Interrupt flags are not cleared by the use of this function.

Returns

Pending and enabled EMU interrupt sources Return value is the bitwise AND of

the enabled interrupt sources in EMU_IEN and
the pending interrupt flags EMU_IF.

◆ EMU_IntSet()

void EMU_IntSet ( uint32_t flags )

inline

Set one or more pending EMU interrupts.

Parameters

[in] flags EMU interrupt sources to set to pending. Use one or more valid interrupt flags for the EMU module (EMU_IFS_nnn).

◆ EMU_Lock()

void EMU_Lock ( void )

inline

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.

◆ EMU_Unlock()

void EMU_Unlock ( void )

inline

Unlock the EMU so that writing to locked registers again is possible.

◆ EMU_UnlatchPinRetention()

void EMU_UnlatchPinRetention ( void )

inline

When EM4 pin retention is set to emuPinRetentionLatch, then pins are retained through EM4 entry and wakeup.

The pin state is released by calling this function. The feature allows peripherals or GPIO to be re-initialized after EM4 exit (reset), and when initialization is done, this function can release pins and return control to the peripherals or GPIO.

◆ EMU_TemperatureReady()

bool EMU_TemperatureReady ( void )

inline

Temperature measurement ready status.

Returns: True if temperature measurement is ready

◆ EMU_TemperatureAvgGet()

float EMU_TemperatureAvgGet ( void )

inline

Get averaged temperature in degrees Celcius.

Note: An averaged temperature measurement must first be requested by calling EMU_TemperatureAvgRequest() and waiting for the TEMPAVG interrupt flag to go high.

Returns: Averaged temperature

◆ EMU_TemperatureAvgRequest()

void EMU_TemperatureAvgRequest ( EMU_TempAvgNum_TypeDef numSamples )

inline

Request averaged temperature.

Note: EMU must be unlocked, by calling EMU_Unlock() , before this function can be called.

Parameters

[in] numSamples Number of temeprature samples to average

Macro Definition Documentation

◆ EMU_VSCALE_PRESENT

#define EMU_VSCALE_PRESENT

Voltage scaling present.

◆ EMU_EM01INIT_DEFAULT

#define EMU_EM01INIT_DEFAULT

Value:

         {                                                                                       \
        
         false
         
          /* Do not scale down in EM0/1.*/
         
         \
        
         }

Default initialization of EM0 and 1 configuration.

◆ EMU_EM23INIT_DEFAULT

#define EMU_EM23INIT_DEFAULT

Value:

         {                                                                                                             \
        
         false,
         
          /* Reduced voltage regulator drive strength in EM2/3.*/
         
         \
        
         emuVScaleEM23_FastWakeup,
         
          /* Do not scale down in EM2/3. */
         
         \
        
         }

Default initialization of EM2 and 3 configuration.

◆ EMU_EM4INIT_DEFAULT

#define EMU_EM4INIT_DEFAULT

Value:

         {                                                                                    \
        
         false,
         
          /* Retain LFXO configuration upon EM4 entry. */
         
         \
        
         false,
         
          /* Retain LFRCO configuration upon EM4 entry. */
         
         \
        
         false,
         
          /* Retain ULFRCO configuration upon EM4 entry. */
         
         \
        
         emuEM4Shutoff,
         
          /* Use EM4 shutoff state. */
         
         \
        
         emuPinRetentionDisable,
         
          /* Do not retain pins in EM4. */
         
         \
        
         }

Default initialization of EM4 configuration (Series 1 without VSCALE).

◆ EMU_DCDCINIT_DEFAULT

#define EMU_DCDCINIT_DEFAULT

Value:

         {                                                                          \
        
         emuDcdcMode_Regulation,                        \
        
         emuVreginCmpThreshold_2v3,      \
        
         emuDcdcTonMaxTimeout_1P19us,                   \
        
         emuDcdcDriveSpeed_Default,           \
        
         emuDcdcDriveSpeed_Default,           \
        
         emuDcdcPeakCurrent_Load36mA,       \
        
         emuDcdcPeakCurrent_Load36mA        \
        
         }

Default DCDC initialization.

◆ EMU_TEMP_ZERO_C_IN_KELVIN

#define EMU_TEMP_ZERO_C_IN_KELVIN (273.15f)

Zero degrees Celcius in Kelvin.

◆ EMU_TEMPCO_CONST

#define EMU_TEMPCO_CONST (0.273f)

As we do not know what energy mode a temperature measurement was taken at, we choose a constant for the TEMPCO calculation that is midway between the EM0/EM1 constant and the EM2/EM3/EM4 constant.

Enumeration Type Documentation

◆ EMU_BODMode_TypeDef

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.

◆ EMU_EM4State_TypeDef

enum EMU_EM4State_TypeDef

EM4 modes.

Enumerator
emuEM4Shutoff	EM4 Shutoff.
emuEM4Hibernate	EM4 Hibernate.

◆ EMU_EM4PinRetention_TypeDef

enum EMU_EM4PinRetention_TypeDef

EM4 Pin Retention Type.

Enumerator
emuPinRetentionDisable	No Retention: Pads enter reset state when entering EM4.
emuPinRetentionEm4Exit	Retention through EM4: Pads enter reset state when exiting EM4.
emuPinRetentionLatch	Retention through EM4 and wakeup: call EMU_UnlatchPinRetention() to release pins from retention after EM4 wakeup.

◆ EMU_PowerConfig_TypeDef

enum EMU_PowerConfig_TypeDef

Power configurations.

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

Enumerator
emuPowerConfig_DcdcToDvdd	DCDC is connected to DVDD.

◆ EMU_DcdcMode_TypeDef

enum EMU_DcdcMode_TypeDef

DCDC mode.

Enumerator

emuDcdcMode_Bypass

DCDC regulator bypass.

emuDcdcMode_Regulation

DCDC regulator on.

◆ EMU_VreginCmpThreshold_TypeDef

enum EMU_VreginCmpThreshold_TypeDef

VREGIN comparator threshold.

Enumerator
emuVreginCmpThreshold_2v0	Comparator threshold is 2.0V.
emuVreginCmpThreshold_2v1	Comparator threshold is 2.1V.
emuVreginCmpThreshold_2v2	Comparator threshold is 2.2V.
emuVreginCmpThreshold_2v3	Comparator threshold is 2.3V.

◆ EMU_DcdcTonMaxTimeout_TypeDef

enum EMU_DcdcTonMaxTimeout_TypeDef

DCDC Ton max timeout.

Enumerator
emuDcdcTonMaxTimeout_Off	Ton max off.
emuDcdcTonMaxTimeout_0P14us	Ton max is 0.14us.
emuDcdcTonMaxTimeout_0P21us	Ton max is 0.21us.
emuDcdcTonMaxTimeout_0P28us	Ton max is 0.28us.
emuDcdcTonMaxTimeout_0P35us	Ton max is 0.35us.
emuDcdcTonMaxTimeout_0P42us	Ton max is 0.42us.
emuDcdcTonMaxTimeout_0P49us	Ton max is 0.49us.
emuDcdcTonMaxTimeout_0P56us	Ton max is 0.56us.
emuDcdcTonMaxTimeout_0P63us	Ton max is 0.63us.
emuDcdcTonMaxTimeout_0P70us	Ton max is 0.70us.
emuDcdcTonMaxTimeout_0P77us	Ton max is 0.77us.
emuDcdcTonMaxTimeout_0P84us	Ton max is 0.84us.
emuDcdcTonMaxTimeout_0P91us	Ton max is 0.91us.
emuDcdcTonMaxTimeout_0P98us	Ton max is 0.98us.
emuDcdcTonMaxTimeout_1P05us	Ton max is 1.05us.
emuDcdcTonMaxTimeout_1P12us	Ton max is 1.12us.
emuDcdcTonMaxTimeout_1P19us	Ton max is 1.19us.
emuDcdcTonMaxTimeout_1P26us	Ton max is 1.26us.
emuDcdcTonMaxTimeout_1P33us	Ton max is 1.33us.
emuDcdcTonMaxTimeout_1P40us	Ton max is 1.40us.
emuDcdcTonMaxTimeout_1P47us	Ton max is 1.47us.
emuDcdcTonMaxTimeout_1P54us	Ton max is 1.54us.
emuDcdcTonMaxTimeout_1P61us	Ton max is 1.61us.
emuDcdcTonMaxTimeout_1P68us	Ton max is 1.68us.
emuDcdcTonMaxTimeout_1P75us	Ton max is 1.75us.
emuDcdcTonMaxTimeout_1P82us	Ton max is 1.82us.
emuDcdcTonMaxTimeout_1P89us	Ton max is 1.89us.
emuDcdcTonMaxTimeout_1P96us	Ton max is 1.96us.
emuDcdcTonMaxTimeout_2P03us	Ton max is 2.03us.
emuDcdcTonMaxTimeout_2P10us	Ton max is 2.10us.
emuDcdcTonMaxTimeout_2P17us	Ton max is 2.17us.
emuDcdcTonMaxTimeout_2P24us	Ton max is 2.24us.

◆ EMU_DcdcDriveSpeed_TypeDef

enum EMU_DcdcDriveSpeed_TypeDef

DCDC drive speed.

Enumerator
emuDcdcDriveSpeed_BestEmi	Lowest efficiency, lowest EMI.
emuDcdcDriveSpeed_Default	Default efficiency, acceptable EMI level.
emuDcdcDriveSpeed_Intermediate	Small increase in efficiency from the default setting.
emuDcdcDriveSpeed_BestEfficiency	Highest efficiency, highest EMI. Small increase in efficiency from INTERMEDIATE setting.

◆ EMU_DcdcPeakCurrent_TypeDef

enum EMU_DcdcPeakCurrent_TypeDef

DCDC peak current setting.

Enumerator
emuDcdcPeakCurrent_Load36mA	Load 36mA, peak current 90mA.
emuDcdcPeakCurrent_Load40mA	Load 40mA, peak current 100mA.
emuDcdcPeakCurrent_Load44mA	Load 44mA, peak current 110mA.
emuDcdcPeakCurrent_Load48mA	Load 48mA, peak current 120mA.
emuDcdcPeakCurrent_Load52mA	Load 52mA, peak current 130mA.
emuDcdcPeakCurrent_Load56mA	Load 56mA, peak current 140mA.
emuDcdcPeakCurrent_Load60mA	Load 60mA, peak current 150mA.

◆ EMU_VScaleEM01_TypeDef

enum EMU_VScaleEM01_TypeDef

Supported EM0/1 Voltage Scaling Levels.

Enumerator

emuVScaleEM01_HighPerformance

High-performance voltage level.

HF clock can be set to any frequency.

emuVScaleEM01_LowPower

Low-power optimized voltage level.

HF clock must be limited to CMU_VSCALEEM01_LOWPOWER_VOLTAGE_CLOCK_MAX Hz at this voltage. EM0/1 voltage scaling is applied when core clock frequency is changed from CMU - Clock Management Unit or when calling EMU_EM01Init() when HF clock is already below the limit. Minimum VSCALE level in EM0/1 is VSCALE1.

◆ EMU_VScaleEM23_TypeDef

enum EMU_VScaleEM23_TypeDef

Supported EM2/3 Voltage Scaling Levels.

Enumerator

emuVScaleEM23_FastWakeup

Fast-wakeup voltage level.

emuVScaleEM23_LowPower

Low-power optimized voltage level.

Using this voltage level in EM2 and 3 adds approximately 30 us to wakeup time if EM0 and 1 voltage must be scaled up to emuVScaleEM01_HighPerformance on EM2 or 3 exit.

◆ EMU_TempAvgNum_TypeDef

enum EMU_TempAvgNum_TypeDef

Number of samples to use for temperature averaging.

Enumerator
emuTempAvgNum_16	16 samples used for temperature averaging.
emuTempAvgNum_64	64 samples used for temperature averaging.

EMU - Energy Management Unit

Description

Data Structures

Functions

Macros

Enumerations

Function Documentation

◆ EMU_EM01Init()

◆ EMU_EM23Init()

◆ EMU_EM23PresleepHook()

◆ EMU_EM23PostsleepHook()

◆ EMU_EM4Init()

◆ EMU_EnterEM2()

◆ EMU_EnterEM3()

◆ EMU_Save()

◆ EMU_Restore()

◆ EMU_EM4PresleepHook()

◆ EMU_EnterEM4()

◆ EMU_EnterEM4H()

◆ EMU_EnterEM4S()

◆ EMU_MemPwrDown()

◆ EMU_RamPowerDown()

◆ EMU_RamPowerUp()

◆ EMU_UpdateOscConfig()

◆ EMU_EFPEM01VScale()

◆ EMU_VScaleEM01ByClock()

◆ EMU_VScaleEM01()

◆ EMU_EFPEM23PresleepHook()

◆ EMU_EFPEM23PostsleepHook()

◆ EMU_EFPEM4PresleepHook()

◆ EMU_DCDCInit()

◆ EMU_DCDCModeSet()

◆ EMU_DCDCPowerOff()

◆ EMU_DCDCSetPFMXModePeakCurrent()

◆ EMU_DCDCSetPFMXTimeoutMaxCtrl()

◆ EMU_EM01PeakCurrentSet()

◆ EMU_TemperatureGet()

◆ EMU_EFPDirectModeEnable()

◆ EMU_EFPDriveDecoupleSet()

◆ EMU_EFPDriveDvddSet()

◆ EMU_DCDCLock()

◆ EMU_DCDCUnlock()

◆ EMU_DCDCSync()

◆ EMU_EnterEM1()

◆ EMU_VScaleWait()

◆ EMU_VScaleGet()

◆ EMU_IntClear()

◆ EMU_IntDisable()

◆ EMU_IntEnable()

◆ EMU_EFPIntEnable()

◆ EMU_EFPIntGet()

◆ EMU_EFPIntClear()

◆ EMU_IntGet()

◆ EMU_IntGetEnabled()

◆ EMU_IntSet()

◆ EMU_Lock()

◆ EMU_Unlock()

◆ EMU_UnlatchPinRetention()

◆ EMU_TemperatureReady()

◆ EMU_TemperatureAvgGet()

◆ EMU_TemperatureAvgRequest()

Macro Definition Documentation

◆ EMU_VSCALE_PRESENT

◆ EMU_EM01INIT_DEFAULT

◆ EMU_EM23INIT_DEFAULT

◆ EMU_EM4INIT_DEFAULT

◆ EMU_DCDCINIT_DEFAULT

◆ EMU_TEMP_ZERO_C_IN_KELVIN

◆ EMU_TEMPCO_CONST

Enumeration Type Documentation

◆ EMU_BODMode_TypeDef

◆ EMU_EM4State_TypeDef

◆ EMU_EM4PinRetention_TypeDef

◆ EMU_PowerConfig_TypeDef

◆ EMU_DcdcMode_TypeDef

◆ EMU_VreginCmpThreshold_TypeDef

◆ EMU_DcdcTonMaxTimeout_TypeDef

◆ EMU_DcdcDriveSpeed_TypeDef

◆ EMU_DcdcPeakCurrent_TypeDef

◆ EMU_VScaleEM01_TypeDef