revert API doc contribution since the document size is big, it affact the code download.
[o-du/phy.git] / docs / API / xran__sync__api_8c.html
diff --git a/docs/API/xran__sync__api_8c.html b/docs/API/xran__sync__api_8c.html
deleted file mode 100644 (file)
index 1fab39e..0000000
+++ /dev/null
@@ -1,258 +0,0 @@
-<!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.13"/>
-<meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>o-du/phy: xran_sync_api.c 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="search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="search/searchdata.js"></script>
-<script type="text/javascript" src="search/search.js"></script>
-<link href="doxygen.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="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">o-du/phy
-   </div>
-   <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
-  </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
-<script type="text/javascript">
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
-</script>
-<script type="text/javascript" src="menudata.js"></script>
-<script type="text/javascript" src="menu.js"></script>
-<script type="text/javascript">
-$(function() {
-  initMenu('',true,false,'search.php','Search');
-  $(document).ready(function() { init_search(); });
-});
-</script>
-<div id="main-nav"></div>
-<!-- window showing the filter options -->
-<div id="MSearchSelectWindow"
-     onmouseover="return searchBox.OnSearchSelectShow()"
-     onmouseout="return searchBox.OnSearchSelectHide()"
-     onkeydown="return searchBox.OnSearchSelectKey(event)">
-</div>
-
-<!-- iframe showing the search results (closed by default) -->
-<div id="MSearchResultsWindow">
-<iframe src="javascript:void(0)" frameborder="0" 
-        name="MSearchResults" id="MSearchResults">
-</iframe>
-</div>
-
-<div id="nav-path" class="navpath">
-  <ul>
-<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_9fc50806095da30fbd4a2dbe2e456ff5.html">src</a></li>  </ul>
-</div>
-</div><!-- top -->
-<div class="header">
-  <div class="summary">
-<a href="#define-members">Macros</a> &#124;
-<a href="#func-members">Functions</a>  </div>
-  <div class="headertitle">
-<div class="title">xran_sync_api.c File Reference</div>  </div>
-</div><!--header-->
-<div class="contents">
-
-<p>This file provides implementation of synchronization related APIs (PTP/1588) for XRAN.  
-<a href="#details">More...</a></p>
-<div class="textblock"><code>#include &lt;assert.h&gt;</code><br />
-<code>#include &lt;dirent.h&gt;</code><br />
-<code>#include &lt;stdio.h&gt;</code><br />
-<code>#include &lt;stdlib.h&gt;</code><br />
-<code>#include &lt;string.h&gt;</code><br />
-<code>#include &quot;<a class="el" href="xran__sync__api_8h_source.html">xran_sync_api.h</a>&quot;</code><br />
-<code>#include &quot;<a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>&quot;</code><br />
-</div><div class="textblock"><div class="dynheader">
-Include dependency graph for xran_sync_api.c:</div>
-<div class="dyncontent">
-<div class="center"><img src="xran__sync__api_8c__incl.png" border="0" usemap="#xran__sync__api_8c" alt=""/></div>
-<map name="xran__sync__api_8c" id="xran__sync__api_8c">
-<area shape="rect" id="node7" href="xran__sync__api_8h.html" title="This file provides interface to synchronization related APIs (PTP/1588) for XRAN. ..." alt="" coords="449,80,567,107"/>
-<area shape="rect" id="node8" href="xran__printf_8h.html" title="Modules provide debug prints and utility functions. " alt="" coords="241,80,335,107"/>
-</map>
-</div>
-</div>
-<p><a href="xran__sync__api_8c_source.html">Go to the source code of this file.</a></p>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
-Macros</h2></td></tr>
-<tr class="memitem:a8b5839f71a3b6e7d64b2d5e9967e3dd1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a8b5839f71a3b6e7d64b2d5e9967e3dd1">BUF_LEN</a>&#160;&#160;&#160;256</td></tr>
-<tr class="separator:a8b5839f71a3b6e7d64b2d5e9967e3dd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a74c4e1e72964de291652bbec04e4e4c9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a74c4e1e72964de291652bbec04e4e4c9">PROC_DIR</a>&#160;&#160;&#160;&quot;/proc&quot;</td></tr>
-<tr class="separator:a74c4e1e72964de291652bbec04e4e4c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a49d668ad019f34e97bb4eab0c86322c4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a49d668ad019f34e97bb4eab0c86322c4">COMM_FILE</a>&#160;&#160;&#160;&quot;comm&quot;</td></tr>
-<tr class="separator:a49d668ad019f34e97bb4eab0c86322c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad358ba75ef7ea0f15a200f9e18af64e4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#ad358ba75ef7ea0f15a200f9e18af64e4">PMC_CMD</a>&#160;&#160;&#160;&quot;pmc -<a class="el" href="xran__pkt__cp_8h.html#a6c38e7b5c31753cf9e58246d571ff250">u</a> -b 0 'GET PORT_DATA_SET'&quot;</td></tr>
-<tr class="separator:ad358ba75ef7ea0f15a200f9e18af64e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad1e97ed2634bf44c3b2d5366cfa3deda"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#ad1e97ed2634bf44c3b2d5366cfa3deda">PTP4L_PROC_NAME</a>&#160;&#160;&#160;&quot;ptp4l&quot;</td></tr>
-<tr class="separator:ad1e97ed2634bf44c3b2d5366cfa3deda"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a651275b1135ce87eb95b301b6427cf07"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a651275b1135ce87eb95b301b6427cf07">PHC2SYS_PROC_NAME</a>&#160;&#160;&#160;&quot;phc2sys&quot;</td></tr>
-<tr class="separator:a651275b1135ce87eb95b301b6427cf07"><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:a4778e0253fe842243ff1b2cee96e9367"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a4778e0253fe842243ff1b2cee96e9367">xran_is_synchronized</a> ()</td></tr>
-<tr class="memdesc:a4778e0253fe842243ff1b2cee96e9367"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function checks if machine is synchronized using PTP for Linux software.  <a href="#a4778e0253fe842243ff1b2cee96e9367">More...</a><br /></td></tr>
-<tr class="separator:a4778e0253fe842243ff1b2cee96e9367"><td class="memSeparator" colspan="2">&#160;</td></tr>
-</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>This file provides implementation of synchronization related APIs (PTP/1588) for XRAN. </p>
-<dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
-
-<p class="definition">Definition in file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
-</div><h2 class="groupheader">Macro Definition Documentation</h2>
-<a id="a8b5839f71a3b6e7d64b2d5e9967e3dd1"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a8b5839f71a3b6e7d64b2d5e9967e3dd1">&#9670;&nbsp;</a></span>BUF_LEN</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define BUF_LEN&#160;&#160;&#160;256</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="xran__sync__api_8c_source.html#l00037">37</a> of file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
-
-</div>
-</div>
-<a id="a49d668ad019f34e97bb4eab0c86322c4"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a49d668ad019f34e97bb4eab0c86322c4">&#9670;&nbsp;</a></span>COMM_FILE</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define COMM_FILE&#160;&#160;&#160;&quot;comm&quot;</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="xran__sync__api_8c_source.html#l00039">39</a> of file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
-
-</div>
-</div>
-<a id="a651275b1135ce87eb95b301b6427cf07"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a651275b1135ce87eb95b301b6427cf07">&#9670;&nbsp;</a></span>PHC2SYS_PROC_NAME</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define PHC2SYS_PROC_NAME&#160;&#160;&#160;&quot;phc2sys&quot;</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="xran__sync__api_8c_source.html#l00042">42</a> of file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
-
-</div>
-</div>
-<a id="ad358ba75ef7ea0f15a200f9e18af64e4"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ad358ba75ef7ea0f15a200f9e18af64e4">&#9670;&nbsp;</a></span>PMC_CMD</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define PMC_CMD&#160;&#160;&#160;&quot;pmc -<a class="el" href="xran__pkt__cp_8h.html#a6c38e7b5c31753cf9e58246d571ff250">u</a> -b 0 'GET PORT_DATA_SET'&quot;</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="xran__sync__api_8c_source.html#l00040">40</a> of file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
-
-</div>
-</div>
-<a id="a74c4e1e72964de291652bbec04e4e4c9"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a74c4e1e72964de291652bbec04e4e4c9">&#9670;&nbsp;</a></span>PROC_DIR</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define PROC_DIR&#160;&#160;&#160;&quot;/proc&quot;</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="xran__sync__api_8c_source.html#l00038">38</a> of file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
-
-</div>
-</div>
-<a id="ad1e97ed2634bf44c3b2d5366cfa3deda"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ad1e97ed2634bf44c3b2d5366cfa3deda">&#9670;&nbsp;</a></span>PTP4L_PROC_NAME</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">#define PTP4L_PROC_NAME&#160;&#160;&#160;&quot;ptp4l&quot;</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p class="definition">Definition at line <a class="el" href="xran__sync__api_8c_source.html#l00041">41</a> of file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
-
-</div>
-</div>
-<h2 class="groupheader">Function Documentation</h2>
-<a id="a4778e0253fe842243ff1b2cee96e9367"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a4778e0253fe842243ff1b2cee96e9367">&#9670;&nbsp;</a></span>xran_is_synchronized()</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int xran_is_synchronized </td>
-          <td>(</td>
-          <td class="paramtype">void&#160;</td>
-          <td class="paramname"></td><td>)</td>
-          <td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Function checks if machine is synchronized using PTP for Linux software. </p>
-<dl class="section return"><dt>Returns</dt><dd>int Returns 0 if synchronized, otherwise positive. </dd></dl>
-
-<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>
-<div class="dynheader">
-Here is the caller graph for this function:</div>
-<div class="dyncontent">
-<div class="center"><img src="xran__sync__api_8c_a4778e0253fe842243ff1b2cee96e9367_icgraph.png" border="0" usemap="#xran__sync__api_8c_a4778e0253fe842243ff1b2cee96e9367_icgraph" alt=""/></div>
-<map name="xran__sync__api_8c_a4778e0253fe842243ff1b2cee96e9367_icgraph" id="xran__sync__api_8c_a4778e0253fe842243ff1b2cee96e9367_icgraph">
-<area shape="rect" id="node2" href="sample-app_8c.html#a0ddf1224851353fc92bfbff6f499fa97" title="main" alt="" coords="201,5,252,32"/>
-</map>
-</div>
-
-</div>
-</div>
-</div><!-- contents -->
-<!-- start footer part -->
-<hr class="footer"/><address class="footer"><small>
-Generated by &#160;<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.13
-</small></address>
-</body>
-</html>