add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__prach__config.html
diff --git a/docs/API/structxran__prach__config.html b/docs/API/structxran__prach__config.html
new file mode 100644 (file)
index 0000000..e82f8ca
--- /dev/null
@@ -0,0 +1,247 @@
+<!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_prach_config Struct 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><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-attribs">Data Fields</a>  </div>
+  <div class="headertitle">
+<div class="title">xran_prach_config Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for xran_prach_config:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__prach__config__coll__graph.png" border="0" usemap="#xran__prach__config_coll__map" alt="Collaboration graph"/></div>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Data Fields</h2></td></tr>
+<tr class="memitem:acb5fe8097b0115e038eb02d5900f66d6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#acb5fe8097b0115e038eb02d5900f66d6">nPrachConfIdx</a></td></tr>
+<tr class="separator:acb5fe8097b0115e038eb02d5900f66d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab9b99e41ea39f16780f66a539aa872c8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#ab9b99e41ea39f16780f66a539aa872c8">nPrachSubcSpacing</a></td></tr>
+<tr class="separator:ab9b99e41ea39f16780f66a539aa872c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a45ae197adc4010202a5b71d7b602bc0c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a45ae197adc4010202a5b71d7b602bc0c">nPrachZeroCorrConf</a></td></tr>
+<tr class="separator:a45ae197adc4010202a5b71d7b602bc0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a26e6c95dfde831c2588d46dde588c751"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a26e6c95dfde831c2588d46dde588c751">nPrachRestrictSet</a></td></tr>
+<tr class="separator:a26e6c95dfde831c2588d46dde588c751"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a66b19aaa946c36b309a3403b3d576c58"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a66b19aaa946c36b309a3403b3d576c58">nPrachRootSeqIdx</a></td></tr>
+<tr class="separator:a66b19aaa946c36b309a3403b3d576c58"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5c648c99c04370a4e8767f919a2289bf"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a5c648c99c04370a4e8767f919a2289bf">nPrachFreqStart</a></td></tr>
+<tr class="separator:a5c648c99c04370a4e8767f919a2289bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3b43924c5ef23b0496d1a7adf2752dbf"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a3b43924c5ef23b0496d1a7adf2752dbf">nPrachFreqOffset</a></td></tr>
+<tr class="separator:a3b43924c5ef23b0496d1a7adf2752dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab3ca7a740428b7023b7e29197124983b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#ab3ca7a740428b7023b7e29197124983b">nPrachFilterIdx</a></td></tr>
+<tr class="separator:ab3ca7a740428b7023b7e29197124983b"><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>SRS configuration required for XRAN based FH </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00429">429</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="acb5fe8097b0115e038eb02d5900f66d6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acb5fe8097b0115e038eb02d5900f66d6">&#9670;&nbsp;</a></span>nPrachConfIdx</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t nPrachConfIdx</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>PRACH Configuration Index </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00432">432</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="ab3ca7a740428b7023b7e29197124983b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab3ca7a740428b7023b7e29197124983b">&#9670;&nbsp;</a></span>nPrachFilterIdx</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t nPrachFilterIdx</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>PRACH Filter index </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00443">443</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a3b43924c5ef23b0496d1a7adf2752dbf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3b43924c5ef23b0496d1a7adf2752dbf">&#9670;&nbsp;</a></span>nPrachFreqOffset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int32_t nPrachFreqOffset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>PRACH prach-frequency-offset </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00442">442</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a5c648c99c04370a4e8767f919a2289bf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5c648c99c04370a4e8767f919a2289bf">&#9670;&nbsp;</a></span>nPrachFreqStart</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t nPrachFreqStart</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>PRACH prach-frequency-start </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00441">441</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a26e6c95dfde831c2588d46dde588c751"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a26e6c95dfde831c2588d46dde588c751">&#9670;&nbsp;</a></span>nPrachRestrictSet</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t nPrachRestrictSet</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>PRACH restrictedSetConfig </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00439">439</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a66b19aaa946c36b309a3403b3d576c58"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a66b19aaa946c36b309a3403b3d576c58">&#9670;&nbsp;</a></span>nPrachRootSeqIdx</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t nPrachRootSeqIdx</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>PRACH Root Sequence Index </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00440">440</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="ab9b99e41ea39f16780f66a539aa872c8"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab9b99e41ea39f16780f66a539aa872c8">&#9670;&nbsp;</a></span>nPrachSubcSpacing</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t nPrachSubcSpacing</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>PRACH Sub-carrier spacing Value:0-&gt;1 For below 6GHz the values indicate 15kHz or 30kHz For above 6GHz the values indicate 60kHz or 120kHz </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00433">433</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<a id="a45ae197adc4010202a5b71d7b602bc0c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a45ae197adc4010202a5b71d7b602bc0c">&#9670;&nbsp;</a></span>nPrachZeroCorrConf</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t nPrachZeroCorrConf</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>PRACH zeroCorrelationZoneConfig </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00438">438</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.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>