add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__sectionext1__info.html
diff --git a/docs/API/structxran__sectionext1__info.html b/docs/API/structxran__sectionext1__info.html
new file mode 100644 (file)
index 0000000..c461e1f
--- /dev/null
@@ -0,0 +1,295 @@
+<!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_sectionext1_info 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_sectionext1_info 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_sectionext1_info:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__sectionext1__info__coll__graph.png" border="0" usemap="#xran__sectionext1__info_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:ad07777df733bfd87b118b5ea683fcb3b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#ad07777df733bfd87b118b5ea683fcb3b">rbNumber</a></td></tr>
+<tr class="separator:ad07777df733bfd87b118b5ea683fcb3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab09d1df0b229edfd34c41706fcfa73e7"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#ab09d1df0b229edfd34c41706fcfa73e7">bfwNumber</a></td></tr>
+<tr class="separator:ab09d1df0b229edfd34c41706fcfa73e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3de53935627d11e11003c38bd6dca548"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#a3de53935627d11e11003c38bd6dca548">bfwiqWidth</a></td></tr>
+<tr class="separator:a3de53935627d11e11003c38bd6dca548"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a489f0b868b86e577a5e515dc40987ba5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#a489f0b868b86e577a5e515dc40987ba5">bfwCompMeth</a></td></tr>
+<tr class="separator:a489f0b868b86e577a5e515dc40987ba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a535b83a8653a891f80fc204eb1d9cb8b"><td class="memItemLeft" align="right" valign="top">int16_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#a535b83a8653a891f80fc204eb1d9cb8b">p_bfwIQ</a></td></tr>
+<tr class="separator:a535b83a8653a891f80fc204eb1d9cb8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae4f265cd1e2941e2d7366085f6f0b598"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#ae4f265cd1e2941e2d7366085f6f0b598">bfwIQ_sz</a></td></tr>
+<tr class="separator:ae4f265cd1e2941e2d7366085f6f0b598"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae3551ba3eeae98639805a8d3391d5b3d"><td class="memItemLeft" >union {</td></tr>
+<tr class="memitem:af05d5abe7656953548edfb3eb5117659"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structxran__sectionext1__info.html#af05d5abe7656953548edfb3eb5117659">exponent</a></td></tr>
+<tr class="separator:af05d5abe7656953548edfb3eb5117659"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad32c6c9662025c7208ec099075b7ec27"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structxran__sectionext1__info.html#ad32c6c9662025c7208ec099075b7ec27">blockScaler</a></td></tr>
+<tr class="separator:ad32c6c9662025c7208ec099075b7ec27"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac538592c50bd54df6d3c3dfb98fd1a96"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structxran__sectionext1__info.html#ac538592c50bd54df6d3c3dfb98fd1a96">compBitWidthShift</a></td></tr>
+<tr class="separator:ac538592c50bd54df6d3c3dfb98fd1a96"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:abeddf07371133e2a155418d2ad6e6606"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structxran__sectionext1__info.html#abeddf07371133e2a155418d2ad6e6606">activeBeamspaceCoeffMask</a> [<a class="el" href="xran__cp__api_8h.html#acf59e7a9af32c6c8c8dd3d7b1e6ee0ca">XRAN_MAX_BFW_N</a>]</td></tr>
+<tr class="separator:abeddf07371133e2a155418d2ad6e6606"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae3551ba3eeae98639805a8d3391d5b3d"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#ae3551ba3eeae98639805a8d3391d5b3d">bfwCompParam</a></td></tr>
+<tr class="separator:ae3551ba3eeae98639805a8d3391d5b3d"><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__cp__api_8h_source.html#l00209">209</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="abeddf07371133e2a155418d2ad6e6606"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#abeddf07371133e2a155418d2ad6e6606">&#9670;&nbsp;</a></span>activeBeamspaceCoeffMask</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t activeBeamspaceCoeffMask[<a class="el" href="xran__cp__api_8h.html#acf59e7a9af32c6c8c8dd3d7b1e6ee0ca">XRAN_MAX_BFW_N</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00220">220</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a489f0b868b86e577a5e515dc40987ba5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a489f0b868b86e577a5e515dc40987ba5">&#9670;&nbsp;</a></span>bfwCompMeth</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t bfwCompMeth</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00213">213</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ae3551ba3eeae98639805a8d3391d5b3d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae3551ba3eeae98639805a8d3391d5b3d">&#9670;&nbsp;</a></span>bfwCompParam</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">union { ... }   bfwCompParam</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="ae4f265cd1e2941e2d7366085f6f0b598"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae4f265cd1e2941e2d7366085f6f0b598">&#9670;&nbsp;</a></span>bfwIQ_sz</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t bfwIQ_sz</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>size of buffer with section extention information </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00215">215</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a3de53935627d11e11003c38bd6dca548"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3de53935627d11e11003c38bd6dca548">&#9670;&nbsp;</a></span>bfwiqWidth</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t bfwiqWidth</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00212">212</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ab09d1df0b229edfd34c41706fcfa73e7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab09d1df0b229edfd34c41706fcfa73e7">&#9670;&nbsp;</a></span>bfwNumber</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t bfwNumber</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>number of bf weights in this section </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00211">211</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ad32c6c9662025c7208ec099075b7ec27"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad32c6c9662025c7208ec099075b7ec27">&#9670;&nbsp;</a></span>blockScaler</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t blockScaler</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00218">218</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ac538592c50bd54df6d3c3dfb98fd1a96"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac538592c50bd54df6d3c3dfb98fd1a96">&#9670;&nbsp;</a></span>compBitWidthShift</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t compBitWidthShift</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00219">219</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="af05d5abe7656953548edfb3eb5117659"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af05d5abe7656953548edfb3eb5117659">&#9670;&nbsp;</a></span>exponent</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t exponent</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00217">217</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a535b83a8653a891f80fc204eb1d9cb8b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a535b83a8653a891f80fc204eb1d9cb8b">&#9670;&nbsp;</a></span>p_bfwIQ</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t* p_bfwIQ</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>pointer to formed section extention </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00214">214</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ad07777df733bfd87b118b5ea683fcb3b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad07777df733bfd87b118b5ea683fcb3b">&#9670;&nbsp;</a></span>rbNumber</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t rbNumber</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>number RBs to ext1 chain </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00210">210</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>