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">
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.c 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" />
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20 <table cellspacing="0" cellpadding="0">
22 <tr style="height: 56px;">
23 <td id="projectalign" style="padding-left: 0.5em;">
24 <div id="projectname">o-du/phy
26 <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</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');
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
41 initMenu('',true,false,'search.php','Search');
42 $(document).ready(function() { init_search(); });
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)">
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">
60 <div id="nav-path" class="navpath">
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_9fc50806095da30fbd4a2dbe2e456ff5.html">src</a></li> </ul>
67 <a href="#define-members">Macros</a> |
68 <a href="#func-members">Functions</a> </div>
69 <div class="headertitle">
70 <div class="title">xran_sync_api.c File Reference</div> </div>
72 <div class="contents">
74 <p>This file provides implementation of synchronization related APIs (PTP/1588) for XRAN.
75 <a href="#details">More...</a></p>
76 <div class="textblock"><code>#include <assert.h></code><br />
77 <code>#include <dirent.h></code><br />
78 <code>#include <stdio.h></code><br />
79 <code>#include <stdlib.h></code><br />
80 <code>#include <string.h></code><br />
81 <code>#include "<a class="el" href="xran__sync__api_8h_source.html">xran_sync_api.h</a>"</code><br />
82 <code>#include "<a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>"</code><br />
83 </div><div class="textblock"><div class="dynheader">
84 Include dependency graph for xran_sync_api.c:</div>
85 <div class="dyncontent">
86 <div class="center"><img src="xran__sync__api_8c__incl.png" border="0" usemap="#xran__sync__api_8c" alt=""/></div>
87 <map name="xran__sync__api_8c" id="xran__sync__api_8c">
88 <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"/>
89 <area shape="rect" id="node8" href="xran__printf_8h.html" title="Modules provide debug prints and utility functions. " alt="" coords="241,80,335,107"/>
93 <p><a href="xran__sync__api_8c_source.html">Go to the source code of this file.</a></p>
94 <table class="memberdecls">
95 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
97 <tr class="memitem:a8b5839f71a3b6e7d64b2d5e9967e3dd1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a8b5839f71a3b6e7d64b2d5e9967e3dd1">BUF_LEN</a>   256</td></tr>
98 <tr class="separator:a8b5839f71a3b6e7d64b2d5e9967e3dd1"><td class="memSeparator" colspan="2"> </td></tr>
99 <tr class="memitem:a74c4e1e72964de291652bbec04e4e4c9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a74c4e1e72964de291652bbec04e4e4c9">PROC_DIR</a>   "/proc"</td></tr>
100 <tr class="separator:a74c4e1e72964de291652bbec04e4e4c9"><td class="memSeparator" colspan="2"> </td></tr>
101 <tr class="memitem:a49d668ad019f34e97bb4eab0c86322c4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a49d668ad019f34e97bb4eab0c86322c4">COMM_FILE</a>   "comm"</td></tr>
102 <tr class="separator:a49d668ad019f34e97bb4eab0c86322c4"><td class="memSeparator" colspan="2"> </td></tr>
103 <tr class="memitem:ad358ba75ef7ea0f15a200f9e18af64e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#ad358ba75ef7ea0f15a200f9e18af64e4">PMC_CMD</a>   "pmc -<a class="el" href="xran__pkt__cp_8h.html#a6c38e7b5c31753cf9e58246d571ff250">u</a> -b 0 'GET PORT_DATA_SET'"</td></tr>
104 <tr class="separator:ad358ba75ef7ea0f15a200f9e18af64e4"><td class="memSeparator" colspan="2"> </td></tr>
105 <tr class="memitem:ad1e97ed2634bf44c3b2d5366cfa3deda"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#ad1e97ed2634bf44c3b2d5366cfa3deda">PTP4L_PROC_NAME</a>   "ptp4l"</td></tr>
106 <tr class="separator:ad1e97ed2634bf44c3b2d5366cfa3deda"><td class="memSeparator" colspan="2"> </td></tr>
107 <tr class="memitem:a651275b1135ce87eb95b301b6427cf07"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a651275b1135ce87eb95b301b6427cf07">PHC2SYS_PROC_NAME</a>   "phc2sys"</td></tr>
108 <tr class="separator:a651275b1135ce87eb95b301b6427cf07"><td class="memSeparator" colspan="2"> </td></tr>
109 </table><table class="memberdecls">
110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
111 Functions</h2></td></tr>
112 <tr class="memitem:a4778e0253fe842243ff1b2cee96e9367"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8c.html#a4778e0253fe842243ff1b2cee96e9367">xran_is_synchronized</a> ()</td></tr>
113 <tr class="memdesc:a4778e0253fe842243ff1b2cee96e9367"><td class="mdescLeft"> </td><td class="mdescRight">Function checks if machine is synchronized using PTP for Linux software. <a href="#a4778e0253fe842243ff1b2cee96e9367">More...</a><br /></td></tr>
114 <tr class="separator:a4778e0253fe842243ff1b2cee96e9367"><td class="memSeparator" colspan="2"> </td></tr>
116 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
117 <div class="textblock"><p>This file provides implementation of synchronization related APIs (PTP/1588) for XRAN. </p>
118 <dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
120 <p class="definition">Definition in file <a class="el" href="xran__sync__api_8c_source.html">xran_sync_api.c</a>.</p>
121 </div><h2 class="groupheader">Macro Definition Documentation</h2>
122 <a id="a8b5839f71a3b6e7d64b2d5e9967e3dd1"></a>
123 <h2 class="memtitle"><span class="permalink"><a href="#a8b5839f71a3b6e7d64b2d5e9967e3dd1">◆ </a></span>BUF_LEN</h2>
125 <div class="memitem">
126 <div class="memproto">
127 <table class="memname">
129 <td class="memname">#define BUF_LEN   256</td>
132 </div><div class="memdoc">
134 <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>
138 <a id="a49d668ad019f34e97bb4eab0c86322c4"></a>
139 <h2 class="memtitle"><span class="permalink"><a href="#a49d668ad019f34e97bb4eab0c86322c4">◆ </a></span>COMM_FILE</h2>
141 <div class="memitem">
142 <div class="memproto">
143 <table class="memname">
145 <td class="memname">#define COMM_FILE   "comm"</td>
148 </div><div class="memdoc">
150 <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>
154 <a id="a651275b1135ce87eb95b301b6427cf07"></a>
155 <h2 class="memtitle"><span class="permalink"><a href="#a651275b1135ce87eb95b301b6427cf07">◆ </a></span>PHC2SYS_PROC_NAME</h2>
157 <div class="memitem">
158 <div class="memproto">
159 <table class="memname">
161 <td class="memname">#define PHC2SYS_PROC_NAME   "phc2sys"</td>
164 </div><div class="memdoc">
166 <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>
170 <a id="ad358ba75ef7ea0f15a200f9e18af64e4"></a>
171 <h2 class="memtitle"><span class="permalink"><a href="#ad358ba75ef7ea0f15a200f9e18af64e4">◆ </a></span>PMC_CMD</h2>
173 <div class="memitem">
174 <div class="memproto">
175 <table class="memname">
177 <td class="memname">#define PMC_CMD   "pmc -<a class="el" href="xran__pkt__cp_8h.html#a6c38e7b5c31753cf9e58246d571ff250">u</a> -b 0 'GET PORT_DATA_SET'"</td>
180 </div><div class="memdoc">
182 <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>
186 <a id="a74c4e1e72964de291652bbec04e4e4c9"></a>
187 <h2 class="memtitle"><span class="permalink"><a href="#a74c4e1e72964de291652bbec04e4e4c9">◆ </a></span>PROC_DIR</h2>
189 <div class="memitem">
190 <div class="memproto">
191 <table class="memname">
193 <td class="memname">#define PROC_DIR   "/proc"</td>
196 </div><div class="memdoc">
198 <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>
202 <a id="ad1e97ed2634bf44c3b2d5366cfa3deda"></a>
203 <h2 class="memtitle"><span class="permalink"><a href="#ad1e97ed2634bf44c3b2d5366cfa3deda">◆ </a></span>PTP4L_PROC_NAME</h2>
205 <div class="memitem">
206 <div class="memproto">
207 <table class="memname">
209 <td class="memname">#define PTP4L_PROC_NAME   "ptp4l"</td>
212 </div><div class="memdoc">
214 <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>
218 <h2 class="groupheader">Function Documentation</h2>
219 <a id="a4778e0253fe842243ff1b2cee96e9367"></a>
220 <h2 class="memtitle"><span class="permalink"><a href="#a4778e0253fe842243ff1b2cee96e9367">◆ </a></span>xran_is_synchronized()</h2>
222 <div class="memitem">
223 <div class="memproto">
224 <table class="memname">
226 <td class="memname">int xran_is_synchronized </td>
228 <td class="paramtype">void </td>
229 <td class="paramname"></td><td>)</td>
233 </div><div class="memdoc">
235 <p>Function checks if machine is synchronized using PTP for Linux software. </p>
236 <dl class="section return"><dt>Returns</dt><dd>int Returns 0 if synchronized, otherwise positive. </dd></dl>
238 <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>
239 <div class="dynheader">
240 Here is the caller graph for this function:</div>
241 <div class="dyncontent">
242 <div class="center"><img src="xran__sync__api_8c_a4778e0253fe842243ff1b2cee96e9367_icgraph.png" border="0" usemap="#xran__sync__api_8c_a4778e0253fe842243ff1b2cee96e9367_icgraph" alt=""/></div>
243 <map name="xran__sync__api_8c_a4778e0253fe842243ff1b2cee96e9367_icgraph" id="xran__sync__api_8c_a4778e0253fe842243ff1b2cee96e9367_icgraph">
244 <area shape="rect" id="node2" href="sample-app_8c.html#a0ddf1224851353fc92bfbff6f499fa97" title="main" alt="" coords="201,5,252,32"/>
250 </div><!-- contents -->
251 <!-- start footer part -->
252 <hr class="footer"/><address class="footer"><small>
253 Generated by  <a href="http://www.doxygen.org/index.html">
254 <img class="footer" src="doxygen.png" alt="doxygen"/>