add Doxygen documentation
[o-du/phy.git] / docs / API / functions_vars_n.html
diff --git a/docs/API/functions_vars_n.html b/docs/API/functions_vars_n.html
new file mode 100644 (file)
index 0000000..85cb2d9
--- /dev/null
@@ -0,0 +1,325 @@
+<!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: Data Fields - Variables</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">
+&#160;
+
+<h3><a id="index_n"></a>- n -</h3><ul>
+<li>nAntElmTRx
+: <a class="el" href="structxran__cp__bf__weight.html#a5a0bb9b26c357c93eb4a7822b5272300">xran_cp_bf_weight</a>
+, <a class="el" href="structxran__fh__config.html#ac63d8c67956a8a08cbfd8efb92a2f055">xran_fh_config</a>
+</li>
+<li>nBeamIndex
+: <a class="el" href="structxran__prb__elm.html#aba198438bbacf8f73b6bfa481b365ce5">xran_prb_elm</a>
+</li>
+<li>nBufferPoolIndex
+: <a class="el" href="structsector_handle_info.html#a7f385bf2d48d174e82285595baa66890">sectorHandleInfo</a>
+</li>
+<li>nBufPoolIndex
+: <a class="el" href="struct_bbu_xran_io_if_struct.html#a52c040c5ef8cdccb720b42ea0c5632a6">BbuXranIoIfStruct</a>
+, <a class="el" href="class_init___sys___check.html#afbefaeac48b99d44a1930b66c9e4e21f">Init_Sys_Check</a>
+</li>
+<li>nCC
+: <a class="el" href="structxran__fh__config.html#a6dcac3ea0b3d99c20c2e6f7091b8b342">xran_fh_config</a>
+</li>
+<li>nCoreMask
+: <a class="el" href="struct_bbu_xran_io_if_struct.html#a1467a6caa947129c506085d9d44d099e">BbuXranIoIfStruct</a>
+</li>
+<li>nDLAbsFrePointA
+: <a class="el" href="struct___runtime_config.html#ac0e69adfb3c3429ce7f7b9a568959934">_RuntimeConfig</a>
+, <a class="el" href="structxran__fh__config.html#ac0e69adfb3c3429ce7f7b9a568959934">xran_fh_config</a>
+</li>
+<li>nDLBandwidth
+: <a class="el" href="struct___runtime_config.html#ad218e25642a9ecba017dfab4637c0b50">_RuntimeConfig</a>
+</li>
+<li>nDLCenterFreqARFCN
+: <a class="el" href="structxran__fh__config.html#acd9d2cad066dac9c7ae84a0edbc9b8ae">xran_fh_config</a>
+</li>
+<li>nDLFftSize
+: <a class="el" href="struct___runtime_config.html#ad86ba09b02f93a0f8525f5d07b471ead">_RuntimeConfig</a>
+, <a class="el" href="structxran__fh__config.html#a8956e982993d4b310e3bffe207f66405">xran_fh_config</a>
+</li>
+<li>nDLRBs
+: <a class="el" href="structxran__fh__config.html#a7917929ae3bb588a5bf6f4e56cf9549e">xran_fh_config</a>
+</li>
+<li>nDriverCoreId
+: <a class="el" href="struct_bbu_xran_io_if_struct.html#a42e7078befd835706ed80adc1688c033">BbuXranIoIfStruct</a>
+, <a class="el" href="struct_xran_lib_config.html#acd5189037e23e024ae8f03a90399e97e">XranLibConfig</a>
+</li>
+<li>neAxc
+: <a class="el" href="structxran__fh__config.html#abcac68b45b2bcf3b5458817d65b86e45">xran_fh_config</a>
+</li>
+<li>neAxcUl
+: <a class="el" href="structxran__fh__config.html#a6b9c6f2e0bae93c45674bea4082c8a7a">xran_fh_config</a>
+</li>
+<li>nebyteorderswap
+: <a class="el" href="struct___runtime_config.html#a932c6c205ec4695d57632b623753a7ab">_RuntimeConfig</a>
+</li>
+<li>nElementLenInBytes
+: <a class="el" href="structxran__flat__buffer.html#ac9d92d585877c2ef1af759479baf85fe">xran_flat_buffer</a>
+</li>
+<li>nFhBufIntFlag
+: <a class="el" href="struct_xran_lib_config.html#a0f7b4777832a26c80e4d58003813d70d">XranLibConfig</a>
+</li>
+<li>nFhConfig
+: <a class="el" href="struct_xran_lib_config.html#af75cbcbef6876a9c79b61b46572b6501">XranLibConfig</a>
+</li>
+<li>nFHCoreId
+: <a class="el" href="struct_bbu_xran_io_if_struct.html#a94a63af18d6661b189605db8f66dbc7a">BbuXranIoIfStruct</a>
+</li>
+<li>nFrameDuplexType
+: <a class="el" href="struct___runtime_config.html#a3b86317723a592e240c0047e53a6326d">_RuntimeConfig</a>
+, <a class="el" href="structxran__frame__config.html#a3b86317723a592e240c0047e53a6326d">xran_frame_config</a>
+</li>
+<li>nIndex
+: <a class="el" href="structsector_handle_info.html#a3e89a68b1b304e37badf1e8a62a38527">sectorHandleInfo</a>
+</li>
+<li>nInstanceHandle
+: <a class="el" href="struct_bbu_xran_io_if_struct.html#a492c471226877c87f771b9f4fe13a6ab">BbuXranIoIfStruct</a>
+, <a class="el" href="class_init___sys___check.html#a492c471226877c87f771b9f4fe13a6ab">Init_Sys_Check</a>
+</li>
+<li>nInstanceNum
+: <a class="el" href="struct_bbu_xran_io_if_struct.html#a0d19e9e74d94b9c2fb5734392bd7a590">BbuXranIoIfStruct</a>
+, <a class="el" href="class_init___sys___check.html#a0d19e9e74d94b9c2fb5734392bd7a590">Init_Sys_Check</a>
+</li>
+<li>nIsPhyAddr
+: <a class="el" href="structxran__flat__buffer.html#a0119c99b1fb0b423f6c1acf165cb8930">xran_flat_buffer</a>
+</li>
+<li>nNrofSfInFrame
+: <a class="el" href="struct_xran_lib_config.html#a6574f1a80394aabb048881d606e03f8e">XranLibConfig</a>
+</li>
+<li>nNrOfSlotInSf
+: <a class="el" href="struct_xran_lib_config.html#a8bf802ca9b9dfa939a1fef031bb8f364">XranLibConfig</a>
+</li>
+<li>nNumberOfElements
+: <a class="el" href="structxran__flat__buffer.html#a4371798a7694f5939136dca8baa93f21">xran_flat_buffer</a>
+</li>
+<li>nNumBuffers
+: <a class="el" href="structxran__buffer__list.html#a3d723fbd99a0f76d412b2b79931fbc6e">xran_buffer_list</a>
+</li>
+<li>nNumerology
+: <a class="el" href="structxran__frame__config.html#a78b2fab8e8d6a6424c2712d528fd9a58">xran_frame_config</a>
+</li>
+<li>nNumRbsPerSymF1
+: <a class="el" href="classxran_lib_wraper.html#a95651581b17afb55b04ca83f04261353">xranLibWraper</a>
+</li>
+<li>nNumRbsPerSymF2
+: <a class="el" href="classxran_lib_wraper.html#aa77e335f5b2d2cc1d81de7a55f122ded">xranLibWraper</a>
+</li>
+<li>nOffsetInBytes
+: <a class="el" href="structxran__flat__buffer.html#a2c3c46f4c4709f349a0cc62bae9ca92d">xran_flat_buffer</a>
+</li>
+<li>nPrachConfIdx
+: <a class="el" href="structxran__prach__config.html#acb5fe8097b0115e038eb02d5900f66d6">xran_prach_config</a>
+</li>
+<li>nPrachFilterIdx
+: <a class="el" href="structxran__prach__config.html#ab3ca7a740428b7023b7e29197124983b">xran_prach_config</a>
+</li>
+<li>nPrachFreqOffset
+: <a class="el" href="structxran__prach__config.html#a3b43924c5ef23b0496d1a7adf2752dbf">xran_prach_config</a>
+</li>
+<li>nPrachFreqStart
+: <a class="el" href="structxran__prach__config.html#a5c648c99c04370a4e8767f919a2289bf">xran_prach_config</a>
+</li>
+<li>nPrachRestrictSet
+: <a class="el" href="structxran__prach__config.html#a26e6c95dfde831c2588d46dde588c751">xran_prach_config</a>
+</li>
+<li>nPrachRootSeqIdx
+: <a class="el" href="structxran__prach__config.html#a66b19aaa946c36b309a3403b3d576c58">xran_prach_config</a>
+</li>
+<li>nPrachSubcSpacing
+: <a class="el" href="structxran__prach__config.html#ab9b99e41ea39f16780f66a539aa872c8">xran_prach_config</a>
+</li>
+<li>nPrachZeroCorrConf
+: <a class="el" href="structxran__prach__config.html#a45ae197adc4010202a5b71d7b602bc0c">xran_prach_config</a>
+</li>
+<li>nPrbElm
+: <a class="el" href="structxran__prb__map.html#a5a2ad8f5285dd33572e310069cdac3c4">xran_prb_map</a>
+</li>
+<li>nRaCp
+: <a class="el" href="structx_r_a_n_prach_preamble_l_r_a_struct.html#a3cab2a5fe931bc424f18ac0b23f2060e">xRANPrachPreambleLRAStruct</a>
+</li>
+<li>NRARFCN
+: <a class="el" href="struct_f_p_g_a_phase_comp_cfg.html#a6d109b341fbd0f31e0a1198a87e79434">FPGAPhaseCompCfg</a>
+</li>
+<li>nRBSize
+: <a class="el" href="structxran__prb__elm.html#a18adf7163dacc5bd7dd344fb1216f729">xran_prb_elm</a>
+</li>
+<li>nRBStart
+: <a class="el" href="structxran__prb__elm.html#a5248ad5c1a177b8b9d5ef60f710652bc">xran_prb_elm</a>
+</li>
+<li>nrofPrachInSlot
+: <a class="el" href="structxran__prach__cp__config.html#a855041f3139611ca7478502e3241b2f1">xran_prach_cp_config</a>
+, <a class="el" href="structx_r_a_n_prach_config_table_struct.html#a855041f3139611ca7478502e3241b2f1">xRANPrachConfigTableStruct</a>
+</li>
+<li>nSectorNum
+: <a class="el" href="struct_xran_lib_config.html#aba0c303e021d8d3d08a3f667f2662d9e">XranLibConfig</a>
+</li>
+<li>nSegGenerated
+: <a class="el" href="struct_bbu_io_buf_ctrl_struct.html#af00b094918ddba2073443dcd755141f6">BbuIoBufCtrlStruct</a>
+</li>
+<li>nSegToBeGen
+: <a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a7dc97933eadb8a8049057209c3303818">BbuIoBufCtrlStruct</a>
+</li>
+<li>nSegTransferred
+: <a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a09ab9a2f4541256129428a4ccabc6803">BbuIoBufCtrlStruct</a>
+</li>
+<li>nStartSymb
+: <a class="el" href="structxran__prb__elm.html#a5acab5eec7096fb7732c804f71f02a4d">xran_prb_elm</a>
+</li>
+<li>nSymbolType
+: <a class="el" href="structxran__slot__config.html#a37a7dc4b204c22c2d8b9da9b07abd154">xran_slot_config</a>
+</li>
+<li>nTddPeriod
+: <a class="el" href="struct___runtime_config.html#a53a1d989c6dee827495401b1973c9ef8">_RuntimeConfig</a>
+, <a class="el" href="structxran__frame__config.html#a53a1d989c6dee827495401b1973c9ef8">xran_frame_config</a>
+</li>
+<li>nTimingAdvance
+: <a class="el" href="struct_xran_lib_config.html#a0b246b8022911c0057e473e1fd41efd8">XranLibConfig</a>
+</li>
+<li>nTscTiming
+: <a class="el" href="struct_bbu_xran_io_if_struct.html#a469fc57d9ae37025ca91e2ce34aea812">BbuXranIoIfStruct</a>
+</li>
+<li>nu
+: <a class="el" href="structx_r_a_n_prach_preamble_l_r_a_struct.html#abc78f4868475122608abbdf1e0439b4c">xRANPrachPreambleLRAStruct</a>
+</li>
+<li>nULAbsFrePointA
+: <a class="el" href="struct___runtime_config.html#a6db9b8b082db12b94c9d7b910a2bf747">_RuntimeConfig</a>
+, <a class="el" href="structxran__fh__config.html#a6db9b8b082db12b94c9d7b910a2bf747">xran_fh_config</a>
+</li>
+<li>nULBandwidth
+: <a class="el" href="struct___runtime_config.html#a62e3563effce6c4c7fa25c233f24c855">_RuntimeConfig</a>
+</li>
+<li>nULCenterFreqARFCN
+: <a class="el" href="structxran__fh__config.html#a1fbf2d7a3e30db571b28c7800f38765d">xran_fh_config</a>
+</li>
+<li>nULFftSize
+: <a class="el" href="struct___runtime_config.html#aa531dddfbcecb22e905ed06255f5ce09">_RuntimeConfig</a>
+, <a class="el" href="structxran__fh__config.html#ae4908e70f937e7eca578e348f4e3911f">xran_fh_config</a>
+</li>
+<li>nULRBs
+: <a class="el" href="structxran__fh__config.html#a5448b37ad609bb66bf44b44d1f9bac72">xran_fh_config</a>
+</li>
+<li>num_prbu
+: <a class="el" href="structdata__section__hdr.html#acb00c5e7ebe809fda7288c699eed867c">data_section_hdr</a>
+</li>
+<li>num_sets
+: <a class="el" href="structxran__sectionext5__info.html#a7c4e67772e2e32e2f63f636730bf6eea">xran_sectionext5_info</a>
+</li>
+<li>numAxc
+: <a class="el" href="struct___runtime_config.html#abbeb3b559727e749a5d085c9374e541d">_RuntimeConfig</a>
+</li>
+<li>numberOfUEs
+: <a class="el" href="structxran__cp__radioapp__section6__header.html#adc2b3bf6f7c4208312d35672ab4f1af7">xran_cp_radioapp_section6_header</a>
+</li>
+<li>numCC
+: <a class="el" href="struct___runtime_config.html#aa7579751e13de05edb086914d6122f31">_RuntimeConfig</a>
+</li>
+<li>numLayers
+: <a class="el" href="structxran__cp__radioapp__section__ext3__first.html#a872448d7734f1458ebd601823497a5fa">xran_cp_radioapp_section_ext3_first</a>
+, <a class="el" href="structxran__cp__radioapp__section__ext3__non__first.html#a872448d7734f1458ebd601823497a5fa">xran_cp_radioapp_section_ext3_non_first</a>
+, <a class="el" href="structxran__sectionext3__info.html#a63fd35fb526e104a9e1155da5c9f4a98">xran_sectionext3_info</a>
+</li>
+<li>numOfSections
+: <a class="el" href="structxran__cp__radioapp__common__header.html#a879dd7efae60d48d1c20349a00feee87">xran_cp_radioapp_common_header</a>
+</li>
+<li>numPrbc
+: <a class="el" href="structxran__cp__radioapp__section6.html#aabc4fe26e40f742fd255e2bb8534de75">xran_cp_radioapp_section6</a>
+, <a class="el" href="structxran__cp__radioapp__section__header.html#ae4ab3aebfd71c3b7c6e5e6890c650254">xran_cp_radioapp_section_header</a>
+, <a class="el" href="structxran__prach__cp__config.html#aabc4fe26e40f742fd255e2bb8534de75">xran_prach_cp_config</a>
+, <a class="el" href="structxran__section__info.html#a2b72ddddeff4e4a8a5c191695ec41079">xran_section_info</a>
+</li>
+<li>numRBs
+: <a class="el" href="structxranlib__compress__request.html#a8ab4fa409402862ead0d17e13edeeb62">xranlib_compress_request</a>
+, <a class="el" href="structxranlib__decompress__request.html#a8ab4fa409402862ead0d17e13edeeb62">xranlib_decompress_request</a>
+</li>
+<li>numSections
+: <a class="el" href="structxran__cp__gen__params.html#a52bddd404e766ddb6f2b9eabe15ea5b1">xran_cp_gen_params</a>
+</li>
+<li>numSlots
+: <a class="el" href="struct___runtime_config.html#ae80b6685104e5d649ce7c9e3865b5ac3">_RuntimeConfig</a>
+</li>
+<li>numSymb
+: <a class="el" href="structxran__prb__elm.html#ad2586af82c76901c361a2d08a6ba553b">xran_prb_elm</a>
+</li>
+<li>numSymbol
+: <a class="el" href="structxran__cp__radioapp__section__header.html#a5dc992c6cc64a3f245e5676c0ff12256">xran_cp_radioapp_section_header</a>
+, <a class="el" href="structxran__prach__cp__config.html#a664cb6ca464c69ef60a445fa4f4b3522">xran_prach_cp_config</a>
+, <a class="el" href="structxran__section__info.html#a664cb6ca464c69ef60a445fa4f4b3522">xran_section_info</a>
+</li>
+<li>numUEs
+: <a class="el" href="structxran__cp__header__params.html#a32f1b5994f68c2670b4db46afdd152f1">xran_cp_header_params</a>
+</li>
+<li>numUlAxc
+: <a class="el" href="struct___runtime_config.html#a8bc1b7962f0840749ad1536662177b43">_RuntimeConfig</a>
+</li>
+<li>nXranPort
+: <a class="el" href="structsector_handle_info.html#a6fa55fef5f643eb92ae1f3890bb239d6">sectorHandleInfo</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>