/******************************************************************************
*
* Copyright (C) 2010 - 2014 Xilinx, Inc. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* Use of the Software is limited solely to applications:
* (a) running on a Xilinx device, or
* (b) that interact with a Xilinx device through a bus or interconnect.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* XILINX CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
* OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Except as contained in this notice, the name of the Xilinx shall not be used
* in advertising or otherwise to promote the sale, use or other dealings in
* this Software without prior written authorization from Xilinx.
*
******************************************************************************/
/*****************************************************************************/
/**
*
* @file xwdtps_intr_example.c
*
* This file contains a design example using the System Watchdog Timer Device
* (WdtPs) driver and hardware device using interrupt mode. This test
* assumes that the RESET OUTPUT OF WDT IS NOT CONNECTED to the processor and
* the IRQ output is connected to an interrupt controller attached to the
* processor
*
*
* @note
*
* <pre>
*
* MODIFICATION HISTORY:
*
* Ver Who Date Changes
* ----- ------ -------- ---------------------------------------------
* 1.00a ecm/jz 01/15/10 First release
* </pre>
*
******************************************************************************/
/***************************** Include Files *********************************/
#include "xparameters.h"
#include "xwdtps.h"
#include "xscugic.h"
#include "xil_exception.h"
#include "xil_printf.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 WDT_DEVICE_ID XPAR_XWDTPS_0_DEVICE_ID
#define INTC_DEVICE_ID XPAR_SCUGIC_SINGLE_DEVICE_ID
#define WDT_IRPT_INTR XPAR_XWDTPS_0_INTR
/**************************** Type Definitions *******************************/
#define HANDLER_CALLED 0xFFFFFFFF
/***************** Macros (Inline Functions) Definitions *********************/
/************************** Function Prototypes ******************************/
int WdtPsIntrExample(XScuGic *IntcInstancePtr, XWdtPs * WdtInstancePtr,
u16 WdtDeviceId, u16 WdtIntrId);
static void WdtIntrHandler(void *CallBackRef);
static int WdtSetupIntrSystem(XScuGic *IntcInstancePtr,
XWdtPs * WdtInstancePtr, u16 WdtIntrId);
static void WdtDisableIntrSystem(XScuGic *IntcInstancePtr, u16 WdtIntrId);
/************************** Variable Definitions *****************************/
XWdtPs WdtInstance; /* Instance of WatchDog Timer */
XScuGic IntcInstance; /* Instance of the Interrupt Controller */
volatile u32 HandlerCalled; /* flag is set when timeout interrupt occurs */
/*****************************************************************************/
/**
* Main function to call the Wdt interrupt example.
*
* @param None.
*
* @return XST_SUCCESS if successful, otherwise XST_FAILURE.
*
* @note None.
*
******************************************************************************/
int main(void)
{
int Status;
xil_printf("WDT Interrupt Example Test\r\n");
/*
* Call the interrupt example, specify the parameters generated in
* xparameters.h
*/
Status = WdtPsIntrExample(&IntcInstance,
&WdtInstance, WDT_DEVICE_ID, WDT_IRPT_INTR);
if (Status != XST_SUCCESS) {
xil_printf("WDT Interrupt Example Test Failed\r\n");
return XST_FAILURE;
}
xil_printf("Successfully ran WDT Interrupt Example Test\r\n");
return XST_SUCCESS;
}
/*****************************************************************************/
/**
*
* This function tests the functioning of the System WatchDog Timer driver in the
* Interrupt mode.
*
* After one expiration of the timeout interval, an interrupt is generated and
* the WDT state bit is set to one in the status register.
*
* This function assumes that the reset output of the Wdt device is not
* connected to the reset of the processor, otherwise, the timer will cause the
* processor to reset when it expires.
*
* @param IntcInstancePtr is a pointer to the instance of the XScuGic
* driver.
* @param WdtInstancePtr is a pointer to the instance of XWdtPs driver.
* @param WdtDeviceId is the Device ID of the XWdtPs device.
* @param WdtIntrId is the Interrupt Id of the XWdtPs device.
*
* @return XST_SUCCESS if successful, otherwise XST_FAILURE.
*
* @note None.
*
******************************************************************************/
int WdtPsIntrExample(XScuGic *IntcInstancePtr,
XWdtPs * WdtInstancePtr, u16 WdtDeviceId, u16 WdtIntrId)
{
int Status;
u32 Timebase = 0;
u32 ExpiredTimeDelta = 0;
u32 EffectiveAddress; /* This can be the virtual address */
XWdtPs_Config *ConfigPtr;
/*
* Initialize the Wdt driver.
*/
ConfigPtr = XWdtPs_LookupConfig(WdtDeviceId);
/*
* This is where the virtual address would be used, this example
* uses physical address.
*/
EffectiveAddress = ConfigPtr->BaseAddress;
Status = XWdtPs_CfgInitialize(WdtInstancePtr, ConfigPtr,
EffectiveAddress);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Perform a self-test to ensure that the hardware was built correctly.
*/
Status = XWdtPs_SelfTest(WdtInstancePtr);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Set the initial counter restart to the smallest value (0).
*/
XWdtPs_SetControlValue(WdtInstancePtr,
(u8) XWDTPS_COUNTER_RESET, (u8) 0);
/*
* Set the initial Divider ratio at the smallest value.
*/
XWdtPs_SetControlValue(WdtInstancePtr,
(u8) XWDTPS_CLK_PRESCALE,
(u8) XWDTPS_CCR_PSCALE_0008);
/*
* Disable the RESET output.
*/
XWdtPs_DisableOutput(WdtInstancePtr, XWDTPS_RESET_SIGNAL);
/*
* Start the Wdt device.
*/
XWdtPs_Start(WdtInstancePtr);
/*
* Restart the timer.
*/
XWdtPs_RestartWdt(WdtInstancePtr);
/*
* Determine how long it takes for the Watchdog Timer to expire
* for later processing.
* If the reset output of the device is connected to the processor,
* the following code will cause a reset.
*/
while (1) {
if (!(XWdtPs_IsWdtExpired(WdtInstancePtr))) {
ExpiredTimeDelta++;
} else {
break;
}
}
/*
* Stop the timer to set up the device in interrupt mode.
*/
XWdtPs_Stop(WdtInstancePtr);
/*
* Connect to the interrupt subsystem so that interrupts can occur.
*/
Status = WdtSetupIntrSystem(IntcInstancePtr, WdtInstancePtr, WdtIntrId);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Enable the IRQ output.
*/
XWdtPs_EnableOutput(WdtInstancePtr, (u8) XWDTPS_IRQ_SIGNAL);
/*
* Start the Wdt device.
*/
HandlerCalled = 0;
XWdtPs_Start(WdtInstancePtr);
XWdtPs_RestartWdt(WdtInstancePtr);
/*
* Verify that the Watchdog Timer does timeout when not restarted
* all the time, wait more than the amount of time it took for it
* to expire in the previous test.
*/
while (1) {
/*
* If the handler is called, the test passed
*/
if ((HandlerCalled != 0)) {
break;
}
/*
* If more time has gone past than it took for it to expire
* when not restarted in the previous test, then stop since the
* handler was never called failing the test.
*/
Timebase++;
if (Timebase > ExpiredTimeDelta + ExpiredTimeDelta) {
/*
* Disable and disconnect the interrupt system.
*/
WdtDisableIntrSystem(IntcInstancePtr, WdtIntrId);
return XST_FAILURE;
}
/*
* If the Watchdog Timer expired and handler was not called,
* then the test failed.
*/
if ((XWdtPs_IsWdtExpired(WdtInstancePtr)) &&
(HandlerCalled == 0)) {
/*
* Disable and disconnect the interrupt system.
*/
WdtDisableIntrSystem(IntcInstancePtr,
WdtIntrId);
return XST_FAILURE;
}
}
/*
* Restart the device to allow the next test to run normally.
*/
XWdtPs_RestartWdt(WdtInstancePtr);
HandlerCalled = 0;
/*
* Verify that the Watchdog Timer does not timeout when restarted
* all the time, wait more than the amount of time it took for it
* to expire in the previous test.
*/
while (1) {
/*
* Reset the WDT each pass through the loop
*/
XWdtPs_RestartWdt(WdtInstancePtr);
/*
* If more time has gone past than it took for it to expire
* when not restarted in the previous test, then stop as the
* restarting worked.
*/
Timebase++;
if (Timebase > ExpiredTimeDelta + ExpiredTimeDelta) {
break;
}
/*
* If the Watchdog Timer expired and/or handler called, then the
* test failed.
*/
if ((XWdtPs_IsWdtExpired(WdtInstancePtr)) ||
(HandlerCalled != 0)) {
/*
* Disable and disconnect the interrupt system.
*/
WdtDisableIntrSystem(IntcInstancePtr, WdtIntrId);
return XST_FAILURE;
}
}
/*
* Disable and disconnect the interrupt system.
*/
WdtDisableIntrSystem(IntcInstancePtr, WdtIntrId);
return XST_SUCCESS;
}
/*****************************************************************************/
/**
*
* This function sets up the interrupt system such that interrupts can occur
* for the device. This function is application specific since the actual
* system may or may not have an interrupt controller. The device could be
* directly connected to a processor without an interrupt controller. The
* user should modify this function to fit the application.
*
* @param IntcInstancePtr is a pointer to the instance of ScuGic driver.
* @param WdtInstancePtr is a pointer to the instance of XWdtPs driver.
* @param WdtIntrId is the Interrupt Id of the XWdtPs device.
*
* @return XST_SUCCESS if successful, otherwise XST_FAILURE.
*
* @note None.
*
******************************************************************************/
static int WdtSetupIntrSystem(XScuGic *IntcInstancePtr,
XWdtPs *WdtInstancePtr, u16 WdtIntrId)
{
int Status;
XScuGic_Config *IntcConfig;
u8 Priority, Trigger;
Xil_ExceptionInit();
/*
* Initialize the interrupt controller driver so that it is ready to
* use.
*/
IntcConfig = XScuGic_LookupConfig(INTC_DEVICE_ID);
if (NULL == IntcConfig) {
return XST_FAILURE;
}
Status = XScuGic_CfgInitialize(IntcInstancePtr, IntcConfig,
IntcConfig->CpuBaseAddress);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
XScuGic_GetPriorityTriggerType(IntcInstancePtr, WdtIntrId,
&Priority, &Trigger);
Trigger = 3;
XScuGic_SetPriorityTriggerType(IntcInstancePtr, WdtIntrId,
Priority, Trigger);
/*
* Connect the interrupt controller interrupt handler to the hardware
* interrupt handling logic in the processor.
*/
Xil_ExceptionRegisterHandler(XIL_EXCEPTION_ID_INT,
(Xil_ExceptionHandler)XScuGic_InterruptHandler,
IntcInstancePtr);
/*
* Connect the device driver handler that will be called when an
* interrupt for the device occurs, the handler defined above performs
* the specific interrupt processing for the device.
*/
Status = XScuGic_Connect(IntcInstancePtr, WdtIntrId,
(Xil_ExceptionHandler)WdtIntrHandler,
(void *)WdtInstancePtr);
if (Status != XST_SUCCESS) {
return Status;
}
/*
* Enable the interrupt for the device.
*/
XScuGic_Enable(IntcInstancePtr, WdtIntrId);
/*
* Enable interrupts in the Processor.
*/
Xil_ExceptionEnable();
return XST_SUCCESS;
}
/*****************************************************************************/
/**
*
* This function is the Interrupt handler for the WDT Interrupt of the
* Wdt device. It is called on the expiration of the timer counter in
* interrupt context.
*
* @param CallBackRef is a pointer to the callback function.
*
* @return None.
*
* @note None.
*
******************************************************************************/
static void WdtIntrHandler(void *CallBackRef)
{
/*
* WDT timed out and interrupt occurred, let main test loop know.
*/
HandlerCalled = HANDLER_CALLED;
}
/*****************************************************************************/
/**
*
* This function disables the interrupts that occur for the device.
*
* @param IntcInstancePtr is the pointer to the instance of XScuGic
* driver.
* @param WdtIntrId is the Interrupt Id for the device.
*
* @return None.
*
* @note None.
*
******************************************************************************/
static void WdtDisableIntrSystem(XScuGic *IntcInstancePtr, u16 WdtIntrId)
{
/*
* Disconnect and disable the interrupt for the Wdt.
*/
XScuGic_Disconnect(IntcInstancePtr, WdtIntrId);
}