WatchDog.h File Reference

Detailed Description

This file defines a common/generic interface for managing the application's and/or platform's watchdog.

The watchdog is responsible for restarted the application/platform if watchdog is not 'kicked' within the pre-configured time intervals.

ALL Colony.* BSPs are ENCOURAGED to support this interface. The default implementation DOES NOTHING. Use the config preprocessor symbols HAVE_BSP_WATCH_DOG_xxx to disable and/or turn off the default implementation.

#include "Bsp/Api.h"

Include dependency graph for WatchDog.h:

Go to the source code of this file.

Macros
#define	Bsp_WatchDog_start   Bsp_WatchDog_start_MAP
	This method starts the watchdog mechanism.
#define	Bsp_WatchDog_kick   Bsp_WatchDog_kick_MAP
	This method 'kicks' the watchdog, i.e.

Macro Definition Documentation

Bsp_WatchDog_kick

#define Bsp_WatchDog_kick   Bsp_WatchDog_kick_MAP

This method 'kicks' the watchdog, i.e.

restart's the watchdog count down timer.

Prototype: void Bsp_WatchDog_kick(void);

Bsp_WatchDog_start

#define Bsp_WatchDog_start   Bsp_WatchDog_start_MAP

This method starts the watchdog mechanism.

Once started, the watchdog mechanism can not be disabled/turned off. This method is also responsible for configuring/setting the time interval/frequency that watchdog must be kicked to keep the application/platform from resetting.

Prototype: void Bsp_WatchDog_start(void);