618 lines
35 KiB
HTML
618 lines
35 KiB
HTML
|
<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 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 List</span></a></li>
|
||
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="contents">
|
||
|
|
<h1>xscutimer.h File Reference</h1><code>#include "xstatus.h"</code><br/>
|
||
|
|
<code>#include "<a class="el" href="xscutimer__hw_8h.html">xscutimer_hw.h</a>"</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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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> * </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 </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 </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 </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 </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 </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 </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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)->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>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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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)->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>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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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)->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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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)->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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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>) == \
|
||
|
|
<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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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> </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> </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 </td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </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)->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> </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> * </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> * </td>
|
||
|
|
<td class="paramname"> <em>ConfigPtr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">u32 </td>
|
||
|
|
<td class="paramname"> <em>EffectiveAddress</em></td><td> </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> </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> </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> </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> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </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> </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 </td>
|
||
|
|
<td class="paramname"> <em>DeviceId</em></td>
|
||
|
|
<td> ) </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> </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> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </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> </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> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">u8 </td>
|
||
|
|
<td class="paramname"> <em>PrescalerValue</em></td><td> </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> </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> </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> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </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> </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> * </td>
|
||
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
||
|
|
<td> ) </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> </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 © 1995-2014 Xilinx, Inc. All rights reserved.
|
||
|
|
</p>
|
||
|
|
</body>
|
||
|
|
</html>
|