docs/API/xran__pkt__up_8h.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_pkt_up.h File Reference</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_7b477aa413287cfa2199e983b77d66dd.html">api</a></li>  </ul>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#nested-classes">Data Structures</a> &#124;
  68 <a href="#define-members">Macros</a> &#124;
  69 <a href="#var-members">Variables</a>  </div>
  70   <div class="headertitle">
  71 <div class="title">xran_pkt_up.h File Reference</div>  </div>
  72 </div><!--header-->
  73 <div class="contents">
  74
  75 <p>Definitions and support functions to process XRAN packet.
  76 <a href="#details">More...</a></p>
  77 <div class="textblock"><code>#include &quot;<a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>&quot;</code><br />
  78 </div><div class="textblock"><div class="dynheader">
  79 Include dependency graph for xran_pkt_up.h:</div>
  80 <div class="dyncontent">
  81 <div class="center"><img src="xran__pkt__up_8h__incl.png" border="0" usemap="#xran__pkt__up_8h" alt=""/></div>
  82 <map name="xran__pkt__up_8h" id="xran__pkt__up_8h">
  83 <area shape="rect" id="node2" href="xran__pkt_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="135,80,218,107"/>
  84 </map>
  85 </div>
  86 </div><div class="textblock"><div class="dynheader">
  87 This graph shows which files directly or indirectly include this file:</div>
  88 <div class="dyncontent">
  89 <div class="center"><img src="xran__pkt__up_8h__dep__incl.png" border="0" usemap="#xran__pkt__up_8hdep" alt=""/></div>
  90 <map name="xran__pkt__up_8hdep" id="xran__pkt__up_8hdep">
  91 <area shape="rect" id="node2" href="common_8h.html" title="common.h" alt="" coords="163,80,246,107"/>
  92 <area shape="rect" id="node3" href="common_8c.html" title="common.c" alt="" coords="221,155,303,181"/>
  93 <area shape="rect" id="node6" href="xran__up__api_8h.html" title="This file provides the definitions for User Plane Messages APIs. " alt="" coords="551,80,653,107"/>
  94 <area shape="rect" id="node7" href="xran__common_8c.html" title="XRAN layer common functionality for both O&#45;DU and O&#45;RU as well as C&#45;plane and U&#45;plane. " alt="" coords="455,155,570,181"/>
  95 <area shape="rect" id="node12" href="xran__app__frag_8c.html" title="xRAN application frgamentation for U&#45;plane packets " alt="" coords="1025,155,1139,181"/>
  96 <area shape="rect" id="node13" 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="1431,80,1546,107"/>
  97 <area shape="rect" id="node4" href="config_8c.html" title="config.c" alt="" coords="5,155,73,181"/>
  98 <area shape="rect" id="node5" href="sample-app_8c.html" title="sample&#45;app.c" alt="" coords="97,155,197,181"/>
  99 <area shape="rect" id="node8" href="xran__main_8c.html" title="XRAN main functionality module. " alt="" coords="594,155,687,181"/>
 100 <area shape="rect" id="node9" href="xran__transport_8c.html" title="This file provides the implementation for Transport lyaer (eCPRI) API. " alt="" coords="712,155,828,181"/>
 101 <area shape="rect" id="node10" href="xran__up__api_8c.html" title="This file provides the implementation of User Plane Messages APIs. " alt="" coords="328,155,431,181"/>
 102 <area shape="rect" id="node11" href="u__plane__functional_8cc.html" title="u_plane_functional.cc" alt="" coords="852,155,1000,181"/>
 103 <area shape="rect" id="node14" href="xran__cp__api_8c.html" title="This file provides the API functions to build Control Plane Messages for XRAN Front Haul layer as def..." alt="" coords="1685,155,1788,181"/>
 104 <area shape="rect" id="node15" href="xran__timer_8c.html" title="This file provides implementation to Timing for XRAN. " alt="" coords="1812,155,1907,181"/>
 105 <area shape="rect" id="node16" href="xran__ul__tables_8c.html" title="This file defines those table used in 5G NR spec. " alt="" coords="1931,155,2049,181"/>
 106 <area shape="rect" id="node17" href="xran__lib__wrap_8hpp.html" title="xran_lib_wrap.hpp" alt="" coords="2124,155,2251,181"/>
 107 <area shape="rect" id="node19" href="c__plane__tests_8cc.html" title="c_plane_tests.cc" alt="" coords="1895,229,2016,256"/>
 108 <area shape="rect" id="node20" href="chain__tests_8cc.html" title="chain_tests.cc" alt="" coords="2235,229,2342,256"/>
 109 <area shape="rect" id="node21" href="init__sys__functional_8cc.html" title="init_sys_functional.cc" alt="" coords="2367,229,2515,256"/>
 110 <area shape="rect" id="node22" href="prach__functional_8cc.html" title="prach_functional.cc" alt="" coords="1164,155,1299,181"/>
 111 <area shape="rect" id="node23" href="prach__performance_8cc.html" title="prach_performance.cc" alt="" coords="1323,155,1473,181"/>
 112 <area shape="rect" id="node24" href="u__plane__performance_8cc.html" title="u_plane_performance.cc" alt="" coords="1497,155,1661,181"/>
 113 <area shape="rect" id="node18" href="xranlib__unit__test__main_8cc.html" title="xranlib_unit_test_main.cc" alt="" coords="2041,229,2211,256"/>
 114 </map>
 115 </div>
 116 </div>
 117 <p><a href="xran__pkt__up_8h_source.html">Go to the source code of this file.</a></p>
 118 <table class="memberdecls">
 119 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 120 Data Structures</h2></td></tr>
 121 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__section__hdr.html">data_section_hdr</a></td></tr>
 122 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__section__compression__hdr.html">data_section_compression_hdr</a></td></tr>
 124 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unioncompression__params.html">compression_params</a></td></tr>
 126 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__params_1_1block__fl__point.html">compression_params::block_fl_point</a></td></tr>
 128 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__params_1_1block__scaling.html">compression_params::block_scaling</a></td></tr>
 130 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__params_1_1u__law.html">compression_params::u_law</a></td></tr>
 132 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrb__map.html">rb_map</a></td></tr>
 134 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__hdr.html">xran_up_pkt_hdr</a></td></tr>
 136 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeth__xran__up__pkt__hdr.html">eth_xran_up_pkt_hdr</a></td></tr>
 138 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 </table><table class="memberdecls">
 140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
 141 Macros</h2></td></tr>
 142 <tr class="memitem:af6647a7b572e3c757fb834c22c06c757"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt__up_8h.html#af6647a7b572e3c757fb834c22c06c757">IQ_PAIR_NUM_IN_RB</a>&#160;&#160;&#160;12</td></tr>
 143 <tr class="separator:af6647a7b572e3c757fb834c22c06c757"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a886c66796fb86299692ed3629a12ed56"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt__up_8h.html#a886c66796fb86299692ed3629a12ed56">MAX_DATA_SECTIONS_NUM</a>&#160;&#160;&#160;273</td></tr>
 145 <tr class="separator:a886c66796fb86299692ed3629a12ed56"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:a863f0b79c08ef7f3431b7d13656fea74"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt__up_8h.html#a863f0b79c08ef7f3431b7d13656fea74">MAX_IQ_BIT_WIDTH</a>&#160;&#160;&#160;16</td></tr>
 147 <tr class="separator:a863f0b79c08ef7f3431b7d13656fea74"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:a1f562f709cbcc25bce1e2af28e796ff2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt__up_8h.html#a1f562f709cbcc25bce1e2af28e796ff2">IQ_BITS</a>&#160;&#160;&#160;<a class="el" href="xran__pkt__up_8h.html#a863f0b79c08ef7f3431b7d13656fea74">MAX_IQ_BIT_WIDTH</a></td></tr>
 149 <tr class="separator:a1f562f709cbcc25bce1e2af28e796ff2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table><table class="memberdecls">
 151 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
 152 Variables</h2></td></tr>
 153 <tr class="memitem:ga303c201bb1ad2f72aa29dd1375efaf72"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structdata__section__hdr.html">data_section_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xran__up__pkt.html#ga303c201bb1ad2f72aa29dd1375efaf72">__rte_packed</a></td></tr>
 154 <tr class="separator:ga303c201bb1ad2f72aa29dd1375efaf72"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 </table>
 156 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 157 <div class="textblock"><p>Definitions and support functions to process XRAN packet. </p>
 158 <dl class="section author"><dt>Author</dt><dd>Intel Corporation</dd></dl>
 159
 160 <p class="definition">Definition in file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
 161 </div><h2 class="groupheader">Macro Definition Documentation</h2>
 162 <a id="a1f562f709cbcc25bce1e2af28e796ff2"></a>
 163 <h2 class="memtitle"><span class="permalink"><a href="#a1f562f709cbcc25bce1e2af28e796ff2">&#9670;&nbsp;</a></span>IQ_BITS</h2>
 164
 165 <div class="memitem">
 166 <div class="memproto">
 167       <table class="memname">
 168         <tr>
 169           <td class="memname">#define IQ_BITS&#160;&#160;&#160;<a class="el" href="xran__pkt__up_8h.html#a863f0b79c08ef7f3431b7d13656fea74">MAX_IQ_BIT_WIDTH</a></td>
 170         </tr>
 171       </table>
 172 </div><div class="memdoc">
 173
 174 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00050">50</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
 175
 176 </div>
 177 </div>
 178 <a id="af6647a7b572e3c757fb834c22c06c757"></a>
 179 <h2 class="memtitle"><span class="permalink"><a href="#af6647a7b572e3c757fb834c22c06c757">&#9670;&nbsp;</a></span>IQ_PAIR_NUM_IN_RB</h2>
 180
 181 <div class="memitem">
 182 <div class="memproto">
 183       <table class="memname">
 184         <tr>
 185           <td class="memname">#define IQ_PAIR_NUM_IN_RB&#160;&#160;&#160;12</td>
 186         </tr>
 187       </table>
 188 </div><div class="memdoc">
 189
 190 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00045">45</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
 191
 192 </div>
 193 </div>
 194 <a id="a886c66796fb86299692ed3629a12ed56"></a>
 195 <h2 class="memtitle"><span class="permalink"><a href="#a886c66796fb86299692ed3629a12ed56">&#9670;&nbsp;</a></span>MAX_DATA_SECTIONS_NUM</h2>
 196
 197 <div class="memitem">
 198 <div class="memproto">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname">#define MAX_DATA_SECTIONS_NUM&#160;&#160;&#160;273</td>
 202         </tr>
 203       </table>
 204 </div><div class="memdoc">
 205
 206 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00046">46</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
 207
 208 </div>
 209 </div>
 210 <a id="a863f0b79c08ef7f3431b7d13656fea74"></a>
 211 <h2 class="memtitle"><span class="permalink"><a href="#a863f0b79c08ef7f3431b7d13656fea74">&#9670;&nbsp;</a></span>MAX_IQ_BIT_WIDTH</h2>
 212
 213 <div class="memitem">
 214 <div class="memproto">
 215       <table class="memname">
 216         <tr>
 217           <td class="memname">#define MAX_IQ_BIT_WIDTH&#160;&#160;&#160;16</td>
 218         </tr>
 219       </table>
 220 </div><div class="memdoc">
 221
 222 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00047">47</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
 223
 224 </div>
 225 </div>
 226 </div><!-- contents -->
 227 <!-- start footer part -->
 228 <hr class="footer"/><address class="footer"><small>
 229 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 230 <img class="footer" src="doxygen.png" alt="doxygen"/>
 231 </a> 1.8.13
 232 </small></address>
 233 </body>
 234 </html>