add Doxygen documentation
[o-du/phy.git] / docs / API / xran__up__api_8h_source.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_up_api.h Source File</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="headertitle">
67 <div class="title">xran_up_api.h</div>  </div>
68 </div><!--header-->
69 <div class="contents">
70 <a href="xran__up__api_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">*   Copyright (c) 2019 Intel.</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">*   Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">*   you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">*   You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">*       http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">*   Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">*   distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">*   See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*   limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">*******************************************************************************/</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#ifndef _XRAN_UP_API_H_</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#define _XRAN_UP_API_H_</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &lt;rte_common.h&gt;</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">#include &lt;rte_mbuf.h&gt;</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="xran__pkt_8h.html">xran_pkt.h</a>&quot;</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="xran__pkt__up_8h.html">xran_pkt_up.h</a>&quot;</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"> * structure used for storing packet parameters needed for generating</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"> * a data packet</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structxran__up__pkt__gen__params.html">   45</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structxran__up__pkt__gen__params.html">xran_up_pkt_gen_params</a></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;{</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structxran__up__pkt__gen__params.html#a26f46f53ef26bc5d5f86e19a15fc356f">   47</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structradio__app__common__hdr.html">radio_app_common_hdr</a> <a class="code" href="structxran__up__pkt__gen__params.html#a26f46f53ef26bc5d5f86e19a15fc356f">app_params</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structxran__up__pkt__gen__params.html#ae5c4194f5046a89d06534a69775c1cab">   48</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structdata__section__hdr.html">data_section_hdr</a> <a class="code" href="structxran__up__pkt__gen__params.html#ae5c4194f5046a89d06534a69775c1cab">sec_hdr</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structxran__up__pkt__gen__params.html#abd4dfd90066570bbcb342a260adcc7a6">   49</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structdata__section__compression__hdr.html">data_section_compression_hdr</a> <a class="code" href="structxran__up__pkt__gen__params.html#abd4dfd90066570bbcb342a260adcc7a6">compr_hdr_param</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structxran__up__pkt__gen__params.html#afac9efa85d81509009b41172040801ec">   50</a></span>&#160;    <span class="keyword">union </span><a class="code" href="unioncompression__params.html">compression_params</a> <a class="code" href="structxran__up__pkt__gen__params.html#afac9efa85d81509009b41172040801ec">compr_param</a>;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;};</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"> * structure used for storing packet parameters needed for generating</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment"> * a data packet without compression</span></div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"> *   Next fields are omitted:</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"> *        udCompHdr (not always present)</span></div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> *        reserved (not always present)</span></div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> *        udCompParam (not always present)</span></div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structxran__up__pkt__gen__no__compression__params.html">   61</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structxran__up__pkt__gen__no__compression__params.html">xran_up_pkt_gen_no_compression_params</a></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;{</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structxran__up__pkt__gen__no__compression__params.html#a26f46f53ef26bc5d5f86e19a15fc356f">   63</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structradio__app__common__hdr.html">radio_app_common_hdr</a> <a class="code" href="structxran__up__pkt__gen__params.html#a26f46f53ef26bc5d5f86e19a15fc356f">app_params</a>;</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structxran__up__pkt__gen__no__compression__params.html#ae5c4194f5046a89d06534a69775c1cab">   64</a></span>&#160;    <span class="keyword">struct </span><a class="code" href="structdata__section__hdr.html">data_section_hdr</a> <a class="code" href="structxran__up__pkt__gen__params.html#ae5c4194f5046a89d06534a69775c1cab">sec_hdr</a>;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;};</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;int32_t <a class="code" href="xran__up__api_8h.html#adfc5ea408600c8de1384be020b359d95">xran_extract_iq_samples</a>(<span class="keyword">struct</span> rte_mbuf *mbuf,</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordtype">void</span> **iq_data_start,</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    uint8_t *CC_ID,</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    uint8_t *Ant_ID,</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    uint8_t *frame_id,</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    uint8_t *subframe_id,</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    uint8_t *slot_id,</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    uint8_t *symb_id,</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="keyword">struct</span> <a class="code" href="structecpri__seq__id.html">ecpri_seq_id</a> *seq_id,</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    uint16_t *<a class="code" href="structdata__section__hdr.html#acb00c5e7ebe809fda7288c699eed867c">num_prbu</a>,</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    uint16_t *<a class="code" href="structdata__section__hdr.html#a486aca552c11b7046ca3066ebf4241dc">start_prbu</a>,</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    uint16_t *<a class="code" href="structdata__section__hdr.html#aba23e80ad7dc1c3f7085ba3a2b4662bb">sym_inc</a>,</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    uint16_t *<a class="code" href="xran__pkt__cp_8h.html#affa3adbd50cd4af2018ba1fc0e8c3e31">rb</a>,</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    uint16_t *<a class="code" href="structdata__section__hdr.html#a11d1616fb975ccafbc33ab590fe501c4">sect_id</a>,</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    int8_t   expect_comp,</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    uint8_t *compMeth,</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    uint8_t *iqWidth);</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="keywordtype">int</span> <a class="code" href="xran__up__api_8h.html#acd8f547b98d7ebd7dbc41c486a26505d">xran_prepare_iq_symbol_portion</a>(</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;                        <span class="keyword">struct</span> rte_mbuf *mbuf,</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;                        <span class="keyword">const</span> <span class="keywordtype">void</span> *iq_data_start,</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;                        <span class="keyword">const</span> <span class="keyword">enum</span> <a class="code" href="xran__fh__o__du_8h.html#ab5ce6839bae2968c79930a0bfa17f4d8">xran_input_byte_order</a> iq_buf_byte_order,</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;                        <span class="keyword">const</span> uint32_t iq_data_num_bytes,</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;                        <span class="keyword">struct</span> <a class="code" href="structxran__up__pkt__gen__params.html">xran_up_pkt_gen_params</a> *params,</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;                        uint8_t CC_ID,</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;                        uint8_t Ant_ID,</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;                        uint8_t seq_id,</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;                        uint32_t do_copy);</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;}</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _XRAN_UP_API_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="structdata__section__hdr_html_aba23e80ad7dc1c3f7085ba3a2b4662bb"><div class="ttname"><a href="structdata__section__hdr.html#aba23e80ad7dc1c3f7085ba3a2b4662bb">data_section_hdr::sym_inc</a></div><div class="ttdeci">uint32_t sym_inc</div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt__up_8h_source.html#l00073">xran_pkt_up.h:73</a></div></div>
71 <div class="ttc" id="xran__pkt__cp_8h_html_affa3adbd50cd4af2018ba1fc0e8c3e31"><div class="ttname"><a href="xran__pkt__cp_8h.html#affa3adbd50cd4af2018ba1fc0e8c3e31">rb</a></div><div class="ttdeci">uint32_t rb</div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt__cp_8h_source.html#l00243">xran_pkt_cp.h:243</a></div></div>
72 <div class="ttc" id="structxran__up__pkt__gen__params_html_a26f46f53ef26bc5d5f86e19a15fc356f"><div class="ttname"><a href="structxran__up__pkt__gen__params.html#a26f46f53ef26bc5d5f86e19a15fc356f">xran_up_pkt_gen_params::app_params</a></div><div class="ttdeci">struct radio_app_common_hdr app_params</div><div class="ttdef"><b>Definition:</b> <a href="xran__up__api_8h_source.html#l00047">xran_up_api.h:47</a></div></div>
73 <div class="ttc" id="structdata__section__compression__hdr_html"><div class="ttname"><a href="structdata__section__compression__hdr.html">data_section_compression_hdr</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt__up_8h_source.html#l00090">xran_pkt_up.h:90</a></div></div>
74 <div class="ttc" id="structdata__section__hdr_html"><div class="ttname"><a href="structdata__section__hdr.html">data_section_hdr</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt__up_8h_source.html#l00067">xran_pkt_up.h:67</a></div></div>
75 <div class="ttc" id="structxran__up__pkt__gen__params_html"><div class="ttname"><a href="structxran__up__pkt__gen__params.html">xran_up_pkt_gen_params</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__up__api_8h_source.html#l00045">xran_up_api.h:45</a></div></div>
76 <div class="ttc" id="structdata__section__hdr_html_acb00c5e7ebe809fda7288c699eed867c"><div class="ttname"><a href="structdata__section__hdr.html#acb00c5e7ebe809fda7288c699eed867c">data_section_hdr::num_prbu</a></div><div class="ttdeci">uint32_t num_prbu</div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt__up_8h_source.html#l00071">xran_pkt_up.h:71</a></div></div>
77 <div class="ttc" id="structxran__up__pkt__gen__no__compression__params_html"><div class="ttname"><a href="structxran__up__pkt__gen__no__compression__params.html">xran_up_pkt_gen_no_compression_params</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__up__api_8h_source.html#l00061">xran_up_api.h:61</a></div></div>
78 <div class="ttc" id="xran__fh__o__du_8h_html_ab5ce6839bae2968c79930a0bfa17f4d8"><div class="ttname"><a href="xran__fh__o__du_8h.html#ab5ce6839bae2968c79930a0bfa17f4d8">xran_input_byte_order</a></div><div class="ttdeci">xran_input_byte_order</div><div class="ttdef"><b>Definition:</b> <a href="xran__fh__o__du_8h_source.html#l00471">xran_fh_o_du.h:471</a></div></div>
79 <div class="ttc" id="structxran__up__pkt__gen__params_html_ae5c4194f5046a89d06534a69775c1cab"><div class="ttname"><a href="structxran__up__pkt__gen__params.html#ae5c4194f5046a89d06534a69775c1cab">xran_up_pkt_gen_params::sec_hdr</a></div><div class="ttdeci">struct data_section_hdr sec_hdr</div><div class="ttdef"><b>Definition:</b> <a href="xran__up__api_8h_source.html#l00048">xran_up_api.h:48</a></div></div>
80 <div class="ttc" id="unioncompression__params_html"><div class="ttname"><a href="unioncompression__params.html">compression_params</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt__up_8h_source.html#l00110">xran_pkt_up.h:110</a></div></div>
81 <div class="ttc" id="structxran__up__pkt__gen__params_html_afac9efa85d81509009b41172040801ec"><div class="ttname"><a href="structxran__up__pkt__gen__params.html#afac9efa85d81509009b41172040801ec">xran_up_pkt_gen_params::compr_param</a></div><div class="ttdeci">union compression_params compr_param</div><div class="ttdef"><b>Definition:</b> <a href="xran__up__api_8h_source.html#l00050">xran_up_api.h:50</a></div></div>
82 <div class="ttc" id="structdata__section__hdr_html_a486aca552c11b7046ca3066ebf4241dc"><div class="ttname"><a href="structdata__section__hdr.html#a486aca552c11b7046ca3066ebf4241dc">data_section_hdr::start_prbu</a></div><div class="ttdeci">uint32_t start_prbu</div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt__up_8h_source.html#l00072">xran_pkt_up.h:72</a></div></div>
83 <div class="ttc" id="structecpri__seq__id_html"><div class="ttname"><a href="structecpri__seq__id.html">ecpri_seq_id</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt_8h_source.html#l00097">xran_pkt.h:97</a></div></div>
84 <div class="ttc" id="xran__pkt_8h_html"><div class="ttname"><a href="xran__pkt_8h.html">xran_pkt.h</a></div><div class="ttdoc">Definitions and support functions to process XRAN packet. </div></div>
85 <div class="ttc" id="xran__pkt__up_8h_html"><div class="ttname"><a href="xran__pkt__up_8h.html">xran_pkt_up.h</a></div><div class="ttdoc">Definitions and support functions to process XRAN packet. </div></div>
86 <div class="ttc" id="structdata__section__hdr_html_a11d1616fb975ccafbc33ab590fe501c4"><div class="ttname"><a href="structdata__section__hdr.html#a11d1616fb975ccafbc33ab590fe501c4">data_section_hdr::sect_id</a></div><div class="ttdeci">uint32_t sect_id</div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt__up_8h_source.html#l00075">xran_pkt_up.h:75</a></div></div>
87 <div class="ttc" id="xran__up__api_8h_html_adfc5ea408600c8de1384be020b359d95"><div class="ttname"><a href="xran__up__api_8h.html#adfc5ea408600c8de1384be020b359d95">xran_extract_iq_samples</a></div><div class="ttdeci">int32_t xran_extract_iq_samples(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 ecpri_seq_id *seq_id, uint16_t *num_prbu, uint16_t *start_prbu, uint16_t *sym_inc, uint16_t *rb, uint16_t *sect_id, int8_t expect_comp, uint8_t *compMeth, uint8_t *iqWidth)</div><div class="ttdoc">Function extracts IQ samples from received mbuf packet. </div><div class="ttdef"><b>Definition:</b> <a href="xran__up__api_8c_source.html#l00327">xran_up_api.c:327</a></div></div>
88 <div class="ttc" id="structradio__app__common__hdr_html"><div class="ttname"><a href="structradio__app__common__hdr.html">radio_app_common_hdr</a></div><div class="ttdef"><b>Definition:</b> <a href="xran__pkt_8h_source.html#l00162">xran_pkt.h:162</a></div></div>
89 <div class="ttc" id="xran__up__api_8h_html_acd8f547b98d7ebd7dbc41c486a26505d"><div class="ttname"><a href="xran__up__api_8h.html#acd8f547b98d7ebd7dbc41c486a26505d">xran_prepare_iq_symbol_portion</a></div><div class="ttdeci">int xran_prepare_iq_symbol_portion(struct rte_mbuf *mbuf, const void *iq_data_start, const enum xran_input_byte_order iq_buf_byte_order, const uint32_t iq_data_num_bytes, struct xran_up_pkt_gen_params *params, uint8_t CC_ID, uint8_t Ant_ID, uint8_t seq_id, uint32_t do_copy)</div><div class="ttdoc">Function for starting preparion of IQ samples portions to be sent in xRAN packet. ...</div><div class="ttdef"><b>Definition:</b> <a href="xran__up__api_8c_source.html#l00455">xran_up_api.c:455</a></div></div>
90 <div class="ttc" id="structxran__up__pkt__gen__params_html_abd4dfd90066570bbcb342a260adcc7a6"><div class="ttname"><a href="structxran__up__pkt__gen__params.html#abd4dfd90066570bbcb342a260adcc7a6">xran_up_pkt_gen_params::compr_hdr_param</a></div><div class="ttdeci">struct data_section_compression_hdr compr_hdr_param</div><div class="ttdef"><b>Definition:</b> <a href="xran__up__api_8h_source.html#l00049">xran_up_api.h:49</a></div></div>
91 </div><!-- fragment --></div><!-- contents -->
92 <!-- start footer part -->
93 <hr class="footer"/><address class="footer"><small>
94 Generated by &#160;<a href="http://www.doxygen.org/index.html">
95 <img class="footer" src="doxygen.png" alt="doxygen"/>
96 </a> 1.8.13
97 </small></address>
98 </body>
99 </html>