EFM32 Pearl Gecko Software Documentation  efm32pg1-doc-4.2.1
em_emu.h File Reference

Energy management unit (EMU) peripheral API. More...

#include "em_device.h"
#include <stdbool.h>
#include "em_bus.h"

Go to the source code of this file.

Data Structures

struct  EMU_EM23Init_TypeDef
 
struct  EMU_EM4Init_TypeDef
 
struct  EMU_DCDCInit_TypeDef
 
struct  EMU_VmonInit_TypeDef
 
struct  EMU_VmonHystInit_TypeDef
 

Macros

#define EMU_EM23INIT_DEFAULT   { false } /* Reduced voltage regulator drive strength in EM2 and EM3 */
 
#define EMU_EM4INIT_DEFAULT
 
#define EMU_DCDCINIT_DEFAULT
 
#define EMU_VMONINIT_DEFAULT
 
#define EMU_VMONHYSTINIT_DEFAULT
 

Enumerations

enum  EMU_BODMode_TypeDef {
  emuBODMode_Active,
  emuBODMode_Inactive
}
 
enum  EMU_EM4State_TypeDef {
  emuEM4Hibernate = EMU_EM4CTRL_EM4STATE_EM4H,
  emuEM4Shutoff = EMU_EM4CTRL_EM4STATE_EM4S
}
 
enum  EMU_EM4PinRetention_TypeDef {
  emuPinRetentionDisable = EMU_EM4CTRL_EM4IORETMODE_DISABLE,
  emuPinRetentionEm4Exit = EMU_EM4CTRL_EM4IORETMODE_EM4EXIT,
  emuPinRetentionLatch = EMU_EM4CTRL_EM4IORETMODE_SWUNLATCH
}
 
enum  EMU_PowerConfig_TypeDef { emuPowerConfig_DcdcToDvdd = EMU_PWRCFG_PWRCFG_DCDCTODVDD }
 
enum  EMU_DcdcMode_TypeDef {
  emuDcdcMode_Bypass = EMU_DCDCCTRL_DCDCMODE_BYPASS,
  emuDcdcMode_LowNoise = EMU_DCDCCTRL_DCDCMODE_LOWNOISE
}
 
enum  EMU_DcdcAnaPeripheralPower_TypeDef {
  emuDcdcAnaPeripheralPower_AVDD = EMU_PWRCTRL_ANASW_AVDD,
  emuDcdcAnaPeripheralPower_DCDC = EMU_PWRCTRL_ANASW_DVDD
}
 
enum  EMU_DcdcLnTransientMode_TypeDef {
  emuDcdcLnHighEfficiency = 0,
  emuDcdcLnFastTransient = EMU_DCDCMISCCTRL_LNFORCECCM
}
 
enum  EMU_DcdcLnRcoBand_TypeDef {
  EMU_DcdcLnRcoBand_3MHz = 0,
  EMU_DcdcLnRcoBand_4MHz = 1,
  EMU_DcdcLnRcoBand_5MHz = 2,
  EMU_DcdcLnRcoBand_6MHz = 3,
  EMU_DcdcLnRcoBand_7MHz = 4,
  EMU_DcdcLnRcoBand_8MHz = 5,
  EMU_DcdcLnRcoBand_9MHz = 6,
  EMU_DcdcLnRcoBand_10MHz = 7
}
 
enum  EMU_VmonChannel_TypeDef {
  emuVmonChannel_AVDD,
  emuVmonChannel_ALTAVDD,
  emuVmonChannel_DVDD,
  emuVmonChannel_IOVDD0
}
 

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...
 
bool EMU_DCDCInit (EMU_DCDCInit_TypeDef *dcdcInit)
 Configure DCDC regulator. More...
 
void EMU_DCDCModeSet (EMU_DcdcMode_TypeDef dcdcMode)
 Set DCDC regulator operating mode. More...
 
bool EMU_DCDCOutputVoltageSet (uint32_t mV, bool setLpVoltage, bool setLnVoltage)
 Set DCDC output voltage. More...
 
void EMU_DCDCOptimizeSlice (uint32_t mAEm0LoadCurrent)
 Optimize DCDC slice count based on the estimated average load current in EM0. More...
 
void EMU_DCDCLnRcoBandSet (EMU_DcdcLnRcoBand_TypeDef band)
 Set DCDC Low-noise RCO band. More...
 
bool EMU_DCDCPowerOff (void)
 Power off the DCDC regulator. More...
 
void EMU_VmonInit (EMU_VmonInit_TypeDef *vmonInit)
 Initialize VMON channel. More...
 
void EMU_VmonHystInit (EMU_VmonHystInit_TypeDef *vmonInit)
 Initialize VMON channel with hysteresis (separate rise and fall triggers). More...
 
void EMU_VmonEnable (EMU_VmonChannel_TypeDef channel, bool enable)
 Enable or disable a VMON channel. More...
 
bool EMU_VmonChannelStatusGet (EMU_VmonChannel_TypeDef channel)
 Get the status of a voltage monitor channel. More...
 
__STATIC_INLINE bool EMU_VmonStatusGet (void)
 Get the status of the voltage monitor (VMON). 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_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_PowerLock (void)
 Lock the EMU regulator control registers in order to protect against unintended modification.
 
__STATIC_INLINE void EMU_PowerUnlock (void)
 Unlock the EMU power control registers 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.
 
__STATIC_INLINE 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 the initialization is done, this function can release pins and return control to the peripherals or GPIO.
 

Detailed Description

Version
4.2.1

License

(C) Copyright 2015 Silicon Labs, http://www.silabs.com

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.
  2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.

DISCLAIMER OF WARRANTY/LIMITATION OF REMEDIES: Silicon Labs has no obligation to support this Software. Silicon Labs is providing the Software "AS IS", with no express or implied warranties of any kind, including, but not limited to, any implied warranties of merchantability or fitness for any particular purpose or warranties against infringement of any proprietary rights of a third party.

Silicon Labs will not be liable for any consequential, incidental, or special damages, or any other relief, or for any claim by any third party, arising from your use of this Software.

Definition in file em_emu.h.