docs/API/structxran__buffer__list.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_buffer_list 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_buffer_list 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_buffer_list:</div>
  72 <div class="dyncontent">
  73 <div class="center"><img src="structxran__buffer__list__coll__graph.png" border="0" usemap="#xran__buffer__list_coll__map" alt="Collaboration graph"/></div>
  74 <map name="xran__buffer__list_coll__map" id="xran__buffer__list_coll__map">
  75 <area shape="rect" id="node2" href="structxran__flat__buffer.html" title="{xran_flat_buffer\n|+ nElementLenInBytes\l+ nNumberOfElements\l+ nOffsetInBytes\l+ nIsPhyAddr\l+ pData\l+ pCtrl\l|}" alt="" coords="5,5,161,156"/>
  76 </map>
  77 </div>
  78 <table class="memberdecls">
  79 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  80 Data Fields</h2></td></tr>
  81 <tr class="memitem:a3d723fbd99a0f76d412b2b79931fbc6e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__buffer__list.html#a3d723fbd99a0f76d412b2b79931fbc6e">nNumBuffers</a></td></tr>
  82 <tr class="separator:a3d723fbd99a0f76d412b2b79931fbc6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="memitem:afa8c44acddb126e8bb0652d7b4e4395e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__flat__buffer.html">xran_flat_buffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__buffer__list.html#afa8c44acddb126e8bb0652d7b4e4395e">pBuffers</a></td></tr>
  84 <tr class="separator:afa8c44acddb126e8bb0652d7b4e4395e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <tr class="memitem:a8d75dbe9027a94780bc2f31670400613"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__buffer__list.html#a8d75dbe9027a94780bc2f31670400613">pUserData</a></td></tr>
  86 <tr class="separator:a8d75dbe9027a94780bc2f31670400613"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 <tr class="memitem:a8ff74a1602372db410403d44e0bdd4a9"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__buffer__list.html#a8ff74a1602372db410403d44e0bdd4a9">pPrivateMetaData</a></td></tr>
  88 <tr class="separator:a8ff74a1602372db410403d44e0bdd4a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 </table>
  90 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  91 <div class="textblock"><p>Scatter/Gather buffer list containing an array of Simple buffers.</p>
  92 <p>A Scatter/Gather buffer list structure. It is expected that this buffer structure will be used where more than one flat buffer can be provided on a particular API.</p>
  93 <p>IMPORTANT - The memory for the pPrivateMetaData member must be allocated by the client as contiguous memory. When allocating memory for pPrivateMetaData a call to cpaCyBufferListGetMetaSize MUST be made to determine the size of the Meta Data Buffer. The returned size (in bytes) may then be passed in a memory allocation routine to allocate the pPrivateMetaData memory. </p>
  94
  95 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00592">592</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
  96 </div><h2 class="groupheader">Field Documentation</h2>
  97 <a id="a3d723fbd99a0f76d412b2b79931fbc6e"></a>
  98 <h2 class="memtitle"><span class="permalink"><a href="#a3d723fbd99a0f76d412b2b79931fbc6e">&#9670;&nbsp;</a></span>nNumBuffers</h2>
  99
 100 <div class="memitem">
 101 <div class="memproto">
 102       <table class="memname">
 103         <tr>
 104           <td class="memname">uint32_t nNumBuffers</td>
 105         </tr>
 106       </table>
 107 </div><div class="memdoc">
 108 <p>Number of pointers </p>
 109
 110 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00594">594</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 111
 112 </div>
 113 </div>
 114 <a id="afa8c44acddb126e8bb0652d7b4e4395e"></a>
 115 <h2 class="memtitle"><span class="permalink"><a href="#afa8c44acddb126e8bb0652d7b4e4395e">&#9670;&nbsp;</a></span>pBuffers</h2>
 116
 117 <div class="memitem">
 118 <div class="memproto">
 119       <table class="memname">
 120         <tr>
 121           <td class="memname">struct <a class="el" href="structxran__flat__buffer.html">xran_flat_buffer</a>* pBuffers</td>
 122         </tr>
 123       </table>
 124 </div><div class="memdoc">
 125 <p>Pointer to an unbounded array containing the number of CpaFlatBuffers defined by nNumBuffers </p>
 126
 127 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00596">596</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 128
 129 </div>
 130 </div>
 131 <a id="a8ff74a1602372db410403d44e0bdd4a9"></a>
 132 <h2 class="memtitle"><span class="permalink"><a href="#a8ff74a1602372db410403d44e0bdd4a9">&#9670;&nbsp;</a></span>pPrivateMetaData</h2>
 133
 134 <div class="memitem">
 135 <div class="memproto">
 136       <table class="memname">
 137         <tr>
 138           <td class="memname">void* pPrivateMetaData</td>
 139         </tr>
 140       </table>
 141 </div><div class="memdoc">
 142 <p>Private Meta representation of this buffer List - the memory for this buffer needs to be allocated by the client as contiguous data. The amount of memory required is returned with a call to cpaCyBufferListGetMetaSize. If cpaCyBufferListGetMetaSize returns a size of zero no memory needs to be allocated, and this parameter can be NULL. </p>
 143
 144 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00601">601</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 145
 146 </div>
 147 </div>
 148 <a id="a8d75dbe9027a94780bc2f31670400613"></a>
 149 <h2 class="memtitle"><span class="permalink"><a href="#a8d75dbe9027a94780bc2f31670400613">&#9670;&nbsp;</a></span>pUserData</h2>
 150
 151 <div class="memitem">
 152 <div class="memproto">
 153       <table class="memname">
 154         <tr>
 155           <td class="memname">void* pUserData</td>
 156         </tr>
 157       </table>
 158 </div><div class="memdoc">
 159 <p>This is an opaque field that is not read or modified internally. </p>
 160
 161 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00599">599</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
 162
 163 </div>
 164 </div>
 165 <hr/>The documentation for this struct was generated from the following file:<ul>
 166 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
 167 </ul>
 168 </div><!-- contents -->
 169 <!-- start footer part -->
 170 <hr class="footer"/><address class="footer"><small>
 171 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 172 <img class="footer" src="doxygen.png" alt="doxygen"/>
 173 </a> 1.8.13
 174 </small></address>
 175 </body>
 176 </html>