/* $Id: xwdttb_example.c,v 1.1.2.1 2009/12/04 05:52:36 svemula Exp $ */
/******************************************************************************
*
* (c) Copyright 2002-2009 Xilinx, Inc. All rights reserved.
*
* This file contains confidential and proprietary information of Xilinx, Inc.
* and is protected under U.S. and international copyright and other
* intellectual property laws.
*
* DISCLAIMER
* This disclaimer is not a license and does not grant any rights to the
* materials distributed herewith. Except as otherwise provided in a valid
* license issued to you by Xilinx, and to the maximum extent permitted by
* applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND WITH ALL
* FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS,
* IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
* MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE;
* and (2) Xilinx shall not be liable (whether in contract or tort, including
* negligence, or under any other theory of liability) for any loss or damage
* of any kind or nature related to, arising under or in connection with these
* materials, including for any direct, or any indirect, special, incidental,
* or consequential loss or damage (including loss of data, profits, goodwill,
* or any type of loss or damage suffered as a result of any action brought by
* a third party) even if such damage or loss was reasonably foreseeable or
* Xilinx had been advised of the possibility of the same.
*
* CRITICAL APPLICATIONS
* Xilinx products are not designed or intended to be fail-safe, or for use in
* any application requiring fail-safe performance, such as life-support or
* safety devices or systems, Class III medical devices, nuclear facilities,
* applications related to the deployment of airbags, or any other applications
* that could lead to death, personal injury, or severe property or
* environmental damage (individually and collectively, "Critical
* Applications"). Customer assumes the sole risk and liability of any use of
* Xilinx products in Critical Applications, subject only to applicable laws
* and regulations governing limitations on product liability.
*
* THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE
* AT ALL TIMES.
*
******************************************************************************/
/*****************************************************************************/
/**
* @file xwdttb_example.c
*
* This file contains a design example using the Watchdog Timer Timebase driver
* (XWdtTb) and hardware device.
*
* @note
*
* None.
*
* MODIFICATION HISTORY:
*
*
* Ver Who Date Changes
* ----- ---- -------- -----------------------------------------------
* 1.00b jhl 02/13/02 First release
* 1.00b sv 04/26/05 Minor changes to comply to Doxygen and coding guidelines
* 2.00a ktn 12/02/09 Updated the example to use the HAL APIs/macros.
* Updated this example to check for Watchdog timer reset
* condition instead of timer expiry state to avoid a race
* condition
*
******************************************************************************/
/***************************** Include Files *********************************/
#include "xparameters.h"
#include "xwdttb.h"
/************************** Constant Definitions *****************************/
/*
* The following constants map to the XPAR parameters created in the
* xparameters.h file. They are only defined here such that a user can easily
* change all the needed parameters in one place.
*/
#define WDTTB_DEVICE_ID XPAR_WDTTB_0_DEVICE_ID
/**************************** Type Definitions *******************************/
/***************** Macros (Inline Functions) Definitions *********************/
/************************** Function Prototypes ******************************/
int WdtTbExample(u16 DeviceId);
/************************** Variable Definitions *****************************/
XWdtTb WatchdogTimebase; /* Instance of WatchDog Timer Base */
/*****************************************************************************/
/**
* Main function to call the Wdttb driver example.
*
* @param None.
*
* @return XST_SUCCESS if successful, XST_FAILURE if unsuccessful.
*
* @note None.
*
******************************************************************************/
int main(void)
{
int Status;
/*
* Call the example , specify the device ID that is generated in
* xparameters.h.
*/
Status = WdtTbExample(WDTTB_DEVICE_ID);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
return XST_SUCCESS;
}
/*****************************************************************************/
/**
* This function tests the functioning of the TimeBase WatchDog Timer module
* in the polled mode.
*
* After one expiration of the WDT timeout interval, the WDT state bit is set to
* one in the status register. If the state bit is not cleared (by writing a 1 to
* the state bit) before the next expiration of the timeout interval, a WDT reset
* is generated.
*
* This function checks for Watchdog timer reset condition in two timer expiry
* state.
*
* This function may require some time (seconds or even minutes) to execute
* because it waits for the watchdog timer to expire.
*
* @param DeviceId is the XPAR__DEVICE_ID value from
* xparameters.h.
*
* @return XST_SUCCESS if WRS bit is not set in next two subsequent timer
* expiry state, otherwise XST_FAILURE.
*
* @note None.
*
****************************************************************************/
int WdtTbExample(u16 DeviceId)
{
int Status;
int Count = 0;
/*
* Initialize the watchdog timer and timebase driver so that
* it is ready to use.
*/
Status = XWdtTb_Initialize(&WatchdogTimebase, DeviceId);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Perform a self-test to ensure that the hardware was built correctly.
*/
Status = XWdtTb_SelfTest(&WatchdogTimebase);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Start the watchdog timer, the timebase is automatically reset
* when this occurs.
*/
XWdtTb_Start(&WatchdogTimebase);
/*
* Verify Whether the WatchDog Reset Status has been set in the next two
* expiry state.
*/
while (1) {
/*
* If the watchdog timer expired, then restart it.
*/
if (XWdtTb_IsWdtExpired(&WatchdogTimebase)) {
/*
* Restart the watchdog timer as a normal application
* would
*/
XWdtTb_RestartWdt(&WatchdogTimebase);
Count++;
}
/*
* Check whether the WatchDog Reset Status has been set.
* If this is set means then the test has failed
*/
if (XWdtTb_ReadReg(WatchdogTimebase.RegBaseAddress,
XWT_TWCSR0_OFFSET) & XWT_CSR0_WRS_MASK) {
/*
* Stop the watchdog timer
*/
XWdtTb_Stop(&WatchdogTimebase);
return XST_FAILURE;
}
/*
* Check whether the WatchDog timer expires two times.
* If the timer expires two times then the test is passed.
*/
if(Count == 2) {
break;
}
}
return XST_SUCCESS;
}