add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__cp__rbmap__list.html
diff --git a/docs/API/structxran__cp__rbmap__list.html b/docs/API/structxran__cp__rbmap__list.html
new file mode 100644 (file)
index 0000000..7ce2a26
--- /dev/null
@@ -0,0 +1,303 @@
+<!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_rbmap_list 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_rbmap_list 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_rbmap_list:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__cp__rbmap__list__coll__graph.png" border="0" usemap="#xran__cp__rbmap__list_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:acbe4924d3235876d0b54c3c9ef6f8149"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#acbe4924d3235876d0b54c3c9ef6f8149">grp_id</a></td></tr>
+<tr class="separator:acbe4924d3235876d0b54c3c9ef6f8149"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a23b2201c117393dd97c63e750e211d57"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a23b2201c117393dd97c63e750e211d57">sym_start</a></td></tr>
+<tr class="separator:a23b2201c117393dd97c63e750e211d57"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa3855fbdf569667bde1830fe8033078a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#aa3855fbdf569667bde1830fe8033078a">sym_num</a></td></tr>
+<tr class="separator:aa3855fbdf569667bde1830fe8033078a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1e0c8aee4bb2520855c655fc3f5ddb3e"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a1e0c8aee4bb2520855c655fc3f5ddb3e">rb_start</a></td></tr>
+<tr class="separator:a1e0c8aee4bb2520855c655fc3f5ddb3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af7735abb4d0e98bff75f6ca302402fd1"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#af7735abb4d0e98bff75f6ca302402fd1">rb_num</a></td></tr>
+<tr class="separator:af7735abb4d0e98bff75f6ca302402fd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:abde12917f82ac21d3b35f788384b69d4"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#abde12917f82ac21d3b35f788384b69d4">iq_buff_offset</a></td></tr>
+<tr class="separator:abde12917f82ac21d3b35f788384b69d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4743b4bb624ddabc85672184430d9d70"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a4743b4bb624ddabc85672184430d9d70">iq_buff_len</a></td></tr>
+<tr class="separator:a4743b4bb624ddabc85672184430d9d70"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a599d618c91d4ce33661381801a7dca9a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a599d618c91d4ce33661381801a7dca9a">beam_id</a></td></tr>
+<tr class="separator:a599d618c91d4ce33661381801a7dca9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1520b1ef6131bff6c14b88d849c266c5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a1520b1ef6131bff6c14b88d849c266c5">iqWidth</a></td></tr>
+<tr class="separator:a1520b1ef6131bff6c14b88d849c266c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aba2cd161fa32b47ca78d0a2e4cf605c3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#aba2cd161fa32b47ca78d0a2e4cf605c3">comp_meth</a></td></tr>
+<tr class="separator:aba2cd161fa32b47ca78d0a2e4cf605c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0976e33e213bf38d277b829252a1ceaa"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a0976e33e213bf38d277b829252a1ceaa">pad0</a></td></tr>
+<tr class="separator:a0976e33e213bf38d277b829252a1ceaa"><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 of RB allocation from PHY to send data for allocated RBs only. </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00329">329</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="a599d618c91d4ce33661381801a7dca9a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a599d618c91d4ce33661381801a7dca9a">&#9670;&nbsp;</a></span>beam_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t beam_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Bean Index </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00341">341</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="aba2cd161fa32b47ca78d0a2e4cf605c3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aba2cd161fa32b47ca78d0a2e4cf605c3">&#9670;&nbsp;</a></span>comp_meth</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t comp_meth</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Compression method </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00343">343</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="acbe4924d3235876d0b54c3c9ef6f8149"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acbe4924d3235876d0b54c3c9ef6f8149">&#9670;&nbsp;</a></span>grp_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t grp_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>group id for this entry, reserved for future use </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00330">330</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a4743b4bb624ddabc85672184430d9d70"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4743b4bb624ddabc85672184430d9d70">&#9670;&nbsp;</a></span>iq_buff_len</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t iq_buff_len</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>length IQs </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00339">339</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="abde12917f82ac21d3b35f788384b69d4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#abde12917f82ac21d3b35f788384b69d4">&#9670;&nbsp;</a></span>iq_buff_offset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t iq_buff_offset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Offset within Sym for start of IQs </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00338">338</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a1520b1ef6131bff6c14b88d849c266c5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1520b1ef6131bff6c14b88d849c266c5">&#9670;&nbsp;</a></span>iqWidth</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t iqWidth</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>I and Q width in bits </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00342">342</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a0976e33e213bf38d277b829252a1ceaa"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0976e33e213bf38d277b829252a1ceaa">&#9670;&nbsp;</a></span>pad0</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t pad0</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00344">344</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="af7735abb4d0e98bff75f6ca302402fd1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af7735abb4d0e98bff75f6ca302402fd1">&#9670;&nbsp;</a></span>rb_num</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t rb_num</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Number of RBs </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00336">336</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a1e0c8aee4bb2520855c655fc3f5ddb3e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1e0c8aee4bb2520855c655fc3f5ddb3e">&#9670;&nbsp;</a></span>rb_start</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t rb_start</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Start RB position </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00335">335</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="aa3855fbdf569667bde1830fe8033078a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa3855fbdf569667bde1830fe8033078a">&#9670;&nbsp;</a></span>sym_num</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t sym_num</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Number of symbols </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00333">333</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a23b2201c117393dd97c63e750e211d57"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a23b2201c117393dd97c63e750e211d57">&#9670;&nbsp;</a></span>sym_start</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t sym_start</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Start symbol ID </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00332">332</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>