add Doxygen documentation
[o-du/phy.git] / docs / API / structdata__section__hdr.html
diff --git a/docs/API/structdata__section__hdr.html b/docs/API/structdata__section__hdr.html
new file mode 100644 (file)
index 0000000..0da064e
--- /dev/null
@@ -0,0 +1,228 @@
+<!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: data_section_hdr 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">data_section_hdr Struct Reference<div class="ingroups"><a class="el" href="group__xran__up__pkt.html">U-Plane XRAN Packet definitions and functions</a></div></div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for data_section_hdr:</div>
+<div class="dyncontent">
+<div class="center"><img src="structdata__section__hdr__coll__graph.png" border="0" usemap="#data__section__hdr_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:a9f1bf385f4549249e191e6563acbdecb"><td class="memItemLeft" >union {</td></tr>
+<tr class="memitem:a9f9f2f87d8b5cc7e4af6ef3e2c4c8189"><td class="memItemLeft" >&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#a9f9f2f87d8b5cc7e4af6ef3e2c4c8189">all_bits</a></td></tr>
+<tr class="separator:a9f9f2f87d8b5cc7e4af6ef3e2c4c8189"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0e0aaa059da6f49839fa06bd19c63c8f"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
+<tr class="memitem:acb00c5e7ebe809fda7288c699eed867c"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#acb00c5e7ebe809fda7288c699eed867c">num_prbu</a>:8</td></tr>
+<tr class="separator:acb00c5e7ebe809fda7288c699eed867c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a486aca552c11b7046ca3066ebf4241dc"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#a486aca552c11b7046ca3066ebf4241dc">start_prbu</a>:10</td></tr>
+<tr class="separator:a486aca552c11b7046ca3066ebf4241dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aba23e80ad7dc1c3f7085ba3a2b4662bb"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#aba23e80ad7dc1c3f7085ba3a2b4662bb">sym_inc</a>:1</td></tr>
+<tr class="separator:aba23e80ad7dc1c3f7085ba3a2b4662bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac91b2b11ae96c1a44e8a2fad473771c7"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#ac91b2b11ae96c1a44e8a2fad473771c7">rb</a>:1</td></tr>
+<tr class="separator:ac91b2b11ae96c1a44e8a2fad473771c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a11d1616fb975ccafbc33ab590fe501c4"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#a11d1616fb975ccafbc33ab590fe501c4">sect_id</a>:12</td></tr>
+<tr class="separator:a11d1616fb975ccafbc33ab590fe501c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0e0aaa059da6f49839fa06bd19c63c8f"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
+<tr class="separator:a0e0aaa059da6f49839fa06bd19c63c8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9f1bf385f4549249e191e6563acbdecb"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__section__hdr.html#a9f1bf385f4549249e191e6563acbdecb">fields</a></td></tr>
+<tr class="separator:a9f1bf385f4549249e191e6563acbdecb"><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>Structure holding data section header fields It is repeated for every section ID in xRAN packet 5.4.5 Coding of Information Elements - Application Layer, Sections for U-plane as per 6.3.2 DL/UL Data </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00067">67</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a9f9f2f87d8b5cc7e4af6ef3e2c4c8189"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9f9f2f87d8b5cc7e4af6ef3e2c4c8189">&#9670;&nbsp;</a></span>all_bits</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t all_bits</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00069">69</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
+
+</div>
+</div>
+<a id="a9f1bf385f4549249e191e6563acbdecb"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9f1bf385f4549249e191e6563acbdecb">&#9670;&nbsp;</a></span>fields</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">union { ... }  fields</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="acb00c5e7ebe809fda7288c699eed867c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acb00c5e7ebe809fda7288c699eed867c">&#9670;&nbsp;</a></span>num_prbu</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t num_prbu</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>5.4.5.6 number of contiguous PRBs per control section </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00071">71</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
+
+</div>
+</div>
+<a id="ac91b2b11ae96c1a44e8a2fad473771c7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac91b2b11ae96c1a44e8a2fad473771c7">&#9670;&nbsp;</a></span>rb</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t rb</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>5.4.5.2 resource block indicator, XRAN_RBIND_xxx </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00074">74</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
+
+</div>
+</div>
+<a id="a11d1616fb975ccafbc33ab590fe501c4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a11d1616fb975ccafbc33ab590fe501c4">&#9670;&nbsp;</a></span>sect_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t sect_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>5.4.5.1 section identifier </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00075">75</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
+
+</div>
+</div>
+<a id="a486aca552c11b7046ca3066ebf4241dc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a486aca552c11b7046ca3066ebf4241dc">&#9670;&nbsp;</a></span>start_prbu</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t start_prbu</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>5.4.5.4 starting PRB of control section </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00072">72</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
+
+</div>
+</div>
+<a id="aba23e80ad7dc1c3f7085ba3a2b4662bb"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aba23e80ad7dc1c3f7085ba3a2b4662bb">&#9670;&nbsp;</a></span>sym_inc</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint32_t sym_inc</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>5.4.5.3 symbol number increment command XRAN_SYMBOLNUMBER_xxxx </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00073">73</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.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>