--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>o-du/phy: xran_buffer_list Struct Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">o-du/phy
+ </div>
+ <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+</div><!-- top -->
+<div class="header">
+ <div class="summary">
+<a href="#pub-attribs">Data Fields</a> </div>
+ <div class="headertitle">
+<div class="title">xran_buffer_list Struct Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>></code></p>
+<div class="dynheader">
+Collaboration diagram for xran_buffer_list:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__buffer__list__coll__graph.png" border="0" usemap="#xran__buffer__list_coll__map" alt="Collaboration graph"/></div>
+<map name="xran__buffer__list_coll__map" id="xran__buffer__list_coll__map">
+<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"/>
+</map>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Data Fields</h2></td></tr>
+<tr class="memitem:a3d723fbd99a0f76d412b2b79931fbc6e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__buffer__list.html#a3d723fbd99a0f76d412b2b79931fbc6e">nNumBuffers</a></td></tr>
+<tr class="separator:a3d723fbd99a0f76d412b2b79931fbc6e"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:afa8c44acddb126e8bb0652d7b4e4395e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__flat__buffer.html">xran_flat_buffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__buffer__list.html#afa8c44acddb126e8bb0652d7b4e4395e">pBuffers</a></td></tr>
+<tr class="separator:afa8c44acddb126e8bb0652d7b4e4395e"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a8d75dbe9027a94780bc2f31670400613"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__buffer__list.html#a8d75dbe9027a94780bc2f31670400613">pUserData</a></td></tr>
+<tr class="separator:a8d75dbe9027a94780bc2f31670400613"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a8ff74a1602372db410403d44e0bdd4a9"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__buffer__list.html#a8ff74a1602372db410403d44e0bdd4a9">pPrivateMetaData</a></td></tr>
+<tr class="separator:a8ff74a1602372db410403d44e0bdd4a9"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Scatter/Gather buffer list containing an array of Simple buffers.</p>
+<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>
+<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>
+
+<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>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a3d723fbd99a0f76d412b2b79931fbc6e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3d723fbd99a0f76d412b2b79931fbc6e">◆ </a></span>nNumBuffers</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint32_t nNumBuffers</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>Number of pointers </p>
+
+<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>
+
+</div>
+</div>
+<a id="afa8c44acddb126e8bb0652d7b4e4395e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afa8c44acddb126e8bb0652d7b4e4395e">◆ </a></span>pBuffers</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">struct <a class="el" href="structxran__flat__buffer.html">xran_flat_buffer</a>* pBuffers</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>Pointer to an unbounded array containing the number of CpaFlatBuffers defined by nNumBuffers </p>
+
+<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>
+
+</div>
+</div>
+<a id="a8ff74a1602372db410403d44e0bdd4a9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8ff74a1602372db410403d44e0bdd4a9">◆ </a></span>pPrivateMetaData</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void* pPrivateMetaData</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<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>
+
+<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>
+
+</div>
+</div>
+<a id="a8d75dbe9027a94780bc2f31670400613"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8d75dbe9027a94780bc2f31670400613">◆ </a></span>pUserData</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void* pUserData</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>This is an opaque field that is not read or modified internally. </p>
+
+<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>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>
Code Review / o-du / phy.git / blobdiff