add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__prach__cp__config.html
diff --git a/docs/API/structxran__prach__cp__config.html b/docs/API/structxran__prach__cp__config.html
new file mode 100644 (file)
index 0000000..2ea78d1
--- /dev/null
@@ -0,0 +1,329 @@
+<!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_prach_cp_config Struct 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><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-attribs">Data Fields</a>  </div>
+  <div class="headertitle">
+<div class="title">xran_prach_cp_config Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for xran_prach_cp_config:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__prach__cp__config__coll__graph.png" border="0" usemap="#xran__prach__cp__config_coll__map" alt="Collaboration graph"/></div>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Data Fields</h2></td></tr>
+<tr class="memitem:ad5150de5e1c141cfe288f260afb00830"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#ad5150de5e1c141cfe288f260afb00830">filterIdx</a></td></tr>
+<tr class="separator:ad5150de5e1c141cfe288f260afb00830"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac54814779041bec5dcf8aec288d69b06"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#ac54814779041bec5dcf8aec288d69b06">startSymId</a></td></tr>
+<tr class="separator:ac54814779041bec5dcf8aec288d69b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6b13285aabf8f2f4598143b2670204c1"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a6b13285aabf8f2f4598143b2670204c1">startPrbc</a></td></tr>
+<tr class="separator:a6b13285aabf8f2f4598143b2670204c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aabc4fe26e40f742fd255e2bb8534de75"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#aabc4fe26e40f742fd255e2bb8534de75">numPrbc</a></td></tr>
+<tr class="separator:aabc4fe26e40f742fd255e2bb8534de75"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a664cb6ca464c69ef60a445fa4f4b3522"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a664cb6ca464c69ef60a445fa4f4b3522">numSymbol</a></td></tr>
+<tr class="separator:a664cb6ca464c69ef60a445fa4f4b3522"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa68c277a66312b4b90819cccc055bdb7"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#aa68c277a66312b4b90819cccc055bdb7">timeOffset</a></td></tr>
+<tr class="separator:aa68c277a66312b4b90819cccc055bdb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3af58496c14a1c91c015aa6ffe7dca49"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a3af58496c14a1c91c015aa6ffe7dca49">freqOffset</a></td></tr>
+<tr class="separator:a3af58496c14a1c91c015aa6ffe7dca49"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a855041f3139611ca7478502e3241b2f1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a855041f3139611ca7478502e3241b2f1">nrofPrachInSlot</a></td></tr>
+<tr class="separator:a855041f3139611ca7478502e3241b2f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2e544eaae35a5756272d62af4fa53a19"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a2e544eaae35a5756272d62af4fa53a19">occassionsInPrachSlot</a></td></tr>
+<tr class="separator:a2e544eaae35a5756272d62af4fa53a19"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0f561e77fa0f040b637f4e04f6cd8078"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a0f561e77fa0f040b637f4e04f6cd8078">x</a></td></tr>
+<tr class="separator:a0f561e77fa0f040b637f4e04f6cd8078"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1d627e83c5e0ae889b71ea0508991f29"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a1d627e83c5e0ae889b71ea0508991f29">y</a> [<a class="el" href="xran__common_8h.html#a342c40a4877f7760c65eca32523efea1">XRAN_PRACH_CANDIDATE_Y</a>]</td></tr>
+<tr class="separator:a1d627e83c5e0ae889b71ea0508991f29"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3b00fdd9e145b9c7be29aa35c6f94fe1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a3b00fdd9e145b9c7be29aa35c6f94fe1">isPRACHslot</a> [<a class="el" href="xran__common_8h.html#af7a48e76794ce5d801ab6d0f848abb53">XRAN_PRACH_CANDIDATE_SLOT</a>]</td></tr>
+<tr class="separator:a3b00fdd9e145b9c7be29aa35c6f94fe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a38a5594e33178248d80ccde98a16262a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a38a5594e33178248d80ccde98a16262a">eAxC_offset</a></td></tr>
+<tr class="separator:a38a5594e33178248d80ccde98a16262a"><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 class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00125">125</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a38a5594e33178248d80ccde98a16262a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a38a5594e33178248d80ccde98a16262a">&#9670;&nbsp;</a></span>eAxC_offset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t eAxC_offset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>starting eAxC for PRACH stream </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00139">139</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="ad5150de5e1c141cfe288f260afb00830"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad5150de5e1c141cfe288f260afb00830">&#9670;&nbsp;</a></span>filterIdx</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t filterIdx</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00127">127</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="a3af58496c14a1c91c015aa6ffe7dca49"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3af58496c14a1c91c015aa6ffe7dca49">&#9670;&nbsp;</a></span>freqOffset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t freqOffset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00133">133</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="a3b00fdd9e145b9c7be29aa35c6f94fe1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3b00fdd9e145b9c7be29aa35c6f94fe1">&#9670;&nbsp;</a></span>isPRACHslot</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t isPRACHslot[<a class="el" href="xran__common_8h.html#af7a48e76794ce5d801ab6d0f848abb53">XRAN_PRACH_CANDIDATE_SLOT</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00138">138</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="a855041f3139611ca7478502e3241b2f1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a855041f3139611ca7478502e3241b2f1">&#9670;&nbsp;</a></span>nrofPrachInSlot</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t nrofPrachInSlot</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00134">134</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="aabc4fe26e40f742fd255e2bb8534de75"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aabc4fe26e40f742fd255e2bb8534de75">&#9670;&nbsp;</a></span>numPrbc</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t numPrbc</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00130">130</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="a664cb6ca464c69ef60a445fa4f4b3522"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a664cb6ca464c69ef60a445fa4f4b3522">&#9670;&nbsp;</a></span>numSymbol</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t numSymbol</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00131">131</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="a2e544eaae35a5756272d62af4fa53a19"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2e544eaae35a5756272d62af4fa53a19">&#9670;&nbsp;</a></span>occassionsInPrachSlot</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t occassionsInPrachSlot</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00135">135</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="a6b13285aabf8f2f4598143b2670204c1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6b13285aabf8f2f4598143b2670204c1">&#9670;&nbsp;</a></span>startPrbc</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t startPrbc</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00129">129</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="ac54814779041bec5dcf8aec288d69b06"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac54814779041bec5dcf8aec288d69b06">&#9670;&nbsp;</a></span>startSymId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t startSymId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00128">128</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="aa68c277a66312b4b90819cccc055bdb7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa68c277a66312b4b90819cccc055bdb7">&#9670;&nbsp;</a></span>timeOffset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t timeOffset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00132">132</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="a0f561e77fa0f040b637f4e04f6cd8078"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0f561e77fa0f040b637f4e04f6cd8078">&#9670;&nbsp;</a></span>x</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t x</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00136">136</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<a id="a1d627e83c5e0ae889b71ea0508991f29"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1d627e83c5e0ae889b71ea0508991f29">&#9670;&nbsp;</a></span>y</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t y[<a class="el" href="xran__common_8h.html#a342c40a4877f7760c65eca32523efea1">XRAN_PRACH_CANDIDATE_Y</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00137">137</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__common_8h_source.html">xran_common.h</a></li>
+</ul>
+</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>