EFM32 Leopard Gecko Software Documentation
efm32lg-doc-4.2.1
|
Energy Management Unit (EMU) Peripheral API
. More...
Data Structures | |
struct | EMU_EM23Init_TypeDef |
struct | EMU_EM4Init_TypeDef |
struct | EMU_BUPDInit_TypeDef |
Macros | |
#define | EMU_EM23INIT_DEFAULT { false } /* Reduced voltage regulator drive strength in EM2 and EM3 */ |
#define | EMU_EM4INIT_DEFAULT |
#define | EMU_BUPDINIT_DEFAULT |
Enumerations | |
enum | EMU_EM4Osc_TypeDef { emuEM4Osc_ULFRCO = EMU_EM4CONF_OSC_ULFRCO, emuEM4Osc_LFXO = EMU_EM4CONF_OSC_LFXO, emuEM4Osc_LFRCO = EMU_EM4CONF_OSC_LFRCO } |
enum | EMU_Probe_TypeDef { emuProbe_Disable = EMU_BUCTRL_PROBE_DISABLE, emuProbe_VDDDReg = EMU_BUCTRL_PROBE_VDDDREG, emuProbe_BUIN = EMU_BUCTRL_PROBE_BUIN, emuProbe_BUOUT = EMU_BUCTRL_PROBE_BUOUT } |
enum | EMU_Resistor_TypeDef { emuRes_Res0 = EMU_PWRCONF_PWRRES_RES0, emuRes_Res1 = EMU_PWRCONF_PWRRES_RES1, emuRes_Res2 = EMU_PWRCONF_PWRRES_RES2, emuRes_Res3 = EMU_PWRCONF_PWRRES_RES3 } |
enum | EMU_Power_TypeDef { emuPower_None = EMU_BUINACT_PWRCON_NONE, emuPower_BUMain = EMU_BUINACT_PWRCON_BUMAIN, emuPower_MainBU = EMU_BUINACT_PWRCON_MAINBU, emuPower_NoDiode = EMU_BUINACT_PWRCON_NODIODE } |
enum | EMU_BODMode_TypeDef { emuBODMode_Active, emuBODMode_Inactive } |
Functions | |
__STATIC_INLINE void | EMU_EnterEM1 (void) |
Enter energy mode 1 (EM1). | |
void | EMU_EM23Init (EMU_EM23Init_TypeDef *em23Init) |
Update EMU module with Energy Mode 2 and 3 configuration. More... | |
void | EMU_EM4Init (EMU_EM4Init_TypeDef *em4Init) |
Update EMU module with Energy Mode 4 configuration. More... | |
void | EMU_EnterEM2 (bool restore) |
Enter energy mode 2 (EM2). More... | |
void | EMU_EnterEM3 (bool restore) |
Enter energy mode 3 (EM3). More... | |
void | EMU_EnterEM4 (void) |
Enter energy mode 4 (EM4). More... | |
void | EMU_MemPwrDown (uint32_t blocks) |
Power down memory block. More... | |
void | EMU_UpdateOscConfig (void) |
Update EMU module with CMU oscillator selection/enable status. More... | |
void | EMU_BUPDInit (EMU_BUPDInit_TypeDef *bupdInit) |
Configure Backup Power Domain settings. More... | |
void | EMU_BUThresholdSet (EMU_BODMode_TypeDef mode, uint32_t value) |
Configure Backup Power Domain BOD Threshold value. More... | |
void | EMU_BUThresRangeSet (EMU_BODMode_TypeDef mode, uint32_t value) |
Configure Backup Power Domain BOD Threshold Range. More... | |
__STATIC_INLINE void | EMU_IntClear (uint32_t flags) |
Clear one or more pending EMU interrupts. More... | |
__STATIC_INLINE void | EMU_IntDisable (uint32_t flags) |
Disable one or more EMU interrupts. More... | |
__STATIC_INLINE void | EMU_IntEnable (uint32_t flags) |
Enable one or more EMU interrupts. More... | |
__STATIC_INLINE uint32_t | EMU_IntGet (void) |
Get pending EMU interrupt flags. More... | |
__STATIC_INLINE uint32_t | EMU_IntGetEnabled (void) |
Get enabled and pending EMU interrupt flags. Useful for handling more interrupt sources in the same interrupt handler. More... | |
__STATIC_INLINE void | EMU_IntSet (uint32_t flags) |
Set one or more pending EMU interrupts. More... | |
__STATIC_INLINE void | EMU_EM4Lock (bool enable) |
Enable or disable EM4 lock configuration. More... | |
__STATIC_INLINE void | EMU_BUReady (void) |
Halts until backup power functionality is ready. | |
__STATIC_INLINE void | EMU_BUPinEnable (bool enable) |
Disable BU_VIN support. More... | |
__STATIC_INLINE void | EMU_Lock (void) |
Lock the EMU in order to protect its registers against unintended modification. More... | |
__STATIC_INLINE void | EMU_Unlock (void) |
Unlock the EMU so that writing to locked registers again is possible. | |
__STATIC_INLINE void | EMU_EM2Block (void) |
Block entering EM2 or higher number energy modes. | |
__STATIC_INLINE void | EMU_EM2UnBlock (void) |
Unblock entering EM2 or higher number energy modes. | |
#define EMU_EM23INIT_DEFAULT { false } /* Reduced voltage regulator drive strength in EM2 and EM3 */ |
#define EMU_EM4INIT_DEFAULT |
Default initialization of EM4 configuration
#define EMU_BUPDINIT_DEFAULT |
Default Backup Power Domain configuration
enum EMU_EM4Osc_TypeDef |
enum EMU_Probe_TypeDef |
enum EMU_Resistor_TypeDef |
Backup Power Domain resistor selection
enum EMU_Power_TypeDef |
Backup Power Domain power connection
enum EMU_BODMode_TypeDef |
void EMU_EM23Init | ( | EMU_EM23Init_TypeDef * | em23Init | ) |
[in] | em23Init | Energy Mode 2 and 3 configuration structure |
Definition at line 753 of file em_emu.c.
References EMU_EM23Init_TypeDef::em23VregFullEn, EMU, and EMU_CTRL_EMVREG.
void EMU_EM4Init | ( | EMU_EM4Init_TypeDef * | em4Init | ) |
[in] | em4Init | Energy Mode 4 configuration structure |
Definition at line 775 of file em_emu.c.
References _EMU_EM4CONF_BURTCWU_MASK, _EMU_EM4CONF_BURTCWU_SHIFT, _EMU_EM4CONF_LOCKCONF_MASK, _EMU_EM4CONF_LOCKCONF_SHIFT, _EMU_EM4CONF_OSC_MASK, _EMU_EM4CONF_VREGEN_MASK, _EMU_EM4CONF_VREGEN_SHIFT, EMU_EM4Init_TypeDef::buRtcWakeup, EMU, EMU_EM4Init_TypeDef::lockConfig, EMU_EM4Init_TypeDef::osc, and EMU_EM4Init_TypeDef::vreg.
void EMU_EnterEM2 | ( | bool | restore | ) |
When entering EM2, the high frequency clocks are disabled, ie 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!
restore
parameter. restore
parameter when waking up on the wakeup sources corresponding to the autostart and select setting.[in] | restore |
|
restore
option should only be used if all clock control is done via the CMU API. Definition at line 413 of file em_emu.c.
References CMU, CMU_STATUS_HFRCOSEL, and SystemCoreClockUpdate().
Referenced by CAPLESENSE_Sleep().
void EMU_EnterEM3 | ( | bool | restore | ) |
When entering EM3, the high frequency clocks are disabled by HW, ie HFXO, HFRCO and AUXHFRCO (for AUXHFRCO, see exception note below). In addition, the low frequency clocks, ie LFXO and LFRCO are disabled by SW. 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 another oscillator 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 SW. However, since handled by SW, it will not be restored before completing the interrupt function(s) waking up the core!
restore
parameter.[in] | restore |
|
restore
option should only be used if all clock control is done via the CMU API. Definition at line 529 of file em_emu.c.
References CMU, CMU_Lock(), CMU_LOCK_LOCKKEY_LOCKED, CMU_OSCENCMD_LFRCODIS, CMU_OSCENCMD_LFXODIS, CMU_STATUS_HFRCOSEL, CMU_Unlock(), and SystemCoreClockUpdate().
void EMU_EnterEM4 | ( | void | ) |
Definition at line 626 of file em_emu.c.
References _EMU_CTRL_EM4CTRL_MASK, _EMU_CTRL_EM4CTRL_SHIFT, EMU, and EMU_Unlock().
void EMU_MemPwrDown | ( | uint32_t | blocks | ) |
[in] | blocks | Specifies a logical OR of bits indicating memory blocks to power down. Bit 0 selects block 1, bit 1 selects block 2, etc. Memory block 0 cannot be disabled. Please refer to the reference manual for available memory blocks for a device. |
Definition at line 687 of file em_emu.c.
References EMU.
void EMU_UpdateOscConfig | ( | void | ) |
When entering EM2 and EM3, the HW may change the core clock oscillator used, as well as disabling some oscillators. The user may optionally select to restore the oscillators after waking up from EM2 and EM3 through the SW API.
However, in order to support this in a safe way, the EMU module must be kept up-to-date on the actual selected configuration. The CMU module must keep the EMU module up-to-date.
This function is mainly intended for internal use by the CMU module, but if the applications changes oscillator configurations without using the CMU API, this function can be used to keep the EMU module up-to-date.
Definition at line 736 of file em_emu.c.
References CMU.
Referenced by CMU_ClockSelectSet(), and CMU_OscillatorEnable().
void EMU_BUPDInit | ( | EMU_BUPDInit_TypeDef * | bupdInit | ) |
[in] | bupdInit | Backup power domain initialization structure |
Definition at line 827 of file em_emu.c.
References _EMU_BUACT_PWRCON_MASK, _EMU_BUCTRL_BODCAL_MASK, _EMU_BUCTRL_BODCAL_SHIFT, _EMU_BUCTRL_EN_MASK, _EMU_BUCTRL_EN_SHIFT, _EMU_BUCTRL_PROBE_MASK, _EMU_BUCTRL_STATEN_MASK, _EMU_BUCTRL_STATEN_SHIFT, _EMU_BUINACT_PWRCON_MASK, _EMU_PWRCONF_PWRRES_MASK, _EMU_PWRCONF_VOUTMED_MASK, _EMU_PWRCONF_VOUTMED_SHIFT, _EMU_PWRCONF_VOUTSTRONG_MASK, _EMU_PWRCONF_VOUTSTRONG_SHIFT, _EMU_PWRCONF_VOUTWEAK_MASK, _EMU_PWRCONF_VOUTWEAK_SHIFT, _RMU_CTRL_BURSTEN_SHIFT, EMU_BUPDInit_TypeDef::activePower, EMU_BUPDInit_TypeDef::bodCal, BUS_RegBitWrite(), EMU, EMU_BUPinEnable(), EMU_BUPDInit_TypeDef::enable, EMU_BUPDInit_TypeDef::inactivePower, EMU_BUPDInit_TypeDef::probe, EMU_BUPDInit_TypeDef::resistor, RMU, EMU_BUPDInit_TypeDef::statusPinEnable, EMU_BUPDInit_TypeDef::voutMed, EMU_BUPDInit_TypeDef::voutStrong, and EMU_BUPDInit_TypeDef::voutWeak.
void EMU_BUThresholdSet | ( | EMU_BODMode_TypeDef | mode, |
uint32_t | value | ||
) |
[in] | mode | Active or Inactive mode |
[in] | value |
Definition at line 886 of file em_emu.c.
References _EMU_BUACT_BUEXTHRES_MASK, _EMU_BUACT_BUEXTHRES_SHIFT, _EMU_BUINACT_BUENTHRES_MASK, _EMU_BUINACT_BUENTHRES_SHIFT, EMU, emuBODMode_Active, and emuBODMode_Inactive.
void EMU_BUThresRangeSet | ( | EMU_BODMode_TypeDef | mode, |
uint32_t | value | ||
) |
[in] | mode | Active or Inactive mode |
[in] | value |
Definition at line 913 of file em_emu.c.
References _EMU_BUACT_BUEXRANGE_MASK, _EMU_BUACT_BUEXRANGE_SHIFT, _EMU_BUINACT_BUENRANGE_MASK, _EMU_BUINACT_BUENRANGE_SHIFT, EMU, emuBODMode_Active, and emuBODMode_Inactive.
__STATIC_INLINE void EMU_IntClear | ( | uint32_t | flags | ) |
__STATIC_INLINE void EMU_IntDisable | ( | uint32_t | flags | ) |
__STATIC_INLINE void EMU_IntEnable | ( | uint32_t | flags | ) |
[in] | flags | EMU interrupt sources to enable. Use one or more valid interrupt flags for the EMU module (EMU_IEN_nnn). |
Definition at line 539 of file em_emu.h.
References EMU.
__STATIC_INLINE uint32_t EMU_IntGet | ( | void | ) |
__STATIC_INLINE uint32_t EMU_IntGetEnabled | ( | void | ) |
__STATIC_INLINE void EMU_IntSet | ( | uint32_t | flags | ) |
__STATIC_INLINE void EMU_EM4Lock | ( | bool | enable | ) |
[in] | enable | If true, locks down EM4 configuration |
Definition at line 607 of file em_emu.h.
References _EMU_EM4CONF_LOCKCONF_SHIFT, BUS_RegBitWrite(), and EMU.
__STATIC_INLINE void EMU_BUPinEnable | ( | bool | enable | ) |
[in] | enable | If true, enables BU_VIN input pin support, if false disables it |
Definition at line 632 of file em_emu.h.
References _EMU_ROUTE_BUVINPEN_SHIFT, BUS_RegBitWrite(), and EMU.
Referenced by EMU_BUPDInit().
__STATIC_INLINE void EMU_Lock | ( | void | ) |
Definition at line 650 of file em_emu.h.
References EMU, and EMU_LOCK_LOCKKEY_LOCK.
Referenced by RMU_ResetCauseClear().