add Doxygen documentation
[o-du/phy.git] / docs / API / dir_7b477aa413287cfa2199e983b77d66dd.html
diff --git a/docs/API/dir_7b477aa413287cfa2199e983b77d66dd.html b/docs/API/dir_7b477aa413287cfa2199e983b77d66dd.html
new file mode 100644 (file)
index 0000000..6863620
--- /dev/null
@@ -0,0 +1,116 @@
+<!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: api Directory 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 id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="dir_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_5cc0cc0264b57168b75ca56bde6cc403.html">lib</a></li><li class="navelem"><a class="el" href="dir_7b477aa413287cfa2199e983b77d66dd.html">api</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="headertitle">
+<div class="title">api Directory Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
+Files</h2></td></tr>
+<tr class="memitem:xran__compression_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__compression_8h.html">xran_compression.h</a> <a href="xran__compression_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__compression_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">External API for compading with the use BFP algorithm. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__compression_8hpp"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__compression_8hpp.html">xran_compression.hpp</a> <a href="xran__compression_8hpp_source.html">[code]</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__cp__api_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__cp__api_8h.html">xran_cp_api.h</a> <a href="xran__cp__api_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__cp__api_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file provides the definitions for Control Plane Messages APIs. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__fh__o__du_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__fh__o__du_8h.html">xran_fh_o_du.h</a> <a href="xran__fh__o__du_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__fh__o__du_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN-WG4.CUS.0-v01.00 spec. Implementation specific to Lower Layer Split Central Unit (O-DU): a logical node that includes the eNB/gNB functions as listed in section 2.1 split option 7-2x, excepting those functions allocated exclusively to the O-RU. The O-DU controls the operation of O-RUs for 5G NR Radio Access technology. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__mlog__lnx_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__mlog__lnx_8h.html">xran_mlog_lnx.h</a> <a href="xran__mlog__lnx_8h_source.html">[code]</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__pkt_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt_8h.html">xran_pkt.h</a> <a href="xran__pkt_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__pkt_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Definitions and support functions to process XRAN packet. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__pkt__cp_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt__cp_8h.html">xran_pkt_cp.h</a> <a href="xran__pkt__cp_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__pkt__cp_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file provides the definition of Control Plane Messages for XRAN Front Haul layer as defined in XRAN-FH.CUS.0-v02.01. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__pkt__up_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt__up_8h.html">xran_pkt_up.h</a> <a href="xran__pkt__up_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__pkt__up_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Definitions and support functions to process XRAN packet. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__sync__api_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__sync__api_8h.html">xran_sync_api.h</a> <a href="xran__sync__api_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__sync__api_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file provides interface to synchronization related APIs (PTP/1588) for XRAN. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__timer_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__timer_8h.html">xran_timer.h</a> <a href="xran__timer_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__timer_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file provides interface to Timing for XRAN. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__transport_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__transport_8h.html">xran_transport.h</a> <a href="xran__transport_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__transport_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file provides the definitions for Transport layer (eCPRI) API. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:xran__up__api_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__up__api_8h.html">xran_up_api.h</a> <a href="xran__up__api_8h_source.html">[code]</a></td></tr>
+<tr class="memdesc:xran__up__api_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file provides the definitions for User Plane Messages APIs. <br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+</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>