embeddedsw/XilinxProcessorIPLib/drivers/ttcps/doc/html/api/xttcps_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

121 lines
13 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>ttcps: xttcps.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">ttcps
</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_de725b611eced9b1a5bbcdbbde197eb0.html">ttcps</a></li><li class="navelem"><a class="el" href="dir_2a60228f1ec814985abe6694c86e28fb.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xttcps.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_ttc_ps___config.html">XTtcPs_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_ttc_ps.html">XTtcPs</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 class="memitem:gada91222b52c938cb8639d333ed334273"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#gada91222b52c938cb8639d333ed334273">XTtcPs_Start</a>(InstancePtr)</td></tr>
<tr class="separator:gada91222b52c938cb8639d333ed334273"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8cc3413150e3c510e47cdb706fc3583e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga8cc3413150e3c510e47cdb706fc3583e">XTtcPs_Stop</a>(InstancePtr)</td></tr>
<tr class="separator:ga8cc3413150e3c510e47cdb706fc3583e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga90395ec5242c1fce193ad5697ee976c3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga90395ec5242c1fce193ad5697ee976c3">XTtcPs_IsStarted</a>(InstancePtr)</td></tr>
<tr class="separator:ga90395ec5242c1fce193ad5697ee976c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e333879788d146e762e8a114159e9e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga2e333879788d146e762e8a114159e9e5">XTtcPs_GetCounterValue</a>(InstancePtr)&#160;&#160;&#160;(u16)InstReadReg((InstancePtr), <a class="el" href="group__ttcps__v3__0.html#ga5d75d0aff87c36aee0b898282dae8c24">XTTCPS_COUNT_VALUE_OFFSET</a>)</td></tr>
<tr class="separator:ga2e333879788d146e762e8a114159e9e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5fae7226b73f9d3c0b2acd3dd0d70561"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga5fae7226b73f9d3c0b2acd3dd0d70561">XTtcPs_SetInterval</a>(InstancePtr, Value)&#160;&#160;&#160;InstWriteReg((InstancePtr), <a class="el" href="group__ttcps__v3__0.html#ga3c55063adfc9bfeaf38a1712ab7345e6">XTTCPS_INTERVAL_VAL_OFFSET</a>, (Value))</td></tr>
<tr class="separator:ga5fae7226b73f9d3c0b2acd3dd0d70561"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga89d0a266832132783ec15391726dbae3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga89d0a266832132783ec15391726dbae3">XTtcPs_GetInterval</a>(InstancePtr)&#160;&#160;&#160;(u16)InstReadReg((InstancePtr), <a class="el" href="group__ttcps__v3__0.html#ga3c55063adfc9bfeaf38a1712ab7345e6">XTTCPS_INTERVAL_VAL_OFFSET</a>)</td></tr>
<tr class="separator:ga89d0a266832132783ec15391726dbae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1075ec0ff78366348f936e1e9bd96ac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#gad1075ec0ff78366348f936e1e9bd96ac">XTtcPs_ResetCounterValue</a>(InstancePtr)</td></tr>
<tr class="separator:gad1075ec0ff78366348f936e1e9bd96ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ba80f16b192bf1a02262154ea52001f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga9ba80f16b192bf1a02262154ea52001f">XTtcPs_EnableInterrupts</a>(InstancePtr, InterruptMask)</td></tr>
<tr class="separator:ga9ba80f16b192bf1a02262154ea52001f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga689593bb0ab2f6d8abe85efcf72fe209"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga689593bb0ab2f6d8abe85efcf72fe209">XTtcPs_DisableInterrupts</a>(InstancePtr, InterruptMask)</td></tr>
<tr class="separator:ga689593bb0ab2f6d8abe85efcf72fe209"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1f24b5dfa3b9147e374aefa0003d924c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga1f24b5dfa3b9147e374aefa0003d924c">XTtcPs_GetInterruptStatus</a>(InstancePtr)&#160;&#160;&#160;InstReadReg((InstancePtr), <a class="el" href="group__ttcps__v3__0.html#gadeae55c98cafd198b2afa7d0175f1d15">XTTCPS_ISR_OFFSET</a>)</td></tr>
<tr class="separator:ga1f24b5dfa3b9147e374aefa0003d924c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3ab6486250e4adc6343fa3e086540d3e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga3ab6486250e4adc6343fa3e086540d3e">XTtcPs_ClearInterruptStatus</a>(InstancePtr, InterruptMask)</td></tr>
<tr class="separator:ga3ab6486250e4adc6343fa3e086540d3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Configuration options</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Options for the device.</p>
<p>Each of the options is bit field, so more than one options can be specified. </p>
</div></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:ga88827c48fd065f14c8c0a1383c5da74e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_ttc_ps___config.html">XTtcPs_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga88827c48fd065f14c8c0a1383c5da74e">XTtcPs_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="separator:ga88827c48fd065f14c8c0a1383c5da74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae49e15051a6bc16bc2a5369832f1a584"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#gae49e15051a6bc16bc2a5369832f1a584">XTtcPs_CfgInitialize</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr, <a class="el" href="struct_x_ttc_ps___config.html">XTtcPs_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
<tr class="separator:gae49e15051a6bc16bc2a5369832f1a584"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b45b9a6c4ce17cf5b50953528de9c65"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga2b45b9a6c4ce17cf5b50953528de9c65">XTtcPs_SetMatchValue</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr, u8 MatchIndex, u16 Value)</td></tr>
<tr class="separator:ga2b45b9a6c4ce17cf5b50953528de9c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3a1b17e7784d4251cbeeb6339ffe8a83"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga3a1b17e7784d4251cbeeb6339ffe8a83">XTtcPs_GetMatchValue</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr, u8 MatchIndex)</td></tr>
<tr class="separator:ga3a1b17e7784d4251cbeeb6339ffe8a83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac08478cc050c41cc435a3f2b49b4c874"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#gac08478cc050c41cc435a3f2b49b4c874">XTtcPs_SetPrescaler</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr, u8 PrescalerValue)</td></tr>
<tr class="separator:gac08478cc050c41cc435a3f2b49b4c874"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d528bcd850e49f08fc585cb867ca11c"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga9d528bcd850e49f08fc585cb867ca11c">XTtcPs_GetPrescaler</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga9d528bcd850e49f08fc585cb867ca11c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad4935dccddaa77ae31faf4ec34d0859f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#gad4935dccddaa77ae31faf4ec34d0859f">XTtcPs_CalcIntervalFromFreq</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr, u32 Freq, u16 *Interval, u8 *Prescaler)</td></tr>
<tr class="separator:gad4935dccddaa77ae31faf4ec34d0859f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7053f4ac8c20f1d1fd335a755960aea9"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga7053f4ac8c20f1d1fd335a755960aea9">XTtcPs_SetOptions</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr, u32 Options)</td></tr>
<tr class="separator:ga7053f4ac8c20f1d1fd335a755960aea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac33ce44553e83555369c400b964234e7"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#gac33ce44553e83555369c400b964234e7">XTtcPs_GetOptions</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr)</td></tr>
<tr class="separator:gac33ce44553e83555369c400b964234e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga38ff3b491801add8d2b5faa22e2e0a08"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ttcps__v3__0.html#ga38ff3b491801add8d2b5faa22e2e0a08">XTtcPs_SelfTest</a> (<a class="el" href="struct_x_ttc_ps.html">XTtcPs</a> *InstancePtr)</td></tr>
<tr class="separator:ga38ff3b491801add8d2b5faa22e2e0a08"><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>