docs/API/structxran__ru__config.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_ru_config 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_ru_config 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_ru_config:</div>
  72 <div class="dyncontent">
  73 <div class="center"><img src="structxran__ru__config__coll__graph.png" border="0" usemap="#xran__ru__config_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:af92ff2dfd2bddd0880d779c04b9fb359"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="xran__fh__o__du_8h.html#abf0211a253f5881ebad3910cef98d30e">xran_category</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#af92ff2dfd2bddd0880d779c04b9fb359">xranCat</a></td></tr>
  79 <tr class="separator:af92ff2dfd2bddd0880d779c04b9fb359"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:a1520b1ef6131bff6c14b88d849c266c5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a1520b1ef6131bff6c14b88d849c266c5">iqWidth</a></td></tr>
  81 <tr class="separator:a1520b1ef6131bff6c14b88d849c266c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:a1e4a3c43fc7865c6520471fb9ba8501f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a1e4a3c43fc7865c6520471fb9ba8501f">compMeth</a></td></tr>
  83 <tr class="separator:a1e4a3c43fc7865c6520471fb9ba8501f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:a59e7e8f3feb686850b0cb0ae065de85b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a59e7e8f3feb686850b0cb0ae065de85b">fftSize</a></td></tr>
  85 <tr class="separator:a59e7e8f3feb686850b0cb0ae065de85b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a74e72997edeea7f9f1696baffb9989b4"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="xran__fh__o__du_8h.html#ab5ce6839bae2968c79930a0bfa17f4d8">xran_input_byte_order</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a74e72997edeea7f9f1696baffb9989b4">byteOrder</a></td></tr>
  87 <tr class="separator:a74e72997edeea7f9f1696baffb9989b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:ad1b1309ca2645e24fa201f8decae1988"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="xran__fh__o__du_8h.html#a0d9cb4cebbc59a8fa5bfef7547898859">xran_input_i_q_order</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#ad1b1309ca2645e24fa201f8decae1988">iqOrder</a></td></tr>
  89 <tr class="separator:ad1b1309ca2645e24fa201f8decae1988"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:a7a25206e77e83a57fd036102cebfb4f0"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ru__config.html#a7a25206e77e83a57fd036102cebfb4f0">xran_max_frame</a></td></tr>
  91 <tr class="separator:a7a25206e77e83a57fd036102cebfb4f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 </table>
  93 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  94 <div class="textblock"><p>XRAN front haul IQ compression settings </p>
  95
  96 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00483">483</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
  97 </div><h2 class="groupheader">Field Documentation</h2>
  98 <a id="a74e72997edeea7f9f1696baffb9989b4"></a>
  99 <h2 class="memtitle"><span class="permalink"><a href="#a74e72997edeea7f9f1696baffb9989b4">&#9670;&nbsp;</a></span>byteOrder</h2>
 100
 101 <div class="memitem">
 102 <div class="memproto">
 103       <table class="memname">
 104         <tr>
 105           <td class="memname">enum <a class="el" href="xran__fh__o__du_8h.html#ab5ce6839bae2968c79930a0bfa17f4d8">xran_input_byte_order</a> byteOrder</td>
 106         </tr>
 107       </table>
 108 </div><div class="memdoc">
 109 <p>Order of bytes in int16_t in buffer. Big or little endian </p>
 110
 111 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00489">489</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 112
 113 </div>
 114 </div>
 115 <a id="a1e4a3c43fc7865c6520471fb9ba8501f"></a>
 116 <h2 class="memtitle"><span class="permalink"><a href="#a1e4a3c43fc7865c6520471fb9ba8501f">&#9670;&nbsp;</a></span>compMeth</h2>
 117
 118 <div class="memitem">
 119 <div class="memproto">
 120       <table class="memname">
 121         <tr>
 122           <td class="memname">uint8_t compMeth</td>
 123         </tr>
 124       </table>
 125 </div><div class="memdoc">
 126 <p>Compression method </p>
 127
 128 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00487">487</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 129
 130 </div>
 131 </div>
 132 <a id="a59e7e8f3feb686850b0cb0ae065de85b"></a>
 133 <h2 class="memtitle"><span class="permalink"><a href="#a59e7e8f3feb686850b0cb0ae065de85b">&#9670;&nbsp;</a></span>fftSize</h2>
 134
 135 <div class="memitem">
 136 <div class="memproto">
 137       <table class="memname">
 138         <tr>
 139           <td class="memname">uint8_t fftSize</td>
 140         </tr>
 141       </table>
 142 </div><div class="memdoc">
 143 <p>FFT Size </p>
 144
 145 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00488">488</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 146
 147 </div>
 148 </div>
 149 <a id="ad1b1309ca2645e24fa201f8decae1988"></a>
 150 <h2 class="memtitle"><span class="permalink"><a href="#ad1b1309ca2645e24fa201f8decae1988">&#9670;&nbsp;</a></span>iqOrder</h2>
 151
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname">enum <a class="el" href="xran__fh__o__du_8h.html#a0d9cb4cebbc59a8fa5bfef7547898859">xran_input_i_q_order</a> iqOrder</td>
 157         </tr>
 158       </table>
 159 </div><div class="memdoc">
 160 <p>order of IQs in the buffer </p>
 161
 162 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00490">490</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 163
 164 </div>
 165 </div>
 166 <a id="a1520b1ef6131bff6c14b88d849c266c5"></a>
 167 <h2 class="memtitle"><span class="permalink"><a href="#a1520b1ef6131bff6c14b88d849c266c5">&#9670;&nbsp;</a></span>iqWidth</h2>
 168
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">uint8_t iqWidth</td>
 174         </tr>
 175       </table>
 176 </div><div class="memdoc">
 177 <p>IQ bit width </p>
 178
 179 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00486">486</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 180
 181 </div>
 182 </div>
 183 <a id="a7a25206e77e83a57fd036102cebfb4f0"></a>
 184 <h2 class="memtitle"><span class="permalink"><a href="#a7a25206e77e83a57fd036102cebfb4f0">&#9670;&nbsp;</a></span>xran_max_frame</h2>
 185
 186 <div class="memitem">
 187 <div class="memproto">
 188       <table class="memname">
 189         <tr>
 190           <td class="memname">uint16_t xran_max_frame</td>
 191         </tr>
 192       </table>
 193 </div><div class="memdoc">
 194 <p>max frame number supported </p>
 195
 196 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00491">491</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 197
 198 </div>
 199 </div>
 200 <a id="af92ff2dfd2bddd0880d779c04b9fb359"></a>
 201 <h2 class="memtitle"><span class="permalink"><a href="#af92ff2dfd2bddd0880d779c04b9fb359">&#9670;&nbsp;</a></span>xranCat</h2>
 202
 203 <div class="memitem">
 204 <div class="memproto">
 205       <table class="memname">
 206         <tr>
 207           <td class="memname">enum <a class="el" href="xran__fh__o__du_8h.html#abf0211a253f5881ebad3910cef98d30e">xran_category</a> xranCat</td>
 208         </tr>
 209       </table>
 210 </div><div class="memdoc">
 211 <p>mode: Catergory A or Category B </p>
 212
 213 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00484">484</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 214
 215 </div>
 216 </div>
 217 <hr/>The documentation for this struct was generated from the following file:<ul>
 218 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
 219 </ul>
 220 </div><!-- contents -->
 221 <!-- start footer part -->
 222 <hr class="footer"/><address class="footer"><small>
 223 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 224 <img class="footer" src="doxygen.png" alt="doxygen"/>
 225 </a> 1.8.13
 226 </small></address>
 227 </body>
 228 </html>