add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__prb__map.html
diff --git a/docs/API/structxran__prb__map.html b/docs/API/structxran__prb__map.html
new file mode 100644 (file)
index 0000000..75bc022
--- /dev/null
@@ -0,0 +1,272 @@
+<!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_map 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_map 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_map:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__prb__map__coll__graph.png" border="0" usemap="#xran__prb__map_coll__map" alt="Collaboration graph"/></div>
+<map name="xran__prb__map_coll__map" id="xran__prb__map_coll__map">
+<area shape="rect" id="node2" href="structxran__prb__elm.html" title="{xran_prb_elm\n|+ nRBStart\l+ nRBSize\l+ nStartSymb\l+ numSymb\l+ nBeamIndex\l+ bf_weight_update\l+ compMethod\l+ iqWidth\l+ BeamFormingType\l+ @4\l|}" alt="" coords="239,204,383,413"/>
+<area shape="rect" id="node3" 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="node4" href="structxran__cp__bf__attribute.html" title="{xran_cp_bf_attribute\n|+ weight\l|}" alt="" coords="161,35,301,112"/>
+<area shape="rect" id="node5" 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="node6" 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:a92abda0bec7c1c978fe96f87aad18067"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a92abda0bec7c1c978fe96f87aad18067">dir</a></td></tr>
+<tr class="separator:a92abda0bec7c1c978fe96f87aad18067"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5ca9a2b3d2a5c902f8153e3e383049be"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a5ca9a2b3d2a5c902f8153e3e383049be">xran_port</a></td></tr>
+<tr class="separator:a5ca9a2b3d2a5c902f8153e3e383049be"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1c85ead6321835264d2451291430a7da"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a1c85ead6321835264d2451291430a7da">band_id</a></td></tr>
+<tr class="separator:a1c85ead6321835264d2451291430a7da"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7fd0cb6d38d73460d3eaba911462dc69"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a7fd0cb6d38d73460d3eaba911462dc69">cc_id</a></td></tr>
+<tr class="separator:a7fd0cb6d38d73460d3eaba911462dc69"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a16b7b2d1f57da5ed39e7e3a026592a85"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a16b7b2d1f57da5ed39e7e3a026592a85">ru_port_id</a></td></tr>
+<tr class="separator:a16b7b2d1f57da5ed39e7e3a026592a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a689e28eeb2f378d4dc5f915a30f560db"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a689e28eeb2f378d4dc5f915a30f560db">tti_id</a></td></tr>
+<tr class="separator:a689e28eeb2f378d4dc5f915a30f560db"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:afc7dda8bf6b9a76f94c88c3610d9c594"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#afc7dda8bf6b9a76f94c88c3610d9c594">start_sym_id</a></td></tr>
+<tr class="separator:afc7dda8bf6b9a76f94c88c3610d9c594"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5a2ad8f5285dd33572e310069cdac3c4"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a5a2ad8f5285dd33572e310069cdac3c4">nPrbElm</a></td></tr>
+<tr class="separator:a5a2ad8f5285dd33572e310069cdac3c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2357c89e196d6c8c53e29bf04d168b7e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__prb__elm.html">xran_prb_elm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a2357c89e196d6c8c53e29bf04d168b7e">prbMap</a> [<a class="el" href="xran__fh__o__du_8h.html#a9435009d03a49d495b2b608129c64b61">XRAN_MAX_PRBS</a>]</td></tr>
+<tr class="separator:a2357c89e196d6c8c53e29bf04d168b7e"><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 map structure </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00414">414</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="a1c85ead6321835264d2451291430a7da"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1c85ead6321835264d2451291430a7da">&#9670;&nbsp;</a></span>band_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t band_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>xran band id </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00417">417</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="a7fd0cb6d38d73460d3eaba911462dc69"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7fd0cb6d38d73460d3eaba911462dc69">&#9670;&nbsp;</a></span>cc_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t cc_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>componnent carrier id [0 - (XRAN_MAX_SECTOR_NR-1)] </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00418">418</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="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>DL or UL direction </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00415">415</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="a5a2ad8f5285dd33572e310069cdac3c4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5a2ad8f5285dd33572e310069cdac3c4">&#9670;&nbsp;</a></span>nPrbElm</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t nPrbElm</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>total number of PRB elements for given map [0- (XRAN_MAX_PRBS-1)] </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00422">422</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="a2357c89e196d6c8c53e29bf04d168b7e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2357c89e196d6c8c53e29bf04d168b7e">&#9670;&nbsp;</a></span>prbMap</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structxran__prb__elm.html">xran_prb_elm</a> prbMap[<a class="el" href="xran__fh__o__du_8h.html#a9435009d03a49d495b2b608129c64b61">XRAN_MAX_PRBS</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00423">423</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="a16b7b2d1f57da5ed39e7e3a026592a85"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a16b7b2d1f57da5ed39e7e3a026592a85">&#9670;&nbsp;</a></span>ru_port_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t ru_port_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>RU device antenna port id [0 - (XRAN_MAX_ANTENNA_NR-1) </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00419">419</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="afc7dda8bf6b9a76f94c88c3610d9c594"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afc7dda8bf6b9a76f94c88c3610d9c594">&#9670;&nbsp;</a></span>start_sym_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t start_sym_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>start symbol Id [0-13] </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00421">421</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="a689e28eeb2f378d4dc5f915a30f560db"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a689e28eeb2f378d4dc5f915a30f560db">&#9670;&nbsp;</a></span>tti_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t tti_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>xRAN slot id [0 - (max tti-1)] </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00420">420</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="a5ca9a2b3d2a5c902f8153e3e383049be"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5ca9a2b3d2a5c902f8153e3e383049be">&#9670;&nbsp;</a></span>xran_port</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t xran_port</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>xran id of given RU [0-(XRAN_PORTS_NUM-1)] </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00416">416</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>