docs/API/structxran__flat__buffer.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_flat_buffer 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_flat_buffer 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_flat_buffer:</div>
  72 <div class="dyncontent">
  73 <div class="center"><img src="structxran__flat__buffer__coll__graph.png" border="0" usemap="#xran__flat__buffer_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:ac9d92d585877c2ef1af759479baf85fe"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#ac9d92d585877c2ef1af759479baf85fe">nElementLenInBytes</a></td></tr>
  79 <tr class="separator:ac9d92d585877c2ef1af759479baf85fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:a4371798a7694f5939136dca8baa93f21"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#a4371798a7694f5939136dca8baa93f21">nNumberOfElements</a></td></tr>
  81 <tr class="separator:a4371798a7694f5939136dca8baa93f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:a2c3c46f4c4709f349a0cc62bae9ca92d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#a2c3c46f4c4709f349a0cc62bae9ca92d">nOffsetInBytes</a></td></tr>
  83 <tr class="separator:a2c3c46f4c4709f349a0cc62bae9ca92d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:a0119c99b1fb0b423f6c1acf165cb8930"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#a0119c99b1fb0b423f6c1acf165cb8930">nIsPhyAddr</a></td></tr>
  85 <tr class="separator:a0119c99b1fb0b423f6c1acf165cb8930"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a77f0d5374ee675db57c0b29946ca7744"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#a77f0d5374ee675db57c0b29946ca7744">pData</a></td></tr>
  87 <tr class="separator:a77f0d5374ee675db57c0b29946ca7744"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:addb9297d816b26c680888115de8c9538"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#addb9297d816b26c680888115de8c9538">pCtrl</a></td></tr>
  89 <tr class="separator:addb9297d816b26c680888115de8c9538"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 </table>
  91 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92 <div class="textblock"><p>A flat buffer structure. The data pointer, pData, is a virtual address. The API requires the memory to by physically contiguous. Each flat buffer segment may contain several equally sized elements. </p>
  93
  94 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00553">553</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
  95 </div><h2 class="groupheader">Field Documentation</h2>
  96 <a id="ac9d92d585877c2ef1af759479baf85fe"></a>
  97 <h2 class="memtitle"><span class="permalink"><a href="#ac9d92d585877c2ef1af759479baf85fe">&#9670;&nbsp;</a></span>nElementLenInBytes</h2>
  98
  99 <div class="memitem">
 100 <div class="memproto">
 101       <table class="memname">
 102         <tr>
 103           <td class="memname">uint32_t nElementLenInBytes</td>
 104         </tr>
 105       </table>
 106 </div><div class="memdoc">
 107 <p>The Element length specified in bytes. This parameter specifies the size of a single element in the buffer. The total size of the buffer is described as bufferSize = nElementLenInBytes * nNumberOfElements </p>
 108
 109 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00555">555</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 110
 111 </div>
 112 </div>
 113 <a id="a0119c99b1fb0b423f6c1acf165cb8930"></a>
 114 <h2 class="memtitle"><span class="permalink"><a href="#a0119c99b1fb0b423f6c1acf165cb8930">&#9670;&nbsp;</a></span>nIsPhyAddr</h2>
 115
 116 <div class="memitem">
 117 <div class="memproto">
 118       <table class="memname">
 119         <tr>
 120           <td class="memname">uint32_t nIsPhyAddr</td>
 121         </tr>
 122       </table>
 123 </div><div class="memdoc">
 124
 125 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00565">565</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 126
 127 </div>
 128 </div>
 129 <a id="a4371798a7694f5939136dca8baa93f21"></a>
 130 <h2 class="memtitle"><span class="permalink"><a href="#a4371798a7694f5939136dca8baa93f21">&#9670;&nbsp;</a></span>nNumberOfElements</h2>
 131
 132 <div class="memitem">
 133 <div class="memproto">
 134       <table class="memname">
 135         <tr>
 136           <td class="memname">uint32_t nNumberOfElements</td>
 137         </tr>
 138       </table>
 139 </div><div class="memdoc">
 140 <p>The number of elements in the physical contiguous memory segment </p>
 141
 142 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00560">560</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 143
 144 </div>
 145 </div>
 146 <a id="a2c3c46f4c4709f349a0cc62bae9ca92d"></a>
 147 <h2 class="memtitle"><span class="permalink"><a href="#a2c3c46f4c4709f349a0cc62bae9ca92d">&#9670;&nbsp;</a></span>nOffsetInBytes</h2>
 148
 149 <div class="memitem">
 150 <div class="memproto">
 151       <table class="memname">
 152         <tr>
 153           <td class="memname">uint32_t nOffsetInBytes</td>
 154         </tr>
 155       </table>
 156 </div><div class="memdoc">
 157 <p>Offset in bytes to the start of the data in the physical contiguous memory segment </p>
 158
 159 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00562">562</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 160
 161 </div>
 162 </div>
 163 <a id="addb9297d816b26c680888115de8c9538"></a>
 164 <h2 class="memtitle"><span class="permalink"><a href="#addb9297d816b26c680888115de8c9538">&#9670;&nbsp;</a></span>pCtrl</h2>
 165
 166 <div class="memitem">
 167 <div class="memproto">
 168       <table class="memname">
 169         <tr>
 170           <td class="memname">void* pCtrl</td>
 171         </tr>
 172       </table>
 173 </div><div class="memdoc">
 174 <p>pointer to control section coresponding to data buffer </p>
 175
 176 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00570">570</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 177
 178 </div>
 179 </div>
 180 <a id="a77f0d5374ee675db57c0b29946ca7744"></a>
 181 <h2 class="memtitle"><span class="permalink"><a href="#a77f0d5374ee675db57c0b29946ca7744">&#9670;&nbsp;</a></span>pData</h2>
 182
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">uint8_t* pData</td>
 188         </tr>
 189       </table>
 190 </div><div class="memdoc">
 191 <p>The data pointer is a virtual address, however the actual data pointed to is required to be in contiguous physical memory unless the field requiresPhysicallyContiguousMemory in CpaInstanceInfo is false. </p>
 192
 193 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00566">566</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 194
 195 </div>
 196 </div>
 197 <hr/>The documentation for this struct was generated from the following file:<ul>
 198 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
 199 </ul>
 200 </div><!-- contents -->
 201 <!-- start footer part -->
 202 <hr class="footer"/><address class="footer"><small>
 203 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 204 <img class="footer" src="doxygen.png" alt="doxygen"/>
 205 </a> 1.8.13
 206 </small></address>
 207 </body>
 208 </html>