add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__prb__elm.html
diff --git a/docs/API/structxran__prb__elm.html b/docs/API/structxran__prb__elm.html
new file mode 100644 (file)
index 0000000..a055b9f
--- /dev/null
@@ -0,0 +1,362 @@
+<!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_prb_elm 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_prb_elm Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for xran_prb_elm:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__prb__elm__coll__graph.png" border="0" usemap="#xran__prb__elm_coll__map" alt="Collaboration graph"/></div>
+<map name="xran__prb__elm_coll__map" id="xran__prb__elm_coll__map">
+<area shape="rect" id="node2" href="structxran__cp__bf__weight.html" title="{xran_cp_bf_weight\n|+ nAntElmTRx\l+ p_ext_section\l+ ext_section_sz\l|}" alt="" coords="5,20,136,127"/>
+<area shape="rect" id="node3" href="structxran__cp__bf__attribute.html" title="{xran_cp_bf_attribute\n|+ weight\l|}" alt="" coords="161,35,301,112"/>
+<area shape="rect" id="node4" 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="325,5,456,141"/>
+<area shape="rect" id="node5" href="structxran__cp__bf__precoding.html" title="{xran_cp_bf_precoding\n|+ weight\l|}" alt="" coords="480,35,629,112"/>
+</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:a5248ad5c1a177b8b9d5ef60f710652bc"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a5248ad5c1a177b8b9d5ef60f710652bc">nRBStart</a></td></tr>
+<tr class="separator:a5248ad5c1a177b8b9d5ef60f710652bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a18adf7163dacc5bd7dd344fb1216f729"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a18adf7163dacc5bd7dd344fb1216f729">nRBSize</a></td></tr>
+<tr class="separator:a18adf7163dacc5bd7dd344fb1216f729"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5acab5eec7096fb7732c804f71f02a4d"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a5acab5eec7096fb7732c804f71f02a4d">nStartSymb</a></td></tr>
+<tr class="separator:a5acab5eec7096fb7732c804f71f02a4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad2586af82c76901c361a2d08a6ba553b"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#ad2586af82c76901c361a2d08a6ba553b">numSymb</a></td></tr>
+<tr class="separator:ad2586af82c76901c361a2d08a6ba553b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aba198438bbacf8f73b6bfa481b365ce5"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#aba198438bbacf8f73b6bfa481b365ce5">nBeamIndex</a></td></tr>
+<tr class="separator:aba198438bbacf8f73b6bfa481b365ce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0cae38b481020301f9e6831c27b5058b"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a0cae38b481020301f9e6831c27b5058b">bf_weight_update</a></td></tr>
+<tr class="separator:a0cae38b481020301f9e6831c27b5058b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad73157f14fa98c54fb563244c1327933"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#ad73157f14fa98c54fb563244c1327933">compMethod</a></td></tr>
+<tr class="separator:ad73157f14fa98c54fb563244c1327933"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a36f5a0cedd274c3ec55f81535f06e0de"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a36f5a0cedd274c3ec55f81535f06e0de">iqWidth</a></td></tr>
+<tr class="separator:a36f5a0cedd274c3ec55f81535f06e0de"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8b8b1bd49f0c7c15063d74dd4ad48cde"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a8b8b1bd49f0c7c15063d74dd4ad48cde">BeamFormingType</a></td></tr>
+<tr class="separator:a8b8b1bd49f0c7c15063d74dd4ad48cde"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6c405fdd34c38d29b355cd051527ad9b"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__section__desc.html">xran_section_desc</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a6c405fdd34c38d29b355cd051527ad9b">p_sec_desc</a> [<a class="el" href="xran__fh__o__du_8h.html#a87d92ec177ed9c388685a91051f66205">XRAN_NUM_OF_SYMBOL_PER_SLOT</a>]</td></tr>
+<tr class="separator:a6c405fdd34c38d29b355cd051527ad9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af868e8b704cfa4b2cfc9f02b14bb8ca4"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__cp__bf__weight.html">xran_cp_bf_weight</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#af868e8b704cfa4b2cfc9f02b14bb8ca4">bf_weight</a></td></tr>
+<tr class="separator:af868e8b704cfa4b2cfc9f02b14bb8ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a792a3f6fb505ec20367144c2cd79f295"><td class="memItemLeft" >union {</td></tr>
+<tr class="memitem:a3e5b780c49cb9d6ec97dcd4762f8ac34"><td class="memItemLeft" >&#160;&#160;&#160;struct <a class="el" href="structxran__cp__bf__attribute.html">xran_cp_bf_attribute</a>&#160;&#160;&#160;<a class="el" href="structxran__prb__elm.html#a3e5b780c49cb9d6ec97dcd4762f8ac34">bf_attribute</a></td></tr>
+<tr class="separator:a3e5b780c49cb9d6ec97dcd4762f8ac34"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a78ed222752b307427c62c9f4c1e4c8be"><td class="memItemLeft" >&#160;&#160;&#160;struct <a class="el" href="structxran__cp__bf__precoding.html">xran_cp_bf_precoding</a>&#160;&#160;&#160;<a class="el" href="structxran__prb__elm.html#a78ed222752b307427c62c9f4c1e4c8be">bf_precoding</a></td></tr>
+<tr class="separator:a78ed222752b307427c62c9f4c1e4c8be"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a792a3f6fb505ec20367144c2cd79f295"><td class="memItemLeft" valign="top">};&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
+<tr class="separator:a792a3f6fb505ec20367144c2cd79f295"><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>PRB element structure </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00393">393</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a792a3f6fb505ec20367144c2cd79f295"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a792a3f6fb505ec20367144c2cd79f295">&#9670;&nbsp;</a></span>@4</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">union { ... } </td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="a8b8b1bd49f0c7c15063d74dd4ad48cde"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8b8b1bd49f0c7c15063d74dd4ad48cde">&#9670;&nbsp;</a></span>BeamFormingType</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t BeamFormingType</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>index based, weights based or attribute based beam forming </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00402">402</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a3e5b780c49cb9d6ec97dcd4762f8ac34"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3e5b780c49cb9d6ec97dcd4762f8ac34">&#9670;&nbsp;</a></span>bf_attribute</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structxran__cp__bf__attribute.html">xran_cp_bf_attribute</a> bf_attribute</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00408">408</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a78ed222752b307427c62c9f4c1e4c8be"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a78ed222752b307427c62c9f4c1e4c8be">&#9670;&nbsp;</a></span>bf_precoding</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structxran__cp__bf__precoding.html">xran_cp_bf_precoding</a> bf_precoding</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00409">409</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="af868e8b704cfa4b2cfc9f02b14bb8ca4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af868e8b704cfa4b2cfc9f02b14bb8ca4">&#9670;&nbsp;</a></span>bf_weight</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structxran__cp__bf__weight.html">xran_cp_bf_weight</a> bf_weight</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>beam forming information relevant for given RBs </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00405">405</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a0cae38b481020301f9e6831c27b5058b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0cae38b481020301f9e6831c27b5058b">&#9670;&nbsp;</a></span>bf_weight_update</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t bf_weight_update</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00399">399</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="ad73157f14fa98c54fb563244c1327933"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad73157f14fa98c54fb563244c1327933">&#9670;&nbsp;</a></span>compMethod</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t compMethod</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>need to update beam weights or not compression index for given PRB </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00400">400</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a36f5a0cedd274c3ec55f81535f06e0de"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a36f5a0cedd274c3ec55f81535f06e0de">&#9670;&nbsp;</a></span>iqWidth</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t iqWidth</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>compression bit width for given PRB </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00401">401</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="aba198438bbacf8f73b6bfa481b365ce5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aba198438bbacf8f73b6bfa481b365ce5">&#9670;&nbsp;</a></span>nBeamIndex</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t nBeamIndex</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>beam index for given PRB </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00398">398</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a18adf7163dacc5bd7dd344fb1216f729"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a18adf7163dacc5bd7dd344fb1216f729">&#9670;&nbsp;</a></span>nRBSize</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t nRBSize</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>number of RBs used </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00395">395</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a5248ad5c1a177b8b9d5ef60f710652bc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5248ad5c1a177b8b9d5ef60f710652bc">&#9670;&nbsp;</a></span>nRBStart</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t nRBStart</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>start RB of RB allocation </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00394">394</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a5acab5eec7096fb7732c804f71f02a4d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5acab5eec7096fb7732c804f71f02a4d">&#9670;&nbsp;</a></span>nStartSymb</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t nStartSymb</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>start symbol ID </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00396">396</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="ad2586af82c76901c361a2d08a6ba553b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad2586af82c76901c361a2d08a6ba553b">&#9670;&nbsp;</a></span>numSymb</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t numSymb</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>number of symbols </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00397">397</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a6c405fdd34c38d29b355cd051527ad9b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6c405fdd34c38d29b355cd051527ad9b">&#9670;&nbsp;</a></span>p_sec_desc</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structxran__section__desc.html">xran_section_desc</a>* p_sec_desc[<a class="el" href="xran__fh__o__du_8h.html#a87d92ec177ed9c388685a91051f66205">XRAN_NUM_OF_SYMBOL_PER_SLOT</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>section desctiptors to U-plane data given RBs </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00404">404</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.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>