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_pkt.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_7b477aa413287cfa2199e983b77d66dd.html">api</a></li> </ul>
67 <a href="#nested-classes">Data Structures</a> |
68 <a href="#define-members">Macros</a> |
69 <a href="#enum-members">Enumerations</a> |
70 <a href="#var-members">Variables</a> </div>
71 <div class="headertitle">
72 <div class="title">xran_pkt.h File Reference</div> </div>
74 <div class="contents">
76 <p>Definitions and support functions to process XRAN packet.
77 <a href="#details">More...</a></p>
78 <div class="textblock"><code>#include <rte_common.h></code><br />
79 <code>#include <rte_ether.h></code><br />
80 <code>#include <rte_byteorder.h></code><br />
81 </div><div class="textblock"><div class="dynheader">
82 Include dependency graph for xran_pkt.h:</div>
83 <div class="dyncontent">
84 <div class="center"><img src="xran__pkt_8h__incl.png" border="0" usemap="#xran__pkt_8h" alt=""/></div>
85 <map name="xran__pkt_8h" id="xran__pkt_8h">
88 </div><div class="textblock"><div class="dynheader">
89 This graph shows which files directly or indirectly include this file:</div>
90 <div class="dyncontent">
91 <div class="center"><img src="xran__pkt_8h__dep__incl.png" border="0" usemap="#xran__pkt_8hdep" alt=""/></div>
92 <map name="xran__pkt_8hdep" id="xran__pkt_8hdep">
93 <area shape="rect" id="node2" href="common_8c.html" title="common.c" alt="" coords="5,304,88,331"/>
94 <area shape="rect" id="node3" href="xran__transport_8h.html" title="This file provides the definitions for Transport layer (eCPRI) API. " alt="" coords="2210,80,2326,107"/>
95 <area shape="rect" id="node8" href="xran__main_8c.html" title="XRAN main functionality module. " alt="" coords="1663,304,1756,331"/>
96 <area shape="rect" id="node10" 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="329,304,444,331"/>
97 <area shape="rect" id="node25" href="xran__pkt__up_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="379,155,483,181"/>
98 <area shape="rect" id="node28" href="xran__up__api_8h.html" title="This file provides the definitions for User Plane Messages APIs. " alt="" coords="469,229,571,256"/>
99 <area shape="rect" id="node4" href="xran__cp__api_8h.html" title="This file provides the definitions for Control Plane Messages APIs. " alt="" coords="1855,155,1958,181"/>
100 <area shape="rect" id="node11" href="xran__cp__api_8c.html" title="This file provides the API functions to build Control Plane Messages for XRAN Front Haul layer as def..." alt="" coords="2354,304,2457,331"/>
101 <area shape="rect" id="node13" href="xran__transport_8c.html" title="This file provides the implementation for Transport lyaer (eCPRI) API. " alt="" coords="1522,304,1638,331"/>
102 <area shape="rect" id="node17" href="c__plane__tests_8cc.html" title="c_plane_tests.cc" alt="" coords="2158,379,2279,405"/>
103 <area shape="rect" id="node18" href="chain__tests_8cc.html" title="chain_tests.cc" alt="" coords="1752,379,1859,405"/>
104 <area shape="rect" id="node20" href="prach__functional_8cc.html" title="prach_functional.cc" alt="" coords="2021,304,2155,331"/>
105 <area shape="rect" id="node21" href="prach__performance_8cc.html" title="prach_performance.cc" alt="" coords="2179,304,2330,331"/>
106 <area shape="rect" id="node24" href="xran__up__api_8c.html" title="This file provides the implementation of User Plane Messages APIs. " alt="" coords="469,304,571,331"/>
107 <area shape="rect" id="node5" href="sample-app_8c.html" title="sample-app.c" alt="" coords="205,304,305,331"/>
108 <area shape="rect" id="node6" href="xran__app__frag_8h.html" title="Header file for functions to perform application level fragmentation. " alt="" coords="1729,229,1844,256"/>
109 <area shape="rect" id="node7" href="xran__app__frag_8c.html" title="xRAN application frgamentation for U-plane packets " alt="" coords="1780,304,1895,331"/>
110 <area shape="rect" id="node9" 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="1337,229,1452,256"/>
111 <area shape="rect" id="node19" href="init__sys__functional_8cc.html" title="init_sys_functional.cc" alt="" coords="1207,379,1355,405"/>
112 <area shape="rect" id="node12" href="xran__timer_8c.html" title="This file provides implementation to Timing for XRAN. " alt="" coords="767,304,862,331"/>
113 <area shape="rect" id="node14" href="xran__ul__tables_8c.html" title="This file defines those table used in 5G NR spec. " alt="" coords="887,304,1004,331"/>
114 <area shape="rect" id="node15" href="xran__lib__wrap_8hpp.html" title="xran_lib_wrap.hpp" alt="" coords="1269,304,1395,331"/>
115 <area shape="rect" id="node22" href="u__plane__functional_8cc.html" title="u_plane_functional.cc" alt="" coords="595,304,743,331"/>
116 <area shape="rect" id="node23" href="u__plane__performance_8cc.html" title="u_plane_performance.cc" alt="" coords="1029,304,1193,331"/>
117 <area shape="rect" id="node16" href="xranlib__unit__test__main_8cc.html" title="xranlib_unit_test_main.cc" alt="" coords="1380,379,1551,405"/>
118 <area shape="rect" id="node26" href="common_8h.html" title="common.h" alt="" coords="255,229,337,256"/>
119 <area shape="rect" id="node27" href="config_8c.html" title="config.c" alt="" coords="113,304,181,331"/>
123 <p><a href="xran__pkt_8h_source.html">Go to the source code of this file.</a></p>
124 <table class="memberdecls">
125 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
126 Data Structures</h2></td></tr>
127 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a></td></tr>
128 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
129 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__cmn__hdr.html">xran_ecpri_cmn_hdr</a></td></tr>
130 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
131 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__hdr.html">xran_ecpri_hdr</a></td></tr>
132 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
133 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structradio__app__common__hdr.html">radio_app_common_hdr</a></td></tr>
134 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
135 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__hdr.html">compression_hdr</a></td></tr>
136 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__pkt__comm__hdr.html">xran_pkt_comm_hdr</a></td></tr>
138 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
139 </table><table class="memberdecls">
140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
141 Macros</h2></td></tr>
142 <tr class="memitem:ada35affbf9950f9f0cfa7faa7c8d0d2c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt_8h.html#ada35affbf9950f9f0cfa7faa7c8d0d2c">ECPRI_MAX_PAYLOAD_SIZE</a>   65535</td></tr>
143 <tr class="separator:ada35affbf9950f9f0cfa7faa7c8d0d2c"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:a55ee65757e33fe8e48262f2fafef064e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt_8h.html#a55ee65757e33fe8e48262f2fafef064e">XRAN_ETHER_TYPE</a>   0xAEFE</td></tr>
145 <tr class="separator:a55ee65757e33fe8e48262f2fafef064e"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:aa8e98bf0d1f79b3e67a5e27b063c6251"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt_8h.html#aa8e98bf0d1f79b3e67a5e27b063c6251">XRAN_ECPRI_VER</a>   0x0001</td></tr>
147 <tr class="separator:aa8e98bf0d1f79b3e67a5e27b063c6251"><td class="memSeparator" colspan="2"> </td></tr>
148 <tr class="memitem:a29711c2ced54314eda6c2d0b869a0e63"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt_8h.html#a29711c2ced54314eda6c2d0b869a0e63">XRAN_PAYLOAD_VER</a>   0x0001</td></tr>
149 <tr class="separator:a29711c2ced54314eda6c2d0b869a0e63"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:ac23326adfc4e624044916cc85d9bac2f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt_8h.html#ac23326adfc4e624044916cc85d9bac2f">VLAN_ID</a>   0</td></tr>
151 <tr class="separator:ac23326adfc4e624044916cc85d9bac2f"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:ab513e295ab0fdafb45b2d30677ed9296"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xran__pkt_8h.html#ab513e295ab0fdafb45b2d30677ed9296">VLAN_PCP</a>   7</td></tr>
153 <tr class="separator:ab513e295ab0fdafb45b2d30677ed9296"><td class="memSeparator" colspan="2"> </td></tr>
154 </table><table class="memberdecls">
155 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
156 Enumerations</h2></td></tr>
157 <tr class="memitem:ga5f49588115e2d0a807ad613ae866384a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xran__common__pkt.html#ga5f49588115e2d0a807ad613ae866384a">ecpri_msg_type</a> { <br />
158   <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aaef46b9a1a9d9f7c3276e1e99b02ef6de">ECPRI_IQ_DATA</a> = 0x00,
159 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa83e30716d1c67fc4c96aed3dc63306e7">ECPRI_BIT_SEQUENCE</a> = 0x01,
160 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa54c48b34d68f3445f6108e416a655955">ECPRI_RT_CONTROL_DATA</a> = 0x02,
161 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aaa63937b639e3635a13a385109df8883b">ECPRI_GEN_DATA_TRANSFER</a> = 0x03,
163   <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa030da92cf8a6e8fe6ef5dda2d8d6869b">ECPRI_REMOTE_MEM_ACCESS</a> = 0x04,
164 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa83e33b4f939bf5f34675c575efef7725">ECPRI_DELAY_MEASUREMENT</a> = 0x05,
165 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa58c3ff60f86b8a738082deeee4e3f1ab">ECPRI_REMOTE_RESET</a> = 0x06,
166 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa2936c4480b2bb50029755835dca9727d">ECPRI_EVENT_INDICATION</a> = 0x07,
168   <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa02a7dc510de42e21631982f2c60be2f1">ECPRI_MSG_TYPE_MAX</a>
171 <tr class="separator:ga5f49588115e2d0a807ad613ae866384a"><td class="memSeparator" colspan="2"> </td></tr>
172 <tr class="memitem:ga9c60a23fdae979ad1842b255790d1558"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xran__common__pkt.html#ga9c60a23fdae979ad1842b255790d1558">xran_pkt_dir</a> { <a class="el" href="group__xran__common__pkt.html#gga9c60a23fdae979ad1842b255790d1558a404255db3f05419798875bfb763e1c05">XRAN_DIR_UL</a> = 0,
173 <a class="el" href="group__xran__common__pkt.html#gga9c60a23fdae979ad1842b255790d1558a19f3d3cee814f10e4f3bf7d80194083f">XRAN_DIR_DL</a> = 1,
174 <a class="el" href="group__xran__common__pkt.html#gga9c60a23fdae979ad1842b255790d1558a927c0750db0e35def0b5e1a088a5b9e4">XRAN_DIR_MAX</a>
176 <tr class="separator:ga9c60a23fdae979ad1842b255790d1558"><td class="memSeparator" colspan="2"> </td></tr>
177 </table><table class="memberdecls">
178 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
179 Variables</h2></td></tr>
180 <tr class="memitem:ga303c201bb1ad2f72aa29dd1375efaf72"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__xran__common__pkt.html#ga303c201bb1ad2f72aa29dd1375efaf72">__rte_packed</a></td></tr>
181 <tr class="separator:ga303c201bb1ad2f72aa29dd1375efaf72"><td class="memSeparator" colspan="2"> </td></tr>
183 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
184 <div class="textblock"><p>Definitions and support functions to process XRAN packet. </p>
185 <dl class="section author"><dt>Author</dt><dd>Intel Corporation</dd></dl>
187 <p class="definition">Definition in file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
188 </div><h2 class="groupheader">Macro Definition Documentation</h2>
189 <a id="ada35affbf9950f9f0cfa7faa7c8d0d2c"></a>
190 <h2 class="memtitle"><span class="permalink"><a href="#ada35affbf9950f9f0cfa7faa7c8d0d2c">◆ </a></span>ECPRI_MAX_PAYLOAD_SIZE</h2>
192 <div class="memitem">
193 <div class="memproto">
194 <table class="memname">
196 <td class="memname">#define ECPRI_MAX_PAYLOAD_SIZE   65535</td>
199 </div><div class="memdoc">
200 <p>Max packet size taken in this implementation </p>
202 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00056">56</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
206 <a id="ac23326adfc4e624044916cc85d9bac2f"></a>
207 <h2 class="memtitle"><span class="permalink"><a href="#ac23326adfc4e624044916cc85d9bac2f">◆ </a></span>VLAN_ID</h2>
209 <div class="memitem">
210 <div class="memproto">
211 <table class="memname">
213 <td class="memname">#define VLAN_ID   0</td>
216 </div><div class="memdoc">
217 <p>Default Tag protocol identifier (TPID) </p>
219 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00064">64</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
223 <a id="ab513e295ab0fdafb45b2d30677ed9296"></a>
224 <h2 class="memtitle"><span class="permalink"><a href="#ab513e295ab0fdafb45b2d30677ed9296">◆ </a></span>VLAN_PCP</h2>
226 <div class="memitem">
227 <div class="memproto">
228 <table class="memname">
230 <td class="memname">#define VLAN_PCP   7</td>
233 </div><div class="memdoc">
234 <p>U-Plane and C-Plane only see Table 3 5 : Quality of service classes </p>
236 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00065">65</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
240 <a id="aa8e98bf0d1f79b3e67a5e27b063c6251"></a>
241 <h2 class="memtitle"><span class="permalink"><a href="#aa8e98bf0d1f79b3e67a5e27b063c6251">◆ </a></span>XRAN_ECPRI_VER</h2>
243 <div class="memitem">
244 <div class="memproto">
245 <table class="memname">
247 <td class="memname">#define XRAN_ECPRI_VER   0x0001</td>
250 </div><div class="memdoc">
251 <p>eCPRI protocol revision 3.1.3.1.1 </p>
253 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00061">61</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
257 <a id="a55ee65757e33fe8e48262f2fafef064e"></a>
258 <h2 class="memtitle"><span class="permalink"><a href="#a55ee65757e33fe8e48262f2fafef064e">◆ </a></span>XRAN_ETHER_TYPE</h2>
260 <div class="memitem">
261 <div class="memproto">
262 <table class="memname">
264 <td class="memname">#define XRAN_ETHER_TYPE   0xAEFE</td>
267 </div><div class="memdoc">
268 <p>defined by eCPRI Specification V1.1 </p>
270 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00059">59</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
274 <a id="a29711c2ced54314eda6c2d0b869a0e63"></a>
275 <h2 class="memtitle"><span class="permalink"><a href="#a29711c2ced54314eda6c2d0b869a0e63">◆ </a></span>XRAN_PAYLOAD_VER</h2>
277 <div class="memitem">
278 <div class="memproto">
279 <table class="memname">
281 <td class="memname">#define XRAN_PAYLOAD_VER   0x0001</td>
284 </div><div class="memdoc">
285 <p>Payload version 5.4.4.2 </p>
287 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00062">62</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
291 </div><!-- contents -->
292 <!-- start footer part -->
293 <hr class="footer"/><address class="footer"><small>
294 Generated by  <a href="http://www.doxygen.org/index.html">
295 <img class="footer" src="doxygen.png" alt="doxygen"/>