add Doxygen documentation
[o-du/phy.git] / docs / API / xran__ul__tables_8c.html
diff --git a/docs/API/xran__ul__tables_8c.html b/docs/API/xran__ul__tables_8c.html
new file mode 100644 (file)
index 0000000..38eb9c6
--- /dev/null
@@ -0,0 +1,198 @@
+<!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: xran_ul_tables.c File 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_9fc50806095da30fbd4a2dbe2e456ff5.html">src</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#var-members">Variables</a>  </div>
+  <div class="headertitle">
+<div class="title">xran_ul_tables.c File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This file defines those table used in 5G NR spec.  
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
+<code>#include &lt;stdlib.h&gt;</code><br />
+<code>#include &lt;string.h&gt;</code><br />
+<code>#include &quot;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&quot;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for xran_ul_tables.c:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__ul__tables_8c__incl.png" border="0" usemap="#xran__ul__tables_8c" alt=""/></div>
+<map name="xran__ul__tables_8c" id="xran__ul__tables_8c">
+<area shape="rect" id="node5" href="xran__common_8h.html" title="XRAN layer common functionality for both lls&#45;CU and RU as well as C&#45;plane and U&#45;plane. " alt="" coords="1037,80,1152,107"/>
+<area shape="rect" id="node12" href="xran__fh__o__du_8h.html" title="This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN&#45;WG..." alt="" coords="659,229,770,256"/>
+<area shape="rect" id="node22" href="xran__pkt__up_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="1552,229,1656,256"/>
+<area shape="rect" id="node26" href="xran__cp__api_8h.html" title="This file provides the definitions for Control Plane Messages APIs. " alt="" coords="903,155,1006,181"/>
+<area shape="rect" id="node23" href="xran__pkt_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="1508,304,1591,331"/>
+<area shape="rect" id="node27" href="xran__pkt__cp_8h.html" title="This file provides the definition of Control Plane Messages for XRAN Front Haul layer as defined in X..." alt="" coords="903,229,1007,256"/>
+<area shape="rect" id="node28" href="xran__transport_8h.html" title="This file provides the definitions for Transport layer (eCPRI) API. " alt="" coords="1411,229,1527,256"/>
+</map>
+</div>
+</div>
+<p><a href="xran__ul__tables_8c_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
+Variables</h2></td></tr>
+<tr class="memitem:a5edf7a402993c76a3a27bee4f390d38c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structx_r_a_n_prach_config_table_struct.html">xRANPrachConfigTableStruct</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__ul__tables_8c.html#a5edf7a402993c76a3a27bee4f390d38c">gxranPrachDataTable_sub6_fdd</a> [<a class="el" href="xran__common_8h.html#acfe10f9da776bb6e50a7280baab35e28">XRAN_PRACH_CONFIG_TABLE_SIZE</a>]</td></tr>
+<tr class="separator:a5edf7a402993c76a3a27bee4f390d38c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1c7c9fd55feeae30dc0b8502ef4cab03"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structx_r_a_n_prach_config_table_struct.html">xRANPrachConfigTableStruct</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__ul__tables_8c.html#a1c7c9fd55feeae30dc0b8502ef4cab03">gxranPrachDataTable_sub6_tdd</a> [<a class="el" href="xran__common_8h.html#acfe10f9da776bb6e50a7280baab35e28">XRAN_PRACH_CONFIG_TABLE_SIZE</a>]</td></tr>
+<tr class="separator:a1c7c9fd55feeae30dc0b8502ef4cab03"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac7439428a0fb0c1782323193707965f6"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structx_r_a_n_prach_config_table_struct.html">xRANPrachConfigTableStruct</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__ul__tables_8c.html#ac7439428a0fb0c1782323193707965f6">gxranPrachDataTable_mmw</a> [<a class="el" href="xran__common_8h.html#acfe10f9da776bb6e50a7280baab35e28">XRAN_PRACH_CONFIG_TABLE_SIZE</a>]</td></tr>
+<tr class="separator:ac7439428a0fb0c1782323193707965f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab7c9c49ac127f2812c5ffe8c54364286"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structx_r_a_n_prach_preamble_l_r_a_struct.html">xRANPrachPreambleLRAStruct</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__ul__tables_8c.html#ab7c9c49ac127f2812c5ffe8c54364286">gxranPreambleforLRA</a> [13]</td></tr>
+<tr class="separator:ab7c9c49ac127f2812c5ffe8c54364286"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>This file defines those table used in 5G NR spec. </p>
+<dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
+
+<p class="definition">Definition in file <a class="el" href="xran__ul__tables_8c_source.html">xran_ul_tables.c</a>.</p>
+</div><h2 class="groupheader">Variable Documentation</h2>
+<a id="ac7439428a0fb0c1782323193707965f6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac7439428a0fb0c1782323193707965f6">&#9670;&nbsp;</a></span>gxranPrachDataTable_mmw</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const <a class="el" href="structx_r_a_n_prach_config_table_struct.html">xRANPrachConfigTableStruct</a> gxranPrachDataTable_mmw[<a class="el" href="xran__common_8h.html#acfe10f9da776bb6e50a7280baab35e28">XRAN_PRACH_CONFIG_TABLE_SIZE</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__ul__tables_8c_source.html#l00553">553</a> of file <a class="el" href="xran__ul__tables_8c_source.html">xran_ul_tables.c</a>.</p>
+
+</div>
+</div>
+<a id="a5edf7a402993c76a3a27bee4f390d38c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5edf7a402993c76a3a27bee4f390d38c">&#9670;&nbsp;</a></span>gxranPrachDataTable_sub6_fdd</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const <a class="el" href="structx_r_a_n_prach_config_table_struct.html">xRANPrachConfigTableStruct</a> gxranPrachDataTable_sub6_fdd[<a class="el" href="xran__common_8h.html#acfe10f9da776bb6e50a7280baab35e28">XRAN_PRACH_CONFIG_TABLE_SIZE</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__ul__tables_8c_source.html#l00032">32</a> of file <a class="el" href="xran__ul__tables_8c_source.html">xran_ul_tables.c</a>.</p>
+
+</div>
+</div>
+<a id="a1c7c9fd55feeae30dc0b8502ef4cab03"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1c7c9fd55feeae30dc0b8502ef4cab03">&#9670;&nbsp;</a></span>gxranPrachDataTable_sub6_tdd</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const <a class="el" href="structx_r_a_n_prach_config_table_struct.html">xRANPrachConfigTableStruct</a> gxranPrachDataTable_sub6_tdd[<a class="el" href="xran__common_8h.html#acfe10f9da776bb6e50a7280baab35e28">XRAN_PRACH_CONFIG_TABLE_SIZE</a>]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__ul__tables_8c_source.html#l00292">292</a> of file <a class="el" href="xran__ul__tables_8c_source.html">xran_ul_tables.c</a>.</p>
+
+</div>
+</div>
+<a id="ab7c9c49ac127f2812c5ffe8c54364286"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab7c9c49ac127f2812c5ffe8c54364286">&#9670;&nbsp;</a></span>gxranPreambleforLRA</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const <a class="el" href="structx_r_a_n_prach_preamble_l_r_a_struct.html">xRANPrachPreambleLRAStruct</a> gxranPreambleforLRA[13]</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<b>Initial value:</b><div class="fragment"><div class="line">=</div><div class="line">{</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda3da3630c9b4bcccd0ce575dec64f1e8c">FORMAT_0</a>, 839,  125, 1 , 3168 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddaa8dcdd4c043312a1375dcca7c9871890">FORMAT_1</a>, 839,  125, 2 ,21024 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddace242c744b99c7a362cd3d1def11f1c2">FORMAT_2</a>, 839,  125, 4 , 4688 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddaf68a27769c5e6ba92952e5c0e020e5a6">FORMAT_3</a>, 839,    5, 1 , 3168 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda4dbd8b9cc1a25a875c17515359bd1b1d">FORMAT_A1</a>, 139,  15, 2 ,  288 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddac9e8e841dda58d91cba5f171ff7ff3fe">FORMAT_A2</a>, 139,  15, 4 ,  576 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda4daf71066792c884693864fefcda15e7">FORMAT_A3</a>, 139,  15, 6 ,  864 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddac94f811c4266a82ce5064662e402e1ef">FORMAT_B1</a>, 139,  15, 2 ,  216 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddadcf4ca500d4c83886f855a53e4f7d525">FORMAT_B2</a>, 139,  15, 4 ,  360 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda6934efee56a47d220a516928ec0d3306">FORMAT_B3</a>, 139,  15, 6 ,  504 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda4f3a9d68540b513a7ea82b7795632e95">FORMAT_B4</a>, 139,  15, 12,  936 },</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda858e0c1dfeafae5dba3691fbfcb3c7a2">FORMAT_C0</a>, 139,  15, 1 ,  1240},</div><div class="line">    {<a class="code" href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda900ab029e31373a471a67c75dbbefa50">FORMAT_C2</a>, 139,  15, 4 ,  2048}</div><div class="line">}</div><div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80dda6934efee56a47d220a516928ec0d3306"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda6934efee56a47d220a516928ec0d3306">FORMAT_B3</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00094">xran_common.h:94</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80dda4dbd8b9cc1a25a875c17515359bd1b1d"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda4dbd8b9cc1a25a875c17515359bd1b1d">FORMAT_A1</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00089">xran_common.h:89</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80dda3da3630c9b4bcccd0ce575dec64f1e8c"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda3da3630c9b4bcccd0ce575dec64f1e8c">FORMAT_0</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00085">xran_common.h:85</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80dda4f3a9d68540b513a7ea82b7795632e95"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda4f3a9d68540b513a7ea82b7795632e95">FORMAT_B4</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00095">xran_common.h:95</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80ddadcf4ca500d4c83886f855a53e4f7d525"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddadcf4ca500d4c83886f855a53e4f7d525">FORMAT_B2</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00093">xran_common.h:93</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80ddaa8dcdd4c043312a1375dcca7c9871890"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddaa8dcdd4c043312a1375dcca7c9871890">FORMAT_1</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00086">xran_common.h:86</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80ddac9e8e841dda58d91cba5f171ff7ff3fe"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddac9e8e841dda58d91cba5f171ff7ff3fe">FORMAT_A2</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00090">xran_common.h:90</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80dda900ab029e31373a471a67c75dbbefa50"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda900ab029e31373a471a67c75dbbefa50">FORMAT_C2</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00097">xran_common.h:97</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80ddac94f811c4266a82ce5064662e402e1ef"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddac94f811c4266a82ce5064662e402e1ef">FORMAT_B1</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00092">xran_common.h:92</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80ddace242c744b99c7a362cd3d1def11f1c2"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddace242c744b99c7a362cd3d1def11f1c2">FORMAT_2</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00087">xran_common.h:87</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80dda4daf71066792c884693864fefcda15e7"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda4daf71066792c884693864fefcda15e7">FORMAT_A3</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00091">xran_common.h:91</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80ddaf68a27769c5e6ba92952e5c0e020e5a6"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80ddaf68a27769c5e6ba92952e5c0e020e5a6">FORMAT_3</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00088">xran_common.h:88</a></div></div>
+<div class="ttc" id="xran__common_8h_html_a8c9c50771b8a51b0209b1866855b80dda858e0c1dfeafae5dba3691fbfcb3c7a2"><div class="ttname"><a href="xran__common_8h.html#a8c9c50771b8a51b0209b1866855b80dda858e0c1dfeafae5dba3691fbfcb3c7a2">FORMAT_C0</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__common_8h_source.html#l00096">xran_common.h:96</a></div></div>
+</div><!-- fragment -->
+<p class="definition">Definition at line <a class="el" href="xran__ul__tables_8c_source.html#l00845">845</a> of file <a class="el" href="xran__ul__tables_8c_source.html">xran_ul_tables.c</a>.</p>
+
+</div>
+</div>
+</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>