Microcontroller functions#

STACK_VECTOR_INDEX#

#define STACK_VECTOR_INDEX

0U

A numerical definition for a vector.

special case: stack pointer at reset

RESET_VECTOR_INDEX#

#define RESET_VECTOR_INDEX

1U

reset vector index

NMI_VECTOR_INDEX#

#define NMI_VECTOR_INDEX

2U

nmi vector index

HARD_FAULT_VECTOR_INDEX#

#define HARD_FAULT_VECTOR_INDEX

3U

hard fault vector index

MEMORY_FAULT_VECTOR_INDEX#

#define MEMORY_FAULT_VECTOR_INDEX

4U

memory fault vector index

BUS_FAULT_VECTOR_INDEX#

#define BUS_FAULT_VECTOR_INDEX

5U

bus fault vector index

USAGE_FAULT_VECTOR_INDEX#

#define USAGE_FAULT_VECTOR_INDEX

6U

usage fault vector index

RESERVED07_VECTOR_INDEX#

#define RESERVED07_VECTOR_INDEX

7U

reserved07 vector index

RESERVED08_VECTOR_INDEX#

#define RESERVED08_VECTOR_INDEX

8U

reserved08 vector index

RESERVED09_VECTOR_INDEX#

#define RESERVED09_VECTOR_INDEX

9U

reserved09 vector index

RESERVED10_VECTOR_INDEX#

#define RESERVED10_VECTOR_INDEX

10U

reserved10 vector index

SVCALL_VECTOR_INDEX#

#define SVCALL_VECTOR_INDEX

11U

svcall vector index

DEBUG_MONITOR_VECTOR_INDEX#

#define DEBUG_MONITOR_VECTOR_INDEX

12U

debug monitor vector index

RESERVED13_VECTOR_INDEX#

#define RESERVED13_VECTOR_INDEX

13U

reserved13 vector index

PENDSV_VECTOR_INDEX#

#define PENDSV_VECTOR_INDEX

14U

pendsv vector index

SYSTICK_VECTOR_INDEX#

#define SYSTICK_VECTOR_INDEX

15U

systick vector index

IRQ_TO_VECTOR_NUMBER#

#define IRQ_TO_VECTOR_NUMBER

(x)

Utility macro to convert from IRQ numbers to exception numbers/ vector indices.

These are different because the latter include the Cortex-M standard exceptions while the former do not.

VECTOR_TABLE_LENGTH#

#define VECTOR_TABLE_LENGTH

(IRQ_TO_VECTOR_NUMBER(EXT_IRQ_COUNT))

Number of vectors.

EXT_IRQ_COUNT is defined in the device header but does not include the Cortex-M standard exceptions.

halInternalSysReset#

void halInternalSysReset (uint16_t extendedCause)

Records the specified reset cause then forces a reboot.

halGetExtendedResetInfo#

uint16_t halGetExtendedResetInfo (void )

Returns the Extended Reset Cause information.

Returns

• A 16-bit code identifying the base and extended cause of the reset

halGetEm2xxResetInfo#

uint8_t halGetEm2xxResetInfo (void )

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.

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.

halGetExtendedResetString#

const char * halGetExtendedResetString (void )

Calls halGetExtendedResetInfo() and supplies a string describing the extended cause of the reset.

halGetResetString() should also be called to get the string for the base reset cause

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.

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.

halResetWatchdog#

void halResetWatchdog (void )

hal Reset Watchdog

halInternalSetCtune#

void halInternalSetCtune (uint16_t tune)

Change the CTUNE value.

Involves switching to HFRCO and turning off the HFXO temporarily.

halInternalGetCtune#

uint16_t halInternalGetCtune (void )

Get the CTUNE value.

Returns

• Current CTUNE value.

halGetResetInfo#

uint8_t halGetResetInfo (void )

Gets information about what caused the microcontroller to reset.

Returns

• A code identifying the cause of the reset.

halGetResetString#

const char * halGetResetString (void )

Calls halGetResetInfo() and supplies a string describing it.

Useful for diagnostic printing of text just after program initialization.

Returns

• A pointer to a program space string.

EM2XX_RESET_UNKNOWN#

#define EM2XX_RESET_UNKNOWN

0

EM2xx-compatible reset code returned by halGetEm2xxResetInfo()

EN2XX reset unknow

EM2XX_RESET_EXTERNAL#

#define EM2XX_RESET_EXTERNAL

1

EM2XX reports POWERON instead.

EM2XX_RESET_POWERON#

#define EM2XX_RESET_POWERON

2

EM2XX reset poweron.

EM2XX_RESET_WATCHDOG#

#define EM2XX_RESET_WATCHDOG

3

EM2XX reset watchdog.

EM2XX_RESET_ASSERT#

#define EM2XX_RESET_ASSERT

6

EM2XX reset assert.

EM2XX_RESET_BOOTLOADER#

#define EM2XX_RESET_BOOTLOADER

9

EM2XX reset bootloader.

EM2XX_RESET_SOFTWARE#

#define EM2XX_RESET_SOFTWARE

11

EM2XX reset software.

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.