EMU - Energy Management Unit#

EMU_BODMode_TypeDef#

EMU_BODMode_TypeDef

BOD threshold setting selector, active or inactive mode.

EMU_EM4State_TypeDef#

EMU_EM4State_TypeDef

EM4 modes.

EMU_EM4PinRetention_TypeDef#

EMU_EM4PinRetention_TypeDef

EM4 Pin Retention Type.

EMU_PowerConfig_TypeDef#

EMU_PowerConfig_TypeDef

Power configurations.

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

EMU_DcdcMode_TypeDef#

EMU_DcdcMode_TypeDef

DCDC mode.

EMU_DcdcBoostDriveSpeed_TypeDef#

EMU_DcdcBoostDriveSpeed_TypeDef

DCDC Boost drive speed.

EMU_DcdcBoostEM01PeakCurrent_TypeDef#

EMU_DcdcBoostEM01PeakCurrent_TypeDef

DCDC Boost EM01 peak current setting.

EMU_DcdcBoostToffMaxTimeout_TypeDef#

EMU_DcdcBoostToffMaxTimeout_TypeDef

DCDC Boost Toff max timeout.

EMU_DcdcBoostTonMaxTimeout_TypeDef#

EMU_DcdcBoostTonMaxTimeout_TypeDef

DCDC Boost peak current detection maximum timeout.

EMU_DcdcBoostEM23PeakCurrent_TypeDef#

EMU_DcdcBoostEM23PeakCurrent_TypeDef

DCDC Boost EM23 peak current setting.

EMU_VScaleEM01_TypeDef#

EMU_VScaleEM01_TypeDef

Supported EM0/1 Voltage Scaling Levels.

EMU_VScaleEM23_TypeDef#

EMU_VScaleEM23_TypeDef

Supported EM2/3 Voltage Scaling Levels.

EMU_TempAvgNum_TypeDef#

EMU_TempAvgNum_TypeDef

Number of samples to use for temperature averaging.

EMU_EM01Init#

void EMU_EM01Init (const EMU_EM01Init_TypeDef * em01Init)

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

EMU_EM23Init#

void EMU_EM23Init (const EMU_EM23Init_TypeDef * em23Init)

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

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_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_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.

• This function is incompatible with the Power Manager module. When the Power Manager module is present, it must be the one deciding at which EM level the device sleeps to ensure the application properly works. Using both at the same time could lead to undefined behavior in the application.

• 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.

• 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.

• This function is incompatible with the Power Manager module. When the Power Manager module is present, it must be the one deciding at which EM level the device sleeps to ensure the application properly works. Using both at the same time could lead to undefined behavior in the application.

• 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.

• 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_EM4Init#

void EMU_EM4Init (const EMU_EM4Init_TypeDef * em4Init)

Update the EMU module with Energy Mode 4 configuration.

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_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_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_EnterEM4Wait#

void EMU_EnterEM4Wait (void )

Enter energy mode 4 (EM4).

This function waits after the EM4 entry request to make sure the CPU is properly shutdown or the EM4 entry failed.

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.

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.

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.

EMU_VScaleEM01ByClock#

void EMU_VScaleEM01ByClock (uint32_t clockFrequency, bool wait)

Voltage scale in EM0 and 1 by clock frequency.

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.

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_DCDCModeSet#

sl_status_t EMU_DCDCModeSet (EMU_DcdcMode_TypeDef dcdcMode)

Set DCDC regulator operating mode.

Returns

• Returns the status of the DCDC mode set operation.

  *   SL_STATUS_OK - Operation completed successfully.
  *   SL_STATUS_TIMEOUT - Operation EMU DCDC set mode timeout.
  * 

EMU_DCDCUpdatedHook#

void EMU_DCDCUpdatedHook (void )

Indicate that the DCDC peripheral bus clock enable has changed allowing RAIL to react accordingly.

This function is called after DCDC has been enabled or disabled. The function implementation does not perform anything, but it is SL_WEAK so that it can use the RAIL version if needed.

EMU_DCDCBoostInit#

bool EMU_DCDCBoostInit (const EMU_DCDCBoostInit_TypeDef * dcdcBoostInit)

Configure the DCDC Boost regulator.

Returns

• True if initialization parameters are valid.

EMU_EM01BoostPeakCurrentSet#

void EMU_EM01BoostPeakCurrentSet (const EMU_DcdcBoostEM01PeakCurrent_TypeDef boostPeakCurrentEM01)

