docs/API/xran__frame__struct_8h_source.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.13"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>o-du/phy: xran_frame_struct.h Source File</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="search/searchdata.js"></script>
  14 <script type="text/javascript" src="search/search.js"></script>
  15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16 </head>
  17 <body>
  18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19 <div id="titlearea">
  20 <table cellspacing="0" cellpadding="0">
  21  <tbody>
  22  <tr style="height: 56px;">
  23   <td id="projectalign" style="padding-left: 0.5em;">
  24    <div id="projectname">o-du/phy
  25    </div>
  26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.13 -->
  34 <script type="text/javascript">
  35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36 </script>
  37 <script type="text/javascript" src="menudata.js"></script>
  38 <script type="text/javascript" src="menu.js"></script>
  39 <script type="text/javascript">
  40 $(function() {
  41   initMenu('',true,false,'search.php','Search');
  42   $(document).ready(function() { init_search(); });
  43 });
  44 </script>
  45 <div id="main-nav"></div>
  46 <!-- window showing the filter options -->
  47 <div id="MSearchSelectWindow"
  48      onmouseover="return searchBox.OnSearchSelectShow()"
  49      onmouseout="return searchBox.OnSearchSelectHide()"
  50      onkeydown="return searchBox.OnSearchSelectKey(event)">
  51 </div>
  52
  53 <!-- iframe showing the search results (closed by default) -->
  54 <div id="MSearchResultsWindow">
  55 <iframe src="javascript:void(0)" frameborder="0"
  56         name="MSearchResults" id="MSearchResults">
  57 </iframe>
  58 </div>
  59
  60 <div id="nav-path" class="navpath">
  61   <ul>
  62 <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>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="headertitle">
  67 <div class="title">xran_frame_struct.h</div>  </div>
  68 </div><!--header-->
  69 <div class="contents">
  70 <a href="xran__frame__struct_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">*   Copyright (c) 2019 Intel.</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">*   Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">*   you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">*   You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">*       http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">*   Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">*   distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">*   See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*   limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">*******************************************************************************/</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#ifndef _XRAN_FRAME_STRUCT_</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#define _XRAN_FRAME_STRUCT_</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="xran__fh__o__du_8h.html">xran_fh_o_du.h</a>&quot;</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;uint32_t <a class="code" href="xran__frame__struct_8h.html#a8e8598556da3e49fa48cb646c24162fa">xran_fs_get_tti_interval</a>(uint8_t nMu);</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;uint32_t <a class="code" href="xran__frame__struct_8h.html#a358977362c5bc0e3adc9f897994c0d09">xran_fs_get_scs</a>(uint8_t nMu);</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">//-------------------------------------------------------------------------------------------</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"></span><span class="comment">//-------------------------------------------------------------------------------------------</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;uint16_t <a class="code" href="xran__frame__struct_8h.html#adef530f5f3ebc94606c692d8784ddaf2">xran_fs_get_num_rbs</a>(uint32_t nNumerology, uint32_t nBandwidth, uint32_t nAbsFrePointA);</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">//-------------------------------------------------------------------------------------------</span></div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"></span><span class="comment">//-------------------------------------------------------------------------------------------</span></div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;uint32_t <a class="code" href="xran__frame__struct_8h.html#acc4fa9a039885a36bec7d1f6b68de1b0">xran_fs_cal_nrarfcn</a>(uint32_t nCenterFreq);</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;int32_t <a class="code" href="xran__frame__struct_8h.html#a2dae6c563c553fcc13a9cd3c87b9f37b">xran_fs_slot_limit</a>(int32_t nSlotIdx);</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keywordtype">void</span> <a class="code" href="xran__frame__struct_8h.html#a74a51cc251882612b53feb4895bcab61">xran_fs_clear_slot_type</a>(uint32_t nCcId);</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;int32_t <a class="code" href="xran__frame__struct_8h.html#a93baa96226b7790c8db4942f304269fc">xran_fs_set_slot_type</a>(uint32_t nCcId, uint32_t nFrameDuplexType, uint32_t nTddPeriod, <span class="keyword">struct</span> <a class="code" href="structxran__slot__config.html">xran_slot_config</a>* psSlotConfig);</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;int32_t <a class="code" href="xran__frame__struct_8h.html#a9cc99d80a722f6afd2aaf6c6bd2e8887">xran_fs_get_slot_type</a>(int32_t nCcId, int32_t nSlotIdx, int32_t nType);</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;uint32_t <a class="code" href="xran__frame__struct_8h.html#a2fd9b68ce2fa4734a021203b320e4e04">xran_fs_slot_limit_init</a>(int32_t tti_interval_us);</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;uint32_t <a class="code" href="xran__frame__struct_8h.html#a7f5a87395d3930f222e58976960c99e2">xran_fs_get_max_slot</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;uint32_t <a class="code" href="xran__frame__struct_8h.html#a00aa0f7cc00a6ca9cde2bec43eb1c9f9">xran_fs_get_max_slot_SFN</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;int32_t <a class="code" href="xran__frame__struct_8h.html#a3ad2b8ea8fe3559ce6d0195ed25dca11">xran_fs_get_symbol_type</a>(int32_t nCellIdx, int32_t nSlotdx,  int32_t nSymbIdx);</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;}</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _XRAN_FRAME_STRUCT_ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div><div class="ttc" id="xran__frame__struct_8h_html_a7f5a87395d3930f222e58976960c99e2"><div class="ttname"><a href="xran__frame__struct_8h.html#a7f5a87395d3930f222e58976960c99e2">xran_fs_get_max_slot</a></div><div class="ttdeci">uint32_t xran_fs_get_max_slot(void)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00316">xran_frame_struct.c:316</a></div></div>
  71 <div class="ttc" id="xran__frame__struct_8h_html_a74a51cc251882612b53feb4895bcab61"><div class="ttname"><a href="xran__frame__struct_8h.html#a74a51cc251882612b53feb4895bcab61">xran_fs_clear_slot_type</a></div><div class="ttdeci">void xran_fs_clear_slot_type(uint32_t nCcId)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00339">xran_frame_struct.c:339</a></div></div>
  72 <div class="ttc" id="xran__frame__struct_8h_html_a93baa96226b7790c8db4942f304269fc"><div class="ttname"><a href="xran__frame__struct_8h.html#a93baa96226b7790c8db4942f304269fc">xran_fs_set_slot_type</a></div><div class="ttdeci">int32_t xran_fs_set_slot_type(uint32_t nCcId, uint32_t nFrameDuplexType, uint32_t nTddPeriod, struct xran_slot_config *psSlotConfig)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00346">xran_frame_struct.c:346</a></div></div>
  73 <div class="ttc" id="xran__frame__struct_8h_html_a8e8598556da3e49fa48cb646c24162fa"><div class="ttname"><a href="xran__frame__struct_8h.html#a8e8598556da3e49fa48cb646c24162fa">xran_fs_get_tti_interval</a></div><div class="ttdeci">uint32_t xran_fs_get_tti_interval(uint8_t nMu)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00108">xran_frame_struct.c:108</a></div></div>
  74 <div class="ttc" id="xran__frame__struct_8h_html_a2fd9b68ce2fa4734a021203b320e4e04"><div class="ttname"><a href="xran__frame__struct_8h.html#a2fd9b68ce2fa4734a021203b320e4e04">xran_fs_slot_limit_init</a></div><div class="ttdeci">uint32_t xran_fs_slot_limit_init(int32_t tti_interval_us)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00309">xran_frame_struct.c:309</a></div></div>
  75 <div class="ttc" id="xran__frame__struct_8h_html_a00aa0f7cc00a6ca9cde2bec43eb1c9f9"><div class="ttname"><a href="xran__frame__struct_8h.html#a00aa0f7cc00a6ca9cde2bec43eb1c9f9">xran_fs_get_max_slot_SFN</a></div><div class="ttdeci">uint32_t xran_fs_get_max_slot_SFN(void)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00321">xran_frame_struct.c:321</a></div></div>
  76 <div class="ttc" id="xran__frame__struct_8h_html_acc4fa9a039885a36bec7d1f6b68de1b0"><div class="ttname"><a href="xran__frame__struct_8h.html#acc4fa9a039885a36bec7d1f6b68de1b0">xran_fs_cal_nrarfcn</a></div><div class="ttdeci">uint32_t xran_fs_cal_nrarfcn(uint32_t nCenterFreq)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00274">xran_frame_struct.c:274</a></div></div>
  77 <div class="ttc" id="xran__frame__struct_8h_html_a9cc99d80a722f6afd2aaf6c6bd2e8887"><div class="ttname"><a href="xran__frame__struct_8h.html#a9cc99d80a722f6afd2aaf6c6bd2e8887">xran_fs_get_slot_type</a></div><div class="ttdeci">int32_t xran_fs_get_slot_type(int32_t nCcId, int32_t nSlotIdx, int32_t nType)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00477">xran_frame_struct.c:477</a></div></div>
  78 <div class="ttc" id="xran__frame__struct_8h_html_a2dae6c563c553fcc13a9cd3c87b9f37b"><div class="ttname"><a href="xran__frame__struct_8h.html#a2dae6c563c553fcc13a9cd3c87b9f37b">xran_fs_slot_limit</a></div><div class="ttdeci">int32_t xran_fs_slot_limit(int32_t nSlotIdx)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00326">xran_frame_struct.c:326</a></div></div>
  79 <div class="ttc" id="xran__fh__o__du_8h_html"><div class="ttname"><a href="xran__fh__o__du_8h.html">xran_fh_o_du.h</a></div><div class="ttdoc">This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN-WG...</div></div>
  80 <div class="ttc" id="xran__frame__struct_8h_html_adef530f5f3ebc94606c692d8784ddaf2"><div class="ttname"><a href="xran__frame__struct_8h.html#adef530f5f3ebc94606c692d8784ddaf2">xran_fs_get_num_rbs</a></div><div class="ttdeci">uint16_t xran_fs_get_num_rbs(uint32_t nNumerology, uint32_t nBandwidth, uint32_t nAbsFrePointA)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00149">xran_frame_struct.c:149</a></div></div>
  81 <div class="ttc" id="xran__frame__struct_8h_html_a3ad2b8ea8fe3559ce6d0195ed25dca11"><div class="ttname"><a href="xran__frame__struct_8h.html#a3ad2b8ea8fe3559ce6d0195ed25dca11">xran_fs_get_symbol_type</a></div><div class="ttdeci">int32_t xran_fs_get_symbol_type(int32_t nCellIdx, int32_t nSlotdx, int32_t nSymbIdx)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00508">xran_frame_struct.c:508</a></div></div>
  82 <div class="ttc" id="structxran__slot__config_html"><div class="ttname"><a href="structxran__slot__config.html">xran_slot_config</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__fh__o__du_8h_source.html#l00453">xran_fh_o_du.h:453</a></div></div>
  83 <div class="ttc" id="xran__frame__struct_8h_html_a358977362c5bc0e3adc9f897994c0d09"><div class="ttname"><a href="xran__frame__struct_8h.html#a358977362c5bc0e3adc9f897994c0d09">xran_fs_get_scs</a></div><div class="ttdeci">uint32_t xran_fs_get_scs(uint8_t nMu)</div><div class="ttdef"><b>Definition:</b> <a href="xran__frame__struct_8c_source.html#l00121">xran_frame_struct.c:121</a></div></div>
  84 </div><!-- fragment --></div><!-- contents -->
  85 <!-- start footer part -->
  86 <hr class="footer"/><address class="footer"><small>
  87 Generated by &#160;<a href="http://www.doxygen.org/index.html">
  88 <img class="footer" src="doxygen.png" alt="doxygen"/>
  89 </a> 1.8.13
  90 </small></address>
  91 </body>
  92 </html>