Minimal Hal functions common across all microcontroller-specific files. See Common Microcontroller Functions for documentation.

License#

Copyright 2018 Silicon Laboratories Inc. www.silabs.com

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code. 

/***************************************************************************/
#ifndef __MICRO_COMMON_H__
#define __MICRO_COMMON_H__

void halInit(void);

void halReboot(void);

void halPowerUp(void);

void halPowerDown(void);

void halResume(void);

void halSuspend(void);

#define MICRO_DISABLE_WATCH_DOG_KEY 0xA5U

void halInternalEnableWatchDog(void);

void halInternalDisableWatchDog(uint8_t magicKey);

bool halInternalWatchDogEnabled(void);

#ifdef DOXYGEN_SHOULD_SKIP_THIS

enum SleepModes
#else
typedef uint8_t SleepModes;
enum
#endif
{
  SLEEPMODE_RUNNING = 0U,
  SLEEPMODE_IDLE = 1U,
  SLEEPMODE_WAKETIMER = 2U,
  SLEEPMODE_MAINTAINTIMER = 3U,
  SLEEPMODE_NOTIMER = 4U,
  SLEEPMODE_HIBERNATE = 5U,

  //The following SleepModes are deprecated on EM2xx and EM3xx chips.  Each
  //micro's halSleep() function will remap these modes to the appropriate
  //replacement, as necessary.
  SLEEPMODE_RESERVED = 6U,
  SLEEPMODE_POWERDOWN = 7U,
  SLEEPMODE_POWERSAVE = 8U,
};

#if defined (CORTEXM3_EFM32_MICRO)
  #define WAKE_GPIO_SIZE    16
  #define WAKE_GPIO_MASK    0x0000FFFF
  #define WAKE_IRQ_GPIO     (1 << 16)
  #define WAKE_IRQ_SYSTIMER (1 << 17)
  #define WAKE_IRQ_RFSENSE  (1 << 18)

typedef uint32_t WakeEvents;
typedef uint32_t WakeMask;
#else // to cover simulation targets
  #define GPIO_MASK_SIZE    24
  #define GPIO_MASK         0xFFFFFF
  #define WAKE_GPIO_MASK    GPIO_MASK
  #define WAKE_GPIO_SIZE    GPIO_MASK_SIZE
typedef uint32_t WakeEvents;
typedef uint32_t WakeMask;
#endif // CORTEXM3_EFM32_MICRO

#define WAKE_MASK_INVALID (-1)

#define WAKE_EVENT_SIZE   WakeMask

void halSleep(SleepModes sleepMode);

void halSleepPreserveInts(SleepModes sleepMode);

void halCommonDelayMicroseconds(uint16_t us);

#define DEBUG_TOGGLE(n)

extern volatile int8_t halCommonVreg1v8EnableCount;

void halCommonDisableVreg1v8(void);

void halCommonEnableVreg1v8(void);

/*
 * This function should set CRYOTimer for EFR32 wakeup from em4 sleep, and also write the counters to RTCC RAM
 */
typedef struct {//Saved in RTCCRAM starting from index 0
  uint32_t outgoingNwkFrameCounter;   //saved in index 0 of RTCCRAM
  uint32_t incomingParentNwkFrameCounter;
  uint32_t outgoingLinkKeyFrameCounter;  //NextApsFrameCounter
  uint32_t incomingLinkKeyFrameCounter;  //incomingTCLinkKeyFrameCounter saved in index 3 of RTCCRAM
} RTCCRamData;
void halBeforeEM4(uint32_t duration, RTCCRamData input);
RTCCRamData halAfterEM4(void);

#endif //__MICRO_COMMON_H__

Modules#

RTCCRamData

Macros#

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

#define
GPIO_MASK_SIZE 24
#define
GPIO_MASK 0xFFFFFF
#define
WAKE_GPIO_MASK GPIO_MASK
#define
WAKE_GPIO_SIZE GPIO_MASK_SIZE
#define
WAKE_MASK_INVALID (-1)
#define
WAKE_EVENT_SIZE WakeMask
#define
DEBUG_TOGGLE (n)

Enumerations#

enum
SleepModes {
SLEEPMODE_RUNNING = 0U
SLEEPMODE_IDLE = 1U
SLEEPMODE_WAKETIMER = 2U
SLEEPMODE_MAINTAINTIMER = 3U
SLEEPMODE_NOTIMER = 4U
SLEEPMODE_HIBERNATE = 5U
SLEEPMODE_RESERVED = 6U
SLEEPMODE_POWERDOWN = 7U
SLEEPMODE_POWERSAVE = 8U
}

Enumerations for the possible microcontroller sleep modes.

Typedefs#

typedef uint32_t
WakeEvents
typedef uint32_t
WakeMask

Variables#

volatile int8_t
halCommonVreg1v8EnableCount

Helper variable to track the state of 1.8V regulator.

Functions#

void
halInit(void)

Initializes microcontroller-specific peripherals.

void
halReboot(void)

Restarts the microcontroller and therefore everything else.

void
halPowerUp(void)

Powers up microcontroller peripherals and board peripherals.

void
halPowerDown(void)

Powers down microcontroller peripherals and board peripherals.

void
halResume(void)

Resumes microcontroller peripherals and board peripherals.

void
halSuspend(void)

