WatchdogTiva.h File Reference

Detailed Description

Watchdog driver implementation for Tiva.

============================================================================

The Watchdog header file for Tiva should be included in an application as follows:

#include <ti/drivers/Watchdog.h>
#include <ti/drivers/watchdog/WatchdogTiva.h>

Refer to Watchdog.h for a complete description of APIs.

This Watchdog driver implementation is designed to operate on a Tiva device. Once opened, Tiva Watchdog will count down from the reload value specified in the WatchdogTiva_HWAttrs. If it times out, the Watchdog interrupt flag will be set, and a user-provided callback function will be called. If resets have been enabled in the Watchdog_Params and the Watchdog Timer is allowed to time out again while the interrupt flag is still pending, a reset signal will be generated. To prevent a reset, Watchdog_clear() must be called to clear the interrupt flag.

The reload value from which the Watchdog Timer counts down may be changed during runtime using Watchdog_setReload().

Watchdog_close() is not supported by this driver implementation.

By default the Watchdog driver has resets turned on. However, they may be turned off in the Watchdog_Params which allows the Watchdog Timer to be used like another timer interrupt. This functionality is not supported by all platforms, refer to device specific documentation for details.

To have a user-defined function run at the warning interrupt, first define a void-type function that takes a Watchdog_Handle cast to a UArg as an argument such as the one shown below.

void callback(UArg handle);

...

Watchdog_Handle handle;
Watchdog_Params params;

Watchdog_Params_init(&params);
params.callbackFxn = callback;
handle = Watchdog_open(Watchdog_configIndex, &params);

---

#include <stdint.h>
#include <stdbool.h>
#include <ti/drivers/Watchdog.h>
#include <ti/sysbios/family/arm/m3/Hwi.h>

Include dependency graph for WatchdogTiva.h:

Go to the source code of this file.

Data Structures
struct	WatchdogTiva_HWAttrs
	Watchdog hardware attributes for Tiva. More...
struct	WatchdogTiva_Object
	Watchdog Object for Tiva. More...

Macros
#define	ti_sysbios_family_arm_m3_Hwi__nolocalnames

Typedefs
typedef struct WatchdogTiva_HWAttrs	WatchdogTiva_HWAttrs
	Watchdog hardware attributes for Tiva. More...
typedef struct WatchdogTiva_Object	WatchdogTiva_Object
	Watchdog Object for Tiva. More...

Variables
const Watchdog_FxnTable	WatchdogTiva_fxnTable
	Watchdog function table for Tiva. More...

Macro Definition Documentation

#define ti_sysbios_family_arm_m3_Hwi__nolocalnames

Typedef Documentation

typedef struct WatchdogTiva_HWAttrs WatchdogTiva_HWAttrs

Watchdog hardware attributes for Tiva.

intPriority is the Watchdog timer's interrupt priority, as defined by the underlying OS. It is passed unmodified to the underlying OS's interrupt handler creation code, so you need to refer to the OS documentation for usage. For example, for SYS/BIOS applications, refer to the ti.sysbios.family.arm.m3.Hwi documentation for SYS/BIOS usage of interrupt priorities. If the driver uses the ti.drivers.ports interface instead of making OS calls directly, then the HwiP port handles the interrupt priority in an OS specific way. In the case of the SYS/BIOS port, intPriority is passed unmodified to Hwi_create().

typedef struct WatchdogTiva_Object WatchdogTiva_Object

Watchdog Object for Tiva.

Not to be accessed by the user.

Variable Documentation

const Watchdog_FxnTable WatchdogTiva_fxnTable

Watchdog function table for Tiva.