add Doxygen documentation
[o-du/phy.git] / docs / API / dir_7b477aa413287cfa2199e983b77d66dd.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>o-du/phy: api Directory Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21  <tbody>
22  <tr style="height: 56px;">
23   <td id="projectalign" style="padding-left: 0.5em;">
24    <div id="projectname">o-du/phy
25    </div>
26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
27   </td>
28  </tr>
29  </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.13 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
36 </script>
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41   initMenu('',true,false,'search.php','Search');
42   $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48      onmouseover="return searchBox.OnSearchSelectShow()"
49      onmouseout="return searchBox.OnSearchSelectHide()"
50      onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
52
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0" 
56         name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
59
60 <div id="nav-path" class="navpath">
61   <ul>
62 <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>
63 </div>
64 </div><!-- top -->
65 <div class="header">
66   <div class="headertitle">
67 <div class="title">api Directory Reference</div>  </div>
68 </div><!--header-->
69 <div class="contents">
70 <table class="memberdecls">
71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
72 Files</h2></td></tr>
73 <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>
74 <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>
75 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <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>
77 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 <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>
79 <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>
80 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
81 <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>
82 <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>
83 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <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>
85 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <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>
87 <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>
88 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <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>
90 <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>
91 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <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>
93 <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>
94 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <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>
96 <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>
97 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <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>
99 <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>
100 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <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>
102 <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>
103 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <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>
105 <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>
106 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 </table>
108 </div><!-- contents -->
109 <!-- start footer part -->
110 <hr class="footer"/><address class="footer"><small>
111 Generated by &#160;<a href="http://www.doxygen.org/index.html">
112 <img class="footer" src="doxygen.png" alt="doxygen"/>
113 </a> 1.8.13
114 </small></address>
115 </body>
116 </html>