Suspends microcontroller peripherals and board peripherals.

void
halInternalEnableWatchDog(void)

Enables the watchdog timer.

void
halInternalDisableWatchDog(uint8_t magicKey)

Disables the watchdog timer.

bool
halInternalWatchDogEnabled(void)

Determines whether the watchdog has been enabled or disabled.

void
halSleep(SleepModes sleepMode)

Puts the microcontroller to sleep in a specified mode.

void
halSleepPreserveInts(SleepModes sleepMode)

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

void
halCommonDelayMicroseconds(uint16_t us)

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

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.

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.

void
halBeforeEM4(uint32_t duration, RTCCRamData input)

Macro Definition Documentation#

MICRO_DISABLE_WATCH_DOG_KEY#

#define MICRO_DISABLE_WATCH_DOG_KEY
Value:
0xA5U

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


Definition at line 56 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

GPIO_MASK_SIZE#

#define GPIO_MASK_SIZE
Value:
24

Definition at line 137 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

GPIO_MASK#

#define GPIO_MASK
Value:
0xFFFFFF

Definition at line 138 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

WAKE_GPIO_MASK#

#define WAKE_GPIO_MASK
Value:
GPIO_MASK

Definition at line 139 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

WAKE_GPIO_SIZE#

#define WAKE_GPIO_SIZE
Value:
GPIO_MASK_SIZE

Definition at line 140 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

WAKE_MASK_INVALID#

#define WAKE_MASK_INVALID
Value:
(-1)

Definition at line 145 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

WAKE_EVENT_SIZE#

#define WAKE_EVENT_SIZE
Value:
WakeMask

Note

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


Definition at line 150 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

DEBUG_TOGGLE#

#define DEBUG_TOGGLE

Definition at line 188 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

Enumeration Documentation#

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

Enumerator
SLEEPMODE_RUNNING
SLEEPMODE_IDLE
SLEEPMODE_WAKETIMER
SLEEPMODE_MAINTAINTIMER
SLEEPMODE_NOTIMER
SLEEPMODE_HIBERNATE
SLEEPMODE_RESERVED
SLEEPMODE_POWERDOWN
SLEEPMODE_POWERSAVE

Definition at line 106 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

Typedef Documentation#

WakeEvents#

typedef uint32_t WakeEvents

Definition at line 141 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

WakeMask#

typedef uint32_t WakeMask

Definition at line 142 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

Variable Documentation#

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.


Definition at line 195 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

Function Documentation#

halInit#

void halInit (void )

Initializes microcontroller-specific peripherals.

Parameters
N/A

Definition at line 30 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halReboot#

void halReboot (void )

Restarts the microcontroller and therefore everything else.

Parameters
N/A

Definition at line 34 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halPowerUp#

void halPowerUp (void )

Powers up microcontroller peripherals and board peripherals.

Parameters
N/A

Definition at line 38 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halPowerDown#

void halPowerDown (void )

Powers down microcontroller peripherals and board peripherals.

Parameters
N/A

Definition at line 42 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halResume#

void halResume (void )

Resumes microcontroller peripherals and board peripherals.

Parameters
N/A

Definition at line 46 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halSuspend#

void halSuspend (void )

Suspends microcontroller peripherals and board peripherals.

Parameters
N/A

Definition at line 50 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halInternalEnableWatchDog#

void halInternalEnableWatchDog (void )

Enables the watchdog timer.

Parameters
N/A

Definition at line 60 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halInternalDisableWatchDog#

void halInternalDisableWatchDog (uint8_t magicKey)

Disables the watchdog timer.

Parameters
N/AmagicKey

A value (MICRO_DISABLE_WATCH_DOG_KEY) that enables the function.

Note

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


Definition at line 69 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halInternalWatchDogEnabled#

bool halInternalWatchDogEnabled (void )

Determines whether the watchdog has been enabled or disabled.

Parameters
N/A

Returns

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


Definition at line 75 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halSleep#

void halSleep (SleepModes sleepMode)

Puts the microcontroller to sleep in a specified mode.

Parameters
N/AsleepMode

A microcontroller sleep mode

Note

  • This routine always enables interrupts.

See Also


Definition at line 160 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halSleepPreserveInts#

void halSleepPreserveInts (SleepModes sleepMode)

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

Parameters
N/AsleepMode

A microcontroller sleep mode

See Also


Definition at line 169 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halCommonDelayMicroseconds#

void halCommonDelayMicroseconds (uint16_t us)

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

Parameters
N/Aus

The specified time, in microseconds. Values should be between 1 and 65535 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.


Definition at line 186 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

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.

Parameters
N/A

Note

  • : Only used when DISABLE_INTERNAL_1V8_REGULATOR is defined.


Definition at line 206 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

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.

Parameters
N/A

Note

  • : Only used when DISABLE_INTERNAL_1V8_REGULATOR is defined.


Definition at line 217 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halBeforeEM4#

void halBeforeEM4 (uint32_t duration, RTCCRamData input)
Parameters
N/Aduration
N/Ainput

Definition at line 228 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h

halAfterEM4#

RTCCRamData halAfterEM4 (void )
Parameters
N/A

Definition at line 229 of file /mnt/raid/workspaces/ws.OJKVohJa4/overlay/gsdk/platform/base/hal/micro/micro-common.h