docs/API/group__xran__common__pkt.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 Packet definitions and functions</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 </div><!-- top -->
  47 <!-- window showing the filter options -->
  48 <div id="MSearchSelectWindow"
  49      onmouseover="return searchBox.OnSearchSelectShow()"
  50      onmouseout="return searchBox.OnSearchSelectHide()"
  51      onkeydown="return searchBox.OnSearchSelectKey(event)">
  52 </div>
  53
  54 <!-- iframe showing the search results (closed by default) -->
  55 <div id="MSearchResultsWindow">
  56 <iframe src="javascript:void(0)" frameborder="0"
  57         name="MSearchResults" id="MSearchResults">
  58 </iframe>
  59 </div>
  60
  61 <div class="header">
  62   <div class="summary">
  63 <a href="#nested-classes">Data Structures</a> &#124;
  64 <a href="#enum-members">Enumerations</a> &#124;
  65 <a href="#var-members">Variables</a>  </div>
  66   <div class="headertitle">
  67 <div class="title">XRAN Packet definitions and functions</div>  </div>
  68 </div><!--header-->
  69 <div class="contents">
  70 <table class="memberdecls">
  71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  72 Data Structures</h2></td></tr>
  73 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a></td></tr>
  74 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__cmn__hdr.html">xran_ecpri_cmn_hdr</a></td></tr>
  76 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__hdr.html">xran_ecpri_hdr</a></td></tr>
  78 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structradio__app__common__hdr.html">radio_app_common_hdr</a></td></tr>
  80 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__hdr.html">compression_hdr</a></td></tr>
  82 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__pkt__comm__hdr.html">xran_pkt_comm_hdr</a></td></tr>
  84 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__hdr.html">xran_up_pkt_hdr</a></td></tr>
  86 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeth__xran__up__pkt__hdr.html">eth_xran_up_pkt_hdr</a></td></tr>
  88 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 </table><table class="memberdecls">
  90 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  91 Enumerations</h2></td></tr>
  92 <tr class="memitem:ga5f49588115e2d0a807ad613ae866384a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xran__common__pkt.html#ga5f49588115e2d0a807ad613ae866384a">ecpri_msg_type</a> { <br />
  93 &#160;&#160;<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aaef46b9a1a9d9f7c3276e1e99b02ef6de">ECPRI_IQ_DATA</a> = 0x00,
  94 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa83e30716d1c67fc4c96aed3dc63306e7">ECPRI_BIT_SEQUENCE</a> = 0x01,
  95 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa54c48b34d68f3445f6108e416a655955">ECPRI_RT_CONTROL_DATA</a> = 0x02,
  96 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aaa63937b639e3635a13a385109df8883b">ECPRI_GEN_DATA_TRANSFER</a> = 0x03,
  97 <br />
  98 &#160;&#160;<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa030da92cf8a6e8fe6ef5dda2d8d6869b">ECPRI_REMOTE_MEM_ACCESS</a> = 0x04,
  99 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa83e33b4f939bf5f34675c575efef7725">ECPRI_DELAY_MEASUREMENT</a> = 0x05,
 100 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa58c3ff60f86b8a738082deeee4e3f1ab">ECPRI_REMOTE_RESET</a> = 0x06,
 101 <a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa2936c4480b2bb50029755835dca9727d">ECPRI_EVENT_INDICATION</a> = 0x07,
 102 <br />
 103 &#160;&#160;<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa02a7dc510de42e21631982f2c60be2f1">ECPRI_MSG_TYPE_MAX</a>
 104 <br />
 105  }</td></tr>
 106 <tr class="separator:ga5f49588115e2d0a807ad613ae866384a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 107 <tr class="memitem:ga9c60a23fdae979ad1842b255790d1558"><td class="memItemLeft" align="right" valign="top">enum &#160;</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,
 108 <a class="el" href="group__xran__common__pkt.html#gga9c60a23fdae979ad1842b255790d1558a19f3d3cee814f10e4f3bf7d80194083f">XRAN_DIR_DL</a> = 1,
 109 <a class="el" href="group__xran__common__pkt.html#gga9c60a23fdae979ad1842b255790d1558a927c0750db0e35def0b5e1a088a5b9e4">XRAN_DIR_MAX</a>
 110  }</td></tr>
 111 <tr class="separator:ga9c60a23fdae979ad1842b255790d1558"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 </table><table class="memberdecls">
 113 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
 114 Variables</h2></td></tr>
 115 <tr class="memitem:ga303c201bb1ad2f72aa29dd1375efaf72"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xran__common__pkt.html#ga303c201bb1ad2f72aa29dd1375efaf72">__rte_packed</a></td></tr>
 116 <tr class="separator:ga303c201bb1ad2f72aa29dd1375efaf72"><td class="memSeparator" colspan="2">&#160;</td></tr>
 117 </table>
 118 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 119 <p>Definitions and support functions to process XRAN packet </p>
 120 <h2 class="groupheader">Enumeration Type Documentation</h2>
 121 <a id="ga5f49588115e2d0a807ad613ae866384a"></a>
 122 <h2 class="memtitle"><span class="permalink"><a href="#ga5f49588115e2d0a807ad613ae866384a">&#9670;&nbsp;</a></span>ecpri_msg_type</h2>
 123
 124 <div class="memitem">
 125 <div class="memproto">
 126       <table class="memname">
 127         <tr>
 128           <td class="memname">enum <a class="el" href="group__xran__common__pkt.html#ga5f49588115e2d0a807ad613ae866384a">ecpri_msg_type</a></td>
 129         </tr>
 130       </table>
 131 </div><div class="memdoc">
 132 <p>eCPRI message types as per eCPRI spec 3.2.4. Message Types </p>
 133 <table class="fieldtable">
 134 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aaef46b9a1a9d9f7c3276e1e99b02ef6de"></a>ECPRI_IQ_DATA&#160;</td><td class="fielddoc"><p>U-plane: IQ data </p>
 135 </td></tr>
 136 <tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa83e30716d1c67fc4c96aed3dc63306e7"></a>ECPRI_BIT_SEQUENCE&#160;</td><td class="fielddoc"></td></tr>
 137 <tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa54c48b34d68f3445f6108e416a655955"></a>ECPRI_RT_CONTROL_DATA&#160;</td><td class="fielddoc"><p>C-plane: Control </p>
 138 </td></tr>
 139 <tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aaa63937b639e3635a13a385109df8883b"></a>ECPRI_GEN_DATA_TRANSFER&#160;</td><td class="fielddoc"></td></tr>
 140 <tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa030da92cf8a6e8fe6ef5dda2d8d6869b"></a>ECPRI_REMOTE_MEM_ACCESS&#160;</td><td class="fielddoc"></td></tr>
 141 <tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa83e33b4f939bf5f34675c575efef7725"></a>ECPRI_DELAY_MEASUREMENT&#160;</td><td class="fielddoc"></td></tr>
 142 <tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa58c3ff60f86b8a738082deeee4e3f1ab"></a>ECPRI_REMOTE_RESET&#160;</td><td class="fielddoc"></td></tr>
 143 <tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa2936c4480b2bb50029755835dca9727d"></a>ECPRI_EVENT_INDICATION&#160;</td><td class="fielddoc"></td></tr>
 144 <tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa02a7dc510de42e21631982f2c60be2f1"></a>ECPRI_MSG_TYPE_MAX&#160;</td><td class="fielddoc"></td></tr>
 145 </table>
 146
 147 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00075">75</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 148
 149 </div>
 150 </div>
 151 <a id="ga9c60a23fdae979ad1842b255790d1558"></a>
 152 <h2 class="memtitle"><span class="permalink"><a href="#ga9c60a23fdae979ad1842b255790d1558">&#9670;&nbsp;</a></span>xran_pkt_dir</h2>
 153
 154 <div class="memitem">
 155 <div class="memproto">
 156       <table class="memname">
 157         <tr>
 158           <td class="memname">enum <a class="el" href="group__xran__common__pkt.html#ga9c60a23fdae979ad1842b255790d1558">xran_pkt_dir</a></td>
 159         </tr>
 160       </table>
 161 </div><div class="memdoc">
 162 <p>Enum used to set xRAN packet data direction (gNB Tx/Rx 5.4.4.1) uplink or downlink </p>
 163 <table class="fieldtable">
 164 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9c60a23fdae979ad1842b255790d1558a404255db3f05419798875bfb763e1c05"></a>XRAN_DIR_UL&#160;</td><td class="fielddoc"><p>UL direction </p>
 165 </td></tr>
 166 <tr><td class="fieldname"><a id="gga9c60a23fdae979ad1842b255790d1558a19f3d3cee814f10e4f3bf7d80194083f"></a>XRAN_DIR_DL&#160;</td><td class="fielddoc"><p>DL direction </p>
 167 </td></tr>
 168 <tr><td class="fieldname"><a id="gga9c60a23fdae979ad1842b255790d1558a927c0750db0e35def0b5e1a088a5b9e4"></a>XRAN_DIR_MAX&#160;</td><td class="fielddoc"></td></tr>
 169 </table>
 170
 171 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00146">146</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 172
 173 </div>
 174 </div>
 175 <h2 class="groupheader">Variable Documentation</h2>
 176 <a id="ga303c201bb1ad2f72aa29dd1375efaf72"></a>
 177 <h2 class="memtitle"><span class="permalink"><a href="#ga303c201bb1ad2f72aa29dd1375efaf72">&#9670;&nbsp;</a></span>__rte_packed</h2>
 178
 179 <div class="memitem">
 180 <div class="memproto">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">struct <a class="el" href="structeth__xran__up__pkt__hdr.html">eth_xran_up_pkt_hdr</a> __rte_packed</td>
 184         </tr>
 185       </table>
 186 </div><div class="memdoc">
 187
 188 </div>
 189 </div>
 190 </div><!-- contents -->
 191 <!-- start footer part -->
 192 <hr class="footer"/><address class="footer"><small>
 193 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 194 <img class="footer" src="doxygen.png" alt="doxygen"/>
 195 </a> 1.8.13
 196 </small></address>
 197 </body>
 198 </html>