--- /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_flat_buffer 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_flat_buffer 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_flat_buffer:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__flat__buffer__coll__graph.png" border="0" usemap="#xran__flat__buffer_coll__map" alt="Collaboration graph"/></div>
+</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:ac9d92d585877c2ef1af759479baf85fe"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#ac9d92d585877c2ef1af759479baf85fe">nElementLenInBytes</a></td></tr>
+<tr class="separator:ac9d92d585877c2ef1af759479baf85fe"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a4371798a7694f5939136dca8baa93f21"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#a4371798a7694f5939136dca8baa93f21">nNumberOfElements</a></td></tr>
+<tr class="separator:a4371798a7694f5939136dca8baa93f21"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a2c3c46f4c4709f349a0cc62bae9ca92d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#a2c3c46f4c4709f349a0cc62bae9ca92d">nOffsetInBytes</a></td></tr>
+<tr class="separator:a2c3c46f4c4709f349a0cc62bae9ca92d"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a0119c99b1fb0b423f6c1acf165cb8930"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#a0119c99b1fb0b423f6c1acf165cb8930">nIsPhyAddr</a></td></tr>
+<tr class="separator:a0119c99b1fb0b423f6c1acf165cb8930"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a77f0d5374ee675db57c0b29946ca7744"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#a77f0d5374ee675db57c0b29946ca7744">pData</a></td></tr>
+<tr class="separator:a77f0d5374ee675db57c0b29946ca7744"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:addb9297d816b26c680888115de8c9538"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__flat__buffer.html#addb9297d816b26c680888115de8c9538">pCtrl</a></td></tr>
+<tr class="separator:addb9297d816b26c680888115de8c9538"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<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>
+
+<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>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="ac9d92d585877c2ef1af759479baf85fe"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac9d92d585877c2ef1af759479baf85fe">◆ </a></span>nElementLenInBytes</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint32_t nElementLenInBytes</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<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>
+
+<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>
+
+</div>
+</div>
+<a id="a0119c99b1fb0b423f6c1acf165cb8930"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0119c99b1fb0b423f6c1acf165cb8930">◆ </a></span>nIsPhyAddr</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint32_t nIsPhyAddr</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<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>
+
+</div>
+</div>
+<a id="a4371798a7694f5939136dca8baa93f21"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4371798a7694f5939136dca8baa93f21">◆ </a></span>nNumberOfElements</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint32_t nNumberOfElements</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>The number of elements in the physical contiguous memory segment </p>
+
+<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>
+
+</div>
+</div>
+<a id="a2c3c46f4c4709f349a0cc62bae9ca92d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2c3c46f4c4709f349a0cc62bae9ca92d">◆ </a></span>nOffsetInBytes</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint32_t nOffsetInBytes</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>Offset in bytes to the start of the data in the physical contiguous memory segment </p>
+
+<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>
+
+</div>
+</div>
+<a id="addb9297d816b26c680888115de8c9538"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#addb9297d816b26c680888115de8c9538">◆ </a></span>pCtrl</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void* pCtrl</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<p>pointer to control section coresponding to data buffer </p>
+
+<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>
+
+</div>
+</div>
+<a id="a77f0d5374ee675db57c0b29946ca7744"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a77f0d5374ee675db57c0b29946ca7744">◆ </a></span>pData</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">uint8_t* pData</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+<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>
+
+<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>
+
+</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