Detailed Description

This file defines a common/generic interface for restarting, rebooting, etc.

and application and/or a physical device. The actual implementation is obviously platform dependent and as such the specific behavior is NOT guarantied on ALL platforms. However, what is GUARENTIED for ALL platforms is that the execution of the application will be stopped - at least momentarily.

ALL Colony.* BSPs are ENCOURAGED to support this interface. The default implementation maps to a forever loop with interrupts disabled. Use the config preprocessor symbols HAVE_BSP_EXECUTION_xxx to disable and/or turn off the default implementation.

#include "Bsp/Api.h"

Include dependency graph for Execution.h:

Go to the source code of this file.

Macros
#define	BSP_EXECUTION_RESET_UNKNOWN BSP_EXECUTION_RESET_UNKNOWN_MAP
	Reset type unknown or not supported.

#define	BSP_EXECUTION_RESET_COLD BSP_EXECUTION_RESET_COLD_MAP
	Cold boot.

#define	BSP_EXECUTION_RESET_WARM BSP_EXECUTION_RESET_WARM_MAP
	Warm boot.

#define	BSP_EXECUTION_RESET_BROWN_OUT BSP_EXECUTION_RESET_BROWN_OUT_MAP
	Reset due to drop in Voltage.

#define	BSP_EXECUTION_RESET_EXECPTION BSP_EXECUTION_RESET_EXECPTION_MAP
	Reset due to an unhandled CPU exception/error.

#define	Bsp_Execution_getResetType Bsp_Execution_getResetType_MAP
	This method returns information about the how the application's platform was last came out of reset.

#define	Bsp_Execution_reboot Bsp_Execution_reboot_MAP
	This method reboots the application's platform.

#define	Bsp_Execution_shutdown Bsp_Execution_shutdown_MAP
	This method shuts down the application's platform.

Macro Definition Documentation

◆ Bsp_Execution_getResetType

#define Bsp_Execution_getResetType Bsp_Execution_getResetType_MAP

This method returns information about the how the application's platform was last came out of reset.

See the above BSP_EXECUTION_RESET_xxxx macros for the possible return values. The application/platform is free define additional reason codes

Prototype: uint32_t Bsp_Execution_getResetType(void);

◆ Bsp_Execution_reboot

#define Bsp_Execution_reboot Bsp_Execution_reboot_MAP

This method reboots the application's platform.

There are no guaranties on how gracefully or safe the reboot is.

Prototype: void Bsp_Execution_reboot( void );

◆ BSP_EXECUTION_RESET_BROWN_OUT

#define BSP_EXECUTION_RESET_BROWN_OUT BSP_EXECUTION_RESET_BROWN_OUT_MAP

Reset due to drop in Voltage.

◆ BSP_EXECUTION_RESET_COLD

#define BSP_EXECUTION_RESET_COLD BSP_EXECUTION_RESET_COLD_MAP

Cold boot.

◆ BSP_EXECUTION_RESET_EXECPTION

#define BSP_EXECUTION_RESET_EXECPTION BSP_EXECUTION_RESET_EXECPTION_MAP

Reset due to an unhandled CPU exception/error.

◆ BSP_EXECUTION_RESET_UNKNOWN

#define BSP_EXECUTION_RESET_UNKNOWN BSP_EXECUTION_RESET_UNKNOWN_MAP

Reset type unknown or not supported.

◆ BSP_EXECUTION_RESET_WARM

#define BSP_EXECUTION_RESET_WARM BSP_EXECUTION_RESET_WARM_MAP

Warm boot.

◆ Bsp_Execution_shutdown

#define Bsp_Execution_shutdown Bsp_Execution_shutdown_MAP

This method shuts down the application's platform.

There are no guaranties on how gracefully or safe the shutdown is.

Prototype: void Bsp_Execution_shutdown( void );