wdog.h File Reference

Contains public interface to various functions related to the watchdog (WDOG) timer object. More...

#include "sw/modules/types/src/types.h"
#include "sw/drivers/cpu/src/32b/f28x/f2806x/cpu.h"

Go to the source code of this file.

Data Structures
struct	_WDOG_Obj_
	Defines the watchdog (WDOG) object. More...

Macros
#define	WDOG_BASE_ADDR   (0x00007022)
	Defines the base address of the watchdog (WDOG) registers. More...
#define	WDOG_SCSR_WDOVERRIDE_BITS   (1 << 0)
	Defines the location of the WDOVERRIDE bits in the SCSR register. More...
#define	WDOG_SCSR_WDENINT_BITS   (1 << 1)
	Defines the location of the WDENINT bits in the SCSR register. More...
#define	WDOG_SCSR_WDINTS_BITS   (1 << 2)
	Defines the location of the WDINTS bits in the SCSR register. More...
#define	WDOG_WDCNTR_BITS   (255 << 0)
	Defines the location of the WDCNTR bits in the WDCNTR register. More...
#define	WDOG_WDKEY_BITS   (255 << 0)
	Defines the location of the WDKEY bits in the WDKEY register. More...
#define	WDOG_WDCR_WDPS_BITS   (7 << 0)
	Defines the location of the WDPS bits in the WDCR register. More...
#define	WDOG_WDCR_WDCHK_BITS   (7 << 3)
	Defines the location of the WDCHK bits in the WDCR register. More...
#define	WDOG_WDCR_WDDIS_BITS   (1 << 6)
	Defines the location of the WDDIS bits in the WDCR register. More...
#define	WDOG_WDCR_WDFLAG_BITS   (1 << 7)
	Defines the location of the WDFLAG bits in the WDCR register. More...
#define	WDOG_WDCR_WRITE_ENABLE   (5 << 3)
	Defines the watchdog write enable mode. More...

Typedefs
typedef struct _WDOG_Obj_	WDOG_Obj
	Defines the watchdog (WDOG) object. More...
typedef struct _WDOG_Obj_ *	WDOG_Handle
	Defines the watchdog (WDOG) handle. More...

Enumerations
enum	WDOG_IntStatus_e { WDOG_IntStatus_Active =(0 << 2), WDOG_IntStatus_InActive =(1 << 2) }
	Enumeration to define the watchdog (WDOG) interrupt status. More...
enum	WDOG_PreScaler_e {   WDOG_PreScaler_OscClk_by_512_by_1 =1, WDOG_PreScaler_OscClk_by_512_by_2, WDOG_PreScaler_OscClk_by_512_by_4, WDOG_PreScaler_OscClk_by_512_by_8,   WDOG_PreScaler_OscClk_by_512_by_16, WDOG_PreScaler_OscClk_by_512_by_32, WDOG_PreScaler_OscClk_by_512_by_64 }
	Enumeration to define the watchdog (WDOG) timer clock prescaler, which sets the clock frequency. More...

Functions
void	WDOG_clearCounter (WDOG_Handle wdogHandle)
	Clears the watchdog (WDOG) counter. More...
void	WDOG_disable (WDOG_Handle wdogHandle)
	Disables the watchdog (WDOG) timer. More...
void	WDOG_disableInt (WDOG_Handle wdogHandle)
	Disables the watchdog (WDOG) timer interrupt. More...
void	WDOG_disableOverRide (WDOG_Handle wdogHandle)
	Disables the timer override. More...
void	WDOG_enable (WDOG_Handle wdogHandle)
	Enables the watchdog (WDOG) timer. More...
void	WDOG_enableInt (WDOG_Handle wdogHandle)
	Enables the watchdog (WDOG) timer interrupt. More...
void	WDOG_enableOverRide (WDOG_Handle wdogHandle)
	Enables the watchdog (WDOG) timer override. More...
WDOG_IntStatus_e	WDOG_getIntStatus (WDOG_Handle wdogHandle)
	Gets the watchdog (WDOG) interrupt status. More...
WDOG_Handle	WDOG_init (void *pMemory, const size_t numBytes)
	Initializes the watchdog (WDOG) object handle. More...
void	WDOG_setCount (WDOG_Handle wdogHandle, const uint_least8_t count)
	Sets the watchdog (WDOG) counter. More...
void	WDOG_setPreScaler (WDOG_Handle wdogHandle, const WDOG_PreScaler_e preScaler)
	Sets the watchdog (WDOG) timer clock prescaler. More...

Detailed Description

Contains public interface to various functions related to the watchdog (WDOG) timer object.

(C) Copyright 2015, Texas Instruments, Inc.

Definition in file wdog.h.