add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__cp__gen__params.html
diff --git a/docs/API/structxran__cp__gen__params.html b/docs/API/structxran__cp__gen__params.html
new file mode 100644 (file)
index 0000000..a37a8a0
--- /dev/null
@@ -0,0 +1,201 @@
+<!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_cp_gen_params 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_cp_gen_params Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for xran_cp_gen_params:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__cp__gen__params__coll__graph.png" border="0" usemap="#xran__cp__gen__params_coll__map" alt="Collaboration graph"/></div>
+<map name="xran__cp__gen__params_coll__map" id="xran__cp__gen__params_coll__map">
+<area shape="rect" id="node2" href="structxran__cp__header__params.html" title="{xran_cp_header_params\n|+ filterIdx\l+ frameId\l+ subframeId\l+ slotId\l+ startSymId\l+ fftSize\l+ scs\l+ iqWidth\l+ compMeth\l+ numUEs\l+ timeOffset\l+ cpLength\l|}" alt="" coords="249,491,413,729"/>
+<area shape="rect" id="node3" href="structxran__section__gen__info.html" title="{xran_section_gen_info\n|+ exDataSize\l+ type\l+ len\l+ data\l+ exData\l|}" alt="" coords="437,542,589,678"/>
+<area shape="rect" id="node4" href="structxran__sectionext5__info.html" title="{xran_sectionext5_info\n|+ num_sets\l+ csf\l+ mcScaleReMask\l+ mcScaleOffset\l+ mc\l|}" alt="" coords="5,248,155,384"/>
+<area shape="rect" id="node5" href="structxran__sectionext4__info.html" title="{xran_sectionext4_info\n|+ csf\l+ pad0\l+ modCompScaler\l|}" alt="" coords="179,263,328,369"/>
+<area shape="rect" id="node6" href="structxran__sectionext3__info.html" title="{xran_sectionext3_info\n|+ codebookIdx\l+ layerId\l+ numLayers\l+ txScheme\l+ crsReMask\l+ crsShift\l+ crsSymNum\l+ beamIdAP1\l+ beamIdAP2\l+ beamIdAP3\l|}" alt="" coords="352,211,501,421"/>
+<area shape="rect" id="node7" href="structxran__sectionext2__info.html" title="{xran_sectionext2_info\n|+ bfAzPtWidth\l+ bfAzPt\l+ bfZePtWidth\l+ bfZePt\l+ bfAz3ddWidth\l+ bfAz3dd\l+ bfZe3ddWidth\l+ bfZe3dd\l+ bfAzSI\l+ bfZeSI\l|}" alt="" coords="525,211,675,421"/>
+<area shape="rect" id="node8" href="structxran__sectionext1__info.html" title="{xran_sectionext1_info\n|+ rbNumber\l+ bfwNumber\l+ bfwiqWidth\l+ bfwCompMeth\l+ p_bfwIQ\l+ bfwIQ_sz\l+ exponent\l+ blockScaler\l+ compBitWidthShift\l+ activeBeamspaceCoeffMask\l+ bfwCompParam\l|}" alt="" coords="699,204,901,428"/>
+<area shape="rect" id="node9" href="structxran__section__info.html" title="{xran_section_info\n|+ type\l+ startSymId\l+ numSymbol\l+ symInc\l+ id\l+ reMask\l+ startPrbc\l+ numPrbc\l+ rb\l+ compMeth\land 7 more...\l|}" alt="" coords="926,204,1050,428"/>
+<area shape="rect" id="node10" href="structxran__section__desc.html" title="{xran_section_desc\n|+ section_id\l+ iq_buffer_offset\l+ iq_buffer_len\l+ pData\l+ pCtrl\l|}" alt="" coords="923,5,1053,141"/>
+</map>
+</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:a92abda0bec7c1c978fe96f87aad18067"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__gen__params.html#a92abda0bec7c1c978fe96f87aad18067">dir</a></td></tr>
+<tr class="separator:a92abda0bec7c1c978fe96f87aad18067"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae273caa235b1c6085de4ad13886f82c9"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__gen__params.html#ae273caa235b1c6085de4ad13886f82c9">sectionType</a></td></tr>
+<tr class="separator:ae273caa235b1c6085de4ad13886f82c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a52bddd404e766ddb6f2b9eabe15ea5b1"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__gen__params.html#a52bddd404e766ddb6f2b9eabe15ea5b1">numSections</a></td></tr>
+<tr class="separator:a52bddd404e766ddb6f2b9eabe15ea5b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6c787affb1020c2b8058a3ddeff3fe52"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__cp__header__params.html">xran_cp_header_params</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__gen__params.html#a6c787affb1020c2b8058a3ddeff3fe52">hdr</a></td></tr>
+<tr class="separator:a6c787affb1020c2b8058a3ddeff3fe52"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5921f2439294279b8111fed577c5c37a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__section__gen__info.html">xran_section_gen_info</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__gen__params.html#a5921f2439294279b8111fed577c5c37a">sections</a></td></tr>
+<tr class="separator:a5921f2439294279b8111fed577c5c37a"><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 structure to hold the information to generate a C-Plane message </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00315">315</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a92abda0bec7c1c978fe96f87aad18067"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a92abda0bec7c1c978fe96f87aad18067">&#9670;&nbsp;</a></span>dir</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t dir</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>UL or DL </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00316">316</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a6c787affb1020c2b8058a3ddeff3fe52"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6c787affb1020c2b8058a3ddeff3fe52">&#9670;&nbsp;</a></span>hdr</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structxran__cp__header__params.html">xran_cp_header_params</a> hdr</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>The information for C-Plane message header </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00320">320</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a52bddd404e766ddb6f2b9eabe15ea5b1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a52bddd404e766ddb6f2b9eabe15ea5b1">&#9670;&nbsp;</a></span>numSections</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t numSections</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>the number of sections to generate </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00318">318</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a5921f2439294279b8111fed577c5c37a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5921f2439294279b8111fed577c5c37a">&#9670;&nbsp;</a></span>sections</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structxran__section__gen__info.html">xran_section_gen_info</a>* sections</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Array of the section information </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00322">322</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ae273caa235b1c6085de4ad13886f82c9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae273caa235b1c6085de4ad13886f82c9">&#9670;&nbsp;</a></span>sectionType</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t sectionType</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>each section must have same type with this </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00317">317</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.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>