129 lines
15 KiB
HTML
Executable file
129 lines
15 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>rtcpsu: xrtcpsu.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">rtcpsu
|
|
</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 Structures</span></a></li>
|
|
<li><a href="globals.html"><span>APIs</span></a></li>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div 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_888a84e23e986c4f5ae36df6aed0dc78.html">rtcpsu</a></li><li class="navelem"><a class="el" href="dir_0a7b48a74c311860737c9ed5155edc73.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">xrtcpsu.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  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_rtc_psu___config.html">XRtcPsu_Config</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_rtc_psu___d_t.html">XRtcPsu_DT</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:gac35a1cc17a44bf7890e7bddec35b7f7f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gac35a1cc17a44bf7890e7bddec35b7f7f">XRtcPsu_SetTime</a>(InstancePtr, Time)</td></tr>
|
|
<tr class="separator:gac35a1cc17a44bf7890e7bddec35b7f7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa1d04a3a39aa70df47747733af96e1c7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gaa1d04a3a39aa70df47747733af96e1c7">XRtcPsu_GetLastSetTime</a>(InstancePtr)   <a class="el" href="group__rtcpsu__v1__0.html#gaccbbc47feabb330a937816bc347766ea">XRtcPsu_ReadReg</a>((InstancePtr)->RtcConfig.BaseAddr + <a class="el" href="group__rtcpsu__v1__0.html#gae8aad0b4ff0c6c094abd427ca68bfb72">XRTC_SET_TIME_RD_OFFSET</a>)</td></tr>
|
|
<tr class="separator:gaa1d04a3a39aa70df47747733af96e1c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4464d5485ee8d997454a4eff3c497040"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga4464d5485ee8d997454a4eff3c497040">XRtcPsu_GetCalibration</a>(InstancePtr)   <a class="el" href="group__rtcpsu__v1__0.html#gaccbbc47feabb330a937816bc347766ea">XRtcPsu_ReadReg</a>((InstancePtr)->RtcConfig.BaseAddr+<a class="el" href="group__rtcpsu__v1__0.html#ga1370c975fd33563789e4a6737599668a">XRTC_CALIB_RD_OFFSET</a>)</td></tr>
|
|
<tr class="separator:ga4464d5485ee8d997454a4eff3c497040"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad31e32e54f893b0b09b77b158f180575"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gad31e32e54f893b0b09b77b158f180575">XRtcPsu_GetCurrentTime</a>(InstancePtr)   <a class="el" href="group__rtcpsu__v1__0.html#gaccbbc47feabb330a937816bc347766ea">XRtcPsu_ReadReg</a>((InstancePtr)->RtcConfig.BaseAddr+<a class="el" href="group__rtcpsu__v1__0.html#ga7fa52cd698601011816bcb3a78cabc6a">XRTC_CUR_TIME_OFFSET</a>)</td></tr>
|
|
<tr class="separator:gad31e32e54f893b0b09b77b158f180575"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa4a4dde16482fe7d440b14d0ce315236"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gaa4a4dde16482fe7d440b14d0ce315236">XRtcPsu_SetControlRegister</a>(InstancePtr, Value)</td></tr>
|
|
<tr class="separator:gaa4a4dde16482fe7d440b14d0ce315236"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga96ee0ca8660637a0b1bdd5feacdf9ac3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga96ee0ca8660637a0b1bdd5feacdf9ac3">XRtcPsu_GetSafetyCheck</a>(InstancePtr)   <a class="el" href="group__rtcpsu__v1__0.html#gaccbbc47feabb330a937816bc347766ea">XRtcPsu_ReadReg</a>((InstancePtr)->RtcConfig.BaseAddr+<a class="el" href="group__rtcpsu__v1__0.html#ga1f92062d8d2cb1c7f0735b1ecd5cdb67">XRTC_SFTY_CHK_OFFSET</a>)</td></tr>
|
|
<tr class="separator:ga96ee0ca8660637a0b1bdd5feacdf9ac3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga01aef4471440e437100dcefd0cf31c47"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga01aef4471440e437100dcefd0cf31c47">XRtcPsu_SetSafetyCheck</a>(InstancePtr, Value)</td></tr>
|
|
<tr class="separator:ga01aef4471440e437100dcefd0cf31c47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf491d4fa3c779586da882c0c3e75c80e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gaf491d4fa3c779586da882c0c3e75c80e">XRtcPsu_ResetAlarm</a>(InstancePtr)</td></tr>
|
|
<tr class="separator:gaf491d4fa3c779586da882c0c3e75c80e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab9fa0e5d7c9536a238863272a1e21bfa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gab9fa0e5d7c9536a238863272a1e21bfa">XRtcPsu_RoundOff</a>(Number)   (u32)(((Number) < (u32)0) ? ((Number) - (u32)0.5) : ((Number) + (u32)0.5))</td></tr>
|
|
<tr class="separator:gab9fa0e5d7c9536a238863272a1e21bfa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Callback events</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>These constants specify the handler events that an application can handle using its specific handler function.</p>
|
|
<p>Note that these constants are not bit mask, so only one event can be passed to an application at a time. </p>
|
|
</div></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:ga8ca73beea761e79bd8faec4fa86f0d17"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga8ca73beea761e79bd8faec4fa86f0d17">XRtcPsu_Handler</a>) (void *CallBackRef, u32 Event)</td></tr>
|
|
<tr class="separator:ga8ca73beea761e79bd8faec4fa86f0d17"><td class="memSeparator" colspan="2"> </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:ga201537801ac896c73018a8719e8637d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga201537801ac896c73018a8719e8637d8">XRtcPsu_SetAlarm</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr, u32 Alarm, u32 Periodic)</td></tr>
|
|
<tr class="separator:ga201537801ac896c73018a8719e8637d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaac3d95ea1a75533a1fd3cd95d62a9914"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gaac3d95ea1a75533a1fd3cd95d62a9914">XRtcPsu_SecToDateTime</a> (u32 Seconds, <a class="el" href="struct_x_rtc_psu___d_t.html">XRtcPsu_DT</a> *dt)</td></tr>
|
|
<tr class="separator:gaac3d95ea1a75533a1fd3cd95d62a9914"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga15d97f88e65f27121f56f06480717824"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga15d97f88e65f27121f56f06480717824">XRtcPsu_DateTimeToSec</a> (<a class="el" href="struct_x_rtc_psu___d_t.html">XRtcPsu_DT</a> *dt)</td></tr>
|
|
<tr class="separator:ga15d97f88e65f27121f56f06480717824"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga33633f27f8155128cc6815d883f9e22c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga33633f27f8155128cc6815d883f9e22c">XRtcPsu_CalculateCalibration</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr, u32 TimeReal, u32 CrystalOscFreq)</td></tr>
|
|
<tr class="separator:ga33633f27f8155128cc6815d883f9e22c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafe9ec3849cca99b5d67f76ffafcc3ab2"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gafe9ec3849cca99b5d67f76ffafcc3ab2">XRtcPsu_IsSecondsEventGenerated</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:gafe9ec3849cca99b5d67f76ffafcc3ab2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga75de01e02970e25ccbbeb1af33d0e808"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga75de01e02970e25ccbbeb1af33d0e808">XRtcPsu_IsAlarmEventGenerated</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:ga75de01e02970e25ccbbeb1af33d0e808"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga645920d3519722e8dc815d07db527367"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga645920d3519722e8dc815d07db527367">XRtcPsu_SetInterruptMask</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr, u32 Mask)</td></tr>
|
|
<tr class="separator:ga645920d3519722e8dc815d07db527367"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaefced00316539320411829b4d701fe3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#gaefced00316539320411829b4d701fe3c">XRtcPsu_ClearInterruptMask</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr, u32 Mask)</td></tr>
|
|
<tr class="separator:gaefced00316539320411829b4d701fe3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga01ca03d23194687c8026dc2f38da6ff7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga01ca03d23194687c8026dc2f38da6ff7">XRtcPsu_InterruptHandler</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:ga01ca03d23194687c8026dc2f38da6ff7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6c782a1e080607664a88ae6dcb994c30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga6c782a1e080607664a88ae6dcb994c30">XRtcPsu_SetHandler</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr, <a class="el" href="group__rtcpsu__v1__0.html#ga8ca73beea761e79bd8faec4fa86f0d17">XRtcPsu_Handler</a> FuncPtr, void *CallBackRef)</td></tr>
|
|
<tr class="separator:ga6c782a1e080607664a88ae6dcb994c30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1c969c089715ea9a86cec887c09f9b92"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga1c969c089715ea9a86cec887c09f9b92">XRtcPsu_SelfTest</a> (<a class="el" href="struct_x_rtc_psu.html">XRtcPsu</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:ga1c969c089715ea9a86cec887c09f9b92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga665fbe64a08c5b13b838ab7b69188e3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_rtc_psu___config.html">XRtcPsu_Config</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtcpsu__v1__0.html#ga665fbe64a08c5b13b838ab7b69188e3e">XRtcPsu_LookupConfig</a> (u16 DeviceId)</td></tr>
|
|
<tr class="separator:ga665fbe64a08c5b13b838ab7b69188e3e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</div><!-- contents -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Copyright © 2015 Xilinx Inc. All rights reserved.</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|