docs/API/xran__app__frag_8c.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_app_frag.c 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_9fc50806095da30fbd4a2dbe2e456ff5.html">src</a></li>  </ul>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#define-members">Macros</a> &#124;
  68 <a href="#func-members">Functions</a>  </div>
  69   <div class="headertitle">
  70 <div class="title">xran_app_frag.c File Reference</div>  </div>
  71 </div><!--header-->
  72 <div class="contents">
  73
  74 <p>xRAN application frgamentation for U-plane packets
  75 <a href="#details">More...</a></p>
  76 <div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
  77 <code>#include &lt;stddef.h&gt;</code><br />
  78 <code>#include &lt;errno.h&gt;</code><br />
  79 <code>#include &lt;rte_mbuf.h&gt;</code><br />
  80 <code>#include &lt;rte_memcpy.h&gt;</code><br />
  81 <code>#include &lt;rte_mempool.h&gt;</code><br />
  82 <code>#include &lt;rte_debug.h&gt;</code><br />
  83 <code>#include &quot;<a class="el" href="xran__app__frag_8h_source.html">xran_app_frag.h</a>&quot;</code><br />
  84 <code>#include &quot;<a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>&quot;</code><br />
  85 <code>#include &quot;<a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>&quot;</code><br />
  86 <code>#include &quot;<a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>&quot;</code><br />
  87 <code>#include &quot;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&quot;</code><br />
  88 </div><div class="textblock"><div class="dynheader">
  89 Include dependency graph for xran_app_frag.c:</div>
  90 <div class="dyncontent">
  91 <div class="center"><img src="xran__app__frag_8c__incl.png" border="0" usemap="#xran__app__frag_8c" alt=""/></div>
  92 <map name="xran__app__frag_8c" id="xran__app__frag_8c">
  93 <area shape="rect" id="node9" href="xran__app__frag_8h.html" title="Header file for functions to perform application level fragmentation. " alt="" coords="481,80,595,107"/>
  94 <area shape="rect" id="node27" href="xran__cp__api_8h.html" title="This file provides the definitions for Control Plane Messages APIs. " alt="" coords="856,155,959,181"/>
  95 <area shape="rect" id="node33" href="xran__pkt__up_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="1518,155,1622,181"/>
  96 <area shape="rect" id="node34" href="xran__printf_8h.html" title="Modules provide debug prints and utility functions. " alt="" coords="685,229,780,256"/>
  97 <area shape="rect" id="node35" 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="1239,80,1354,107"/>
  98 <area shape="rect" id="node15" 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="551,229,661,256"/>
  99 <area shape="rect" id="node28" 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="855,229,959,256"/>
 100 <area shape="rect" id="node29" href="xran__transport_8h.html" title="This file provides the definitions for Transport layer (eCPRI) API. " alt="" coords="1456,229,1572,256"/>
 101 <area shape="rect" id="node31" href="xran__pkt_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="1379,304,1462,331"/>
 102 </map>
 103 </div>
 104 </div>
 105 <p><a href="xran__app__frag_8c_source.html">Go to the source code of this file.</a></p>
 106 <table class="memberdecls">
 107 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
 108 Macros</h2></td></tr>
 109 <tr class="memitem:a2edabb9c91d40ec79fbebbb2fa0457d0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__app__frag_8c.html#a2edabb9c91d40ec79fbebbb2fa0457d0">XRAN_PAYLOAD_RB_ALIGN</a>&#160;&#160;&#160;(<a class="el" href="xran__common_8h.html#ab97ae0d1cc679c3c40b779b34ab7b4cf">N_SC_PER_PRB</a>*(<a class="el" href="xran__pkt__up_8h.html#a1f562f709cbcc25bce1e2af28e796ff2">IQ_BITS</a>/8)*2)</td></tr>
 110 <tr class="separator:a2edabb9c91d40ec79fbebbb2fa0457d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 </table><table class="memberdecls">
 112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 113 Functions</h2></td></tr>
 114 <tr class="memitem:a601e1216fbace8ea32a97e37df69b129"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__app__frag_8c.html#a601e1216fbace8ea32a97e37df69b129">xran_app_fragment_packet</a> (struct rte_mbuf *pkt_in, struct rte_mbuf **pkts_out, uint16_t nb_pkts_out, uint16_t mtu_size, struct rte_mempool *pool_direct, struct rte_mempool *pool_indirect, struct <a class="el" href="structxran__section__info.html">xran_section_info</a> *sectinfo, uint8_t *seqid)</td></tr>
 115 <tr class="separator:a601e1216fbace8ea32a97e37df69b129"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 </table>
 117 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 118 <div class="textblock"><p>xRAN application frgamentation for U-plane packets </p>
 119 <dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
 120
 121 <p class="definition">Definition in file <a class="el" href="xran__app__frag_8c_source.html">xran_app_frag.c</a>.</p>
 122 </div><h2 class="groupheader">Macro Definition Documentation</h2>
 123 <a id="a2edabb9c91d40ec79fbebbb2fa0457d0"></a>
 124 <h2 class="memtitle"><span class="permalink"><a href="#a2edabb9c91d40ec79fbebbb2fa0457d0">&#9670;&nbsp;</a></span>XRAN_PAYLOAD_RB_ALIGN</h2>
 125
 126 <div class="memitem">
 127 <div class="memproto">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname">#define XRAN_PAYLOAD_RB_ALIGN&#160;&#160;&#160;(<a class="el" href="xran__common_8h.html#ab97ae0d1cc679c3c40b779b34ab7b4cf">N_SC_PER_PRB</a>*(<a class="el" href="xran__pkt__up_8h.html#a1f562f709cbcc25bce1e2af28e796ff2">IQ_BITS</a>/8)*2)</td>
 131         </tr>
 132       </table>
 133 </div><div class="memdoc">
 134 <p>at least 12*4=48 bytes per one RB </p>
 135
 136 <p class="definition">Definition at line <a class="el" href="xran__app__frag_8c_source.html#l00043">43</a> of file <a class="el" href="xran__app__frag_8c_source.html">xran_app_frag.c</a>.</p>
 137
 138 </div>
 139 </div>
 140 <h2 class="groupheader">Function Documentation</h2>
 141 <a id="a601e1216fbace8ea32a97e37df69b129"></a>
 142 <h2 class="memtitle"><span class="permalink"><a href="#a601e1216fbace8ea32a97e37df69b129">&#9670;&nbsp;</a></span>xran_app_fragment_packet()</h2>
 143
 144 <div class="memitem">
 145 <div class="memproto">
 146       <table class="memname">
 147         <tr>
 148           <td class="memname">int32_t xran_app_fragment_packet </td>
 149           <td>(</td>
 150           <td class="paramtype">struct rte_mbuf *&#160;</td>
 151           <td class="paramname"><em>pkt_in</em>, </td>
 152         </tr>
 153         <tr>
 154           <td class="paramkey"></td>
 155           <td></td>
 156           <td class="paramtype">struct rte_mbuf **&#160;</td>
 157           <td class="paramname"><em>pkts_out</em>, </td>
 158         </tr>
 159         <tr>
 160           <td class="paramkey"></td>
 161           <td></td>
 162           <td class="paramtype">uint16_t&#160;</td>
 163           <td class="paramname"><em>nb_pkts_out</em>, </td>
 164         </tr>
 165         <tr>
 166           <td class="paramkey"></td>
 167           <td></td>
 168           <td class="paramtype">uint16_t&#160;</td>
 169           <td class="paramname"><em>mtu_size</em>, </td>
 170         </tr>
 171         <tr>
 172           <td class="paramkey"></td>
 173           <td></td>
 174           <td class="paramtype">struct rte_mempool *&#160;</td>
 175           <td class="paramname"><em>pool_direct</em>, </td>
 176         </tr>
 177         <tr>
 178           <td class="paramkey"></td>
 179           <td></td>
 180           <td class="paramtype">struct rte_mempool *&#160;</td>
 181           <td class="paramname"><em>pool_indirect</em>, </td>
 182         </tr>
 183         <tr>
 184           <td class="paramkey"></td>
 185           <td></td>
 186           <td class="paramtype">struct <a class="el" href="structxran__section__info.html">xran_section_info</a> *&#160;</td>
 187           <td class="paramname"><em>sectinfo</em>, </td>
 188         </tr>
 189         <tr>
 190           <td class="paramkey"></td>
 191           <td></td>
 192           <td class="paramtype">uint8_t *&#160;</td>
 193           <td class="paramname"><em>seqid</em>&#160;</td>
 194         </tr>
 195         <tr>
 196           <td></td>
 197           <td>)</td>
 198           <td></td><td></td>
 199         </tr>
 200       </table>
 201 </div><div class="memdoc">
 202 <p>XRAN fragmentation.</p>
 203 <p>This function implements the application fragmentation of XRAN packets.</p>
 204 <dl class="params"><dt>Parameters</dt><dd>
 205   <table class="params">
 206     <tr><td class="paramname">pkt_in</td><td>The input packet. </td></tr>
 207     <tr><td class="paramname">pkts_out</td><td>Array storing the output fragments. </td></tr>
 208     <tr><td class="paramname">mtu_size</td><td>Size in bytes of the Maximum Transfer Unit (MTU) for the outgoing XRAN datagrams. This value includes the size of the XRAN headers. </td></tr>
 209     <tr><td class="paramname">pool_direct</td><td>MBUF pool used for allocating direct buffers for the output fragments. </td></tr>
 210     <tr><td class="paramname">pool_indirect</td><td>MBUF pool used for allocating indirect buffers for the output fragments. </td></tr>
 211   </table>
 212   </dd>
 213 </dl>
 214 <dl class="section return"><dt>Returns</dt><dd>Upon successful completion - number of output fragments placed in the pkts_out array. Otherwise - (-1) * &lt;errno&gt;. </dd></dl>
 215
 216 <p class="definition">Definition at line <a class="el" href="xran__app__frag_8c_source.html#l00104">104</a> of file <a class="el" href="xran__app__frag_8c_source.html">xran_app_frag.c</a>.</p>
 217
 218 </div>
 219 </div>
 220 </div><!-- contents -->
 221 <!-- start footer part -->
 222 <hr class="footer"/><address class="footer"><small>
 223 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 224 <img class="footer" src="doxygen.png" alt="doxygen"/>
 225 </a> 1.8.13
 226 </small></address>
 227 </body>
 228 </html>