Common Microcontroller Functions#

Microcontroller functions.

Many of the supplied example applications use these microcontroller functions. See hal/micro/micro.h for source code.

Note

The term SFD refers to the Start Frame Delimiter.

Functions#

uint8_t

halGetResetInfo(void)

Gets information about what caused the microcontroller to reset.

const char *

halGetResetString(void)

Calls halGetResetInfo() and supplies a string describing it.

void

halInit(void)

Initializes microcontroller-specific peripherals.

void

halReboot(void)

Restarts the microcontroller and therefore everything else.

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

halResetWatchdog(void)

hal Reset Watchdog

void

halInternalSetCtune(uint16_t tune)

Change the CTUNE value. Involves switching to HFRCO and turning off the HFXO temporarily.

uint16_t

halInternalGetCtune(void)

Get the CTUNE value.

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.

Function Documentation#

halGetResetInfo#

uint8_t halGetResetInfo (void )

Gets information about what caused the microcontroller to reset.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

A code identifying the cause of the reset.

halGetResetString#

const char * halGetResetString (void )

Calls halGetResetInfo() and supplies a string describing it.

Parameters

Type	Direction	Argument Name	Description
void	N/A

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.

Parameters

Type	Direction	Argument Name	Description
void	N/A

halReboot#

void halReboot (void )

Restarts the microcontroller and therefore everything else.

Parameters

Type	Direction	Argument Name	Description
void	N/A

halInternalEnableWatchDog#

void halInternalEnableWatchDog (void )

Enables the watchdog timer.

Parameters

Type	Direction	Argument Name	Description
void	N/A

halInternalDisableWatchDog#

void halInternalDisableWatchDog (uint8_t magicKey)

Disables the watchdog timer.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	magicKey	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.

halInternalWatchDogEnabled#

bool halInternalWatchDogEnabled (void )

Determines whether the watchdog has been enabled or disabled.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

A bool value indicating if the watchdog is current enabled.

halResetWatchdog#

void halResetWatchdog (void )

hal Reset Watchdog

Parameters

Type	Direction	Argument Name	Description
void	N/A

halInternalSetCtune#

void halInternalSetCtune (uint16_t tune)

Change the CTUNE value. Involves switching to HFRCO and turning off the HFXO temporarily.

Parameters

Type	Direction	Argument Name	Description
uint16_t	N/A	tune	Value to set CTUNE to.

halInternalGetCtune#

uint16_t halInternalGetCtune (void )

Get the CTUNE value.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

Current CTUNE value.