EMU - Energy Management Unit#
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.
Modules#
Enumerations#
BOD threshold setting selector, active or inactive mode.
EM4 Pin Retention Type.
DCDC mode.
VREGIN comparator threshold.
DCDC Buck Ton max timeout.
DCDC Buck drive speed.
DCDC Buck peak current setting.
Supported EM0/1 Voltage Scaling Levels.
Supported EM2/3 Voltage Scaling Levels.
Number of samples to use for temperature averaging.
Functions#
Update the EMU module with Energy Mode 0 and 1 configuration.
Update the EMU module with Energy Mode 2 and 3 configuration.
Energy mode 2/3 pre-sleep hook function.
Energy mode 2/3 post-sleep hook function.
EFP's Energy mode 2/3 pre-sleep hook function.
EFP's Energy mode 2/3 post-sleep hook function.
Enter energy mode 2 (EM2).
Enter energy mode 3 (EM3).
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.
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.
Update the EMU module with Energy Mode 4 configuration.
Energy mode 4 pre-sleep hook function.
EFP's Energy mode 4 pre-sleep hook function.
Enter energy mode 4 (EM4).
Enter energy mode 4 (EM4).
Enter energy mode 4 hibernate (EM4H).
Enter energy mode 4 shutoff (EM4S).
Power down memory block.
Power down RAM memory blocks.
Power up all available RAM memory blocks.
Update EMU module with CMU oscillator selection/enable status.
Energy mode 01 voltage scaling hook function.
Voltage scale in EM0 and 1 by clock frequency.
Force voltage scaling in EM0 and 1 to a specific voltage level.
Set DCDC regulator operating mode.
Indicate that the DCDC peripheral bus clock enable has changed allowing RAIL to react accordingly.
Configure the DCDC regulator.
Power off the DCDC regulator.
Set EMO1 mode Peak Current setting.
Set PFMX mode Peak Current setting.
Set Ton_max timeout control.
Get temperature in degrees Celsius.
Enable/disable EFP Direct Mode.
Set to enable EFP to drive Decouple voltage.
Set to enable EFP to drive DVDD voltage.
Lock DCDC registers in order to protect them against unintended modification.
Unlock the DCDC so that writing to locked registers again is possible.
Wait for the DCDC to complete all synchronization of register changes.
Enter energy mode 1 (EM1).
Wait for voltage scaling to complete.
Get current voltage scaling level.
Clear one or more pending EMU interrupts.
Disable one or more EMU interrupts.
Enable one or more EMU interrupts.
Disable one or more EFP interrupts.
Enable one or more EFP interrupts.
Get pending EMU EFP interrupt flags.
Get enabled and pending EMU EFP interrupt flags.
Set one or more pending EMU EFP interrupts.
Clear one or more pending EMU EFP interrupts.
Get pending EMU interrupt flags.
Get enabled and pending EMU interrupt flags.
Set one or more pending EMU interrupts.
Lock EMU registers in order to protect them against unintended modification.
Unlock the EMU so that writing to locked registers again is possible.
When EM4 pin retention is set to emuPinRetentionLatch, then pins are retained through EM4 entry and wakeup.
Temperature measurement ready status.
Get averaged temperature in degrees Celsius.
Request averaged temperature.
Macros#
Voltage scaling present.
Voltage scaling for EM01 present.
DC-DC buck converter present.
Default initialization of EM0 and 1 configuration.
Default initialization of EM2 and 3 configuration.
Default initialization of EM4 configuration (Series 1 without VSCALE).
Default DCDC Buck initialization.
Zero degrees Celcius in Kelvin.
Enumeration Documentation#
EMU_BODMode_TypeDef#
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. |
201
of file platform/emlib/inc/em_emu.h
EMU_EM4State_TypeDef#
EMU_EM4State_TypeDef
EM4 modes.
Enumerator | |
---|---|
emuEM4Shutoff | EM4 Shutoff. |
emuEM4Hibernate | EM4 Hibernate. |
209
of file platform/emlib/inc/em_emu.h
EMU_EM4PinRetention_TypeDef#
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. |
218
of file platform/emlib/inc/em_emu.h
EMU_PowerConfig_TypeDef#
EMU_PowerConfig_TypeDef
Power configurations.
DCDC-to-DVDD is currently the only supported mode.
Enumerator | |
---|---|
emuPowerConfig_DcdcToDvdd | DCDC is connected to DVDD. |
230
of file platform/emlib/inc/em_emu.h
EMU_DcdcMode_TypeDef#
EMU_DcdcMode_TypeDef
DCDC mode.
Enumerator | |
---|---|
emuDcdcMode_Bypass | DCDC regulator bypass. |
emuDcdcMode_Regulation | DCDC regulator on. |
337
of file platform/emlib/inc/em_emu.h
EMU_VreginCmpThreshold_TypeDef#
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. |
345
of file platform/emlib/inc/em_emu.h
EMU_DcdcTonMaxTimeout_TypeDef#
EMU_DcdcTonMaxTimeout_TypeDef
DCDC Buck 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. |
353
of file platform/emlib/inc/em_emu.h
EMU_DcdcDriveSpeed_TypeDef#
EMU_DcdcDriveSpeed_TypeDef
DCDC Buck drive speed.
Enumerator | |
---|---|
emuDcdcDriveSpeed_BestEmi | Recommend no options other than DEFAULT be used here, as there is no benefit. |
emuDcdcDriveSpeed_Default | Recommend no options other than DEFAULT be used here, as there is no benefit. |
emuDcdcDriveSpeed_Intermediate | Recommend no options other than DEFAULT be used here, as there is no benefit. |
emuDcdcDriveSpeed_BestEfficiency | Recommend no options other than DEFAULT be used here, as there is no benefit. |
402
of file platform/emlib/inc/em_emu.h
EMU_DcdcPeakCurrent_TypeDef#
EMU_DcdcPeakCurrent_TypeDef
DCDC Buck peak current setting.
Enumerator | |
---|---|
emuDcdcPeakCurrent_Load5mA | Load 5mA, peak current 90mA. |
emuDcdcPeakCurrent_Load10mA | Load 10mA, peak current 150mA. |
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. |
410
of file platform/emlib/inc/em_emu.h
EMU_VScaleEM01_TypeDef#
EMU_VScaleEM01_TypeDef
Supported EM0/1 Voltage Scaling Levels.
Enumerator | |
---|---|
emuVScaleEM01_HighPerformance | High-performance voltage level. |
emuVScaleEM01_LowPower | Low-power optimized voltage level. |
536
of file platform/emlib/inc/em_emu.h
EMU_VScaleEM23_TypeDef#
EMU_VScaleEM23_TypeDef
Supported EM2/3 Voltage Scaling Levels.
Enumerator | |
---|---|
emuVScaleEM23_FastWakeup | Fast-wakeup voltage level. |
emuVScaleEM23_LowPower | Low-power optimized voltage level. |
555
of file platform/emlib/inc/em_emu.h
EMU_TempAvgNum_TypeDef#
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. |
698
of file platform/emlib/inc/em_emu.h
Function Documentation#
EMU_EM01Init#
void EMU_EM01Init (const EMU_EM01Init_TypeDef * em01Init)
Update the EMU module with Energy Mode 0 and 1 configuration.
[in] | em01Init | Energy Mode 0 and 1 configuration structure. |
789
of file platform/emlib/src/em_emu.c
EMU_EM23Init#
void EMU_EM23Init (const EMU_EM23Init_TypeDef * em23Init)
Update the EMU module with Energy Mode 2 and 3 configuration.
[in] | em23Init | Energy Mode 2 and 3 configuration structure. |
804
of file platform/emlib/src/em_emu.c
EMU_EM23PresleepHook#
void EMU_EM23PresleepHook (void )
Energy mode 2/3 pre-sleep hook function.
N/A |
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.
838
of file platform/emlib/src/em_emu.c
EMU_EM23PostsleepHook#
void EMU_EM23PostsleepHook (void )
Energy mode 2/3 post-sleep hook function.
N/A |
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.
870
of file platform/emlib/src/em_emu.c
EMU_EFPEM23PresleepHook#
void EMU_EFPEM23PresleepHook (void )
EFP's Energy mode 2/3 pre-sleep hook function.
N/A |
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.
856
of file platform/emlib/src/em_emu.c
EMU_EFPEM23PostsleepHook#
void EMU_EFPEM23PostsleepHook (void )
EFP's Energy mode 2/3 post-sleep hook function.
N/A |
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.
888
of file platform/emlib/src/em_emu.c
EMU_EnterEM2#
void EMU_EnterEM2 (bool restore)
Enter energy mode 2 (EM2).
[in] | restore |
|
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.
962
of file platform/emlib/src/em_emu.c
EMU_EnterEM3#
void EMU_EnterEM3 (bool restore)
Enter energy mode 3 (EM3).
[in] | restore |
|
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.
1165
of file platform/emlib/src/em_emu.c
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.
N/A |
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().
1330
of file platform/emlib/src/em_emu.c
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.
N/A |
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.
1351
of file platform/emlib/src/em_emu.c
EMU_EM4Init#
void EMU_EM4Init (const EMU_EM4Init_TypeDef * em4Init)
Update the EMU module with Energy Mode 4 configuration.
[in] | em4Init | Energy Mode 4 configuration structure. |
1371
of file platform/emlib/src/em_emu.c
EMU_EM4PresleepHook#
void EMU_EM4PresleepHook (void )
Energy mode 4 pre-sleep hook function.
N/A |
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.
1435
of file platform/emlib/src/em_emu.c
EMU_EFPEM4PresleepHook#
void EMU_EFPEM4PresleepHook (void )
EFP's Energy mode 4 pre-sleep hook function.
N/A |
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.
1453
of file platform/emlib/src/em_emu.c
EMU_EnterEM4#
void EMU_EnterEM4 (void )
Enter energy mode 4 (EM4).
N/A |
Note
Only a power on reset or external reset pin can wake the device from EM4.
1464
of file platform/emlib/src/em_emu.c
EMU_EnterEM4Wait#
void EMU_EnterEM4Wait (void )
Enter energy mode 4 (EM4).
N/A |
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.
1605
of file platform/emlib/src/em_emu.c
EMU_EnterEM4H#
void EMU_EnterEM4H (void )
Enter energy mode 4 hibernate (EM4H).
N/A |
Note
Retention of clocks and GPIO in EM4 can be configured using EMU_EM4Init before calling this function.
1625
of file platform/emlib/src/em_emu.c
EMU_EnterEM4S#
void EMU_EnterEM4S (void )
Enter energy mode 4 shutoff (EM4S).
N/A |
Note
Retention of clocks and GPIO in EM4 can be configured using EMU_EM4Init before calling this function.
1641
of file platform/emlib/src/em_emu.c
EMU_MemPwrDown#
void EMU_MemPwrDown (uint32_t blocks)
Power down memory block.
[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.
1667
of file platform/emlib/src/em_emu.c
EMU_RamPowerDown#
void EMU_RamPowerDown (uint32_t start, uint32_t end)
Power down RAM memory blocks.
[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. |
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.
1714
of file platform/emlib/src/em_emu.c
EMU_RamPowerUp#
void EMU_RamPowerUp (void )
Power up all available RAM memory blocks.
N/A |
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.
1807
of file platform/emlib/src/em_emu.c
EMU_UpdateOscConfig#
void EMU_UpdateOscConfig (void )
Update EMU module with CMU oscillator selection/enable status.
N/A |
1857
of file platform/emlib/src/em_emu.c
EMU_EFPEM01VScale#
void EMU_EFPEM01VScale (EMU_VScaleEM01_TypeDef voltage)
Energy mode 01 voltage scaling hook function.
[in] | voltage | Voltage scaling level requested. |
This function is called by EMU_VScaleEM01 to let EFP know that voltage scaling is requested.
1876
of file platform/emlib/src/em_emu.c
EMU_VScaleEM01ByClock#
void EMU_VScaleEM01ByClock (uint32_t clockFrequency, bool wait)
Voltage scale in EM0 and 1 by clock frequency.
[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.
1897
of file platform/emlib/src/em_emu.c
EMU_VScaleEM01#
void EMU_VScaleEM01 (EMU_VScaleEM01_TypeDef voltage, bool wait)
Force voltage scaling in EM0 and 1 to a specific voltage level.
[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().
1950
of file platform/emlib/src/em_emu.c
EMU_DCDCModeSet#
sl_status_t EMU_DCDCModeSet (EMU_DcdcMode_TypeDef dcdcMode)
Set DCDC regulator operating mode.
[in] | dcdcMode | DCDC 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. *
3460
of file platform/emlib/src/em_emu.c
EMU_DCDCUpdatedHook#
void EMU_DCDCUpdatedHook (void )
Indicate that the DCDC peripheral bus clock enable has changed allowing RAIL to react accordingly.
N/A |
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.
3443
of file platform/emlib/src/em_emu.c
EMU_DCDCInit#
bool EMU_DCDCInit (const EMU_DCDCInit_TypeDef * dcdcInit)
Configure the DCDC regulator.
[in] | dcdcInit | The DCDC initialization structure. |
Returns
True if initialization parameters are valid.
3538
of file platform/emlib/src/em_emu.c
EMU_DCDCPowerOff#
bool EMU_DCDCPowerOff (void )
Power off the DCDC regulator.
N/A |
Returns
Returns true.
3592
of file platform/emlib/src/em_emu.c
EMU_EM01PeakCurrentSet#
void EMU_EM01PeakCurrentSet (const EMU_DcdcPeakCurrent_TypeDef peakCurrentEM01)
Set EMO1 mode Peak Current setting.
[in] | peakCurrentEM01 | Peak load current coefficient in EM01 mode. |
3605
of file platform/emlib/src/em_emu.c
EMU_DCDCSetPFMXModePeakCurrent#
void EMU_DCDCSetPFMXModePeakCurrent (uint32_t value)
Set PFMX mode Peak Current setting.
[in] | value | Peak load current coefficient in PFMX mode. |
3659
of file platform/emlib/src/em_emu.c
EMU_DCDCSetPFMXTimeoutMaxCtrl#
void EMU_DCDCSetPFMXTimeoutMaxCtrl (EMU_DcdcTonMaxTimeout_TypeDef value)
Set Ton_max timeout control.
[in] | value | Maximum time for peak current detection. |
3705
of file platform/emlib/src/em_emu.c
EMU_TemperatureGet#
float EMU_TemperatureGet (void )
Get temperature in degrees Celsius.
N/A |
Returns
Temperature in degrees Celsius
4147
of file platform/emlib/src/em_emu.c
EMU_EFPDirectModeEnable#
void EMU_EFPDirectModeEnable (bool enable)
Enable/disable EFP Direct Mode.
[in] | enable | True to enable direct mode. |
4185
of file platform/emlib/src/em_emu.c
EMU_EFPDriveDecoupleSet#
void EMU_EFPDriveDecoupleSet (bool enable)
Set to enable EFP to drive Decouple voltage.
[in] | enable | True 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.
4209
of file platform/emlib/src/em_emu.c
EMU_EFPDriveDvddSet#
void EMU_EFPDriveDvddSet (bool enable)
Set to enable EFP to drive DVDD voltage.
[in] | enable | True 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.
4231
of file platform/emlib/src/em_emu.c
EMU_DCDCLock#
void EMU_DCDCLock (void )
Lock DCDC registers in order to protect them against unintended modification.
N/A |
1251
of file platform/emlib/inc/em_emu.h
EMU_DCDCUnlock#
void EMU_DCDCUnlock (void )
Unlock the DCDC so that writing to locked registers again is possible.
N/A |
1262
of file platform/emlib/inc/em_emu.h
EMU_DCDCSync#
void EMU_DCDCSync (uint32_t mask)
Wait for the DCDC to complete all synchronization of register changes.
[in] | mask | A bitmask corresponding to SYNCBUSY register defined bits indicating registers that must complete any ongoing synchronization. |
1277
of file platform/emlib/inc/em_emu.h
EMU_EnterEM1#
void EMU_EnterEM1 (void )
Enter energy mode 1 (EM1).
N/A |
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.
1313
of file platform/emlib/inc/em_emu.h
EMU_VScaleWait#
void EMU_VScaleWait (void )
Wait for voltage scaling to complete.
N/A |
1325
of file platform/emlib/inc/em_emu.h
EMU_VScaleGet#
EMU_VScaleEM01_TypeDef EMU_VScaleGet (void )
Get current voltage scaling level.
N/A |
Returns
Current voltage scaling level.
1347
of file platform/emlib/inc/em_emu.h
EMU_IntClear#
void EMU_IntClear (uint32_t flags)
Clear one or more pending EMU interrupts.
[in] | flags | Pending EMU interrupt sources to clear. Use one or more valid interrupt flags for the EMU module (EMU_IFC_nnn or EMU_IF_nnn). |
1380
of file platform/emlib/inc/em_emu.h
EMU_IntDisable#
void EMU_IntDisable (uint32_t flags)
Disable one or more EMU interrupts.
[in] | flags | EMU interrupt sources to disable. Use one or more valid interrupt flags for the EMU module (EMU_IEN_nnn). |
1397
of file platform/emlib/inc/em_emu.h
EMU_IntEnable#
void EMU_IntEnable (uint32_t flags)
Enable one or more EMU interrupts.
[in] | flags | EMU interrupt sources to enable. Use one or more valid interrupt flags for the EMU module (EMU_IEN_nnn). |
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.
1419
of file platform/emlib/inc/em_emu.h
EMU_EFPIntDisable#
void EMU_EFPIntDisable (uint32_t flags)
Disable one or more EFP interrupts.
[in] | flags | EFP interrupt sources to disable. Use one or more valid interrupt flags for the EFP module (EFPIENnnn). |
1437
of file platform/emlib/inc/em_emu.h
EMU_EFPIntEnable#
void EMU_EFPIntEnable (uint32_t flags)
Enable one or more EFP interrupts.
[in] | flags | EFP interrupt sources to enable. Use one or more valid interrupt flags for the EFP module (EFPIENnnn). |
1450
of file platform/emlib/inc/em_emu.h
EMU_EFPIntGet#
uint32_t EMU_EFPIntGet (void )
Get pending EMU EFP interrupt flags.
N/A |
Note
Event bits are not cleared by the use of this function.
Returns
EMU EFP interrupt sources pending. .
1465
of file platform/emlib/inc/em_emu.h
EMU_EFPIntGetEnabled#
uint32_t EMU_EFPIntGetEnabled (void )
Get enabled and pending EMU EFP interrupt flags.
N/A |
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.
1484
of file platform/emlib/inc/em_emu.h
EMU_EFPIntSet#
void EMU_EFPIntSet (uint32_t flags)
Set one or more pending EMU EFP interrupts.
[in] | flags | EMU EFP interrupt sources to set to pending. Use one or more valid interrupt flags for the EMU EFP module (EMU_EFPIFSnnn). |
1500
of file platform/emlib/inc/em_emu.h
EMU_EFPIntClear#
void EMU_EFPIntClear (uint32_t flags)
Clear one or more pending EMU EFP interrupts.
[in] | flags | Pending EMU EFP interrupt sources to clear. Use one or more valid interrupt flags for the EMU EFP module. |
1513
of file platform/emlib/inc/em_emu.h
EMU_IntGet#
uint32_t EMU_IntGet (void )
Get pending EMU interrupt flags.
N/A |
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).
1530
of file platform/emlib/inc/em_emu.h
EMU_IntGetEnabled#
uint32_t EMU_IntGetEnabled (void )
Get enabled and pending EMU interrupt flags.
N/A |
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.
1549
of file platform/emlib/inc/em_emu.h
EMU_IntSet#
void EMU_IntSet (uint32_t flags)
Set one or more pending EMU interrupts.
[in] | flags | EMU interrupt sources to set to pending. Use one or more valid interrupt flags for the EMU module (EMU_IFS_nnn). |
1565
of file platform/emlib/inc/em_emu.h
EMU_Lock#
void EMU_Lock (void )
Lock EMU registers in order to protect them against unintended modification.
N/A |
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.
1625
of file platform/emlib/inc/em_emu.h
EMU_Unlock#
void EMU_Unlock (void )
Unlock the EMU so that writing to locked registers again is possible.
N/A |
1634
of file platform/emlib/inc/em_emu.h
EMU_UnlatchPinRetention#
void EMU_UnlatchPinRetention (void )
When EM4 pin retention is set to emuPinRetentionLatch, then pins are retained through EM4 entry and wakeup.
N/A |
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.
1690
of file platform/emlib/inc/em_emu.h
EMU_TemperatureReady#
bool EMU_TemperatureReady (void )
Temperature measurement ready status.
N/A |
Returns
True if temperature measurement is ready
1706
of file platform/emlib/inc/em_emu.h
EMU_TemperatureAvgGet#
float EMU_TemperatureAvgGet (void )
Get averaged temperature in degrees Celsius.
N/A |
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
1728
of file platform/emlib/inc/em_emu.h
EMU_TemperatureAvgRequest#
void EMU_TemperatureAvgRequest (EMU_TempAvgNum_TypeDef numSamples)
Request averaged temperature.
[in] | numSamples | Number of temperature samples to average |
Note
EMU must be unlocked by calling EMU_Unlock() before this function can be called.
1746
of file platform/emlib/inc/em_emu.h
Macro Definition Documentation#
EMU_VSCALE_PRESENT#
#define EMU_VSCALE_PRESENT
Voltage scaling present.
58
of file platform/emlib/inc/em_emu.h
EMU_VSCALE_EM01_PRESENT#
#define EMU_VSCALE_EM01_PRESENT
Voltage scaling for EM01 present.
61
of file platform/emlib/inc/em_emu.h
EMU_SERIES2_DCDC_BUCK_PRESENT#
#define EMU_SERIES2_DCDC_BUCK_PRESENT
DC-DC buck converter present.
74
of file platform/emlib/inc/em_emu.h
EMU_EM01INIT_DEFAULT#
#define EMU_EM01INIT_DEFAULTValue:
Default initialization of EM0 and 1 configuration.
719
of file platform/emlib/inc/em_emu.h
EMU_EM23INIT_DEFAULT#
#define EMU_EM23INIT_DEFAULTValue:
Default initialization of EM2 and 3 configuration.
735
of file platform/emlib/inc/em_emu.h
EMU_EM4INIT_DEFAULT#
#define EMU_EM4INIT_DEFAULTValue:
Default initialization of EM4 configuration (Series 1 without VSCALE).
796
of file platform/emlib/inc/em_emu.h
EMU_DCDCINIT_DEFAULT#
#define EMU_DCDCINIT_DEFAULTValue:
Default DCDC Buck initialization.
938
of file platform/emlib/inc/em_emu.h
EMU_TEMP_ZERO_C_IN_KELVIN#
#define EMU_TEMP_ZERO_C_IN_KELVINValue:
(273.15f)
Zero degrees Celcius in Kelvin.
1698
of file platform/emlib/inc/em_emu.h