--- /dev/null
+<!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: xran_app_frag.c File Reference</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>
+<!-- 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 id="nav-path" class="navpath">
+ <ul>
+<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>
+</div>
+</div><!-- top -->
+<div class="header">
+ <div class="summary">
+<a href="#define-members">Macros</a> |
+<a href="#func-members">Functions</a> </div>
+ <div class="headertitle">
+<div class="title">xran_app_frag.c File Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p>xRAN application frgamentation for U-plane packets
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include <stdio.h></code><br />
+<code>#include <stddef.h></code><br />
+<code>#include <errno.h></code><br />
+<code>#include <rte_mbuf.h></code><br />
+<code>#include <rte_memcpy.h></code><br />
+<code>#include <rte_mempool.h></code><br />
+<code>#include <rte_debug.h></code><br />
+<code>#include "<a class="el" href="xran__app__frag_8h_source.html">xran_app_frag.h</a>"</code><br />
+<code>#include "<a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>"</code><br />
+<code>#include "<a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>"</code><br />
+<code>#include "<a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>"</code><br />
+<code>#include "<a class="el" href="xran__common_8h_source.html">xran_common.h</a>"</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for xran_app_frag.c:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__app__frag_8c__incl.png" border="0" usemap="#xran__app__frag_8c" alt=""/></div>
+<map name="xran__app__frag_8c" id="xran__app__frag_8c">
+<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"/>
+<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"/>
+<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"/>
+<area shape="rect" id="node34" href="xran__printf_8h.html" title="Modules provide debug prints and utility functions. " alt="" coords="685,229,780,256"/>
+<area shape="rect" id="node35" href="xran__common_8h.html" title="XRAN layer common functionality for both lls-CU and RU as well as C-plane and U-plane. " alt="" coords="1239,80,1354,107"/>
+<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-WG..." alt="" coords="551,229,661,256"/>
+<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"/>
+<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"/>
+<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"/>
+</map>
+</div>
+</div>
+<p><a href="xran__app__frag_8c_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
+Macros</h2></td></tr>
+<tr class="memitem:a2edabb9c91d40ec79fbebbb2fa0457d0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__app__frag_8c.html#a2edabb9c91d40ec79fbebbb2fa0457d0">XRAN_PAYLOAD_RB_ALIGN</a>   (<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>
+<tr class="separator:a2edabb9c91d40ec79fbebbb2fa0457d0"><td class="memSeparator" colspan="2"> </td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<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_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>
+<tr class="separator:a601e1216fbace8ea32a97e37df69b129"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>xRAN application frgamentation for U-plane packets </p>
+<dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
+
+<p class="definition">Definition in file <a class="el" href="xran__app__frag_8c_source.html">xran_app_frag.c</a>.</p>
+</div><h2 class="groupheader">Macro Definition Documentation</h2>
+<a id="a2edabb9c91d40ec79fbebbb2fa0457d0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2edabb9c91d40ec79fbebbb2fa0457d0">◆ </a></span>XRAN_PAYLOAD_RB_ALIGN</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">#define XRAN_PAYLOAD_RB_ALIGN   (<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>
+ </table>
+</div><div class="memdoc">
+<p>at least 12*4=48 bytes per one RB </p>
+
+<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>
+
+</div>
+</div>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="a601e1216fbace8ea32a97e37df69b129"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a601e1216fbace8ea32a97e37df69b129">◆ </a></span>xran_app_fragment_packet()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int32_t xran_app_fragment_packet </td>
+ <td>(</td>
+ <td class="paramtype">struct rte_mbuf * </td>
+ <td class="paramname"><em>pkt_in</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">struct rte_mbuf ** </td>
+ <td class="paramname"><em>pkts_out</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint16_t </td>
+ <td class="paramname"><em>nb_pkts_out</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint16_t </td>
+ <td class="paramname"><em>mtu_size</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">struct rte_mempool * </td>
+ <td class="paramname"><em>pool_direct</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">struct rte_mempool * </td>
+ <td class="paramname"><em>pool_indirect</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">struct <a class="el" href="structxran__section__info.html">xran_section_info</a> * </td>
+ <td class="paramname"><em>sectinfo</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>seqid</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>XRAN fragmentation.</p>
+<p>This function implements the application fragmentation of XRAN packets.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">pkt_in</td><td>The input packet. </td></tr>
+ <tr><td class="paramname">pkts_out</td><td>Array storing the output fragments. </td></tr>
+ <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>
+ <tr><td class="paramname">pool_direct</td><td>MBUF pool used for allocating direct buffers for the output fragments. </td></tr>
+ <tr><td class="paramname">pool_indirect</td><td>MBUF pool used for allocating indirect buffers for the output fragments. </td></tr>
+ </table>
+ </dd>
+</dl>
+<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>
+
+<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>
+
+</div>
+</div>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>
Code Review / o-du / phy.git / blobdiff