add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__io__cfg.html
diff --git a/docs/API/structxran__io__cfg.html b/docs/API/structxran__io__cfg.html
new file mode 100644 (file)
index 0000000..10a4609
--- /dev/null
@@ -0,0 +1,285 @@
+<!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_io_cfg 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_io_cfg 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_io_cfg:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__io__cfg__coll__graph.png" border="0" usemap="#xran__io__cfg_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:a1e6927fa1486224044e568f9c370519b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a1e6927fa1486224044e568f9c370519b">id</a></td></tr>
+<tr class="separator:a1e6927fa1486224044e568f9c370519b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae58734e2aff608373089778da1aa4efa"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#ae58734e2aff608373089778da1aa4efa">dpdk_dev</a> [<a class="el" href="xran__fh__o__du_8h.html#a185d8ae20c697568878935f0a260227aaacf0b73353fef317536c389fcccde6ac">XRAN_VF_MAX</a>]</td></tr>
+<tr class="separator:ae58734e2aff608373089778da1aa4efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a64ddf49fc9f31dbe434f9ee6b0a08db4"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a64ddf49fc9f31dbe434f9ee6b0a08db4">bbdev_dev</a> [1]</td></tr>
+<tr class="separator:a64ddf49fc9f31dbe434f9ee6b0a08db4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab99f9c6dba4d5fdc09299b3ac670503c"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#ab99f9c6dba4d5fdc09299b3ac670503c">bbdev_mode</a></td></tr>
+<tr class="separator:ab99f9c6dba4d5fdc09299b3ac670503c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a53341e81716fce9aeddee73d7228f2bf"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a53341e81716fce9aeddee73d7228f2bf">core</a></td></tr>
+<tr class="separator:a53341e81716fce9aeddee73d7228f2bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a727bdc89e33bfc7d18dfaf166d46598a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a727bdc89e33bfc7d18dfaf166d46598a">system_core</a></td></tr>
+<tr class="separator:a727bdc89e33bfc7d18dfaf166d46598a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7ea8f53112b353d5e98cc955437f3706"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a7ea8f53112b353d5e98cc955437f3706">pkt_proc_core</a></td></tr>
+<tr class="separator:a7ea8f53112b353d5e98cc955437f3706"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:afc9b03cdc767412993891263da114dc3"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#afc9b03cdc767412993891263da114dc3">pkt_aux_core</a></td></tr>
+<tr class="separator:afc9b03cdc767412993891263da114dc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa442a227739dcff5212e5356dee54b68"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#aa442a227739dcff5212e5356dee54b68">timing_core</a></td></tr>
+<tr class="separator:aa442a227739dcff5212e5356dee54b68"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab4a87dda9c9ac332a46e6a9b8a8b8315"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#ab4a87dda9c9ac332a46e6a9b8a8b8315">port</a> [<a class="el" href="xran__fh__o__du_8h.html#a185d8ae20c697568878935f0a260227aaacf0b73353fef317536c389fcccde6ac">XRAN_VF_MAX</a>]</td></tr>
+<tr class="separator:ab4a87dda9c9ac332a46e6a9b8a8b8315"><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>DPDK IO configuration for XRAN layer </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00294">294</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="a64ddf49fc9f31dbe434f9ee6b0a08db4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a64ddf49fc9f31dbe434f9ee6b0a08db4">&#9670;&nbsp;</a></span>bbdev_dev</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">char* bbdev_dev[1]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>BBDev dev name </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00297">297</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="ab99f9c6dba4d5fdc09299b3ac670503c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab99f9c6dba4d5fdc09299b3ac670503c">&#9670;&nbsp;</a></span>bbdev_mode</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t bbdev_mode</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>DPDK for BBDev </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00298">298</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="a53341e81716fce9aeddee73d7228f2bf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a53341e81716fce9aeddee73d7228f2bf">&#9670;&nbsp;</a></span>core</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t core</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>reservd </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00299">299</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="ae58734e2aff608373089778da1aa4efa"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae58734e2aff608373089778da1aa4efa">&#9670;&nbsp;</a></span>dpdk_dev</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">char* dpdk_dev[<a class="el" href="xran__fh__o__du_8h.html#a185d8ae20c697568878935f0a260227aaacf0b73353fef317536c389fcccde6ac">XRAN_VF_MAX</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>VFs devices </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00296">296</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="a1e6927fa1486224044e568f9c370519b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1e6927fa1486224044e568f9c370519b">&#9670;&nbsp;</a></span>id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>should be (0) for O-DU or (1) O-RU (debug) </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00295">295</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="afc9b03cdc767412993891263da114dc3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afc9b03cdc767412993891263da114dc3">&#9670;&nbsp;</a></span>pkt_aux_core</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t pkt_aux_core</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>reservd </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00302">302</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="a7ea8f53112b353d5e98cc955437f3706"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7ea8f53112b353d5e98cc955437f3706">&#9670;&nbsp;</a></span>pkt_proc_core</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t pkt_proc_core</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>reservd </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00301">301</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="ab4a87dda9c9ac332a46e6a9b8a8b8315"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab4a87dda9c9ac332a46e6a9b8a8b8315">&#9670;&nbsp;</a></span>port</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t port[<a class="el" href="xran__fh__o__du_8h.html#a185d8ae20c697568878935f0a260227aaacf0b73353fef317536c389fcccde6ac">XRAN_VF_MAX</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>VFs ports </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00304">304</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="a727bdc89e33bfc7d18dfaf166d46598a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a727bdc89e33bfc7d18dfaf166d46598a">&#9670;&nbsp;</a></span>system_core</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t system_core</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>reservd </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00300">300</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="aa442a227739dcff5212e5356dee54b68"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa442a227739dcff5212e5356dee54b68">&#9670;&nbsp;</a></span>timing_core</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t timing_core</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>core used by xRAN </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00303">303</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>