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">
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.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" />
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20 <table cellspacing="0" cellpadding="0">
22 <tr style="height: 56px;">
23 <td id="projectalign" style="padding-left: 0.5em;">
24 <div id="projectname">o-du/phy
26 <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</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');
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
41 initMenu('',true,false,'search.php','Search');
42 $(document).ready(function() { init_search(); });
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)">
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">
60 <div id="nav-path" class="navpath">
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>
67 <a href="#func-members">Functions</a> </div>
68 <div class="headertitle">
69 <div class="title">xran_app_frag.h File Reference</div> </div>
71 <div class="contents">
73 <p>Header file for functions to perform application level fragmentation.
74 <a href="#details">More...</a></p>
75 <div class="textblock"><code>#include <stdint.h></code><br />
76 <code>#include <stdio.h></code><br />
77 <code>#include <rte_config.h></code><br />
78 <code>#include <rte_malloc.h></code><br />
79 <code>#include <rte_memory.h></code><br />
80 <code>#include <rte_mempool.h></code><br />
81 <code>#include <rte_byteorder.h></code><br />
82 <code>#include "<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>"</code><br />
83 <code>#include "<a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>"</code><br />
84 </div><div class="textblock"><div class="dynheader">
85 Include dependency graph for xran_app_frag.h:</div>
86 <div class="dyncontent">
87 <div class="center"><img src="xran__app__frag_8h__incl.png" border="0" usemap="#xran__app__frag_8h" alt=""/></div>
88 <map name="xran__app__frag_8h" id="xran__app__frag_8h">
89 <area shape="rect" id="node9" href="xran__fh__o__du_8h.html" title="This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN-WG..." alt="" coords="665,155,776,181"/>
90 <area shape="rect" id="node22" href="xran__cp__api_8h.html" title="This file provides the definitions for Control Plane Messages APIs. " alt="" coords="1323,80,1425,107"/>
91 <area shape="rect" id="node23" 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="1265,155,1369,181"/>
92 <area shape="rect" id="node24" href="xran__transport_8h.html" title="This file provides the definitions for Transport layer (eCPRI) API. " alt="" coords="1393,155,1509,181"/>
93 <area shape="rect" id="node27" href="xran__pkt_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="1410,229,1493,256"/>
96 </div><div class="textblock"><div class="dynheader">
97 This graph shows which files directly or indirectly include this file:</div>
98 <div class="dyncontent">
99 <div class="center"><img src="xran__app__frag_8h__dep__incl.png" border="0" usemap="#xran__app__frag_8hdep" alt=""/></div>
100 <map name="xran__app__frag_8hdep" id="xran__app__frag_8hdep">
101 <area shape="rect" id="node2" href="xran__app__frag_8c.html" title="xRAN application frgamentation for U-plane packets " alt="" coords="5,80,120,107"/>
102 <area shape="rect" id="node3" href="xran__main_8c.html" title="XRAN main functionality module. " alt="" coords="144,80,237,107"/>
106 <p><a href="xran__app__frag_8h_source.html">Go to the source code of this file.</a></p>
107 <table class="memberdecls">
108 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
109 Functions</h2></td></tr>
110 <tr class="memitem:a601e1216fbace8ea32a97e37df69b129"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__app__frag_8h.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>
111 <tr class="separator:a601e1216fbace8ea32a97e37df69b129"><td class="memSeparator" colspan="2"> </td></tr>
113 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
114 <div class="textblock"><p>Header file for functions to perform application level fragmentation. </p>
115 <dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
117 <p class="definition">Definition in file <a class="el" href="xran__app__frag_8h_source.html">xran_app_frag.h</a>.</p>
118 </div><h2 class="groupheader">Function Documentation</h2>
119 <a id="a601e1216fbace8ea32a97e37df69b129"></a>
120 <h2 class="memtitle"><span class="permalink"><a href="#a601e1216fbace8ea32a97e37df69b129">◆ </a></span>xran_app_fragment_packet()</h2>
122 <div class="memitem">
123 <div class="memproto">
124 <table class="memname">
126 <td class="memname">int32_t xran_app_fragment_packet </td>
128 <td class="paramtype">struct rte_mbuf * </td>
129 <td class="paramname"><em>pkt_in</em>, </td>
132 <td class="paramkey"></td>
134 <td class="paramtype">struct rte_mbuf ** </td>
135 <td class="paramname"><em>pkts_out</em>, </td>
138 <td class="paramkey"></td>
140 <td class="paramtype">uint16_t </td>
141 <td class="paramname"><em>nb_pkts_out</em>, </td>
144 <td class="paramkey"></td>
146 <td class="paramtype">uint16_t </td>
147 <td class="paramname"><em>mtu_size</em>, </td>
150 <td class="paramkey"></td>
152 <td class="paramtype">struct rte_mempool * </td>
153 <td class="paramname"><em>pool_direct</em>, </td>
156 <td class="paramkey"></td>
158 <td class="paramtype">struct rte_mempool * </td>
159 <td class="paramname"><em>pool_indirect</em>, </td>
162 <td class="paramkey"></td>
164 <td class="paramtype">struct <a class="el" href="structxran__section__info.html">xran_section_info</a> * </td>
165 <td class="paramname"><em>sectinfo</em>, </td>
168 <td class="paramkey"></td>
170 <td class="paramtype">uint8_t * </td>
171 <td class="paramname"><em>seqid</em> </td>
179 </div><div class="memdoc">
180 <p>XRAN fragmentation.</p>
181 <p>This function implements the application fragmentation of XRAN packets.</p>
182 <dl class="params"><dt>Parameters</dt><dd>
183 <table class="params">
184 <tr><td class="paramname">pkt_in</td><td>The input packet. </td></tr>
185 <tr><td class="paramname">pkts_out</td><td>Array storing the output fragments. </td></tr>
186 <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>
187 <tr><td class="paramname">pool_direct</td><td>MBUF pool used for allocating direct buffers for the output fragments. </td></tr>
188 <tr><td class="paramname">pool_indirect</td><td>MBUF pool used for allocating indirect buffers for the output fragments. </td></tr>
192 <dl class="section return"><dt>Returns</dt><dd>Upon successful completion - number of output fragments placed in the pkts_out array. Otherwise - (-1) * <errno>. </dd></dl>
194 <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>
198 </div><!-- contents -->
199 <!-- start footer part -->
200 <hr class="footer"/><address class="footer"><small>
201 Generated by  <a href="http://www.doxygen.org/index.html">
202 <img class="footer" src="doxygen.png" alt="doxygen"/>