stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

doxygen: update doxygen for the scutimer driver.

Browse source 
This patch updates the doxygen for the scutimer driver.

Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
This commit is contained in:
Kedareswara rao Appana 2014-08-25 11:06:16 +05:30 • committed by Jagannadha Sutradharudu Teki
parent 783617f75b
commit b2a72ec74f
24 changed files with 2204 additions and 1729 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/Thumbs.db
View file

Binary file not shown.

41
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/annotated.html
View file

@ -2,27 +2,38 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Class List
Xilinx Driver scutimer v2_0: Class List
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a></td><td class="indexvalue"></td></tr>
</table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

39
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/classes.html Executable file
View file

@ -0,0 +1,39 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver scutimer v2_0: Alphabetical List
</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><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Class Index</h1><div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
<table align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
<tr><td><a name="letter_X"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&nbsp;&nbsp;X&nbsp;&nbsp;</div></td></tr></table>
</td><td><a class="el" href="struct_x_scu_timer.html">XScuTimer</a>&nbsp;&nbsp;&nbsp;</td><td><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>&nbsp;&nbsp;&nbsp;</td></tr></table><div class="qindex"><a class="qindex" href="#letter_X">X</a></div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

BIN
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/doxygen.png
View file

Binary file not shown.

334
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/driver_api_doxygen.css
View file

