SleepModes#

SleepModes

Enumerations for the possible microcontroller sleep modes.

• SLEEPMODE_RUNNING Everything is active and running. In practice this mode is not used, but it is defined for completeness of information.

• SLEEPMODE_IDLE Only the CPU is idled. The rest of the chip continues running normally. The chip will wake from any interrupt.

• SLEEPMODE_WAKETIMER The sleep timer clock sources remain running. The RC is always running and the 32kHz XTAL depends on the board header. Wakeup is possible from both GPIO and the sleep timer. System time is maintained. The sleep timer is assumed to be configured properly for wake events.

• SLEEPMODE_MAINTAINTIMER The sleep timer clock sources remain running. The RC is always running and the 32kHz XTAL depends on the board header. Wakeup is possible from only GPIO. System time is maintained. NOTE: This mode is not available on EM2XX chips.

• SLEEPMODE_NOTIMER The sleep timer clock sources (both RC and XTAL) are turned off. Wakeup is possible from only GPIO. System time is lost.

• SLEEPMODE_HIBERNATE This maps to EM4 Hibernate on the EFM32/EFR32 devices. RAM is not retained in SLEEPMODE_HIBERNATE so waking up from this sleepmode will behave like a reset. NOTE: This mode is only available on EFM32/EFR32

WakeEvents#

typedef uint32_t WakeEvents

WakeMask#

typedef uint32_t WakeMask

halCommonVreg1v8EnableCount#

volatile int8_t halCommonVreg1v8EnableCount

Helper variable to track the state of 1.8V regulator.

Note

• : Only used when DISABLE_INTERNAL_1V8_REGULATOR is defined.

halStackProcessBootCount#

void halStackProcessBootCount (void )

Called from emberInit and provides a means for the HAL to increment a boot counter, most commonly in non-volatile memory.

This is useful while debugging to determine the number of resets that might be seen over a period of time. Exposing this functionality allows the application to disable or alter processing of the boot counter if, for example, the application is expecting a lot of resets that could wear out non-volatile storage or some

• EmberStack Usage:\n Called from emberInit only as helpful debugging information.#

  This should be left enabled by default, but this function can also be reduced to a simple return statement if boot counting is not desired.

halGetResetInfo#

uint8_t halGetResetInfo (void )

Gets information about what caused the microcontroller to reset.

Returns

• A code identifying the cause of the reset.

halGetResetString#

PGM_P halGetResetString (void )

Calls halGetResetInfo() and supplies a string describing it.

• Application Usage:\n Useful for diagnostic printing of text just after program#

  initialization.

Returns

• A pointer to a program space string.

halInit#

void halInit (void )

Initializes microcontroller-specific peripherals.

halReboot#

void halReboot (void )

Restarts the microcontroller and therefore everything else.

halPowerUp#

void halPowerUp (void )

Powers up microcontroller peripherals and board peripherals.

halPowerDown#

void halPowerDown (void )

Powers down microcontroller peripherals and board peripherals.

halResume#

void halResume (void )

Resumes microcontroller peripherals and board peripherals.

halSuspend#

void halSuspend (void )

Suspends microcontroller peripherals and board peripherals.

halInternalEnableWatchDog#

void halInternalEnableWatchDog (void )

Enables the watchdog timer.

halInternalDisableWatchDog#

void halInternalDisableWatchDog (uint8_t magicKey)

Disables the watchdog timer.

Note

• To prevent the watchdog from being disabled accidentally, a magic key must be provided.

halInternalWatchDogEnabled#

bool halInternalWatchDogEnabled (void )

Determines whether the watchdog has been enabled or disabled.

Returns

• A bool value indicating if the watchdog is current enabled.

halSleep#

void halSleep (SleepModes sleepMode)

Puts the microcontroller to sleep in a specified mode.

Note

• This routine always enables interrupts.

See Also

• SleepModes

halSleepPreserveInts#

void halSleepPreserveInts (SleepModes sleepMode)

Same as halSleep() except it preserves the current interrupt state rather than always enabling interrupts prior to returning.

See Also

• SleepModes

halCommonDelayMicroseconds#

void halCommonDelayMicroseconds (uint16_t us)

Blocks the current thread of execution for the specified amount of time, in microseconds.

The function is implemented with cycle-counted busy loops and is intended to create the short delays required when interfacing with hardware peripherals.

The accuracy of the timing provided by this function is not specified, but a general rule is that when running off of a crystal oscillator it will be within 10us. If the micro is running off of another type of oscillator (e.g. RC) the timing accuracy will potentially be much worse.

halCommonDisableVreg1v8#

void halCommonDisableVreg1v8 (void )

Disable the 1.8V regulator. This function is to be used when the 1.8V supply is provided externally. Disabling the regulator saves current consumption. Disabling the regulator will cause ADC readings of external signals to be wrong. These exteranl signals include analog sources ADC0 thru ADC5 and VDD_PADS/4.

Note

• : Only used when DISABLE_INTERNAL_1V8_REGULATOR is defined.

halCommonEnableVreg1v8#

void halCommonEnableVreg1v8 (void )

Enable the 1.8V regulator. Normally the 1.8V regulator is enabled out of reset. This function is only needed if the 1.8V regulator has been disabled and ADC conversions on external signals are needed. These exteranl signals include analog sources ADC0 thru ADC5 and VDD_PADS/4. The state of 1v8 survives deep sleep.

Note

• : Only used when DISABLE_INTERNAL_1V8_REGULATOR is defined.

halBeforeEM4#

void halBeforeEM4 (uint32_t duration, RTCCRamData input)

halAfterEM4#

RTCCRamData halAfterEM4 (void )

halGetEm2xxResetInfo#

#define halGetEm2xxResetInfo

()

Calls ::halGetExtendedResetInfo() and translates the EM35x reset code to the corresponding value used by the EM2XX HAL. Any reset codes not present in the EM2XX are returned after being OR'ed with 0x80.

• Application Usage:\n Used by the EZSP host as a platform-independent NCP reset code.#

Returns

• The EM2XX-compatible reset code. If not supported by the EM2XX, return the platform-specific code with B7 set.

MICRO_DISABLE_WATCH_DOG_KEY#

#define MICRO_DISABLE_WATCH_DOG_KEY

0xA5U

The value that must be passed as the single parameter to halInternalDisableWatchDog() in order to successfully disable the watchdog timer.

GPIO_MASK_SIZE#

#define GPIO_MASK_SIZE

24

GPIO_MASK#

#define GPIO_MASK

0xFFFFFF

WAKE_GPIO_MASK#

#define WAKE_GPIO_MASK

GPIO_MASK

WAKE_GPIO_SIZE#

#define WAKE_GPIO_SIZE

GPIO_MASK_SIZE

WAKE_MASK_INVALID#

#define WAKE_MASK_INVALID

(-1)

WAKE_EVENT_SIZE#

#define WAKE_EVENT_SIZE

WakeMask

Note

• The preprocessor symbol WAKE_EVENT_SIZE has been deprecated. Please use WakeMask instead.

DEBUG_TOGGLE#

#define DEBUG_TOGGLE