docs/API/structxran__io__cfg.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_io_cfg Struct 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" />
  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><!-- top -->
  61 <div class="header">
  62   <div class="summary">
  63 <a href="#pub-attribs">Data Fields</a>  </div>
  64   <div class="headertitle">
  65 <div class="title">xran_io_cfg Struct Reference</div>  </div>
  66 </div><!--header-->
  67 <div class="contents">
  68
  69 <p><code>#include &lt;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&gt;</code></p>
  70 <div class="dynheader">
  71 Collaboration diagram for xran_io_cfg:</div>
  72 <div class="dyncontent">
  73 <div class="center"><img src="structxran__io__cfg__coll__graph.png" border="0" usemap="#xran__io__cfg_coll__map" alt="Collaboration graph"/></div>
  74 </div>
  75 <table class="memberdecls">
  76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  77 Data Fields</h2></td></tr>
  78 <tr class="memitem:a1e6927fa1486224044e568f9c370519b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a1e6927fa1486224044e568f9c370519b">id</a></td></tr>
  79 <tr class="separator:a1e6927fa1486224044e568f9c370519b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:ae58734e2aff608373089778da1aa4efa"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#ae58734e2aff608373089778da1aa4efa">dpdk_dev</a> [<a class="el" href="xran__fh__o__du_8h.html#a185d8ae20c697568878935f0a260227aaacf0b73353fef317536c389fcccde6ac">XRAN_VF_MAX</a>]</td></tr>
  81 <tr class="separator:ae58734e2aff608373089778da1aa4efa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:a64ddf49fc9f31dbe434f9ee6b0a08db4"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a64ddf49fc9f31dbe434f9ee6b0a08db4">bbdev_dev</a> [1]</td></tr>
  83 <tr class="separator:a64ddf49fc9f31dbe434f9ee6b0a08db4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:ab99f9c6dba4d5fdc09299b3ac670503c"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#ab99f9c6dba4d5fdc09299b3ac670503c">bbdev_mode</a></td></tr>
  85 <tr class="separator:ab99f9c6dba4d5fdc09299b3ac670503c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a53341e81716fce9aeddee73d7228f2bf"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a53341e81716fce9aeddee73d7228f2bf">core</a></td></tr>
  87 <tr class="separator:a53341e81716fce9aeddee73d7228f2bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:a727bdc89e33bfc7d18dfaf166d46598a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a727bdc89e33bfc7d18dfaf166d46598a">system_core</a></td></tr>
  89 <tr class="separator:a727bdc89e33bfc7d18dfaf166d46598a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:a7ea8f53112b353d5e98cc955437f3706"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#a7ea8f53112b353d5e98cc955437f3706">pkt_proc_core</a></td></tr>
  91 <tr class="separator:a7ea8f53112b353d5e98cc955437f3706"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:afc9b03cdc767412993891263da114dc3"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#afc9b03cdc767412993891263da114dc3">pkt_aux_core</a></td></tr>
  93 <tr class="separator:afc9b03cdc767412993891263da114dc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:aa442a227739dcff5212e5356dee54b68"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#aa442a227739dcff5212e5356dee54b68">timing_core</a></td></tr>
  95 <tr class="separator:aa442a227739dcff5212e5356dee54b68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:ab4a87dda9c9ac332a46e6a9b8a8b8315"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__io__cfg.html#ab4a87dda9c9ac332a46e6a9b8a8b8315">port</a> [<a class="el" href="xran__fh__o__du_8h.html#a185d8ae20c697568878935f0a260227aaacf0b73353fef317536c389fcccde6ac">XRAN_VF_MAX</a>]</td></tr>
  97 <tr class="separator:ab4a87dda9c9ac332a46e6a9b8a8b8315"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 </table>
  99 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 100 <div class="textblock"><p>DPDK IO configuration for XRAN layer </p>
 101
 102 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00294">294</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 103 </div><h2 class="groupheader">Field Documentation</h2>
 104 <a id="a64ddf49fc9f31dbe434f9ee6b0a08db4"></a>
 105 <h2 class="memtitle"><span class="permalink"><a href="#a64ddf49fc9f31dbe434f9ee6b0a08db4">&#9670;&nbsp;</a></span>bbdev_dev</h2>
 106
 107 <div class="memitem">
 108 <div class="memproto">
 109       <table class="memname">
 110         <tr>
 111           <td class="memname">char* bbdev_dev[1]</td>
 112         </tr>
 113       </table>
 114 </div><div class="memdoc">
 115 <p>BBDev dev name </p>
 116
 117 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00297">297</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 118
 119 </div>
 120 </div>
 121 <a id="ab99f9c6dba4d5fdc09299b3ac670503c"></a>
 122 <h2 class="memtitle"><span class="permalink"><a href="#ab99f9c6dba4d5fdc09299b3ac670503c">&#9670;&nbsp;</a></span>bbdev_mode</h2>
 123
 124 <div class="memitem">
 125 <div class="memproto">
 126       <table class="memname">
 127         <tr>
 128           <td class="memname">int32_t bbdev_mode</td>
 129         </tr>
 130       </table>
 131 </div><div class="memdoc">
 132 <p>DPDK for BBDev </p>
 133
 134 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00298">298</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 135
 136 </div>
 137 </div>
 138 <a id="a53341e81716fce9aeddee73d7228f2bf"></a>
 139 <h2 class="memtitle"><span class="permalink"><a href="#a53341e81716fce9aeddee73d7228f2bf">&#9670;&nbsp;</a></span>core</h2>
 140
 141 <div class="memitem">
 142 <div class="memproto">
 143       <table class="memname">
 144         <tr>
 145           <td class="memname">int32_t core</td>
 146         </tr>
 147       </table>
 148 </div><div class="memdoc">
 149 <p>reservd </p>
 150
 151 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00299">299</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 152
 153 </div>
 154 </div>
 155 <a id="ae58734e2aff608373089778da1aa4efa"></a>
 156 <h2 class="memtitle"><span class="permalink"><a href="#ae58734e2aff608373089778da1aa4efa">&#9670;&nbsp;</a></span>dpdk_dev</h2>
 157
 158 <div class="memitem">
 159 <div class="memproto">
 160       <table class="memname">
 161         <tr>
 162           <td class="memname">char* dpdk_dev[<a class="el" href="xran__fh__o__du_8h.html#a185d8ae20c697568878935f0a260227aaacf0b73353fef317536c389fcccde6ac">XRAN_VF_MAX</a>]</td>
 163         </tr>
 164       </table>
 165 </div><div class="memdoc">
 166 <p>VFs devices </p>
 167
 168 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00296">296</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 169
 170 </div>
 171 </div>
 172 <a id="a1e6927fa1486224044e568f9c370519b"></a>
 173 <h2 class="memtitle"><span class="permalink"><a href="#a1e6927fa1486224044e568f9c370519b">&#9670;&nbsp;</a></span>id</h2>
 174
 175 <div class="memitem">
 176 <div class="memproto">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname">uint8_t id</td>
 180         </tr>
 181       </table>
 182 </div><div class="memdoc">
 183 <p>should be (0) for O-DU or (1) O-RU (debug) </p>
 184
 185 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00295">295</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 186
 187 </div>
 188 </div>
 189 <a id="afc9b03cdc767412993891263da114dc3"></a>
 190 <h2 class="memtitle"><span class="permalink"><a href="#afc9b03cdc767412993891263da114dc3">&#9670;&nbsp;</a></span>pkt_aux_core</h2>
 191
 192 <div class="memitem">
 193 <div class="memproto">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">int32_t pkt_aux_core</td>
 197         </tr>
 198       </table>
 199 </div><div class="memdoc">
 200 <p>reservd </p>
 201
 202 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00302">302</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 203
 204 </div>
 205 </div>
 206 <a id="a7ea8f53112b353d5e98cc955437f3706"></a>
 207 <h2 class="memtitle"><span class="permalink"><a href="#a7ea8f53112b353d5e98cc955437f3706">&#9670;&nbsp;</a></span>pkt_proc_core</h2>
 208
 209 <div class="memitem">
 210 <div class="memproto">
 211       <table class="memname">
 212         <tr>
 213           <td class="memname">int32_t pkt_proc_core</td>
 214         </tr>
 215       </table>
 216 </div><div class="memdoc">
 217 <p>reservd </p>
 218
 219 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00301">301</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 220
 221 </div>
 222 </div>
 223 <a id="ab4a87dda9c9ac332a46e6a9b8a8b8315"></a>
 224 <h2 class="memtitle"><span class="permalink"><a href="#ab4a87dda9c9ac332a46e6a9b8a8b8315">&#9670;&nbsp;</a></span>port</h2>
 225
 226 <div class="memitem">
 227 <div class="memproto">
 228       <table class="memname">
 229         <tr>
 230           <td class="memname">int32_t port[<a class="el" href="xran__fh__o__du_8h.html#a185d8ae20c697568878935f0a260227aaacf0b73353fef317536c389fcccde6ac">XRAN_VF_MAX</a>]</td>
 231         </tr>
 232       </table>
 233 </div><div class="memdoc">
 234 <p>VFs ports </p>
 235
 236 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00304">304</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 237
 238 </div>
 239 </div>
 240 <a id="a727bdc89e33bfc7d18dfaf166d46598a"></a>
 241 <h2 class="memtitle"><span class="permalink"><a href="#a727bdc89e33bfc7d18dfaf166d46598a">&#9670;&nbsp;</a></span>system_core</h2>
 242
 243 <div class="memitem">
 244 <div class="memproto">
 245       <table class="memname">
 246         <tr>
 247           <td class="memname">int32_t system_core</td>
 248         </tr>
 249       </table>
 250 </div><div class="memdoc">
 251 <p>reservd </p>
 252
 253 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00300">300</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 254
 255 </div>
 256 </div>
 257 <a id="aa442a227739dcff5212e5356dee54b68"></a>
 258 <h2 class="memtitle"><span class="permalink"><a href="#aa442a227739dcff5212e5356dee54b68">&#9670;&nbsp;</a></span>timing_core</h2>
 259
 260 <div class="memitem">
 261 <div class="memproto">
 262       <table class="memname">
 263         <tr>
 264           <td class="memname">int32_t timing_core</td>
 265         </tr>
 266       </table>
 267 </div><div class="memdoc">
 268 <p>core used by xRAN </p>
 269
 270 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00303">303</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 271
 272 </div>
 273 </div>
 274 <hr/>The documentation for this struct was generated from the following file:<ul>
 275 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
 276 </ul>
 277 </div><!-- contents -->
 278 <!-- start footer part -->
 279 <hr class="footer"/><address class="footer"><small>
 280 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 281 <img class="footer" src="doxygen.png" alt="doxygen"/>
 282 </a> 1.8.13
 283 </small></address>
 284 </body>
 285 </html>