--- /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_up_api.h 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_7b477aa413287cfa2199e983b77d66dd.html">api</a></li> </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+ <div class="summary">
+<a href="#nested-classes">Data Structures</a> |
+<a href="#func-members">Functions</a> </div>
+ <div class="headertitle">
+<div class="title">xran_up_api.h File Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This file provides the definitions for User Plane Messages APIs.
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include <rte_common.h></code><br />
+<code>#include <rte_mbuf.h></code><br />
+<code>#include "<a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>"</code><br />
+<code>#include "<a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>"</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for xran_up_api.h:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__up__api_8h__incl.png" border="0" usemap="#xran__up__api_8h" alt=""/></div>
+<map name="xran__up__api_8h" id="xran__up__api_8h">
+<area shape="rect" id="node4" href="xran__pkt_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="166,155,249,181"/>
+<area shape="rect" id="node7" href="xran__pkt__up_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="245,80,349,107"/>
+</map>
+</div>
+</div><div class="textblock"><div class="dynheader">
+This graph shows which files directly or indirectly include this file:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__up__api_8h__dep__incl.png" border="0" usemap="#xran__up__api_8hdep" alt=""/></div>
+<map name="xran__up__api_8hdep" id="xran__up__api_8hdep">
+<area shape="rect" id="node2" href="common_8c.html" title="common.c" alt="" coords="5,80,88,107"/>
+<area shape="rect" id="node3" href="xran__common_8c.html" title="XRAN layer common functionality for both O-DU and O-RU as well as C-plane and U-plane. " alt="" coords="112,80,227,107"/>
+<area shape="rect" id="node4" href="xran__main_8c.html" title="XRAN main functionality module. " alt="" coords="251,80,344,107"/>
+<area shape="rect" id="node5" href="xran__transport_8c.html" title="This file provides the implementation for Transport lyaer (eCPRI) API. " alt="" coords="369,80,485,107"/>
+<area shape="rect" id="node6" href="xran__up__api_8c.html" title="This file provides the implementation of User Plane Messages APIs. " alt="" coords="509,80,611,107"/>
+<area shape="rect" id="node7" href="u__plane__functional_8cc.html" title="u_plane_functional.cc" alt="" coords="635,80,783,107"/>
+</map>
+</div>
+</div>
+<p><a href="xran__up__api_8h_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="nested-classes"></a>
+Data Structures</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__gen__params.html">xran_up_pkt_gen_params</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__gen__no__compression__params.html">xran_up_pkt_gen_no_compression_params</a></td></tr>
+<tr class="separator:"><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:adfc5ea408600c8de1384be020b359d95"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__up__api_8h.html#adfc5ea408600c8de1384be020b359d95">xran_extract_iq_samples</a> (struct rte_mbuf *mbuf, void **iq_data_start, uint8_t *CC_ID, uint8_t *Ant_ID, uint8_t *frame_id, uint8_t *subframe_id, uint8_t *slot_id, uint8_t *symb_id, struct <a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a> *seq_id, uint16_t *num_prbu, uint16_t *start_prbu, uint16_t *sym_inc, uint16_t *<a class="el" href="xran__pkt__cp_8h.html#affa3adbd50cd4af2018ba1fc0e8c3e31">rb</a>, uint16_t *sect_id, int8_t expect_comp, uint8_t *compMeth, uint8_t *iqWidth)</td></tr>
+<tr class="memdesc:adfc5ea408600c8de1384be020b359d95"><td class="mdescLeft"> </td><td class="mdescRight">Function extracts IQ samples from received mbuf packet. <a href="#adfc5ea408600c8de1384be020b359d95">More...</a><br /></td></tr>
+<tr class="separator:adfc5ea408600c8de1384be020b359d95"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:acd8f547b98d7ebd7dbc41c486a26505d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__up__api_8h.html#acd8f547b98d7ebd7dbc41c486a26505d">xran_prepare_iq_symbol_portion</a> (struct rte_mbuf *mbuf, const void *iq_data_start, const enum <a class="el" href="xran__fh__o__du_8h.html#ab5ce6839bae2968c79930a0bfa17f4d8">xran_input_byte_order</a> iq_buf_byte_order, const uint32_t iq_data_num_bytes, struct <a class="el" href="structxran__up__pkt__gen__params.html">xran_up_pkt_gen_params</a> *params, uint8_t CC_ID, uint8_t Ant_ID, uint8_t seq_id, uint32_t do_copy)</td></tr>
+<tr class="memdesc:acd8f547b98d7ebd7dbc41c486a26505d"><td class="mdescLeft"> </td><td class="mdescRight">Function for starting preparion of IQ samples portions to be sent in xRAN packet. <a href="#acd8f547b98d7ebd7dbc41c486a26505d">More...</a><br /></td></tr>
+<tr class="separator:acd8f547b98d7ebd7dbc41c486a26505d"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>This file provides the definitions for User Plane Messages APIs. </p>
+<dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
+
+<p class="definition">Definition in file <a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a>.</p>
+</div><h2 class="groupheader">Function Documentation</h2>
+<a id="adfc5ea408600c8de1384be020b359d95"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#adfc5ea408600c8de1384be020b359d95">◆ </a></span>xran_extract_iq_samples()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int32_t xran_extract_iq_samples </td>
+ <td>(</td>
+ <td class="paramtype">struct rte_mbuf * </td>
+ <td class="paramname"><em>mbuf</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">void ** </td>
+ <td class="paramname"><em>iq_data_start</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>CC_ID</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>Ant_ID</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>frame_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>subframe_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>slot_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>symb_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">struct <a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a> * </td>
+ <td class="paramname"><em>seq_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint16_t * </td>
+ <td class="paramname"><em>num_prbu</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint16_t * </td>
+ <td class="paramname"><em>start_prbu</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint16_t * </td>
+ <td class="paramname"><em>sym_inc</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint16_t * </td>
+ <td class="paramname"><em>rb</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint16_t * </td>
+ <td class="paramname"><em>sect_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int8_t </td>
+ <td class="paramname"><em>expect_comp</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>compMeth</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>iqWidth</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Function extracts IQ samples from received mbuf packet. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">mbuf</td><td>Packet with received data. </td></tr>
+ <tr><td class="paramname">iq_data_start</td><td>Address of the first IQ sample in mbuf will be returned here </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>int Bytes of IQ samples that have been extracted from mbuf.</dd></dl>
+<p>Function extracts IQ samples from received mbuf packet.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">iq_data_start</td><td>Address of the first element in IQ data array. </td></tr>
+ <tr><td class="paramname">symb_id</td><td>Symbol ID to be extracted from ecpri header </td></tr>
+ <tr><td class="paramname">seq_id</td><td>Sequence ID to be extracted from radio header </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>int Size of remaining mbuf filled with IQ samples zero on failure </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="xran__up__api_8c_source.html#l00327">327</a> of file <a class="el" href="xran__up__api_8c_source.html">xran_up_api.c</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__up__api_8h_adfc5ea408600c8de1384be020b359d95_cgraph.png" border="0" usemap="#xran__up__api_8h_adfc5ea408600c8de1384be020b359d95_cgraph" alt=""/></div>
+<map name="xran__up__api_8h_adfc5ea408600c8de1384be020b359d95_cgraph" id="xran__up__api_8h_adfc5ea408600c8de1384be020b359d95_cgraph">
+<area shape="rect" id="node2" href="xran__transport_8h.html#ab08a85b6527f45a9ba22d25061a96a3c" title="Decompose ecpriRtcid/ecpriPcid. " alt="" coords="220,5,365,32"/>
+<area shape="rect" id="node3" href="xran__common_8h.html#a761e3947dcc547008a12a9cca10b1ea0" title="Get the configuration of eAxC ID. " alt="" coords="413,5,557,32"/>
+<area shape="rect" id="node4" href="xran__main_8c.html#aa09e72e94d2a1d891e86f4c09b0f8b21" title="xran_dev_get_ctx" alt="" coords="605,5,731,32"/>
+</map>
+</div>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__up__api_8h_adfc5ea408600c8de1384be020b359d95_icgraph.png" border="0" usemap="#xran__up__api_8h_adfc5ea408600c8de1384be020b359d95_icgraph" alt=""/></div>
+<map name="xran__up__api_8h_adfc5ea408600c8de1384be020b359d95_icgraph" id="xran__up__api_8h_adfc5ea408600c8de1384be020b359d95_icgraph">
+<area shape="rect" id="node2" href="u__plane__functional_8cc.html#a17e5d82ac5aec3860b1324a80fda79ed" title="TEST_P" alt="" coords="236,5,308,32"/>
+<area shape="rect" id="node3" href="chain__tests_8cc.html#a3d4bd5c7eec6da4ab71688e209100761" title="process_mbuf" alt="" coords="220,56,324,83"/>
+<area shape="rect" id="node4" href="xran__main_8c.html#a7a412a9cd0ac919dccb2112fb386d64a" title="handle_ecpri_ethertype" alt="" coords="372,56,528,83"/>
+<area shape="rect" id="node5" href="xran__main_8c.html#a4ea0e9c036a1dc7605f53f1f862f4952" title="xran_init" alt="" coords="576,56,647,83"/>
+<area shape="rect" id="node6" href="classxran_lib_wraper.html#a126b53d8cc57521b34496dbe3a26621f" title="xranLibWraper::SetUp" alt="" coords="695,56,845,83"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="acd8f547b98d7ebd7dbc41c486a26505d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acd8f547b98d7ebd7dbc41c486a26505d">◆ </a></span>xran_prepare_iq_symbol_portion()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int xran_prepare_iq_symbol_portion </td>
+ <td>(</td>
+ <td class="paramtype">struct rte_mbuf * </td>
+ <td class="paramname"><em>mbuf</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const void * </td>
+ <td class="paramname"><em>iq_data_start</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const enum <a class="el" href="xran__fh__o__du_8h.html#ab5ce6839bae2968c79930a0bfa17f4d8">xran_input_byte_order</a> </td>
+ <td class="paramname"><em>iq_buf_byte_order</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const uint32_t </td>
+ <td class="paramname"><em>iq_data_num_bytes</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">struct <a class="el" href="structxran__up__pkt__gen__params.html">xran_up_pkt_gen_params</a> * </td>
+ <td class="paramname"><em>params</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t </td>
+ <td class="paramname"><em>CC_ID</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t </td>
+ <td class="paramname"><em>Ant_ID</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t </td>
+ <td class="paramname"><em>seq_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint32_t </td>
+ <td class="paramname"><em>do_copy</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Function for starting preparion of IQ samples portions to be sent in xRAN packet. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">mbuf</td><td>Initialized rte_mbuf packet. </td></tr>
+ <tr><td class="paramname">iq_data_start</td><td>Address of the first element in IQ data array. </td></tr>
+ <tr><td class="paramname">iq_data_num_bytes</td><td>Size of the IQ data array. </td></tr>
+ <tr><td class="paramname">iq_data_offset</td><td>IQ data bytes already sent. </td></tr>
+ <tr><td class="paramname">alignment</td><td>Size of IQ data alignment. </td></tr>
+ <tr><td class="paramname">pkt_gen_params</td><td>Struct with parameters used for building packet </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>int Number of bytes that have been appended to the packet within all appended sections. </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="xran__up__api_8c_source.html#l00455">455</a> of file <a class="el" href="xran__up__api_8c_source.html">xran_up_api.c</a>.</p>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__up__api_8h_acd8f547b98d7ebd7dbc41c486a26505d_icgraph.png" border="0" usemap="#xran__up__api_8h_acd8f547b98d7ebd7dbc41c486a26505d_icgraph" alt=""/></div>
+<map name="xran__up__api_8h_acd8f547b98d7ebd7dbc41c486a26505d_icgraph" id="xran__up__api_8h_acd8f547b98d7ebd7dbc41c486a26505d_icgraph">
+<area shape="rect" id="node2" href="xran__common_8h.html#adc9636576fb70f4b4fcfd1d03fe59998" title="prepare_symbol_ex" alt="" coords="216,56,351,83"/>
+<area shape="rect" id="node3" href="u__plane__functional_8cc.html#a17e5d82ac5aec3860b1324a80fda79ed" title="TEST_P" alt="" coords="450,5,522,32"/>
+<area shape="rect" id="node4" href="class_u__plane_perf.html#aa2fb15367f40188e0a2d2c15fa6ad124" title="U_planePerf::fucntional_dl" alt="" coords="399,56,573,83"/>
+<area shape="rect" id="node6" href="xran__common_8h.html#ab67b9cc6e54d8ba3945b265b47af743c" title="send_symbol_ex" alt="" coords="426,107,546,133"/>
+<area shape="rect" id="node5" href="u__plane__performance_8cc.html#a227817e595c0b079e12728d4d19364e8" title="TEST_P" alt="" coords="621,56,693,83"/>
+</map>
+</div>
+
+</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