add Doxygen documentation
[o-du/phy.git] / docs / API / prach__functional_8cc.html
diff --git a/docs/API/prach__functional_8cc.html b/docs/API/prach__functional_8cc.html
new file mode 100644 (file)
index 0000000..b896672
--- /dev/null
@@ -0,0 +1,258 @@
+<!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: prach_functional.cc 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_eb25680e5ae075ef825a327f00297047.html">test_xran</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Data Structures</a> &#124;
+<a href="#func-members">Functions</a> &#124;
+<a href="#var-members">Variables</a>  </div>
+  <div class="headertitle">
+<div class="title">prach_functional.cc File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><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__common_8h_source.html">xran_common.h</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="ethernet_8h_source.html">ethernet.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="xran__transport_8h_source.html">xran_transport.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>&quot;</code><br />
+<code>#include &lt;stdint.h&gt;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for prach_functional.cc:</div>
+<div class="dyncontent">
+<div class="center"><img src="prach__functional_8cc__incl.png" border="0" usemap="#prach__functional_8cc" alt=""/></div>
+<map name="prach__functional_8cc" id="prach__functional_8cc">
+<area shape="rect" id="node2" href="common_8hpp.html" title="common.hpp" alt="" coords="655,155,753,181"/>
+<area shape="rect" id="node26" 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="1971,80,2085,107"/>
+<area shape="rect" id="node33" 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="2166,229,2277,256"/>
+<area shape="rect" id="node47" href="xran__cp__api_8h.html" title="This file provides the definitions for Control Plane Messages APIs. " alt="" coords="1623,155,1726,181"/>
+<area shape="rect" id="node49" href="xran__transport_8h.html" title="This file provides the definitions for Transport layer (eCPRI) API. " alt="" coords="1293,229,1409,256"/>
+<area shape="rect" id="node50" href="ethernet_8h.html" title="This file has all definitions for the Ethernet Data Interface Layer. " alt="" coords="1125,155,1205,181"/>
+<area shape="rect" id="node13" href="common__typedef__xran_8h.html" title="This header file defines those data type both used by eNB and UE. " alt="" coords="1433,229,1599,256"/>
+<area shape="rect" id="node17" href="json_8hpp.html" title="json.hpp" alt="" coords="365,229,435,256"/>
+<area shape="rect" id="node44" href="xran__pkt__up_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="1801,155,1905,181"/>
+<area shape="rect" id="node45" href="xran__pkt_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="1300,304,1383,331"/>
+<area shape="rect" id="node48" href="xran__pkt__cp_8h.html" title="This file provides the definition of Control Plane Messages for XRAN Front Haul layer as defined in X..." alt="" coords="1623,229,1727,256"/>
+</map>
+</div>
+</div>
+<p><a href="prach__functional_8cc_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="class_prach_check.html">PrachCheck</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="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:a62307393b7f454a2b348ada67997b796"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="prach__functional_8cc.html#a62307393b7f454a2b348ada67997b796">TEST_P</a> (<a class="el" href="class_prach_check.html">PrachCheck</a>, PacketGen)</td></tr>
+<tr class="separator:a62307393b7f454a2b348ada67997b796"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac9bbd414b07f0f0f9220e132a11bea34"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="prach__functional_8cc.html#ac9bbd414b07f0f0f9220e132a11bea34">INSTANTIATE_TEST_CASE_P</a> (UnitTest, <a class="el" href="class_prach_check.html">PrachCheck</a>, testing::ValuesIn(<a class="el" href="common_8hpp.html#a39bf4f7770751080f5b72046abfd01a5">get_sequence</a>(<a class="el" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96">PrachCheck::get_number_of_cases</a>(&quot;prach_functional&quot;))))</td></tr>
+<tr class="separator:ac9bbd414b07f0f0f9220e132a11bea34"><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:a69b4bff6061152ff85770d725cced3cc"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="prach__functional_8cc.html#a69b4bff6061152ff85770d725cced3cc">module_name</a> = &quot;Prach_test&quot;</td></tr>
+<tr class="separator:a69b4bff6061152ff85770d725cced3cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="ac9bbd414b07f0f0f9220e132a11bea34"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac9bbd414b07f0f0f9220e132a11bea34">&#9670;&nbsp;</a></span>INSTANTIATE_TEST_CASE_P()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">INSTANTIATE_TEST_CASE_P </td>
+          <td>(</td>
+          <td class="paramtype">UnitTest&#160;</td>
+          <td class="paramname">, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="class_prach_check.html">PrachCheck</a>&#160;</td>
+          <td class="paramname">, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">testing::ValuesIn(<a class="el" href="common_8hpp.html#a39bf4f7770751080f5b72046abfd01a5">get_sequence</a>(<a class="el" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96">PrachCheck::get_number_of_cases</a>(&quot;prach_functional&quot;)))&#160;</td>
+          <td class="paramname">&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="prach__functional_8cc_ac9bbd414b07f0f0f9220e132a11bea34_icgraph.png" border="0" usemap="#prach__functional_8cc_ac9bbd414b07f0f0f9220e132a11bea34_icgraph" alt=""/></div>
+<map name="prach__functional_8cc_ac9bbd414b07f0f0f9220e132a11bea34_icgraph" id="prach__functional_8cc_ac9bbd414b07f0f0f9220e132a11bea34_icgraph">
+<area shape="rect" id="node2" href="prach__functional_8cc.html#a62307393b7f454a2b348ada67997b796" title="TEST_P" alt="" coords="264,5,336,32"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a62307393b7f454a2b348ada67997b796"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a62307393b7f454a2b348ada67997b796">&#9670;&nbsp;</a></span>TEST_P()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">TEST_P </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="class_prach_check.html">PrachCheck</a>&#160;</td>
+          <td class="paramname">, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">PacketGen&#160;</td>
+          <td class="paramname">&#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="prach__functional_8cc_source.html#l00177">177</a> of file <a class="el" href="prach__functional_8cc_source.html">prach_functional.cc</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="prach__functional_8cc_a62307393b7f454a2b348ada67997b796_cgraph.png" border="0" usemap="#prach__functional_8cc_a62307393b7f454a2b348ada67997b796_cgraph" alt=""/></div>
+<map name="prach__functional_8cc_a62307393b7f454a2b348ada67997b796_cgraph" id="prach__functional_8cc_a62307393b7f454a2b348ada67997b796_cgraph">
+<area shape="rect" id="node2" href="xran__common_8h.html#a00025c5bad7b7b6eea4374226f8c54bb" title="xran_init_prach" alt="" coords="422,309,533,336"/>
+<area shape="rect" id="node5" href="xran__fh__o__du_8h.html#a03f408f45e97aa68ca47c92e4e7d1a70" title="xran_open" alt="" coords="189,588,272,615"/>
+<area shape="rect" id="node17" href="xran__common_8c.html#ab8a6ed3cee8fa183142d0c23d0b4971d" title="generate_cpmsg_prach" alt="" coords="152,157,309,184"/>
+<area shape="rect" id="node30" href="prach__functional_8cc.html#ac9bbd414b07f0f0f9220e132a11bea34" title="INSTANTIATE_TEST_CASE_P" alt="" coords="125,639,336,665"/>
+<area shape="rect" id="node31" href="common_8cpp.html#a39bf4f7770751080f5b72046abfd01a5" title="For a given number return sequence of number from 0 to number &#45; 1. " alt="" coords="179,689,282,716"/>
+<area shape="rect" id="node32" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96" title="KernelTests::get_number\l_of_cases" alt="" coords="147,939,315,981"/>
+<area shape="rect" id="node3" href="xran__cp__api_8h.html#a4b7c2b7f89a0a04b07426e6adbecdb27" title="xran_get_freqoffset" alt="" coords="627,360,762,387"/>
+<area shape="rect" id="node4" href="xran__main_8c.html#a3fc01469558ddf728239d59038ac5803" title="Get the configuration of the number of antenna for UL. " alt="" coords="624,309,765,336"/>
+<area shape="rect" id="node6" href="xran__main_8c.html#aa09e72e94d2a1d891e86f4c09b0f8b21" title="xran_dev_get_ctx" alt="" coords="1221,537,1347,564"/>
+<area shape="rect" id="node7" href="xran__main_8c.html#ae6070ee9caf6a7ea8d7ef052ed0a559a" title="Get the configuration of nummerology. " alt="" coords="388,411,567,437"/>
+<area shape="rect" id="node8" href="xran__main_8c.html#a00025c5bad7b7b6eea4374226f8c54bb" title="xran_init_prach" alt="" coords="422,360,533,387"/>
+<area shape="rect" id="node9" href="xran__main_8c.html#acb5dd6ae5569cb3090d441c800068244" title="xran_init_srs" alt="" coords="429,461,525,488"/>
+<area shape="rect" id="node10" href="xran__cp__api_8h.html#a3ca98b2a49501149a7b5baf9174897d8" title="Initialize section database. Allocate required memory space to store section information. Each eAxC allocates dedicated storage and the entry size is the maximum number of sections. Total entry size : number of CC * number of antenna * max number of sections * 2(direction) " alt="" coords="400,512,555,539"/>
+<area shape="rect" id="node11" href="xran__main_8c.html#a54de92e0ced826beeb759580d170562b" title="xran_init_sectionid" alt="" coords="412,613,543,640"/>
+<area shape="rect" id="node12" href="xran__main_8c.html#a7a3c06a23d41de0038747348be9bb9da" title="xran_init_seqid" alt="" coords="423,664,532,691"/>
+<area shape="rect" id="node13" href="xran__frame__struct_8c.html#a8e8598556da3e49fa48cb646c24162fa" title="xran_fs_get_tti_interval" alt="" coords="399,715,556,741"/>
+<area shape="rect" id="node14" href="xran__timer_8h.html#a6c1790e87767257159038d0d98a393e6" title="timing_set_numerology" alt="" coords="399,765,555,792"/>
+<area shape="rect" id="node15" href="xran__frame__struct_8c.html#a075025c7652869adb79799313aab4f64" title="xran_fs_set_slot_type" alt="" coords="402,816,553,843"/>
+<area shape="rect" id="node16" href="xran__frame__struct_8c.html#a2fd9b68ce2fa4734a021203b320e4e04" title="xran_fs_slot_limit_init" alt="" coords="403,867,551,893"/>
+<area shape="rect" id="node18" href="xran__common_8h.html#a5f780beefc47e125ffd42fde16117e62" title="Get the configuration of IQ bit width for RU. " alt="" coords="401,56,553,83"/>
+<area shape="rect" id="node19" href="xran__common_8h.html#a70d428b456fbe76f8550ff9b782a9e4e" title="Get the configuration of compression method for RU. " alt="" coords="384,107,571,133"/>
+<area shape="rect" id="node20" href="xran__common_8h.html#ada345a8a99480787d4274a342aa39535" title="Get the configuration of FFT size for RU. " alt="" coords="404,208,551,235"/>
+<area shape="rect" id="node21" href="xran__common_8h.html#ab39a5770374d16662d62a85504a11930" title="Get the configuration of subcarrier spacing for PRACH. " alt="" coords="392,259,563,285"/>
+<area shape="rect" id="node22" href="xran__common_8h.html#a8546e95e2daf30058a66904e7f801723" title="xran_alloc_sectionid" alt="" coords="407,5,547,32"/>
+<area shape="rect" id="node23" href="xran__cp__api_8h.html#af9eb550e92ea270af41b4b6bcda363db" title="Create a C&#45;Plane packet Transport layer fragmentation is not supported. " alt="" coords="404,157,551,184"/>
+<area shape="rect" id="node24" href="xran__transport_8h.html#aa21387dfaba47c2046d4a05f50cfc768" title="Build ECPRI header and returns added length. " alt="" coords="624,113,765,140"/>
+<area shape="rect" id="node28" href="xran__cp__api_8c.html#a1261c107d1103c8bd1b3376db4aa7951" title="add a radio application header in a C&#45;Plane packet " alt="" coords="619,165,771,206"/>
+<area shape="rect" id="node29" href="xran__cp__api_8c.html#ad50ae862f0707dab5e7b8e6a774fd225" title="add sections to C&#45;Plane packet Section type 1 and 3 are supported. " alt="" coords="623,230,766,271"/>
+<area shape="rect" id="node25" href="xran__transport_8c.html#ae834080139ba785f1a3ac5781bf2ec88" title="Compose ecpriRtcid/ecpriPcid. " alt="" coords="835,113,965,140"/>
+<area shape="rect" id="node27" href="xran__transport_8c.html#a0f378609208ec66467c58f0702ced85c" title="return eCPRI header size without eCPRI common header " alt="" coords="819,164,981,191"/>
+<area shape="rect" id="node26" href="xran__common_8h.html#a761e3947dcc547008a12a9cca10b1ea0" title="Get the configuration of eAxC ID. " alt="" coords="1029,313,1173,340"/>
+<area shape="rect" id="node33" href="common_8hpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428" title="Read JSON from the given file. " alt="" coords="410,917,545,944"/>
+<area shape="rect" id="node34" href="classnlohmann_1_1basic__json.html#a0801762a3fe36fe32dca5f16e515478d" title="returns the number of elements " alt="" coords="403,969,551,1010"/>
+<area shape="rect" id="node35" href="structmissing__config__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="missing_config_file\l_exception::what" alt="" coords="411,1034,544,1075"/>
+</map>
+</div>
+
+</div>
+</div>
+<h2 class="groupheader">Variable Documentation</h2>
+<a id="a69b4bff6061152ff85770d725cced3cc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a69b4bff6061152ff85770d725cced3cc">&#9670;&nbsp;</a></span>module_name</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const std::string module_name = &quot;Prach_test&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="prach__functional_8cc_source.html#l00030">30</a> of file <a class="el" href="prach__functional_8cc_source.html">prach_functional.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>