embeddedsw/XilinxProcessorIPLib/drivers/tmrctr/doc/html/api/xtmrctr_8h.html
Nava kishore Manne d18411f597 Drivers: Doxygen changes for 2015.4
Signed-off-by: Nava kishore Manne <navam@xilinx.com>
2015-12-01 11:51:28 +05:30

123 lines
14 KiB
HTML
Executable file

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>tmrctr: xtmrctr.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">tmrctr
</div>
<div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Overview</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="globals.html"><span>APIs</span></a></li>
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_8149afbcf00aa40063719711769970ff.html">tmrctr</a></li><li class="navelem"><a class="el" href="dir_ee97852cfc3fa7cd29328bd40f8802a2.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xtmrctr.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_tmr_ctr___config.html">XTmrCtr_Config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_tmr_ctr_stats.html">XTmrCtrStats</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Configuration options</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These options are used in <a class="el" href="group__tmrctr__v4__0.html#ga93d796cf55144d6adb3c51fedf6c3b76" title="Enables the specified options for the specified timer counter. ">XTmrCtr_SetOptions()</a> and <a class="el" href="group__tmrctr__v4__0.html#gaaff209dc01c2946c239c6e5c1bdc1a5b" title="Get the options for the specified timer counter. ">XTmrCtr_GetOptions()</a> </p>
</div></td></tr>
<tr class="memitem:ga4fb085742ee50628791c81ff9a14bc2c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga4fb085742ee50628791c81ff9a14bc2c">XTC_CASCADE_MODE_OPTION</a>&#160;&#160;&#160;0x00000080UL</td></tr>
<tr class="separator:ga4fb085742ee50628791c81ff9a14bc2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga60d20c9562b95591c9d6000b21747135"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga60d20c9562b95591c9d6000b21747135">XTmrCtr_Handler</a>) (void *CallBackRef, u8 TmrCtrNumber)</td></tr>
<tr class="separator:ga60d20c9562b95591c9d6000b21747135"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5186828a046cd32bbf69874524e983d2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga5186828a046cd32bbf69874524e983d2">XTmrCtr_CfgInitialize</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, <a class="el" href="struct_x_tmr_ctr___config.html">XTmrCtr_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
<tr class="separator:ga5186828a046cd32bbf69874524e983d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3ffcfef4ba4507d5f2b9e17a08c7bf0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#gac3ffcfef4ba4507d5f2b9e17a08c7bf0">XTmrCtr_InitHw</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr)</td></tr>
<tr class="separator:gac3ffcfef4ba4507d5f2b9e17a08c7bf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad5f9b6172f448d2dd13d1c200ca37928"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#gad5f9b6172f448d2dd13d1c200ca37928">XTmrCtr_Initialize</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="separator:gad5f9b6172f448d2dd13d1c200ca37928"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga009c17ab4fcedf73279638dd97b6edd4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga009c17ab4fcedf73279638dd97b6edd4">XTmrCtr_Start</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber)</td></tr>
<tr class="separator:ga009c17ab4fcedf73279638dd97b6edd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab8156ff2a16b8efc0fcd3ed2b7ecf91a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#gab8156ff2a16b8efc0fcd3ed2b7ecf91a">XTmrCtr_Stop</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber)</td></tr>
<tr class="separator:gab8156ff2a16b8efc0fcd3ed2b7ecf91a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga325269055bb6f9f7a0c7f703bd2f2174"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga325269055bb6f9f7a0c7f703bd2f2174">XTmrCtr_GetValue</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber)</td></tr>
<tr class="separator:ga325269055bb6f9f7a0c7f703bd2f2174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga74b790866611a3ab1e96700feb48f6ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga74b790866611a3ab1e96700feb48f6ea">XTmrCtr_SetResetValue</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber, u32 ResetValue)</td></tr>
<tr class="separator:ga74b790866611a3ab1e96700feb48f6ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad8f339bdf71ed11fa92f08720c9ce663"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#gad8f339bdf71ed11fa92f08720c9ce663">XTmrCtr_GetCaptureValue</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber)</td></tr>
<tr class="separator:gad8f339bdf71ed11fa92f08720c9ce663"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga44d19561a31682753e4996c7b57d6982"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga44d19561a31682753e4996c7b57d6982">XTmrCtr_IsExpired</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber)</td></tr>
<tr class="separator:ga44d19561a31682753e4996c7b57d6982"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7b4ca5a0ac2199ee5341fddd8056500"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#gaa7b4ca5a0ac2199ee5341fddd8056500">XTmrCtr_Reset</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber)</td></tr>
<tr class="separator:gaa7b4ca5a0ac2199ee5341fddd8056500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga59bced86622b77630d18e731fbcec7f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_tmr_ctr___config.html">XTmrCtr_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga59bced86622b77630d18e731fbcec7f5">XTmrCtr_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="separator:ga59bced86622b77630d18e731fbcec7f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93d796cf55144d6adb3c51fedf6c3b76"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga93d796cf55144d6adb3c51fedf6c3b76">XTmrCtr_SetOptions</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber, u32 Options)</td></tr>
<tr class="separator:ga93d796cf55144d6adb3c51fedf6c3b76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaff209dc01c2946c239c6e5c1bdc1a5b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#gaaff209dc01c2946c239c6e5c1bdc1a5b">XTmrCtr_GetOptions</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber)</td></tr>
<tr class="separator:gaaff209dc01c2946c239c6e5c1bdc1a5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c99744f99aef2a019616e712206f1b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga3c99744f99aef2a019616e712206f1b0">XTmrCtr_GetStats</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, <a class="el" href="struct_x_tmr_ctr_stats.html">XTmrCtrStats</a> *StatsPtr)</td></tr>
<tr class="separator:ga3c99744f99aef2a019616e712206f1b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f51d8030e9d1a4edc588b0846e22e49"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga6f51d8030e9d1a4edc588b0846e22e49">XTmrCtr_ClearStats</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr)</td></tr>
<tr class="separator:ga6f51d8030e9d1a4edc588b0846e22e49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga42b972b6d7ae5d18a9bb2ca99446b1e7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga42b972b6d7ae5d18a9bb2ca99446b1e7">XTmrCtr_SelfTest</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, u8 TmrCtrNumber)</td></tr>
<tr class="separator:ga42b972b6d7ae5d18a9bb2ca99446b1e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9eb7b372c13b5e3493fec7370858309f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga9eb7b372c13b5e3493fec7370858309f">XTmrCtr_SetHandler</a> (<a class="el" href="struct_x_tmr_ctr.html">XTmrCtr</a> *InstancePtr, <a class="el" href="group__tmrctr__v4__0.html#ga60d20c9562b95591c9d6000b21747135">XTmrCtr_Handler</a> FuncPtr, void *CallBackRef)</td></tr>
<tr class="separator:ga9eb7b372c13b5e3493fec7370858309f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c00e99b19f58b5821c5541069ffb20b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tmrctr__v4__0.html#ga2c00e99b19f58b5821c5541069ffb20b">XTmrCtr_InterruptHandler</a> (void *InstancePtr)</td></tr>
<tr class="separator:ga2c00e99b19f58b5821c5541069ffb20b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
</ul>
</div>
</body>
</html>