add Doxygen documentation
[o-du/phy.git] / docs / API / xran__lib__wrap_8hpp.html
diff --git a/docs/API/xran__lib__wrap_8hpp.html b/docs/API/xran__lib__wrap_8hpp.html
new file mode 100644 (file)
index 0000000..68a12f6
--- /dev/null
@@ -0,0 +1,540 @@
+<!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_lib_wrap.hpp 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_babe8eacf738372576863f88f66866a5.html">test</a></li><li class="navelem"><a class="el" href="dir_1bd9561fc3fad99ea06f3a94905f6e7f.html">common</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> &#124;
+<a href="#var-members">Variables</a>  </div>
+  <div class="headertitle">
+<div class="title">xran_lib_wrap.hpp File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &lt;exception&gt;</code><br />
+<code>#include &lt;random&gt;</code><br />
+<code>#include &lt;string&gt;</code><br />
+<code>#include &lt;utility&gt;</code><br />
+<code>#include &lt;vector&gt;</code><br />
+<code>#include &lt;malloc.h&gt;</code><br />
+<code>#include &lt;stdint.h&gt;</code><br />
+<code>#include &quot;<a class="el" href="common_8hpp_source.html">common.hpp</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="xran__frame__struct_8h_source.html">xran_frame_struct.h</a>&quot;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for xran_lib_wrap.hpp:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__lib__wrap_8hpp__incl.png" border="0" usemap="#xran__lib__wrap_8hpp" alt=""/></div>
+<map name="xran__lib__wrap_8hpp" id="xran__lib__wrap_8hpp">
+<area shape="rect" id="node9" href="common_8hpp.html" title="common.hpp" alt="" coords="821,80,918,107"/>
+<area shape="rect" id="node30" href="xran__fh__o__du_8h.html" title="This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN&#45;WG..." alt="" coords="2004,229,2114,256"/>
+<area shape="rect" id="node43" href="xran__common_8h.html" title="XRAN layer common functionality for both lls&#45;CU and RU as well as C&#45;plane and U&#45;plane. " alt="" coords="2156,80,2271,107"/>
+<area shape="rect" id="node50" href="xran__frame__struct_8h.html" title="Header file for function to work with 5G NR frame structure and related routines. ..." alt="" coords="1475,80,1614,107"/>
+<area shape="rect" id="node14" href="common__typedef__xran_8h.html" title="This header file defines those data type both used by eNB and UE. " alt="" coords="1363,229,1528,256"/>
+<area shape="rect" id="node17" href="json_8hpp.html" title="json.hpp" alt="" coords="566,155,637,181"/>
+<area shape="rect" id="node48" href="xran__pkt__up_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="2162,155,2266,181"/>
+<area shape="rect" id="node49" href="xran__cp__api_8h.html" title="This file provides the definitions for Control Plane Messages APIs. " alt="" coords="1689,155,1792,181"/>
+</map>
+</div>
+</div><div class="textblock"><div class="dynheader">
+This graph shows which files directly or indirectly include this file:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__lib__wrap_8hpp__dep__incl.png" border="0" usemap="#xran__lib__wrap_8hppdep" alt=""/></div>
+<map name="xran__lib__wrap_8hppdep" id="xran__lib__wrap_8hppdep">
+<area shape="rect" id="node2" href="xranlib__unit__test__main_8cc.html" title="xranlib_unit_test_main.cc" alt="" coords="5,80,176,107"/>
+<area shape="rect" id="node3" href="c__plane__tests_8cc.html" title="c_plane_tests.cc" alt="" coords="201,80,322,107"/>
+<area shape="rect" id="node4" href="chain__tests_8cc.html" title="chain_tests.cc" alt="" coords="347,80,453,107"/>
+<area shape="rect" id="node5" href="init__sys__functional_8cc.html" title="init_sys_functional.cc" alt="" coords="478,80,626,107"/>
+</map>
+</div>
+</div>
+<p><a href="xran__lib__wrap_8hpp_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="nested-classes"></a>
+Data Structures</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxran_lib_wraper.html">xranLibWraper</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="structxran_lib_wraper_1_1xran__timer__ctx.html">xranLibWraper::xran_timer_ctx</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:a7959c3e12f3260a6461fe2610203d1af"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a7959c3e12f3260a6461fe2610203d1af">XRAN_UT_CFG_FILENAME</a>&#160;&#160;&#160;&quot;conf.json&quot;</td></tr>
+<tr class="separator:a7959c3e12f3260a6461fe2610203d1af"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7c71ebeaaa34df8b1f1e2f33c6d7a54e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a7c71ebeaaa34df8b1f1e2f33c6d7a54e">XRAN_UT_KEY_GLOBALCFG</a>&#160;&#160;&#160;&quot;GLOBAL&quot;</td></tr>
+<tr class="separator:a7c71ebeaaa34df8b1f1e2f33c6d7a54e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad3747a607e4b273dfae8278854ffc532"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#ad3747a607e4b273dfae8278854ffc532">XRAN_UT_KEY_GLOBALCFG_IO</a>&#160;&#160;&#160;&quot;io_cfg&quot;</td></tr>
+<tr class="separator:ad3747a607e4b273dfae8278854ffc532"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad8d180966ea390f149dea00f5616b540"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#ad8d180966ea390f149dea00f5616b540">XRAN_UT_KEY_GLOBALCFG_EAXCID</a>&#160;&#160;&#160;&quot;eAxCId_cfg&quot;</td></tr>
+<tr class="separator:ad8d180966ea390f149dea00f5616b540"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0c97e7d2cdb34b857e3b6de86b49f55d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a0c97e7d2cdb34b857e3b6de86b49f55d">XRAN_UT_KEY_GLOBALCFG_PRACH</a>&#160;&#160;&#160;&quot;prach_cfg&quot;</td></tr>
+<tr class="separator:a0c97e7d2cdb34b857e3b6de86b49f55d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a98f3e1fb2c2dd1381aac8d01b293486a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a98f3e1fb2c2dd1381aac8d01b293486a">XRAN_UT_KEY_GLOBALCFG_RU</a>&#160;&#160;&#160;&quot;ru_cfg&quot;</td></tr>
+<tr class="separator:a98f3e1fb2c2dd1381aac8d01b293486a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1976c5b3ee9779f3fe720e706b5c4e72"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a1976c5b3ee9779f3fe720e706b5c4e72">XRAN_UT_KEY_GLOBALCFG_SLOT</a>&#160;&#160;&#160;&quot;slotcfg_&quot;</td></tr>
+<tr class="separator:a1976c5b3ee9779f3fe720e706b5c4e72"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a16ea7ba6b48522ff69767c3a3d31b776"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a16ea7ba6b48522ff69767c3a3d31b776">MAX_NUM_OF_XRAN_CTX</a>&#160;&#160;&#160;(2)</td></tr>
+<tr class="separator:a16ea7ba6b48522ff69767c3a3d31b776"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7b323875aec9da8e30e082063f75b50b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a7b323875aec9da8e30e082063f75b50b">SW_FPGA_TOTAL_BUFFER_LEN</a>&#160;&#160;&#160;(4*1024*1024*1024)</td></tr>
+<tr class="separator:a7b323875aec9da8e30e082063f75b50b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae9c34194d5ec7c9c24b680085991306c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#ae9c34194d5ec7c9c24b680085991306c">SW_FPGA_SEGMENT_BUFFER_LEN</a>&#160;&#160;&#160;(1*1024*1024*1024)</td></tr>
+<tr class="separator:ae9c34194d5ec7c9c24b680085991306c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad5b1e2ec82b937000bd1fe89acb5384c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#ad5b1e2ec82b937000bd1fe89acb5384c">SW_FPGA_FH_TOTAL_BUFFER_LEN</a>&#160;&#160;&#160;(1*1024*1024*1024)</td></tr>
+<tr class="separator:ad5b1e2ec82b937000bd1fe89acb5384c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a67e68cef19d6e679b04c315c9234a0e3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a67e68cef19d6e679b04c315c9234a0e3">FPGA_TO_SW_PRACH_RX_BUFFER_LEN</a>&#160;&#160;&#160;(8192)</td></tr>
+<tr class="separator:a67e68cef19d6e679b04c315c9234a0e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a14c306e04a1b3ecdd13b82ab9ca6c9b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a14c306e04a1b3ecdd13b82ab9ca6c9b5">MAX_ANT_CARRIER_SUPPORTED</a>&#160;&#160;&#160;(<a class="el" href="xran__fh__o__du_8h.html#a34dbe5e515cc78b4ce26fa287e6c1edc">XRAN_MAX_SECTOR_NR</a>*<a class="el" href="xran__fh__o__du_8h.html#a35fa05e7523928c0c86cbcf835c12dc5">XRAN_MAX_ANTENNA_NR</a>)</td></tr>
+<tr class="separator:a14c306e04a1b3ecdd13b82ab9ca6c9b5"><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:a6c189fbbc24f87fad24cff9cbd0e6a42"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a6c189fbbc24f87fad24cff9cbd0e6a42">sym_ota_cb</a> (struct rte_timer *tim, void *arg)</td></tr>
+<tr class="separator:a6c189fbbc24f87fad24cff9cbd0e6a42"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9c3700d61ba446fa9b05cca2ca9018ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a9c3700d61ba446fa9b05cca2ca9018ab">tti_ota_cb</a> (struct rte_timer *tim, void *arg)</td></tr>
+<tr class="separator:a9c3700d61ba446fa9b05cca2ca9018ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
+Variables</h2></td></tr>
+<tr class="memitem:a273a09cbea9267272f4e2a339059e442"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a273a09cbea9267272f4e2a339059e442">xran_lib_ota_tti</a></td></tr>
+<tr class="separator:a273a09cbea9267272f4e2a339059e442"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8cec0b41a42705e6ab9f49914ca666c2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a8cec0b41a42705e6ab9f49914ca666c2">xran_lib_ota_sym</a></td></tr>
+<tr class="separator:a8cec0b41a42705e6ab9f49914ca666c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a98175f360f5753bc99c4edd3c2d8bd04"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a98175f360f5753bc99c4edd3c2d8bd04">xran_lib_ota_sym_idx</a></td></tr>
+<tr class="separator:a98175f360f5753bc99c4edd3c2d8bd04"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1b2100f9f398243bb4bdbf0db003b9a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxran_lib_wraper.html">xranLibWraper</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__lib__wrap_8hpp.html#a1b2100f9f398243bb4bdbf0db003b9a3">xranlib</a></td></tr>
+<tr class="separator:a1b2100f9f398243bb4bdbf0db003b9a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Macro Definition Documentation</h2>
+<a id="a67e68cef19d6e679b04c315c9234a0e3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a67e68cef19d6e679b04c315c9234a0e3">&#9670;&nbsp;</a></span>FPGA_TO_SW_PRACH_RX_BUFFER_LEN</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define FPGA_TO_SW_PRACH_RX_BUFFER_LEN&#160;&#160;&#160;(8192)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00052">52</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a14c306e04a1b3ecdd13b82ab9ca6c9b5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a14c306e04a1b3ecdd13b82ab9ca6c9b5">&#9670;&nbsp;</a></span>MAX_ANT_CARRIER_SUPPORTED</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define MAX_ANT_CARRIER_SUPPORTED&#160;&#160;&#160;(<a class="el" href="xran__fh__o__du_8h.html#a34dbe5e515cc78b4ce26fa287e6c1edc">XRAN_MAX_SECTOR_NR</a>*<a class="el" href="xran__fh__o__du_8h.html#a35fa05e7523928c0c86cbcf835c12dc5">XRAN_MAX_ANTENNA_NR</a>)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00054">54</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a16ea7ba6b48522ff69767c3a3d31b776"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a16ea7ba6b48522ff69767c3a3d31b776">&#9670;&nbsp;</a></span>MAX_NUM_OF_XRAN_CTX</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define MAX_NUM_OF_XRAN_CTX&#160;&#160;&#160;(2)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00047">47</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="ad5b1e2ec82b937000bd1fe89acb5384c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad5b1e2ec82b937000bd1fe89acb5384c">&#9670;&nbsp;</a></span>SW_FPGA_FH_TOTAL_BUFFER_LEN</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define SW_FPGA_FH_TOTAL_BUFFER_LEN&#160;&#160;&#160;(1*1024*1024*1024)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00051">51</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="ae9c34194d5ec7c9c24b680085991306c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae9c34194d5ec7c9c24b680085991306c">&#9670;&nbsp;</a></span>SW_FPGA_SEGMENT_BUFFER_LEN</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define SW_FPGA_SEGMENT_BUFFER_LEN&#160;&#160;&#160;(1*1024*1024*1024)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00050">50</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a7b323875aec9da8e30e082063f75b50b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7b323875aec9da8e30e082063f75b50b">&#9670;&nbsp;</a></span>SW_FPGA_TOTAL_BUFFER_LEN</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define SW_FPGA_TOTAL_BUFFER_LEN&#160;&#160;&#160;(4*1024*1024*1024)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00049">49</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a7959c3e12f3260a6461fe2610203d1af"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7959c3e12f3260a6461fe2610203d1af">&#9670;&nbsp;</a></span>XRAN_UT_CFG_FILENAME</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define XRAN_UT_CFG_FILENAME&#160;&#160;&#160;&quot;conf.json&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00038">38</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a7c71ebeaaa34df8b1f1e2f33c6d7a54e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7c71ebeaaa34df8b1f1e2f33c6d7a54e">&#9670;&nbsp;</a></span>XRAN_UT_KEY_GLOBALCFG</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define XRAN_UT_KEY_GLOBALCFG&#160;&#160;&#160;&quot;GLOBAL&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00040">40</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="ad8d180966ea390f149dea00f5616b540"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad8d180966ea390f149dea00f5616b540">&#9670;&nbsp;</a></span>XRAN_UT_KEY_GLOBALCFG_EAXCID</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define XRAN_UT_KEY_GLOBALCFG_EAXCID&#160;&#160;&#160;&quot;eAxCId_cfg&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00042">42</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="ad3747a607e4b273dfae8278854ffc532"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad3747a607e4b273dfae8278854ffc532">&#9670;&nbsp;</a></span>XRAN_UT_KEY_GLOBALCFG_IO</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define XRAN_UT_KEY_GLOBALCFG_IO&#160;&#160;&#160;&quot;io_cfg&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00041">41</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a0c97e7d2cdb34b857e3b6de86b49f55d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0c97e7d2cdb34b857e3b6de86b49f55d">&#9670;&nbsp;</a></span>XRAN_UT_KEY_GLOBALCFG_PRACH</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define XRAN_UT_KEY_GLOBALCFG_PRACH&#160;&#160;&#160;&quot;prach_cfg&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00043">43</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a98f3e1fb2c2dd1381aac8d01b293486a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a98f3e1fb2c2dd1381aac8d01b293486a">&#9670;&nbsp;</a></span>XRAN_UT_KEY_GLOBALCFG_RU</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define XRAN_UT_KEY_GLOBALCFG_RU&#160;&#160;&#160;&quot;ru_cfg&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00044">44</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a1976c5b3ee9779f3fe720e706b5c4e72"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1976c5b3ee9779f3fe720e706b5c4e72">&#9670;&nbsp;</a></span>XRAN_UT_KEY_GLOBALCFG_SLOT</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define XRAN_UT_KEY_GLOBALCFG_SLOT&#160;&#160;&#160;&quot;slotcfg_&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__lib__wrap_8hpp_source.html#l00045">45</a> of file <a class="el" href="xran__lib__wrap_8hpp_source.html">xran_lib_wrap.hpp</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="a6c189fbbc24f87fad24cff9cbd0e6a42"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6c189fbbc24f87fad24cff9cbd0e6a42">&#9670;&nbsp;</a></span>sym_ota_cb()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void sym_ota_cb </td>
+          <td>(</td>
+          <td class="paramtype">struct rte_timer *&#160;</td>
+          <td class="paramname"><em>tim</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&#160;</td>
+          <td class="paramname"><em>arg</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="a9c3700d61ba446fa9b05cca2ca9018ab"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9c3700d61ba446fa9b05cca2ca9018ab">&#9670;&nbsp;</a></span>tti_ota_cb()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void tti_ota_cb </td>
+          <td>(</td>
+          <td class="paramtype">struct rte_timer *&#160;</td>
+          <td class="paramname"><em>tim</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&#160;</td>
+          <td class="paramname"><em>arg</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__main_8c_source.html#l00632">632</a> of file <a class="el" href="xran__main_8c_source.html">xran_main.c</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__lib__wrap_8hpp_a9c3700d61ba446fa9b05cca2ca9018ab_cgraph.png" border="0" usemap="#xran__lib__wrap_8hpp_a9c3700d61ba446fa9b05cca2ca9018ab_cgraph" alt=""/></div>
+<map name="xran__lib__wrap_8hpp_a9c3700d61ba446fa9b05cca2ca9018ab_cgraph" id="xran__lib__wrap_8hpp_a9c3700d61ba446fa9b05cca2ca9018ab_cgraph">
+<area shape="rect" id="node2" href="xran__main_8c.html#aa09e72e94d2a1d891e86f4c09b0f8b21" title="xran_dev_get_ctx" alt="" coords="145,5,270,32"/>
+<area shape="rect" id="node3" href="xran__frame__struct_8c.html#a7f5a87395d3930f222e58976960c99e2" title="xran_fs_get_max_slot" alt="" coords="132,56,283,83"/>
+</map>
+</div>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__lib__wrap_8hpp_a9c3700d61ba446fa9b05cca2ca9018ab_icgraph.png" border="0" usemap="#xran__lib__wrap_8hpp_a9c3700d61ba446fa9b05cca2ca9018ab_icgraph" alt=""/></div>
+<map name="xran__lib__wrap_8hpp_a9c3700d61ba446fa9b05cca2ca9018ab_icgraph" id="xran__lib__wrap_8hpp_a9c3700d61ba446fa9b05cca2ca9018ab_icgraph">
+<area shape="rect" id="node2" href="classxran_lib_wraper.html#a3783fbb2a26b8a0530c489850a905a38" title="xranLibWraper::update_tti" alt="" coords="132,56,303,83"/>
+<area shape="rect" id="node12" href="xran__main_8c.html#a195da46c3cb90e36da543594416cbba7" title="sym_ota_cb" alt="" coords="171,107,264,133"/>
+<area shape="rect" id="node3" href="chain__tests_8cc.html#af4e08ea14f09b53fce43ec39aba7a605" title="xran_ut_tx_cp_dl" alt="" coords="367,5,488,32"/>
+<area shape="rect" id="node6" href="chain__tests_8cc.html#a61f8088ed26f5ccc6a323c3b0feb66c2" title="xran_ut_tx_cp_ul" alt="" coords="367,56,488,83"/>
+<area shape="rect" id="node8" href="classxran_lib_wraper.html#ac4ce5a18c687ee515676e035359a1e89" title="xranLibWraper::update\l_symbol_index" alt="" coords="351,107,504,149"/>
+<area shape="rect" id="node4" href="chain__tests_8cc.html#a6c5f599800ca755367ad7df4da60eb86" title="TEST_P" alt="" coords="583,5,655,32"/>
+<area shape="rect" id="node5" href="chain__tests_8cc.html#a9dc1e3a47b655cad97eed3db3cdebd92" title="TEST_P" alt="" coords="735,56,807,83"/>
+<area shape="rect" id="node7" href="chain__tests_8cc.html#a54a43b6c3ece3e568457002dbe5b5c1a" title="TEST_P" alt="" coords="583,56,655,83"/>
+<area shape="rect" id="node9" href="chain__tests_8cc.html#a73639c0dcf18fe068dc350fc0c8ba2f2" title="xran_ut_tx_up_dl" alt="" coords="559,157,680,184"/>
+<area shape="rect" id="node11" href="chain__tests_8cc.html#ad274ca70e6c47c2c549422b1cba1f0b0" title="xran_ut_tx_cpup_dl" alt="" coords="552,107,687,133"/>
+<area shape="rect" id="node10" href="chain__tests_8cc.html#a2bc2178388f6edfa69905ff5f52fbcdc" title="TEST_P" alt="" coords="735,157,807,184"/>
+</map>
+</div>
+
+</div>
+</div>
+<h2 class="groupheader">Variable Documentation</h2>
+<a id="a8cec0b41a42705e6ab9f49914ca666c2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8cec0b41a42705e6ab9f49914ca666c2">&#9670;&nbsp;</a></span>xran_lib_ota_sym</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t xran_lib_ota_sym</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Symbol index in a slot [0:13] </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__main_8c_source.html#l00112">112</a> of file <a class="el" href="xran__main_8c_source.html">xran_main.c</a>.</p>
+
+</div>
+</div>
+<a id="a98175f360f5753bc99c4edd3c2d8bd04"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a98175f360f5753bc99c4edd3c2d8bd04">&#9670;&nbsp;</a></span>xran_lib_ota_sym_idx</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t xran_lib_ota_sym_idx</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Symbol index in a second [0 : 14*(1000000/TTI)-1] where TTI is TTI interval in microseconds </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__main_8c_source.html#l00113">113</a> of file <a class="el" href="xran__main_8c_source.html">xran_main.c</a>.</p>
+
+</div>
+</div>
+<a id="a273a09cbea9267272f4e2a339059e442"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a273a09cbea9267272f4e2a339059e442">&#9670;&nbsp;</a></span>xran_lib_ota_tti</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t xran_lib_ota_tti</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Slot index in a second [0:(1000000/TTI-1)] </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__main_8c_source.html#l00111">111</a> of file <a class="el" href="xran__main_8c_source.html">xran_main.c</a>.</p>
+
+</div>
+</div>
+<a id="a1b2100f9f398243bb4bdbf0db003b9a3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1b2100f9f398243bb4bdbf0db003b9a3">&#9670;&nbsp;</a></span>xranlib</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classxran_lib_wraper.html">xranLibWraper</a>* xranlib</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xranlib__unit__test__main_8cc_source.html#l00044">44</a> of file <a class="el" href="xranlib__unit__test__main_8cc_source.html">xranlib_unit_test_main.cc</a>.</p>
+
+</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>