add Doxygen documentation
[o-du/phy.git] / docs / API / struct_bbu_io_buf_ctrl_struct.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: BbuIoBufCtrlStruct 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">BbuIoBufCtrlStruct Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for BbuIoBufCtrlStruct:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="struct_bbu_io_buf_ctrl_struct__coll__graph.png" border="0" usemap="#_bbu_io_buf_ctrl_struct_coll__map" alt="Collaboration graph"/></div>
74 <map name="_bbu_io_buf_ctrl_struct_coll__map" id="_bbu_io_buf_ctrl_struct_coll__map">
75 <area shape="rect" id="node2" href="structxran__buffer__list.html" title="{xran_buffer_list\n|+ nNumBuffers\l+ pUserData\l+ pPrivateMetaData\l|}" alt="" coords="14,219,153,325"/>
76 <area shape="rect" id="node3" 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"/>
77 </map>
78 </div>
79 <table class="memberdecls">
80 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
81 Data Fields</h2></td></tr>
82 <tr class="memitem:a48c33fa4a8f2f93d51cba58b78d3cd9f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a48c33fa4a8f2f93d51cba58b78d3cd9f">bValid</a></td></tr>
83 <tr class="separator:a48c33fa4a8f2f93d51cba58b78d3cd9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a7dc97933eadb8a8049057209c3303818"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a7dc97933eadb8a8049057209c3303818">nSegToBeGen</a></td></tr>
85 <tr class="separator:a7dc97933eadb8a8049057209c3303818"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:af00b094918ddba2073443dcd755141f6"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#af00b094918ddba2073443dcd755141f6">nSegGenerated</a></td></tr>
87 <tr class="separator:af00b094918ddba2073443dcd755141f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:a09ab9a2f4541256129428a4ccabc6803"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a09ab9a2f4541256129428a4ccabc6803">nSegTransferred</a></td></tr>
89 <tr class="separator:a09ab9a2f4541256129428a4ccabc6803"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a7941f6b35742c3de02e270f7b80c8dda"><td class="memItemLeft" align="right" valign="top">struct rte_mbuf *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#a7941f6b35742c3de02e270f7b80c8dda">pData</a> [<a class="el" href="sample-app_8c.html#ac29300907d1558b4b1f7bc1091151643">N_MAX_BUFFER_SEGMENT</a>]</td></tr>
91 <tr class="separator:a7941f6b35742c3de02e270f7b80c8dda"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:ab79185e465507117d7b13fd30ec49f70"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__buffer__list.html">xran_buffer_list</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bbu_io_buf_ctrl_struct.html#ab79185e465507117d7b13fd30ec49f70">sBufferList</a></td></tr>
93 <tr class="separator:ab79185e465507117d7b13fd30ec49f70"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 </table>
95 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
96 <div class="textblock">
97 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00116">116</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
98 </div><h2 class="groupheader">Field Documentation</h2>
99 <a id="a48c33fa4a8f2f93d51cba58b78d3cd9f"></a>
100 <h2 class="memtitle"><span class="permalink"><a href="#a48c33fa4a8f2f93d51cba58b78d3cd9f">&#9670;&nbsp;</a></span>bValid</h2>
101
102 <div class="memitem">
103 <div class="memproto">
104       <table class="memname">
105         <tr>
106           <td class="memname">int32_t bValid</td>
107         </tr>
108       </table>
109 </div><div class="memdoc">
110
111 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00123">123</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
112
113 </div>
114 </div>
115 <a id="af00b094918ddba2073443dcd755141f6"></a>
116 <h2 class="memtitle"><span class="permalink"><a href="#af00b094918ddba2073443dcd755141f6">&#9670;&nbsp;</a></span>nSegGenerated</h2>
117
118 <div class="memitem">
119 <div class="memproto">
120       <table class="memname">
121         <tr>
122           <td class="memname">int32_t nSegGenerated</td>
123         </tr>
124       </table>
125 </div><div class="memdoc">
126
127 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00125">125</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
128
129 </div>
130 </div>
131 <a id="a7dc97933eadb8a8049057209c3303818"></a>
132 <h2 class="memtitle"><span class="permalink"><a href="#a7dc97933eadb8a8049057209c3303818">&#9670;&nbsp;</a></span>nSegToBeGen</h2>
133
134 <div class="memitem">
135 <div class="memproto">
136       <table class="memname">
137         <tr>
138           <td class="memname">int32_t nSegToBeGen</td>
139         </tr>
140       </table>
141 </div><div class="memdoc">
142
143 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00124">124</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
144
145 </div>
146 </div>
147 <a id="a09ab9a2f4541256129428a4ccabc6803"></a>
148 <h2 class="memtitle"><span class="permalink"><a href="#a09ab9a2f4541256129428a4ccabc6803">&#9670;&nbsp;</a></span>nSegTransferred</h2>
149
150 <div class="memitem">
151 <div class="memproto">
152       <table class="memname">
153         <tr>
154           <td class="memname">int32_t nSegTransferred</td>
155         </tr>
156       </table>
157 </div><div class="memdoc">
158
159 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00127">127</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
160
161 </div>
162 </div>
163 <a id="a7941f6b35742c3de02e270f7b80c8dda"></a>
164 <h2 class="memtitle"><span class="permalink"><a href="#a7941f6b35742c3de02e270f7b80c8dda">&#9670;&nbsp;</a></span>pData</h2>
165
166 <div class="memitem">
167 <div class="memproto">
168       <table class="memname">
169         <tr>
170           <td class="memname">struct rte_mbuf * pData</td>
171         </tr>
172       </table>
173 </div><div class="memdoc">
174
175 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00128">128</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
176
177 </div>
178 </div>
179 <a id="ab79185e465507117d7b13fd30ec49f70"></a>
180 <h2 class="memtitle"><span class="permalink"><a href="#ab79185e465507117d7b13fd30ec49f70">&#9670;&nbsp;</a></span>sBufferList</h2>
181
182 <div class="memitem">
183 <div class="memproto">
184       <table class="memname">
185         <tr>
186           <td class="memname">struct <a class="el" href="structxran__buffer__list.html">xran_buffer_list</a> sBufferList</td>
187         </tr>
188       </table>
189 </div><div class="memdoc">
190
191 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00129">129</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
192
193 </div>
194 </div>
195 <hr/>The documentation for this struct was generated from the following files:<ul>
196 <li><a class="el" href="sample-app_8c_source.html">sample-app.c</a></li>
197 <li><a class="el" href="xran__common_8h_source.html">xran_common.h</a></li>
198 </ul>
199 </div><!-- contents -->
200 <!-- start footer part -->
201 <hr class="footer"/><address class="footer"><small>
202 Generated by &#160;<a href="http://www.doxygen.org/index.html">
203 <img class="footer" src="doxygen.png" alt="doxygen"/>
204 </a> 1.8.13
205 </small></address>
206 </body>
207 </html>