add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__ecpri__cmn__hdr.html
diff --git a/docs/API/structxran__ecpri__cmn__hdr.html b/docs/API/structxran__ecpri__cmn__hdr.html
new file mode 100644 (file)
index 0000000..d874435
--- /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_ecpri_cmn_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">xran_ecpri_cmn_hdr Struct Reference<div class="ingroups"><a class="el" href="group__xran__common__pkt.html">XRAN Packet definitions and functions</a></div></div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for xran_ecpri_cmn_hdr:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__ecpri__cmn__hdr__coll__graph.png" border="0" usemap="#xran__ecpri__cmn__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:a322d75c9ec1299251f0af915b2a1de75"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__cmn__hdr.html#a322d75c9ec1299251f0af915b2a1de75">ecpri_concat</a>:1</td></tr>
+<tr class="separator:a322d75c9ec1299251f0af915b2a1de75"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5dc01ebf378adefbe507b257d8e6c6d8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__cmn__hdr.html#a5dc01ebf378adefbe507b257d8e6c6d8">ecpri_resv</a>:3</td></tr>
+<tr class="separator:a5dc01ebf378adefbe507b257d8e6c6d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae951511bfaa494bee98d7fc69c0966f0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__cmn__hdr.html#ae951511bfaa494bee98d7fc69c0966f0">ecpri_ver</a>:4</td></tr>
+<tr class="separator:ae951511bfaa494bee98d7fc69c0966f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5b41115e5686e3ff4f14c356a3aa209a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__cmn__hdr.html#a5b41115e5686e3ff4f14c356a3aa209a">ecpri_mesg_type</a></td></tr>
+<tr class="separator:a5b41115e5686e3ff4f14c356a3aa209a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a61bf830b8866773b24cbca74ed3a4d6f"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__cmn__hdr.html#a61bf830b8866773b24cbca74ed3a4d6f">ecpri_payl_size</a></td></tr>
+<tr class="separator:a61bf830b8866773b24cbca74ed3a4d6f"><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 holds common eCPRI header as per Table 3 1 : eCPRI Transport Header Field Definitions </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00113">113</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a322d75c9ec1299251f0af915b2a1de75"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a322d75c9ec1299251f0af915b2a1de75">&#9670;&nbsp;</a></span>ecpri_concat</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t ecpri_concat</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>3.1.3.1.3 eCPRI concatenation indicator </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00115">115</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
+
+</div>
+</div>
+<a id="a5b41115e5686e3ff4f14c356a3aa209a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5b41115e5686e3ff4f14c356a3aa209a">&#9670;&nbsp;</a></span>ecpri_mesg_type</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t ecpri_mesg_type</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>3.1.3.1.4 eCPRI message type, defined in ecpri_msg_type </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00118">118</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
+
+</div>
+</div>
+<a id="a61bf830b8866773b24cbca74ed3a4d6f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a61bf830b8866773b24cbca74ed3a4d6f">&#9670;&nbsp;</a></span>ecpri_payl_size</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t ecpri_payl_size</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>3.1.3.1.5 eCPRI payload size, without common header and any padding bytes </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00119">119</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
+
+</div>
+</div>
+<a id="a5dc01ebf378adefbe507b257d8e6c6d8"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5dc01ebf378adefbe507b257d8e6c6d8">&#9670;&nbsp;</a></span>ecpri_resv</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t ecpri_resv</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>3.1.3.1.2 eCPRI reserved </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00116">116</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
+
+</div>
+</div>
+<a id="ae951511bfaa494bee98d7fc69c0966f0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae951511bfaa494bee98d7fc69c0966f0">&#9670;&nbsp;</a></span>ecpri_ver</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t ecpri_ver</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>3.1.3.1.1 eCPRI protocol revision, defined in XRAN_ECPRI_VER </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00117">117</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.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_8h_source.html">xran_pkt.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>