add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__section__desc.html
diff --git a/docs/API/structxran__section__desc.html b/docs/API/structxran__section__desc.html
new file mode 100644 (file)
index 0000000..53ee900
--- /dev/null
@@ -0,0 +1,190 @@
+<!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_section_desc 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_section_desc 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_section_desc:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__section__desc__coll__graph.png" border="0" usemap="#xran__section__desc_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:aa82fd2a2292b3c25c7027b898fa53815"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#aa82fd2a2292b3c25c7027b898fa53815">section_id</a></td></tr>
+<tr class="separator:aa82fd2a2292b3c25c7027b898fa53815"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4d1fb35f3f2d9f3556fbd1761a167255"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#a4d1fb35f3f2d9f3556fbd1761a167255">iq_buffer_offset</a></td></tr>
+<tr class="separator:a4d1fb35f3f2d9f3556fbd1761a167255"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae55ac9499e5406559ad2ff0376dd0a68"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#ae55ac9499e5406559ad2ff0376dd0a68">iq_buffer_len</a></td></tr>
+<tr class="separator:ae55ac9499e5406559ad2ff0376dd0a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a77f0d5374ee675db57c0b29946ca7744"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#a77f0d5374ee675db57c0b29946ca7744">pData</a></td></tr>
+<tr class="separator:a77f0d5374ee675db57c0b29946ca7744"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:addb9297d816b26c680888115de8c9538"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#addb9297d816b26c680888115de8c9538">pCtrl</a></td></tr>
+<tr class="separator:addb9297d816b26c680888115de8c9538"><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>section descriptor for given number of PRBs used on U-plane packet creation </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00382">382</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="ae55ac9499e5406559ad2ff0376dd0a68"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae55ac9499e5406559ad2ff0376dd0a68">&#9670;&nbsp;</a></span>iq_buffer_len</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t iq_buffer_len</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Length in bytes for the content of IQs with in main symb buffer </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00386">386</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="a4d1fb35f3f2d9f3556fbd1761a167255"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4d1fb35f3f2d9f3556fbd1761a167255">&#9670;&nbsp;</a></span>iq_buffer_offset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int16_t iq_buffer_offset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Offset in bytes for the content of IQs with in main symb buffer </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00385">385</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="addb9297d816b26c680888115de8c9538"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#addb9297d816b26c680888115de8c9538">&#9670;&nbsp;</a></span>pCtrl</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void* pCtrl</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>optional poitner to mbuf </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00389">389</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="a77f0d5374ee675db57c0b29946ca7744"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a77f0d5374ee675db57c0b29946ca7744">&#9670;&nbsp;</a></span>pData</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t* pData</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>optional pointer to data buffer </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00388">388</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="aa82fd2a2292b3c25c7027b898fa53815"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa82fd2a2292b3c25c7027b898fa53815">&#9670;&nbsp;</a></span>section_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t section_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>section id used for this element </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00383">383</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>