embeddedsw/XilinxProcessorIPLib/drivers/wdtps/doc/html/api/index.html
Kedareswara rao Appana 6a08b60322 doxygen: Update doxygen for the drivers to include .h files in documentation.
This patch updates the doxygen for the drivers
wdtps,wdttb,xadcps,usb,usbps to include .h files
in the listof files provided in the index.html file.

Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2014-09-02 11:21:46 +05:30

58 lines
2.9 KiB
HTML
Executable file

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver wdtps v2_0: wdtps v2_0
</title>
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
</head>
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
<hl>Software Drivers</hl>
<hr class="whs1">
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li class="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>wdtps v2_0</h1><p>The Xilinx watchdog timer driver supports the Xilinx watchdog timer hardware.</p>
<p>The Xilinx watchdog timer (WDT) driver supports the following features:</p>
<ul>
<li>Both Interrupt driven and Polled mode</li>
<li>enabling and disabling the watchdog timer</li>
<li>restarting the watchdog.</li>
<li>initializing the most significant digit of the counter restart value.</li>
<li>multiple individually enabling/disabling outputs</li>
</ul>
<p>It is the responsibility of the application to provide an interrupt handler for the watchdog timer and connect it to the interrupt system if interrupt driven mode is desired.</p>
<p>If interrupt is enabled, the watchdog timer device generates an interrupt when the counter reaches zero.</p>
<p>If the hardware interrupt signal is not connected/enabled, polled mode is the only option (using IsWdtExpired) for the watchdog.</p>
<p>The outputs from the WDT are individually enabled/disabled using _EnableOutput()/_DisableOutput(). The clock divisor ratio and initial restart value of the count is configurable using _SetControlValues().</p>
<p>The reset condition of the hardware has the maximum initial count in the Counter Reset Value (CRV) and the WDT is disabled with the reset enable enabled and the reset length set to 32 clocks. i.e. </p>
<pre>
register ZMR = 0x1C2
register CCR = 0x3FC
</pre><p>This driver is intended to be RTOS and processor independent. It works with physical addresses only. Any needs for dynamic memory management, threads or thread mutual exclusion, virtual memory, or cache control must be satisfied by the layer above this driver.</p>
<pre>
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
----- ------ -------- -----------------------------------------------
1.00a ecm/jz 01/15/10 First release
1.01a asa 02/15/12 Added tcl file to generate xparameters
1.02a sg 07/15/12 Removed code/APIs related to External Signal
Length functionality for CR 658287
Removed APIs XWdtPs_SetExternalSignalLength,
XWdtPs_GetExternalSignalLength
Modified the Self Test to use the Reset Length mask
for CR 658287
</pre> </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>