add Doxygen documentation
[o-du/phy.git] / docs / API / globals_r.html
diff --git a/docs/API/globals_r.html b/docs/API/globals_r.html
new file mode 100644 (file)
index 0000000..b3fbfcb
--- /dev/null
@@ -0,0 +1,253 @@
+<!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: Globals</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>
+</div><!-- top -->
+<!-- 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 class="contents">
+<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div>
+
+<h3><a id="index_r"></a>- r -</h3><ul>
+<li>rb
+: <a class="el" href="xran__pkt__cp_8h.html#affa3adbd50cd4af2018ba1fc0e8c3e31">xran_pkt_cp.h</a>
+</li>
+<li>RB_NUM_ROUNDUP
+: <a class="el" href="xran__compression_8cpp.html#a8e2efc093002a3f4ed586a274dac0814">xran_compression.cpp</a>
+</li>
+<li>read_data_to_aligned_array()
+: <a class="el" href="common_8hpp.html#a876ed07783b27d38779f7cef4db673e6">common.hpp</a>
+, <a class="el" href="common_8cpp.html#a876ed07783b27d38779f7cef4db673e6">common.cpp</a>
+</li>
+<li>read_head
+: <a class="el" href="ethernet_8c.html#a33dbe0774fc577b56bd532cf3736106e">ethernet.c</a>
+</li>
+<li>read_json_from_file()
+: <a class="el" href="common_8cpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428">common.cpp</a>
+, <a class="el" href="common_8hpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428">common.hpp</a>
+</li>
+<li>regularizationFactor
+: <a class="el" href="xran__pkt__cp_8h.html#ab73e0a6442bf42de3e9110afca7b4ec4">xran_pkt_cp.h</a>
+</li>
+<li>reMask
+: <a class="el" href="xran__pkt__cp_8h.html#aff6c92a5dba7cc22be5e23785fe5fc43">xran_pkt_cp.h</a>
+</li>
+<li>reserved
+: <a class="el" href="xran__pkt__cp_8h.html#a5a6ed8c04a3db86066924b1a1bf4dad3">xran_pkt_cp.h</a>
+</li>
+<li>reserved0
+: <a class="el" href="xran__pkt__cp_8h.html#aed93283265f941dc1d2bf8d634164493">xran_pkt_cp.h</a>
+</li>
+<li>reserved1
+: <a class="el" href="xran__pkt__cp_8h.html#aef9bb556c1530f5d648fd57e73b9a105">xran_pkt_cp.h</a>
+</li>
+<li>reserved2
+: <a class="el" href="xran__pkt__cp_8h.html#a0fc429b055e74830a4583ec37f5c3846">xran_pkt_cp.h</a>
+</li>
+<li>RESOURCE_CORE_0
+: <a class="el" href="xran__mlog__task__id_8h.html#ad63ecf36236d55b6889b694a37f4c82a">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#ad63ecf36236d55b6889b694a37f4c82a">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_1
+: <a class="el" href="xran__mlog__task__id_8h.html#a206f9b6fd7606da5b0ddbeda0cc2d30d">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a206f9b6fd7606da5b0ddbeda0cc2d30d">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_10
+: <a class="el" href="xran__mlog__task__id_8h.html#a95a2ee6d2e9053eba72cfbd68b61e726">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a95a2ee6d2e9053eba72cfbd68b61e726">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_11
+: <a class="el" href="xran__mlog__task__id_8h.html#ac7c78da6670986038e59ec04197ba2de">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#ac7c78da6670986038e59ec04197ba2de">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_12
+: <a class="el" href="xran__mlog__task__id_8h.html#a4810ab3931b63321f315a33471562621">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a4810ab3931b63321f315a33471562621">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_13
+: <a class="el" href="xran__mlog__task__id_8h.html#a1b85fbf64ceefa1ff866a9904cc08447">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a1b85fbf64ceefa1ff866a9904cc08447">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_14
+: <a class="el" href="xran__mlog__task__id_8h.html#a662204d14e93ec97c3860dba456708ae">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a662204d14e93ec97c3860dba456708ae">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_15
+: <a class="el" href="xran__mlog__task__id_8h.html#a05f7fe99fea79c815423f3b68b045bbc">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a05f7fe99fea79c815423f3b68b045bbc">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_16
+: <a class="el" href="xran__mlog__task__id_8h.html#ab62f03244680e08b6d290b84605b926d">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#ab62f03244680e08b6d290b84605b926d">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_2
+: <a class="el" href="xran__mlog__task__id_8h.html#a85fd89028c0e45defdd171a529cb3eb5">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a85fd89028c0e45defdd171a529cb3eb5">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_3
+: <a class="el" href="xran__mlog__task__id_8h.html#a497b673d19fb0e0a12e047433e0a0e91">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a497b673d19fb0e0a12e047433e0a0e91">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_4
+: <a class="el" href="xran__mlog__task__id_8h.html#ab2899a3a28bf6b48f5f252944f96d07b">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#ab2899a3a28bf6b48f5f252944f96d07b">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_5
+: <a class="el" href="xran__mlog__task__id_8h.html#a33defb76a292b4840ef108746339240c">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a33defb76a292b4840ef108746339240c">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_6
+: <a class="el" href="xran__mlog__task__id_8h.html#a26695e5577928c9e80d055714a937329">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a26695e5577928c9e80d055714a937329">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_7
+: <a class="el" href="xran__mlog__task__id_8h.html#ae38446635f2f0f32f48776a8af2d21c7">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#ae38446635f2f0f32f48776a8af2d21c7">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_8
+: <a class="el" href="xran__mlog__task__id_8h.html#aac32aa932a156c8c4c0be901d63cfb4f">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#aac32aa932a156c8c4c0be901d63cfb4f">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>RESOURCE_CORE_9
+: <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a9b127d3cfc1299cb5706e46c1ef6d756">xran_lib_mlog_tasks_id.h</a>
+, <a class="el" href="xran__mlog__task__id_8h.html#a9b127d3cfc1299cb5706e46c1ef6d756">xran_mlog_task_id.h</a>
+</li>
+<li>RESOURCE_IA_CORE
+: <a class="el" href="xran__mlog__task__id_8h.html#a8e34684ae6b2d25c23323b56693266f0">xran_mlog_task_id.h</a>
+, <a class="el" href="xran__lib__mlog__tasks__id_8h.html#a8e34684ae6b2d25c23323b56693266f0">xran_lib_mlog_tasks_id.h</a>
+</li>
+<li>ring_idx
+: <a class="el" href="ethernet_8c.html#a845b3b4b5f6eeeef2ffa38a0048d5969">ethernet.c</a>
+</li>
+<li>ring_processing_func()
+: <a class="el" href="xran__common_8c.html#a595fa22ad1c316d4c7d77f6333478b49">xran_common.c</a>
+, <a class="el" href="xran__common_8h.html#a595fa22ad1c316d4c7d77f6333478b49">xran_common.h</a>
+</li>
+<li>ring_processing_thread()
+: <a class="el" href="xran__common_8c.html#a3cdc276ccd8081a8bda75f22b0cac279">xran_common.c</a>
+, <a class="el" href="xran__common_8h.html#a3cdc276ccd8081a8bda75f22b0cac279">xran_common.h</a>
+</li>
+<li>RINGMASK
+: <a class="el" href="ethernet_8c.html#a86876a46f9f0a408e13cb2a225b8e4e6">ethernet.c</a>
+</li>
+<li>RINGSIZE
+: <a class="el" href="ethernet_8c.html#a0ff6d080449124d52d868d9ce2ffe871">ethernet.c</a>
+</li>
+<li>run_benchmark()
+: <a class="el" href="common_8hpp.html#af69d779517f2bdee3aba95bc38022074">common.hpp</a>
+</li>
+<li>RuntimeConfig
+: <a class="el" href="config_8h.html#af57013248b2c9c128e04d2e8ce8c93c9">config.h</a>
+</li>
+<li>rx_buffer_size
+: <a class="el" href="common_8c.html#ac33fae2fa6f1f85b151fe0d60c132931">common.c</a>
+, <a class="el" href="common_8h.html#ac33fae2fa6f1f85b151fe0d60c132931">common.h</a>
+</li>
+<li>rx_bytes_counter
+: <a class="el" href="xran__common_8c.html#af2fff595280c3b2999bfa40d7beafadf">xran_common.c</a>
+, <a class="el" href="sample-app_8c.html#af2fff595280c3b2999bfa40d7beafadf">sample-app.c</a>
+, <a class="el" href="xran__common_8h.html#af2fff595280c3b2999bfa40d7beafadf">xran_common.h</a>
+</li>
+<li>rx_bytes_per_sec
+: <a class="el" href="sample-app_8c.html#adc695e955f335d5dedb486ce89a4e0b3">sample-app.c</a>
+, <a class="el" href="xran__common_8c.html#adc695e955f335d5dedb486ce89a4e0b3">xran_common.c</a>
+, <a class="el" href="xran__common_8h.html#adc695e955f335d5dedb486ce89a4e0b3">xran_common.h</a>
+</li>
+<li>rx_counter
+: <a class="el" href="xran__common_8c.html#a9e6e93a89aa6750e04b8249db2d8ad2a">xran_common.c</a>
+, <a class="el" href="xran__common_8h.html#a9e6e93a89aa6750e04b8249db2d8ad2a">xran_common.h</a>
+, <a class="el" href="sample-app_8c.html#a9e6e93a89aa6750e04b8249db2d8ad2a">sample-app.c</a>
+</li>
+<li>rx_dl_bfw_buffer_position
+: <a class="el" href="common_8c.html#a69ceaec7b612ecba9628a4a078ff319a">common.c</a>
+, <a class="el" href="common_8h.html#a69ceaec7b612ecba9628a4a078ff319a">common.h</a>
+</li>
+<li>rx_dl_bfw_buffer_size
+: <a class="el" href="common_8c.html#a75c2080232a140585589adea6b446d61">common.c</a>
+, <a class="el" href="common_8h.html#a75c2080232a140585589adea6b446d61">common.h</a>
+</li>
+<li>rx_log_buffer_position
+: <a class="el" href="common_8h.html#adb25475aaf7dcca7350334f201c161c4">common.h</a>
+, <a class="el" href="common_8c.html#adb25475aaf7dcca7350334f201c161c4">common.c</a>
+</li>
+<li>rx_log_buffer_size
+: <a class="el" href="common_8c.html#abc08d2b5f2da30c4a1e5d258dfe8dfc7">common.c</a>
+, <a class="el" href="common_8h.html#abc08d2b5f2da30c4a1e5d258dfe8dfc7">common.h</a>
+</li>
+<li>rx_ul_bfw_buffer_position
+: <a class="el" href="common_8h.html#a49b46cf2c43d8dade13dce8a3e3cdba9">common.h</a>
+, <a class="el" href="common_8c.html#a49b46cf2c43d8dade13dce8a3e3cdba9">common.c</a>
+</li>
+<li>rx_ul_bfw_buffer_size
+: <a class="el" href="common_8h.html#ada292a2cdef3b215f7a2f0e84c8c027c">common.h</a>
+, <a class="el" href="common_8c.html#ada292a2cdef3b215f7a2f0e84c8c027c">common.c</a>
+</li>
+<li>rx_ul_deadline_full_cb()
+: <a class="el" href="xran__main_8c.html#a63aa00dad3b771f4db5df8ca8ac68323">xran_main.c</a>
+</li>
+<li>rx_ul_deadline_half_cb()
+: <a class="el" href="xran__main_8c.html#ad4544f4d6f4713c010f083bce5758d14">xran_main.c</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>