docs/API/files.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: File List</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 </div><!-- top -->
  47 <!-- window showing the filter options -->
  48 <div id="MSearchSelectWindow"
  49      onmouseover="return searchBox.OnSearchSelectShow()"
  50      onmouseout="return searchBox.OnSearchSelectHide()"
  51      onkeydown="return searchBox.OnSearchSelectKey(event)">
  52 </div>
  53
  54 <!-- iframe showing the search results (closed by default) -->
  55 <div id="MSearchResultsWindow">
  56 <iframe src="javascript:void(0)" frameborder="0"
  57         name="MSearchResults" id="MSearchResults">
  58 </iframe>
  59 </div>
  60
  61 <div class="header">
  62   <div class="headertitle">
  63 <div class="title">File List</div>  </div>
  64 </div><!--header-->
  65 <div class="contents">
  66 <div class="textblock">Here is a list of all files with brief descriptions:</div><div class="directory">
  67 <table class="directory">
  68 <tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="c__plane__tests_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="c__plane__tests_8cc.html" target="_self">c_plane_tests.cc</a></td><td class="desc"></td></tr>
  69 <tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="chain__tests_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="chain__tests_8cc.html" target="_self">chain_tests.cc</a></td><td class="desc"></td></tr>
  70 <tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="common_8c_source.html"><span class="icondoc"></span></a><a class="el" href="common_8c.html" target="_self">common.c</a></td><td class="desc"></td></tr>
  71 <tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="common_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="common_8cpp.html" target="_self">common.cpp</a></td><td class="desc"></td></tr>
  72 <tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="common_8h_source.html"><span class="icondoc"></span></a><a class="el" href="common_8h.html" target="_self">common.h</a></td><td class="desc"></td></tr>
  73 <tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="common_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="common_8hpp.html" target="_self">common.hpp</a></td><td class="desc"></td></tr>
  74 <tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="common__typedef__xran_8h_source.html"><span class="icondoc"></span></a><a class="el" href="common__typedef__xran_8h.html" target="_self">common_typedef_xran.h</a></td><td class="desc">This header file defines those data type both used by eNB and UE </td></tr>
  75 <tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="compander__functional_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="compander__functional_8cc.html" target="_self">compander_functional.cc</a></td><td class="desc"></td></tr>
  76 <tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="config_8c_source.html"><span class="icondoc"></span></a><a class="el" href="config_8c.html" target="_self">config.c</a></td><td class="desc"></td></tr>
  77 <tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="config_8h_source.html"><span class="icondoc"></span></a><a class="el" href="config_8h.html" target="_self">config.h</a></td><td class="desc"></td></tr>
  78 <tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="debug_8h_source.html"><span class="icondoc"></span></a><a class="el" href="debug_8h.html" target="_self">debug.h</a></td><td class="desc"></td></tr>
  79 <tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="ethdi_8c_source.html"><span class="icondoc"></span></a><a class="el" href="ethdi_8c.html" target="_self">ethdi.c</a></td><td class="desc">This file has all definitions for the Ethernet Data Interface Layer </td></tr>
  80 <tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="ethdi_8h_source.html"><span class="icondoc"></span></a><a class="el" href="ethdi_8h.html" target="_self">ethdi.h</a></td><td class="desc">This file has all definitions for the Ethernet Data Interface Layer </td></tr>
  81 <tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="ethernet_8c_source.html"><span class="icondoc"></span></a><a class="el" href="ethernet_8c.html" target="_self">ethernet.c</a></td><td class="desc">This file has all definitions for the Ethernet Data Interface Layer </td></tr>
  82 <tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="ethernet_8h_source.html"><span class="icondoc"></span></a><a class="el" href="ethernet_8h.html" target="_self">ethernet.h</a></td><td class="desc">This file has all definitions for the Ethernet Data Interface Layer </td></tr>
  83 <tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="gen__test_8m_source.html"><span class="icondoc"></span></a><a class="el" href="gen__test_8m.html" target="_self">gen_test.m</a></td><td class="desc"></td></tr>
  84 <tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="init__sys__functional_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="init__sys__functional_8cc.html" target="_self">init_sys_functional.cc</a></td><td class="desc"></td></tr>
  85 <tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="json_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="json_8hpp.html" target="_self">json.hpp</a></td><td class="desc"></td></tr>
  86 <tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="master_8py_source.html"><span class="icondoc"></span></a><a class="el" href="master_8py.html" target="_self">master.py</a></td><td class="desc"></td></tr>
  87 <tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="prach__functional_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="prach__functional_8cc.html" target="_self">prach_functional.cc</a></td><td class="desc"></td></tr>
  88 <tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="prach__performance_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="prach__performance_8cc.html" target="_self">prach_performance.cc</a></td><td class="desc"></td></tr>
  89 <tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="sample-app_8c_source.html"><span class="icondoc"></span></a><a class="el" href="sample-app_8c.html" target="_self">sample-app.c</a></td><td class="desc"></td></tr>
  90 <tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="u__plane__functional_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="u__plane__functional_8cc.html" target="_self">u_plane_functional.cc</a></td><td class="desc"></td></tr>
  91 <tr id="row_23_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="u__plane__performance_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="u__plane__performance_8cc.html" target="_self">u_plane_performance.cc</a></td><td class="desc"></td></tr>
  92 <tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="unittests_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="unittests_8cc.html" target="_self">unittests.cc</a></td><td class="desc"></td></tr>
  93 <tr id="row_25_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__app__frag_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__app__frag_8c.html" target="_self">xran_app_frag.c</a></td><td class="desc">XRAN application frgamentation for U-plane packets </td></tr>
  94 <tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__app__frag_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__app__frag_8h.html" target="_self">xran_app_frag.h</a></td><td class="desc">Header file for functions to perform application level fragmentation </td></tr>
  95 <tr id="row_27_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__common_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__common_8c.html" target="_self">xran_common.c</a></td><td class="desc">XRAN layer common functionality for both O-DU and O-RU as well as C-plane and U-plane </td></tr>
  96 <tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__common_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__common_8h.html" target="_self">xran_common.h</a></td><td class="desc">XRAN layer common functionality for both lls-CU and RU as well as C-plane and U-plane </td></tr>
  97 <tr id="row_29_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__compression_8cpp_source.html"><span class="icondoc"></span></a><a class="el" href="xran__compression_8cpp.html" target="_self">xran_compression.cpp</a></td><td class="desc"></td></tr>
  98 <tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__compression_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__compression_8h.html" target="_self">xran_compression.h</a></td><td class="desc">External API for compading with the use BFP algorithm </td></tr>
  99 <tr id="row_31_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__compression_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="xran__compression_8hpp.html" target="_self">xran_compression.hpp</a></td><td class="desc"></td></tr>
 100 <tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__cp__api_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__cp__api_8c.html" target="_self">xran_cp_api.c</a></td><td class="desc">This file provides the API functions to build Control Plane Messages for XRAN Front Haul layer as defined in XRAN-FH.CUS.0-v02.01 </td></tr>
 101 <tr id="row_33_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__cp__api_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__cp__api_8h.html" target="_self">xran_cp_api.h</a></td><td class="desc">This file provides the definitions for Control Plane Messages APIs </td></tr>
 102 <tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__fh__o__du_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__fh__o__du_8h.html" target="_self">xran_fh_o_du.h</a></td><td class="desc">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 </td></tr>
 103 <tr id="row_35_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__frame__struct_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__frame__struct_8c.html" target="_self">xran_frame_struct.c</a></td><td class="desc"></td></tr>
 104 <tr id="row_36_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__frame__struct_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__frame__struct_8h.html" target="_self">xran_frame_struct.h</a></td><td class="desc">Header file for function to work with 5G NR frame structure and related routines </td></tr>
 105 <tr id="row_37_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__lib__mlog__tasks__id_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__lib__mlog__tasks__id_8h.html" target="_self">xran_lib_mlog_tasks_id.h</a></td><td class="desc"></td></tr>
 106 <tr id="row_38_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__lib__wrap_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="xran__lib__wrap_8hpp.html" target="_self">xran_lib_wrap.hpp</a></td><td class="desc"></td></tr>
 107 <tr id="row_39_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__main_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__main_8c.html" target="_self">xran_main.c</a></td><td class="desc">XRAN main functionality module </td></tr>
 108 <tr id="row_40_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__mlog__lnx_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__mlog__lnx_8h.html" target="_self">xran_mlog_lnx.h</a></td><td class="desc"></td></tr>
 109 <tr id="row_41_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__mlog__task__id_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__mlog__task__id_8h.html" target="_self">xran_mlog_task_id.h</a></td><td class="desc"></td></tr>
 110 <tr id="row_42_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__pkt_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__pkt_8h.html" target="_self">xran_pkt.h</a></td><td class="desc">Definitions and support functions to process XRAN packet </td></tr>
 111 <tr id="row_43_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__pkt__cp_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__pkt__cp_8h.html" target="_self">xran_pkt_cp.h</a></td><td class="desc">This file provides the definition of Control Plane Messages for XRAN Front Haul layer as defined in XRAN-FH.CUS.0-v02.01 </td></tr>
 112 <tr id="row_44_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__pkt__up_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__pkt__up_8h.html" target="_self">xran_pkt_up.h</a></td><td class="desc">Definitions and support functions to process XRAN packet </td></tr>
 113 <tr id="row_45_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__printf_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__printf_8h.html" target="_self">xran_printf.h</a></td><td class="desc">Modules provide debug prints and utility functions </td></tr>
 114 <tr id="row_46_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__sync__api_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__sync__api_8c.html" target="_self">xran_sync_api.c</a></td><td class="desc">This file provides implementation of synchronization related APIs (PTP/1588) for XRAN </td></tr>
 115 <tr id="row_47_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__sync__api_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__sync__api_8h.html" target="_self">xran_sync_api.h</a></td><td class="desc">This file provides interface to synchronization related APIs (PTP/1588) for XRAN </td></tr>
 116 <tr id="row_48_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__timer_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__timer_8c.html" target="_self">xran_timer.c</a></td><td class="desc">This file provides implementation to Timing for XRAN </td></tr>
 117 <tr id="row_49_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__timer_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__timer_8h.html" target="_self">xran_timer.h</a></td><td class="desc">This file provides interface to Timing for XRAN </td></tr>
 118 <tr id="row_50_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__transport_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__transport_8c.html" target="_self">xran_transport.c</a></td><td class="desc">This file provides the implementation for Transport lyaer (eCPRI) API </td></tr>
 119 <tr id="row_51_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__transport_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__transport_8h.html" target="_self">xran_transport.h</a></td><td class="desc">This file provides the definitions for Transport layer (eCPRI) API </td></tr>
 120 <tr id="row_52_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__ul__tables_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__ul__tables_8c.html" target="_self">xran_ul_tables.c</a></td><td class="desc">This file defines those table used in 5G NR spec </td></tr>
 121 <tr id="row_53_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__up__api_8c_source.html"><span class="icondoc"></span></a><a class="el" href="xran__up__api_8c.html" target="_self">xran_up_api.c</a></td><td class="desc">This file provides the implementation of User Plane Messages APIs </td></tr>
 122 <tr id="row_54_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xran__up__api_8h_source.html"><span class="icondoc"></span></a><a class="el" href="xran__up__api_8h.html" target="_self">xran_up_api.h</a></td><td class="desc">This file provides the definitions for User Plane Messages APIs </td></tr>
 123 <tr id="row_55_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><a href="xranlib__unit__test__main_8cc_source.html"><span class="icondoc"></span></a><a class="el" href="xranlib__unit__test__main_8cc.html" target="_self">xranlib_unit_test_main.cc</a></td><td class="desc"></td></tr>
 124 </table>
 125 </div><!-- directory -->
 126 </div><!-- contents -->
 127 <!-- start footer part -->
 128 <hr class="footer"/><address class="footer"><small>
 129 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 130 <img class="footer" src="doxygen.png" alt="doxygen"/>
 131 </a> 1.8.13
 132 </small></address>
 133 </body>
 134 </html>