add Doxygen documentation
[o-du/phy.git] / docs / API / globals_s.html
diff --git a/docs/API/globals_s.html b/docs/API/globals_s.html
new file mode 100644 (file)
index 0000000..f231d00
--- /dev/null
@@ -0,0 +1,217 @@
+<!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_s"></a>- s -</h3><ul>
+<li>s0
+: <a class="el" href="xran__pkt__cp_8h.html#a4b39e0bd755009987ba524eeb2dc498c">xran_pkt_cp.h</a>
+</li>
+<li>s1
+: <a class="el" href="xran__pkt__cp_8h.html#a3acb089c3231d11a0b19b211a4064858">xran_pkt_cp.h</a>
+</li>
+<li>s3
+: <a class="el" href="xran__pkt__cp_8h.html#a4127e3fdcd37be2355359a4d62704f29">xran_pkt_cp.h</a>
+</li>
+<li>s5
+: <a class="el" href="xran__pkt__cp_8h.html#a530893d11c684e6332abc2c8f08062fb">xran_pkt_cp.h</a>
+</li>
+<li>SEC_MOD_STOP
+: <a class="el" href="xran__timer_8c.html#a7ea28dc9406161730556bbec38f1a799">xran_timer.c</a>
+</li>
+<li>sectionId
+: <a class="el" href="xran__pkt__cp_8h.html#a9a83cf1c3a2706e565cbbd8a6e3af8b2">xran_pkt_cp.h</a>
+</li>
+<li>sectionType
+: <a class="el" href="xran__pkt__cp_8h.html#ae273caa235b1c6085de4ad13886f82c9">xran_pkt_cp.h</a>
+</li>
+<li>send_cpmsg()
+: <a class="el" href="xran__common_8c.html#a484fa852a2e973600abba0efb1fbefb9">xran_common.c</a>
+, <a class="el" href="xran__common_8h.html#a484fa852a2e973600abba0efb1fbefb9">xran_common.h</a>
+</li>
+<li>send_mbuf_cp_perf()
+: <a class="el" href="chain__tests_8cc.html#aa17765d107c851ebcc3d202cef78aa75">chain_tests.cc</a>
+</li>
+<li>send_mbuf_up()
+: <a class="el" href="chain__tests_8cc.html#a35e1cd308253045533454c90a54f876f">chain_tests.cc</a>
+</li>
+<li>send_symbol_ex()
+: <a class="el" href="xran__common_8c.html#ab67b9cc6e54d8ba3945b265b47af743c">xran_common.c</a>
+, <a class="el" href="xran__common_8h.html#ab67b9cc6e54d8ba3945b265b47af743c">xran_common.h</a>
+</li>
+<li>ShowData()
+: <a class="el" href="debug_8h.html#a42574ce0fd997ec42f57353f49235176">debug.h</a>
+</li>
+<li>sleep_next_tick()
+: <a class="el" href="xran__timer_8c.html#a63aaaffc2af6e6655ea0fc95078d5a04">xran_timer.c</a>
+, <a class="el" href="xran__timer_8h.html#a63aaaffc2af6e6655ea0fc95078d5a04">xran_timer.h</a>
+</li>
+<li>SLEEP_TIME
+: <a class="el" href="ethdi_8h.html#abe0b7b2a0ec4b64b92585808a051e1fa">ethdi.h</a>
+</li>
+<li>slotId
+: <a class="el" href="xran__pkt__cp_8h.html#ae287404c8c0fa4fb464abf8f6a516346">xran_pkt_cp.h</a>
+</li>
+<li>SLOTNUM_PER_SUBFRAME
+: <a class="el" href="xran__common_8h.html#a76e4794a93b44d5f6bd835f1640f7f4f">xran_common.h</a>
+</li>
+<li>SLOTS_PER_SYSTEMFRAME
+: <a class="el" href="xran__common_8h.html#a725b4fbf070658ef449db5718a6c9f22">xran_common.h</a>
+</li>
+<li>socket_direct_pool
+: <a class="el" href="ethernet_8c.html#a9b3ca6fe25e72be5c4fd7a95f92d174f">ethernet.c</a>
+, <a class="el" href="ethernet_8h.html#a9b3ca6fe25e72be5c4fd7a95f92d174f">ethernet.h</a>
+</li>
+<li>socket_indirect_pool
+: <a class="el" href="ethernet_8c.html#adb2e2732725779d167cb43cb9ecac924">ethernet.c</a>
+, <a class="el" href="ethernet_8h.html#adb2e2732725779d167cb43cb9ecac924">ethernet.h</a>
+</li>
+<li>srs_log_buffer_position
+: <a class="el" href="common_8c.html#a54295c1c12a237fac044d84d8c0ff0d9">common.c</a>
+, <a class="el" href="common_8h.html#a54295c1c12a237fac044d84d8c0ff0d9">common.h</a>
+</li>
+<li>srs_log_buffer_size
+: <a class="el" href="common_8c.html#a9903f17a482557ec30123a63d9f52c7f">common.c</a>
+, <a class="el" href="common_8h.html#a9903f17a482557ec30123a63d9f52c7f">common.h</a>
+</li>
+<li>SSE4_2
+: <a class="el" href="common__typedef__xran_8h.html#a4c160ac3b177a2fde8738ef01e58494ca4c63ae1c44ecd28b978e615d7773e15f">common_typedef_xran.h</a>
+</li>
+<li>startPrbc
+: <a class="el" href="xran__pkt__cp_8h.html#a94a428ce385fe1757f5de40003b85030">xran_pkt_cp.h</a>
+</li>
+<li>startPrbch
+: <a class="el" href="xran__pkt__cp_8h.html#a02b265f2198407df96202e1dfdc5c7dd">xran_pkt_cp.h</a>
+</li>
+<li>startPrbcl
+: <a class="el" href="xran__pkt__cp_8h.html#ae0ba1ea05777c0190eb5d898d177f37d">xran_pkt_cp.h</a>
+</li>
+<li>startSymbolId
+: <a class="el" href="xran__pkt__cp_8h.html#a158cc4eb9be778527f9afe0bf9df19e0">xran_pkt_cp.h</a>
+</li>
+<li>startupConfiguration
+: <a class="el" href="sample-app_8c.html#aa2ff8adc05857ee86fea1fcff787290b">sample-app.c</a>
+</li>
+<li>state
+: <a class="el" href="common_8c.html#a9dc062894f50c14d43977487568e69bc">common.c</a>
+, <a class="el" href="sample-app_8c.html#a9dc062894f50c14d43977487568e69bc">sample-app.c</a>
+</li>
+<li>stop_xran()
+: <a class="el" href="sample-app_8c.html#ac871776e03d4a4ae1717d2600a7f7dff">sample-app.c</a>
+</li>
+<li>SUBFRAME_DURATION_US
+: <a class="el" href="common_8h.html#a9a2a7fcab69aaafebda2e160cf2eb85b">common.h</a>
+, <a class="el" href="xran__common_8h.html#a9a2a7fcab69aaafebda2e160cf2eb85b">xran_common.h</a>
+</li>
+<li>subframeId
+: <a class="el" href="xran__pkt__cp_8h.html#aa948cf928c529d24f8d536fb480094f2">xran_pkt_cp.h</a>
+</li>
+<li>SUBFRAMES_PER_SYSTEMFRAME
+: <a class="el" href="common_8h.html#a695a7a6db2c879d5a4ec04a4bc99d0e4">common.h</a>
+, <a class="el" href="xran__common_8h.html#a695a7a6db2c879d5a4ec04a4bc99d0e4">xran_common.h</a>
+</li>
+<li>SW_FPGA_FH_TOTAL_BUFFER_LEN
+: <a class="el" href="sample-app_8c.html#ad5b1e2ec82b937000bd1fe89acb5384c">sample-app.c</a>
+, <a class="el" href="xran__lib__wrap_8hpp.html#ad5b1e2ec82b937000bd1fe89acb5384c">xran_lib_wrap.hpp</a>
+</li>
+<li>SW_FPGA_SEGMENT_BUFFER_LEN
+: <a class="el" href="xran__lib__wrap_8hpp.html#ae9c34194d5ec7c9c24b680085991306c">xran_lib_wrap.hpp</a>
+, <a class="el" href="sample-app_8c.html#ae9c34194d5ec7c9c24b680085991306c">sample-app.c</a>
+</li>
+<li>SW_FPGA_TOTAL_BUFFER_LEN
+: <a class="el" href="xran__lib__wrap_8hpp.html#a7b323875aec9da8e30e082063f75b50b">xran_lib_wrap.hpp</a>
+, <a class="el" href="sample-app_8c.html#a7b323875aec9da8e30e082063f75b50b">sample-app.c</a>
+</li>
+<li>switch()
+: <a class="el" href="gen__test_8m.html#ae7c338f9b485676bfc0ee154384d8676">gen_test.m</a>
+</li>
+<li>SWXRANInterfaceTypeEnum
+: <a class="el" href="sample-app_8c.html#afecde4b156cd353cb29487bbb9675d46">sample-app.c</a>
+</li>
+<li>sym_ota_cb()
+: <a class="el" href="xran__main_8c.html#a195da46c3cb90e36da543594416cbba7">xran_main.c</a>
+, <a class="el" href="xran__lib__wrap_8hpp.html#a6c189fbbc24f87fad24cff9cbd0e6a42">xran_lib_wrap.hpp</a>
+</li>
+<li>symInc
+: <a class="el" href="xran__pkt__cp_8h.html#a52f6623d45fec4bf9c14898f7e53db34">xran_pkt_cp.h</a>
+</li>
+<li>sys_load_file_to_buff()
+: <a class="el" href="common_8h.html#a8f27f0a8b6843f5e32ecbce83d487262">common.h</a>
+, <a class="el" href="common_8c.html#a8f27f0a8b6843f5e32ecbce83d487262">common.c</a>
+</li>
+<li>sys_save_buf_to_file()
+: <a class="el" href="common_8c.html#acd37223937d89e77a1ccbdc6e94b38cc">common.c</a>
+, <a class="el" href="common_8h.html#acd37223937d89e77a1ccbdc6e94b38cc">common.h</a>
+</li>
+<li>sys_save_buf_to_file_txt()
+: <a class="el" href="common_8c.html#ab022cdd736a497eb5cfa7d5dcab0634c">common.c</a>
+, <a class="el" href="common_8h.html#ab022cdd736a497eb5cfa7d5dcab0634c">common.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>