b2a72ec74f
This patch updates the doxygen for the scutimer driver. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
61 lines
3.5 KiB
HTML
Executable file
61 lines
3.5 KiB
HTML
Executable file
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
Xilinx Driver scutimer v2_0: scutimer 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 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>scutimer v2_0</h1><p>The timer driver supports the Cortex A9 private timer.</p>
|
|
<p>The timer driver supports the following features:</p>
|
|
<ul>
|
|
<li>Normal mode and Auto reload mode</li>
|
|
<li>Interrupts (Interrupt handler is not provided in this driver. Application has to register it's own handler)</li>
|
|
</ul>
|
|
<p><b> Initialization and Configuration </b></p>
|
|
<p>The device driver enables higher layer software (e.g., an application) to communicate with the Timer.</p>
|
|
<p><a class="el" href="xscutimer_8c.html#ae35db1bdd114423a1e7fa858ffb8336f">XScuTimer_CfgInitialize()</a> API is used to initialize the Timer. The user needs to first call the <a class="el" href="xscutimer_8h.html#a434173b7a204dfa9b2a99d0776880d99">XScuTimer_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="xscutimer_8c.html#ae35db1bdd114423a1e7fa858ffb8336f">XScuTimer_CfgInitialize()</a> API.</p>
|
|
<p><b> Interrupts </b></p>
|
|
<p>The Timer hardware supports interrupts.</p>
|
|
<p>This driver does not provide a Interrupt Service Routine (ISR) for the device. It is the responsibility of the application to provide one if needed. Refer to the interrupt example provided with this driver for details on using the Timer in interrupt mode.</p>
|
|
<p><b> Virtual Memory </b></p>
|
|
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
|
|
<p><b> Threads </b></p>
|
|
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
|
|
<p><b> Asserts </b></p>
|
|
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.</p>
|
|
<p><b> Building the driver </b></p>
|
|
<p>The <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.</p>
|
|
<p><br/>
|
|
<br/>
|
|
</p>
|
|
<p>NOTE: The timer is not a part of the snoop control unit as indicated by the prefix "scu" in the name of the driver. It is an independent module in APU.</p>
|
|
<pre>
|
|
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
|
|
----- --- -------- ---------------------------------------------
|
|
1.00a nm 03/10/10 First release
|
|
1.02a sg 07/17/12 Included xil_assert.h for CR 667947. This is an issue
|
|
when the xstatus.h in the common driver overwrites
|
|
the xstatus.h of the standalone BSP during the
|
|
libgen.
|
|
</pre> </div>
|
|
<p class="Copyright">
|
|
Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
|
|
</p>
|
|
</body>
|
|
</html>
|