Set EM01 mode Boost Peak Current setting.

EMU_BoostExternalShutdownEnable#

void EMU_BoostExternalShutdownEnable (bool enable)

Enable/disable Boost External Shutdown Mode.

EMU_TemperatureGet#

float EMU_TemperatureGet (void )

Get temperature in degrees Celsius.

Returns

• Temperature in degrees Celsius

EMU_EFPDirectModeEnable#

void EMU_EFPDirectModeEnable (bool enable)

Enable/disable EFP 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.

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.

EMU_DCDCLock#

void EMU_DCDCLock (void )

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

EMU_DCDCUnlock#

void EMU_DCDCUnlock (void )

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

EMU_DCDCSync#

void EMU_DCDCSync (uint32_t mask)

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

EMU_EnterEM1#

void EMU_EnterEM1 (void )

Enter energy mode 1 (EM1).

Note

• This function is incompatible with the Power Manager module. When the Power Manager module is present, it must be the one deciding at which EM level the device sleeps to ensure the application properly works. Using both at the same time could lead to undefined behavior in the application.

EMU_VScaleWait#

void EMU_VScaleWait (void )

Wait for voltage scaling to complete.

EMU_VScaleGet#

EMU_VScaleEM01_TypeDef EMU_VScaleGet (void )

Get current voltage scaling level.

Returns

• Current voltage scaling level.

EMU_IntClear#

void EMU_IntClear (uint32_t flags)

Clear one or more pending EMU interrupts.

EMU_IntDisable#

void EMU_IntDisable (uint32_t flags)

Disable one or more EMU interrupts.

EMU_IntEnable#

void EMU_IntEnable (uint32_t flags)

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.

EMU_EFPIntDisable#

void EMU_EFPIntDisable (uint32_t flags)

Disable one or more EFP interrupts.

EMU_EFPIntEnable#

void EMU_EFPIntEnable (uint32_t flags)

Enable one or more EFP interrupts.

EMU_EFPIntGet#

uint32_t EMU_EFPIntGet (void )

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_EFPIntGetEnabled#

uint32_t EMU_EFPIntGetEnabled (void )

Get enabled and pending EMU EFP 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 EFP interrupt sources Return value is the bitwise AND of

  • the enabled interrupt sources in EMU_EFPIEN and

  • the pending interrupt flags EMU_EFPIF.

EMU_EFPIntSet#

void EMU_EFPIntSet (uint32_t flags)

Set one or more pending EMU EFP interrupts.

EMU_EFPIntClear#

void EMU_EFPIntClear (uint32_t flags)

Clear one or more pending EMU EFP interrupts.

EMU_IntGet#

uint32_t EMU_IntGet (void )

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 )

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)

Set one or more pending EMU interrupts.

EMU_Lock#

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.

EMU_Unlock#

void EMU_Unlock (void )

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

EMU_UnlatchPinRetention#

void EMU_UnlatchPinRetention (void )

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 )

Temperature measurement ready status.

Returns

• True if temperature measurement is ready

EMU_TemperatureAvgGet#

float EMU_TemperatureAvgGet (void )

Get averaged temperature in degrees Celsius.

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)

Request averaged temperature.

Note

• EMU must be unlocked by calling EMU_Unlock() before this function can be called.

EMU_VSCALE_PRESENT#

#define EMU_VSCALE_PRESENT

Voltage scaling present.

EMU_VSCALE_EM01_PRESENT#

#define EMU_VSCALE_EM01_PRESENT

Voltage scaling for EM01 present.

EMU_SERIES2_DCDC_BOOST_PRESENT#

#define EMU_SERIES2_DCDC_BOOST_PRESENT

DC-DC boost converter present.

EMU_EM01INIT_DEFAULT#

#define EMU_EM01INIT_DEFAULT

Default initialization of EM0 and 1 configuration.

EMU_EM23INIT_DEFAULT#

#define EMU_EM23INIT_DEFAULT

Default initialization of EM2 and 3 configuration.

EMU_EM4INIT_DEFAULT#

#define EMU_EM4INIT_DEFAULT

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

EMU_DCDCBOOSTINIT_DEFAULT#

#define EMU_DCDCBOOSTINIT_DEFAULT

Default DCDC Boost initialization.

EMU_TEMP_ZERO_C_IN_KELVIN#

#define EMU_TEMP_ZERO_C_IN_KELVIN

(273.15f)

Zero degrees Celcius in Kelvin.