@ -1,334 +0,0 @@
BODY {
background-color: #FFFFFF;
font-family: Verdana, Arial, Helvetica, Sans-serif;
}
H1 {
margin-bottom: 0em;
font-size: 2.00em;
font-style: normal;
color: #990033;
}
H2 {
font-size: 1.05em;
font-style: normal;
color: #666666;
}
H3 {
font-size: 1.00em;
font-style: normal;
color: #000000;
}
H4 {
font-size: .90em;
font-style: italic;
color: #000000;
}
H5 {
font-size: .90em;
font-style: italic;
color: #000000;
}
H6 {
font-size: .90em;
font-style: italic;
color: #000000;
}
OL {
}
UL {
}
LI {
}
P {
color: #000000;
}
P.Caution {
color: #990033;
}
P.Code {
font-family: Courier New, Courier, Mono;
color: #003399;
}
P.HeadingDBox {
font-weight: bold;
}
P.HeadingGlossary {
font-weight: bold;
}
P.LinkGlossary {
margin-bottom: .50em;
}
P.Note {
}
P.SysInOut {
font-family: Courier New, Courier, Mono;
}
P.TableFootnote {
font-size: .80em;
margin-bottom: .70em;
}
P.TableHeading {
font-weight: bold;
color: #FFFFFF;
}
P.TableTitle {
font-style: italic;
font-weight: bold;
}
SPAN.aEmphasis {
font-style: italic;
}
SPAN.aFilename {
font-family: Courier New, Courier, Mono;
}
SPAN.aGUISysIn {
font-family: Verdana, Arial, Helvetica, Sans-serif;
font-weight: bold;
}
SPAN.aReference {
font-style: italic;
}
SPAN.aSysIn {
font-family: Courier New, Courier, Monospace;
font-weight: bold;
}
SPAN.aSysOut {
font-family: Courier New, Courier, Monospace;
}
SPAN.aSymbol {
font-family: Symbol;
}
CAPTION { font-weight: bold }
DIV.qindex {
width: 100%;
background-color: #eeeeff;
border: 1px solid #B0B0B0;
text-align: center;
margin: 2px;
padding: 2px;
}
A.qindex {
text-decoration: none;
font-weight: bold;
color: #1A419D;
padding: 2px;
}
A.qindex:visited {
text-decoration: none;
font-weight: bold;
color: #1A419D
padding: 2px;
}
A.qindex:hover {
text-decoration: none;
background-color: #ddddff;
padding: 2px;
}
A.qindexHL {
text-decoration: none;
font-weight: bold;
background-color: #6666cc;
color: #ffffff;
padding: 2 6px;
border: 1px double #9295C2;
}
A.qindexHL:hover {
text-decoration: none;
background-color: #6666cc;
color: #ffffff;
padding: 2px 6px;
}
A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff }
A.el { text-decoration: none; font-weight: bold }
A.elRef { font-weight: bold }
A.code { text-decoration: none; font-weight: normal; color: #1A419D}
A.codeRef { font-weight: normal; color: #1A419D}
A:hover { text-decoration: none; background-color: #f2f2ff }
DL.el { margin-left: -1cm }
PRE.fragment {
border: 1px solid #CCCCCC;
background-color: #f5f5f5;
margin-top: 4px;
margin-bottom: 4px;
margin-left: 2px;
margin-right: 8px;
padding-left: 6px;
padding-right: 6px;
padding-top: 4px;
padding-bottom: 4px;
}
DIV.fragment {
border: 1px solid #CCCCCC;
background-color: #f5f5f5;
padding: 6px;
}
DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
TD.md { background-color: #F4F4FB; font-weight: bold; }
TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; }
TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; }
DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold }
DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller }
BODY {
background: white;
color: black;
margin-right: 20px;
margin-left: 20px;
}
TD.indexkey {
background-color: #eeeeff;
font-weight: bold;
padding-right : 10px;
padding-top : 2px;
padding-left : 10px;
padding-bottom : 2px;
margin-left : 0px;
margin-right : 0px;
margin-top : 2px;
margin-bottom : 2px;
border: 1px solid #CCCCCC;
}
TD.indexvalue {
background-color: #eeeeff;
font-style: italic;
padding-right : 10px;
padding-top : 2px;
padding-left : 10px;
padding-bottom : 2px;
margin-left : 0px;
margin-right : 0px;
margin-top : 2px;
margin-bottom : 2px;
border: 1px solid #CCCCCC;
}
TR.memlist {
background-color: #f0f0f0;
}
P.formulaDsp { text-align: center; }
IMG.formulaDsp { }
IMG.formulaInl { vertical-align: middle; }
SPAN.keyword { color: #008000 }
SPAN.keywordtype { color: #604020 }
SPAN.keywordflow { color: #e08000 }
SPAN.comment { color: #800000 }
SPAN.preprocessor { color: #806020 }
SPAN.stringliteral { color: #002080 }
SPAN.charliteral { color: #008080 }
.mdTable {
border: 1px solid #868686;
background-color: #F4F4FB;
}
.mdRow {
padding: 8px 10px;
}
.mdescLeft {
font-size: smaller;
font-family: Verdana, Arial, Helvetica, sans-serif;
background-color: #FAFAFA;
padding-left: 8px;
border-top: 1px none #E0E0E0;
border-right: 1px none #E0E0E0;
border-bottom: 1px none #E0E0E0;
border-left: 1px none #E0E0E0;
margin: 0px;
}
.mdescRight {
font-size: smaller;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-style: italic;
background-color: #FAFAFA;
padding-left: 4px;
border-top: 1px none #E0E0E0;
border-right: 1px none #E0E0E0;
border-bottom: 1px none #E0E0E0;
border-left: 1px none #E0E0E0;
margin: 0px;
padding-bottom: 0px;
padding-right: 8px;
}
.memItemLeft {
padding: 1px 0px 0px 8px;
margin: 4px;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-style: solid;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
background-color: #FAFAFA;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 12px;
}
.memItemRight {
padding: 1px 0px 0px 8px;
margin: 4px;
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-style: solid;
border-top-color: #E0E0E0;
border-right-color: #E0E0E0;
border-bottom-color: #E0E0E0;
border-left-color: #E0E0E0;
border-right-style: none;
border-bottom-style: none;
border-left-style: none;
background-color: #FAFAFA;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 13px;
}
.search { color: #003399;
font-weight: bold;
}
FORM.search {
margin-bottom: 0px;
margin-top: 0px;
}
INPUT.search { font-size: 75%;
color: #000080;
font-weight: normal;
background-color: #eeeeff;
}
TD.tiny { font-size: 75%;
}
a {
color: #252E78;
}
a:visited {
color: #3D2185;
}

44
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/files.html
View file

@ -2,30 +2,42 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
File Index
Xilinx Driver scutimer v2_0: File Index
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>File List</h1>Here is a list of all files with brief descriptions:<table>
<tr><td class="indexkey"><a class="el" href="xscutimer_8c.html">xscutimer.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xscutimer_8h.html">xscutimer.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xscutimer__g_8c.html">xscutimer_g.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xscutimer__selftest_8c.html">xscutimer_selftest.c</a></td><td class="indexvalue"></td></tr>
<tr><td class="indexkey"><a class="el" href="xscutimer__sinit_8c.html">xscutimer_sinit.c</a></td><td class="indexvalue"></td></tr>
</table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

75
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions.html
View file

@ -2,38 +2,57 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Class Members
Xilinx Driver scutimer v2_0: Class Members
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
</div>
Here is a list of all documented class members with links to the class documentation for each member:
<p>
<ul>
<div class="contents">
Here is a list of all class members with links to the classes they belong to:<ul>
<li>BaseAddr
: <a class="el" href="struct_x_scu_timer___config.html#4a795cf4295903cb3e7dee5f6496e9b2">XScuTimer_Config</a><li>Config
: <a class="el" href="struct_x_scu_timer.html#fa535ffb25e1fd20341652f9be21e06e">XScuTimer</a><li>DeviceId
: <a class="el" href="struct_x_scu_timer___config.html#d0263c6cf0769cabc86cfe88226d204b">XScuTimer_Config</a><li>IsReady
: <a class="el" href="struct_x_scu_timer.html#217c41df00b2eee11e1009f5e63905ed">XScuTimer</a><li>IsStarted
: <a class="el" href="struct_x_scu_timer.html#63a64646c360777ff67124e566d34c6e">XScuTimer</a></ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
: <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config</a>
</li>
<li>Config
: <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer</a>
</li>
<li>DeviceId
: <a class="el" href="struct_x_scu_timer___config.html#a5dd6111c3cec690eb023ef2e25dadb35">XScuTimer_Config</a>
</li>
<li>IsReady
: <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer</a>
</li>
<li>IsStarted
: <a class="el" href="struct_x_scu_timer.html#aa0f089c744abd0bbd2e9b86e494241a5">XScuTimer</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

75
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/functions_vars.html
View file

@ -2,38 +2,57 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Class Members - Variables
Xilinx Driver scutimer v2_0: Class Members - Variables
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li id="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="functions.html"><span>All</span></a></li>
<li id="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li class="current"><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="functions.html"><span>All</span></a></li>
<li class="current"><a href="functions_vars.html"><span>Variables</span></a></li>
</ul>
</div>
</div>
&nbsp;
<p>
<ul>
<div class="contents">
&nbsp;<ul>
<li>BaseAddr
: <a class="el" href="struct_x_scu_timer___config.html#4a795cf4295903cb3e7dee5f6496e9b2">XScuTimer_Config</a><li>Config
: <a class="el" href="struct_x_scu_timer.html#fa535ffb25e1fd20341652f9be21e06e">XScuTimer</a><li>DeviceId
: <a class="el" href="struct_x_scu_timer___config.html#d0263c6cf0769cabc86cfe88226d204b">XScuTimer_Config</a><li>IsReady
: <a class="el" href="struct_x_scu_timer.html#217c41df00b2eee11e1009f5e63905ed">XScuTimer</a><li>IsStarted
: <a class="el" href="struct_x_scu_timer.html#63a64646c360777ff67124e566d34c6e">XScuTimer</a></ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
: <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config</a>
</li>
<li>Config
: <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer</a>
</li>
<li>DeviceId
: <a class="el" href="struct_x_scu_timer___config.html#a5dd6111c3cec690eb023ef2e25dadb35">XScuTimer_Config</a>
</li>
<li>IsReady
: <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer</a>
</li>
<li>IsStarted
: <a class="el" href="struct_x_scu_timer.html#aa0f089c744abd0bbd2e9b86e494241a5">XScuTimer</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

223
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals.html
View file

@ -2,62 +2,181 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Class Members
Xilinx Driver scutimer v2_0: Class Members
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li id="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li class="current"><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
Here is a list of all documented file members with links to the documentation:
<p>
<ul>
<div class="contents">
Here is a list of all file members with links to the files they belong to:
<h3><a class="anchor" id="index_x">- x -</a></h3><ul>
<li>XScuTimer_CfgInitialize()
: <a class="el" href="xscutimer_8c.html#e07fcd40f2b6a398fa271cefc6fc6860">xscutimer.c</a><li>XScuTimer_ConfigTable
: <a class="el" href="xscutimer__g_8c.html#4ffc85df99bf3910a76bcce2c16f6128">xscutimer_g.c</a><li>XSCUTIMER_CONTROL_AUTO_RELOAD_MASK
: <a class="el" href="xscutimer__hw_8h.html#3113ed719f3113c1c12b25c487b32cdf">xscutimer_hw.h</a><li>XSCUTIMER_CONTROL_ENABLE_MASK
: <a class="el" href="xscutimer__hw_8h.html#ac964bc4cc856919f1f0da8757693da7">xscutimer_hw.h</a><li>XSCUTIMER_CONTROL_IRQ_ENABLE_MASK
: <a class="el" href="xscutimer__hw_8h.html#16b7fb1d0e2290b5490c529170863202">xscutimer_hw.h</a><li>XSCUTIMER_CONTROL_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#926f373c358dbd998f5649720ff5df60">xscutimer_hw.h</a><li>XSCUTIMER_CONTROL_PRESCALER_MASK
: <a class="el" href="xscutimer__hw_8h.html#a07159ff4e44fd30a78617d9e72d8844">xscutimer_hw.h</a><li>XSCUTIMER_COUNTER_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#66ea9220a7e3d1982f6021c0e250bba9">xscutimer_hw.h</a><li>XScuTimer_GetControlReg
: <a class="el" href="xscutimer__hw_8h.html#9b736471858b58a6e51abf43cb08692d">xscutimer_hw.h</a><li>XScuTimer_GetCounterReg
: <a class="el" href="xscutimer__hw_8h.html#b702cdc48e32170cfb9cb0912f2b043a">xscutimer_hw.h</a><li>XScuTimer_GetIntrReg
: <a class="el" href="xscutimer__hw_8h.html#40b2e2457732f27f1e55bbc8a6de6775">xscutimer_hw.h</a><li>XScuTimer_GetLoadReg
: <a class="el" href="xscutimer__hw_8h.html#869dabba06711c436937107d52cae9c2">xscutimer_hw.h</a><li>XScuTimer_GetPrescaler()
: <a class="el" href="xscutimer_8c.html#7425f95cbe5a2d3bb0ab0cb41814fd13">xscutimer.c</a><li>XSCUTIMER_ISR_EVENT_FLAG_MASK
: <a class="el" href="xscutimer__hw_8h.html#22854a034df0044bd7cac0009120ef73">xscutimer_hw.h</a><li>XSCUTIMER_ISR_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#a5f4d9505e2dba71f0fed7738e84da05">xscutimer_hw.h</a><li>XSCUTIMER_LOAD_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#0a93b534d57ebd2c0364bdff3ce571bc">xscutimer_hw.h</a><li>XScuTimer_LookupConfig()
: <a class="el" href="xscutimer__sinit_8c.html#95063dbcb9e072f9faf6ceb46e142e43">xscutimer_sinit.c</a><li>XScuTimer_ReadReg
: <a class="el" href="xscutimer__hw_8h.html#72a7a3eb3d7e4ee57c78f4c0bdba0542">xscutimer_hw.h</a><li>XScuTimer_SelfTest()
: <a class="el" href="xscutimer__selftest_8c.html#45abefddd52b5f85df773c9e3d0f9532">xscutimer_selftest.c</a><li>XScuTimer_SetControlReg
: <a class="el" href="xscutimer__hw_8h.html#efe9bcecc8615cd4b2cf954a7526591f">xscutimer_hw.h</a><li>XScuTimer_SetCounterReg
: <a class="el" href="xscutimer__hw_8h.html#05868737d454740745b88d0688a4fac2">xscutimer_hw.h</a><li>XScuTimer_SetIntrReg
: <a class="el" href="xscutimer__hw_8h.html#10e3b533e1754d26bff75c5f845ca28a">xscutimer_hw.h</a><li>XScuTimer_SetLoadReg
: <a class="el" href="xscutimer__hw_8h.html#7ea67a8f266e64cc47d10c33227fe7e8">xscutimer_hw.h</a><li>XScuTimer_SetPrescaler()
: <a class="el" href="xscutimer_8c.html#5934d18e525110e91e6251e2d58322ed">xscutimer.c</a><li>XScuTimer_Start()
: <a class="el" href="xscutimer_8c.html#fbcbdd7a4dc1b76c439fc1727d853d7c">xscutimer.c</a><li>XScuTimer_Stop()
: <a class="el" href="xscutimer_8c.html#42899541fdb070b9c0cdfb2b77f262c5">xscutimer.c</a><li>XScuTimer_WriteReg
: <a class="el" href="xscutimer__hw_8h.html#e5544d1d77c67e2501b1f59bfc9db087">xscutimer_hw.h</a></ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
: <a class="el" href="xscutimer_8c.html#ae35db1bdd114423a1e7fa858ffb8336f">xscutimer.c</a>
, <a class="el" href="xscutimer_8h.html#ae35db1bdd114423a1e7fa858ffb8336f">xscutimer.h</a>
</li>
<li>XScuTimer_ClearInterruptStatus
: <a class="el" href="xscutimer_8h.html#adc11e29fe8f755683fbc6edc883e0a4d">xscutimer.h</a>
</li>
<li>XScuTimer_ConfigTable
: <a class="el" href="xscutimer__g_8c.html#ac54aa07186803163582a0d3c4f96a686">xscutimer_g.c</a>
</li>
<li>XSCUTIMER_CONTROL_AUTO_RELOAD_MASK
: <a class="el" href="xscutimer__hw_8h.html#aeaf7add0552b3b0c5ab78b6668a88d6a">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_ENABLE_MASK
: <a class="el" href="xscutimer__hw_8h.html#a242deea9cc62049619bdfd97e7a731f4">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_IRQ_ENABLE_MASK
: <a class="el" href="xscutimer__hw_8h.html#a62c9d23e23b5329976291d26cc36c6a6">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_PRESCALER_MASK
: <a class="el" href="xscutimer__hw_8h.html#a867b2da6f5e9b1d921c34a925d4b498a">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_PRESCALER_SHIFT
: <a class="el" href="xscutimer__hw_8h.html#a31316fbcb2292f6d29c39a025bbd9821">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_COUNTER_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#aa96f9778b3fb95bb968793b504bee53e">xscutimer_hw.h</a>
</li>
<li>XScuTimer_DisableAutoReload
: <a class="el" href="xscutimer_8h.html#a29b90dcea87e70190d47c53e89977c8a">xscutimer.h</a>
</li>
<li>XScuTimer_DisableInterrupt
: <a class="el" href="xscutimer_8h.html#ac3ea67683ec802381c4aef819d04768b">xscutimer.h</a>
</li>
<li>XScuTimer_EnableAutoReload
: <a class="el" href="xscutimer_8h.html#a54fc490ff5bdcfa76eddddf5fc5dc5bf">xscutimer.h</a>
</li>
<li>XScuTimer_EnableInterrupt
: <a class="el" href="xscutimer_8h.html#a41e184373a4d02ce8a9aec1601a52c04">xscutimer.h</a>
</li>
<li>XScuTimer_GetControlReg
: <a class="el" href="xscutimer__hw_8h.html#a1427e7cc324917e9bc062ea9cc1976ac">xscutimer_hw.h</a>
</li>
<li>XScuTimer_GetCounterReg
: <a class="el" href="xscutimer__hw_8h.html#a65cf8fca671de7e21a9944c43bf7cd8a">xscutimer_hw.h</a>
</li>
<li>XScuTimer_GetCounterValue
: <a class="el" href="xscutimer_8h.html#a494afe8a54f75991a1e63fcef913df41">xscutimer.h</a>
</li>
<li>XScuTimer_GetInterruptStatus
: <a class="el" href="xscutimer_8h.html#ab653a0c97cfb913f3cabeaa3a9167586">xscutimer.h</a>
</li>
<li>XScuTimer_GetIntrReg
: <a class="el" href="xscutimer__hw_8h.html#a48d158b4cc15416e7d4a62867720b79a">xscutimer_hw.h</a>
</li>
<li>XScuTimer_GetLoadReg
: <a class="el" href="xscutimer__hw_8h.html#a3eedf4e335232d3303b1fd3927f10213">xscutimer_hw.h</a>
</li>
<li>XScuTimer_GetPrescaler()
: <a class="el" href="xscutimer_8c.html#a56d8c36e4aa28168de3ba5d7f87feb2d">xscutimer.c</a>
, <a class="el" href="xscutimer_8h.html#a56d8c36e4aa28168de3ba5d7f87feb2d">xscutimer.h</a>
</li>
<li>XSCUTIMER_H
: <a class="el" href="xscutimer_8h.html#a0e6142d11b3ee5ef331787855f179762">xscutimer.h</a>
</li>
<li>XSCUTIMER_HW_H
: <a class="el" href="xscutimer__hw_8h.html#a9cdd1aa68f5988c97573b70f60dc5d08">xscutimer_hw.h</a>
</li>
<li>XScuTimer_IsExpired
: <a class="el" href="xscutimer_8h.html#aac033729416a2ae86fec784a89a4c653">xscutimer.h</a>
</li>
<li>XSCUTIMER_ISR_EVENT_FLAG_MASK
: <a class="el" href="xscutimer__hw_8h.html#afa21717c99e101943a7075d4e2e30ca1">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_ISR_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#a79f4aab3a1968e66ae1fadb846e7b8c8">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_LOAD_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#ae86109b8ee86ede103995c458720c743">xscutimer_hw.h</a>
</li>
<li>XScuTimer_LoadTimer
: <a class="el" href="xscutimer_8h.html#a94fbce5d53f983ec5cf675cfc97f4f78">xscutimer.h</a>
</li>
<li>XScuTimer_LookupConfig()
: <a class="el" href="xscutimer__sinit_8c.html#a434173b7a204dfa9b2a99d0776880d99">xscutimer_sinit.c</a>
, <a class="el" href="xscutimer_8h.html#a434173b7a204dfa9b2a99d0776880d99">xscutimer.h</a>
</li>
<li>XScuTimer_ReadReg
: <a class="el" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">xscutimer_hw.h</a>
</li>
<li>XScuTimer_RestartTimer
: <a class="el" href="xscutimer_8h.html#af1976650946668999ca5107fef691e53">xscutimer.h</a>
</li>
<li>XScuTimer_SelfTest()
: <a class="el" href="xscutimer__selftest_8c.html#a06b9885ee26427833fd3fb7b7ad33ec5">xscutimer_selftest.c</a>
, <a class="el" href="xscutimer_8h.html#a06b9885ee26427833fd3fb7b7ad33ec5">xscutimer.h</a>
</li>
<li>XSCUTIMER_SELFTEST_VALUE
: <a class="el" href="xscutimer__selftest_8c.html#a2795253b5bea39b3ca8e8bf96bec03f5">xscutimer_selftest.c</a>
</li>
<li>XScuTimer_SetControlReg
: <a class="el" href="xscutimer__hw_8h.html#ae0b71c6aa97a846b93c4a5fa2092be9e">xscutimer_hw.h</a>
</li>
<li>XScuTimer_SetCounterReg
: <a class="el" href="xscutimer__hw_8h.html#a162738ee853ef5fc9c4fa35bf9c2bb8d">xscutimer_hw.h</a>
</li>
<li>XScuTimer_SetIntrReg
: <a class="el" href="xscutimer__hw_8h.html#affc9febb953169fb57818c4c58fd68fc">xscutimer_hw.h</a>
</li>
<li>XScuTimer_SetLoadReg
: <a class="el" href="xscutimer__hw_8h.html#ae3cd5f68d2ce17dd72a4abaf4afe06a6">xscutimer_hw.h</a>
</li>
<li>XScuTimer_SetPrescaler()
: <a class="el" href="xscutimer_8c.html#ac6cd65141b00c0d1940d0b8f2a081faf">xscutimer.c</a>
, <a class="el" href="xscutimer_8h.html#ac6cd65141b00c0d1940d0b8f2a081faf">xscutimer.h</a>
</li>
<li>XScuTimer_Start()
: <a class="el" href="xscutimer_8h.html#abf24fad576d3adab4b53eebdef424bde">xscutimer.h</a>
, <a class="el" href="xscutimer_8c.html#abf24fad576d3adab4b53eebdef424bde">xscutimer.c</a>
</li>
<li>XScuTimer_Stop()
: <a class="el" href="xscutimer_8h.html#aac0376fbfeb5c29bb44403d6fefd0843">xscutimer.h</a>
, <a class="el" href="xscutimer_8c.html#aac0376fbfeb5c29bb44403d6fefd0843">xscutimer.c</a>
</li>
<li>XScuTimer_WriteReg
: <a class="el" href="xscutimer__hw_8h.html#a6f29815a4f21529bfc3d009932d3c2fe">xscutimer_hw.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

182
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_defs.html
View file

@ -2,54 +2,150 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Class Members
Xilinx Driver scutimer v2_0: Class Members
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li id="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="#index_x"><span>x</span></a></li>
</ul>
</div>
</div>
<div class="contents">
&nbsp;
<p>
<ul>
<h3><a class="anchor" id="index_x">- x -</a></h3><ul>
<li>XScuTimer_ClearInterruptStatus
: <a class="el" href="xscutimer_8h.html#adc11e29fe8f755683fbc6edc883e0a4d">xscutimer.h</a>
</li>
<li>XSCUTIMER_CONTROL_AUTO_RELOAD_MASK
: <a class="el" href="xscutimer__hw_8h.html#3113ed719f3113c1c12b25c487b32cdf">xscutimer_hw.h</a><li>XSCUTIMER_CONTROL_ENABLE_MASK
: <a class="el" href="xscutimer__hw_8h.html#ac964bc4cc856919f1f0da8757693da7">xscutimer_hw.h</a><li>XSCUTIMER_CONTROL_IRQ_ENABLE_MASK
: <a class="el" href="xscutimer__hw_8h.html#16b7fb1d0e2290b5490c529170863202">xscutimer_hw.h</a><li>XSCUTIMER_CONTROL_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#926f373c358dbd998f5649720ff5df60">xscutimer_hw.h</a><li>XSCUTIMER_CONTROL_PRESCALER_MASK
: <a class="el" href="xscutimer__hw_8h.html#a07159ff4e44fd30a78617d9e72d8844">xscutimer_hw.h</a><li>XSCUTIMER_COUNTER_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#66ea9220a7e3d1982f6021c0e250bba9">xscutimer_hw.h</a><li>XScuTimer_GetControlReg
: <a class="el" href="xscutimer__hw_8h.html#9b736471858b58a6e51abf43cb08692d">xscutimer_hw.h</a><li>XScuTimer_GetCounterReg
: <a class="el" href="xscutimer__hw_8h.html#b702cdc48e32170cfb9cb0912f2b043a">xscutimer_hw.h</a><li>XScuTimer_GetIntrReg
: <a class="el" href="xscutimer__hw_8h.html#40b2e2457732f27f1e55bbc8a6de6775">xscutimer_hw.h</a><li>XScuTimer_GetLoadReg
: <a class="el" href="xscutimer__hw_8h.html#869dabba06711c436937107d52cae9c2">xscutimer_hw.h</a><li>XSCUTIMER_ISR_EVENT_FLAG_MASK
: <a class="el" href="xscutimer__hw_8h.html#22854a034df0044bd7cac0009120ef73">xscutimer_hw.h</a><li>XSCUTIMER_ISR_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#a5f4d9505e2dba71f0fed7738e84da05">xscutimer_hw.h</a><li>XSCUTIMER_LOAD_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#0a93b534d57ebd2c0364bdff3ce571bc">xscutimer_hw.h</a><li>XScuTimer_ReadReg
: <a class="el" href="xscutimer__hw_8h.html#72a7a3eb3d7e4ee57c78f4c0bdba0542">xscutimer_hw.h</a><li>XScuTimer_SetControlReg
: <a class="el" href="xscutimer__hw_8h.html#efe9bcecc8615cd4b2cf954a7526591f">xscutimer_hw.h</a><li>XScuTimer_SetCounterReg
: <a class="el" href="xscutimer__hw_8h.html#05868737d454740745b88d0688a4fac2">xscutimer_hw.h</a><li>XScuTimer_SetIntrReg
: <a class="el" href="xscutimer__hw_8h.html#10e3b533e1754d26bff75c5f845ca28a">xscutimer_hw.h</a><li>XScuTimer_SetLoadReg
: <a class="el" href="xscutimer__hw_8h.html#7ea67a8f266e64cc47d10c33227fe7e8">xscutimer_hw.h</a><li>XScuTimer_WriteReg
: <a class="el" href="xscutimer__hw_8h.html#e5544d1d77c67e2501b1f59bfc9db087">xscutimer_hw.h</a></ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
: <a class="el" href="xscutimer__hw_8h.html#aeaf7add0552b3b0c5ab78b6668a88d6a">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_ENABLE_MASK
: <a class="el" href="xscutimer__hw_8h.html#a242deea9cc62049619bdfd97e7a731f4">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_IRQ_ENABLE_MASK
: <a class="el" href="xscutimer__hw_8h.html#a62c9d23e23b5329976291d26cc36c6a6">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_PRESCALER_MASK
: <a class="el" href="xscutimer__hw_8h.html#a867b2da6f5e9b1d921c34a925d4b498a">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_CONTROL_PRESCALER_SHIFT
: <a class="el" href="xscutimer__hw_8h.html#a31316fbcb2292f6d29c39a025bbd9821">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_COUNTER_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#aa96f9778b3fb95bb968793b504bee53e">xscutimer_hw.h</a>
</li>
<li>XScuTimer_DisableAutoReload
: <a class="el" href="xscutimer_8h.html#a29b90dcea87e70190d47c53e89977c8a">xscutimer.h</a>
</li>
<li>XScuTimer_DisableInterrupt
: <a class="el" href="xscutimer_8h.html#ac3ea67683ec802381c4aef819d04768b">xscutimer.h</a>
</li>
<li>XScuTimer_EnableAutoReload
: <a class="el" href="xscutimer_8h.html#a54fc490ff5bdcfa76eddddf5fc5dc5bf">xscutimer.h</a>
</li>
<li>XScuTimer_EnableInterrupt
: <a class="el" href="xscutimer_8h.html#a41e184373a4d02ce8a9aec1601a52c04">xscutimer.h</a>
</li>
<li>XScuTimer_GetControlReg
: <a class="el" href="xscutimer__hw_8h.html#a1427e7cc324917e9bc062ea9cc1976ac">xscutimer_hw.h</a>
</li>
<li>XScuTimer_GetCounterReg
: <a class="el" href="xscutimer__hw_8h.html#a65cf8fca671de7e21a9944c43bf7cd8a">xscutimer_hw.h</a>
</li>
<li>XScuTimer_GetCounterValue
: <a class="el" href="xscutimer_8h.html#a494afe8a54f75991a1e63fcef913df41">xscutimer.h</a>
</li>
<li>XScuTimer_GetInterruptStatus
: <a class="el" href="xscutimer_8h.html#ab653a0c97cfb913f3cabeaa3a9167586">xscutimer.h</a>
</li>
<li>XScuTimer_GetIntrReg
: <a class="el" href="xscutimer__hw_8h.html#a48d158b4cc15416e7d4a62867720b79a">xscutimer_hw.h</a>
</li>
<li>XScuTimer_GetLoadReg
: <a class="el" href="xscutimer__hw_8h.html#a3eedf4e335232d3303b1fd3927f10213">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_H
: <a class="el" href="xscutimer_8h.html#a0e6142d11b3ee5ef331787855f179762">xscutimer.h</a>
</li>
<li>XSCUTIMER_HW_H
: <a class="el" href="xscutimer__hw_8h.html#a9cdd1aa68f5988c97573b70f60dc5d08">xscutimer_hw.h</a>
</li>
<li>XScuTimer_IsExpired
: <a class="el" href="xscutimer_8h.html#aac033729416a2ae86fec784a89a4c653">xscutimer.h</a>
</li>
<li>XSCUTIMER_ISR_EVENT_FLAG_MASK
: <a class="el" href="xscutimer__hw_8h.html#afa21717c99e101943a7075d4e2e30ca1">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_ISR_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#a79f4aab3a1968e66ae1fadb846e7b8c8">xscutimer_hw.h</a>
</li>
<li>XSCUTIMER_LOAD_OFFSET
: <a class="el" href="xscutimer__hw_8h.html#ae86109b8ee86ede103995c458720c743">xscutimer_hw.h</a>
</li>
<li>XScuTimer_LoadTimer
: <a class="el" href="xscutimer_8h.html#a94fbce5d53f983ec5cf675cfc97f4f78">xscutimer.h</a>
</li>
<li>XScuTimer_ReadReg
: <a class="el" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">xscutimer_hw.h</a>
</li>
<li>XScuTimer_RestartTimer
: <a class="el" href="xscutimer_8h.html#af1976650946668999ca5107fef691e53">xscutimer.h</a>
</li>
<li>XSCUTIMER_SELFTEST_VALUE
: <a class="el" href="xscutimer__selftest_8c.html#a2795253b5bea39b3ca8e8bf96bec03f5">xscutimer_selftest.c</a>
</li>
<li>XScuTimer_SetControlReg
: <a class="el" href="xscutimer__hw_8h.html#ae0b71c6aa97a846b93c4a5fa2092be9e">xscutimer_hw.h</a>
</li>
<li>XScuTimer_SetCounterReg
: <a class="el" href="xscutimer__hw_8h.html#a162738ee853ef5fc9c4fa35bf9c2bb8d">xscutimer_hw.h</a>
</li>
<li>XScuTimer_SetIntrReg
: <a class="el" href="xscutimer__hw_8h.html#affc9febb953169fb57818c4c58fd68fc">xscutimer_hw.h</a>
</li>
<li>XScuTimer_SetLoadReg
: <a class="el" href="xscutimer__hw_8h.html#ae3cd5f68d2ce17dd72a4abaf4afe06a6">xscutimer_hw.h</a>
</li>
<li>XScuTimer_WriteReg
: <a class="el" href="xscutimer__hw_8h.html#a6f29815a4f21529bfc3d009932d3c2fe">xscutimer_hw.h</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

94
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_func.html
View file

@ -2,42 +2,72 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Class Members
Xilinx Driver scutimer v2_0: Class Members
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li id="current"><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li class="current"><a href="globals_func.html"><span>Functions</span></a></li>
<li><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div>
&nbsp;
<p>
<ul>
<div class="contents">
&nbsp;<ul>
<li>XScuTimer_CfgInitialize()
: <a class="el" href="xscutimer_8c.html#e07fcd40f2b6a398fa271cefc6fc6860">xscutimer.c</a><li>XScuTimer_GetPrescaler()
: <a class="el" href="xscutimer_8c.html#7425f95cbe5a2d3bb0ab0cb41814fd13">xscutimer.c</a><li>XScuTimer_LookupConfig()
: <a class="el" href="xscutimer__sinit_8c.html#95063dbcb9e072f9faf6ceb46e142e43">xscutimer_sinit.c</a><li>XScuTimer_SelfTest()
: <a class="el" href="xscutimer__selftest_8c.html#45abefddd52b5f85df773c9e3d0f9532">xscutimer_selftest.c</a><li>XScuTimer_SetPrescaler()
: <a class="el" href="xscutimer_8c.html#5934d18e525110e91e6251e2d58322ed">xscutimer.c</a><li>XScuTimer_Start()
: <a class="el" href="xscutimer_8c.html#fbcbdd7a4dc1b76c439fc1727d853d7c">xscutimer.c</a><li>XScuTimer_Stop()
: <a class="el" href="xscutimer_8c.html#42899541fdb070b9c0cdfb2b77f262c5">xscutimer.c</a></ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
: <a class="el" href="xscutimer_8c.html#ae35db1bdd114423a1e7fa858ffb8336f">xscutimer.c</a>
, <a class="el" href="xscutimer_8h.html#ae35db1bdd114423a1e7fa858ffb8336f">xscutimer.h</a>
</li>
<li>XScuTimer_GetPrescaler()
: <a class="el" href="xscutimer_8h.html#a56d8c36e4aa28168de3ba5d7f87feb2d">xscutimer.h</a>
, <a class="el" href="xscutimer_8c.html#a56d8c36e4aa28168de3ba5d7f87feb2d">xscutimer.c</a>
</li>
<li>XScuTimer_LookupConfig()
: <a class="el" href="xscutimer_8h.html#a434173b7a204dfa9b2a99d0776880d99">xscutimer.h</a>
, <a class="el" href="xscutimer__sinit_8c.html#a434173b7a204dfa9b2a99d0776880d99">xscutimer_sinit.c</a>
</li>
<li>XScuTimer_SelfTest()
: <a class="el" href="xscutimer__selftest_8c.html#a06b9885ee26427833fd3fb7b7ad33ec5">xscutimer_selftest.c</a>
, <a class="el" href="xscutimer_8h.html#a06b9885ee26427833fd3fb7b7ad33ec5">xscutimer.h</a>
</li>
<li>XScuTimer_SetPrescaler()
: <a class="el" href="xscutimer_8c.html#ac6cd65141b00c0d1940d0b8f2a081faf">xscutimer.c</a>
, <a class="el" href="xscutimer_8h.html#ac6cd65141b00c0d1940d0b8f2a081faf">xscutimer.h</a>
</li>
<li>XScuTimer_Start()
: <a class="el" href="xscutimer_8c.html#abf24fad576d3adab4b53eebdef424bde">xscutimer.c</a>
, <a class="el" href="xscutimer_8h.html#abf24fad576d3adab4b53eebdef424bde">xscutimer.h</a>
</li>
<li>XScuTimer_Stop()
: <a class="el" href="xscutimer_8h.html#aac0376fbfeb5c29bb44403d6fefd0843">xscutimer.h</a>
, <a class="el" href="xscutimer_8c.html#aac0376fbfeb5c29bb44403d6fefd0843">xscutimer.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

63
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/globals_vars.html
View file

@ -2,36 +2,47 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Class Members
Xilinx Driver scutimer v2_0: Class Members
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li id="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li id="current"><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li class="current"><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="globals.html"><span>All</span></a></li>
<li><a href="globals_func.html"><span>Functions</span></a></li>
<li class="current"><a href="globals_vars.html"><span>Variables</span></a></li>
<li><a href="globals_defs.html"><span>Defines</span></a></li>
</ul>
</div>
</div>
&nbsp;
<p>
<ul>
<div class="contents">
&nbsp;<ul>
<li>XScuTimer_ConfigTable
: <a class="el" href="xscutimer__g_8c.html#4ffc85df99bf3910a76bcce2c16f6128">xscutimer_g.c</a></ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
: <a class="el" href="xscutimer__g_8c.html#ac54aa07186803163582a0d3c4f96a686">xscutimer_g.c</a>
</li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

82
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/index.html
View file

@ -2,52 +2,60 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xscutimer v2_0
Xilinx Driver scutimer v2_0: scutimer v2_0
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li id="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>
<h1>xscutimer v2_0</h1>
<p>
The timer driver supports the Cortex A9 private timer.<p>
The timer driver supports the following features:<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>
The device driver enables higher layer software (e.g., an application) to communicate with the Timer.<p>
<a class="el" href="xscutimer_8c.html#e07fcd40f2b6a398fa271cefc6fc6860">XScuTimer_CfgInitialize()</a> API is used to initialize the Timer. The user needs to first call the <a class="el" href="xscutimer__sinit_8c.html#95063dbcb9e072f9faf6ceb46e142e43">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#e07fcd40f2b6a398fa271cefc6fc6860">XScuTimer_CfgInitialize()</a> API.<p>
<b> Interrupts </b><p>
The Timer hardware supports interrupts.<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>
<b> Virtual Memory </b><p>
This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.<p>
<b> Threads </b><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>
<b> Asserts </b><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>
<b> Building the driver </b><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>
<br>
<br>
<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>
<!-- 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>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><p>
<pre> Ver Who Date Changes
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.0 hk 03/07/14 Version number revised.
</pre> Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
</pre> </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

49
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer-members.html
View file

@ -2,27 +2,38 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Member List
Xilinx Driver scutimer v2_0: Member List
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>XScuTimer Member List</h1>This is the complete list of members for <a class="el" href="struct_x_scu_timer.html">XScuTimer</a>, including all inherited members.<p><table>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer.html#fa535ffb25e1fd20341652f9be21e06e">Config</a></td><td><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer.html#217c41df00b2eee11e1009f5e63905ed">IsReady</a></td><td><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer.html#63a64646c360777ff67124e566d34c6e">IsStarted</a></td><td><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td><td></td></tr>
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XScuTimer Member List</h1>This is the complete list of members for <a class="el" href="struct_x_scu_timer.html">XScuTimer</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">Config</a></td><td><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">IsReady</a></td><td><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer.html#aa0f089c744abd0bbd2e9b86e494241a5">IsStarted</a></td><td><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

159
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer.html
View file

@ -2,110 +2,93 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
XScuTimer Struct Reference
Xilinx Driver scutimer v2_0: XScuTimer Struct Reference
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>XScuTimer Struct Reference</h1><!-- doxytag: class="XScuTimer" --><code>#include &lt;xscutimer.h&gt;</code>
<p>
<a href="struct_x_scu_timer-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The XScuTimer driver instance data. The user is required to allocate a variable of this type for every timer device in the system. A pointer to a variable of this type is then passed to the driver API functions.
<p>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XScuTimer Struct Reference</h1><!-- doxytag: class="XScuTimer" -->
<p><code>#include &lt;xscutimer.h&gt;</code></p>
<p><a href="struct_x_scu_timer-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer.html#fa535ffb25e1fd20341652f9be21e06e">Config</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer.html#217c41df00b2eee11e1009f5e63905ed">IsReady</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer.html#63a64646c360777ff67124e566d34c6e">IsStarted</a></td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">Config</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">IsReady</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer.html#aa0f089c744abd0bbd2e9b86e494241a5">IsStarted</a></td></tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="fa535ffb25e1fd20341652f9be21e06e"></a><!-- doxytag: member="XScuTimer::Config" ref="fa535ffb25e1fd20341652f9be21e06e" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> driver instance data. The user is required to allocate a variable of this type for every timer device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a6dfa00cf1df32f581332123902bd2e0e"></a><!-- doxytag: member="XScuTimer::Config" ref="a6dfa00cf1df32f581332123902bd2e0e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> <a class="el" href="struct_x_scu_timer.html#fa535ffb25e1fd20341652f9be21e06e">XScuTimer::Config</a> </td>
<td class="memname"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> <a class="el" href="struct_x_scu_timer.html#a6dfa00cf1df32f581332123902bd2e0e">XScuTimer::Config</a></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
</div>
<div class="memdoc">
<p>Hardware Configuration </p>
<p>
Hardware Configuration </td>
</tr>
</table>
<a class="anchor" name="217c41df00b2eee11e1009f5e63905ed"></a><!-- doxytag: member="XScuTimer::IsReady" ref="217c41df00b2eee11e1009f5e63905ed" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
</div>
</div>
<a class="anchor" id="a348e1922cf71c91c233629655acaef32"></a><!-- doxytag: member="XScuTimer::IsReady" ref="a348e1922cf71c91c233629655acaef32" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_scu_timer.html#217c41df00b2eee11e1009f5e63905ed">XScuTimer::IsReady</a> </td>
<td class="memname">u32 <a class="el" href="struct_x_scu_timer.html#a348e1922cf71c91c233629655acaef32">XScuTimer::IsReady</a></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
</div>
<div class="memdoc">
<p>Device is initialized and ready </p>
<p>
Device is initialized and ready </td>
</tr>
</table>
<a class="anchor" name="63a64646c360777ff67124e566d34c6e"></a><!-- doxytag: member="XScuTimer::IsStarted" ref="63a64646c360777ff67124e566d34c6e" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
</div>
</div>
<a class="anchor" id="aa0f089c744abd0bbd2e9b86e494241a5"></a><!-- doxytag: member="XScuTimer::IsStarted" ref="aa0f089c744abd0bbd2e9b86e494241a5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_scu_timer.html#63a64646c360777ff67124e566d34c6e">XScuTimer::IsStarted</a> </td>
<td class="memname">u32 <a class="el" href="struct_x_scu_timer.html#aa0f089c744abd0bbd2e9b86e494241a5">XScuTimer::IsStarted</a></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
</div>
<div class="memdoc">
<p>Device timer is running </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="xscutimer_8h.html">xscutimer.h</a></li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
Device timer is running </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xscutimer.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

47
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config-members.html
View file

@ -2,26 +2,37 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Member List
Xilinx Driver scutimer v2_0: Member List
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>XScuTimer_Config Member List</h1>This is the complete list of members for <a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>, including all inherited members.<p><table>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer___config.html#4a795cf4295903cb3e7dee5f6496e9b2">BaseAddr</a></td><td><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer___config.html#d0263c6cf0769cabc86cfe88226d204b">DeviceId</a></td><td><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a></td><td></td></tr>
</table>Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XScuTimer_Config Member List</h1>This is the complete list of members for <a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>, including all inherited members.<table>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">BaseAddr</a></td><td><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a></td><td></td></tr>
<tr class="memlist"><td><a class="el" href="struct_x_scu_timer___config.html#a5dd6111c3cec690eb023ef2e25dadb35">DeviceId</a></td><td><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a></td><td></td></tr>
</table></div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

127
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/struct_x_scu_timer___config.html
View file

@ -2,85 +2,78 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
XScuTimer_Config Struct Reference
Xilinx Driver scutimer v2_0: XScuTimer_Config Struct Reference
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>XScuTimer_Config Struct Reference</h1><!-- doxytag: class="XScuTimer_Config" --><code>#include &lt;xscutimer.h&gt;</code>
<p>
<a href="struct_x_scu_timer___config-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
This typedef contains configuration information for the device.
<p>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XScuTimer_Config Struct Reference</h1><!-- doxytag: class="XScuTimer_Config" -->
<p><code>#include &lt;xscutimer.h&gt;</code></p>
<p><a href="struct_x_scu_timer___config-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer___config.html#d0263c6cf0769cabc86cfe88226d204b">DeviceId</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer___config.html#4a795cf4295903cb3e7dee5f6496e9b2">BaseAddr</a></td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer___config.html#a5dd6111c3cec690eb023ef2e25dadb35">DeviceId</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">BaseAddr</a></td></tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="4a795cf4295903cb3e7dee5f6496e9b2"></a><!-- doxytag: member="XScuTimer_Config::BaseAddr" ref="4a795cf4295903cb3e7dee5f6496e9b2" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This typedef contains configuration information for the device. </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a53dc49c2ec07c2bc40cd0c0b29d49bc0"></a><!-- doxytag: member="XScuTimer_Config::BaseAddr" ref="a53dc49c2ec07c2bc40cd0c0b29d49bc0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">u32 <a class="el" href="struct_x_scu_timer___config.html#4a795cf4295903cb3e7dee5f6496e9b2">XScuTimer_Config::BaseAddr</a> </td>
<td class="memname">u32 <a class="el" href="struct_x_scu_timer___config.html#a53dc49c2ec07c2bc40cd0c0b29d49bc0">XScuTimer_Config::BaseAddr</a></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
</div>
<div class="memdoc">
<p>Base address of the device </p>
<p>
Base address of the device </td>
</tr>
</table>
<a class="anchor" name="d0263c6cf0769cabc86cfe88226d204b"></a><!-- doxytag: member="XScuTimer_Config::DeviceId" ref="d0263c6cf0769cabc86cfe88226d204b" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
</div>
</div>
<a class="anchor" id="a5dd6111c3cec690eb023ef2e25dadb35"></a><!-- doxytag: member="XScuTimer_Config::DeviceId" ref="a5dd6111c3cec690eb023ef2e25dadb35" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">u16 <a class="el" href="struct_x_scu_timer___config.html#d0263c6cf0769cabc86cfe88226d204b">XScuTimer_Config::DeviceId</a> </td>
<td class="memname">u16 <a class="el" href="struct_x_scu_timer___config.html#a5dd6111c3cec690eb023ef2e25dadb35">XScuTimer_Config::DeviceId</a></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
</div>
<div class="memdoc">
<p>Unique ID of device </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="xscutimer_8h.html">xscutimer.h</a></li>
</ul>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>
<p>
Unique ID of device </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>xscutimer.h</ul>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.

15
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/tabs.css
View file

@ -32,7 +32,7 @@ DIV.tabs A
float : left;
background : url("tab_r.gif") no-repeat right top;
border-bottom : 1px solid #84B0C7;
font-size : x-small;
font-size : 80%;
font-weight : bold;
text-decoration : none;
}
@ -57,7 +57,7 @@ DIV.tabs SPAN
white-space : nowrap;
}
DIV.tabs INPUT
DIV.tabs #MSearchBox
{
float : right;
display : inline;
@ -66,7 +66,7 @@ DIV.tabs INPUT
DIV.tabs TD
{
font-size : x-small;
font-size : 80%;
font-weight : bold;
text-decoration : none;
}
@ -82,21 +82,24 @@ DIV.tabs A:hover SPAN
background-position: 0% -150px;
}
DIV.tabs LI#current A
DIV.tabs LI.current A
{
background-position: 100% -150px;
border-width : 0px;
}
DIV.tabs LI#current SPAN
DIV.tabs LI.current SPAN
{
background-position: 0% -150px;
padding-bottom : 6px;
}
DIV.nav
DIV.navpath
{
background : none;
border : none;
border-bottom : 1px solid #84B0C7;
text-align : center;
margin : 2px;
padding : 2px;
}

353
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8c.html
View file

@ -2,257 +2,216 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xscutimer.c File Reference
Xilinx Driver scutimer v2_0: xscutimer.c File Reference
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>xscutimer.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Contains the implementation of interface functions of the SCU Timer driver. See xscutimer.h for a description of the driver.<p>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xscutimer.c File Reference</h1><code>#include &quot;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#ae35db1bdd114423a1e7fa858ffb8336f">XScuTimer_CfgInitialize</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr, <a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#abf24fad576d3adab4b53eebdef424bde">XScuTimer_Start</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#aac0376fbfeb5c29bb44403d6fefd0843">XScuTimer_Stop</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#ac6cd65141b00c0d1940d0b8f2a081faf">XScuTimer_SetPrescaler</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr, u8 PrescalerValue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#a56d8c36e4aa28168de3ba5d7f87feb2d">XScuTimer_GetPrescaler</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Contains the implementation of interface functions of the SCU Timer driver. See <a class="el" href="xscutimer_8h.html">xscutimer.h</a> for a description of the driver.</p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
----- --- -------- ---------------------------------------------
1.00a nm 03/10/10 First release
</pre>
<p>
<code>#include &quot;xscutimer.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#e07fcd40f2b6a398fa271cefc6fc6860">XScuTimer_CfgInitialize</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr, <a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#fbcbdd7a4dc1b76c439fc1727d853d7c">XScuTimer_Start</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#42899541fdb070b9c0cdfb2b77f262c5">XScuTimer_Stop</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#5934d18e525110e91e6251e2d58322ed">XScuTimer_SetPrescaler</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr, u8 PrescalerValue)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8c.html#7425f95cbe5a2d3bb0ab0cb41814fd13">XScuTimer_GetPrescaler</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="e07fcd40f2b6a398fa271cefc6fc6860"></a><!-- doxytag: member="xscutimer.c::XScuTimer_CfgInitialize" ref="e07fcd40f2b6a398fa271cefc6fc6860" args="(XScuTimer *InstancePtr, XScuTimer_Config *ConfigPtr, u32 EffectiveAddress)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
</pre> <hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae35db1bdd114423a1e7fa858ffb8336f"></a><!-- doxytag: member="xscutimer.c::XScuTimer_CfgInitialize" ref="ae35db1bdd114423a1e7fa858ffb8336f" args="(XScuTimer *InstancePtr, XScuTimer_Config *ConfigPtr, u32 EffectiveAddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">int XScuTimer_CfgInitialize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
<td class="memname">int XScuTimer_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>ConfigPtr</em>, </td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *&nbsp;</td>
<td class="paramname"> <em>ConfigPtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u32&nbsp;</td>
<td class="mdname" nowrap> <em>EffectiveAddress</em></td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddress</em></td><td>&nbsp;</td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Initialize a specific timer instance/driver. This function must be called before other functions of the driver are called.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
</div>
<div class="memdoc">
<p>Initialize a specific timer instance/driver. This function must be called before other functions of the driver are called.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ConfigPtr</em>&nbsp;</td><td>points to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> configuration structure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddress</em>&nbsp;</td><td>is the base address for the device. It could be a virtual address if address translation is supported in the system, otherwise it is the physical address.</td></tr>
</table>
</dd>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li><li>XST_DEVICE_IS_STARTED if the device has already been started.</li></ul>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li>
<li>XST_DEVICE_IS_STARTED if the device has already been started.</li>
</ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="7425f95cbe5a2d3bb0ab0cb41814fd13"></a><!-- doxytag: member="xscutimer.c::XScuTimer_GetPrescaler" ref="7425f95cbe5a2d3bb0ab0cb41814fd13" args="(XScuTimer *InstancePtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a56d8c36e4aa28168de3ba5d7f87feb2d"></a><!-- doxytag: member="xscutimer.c::XScuTimer_GetPrescaler" ref="a56d8c36e4aa28168de3ba5d7f87feb2d" args="(XScuTimer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">u8 XScuTimer_GetPrescaler </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>InstancePtr</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
<td class="memname">u8 XScuTimer_GetPrescaler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function returns the current prescaler value.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
</div>
<div class="memdoc">
<p>This function returns the current prescaler value.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The prescaler value.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="5934d18e525110e91e6251e2d58322ed"></a><!-- doxytag: member="xscutimer.c::XScuTimer_SetPrescaler" ref="5934d18e525110e91e6251e2d58322ed" args="(XScuTimer *InstancePtr, u8 PrescalerValue)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<dl class="return"><dt><b>Returns:</b></dt><dd>The prescaler value.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ac6cd65141b00c0d1940d0b8f2a081faf"></a><!-- doxytag: member="xscutimer.c::XScuTimer_SetPrescaler" ref="ac6cd65141b00c0d1940d0b8f2a081faf" args="(XScuTimer *InstancePtr, u8 PrescalerValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">void XScuTimer_SetPrescaler </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
<td class="memname">void XScuTimer_SetPrescaler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u8&nbsp;</td>
<td class="mdname" nowrap> <em>PrescalerValue</em></td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>PrescalerValue</em></td><td>&nbsp;</td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function sets the prescaler bits in the timer control register.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
</div>
<div class="memdoc">
<p>This function sets the prescaler bits in the timer control register.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>PrescalerValue</em>&nbsp;</td><td>is a 8 bit value that sets the prescaler to use.</td></tr>
</table>
</dd>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="fbcbdd7a4dc1b76c439fc1727d853d7c"></a><!-- doxytag: member="xscutimer.c::XScuTimer_Start" ref="fbcbdd7a4dc1b76c439fc1727d853d7c" args="(XScuTimer *InstancePtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="abf24fad576d3adab4b53eebdef424bde"></a><!-- doxytag: member="xscutimer.c::XScuTimer_Start" ref="abf24fad576d3adab4b53eebdef424bde" args="(XScuTimer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">void XScuTimer_Start </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>InstancePtr</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
<td class="memname">void XScuTimer_Start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Start the timer.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
</div>
<div class="memdoc">
<p>Start the timer.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="42899541fdb070b9c0cdfb2b77f262c5"></a><!-- doxytag: member="xscutimer.c::XScuTimer_Stop" ref="42899541fdb070b9c0cdfb2b77f262c5" args="(XScuTimer *InstancePtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="aac0376fbfeb5c29bb44403d6fefd0843"></a><!-- doxytag: member="xscutimer.c::XScuTimer_Stop" ref="aac0376fbfeb5c29bb44403d6fefd0843" args="(XScuTimer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">void XScuTimer_Stop </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>InstancePtr</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
<td class="memname">void XScuTimer_Stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Stop the timer.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
</div>
<div class="memdoc">
<p>Stop the timer.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

617
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer_8h.html Executable file
View file

@ -0,0 +1,617 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver scutimer v2_0: xscutimer.h File Reference
</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><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xscutimer.h File Reference</h1><code>#include &quot;xstatus.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a0e6142d11b3ee5ef331787855f179762">XSCUTIMER_H</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#aac033729416a2ae86fec784a89a4c653">XScuTimer_IsExpired</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#af1976650946668999ca5107fef691e53">XScuTimer_RestartTimer</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a94fbce5d53f983ec5cf675cfc97f4f78">XScuTimer_LoadTimer</a>(InstancePtr, Value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a494afe8a54f75991a1e63fcef913df41">XScuTimer_GetCounterValue</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a54fc490ff5bdcfa76eddddf5fc5dc5bf">XScuTimer_EnableAutoReload</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a29b90dcea87e70190d47c53e89977c8a">XScuTimer_DisableAutoReload</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a41e184373a4d02ce8a9aec1601a52c04">XScuTimer_EnableInterrupt</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#ac3ea67683ec802381c4aef819d04768b">XScuTimer_DisableInterrupt</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#ab653a0c97cfb913f3cabeaa3a9167586">XScuTimer_GetInterruptStatus</a>(InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#adc11e29fe8f755683fbc6edc883e0a4d">XScuTimer_ClearInterruptStatus</a>(InstancePtr)</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a434173b7a204dfa9b2a99d0776880d99">XScuTimer_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a06b9885ee26427833fd3fb7b7ad33ec5">XScuTimer_SelfTest</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#ae35db1bdd114423a1e7fa858ffb8336f">XScuTimer_CfgInitialize</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr, <a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *ConfigPtr, u32 EffectiveAddress)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#abf24fad576d3adab4b53eebdef424bde">XScuTimer_Start</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#aac0376fbfeb5c29bb44403d6fefd0843">XScuTimer_Stop</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#ac6cd65141b00c0d1940d0b8f2a081faf">XScuTimer_SetPrescaler</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr, u8 PrescalerValue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer_8h.html#a56d8c36e4aa28168de3ba5d7f87feb2d">XScuTimer_GetPrescaler</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="adc11e29fe8f755683fbc6edc883e0a4d"></a><!-- doxytag: member="xscutimer.h::XScuTimer_ClearInterruptStatus" ref="adc11e29fe8f755683fbc6edc883e0a4d" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_ClearInterruptStatus</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer__hw_8h.html#a6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>, <a class="code" href="xscutimer__hw_8h.html#afa21717c99e101943a7075d4e2e30ca1">XSCUTIMER_ISR_EVENT_FLAG_MASK</a>)
</pre></div><p>This function clears the interrupt status.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xscutimer_8h.html#adc11e29fe8f755683fbc6edc883e0a4d">XScuTimer_ClearInterruptStatus(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a29b90dcea87e70190d47c53e89977c8a"></a><!-- doxytag: member="xscutimer.h::XScuTimer_DisableAutoReload" ref="a29b90dcea87e70190d47c53e89977c8a" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_DisableAutoReload</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer__hw_8h.html#a6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, \
(<a class="code" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>) &amp; \
~(<a class="code" href="xscutimer__hw_8h.html#aeaf7add0552b3b0c5ab78b6668a88d6a">XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</a>)))
</pre></div><p>Disable auto-reload mode.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xscutimer_8h.html#a29b90dcea87e70190d47c53e89977c8a">XScuTimer_DisableAutoReload(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac3ea67683ec802381c4aef819d04768b"></a><!-- doxytag: member="xscutimer.h::XScuTimer_DisableInterrupt" ref="ac3ea67683ec802381c4aef819d04768b" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_DisableInterrupt</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer__hw_8h.html#a6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, \
(<a class="code" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>) &amp; \
~(<a class="code" href="xscutimer__hw_8h.html#a62c9d23e23b5329976291d26cc36c6a6">XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</a>)))
</pre></div><p>Disable the Timer interrupt.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xscutimer_8h.html#ac3ea67683ec802381c4aef819d04768b">XScuTimer_DisableInterrupt(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a54fc490ff5bdcfa76eddddf5fc5dc5bf"></a><!-- doxytag: member="xscutimer.h::XScuTimer_EnableAutoReload" ref="a54fc490ff5bdcfa76eddddf5fc5dc5bf" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_EnableAutoReload</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer__hw_8h.html#a6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, \
(<a class="code" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>) | \
<a class="code" href="xscutimer__hw_8h.html#aeaf7add0552b3b0c5ab78b6668a88d6a">XSCUTIMER_CONTROL_AUTO_RELOAD_MASK</a>))
</pre></div><p>Enable auto-reload mode.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xscutimer_8h.html#a54fc490ff5bdcfa76eddddf5fc5dc5bf">XScuTimer_EnableAutoReload(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a41e184373a4d02ce8a9aec1601a52c04"></a><!-- doxytag: member="xscutimer.h::XScuTimer_EnableInterrupt" ref="a41e184373a4d02ce8a9aec1601a52c04" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_EnableInterrupt</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer__hw_8h.html#a6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>, \
(<a class="code" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a8f0a12cb3bfff490af76bc9a3ffca4be">XSCUTIMER_CONTROL_OFFSET</a>) | \
<a class="code" href="xscutimer__hw_8h.html#a62c9d23e23b5329976291d26cc36c6a6">XSCUTIMER_CONTROL_IRQ_ENABLE_MASK</a>))
</pre></div><p>Enable the Timer interrupt.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xscutimer_8h.html#a41e184373a4d02ce8a9aec1601a52c04">XScuTimer_EnableInterrupt(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a494afe8a54f75991a1e63fcef913df41"></a><!-- doxytag: member="xscutimer.h::XScuTimer_GetCounterValue" ref="a494afe8a54f75991a1e63fcef913df41" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_GetCounterValue</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#aa96f9778b3fb95bb968793b504bee53e">XSCUTIMER_COUNTER_OFFSET</a>)
</pre></div><p>Returns the current timer counter register value. It can be called at any time.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Contents of the timer counter register.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xscutimer_8h.html#a494afe8a54f75991a1e63fcef913df41">XScuTimer_GetCounterValue(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab653a0c97cfb913f3cabeaa3a9167586"></a><!-- doxytag: member="xscutimer.h::XScuTimer_GetInterruptStatus" ref="ab653a0c97cfb913f3cabeaa3a9167586" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_GetInterruptStatus</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>)
</pre></div><p>This function reads the interrupt status.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xscutimer_8h.html#ab653a0c97cfb913f3cabeaa3a9167586">XScuTimer_GetInterruptStatus(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0e6142d11b3ee5ef331787855f179762"></a><!-- doxytag: member="xscutimer.h::XSCUTIMER_H" ref="a0e6142d11b3ee5ef331787855f179762" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XSCUTIMER_H</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aac033729416a2ae86fec784a89a4c653"></a><!-- doxytag: member="xscutimer.h::XScuTimer_IsExpired" ref="aac033729416a2ae86fec784a89a4c653" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_IsExpired</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#a79f4aab3a1968e66ae1fadb846e7b8c8">XSCUTIMER_ISR_OFFSET</a>) &amp; \
<a class="code" href="xscutimer__hw_8h.html#afa21717c99e101943a7075d4e2e30ca1">XSCUTIMER_ISR_EVENT_FLAG_MASK</a>) == \
<a class="code" href="xscutimer__hw_8h.html#afa21717c99e101943a7075d4e2e30ca1">XSCUTIMER_ISR_EVENT_FLAG_MASK</a>)
</pre></div><p>Check if the timer has expired.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>TRUE if the timer has expired.</li>
<li>FALSE if the timer has not expired.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: int <a class="el" href="xscutimer_8h.html#aac033729416a2ae86fec784a89a4c653">XScuTimer_IsExpired(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a94fbce5d53f983ec5cf675cfc97f4f78"></a><!-- doxytag: member="xscutimer.h::XScuTimer_LoadTimer" ref="a94fbce5d53f983ec5cf675cfc97f4f78" args="(InstancePtr, Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_LoadTimer</td>
<td>(</td>
<td class="paramtype">InstancePtr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Value&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer__hw_8h.html#a6f29815a4f21529bfc3d009932d3c2fe">XScuTimer_WriteReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#ae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>, Value)
</pre></div><p>Write to the timer load register. This will also update the timer counter register with the new value. This macro can be used to change the time-out value.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Value</em>&nbsp;</td><td>is the count to be loaded in to the load register.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xscutimer_8h.html#a94fbce5d53f983ec5cf675cfc97f4f78">XScuTimer_LoadTimer(XScuTimer *InstancePtr, u32 Value)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af1976650946668999ca5107fef691e53"></a><!-- doxytag: member="xscutimer.h::XScuTimer_RestartTimer" ref="af1976650946668999ca5107fef691e53" args="(InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XScuTimer_RestartTimer</td>
<td>(</td>
<td class="paramtype">InstancePtr&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xscutimer_8h.html#a94fbce5d53f983ec5cf675cfc97f4f78">XScuTimer_LoadTimer</a>(InstancePtr, \
<a class="code" href="xscutimer__hw_8h.html#ae4c784baaac425e11d6a1184ae44b349">XScuTimer_ReadReg</a>((InstancePtr)-&gt;Config.BaseAddr, \
<a class="code" href="xscutimer__hw_8h.html#ae86109b8ee86ede103995c458720c743">XSCUTIMER_LOAD_OFFSET</a>))
</pre></div><p>Re-start the timer. This macro will read the timer load register and writes the same value to load register to update the counter register.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xscutimer_8h.html#af1976650946668999ca5107fef691e53">XScuTimer_RestartTimer(XScuTimer *InstancePtr)</a> </dd></dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae35db1bdd114423a1e7fa858ffb8336f"></a><!-- doxytag: member="xscutimer.h::XScuTimer_CfgInitialize" ref="ae35db1bdd114423a1e7fa858ffb8336f" args="(XScuTimer *InstancePtr, XScuTimer_Config *ConfigPtr, u32 EffectiveAddress)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XScuTimer_CfgInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *&nbsp;</td>
<td class="paramname"> <em>ConfigPtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&nbsp;</td>
<td class="paramname"> <em>EffectiveAddress</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize a specific timer instance/driver. This function must be called before other functions of the driver are called.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ConfigPtr</em>&nbsp;</td><td>points to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> configuration structure. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddress</em>&nbsp;</td><td>is the base address for the device. It could be a virtual address if address translation is supported in the system, otherwise it is the physical address.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li>
<li>XST_DEVICE_IS_STARTED if the device has already been started.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a56d8c36e4aa28168de3ba5d7f87feb2d"></a><!-- doxytag: member="xscutimer.h::XScuTimer_GetPrescaler" ref="a56d8c36e4aa28168de3ba5d7f87feb2d" args="(XScuTimer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u8 XScuTimer_GetPrescaler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the current prescaler value.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The prescaler value.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a434173b7a204dfa9b2a99d0776880d99"></a><!-- doxytag: member="xscutimer.h::XScuTimer_LookupConfig" ref="a434173b7a204dfa9b2a99d0776880d99" args="(u16 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>* XScuTimer_LookupConfig </td>
<td>(</td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>DeviceId</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lookup the device configuration based on the unique device ID. The table contains the configuration info for each device in the system.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>DeviceId</em>&nbsp;</td><td>is the unique device ID of the device being looked up.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a06b9885ee26427833fd3fb7b7ad33ec5"></a><!-- doxytag: member="xscutimer.h::XScuTimer_SelfTest" ref="a06b9885ee26427833fd3fb7b7ad33ec5" args="(XScuTimer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XScuTimer_SelfTest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Run a self-test on the timer. This test clears the timer enable bit in the control register, writes to the timer load register and verifies the value read back matches the value written and restores the control register and the timer load register.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if self-test was successful.</li>
<li>XST_FAILURE if self test was not successful.</li>
</ul>
</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ac6cd65141b00c0d1940d0b8f2a081faf"></a><!-- doxytag: member="xscutimer.h::XScuTimer_SetPrescaler" ref="ac6cd65141b00c0d1940d0b8f2a081faf" args="(XScuTimer *InstancePtr, u8 PrescalerValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XScuTimer_SetPrescaler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8&nbsp;</td>
<td class="paramname"> <em>PrescalerValue</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the prescaler bits in the timer control register.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>PrescalerValue</em>&nbsp;</td><td>is a 8 bit value that sets the prescaler to use.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
</div>
</div>
<a class="anchor" id="abf24fad576d3adab4b53eebdef424bde"></a><!-- doxytag: member="xscutimer.h::XScuTimer_Start" ref="abf24fad576d3adab4b53eebdef424bde" args="(XScuTimer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XScuTimer_Start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start the timer.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="aac0376fbfeb5c29bb44403d6fefd0843"></a><!-- doxytag: member="xscutimer.h::XScuTimer_Stop" ref="aac0376fbfeb5c29bb44403d6fefd0843" args="(XScuTimer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XScuTimer_Stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop the timer.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

97
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__g_8c.html
View file

@ -2,70 +2,67 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xscutimer_g.c File Reference
Xilinx Driver scutimer v2_0: xscutimer_g.c File Reference
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>xscutimer_g.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains a table that specifies the configuration of the SCU Timer in the system.<p>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xscutimer_g.c File Reference</h1><code>#include &quot;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&quot;</code><br/>
<code>#include &quot;xparameters.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer__g_8c.html#ac54aa07186803163582a0d3c4f96a686">XScuTimer_ConfigTable</a> [XPAR_XSCUTIMER_NUM_INSTANCES]</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This file contains a table that specifies the configuration of the SCU Timer in the system.</p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
----- --- -------- ---------------------------------------------
1.00a nm 03/10/10 First release
</pre>
<p>
<code>#include &quot;xscutimer.h&quot;</code><br>
<code>#include &quot;xparameters.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer__g_8c.html#4ffc85df99bf3910a76bcce2c16f6128">XScuTimer_ConfigTable</a> [XPAR_XSCUTIMER_NUM_INSTANCES]</td></tr>
</table>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="4ffc85df99bf3910a76bcce2c16f6128"></a><!-- doxytag: member="xscutimer_g.c::XScuTimer_ConfigTable" ref="4ffc85df99bf3910a76bcce2c16f6128" args="[XPAR_XSCUTIMER_NUM_INSTANCES]" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
</pre> <hr/><h2>Variable Documentation</h2>
<a class="anchor" id="ac54aa07186803163582a0d3c4f96a686"></a><!-- doxytag: member="xscutimer_g.c::XScuTimer_ConfigTable" ref="ac54aa07186803163582a0d3c4f96a686" args="[XPAR_XSCUTIMER_NUM_INSTANCES]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> <a class="el" href="xscutimer__g_8c.html#4ffc85df99bf3910a76bcce2c16f6128">XScuTimer_ConfigTable</a>[XPAR_XSCUTIMER_NUM_INSTANCES] </td>
<td class="memname"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> <a class="el" href="xscutimer__g_8c.html#ac54aa07186803163582a0d3c4f96a686">XScuTimer_ConfigTable</a>[XPAR_XSCUTIMER_NUM_INSTANCES]</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment"> {
{
XPAR_XSCUTIMER_0_DEVICE_ID,
XPAR_XSCUTIMER_0_BASEADDR
}
}
</pre></div>This table contains configuration information for each timer device in the system. </td>
</tr>
</table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
</pre></div><p>This table contains configuration information for each timer device in the system. </p>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

971
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__hw_8h.html
View file

File diff suppressed because it is too large Load diff

131
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__selftest_8c.html
View file

@ -2,78 +2,93 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xscutimer_selftest.c File Reference
Xilinx Driver scutimer v2_0: xscutimer_selftest.c File Reference
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>xscutimer_selftest.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Contains diagnostic self-test functions for the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> driver.<p>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xscutimer_selftest.c File Reference</h1><code>#include &quot;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer__selftest_8c.html#a2795253b5bea39b3ca8e8bf96bec03f5">XSCUTIMER_SELFTEST_VALUE</a>&nbsp;&nbsp;&nbsp;0xA55AF00F</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer__selftest_8c.html#a06b9885ee26427833fd3fb7b7ad33ec5">XScuTimer_SelfTest</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Contains diagnostic self-test functions for the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> driver.</p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
----- --- -------- ---------------------------------------------
1.00a nm 03/10/10 First release
</pre>
<p>
<code>#include &quot;xscutimer.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer__selftest_8c.html#45abefddd52b5f85df773c9e3d0f9532">XScuTimer_SelfTest</a> (<a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *InstancePtr)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="45abefddd52b5f85df773c9e3d0f9532"></a><!-- doxytag: member="xscutimer_selftest.c::XScuTimer_SelfTest" ref="45abefddd52b5f85df773c9e3d0f9532" args="(XScuTimer *InstancePtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
</pre> <hr/><h2>Define Documentation</h2>
<a class="anchor" id="a2795253b5bea39b3ca8e8bf96bec03f5"></a><!-- doxytag: member="xscutimer_selftest.c::XSCUTIMER_SELFTEST_VALUE" ref="a2795253b5bea39b3ca8e8bf96bec03f5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top">int XScuTimer_SelfTest </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>InstancePtr</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
<td class="memname">#define XSCUTIMER_SELFTEST_VALUE&nbsp;&nbsp;&nbsp;0xA55AF00F</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
</div>
<div class="memdoc">
<p>
Run a self-test on the timer. This test clears the timer enable bit in the control register, writes to the timer load register and verifies the value read back matches the value written and restores the control register and the timer load register.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a06b9885ee26427833fd3fb7b7ad33ec5"></a><!-- doxytag: member="xscutimer_selftest.c::XScuTimer_SelfTest" ref="a06b9885ee26427833fd3fb7b7ad33ec5" args="(XScuTimer *InstancePtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int XScuTimer_SelfTest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_x_scu_timer.html">XScuTimer</a> *&nbsp;</td>
<td class="paramname"> <em>InstancePtr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Run a self-test on the timer. This test clears the timer enable bit in the control register, writes to the timer load register and verifies the value read back matches the value written and restores the control register and the timer load register.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_scu_timer.html">XScuTimer</a> instance.</td></tr>
</table>
</dd>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if self-test was successful.</li><li>XST_FAILURE if self test was not successful.</li></ul>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>XST_SUCCESS if self-test was successful.</li>
<li>XST_FAILURE if self test was not successful.</li>
</ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>

115
XilinxProcessorIPLib/drivers/scutimer/doc/html/api/xscutimer__sinit_8c.html
View file

@ -2,77 +2,74 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
xscutimer_sinit.c File Reference
Xilinx Driver scutimer v2_0: xscutimer_sinit.c File Reference
</title>
<link href="$DriverApiDocsCssPath" rel="stylesheet" type="text/css">
<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.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>xscutimer_sinit.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains method for static initialization (compile-time) of the driver.<p>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>xscutimer_sinit.c File Reference</h1><code>#include &quot;<a class="el" href="xscutimer_8h.html">xscutimer.h</a>&quot;</code><br/>
<code>#include &quot;xparameters.h&quot;</code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer__sinit_8c.html#a434173b7a204dfa9b2a99d0776880d99">XScuTimer_LookupConfig</a> (u16 DeviceId)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This file contains method for static initialization (compile-time) of the driver.</p>
<pre>
MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
----- --- -------- ---------------------------------------------
1.00a nm 03/10/10 First release
</pre>
<p>
<code>#include &quot;xscutimer.h&quot;</code><br>
<code>#include &quot;xparameters.h&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xscutimer__sinit_8c.html#95063dbcb9e072f9faf6ceb46e142e43">XScuTimer_LookupConfig</a> (u16 DeviceId)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="95063dbcb9e072f9faf6ceb46e142e43"></a><!-- doxytag: member="xscutimer_sinit.c::XScuTimer_LookupConfig" ref="95063dbcb9e072f9faf6ceb46e142e43" args="(u16 DeviceId)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
</pre> <hr/><h2>Function Documentation</h2>
<a class="anchor" id="a434173b7a204dfa9b2a99d0776880d99"></a><!-- doxytag: member="xscutimer_sinit.c::XScuTimer_LookupConfig" ref="a434173b7a204dfa9b2a99d0776880d99" args="(u16 DeviceId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>* XScuTimer_LookupConfig </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">u16&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>DeviceId</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
<td class="memname"><a class="el" href="struct_x_scu_timer___config.html">XScuTimer_Config</a>* XScuTimer_LookupConfig </td>
<td>(</td>
<td class="paramtype">u16&nbsp;</td>
<td class="paramname"> <em>DeviceId</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Lookup the device configuration based on the unique device ID. The table contains the configuration info for each device in the system.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
</div>
<div class="memdoc">
<p>Lookup the device configuration based on the unique device ID. The table contains the configuration info for each device in the system.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>DeviceId</em>&nbsp;</td><td>is the unique device ID of the device being looked up.</td></tr>
</table>
</dd>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>None. </dd></dl>
</td>
</tr>
</table>
Copyright @ 1995-2014 Xilinx, Inc. All rights reserved.
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the configuration table entry corresponding to the given device ID, or NULL if no match is found.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
</div>
</div>
</div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>