84 lines
4.9 KiB
HTML
Executable file
84 lines
4.9 KiB
HTML
Executable file
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.10"/>
|
|
<title>scutimer: Main Page</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">scutimer
|
|
</div>
|
|
<div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li class="current"><a href="index.html"><span>Overview</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="globals.html"><span>APIs</span></a></li>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">scutimer Documentation</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>The timer driver supports the Cortex A9 private timer.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="group__scutimer__v2__1.html#ga59badd651be237aab4099cedd96621d2" title="Initialize a specific timer instance/driver. ">XScuTimer_CfgInitialize()</a> API is used to initialize the Timer. The user needs to first call the <a class="el" href="group__scutimer__v2__1.html#ga1e7db0f5795151c2d6538dae1fd07a16" title="Lookup the device configuration based on the unique device ID. ">XScuTimer_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="group__scutimer__v2__1.html#ga59badd651be237aab4099cedd96621d2" title="Initialize a specific timer instance/driver. ">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" title="The XScuTimer driver instance data. ">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.
|
|
2.1 sk 02/26/15 Modified the code for MISRA-C:2012 compliance.
|
|
</pre> </div></div><!-- contents -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Copyright © 2015 Xilinx Inc. All rights reserved.</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|