docs/API/xran__sync__api_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.13"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>o-du/phy: xran_sync_api.h File Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="search/searchdata.js"></script>
  14 <script type="text/javascript" src="search/search.js"></script>
  15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16 </head>
  17 <body>
  18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19 <div id="titlearea">
  20 <table cellspacing="0" cellpadding="0">
  21  <tbody>
  22  <tr style="height: 56px;">
  23   <td id="projectalign" style="padding-left: 0.5em;">
  24    <div id="projectname">o-du/phy
  25    </div>
  26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.13 -->
  34 <script type="text/javascript">
  35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36 </script>
  37 <script type="text/javascript" src="menudata.js"></script>
  38 <script type="text/javascript" src="menu.js"></script>
  39 <script type="text/javascript">
  40 $(function() {
  41   initMenu('',true,false,'search.php','Search');
  42   $(document).ready(function() { init_search(); });
  43 });
  44 </script>
  45 <div id="main-nav"></div>
  46 <!-- window showing the filter options -->
  47 <div id="MSearchSelectWindow"
  48      onmouseover="return searchBox.OnSearchSelectShow()"
  49      onmouseout="return searchBox.OnSearchSelectHide()"
  50      onkeydown="return searchBox.OnSearchSelectKey(event)">
  51 </div>
  52
  53 <!-- iframe showing the search results (closed by default) -->
  54 <div id="MSearchResultsWindow">
  55 <iframe src="javascript:void(0)" frameborder="0"
  56         name="MSearchResults" id="MSearchResults">
  57 </iframe>
  58 </div>
  59
  60 <div id="nav-path" class="navpath">
  61   <ul>
  62 <li class="navelem"><a class="el" href="dir_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_5cc0cc0264b57168b75ca56bde6cc403.html">lib</a></li><li class="navelem"><a class="el" href="dir_7b477aa413287cfa2199e983b77d66dd.html">api</a></li>  </ul>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#func-members">Functions</a>  </div>
  68   <div class="headertitle">
  69 <div class="title">xran_sync_api.h File Reference</div>  </div>
  70 </div><!--header-->
  71 <div class="contents">
  72
  73 <p>This file provides interface to synchronization related APIs (PTP/1588) for XRAN.
  74 <a href="#details">More...</a></p>
  75 <div class="textblock"><div class="dynheader">
  76 This graph shows which files directly or indirectly include this file:</div>
  77 <div class="dyncontent">
  78 <div class="center"><img src="xran__sync__api_8h__dep__incl.png" border="0" usemap="#xran__sync__api_8hdep" alt=""/></div>
  79 <map name="xran__sync__api_8hdep" id="xran__sync__api_8hdep">
  80 <area shape="rect" id="node2" href="sample-app_8c.html" title="sample&#45;app.c" alt="" coords="5,80,105,107"/>
  81 <area shape="rect" id="node3" href="xran__main_8c.html" title="XRAN main functionality module. " alt="" coords="130,80,223,107"/>
  82 <area shape="rect" id="node4" href="xran__sync__api_8c.html" title="This file provides implementation of synchronization related APIs (PTP/1588) for XRAN. " alt="" coords="247,80,365,107"/>
  83 </map>
  84 </div>
  85 </div>
  86 <p><a href="xran__sync__api_8h_source.html">Go to the source code of this file.</a></p>
  87 <table class="memberdecls">
  88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  89 Functions</h2></td></tr>
  90 <tr class="memitem:ac7d90edeea3b7f779bf85f44810c6a3a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8h.html#ac7d90edeea3b7f779bf85f44810c6a3a">xran_is_synchronized</a> (void)</td></tr>
  91 <tr class="memdesc:ac7d90edeea3b7f779bf85f44810c6a3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function checks if machine is synchronized using PTP for Linux software.  <a href="#ac7d90edeea3b7f779bf85f44810c6a3a">More...</a><br /></td></tr>
  92 <tr class="separator:ac7d90edeea3b7f779bf85f44810c6a3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 </table>
  94 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  95 <div class="textblock"><p>This file provides interface to synchronization related APIs (PTP/1588) for XRAN. </p>
  96 <dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
  97
  98 <p class="definition">Definition in file <a class="el" href="xran__sync__api_8h_source.html">xran_sync_api.h</a>.</p>
  99 </div><h2 class="groupheader">Function Documentation</h2>
 100 <a id="ac7d90edeea3b7f779bf85f44810c6a3a"></a>
 101 <h2 class="memtitle"><span class="permalink"><a href="#ac7d90edeea3b7f779bf85f44810c6a3a">&#9670;&nbsp;</a></span>xran_is_synchronized()</h2>
 102
 103 <div class="memitem">
 104 <div class="memproto">
 105       <table class="memname">
 106         <tr>
 107           <td class="memname">int xran_is_synchronized </td>
 108           <td>(</td>
 109           <td class="paramtype">void&#160;</td>
 110           <td class="paramname"></td><td>)</td>
 111           <td></td>
 112         </tr>
 113       </table>
 114 </div><div class="memdoc">
 115
 116 <p>Function checks if machine is synchronized using PTP for Linux software. </p>
 117 <dl class="section return"><dt>Returns</dt><dd>int Returns 0 if synchronized, otherwise positive. </dd></dl>
 118
 119 <p class="definition">Definition at line <a class="el" href="xran__sync__api_8c_source.html#l00113">113</a> of file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
 120 <div class="dynheader">
 121 Here is the caller graph for this function:</div>
 122 <div class="dyncontent">
 123 <div class="center"><img src="xran__sync__api_8h_ac7d90edeea3b7f779bf85f44810c6a3a_icgraph.png" border="0" usemap="#xran__sync__api_8h_ac7d90edeea3b7f779bf85f44810c6a3a_icgraph" alt=""/></div>
 124 <map name="xran__sync__api_8h_ac7d90edeea3b7f779bf85f44810c6a3a_icgraph" id="xran__sync__api_8h_ac7d90edeea3b7f779bf85f44810c6a3a_icgraph">
 125 <area shape="rect" id="node2" href="sample-app_8c.html#a0ddf1224851353fc92bfbff6f499fa97" title="main" alt="" coords="201,5,252,32"/>
 126 </map>
 127 </div>
 128
 129 </div>
 130 </div>
 131 </div><!-- contents -->
 132 <!-- start footer part -->
 133 <hr class="footer"/><address class="footer"><small>
 134 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 135 <img class="footer" src="doxygen.png" alt="doxygen"/>
 136 </a> 1.8.13
 137 </small></address>
 138 </body>
 139 </html>