add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__eaxcid__config.html
diff --git a/docs/API/structxran__eaxcid__config.html b/docs/API/structxran__eaxcid__config.html
new file mode 100644 (file)
index 0000000..545bbeb
--- /dev/null
@@ -0,0 +1,247 @@
+<!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_eaxcid_config 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_eaxcid_config 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_eaxcid_config:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__eaxcid__config__coll__graph.png" border="0" usemap="#xran__eaxcid__config_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:a3357253b181bed8132156f87728efc8d"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__eaxcid__config.html#a3357253b181bed8132156f87728efc8d">mask_cuPortId</a></td></tr>
+<tr class="separator:a3357253b181bed8132156f87728efc8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:affca087d8bc179073b5ae2f429340898"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__eaxcid__config.html#affca087d8bc179073b5ae2f429340898">mask_bandSectorId</a></td></tr>
+<tr class="separator:affca087d8bc179073b5ae2f429340898"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0ba87d865af2deb1ee2565f528e1e72d"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__eaxcid__config.html#a0ba87d865af2deb1ee2565f528e1e72d">mask_ccId</a></td></tr>
+<tr class="separator:a0ba87d865af2deb1ee2565f528e1e72d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a64cc7d4da64fe531f01c6bb54e6a02f3"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__eaxcid__config.html#a64cc7d4da64fe531f01c6bb54e6a02f3">mask_ruPortId</a></td></tr>
+<tr class="separator:a64cc7d4da64fe531f01c6bb54e6a02f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8812802228fbd32d92c2c8f29963628b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__eaxcid__config.html#a8812802228fbd32d92c2c8f29963628b">bit_cuPortId</a></td></tr>
+<tr class="separator:a8812802228fbd32d92c2c8f29963628b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab3f5b7b7c113a7fdff4bdf31ff685594"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__eaxcid__config.html#ab3f5b7b7c113a7fdff4bdf31ff685594">bit_bandSectorId</a></td></tr>
+<tr class="separator:ab3f5b7b7c113a7fdff4bdf31ff685594"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a292acf2be52d7b22753f8f3a9839f455"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__eaxcid__config.html#a292acf2be52d7b22753f8f3a9839f455">bit_ccId</a></td></tr>
+<tr class="separator:a292acf2be52d7b22753f8f3a9839f455"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa6294a3b04f47cabf866ec1e1ec4bd23"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__eaxcid__config.html#aa6294a3b04f47cabf866ec1e1ec4bd23">bit_ruPortId</a></td></tr>
+<tr class="separator:aa6294a3b04f47cabf866ec1e1ec4bd23"><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>XRAN spec section 3.1.3.1.6 ecpriRtcid / ecpriPcid define </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00308">308</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="ab3f5b7b7c113a7fdff4bdf31ff685594"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab3f5b7b7c113a7fdff4bdf31ff685594">&#9670;&nbsp;</a></span>bit_bandSectorId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t bit_bandSectorId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>ccId + ruPortId </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00315">315</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="a292acf2be52d7b22753f8f3a9839f455"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a292acf2be52d7b22753f8f3a9839f455">&#9670;&nbsp;</a></span>bit_ccId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t bit_ccId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>ruportId </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00316">316</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="a8812802228fbd32d92c2c8f29963628b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8812802228fbd32d92c2c8f29963628b">&#9670;&nbsp;</a></span>bit_cuPortId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t bit_cuPortId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>bandsectorId + ccId + ruportId </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00314">314</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="aa6294a3b04f47cabf866ec1e1ec4bd23"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa6294a3b04f47cabf866ec1e1ec4bd23">&#9670;&nbsp;</a></span>bit_ruPortId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t bit_ruPortId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>0 </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00317">317</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="affca087d8bc179073b5ae2f429340898"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#affca087d8bc179073b5ae2f429340898">&#9670;&nbsp;</a></span>mask_bandSectorId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t mask_bandSectorId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Mask Band </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00310">310</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="a0ba87d865af2deb1ee2565f528e1e72d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0ba87d865af2deb1ee2565f528e1e72d">&#9670;&nbsp;</a></span>mask_ccId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t mask_ccId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Mask CC </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00311">311</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="a3357253b181bed8132156f87728efc8d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3357253b181bed8132156f87728efc8d">&#9670;&nbsp;</a></span>mask_cuPortId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t mask_cuPortId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Mask CU PortId </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00309">309</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="a64cc7d4da64fe531f01c6bb54e6a02f3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a64cc7d4da64fe531f01c6bb54e6a02f3">&#9670;&nbsp;</a></span>mask_ruPortId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t mask_ruPortId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Mask RU Port ID </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00312">312</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>