add Doxygen documentation
[o-du/phy.git] / docs / API / structsector_handle_info.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: sectorHandleInfo 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">sectorHandleInfo 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 sectorHandleInfo:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structsector_handle_info__coll__graph.png" border="0" usemap="#sector_handle_info_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:a3e89a68b1b304e37badf1e8a62a38527"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsector_handle_info.html#a3e89a68b1b304e37badf1e8a62a38527">nIndex</a></td></tr>
79 <tr class="separator:a3e89a68b1b304e37badf1e8a62a38527"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:a6fa55fef5f643eb92ae1f3890bb239d6"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsector_handle_info.html#a6fa55fef5f643eb92ae1f3890bb239d6">nXranPort</a></td></tr>
81 <tr class="separator:a6fa55fef5f643eb92ae1f3890bb239d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a7f385bf2d48d174e82285595baa66890"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsector_handle_info.html#a7f385bf2d48d174e82285595baa66890">nBufferPoolIndex</a></td></tr>
83 <tr class="separator:a7f385bf2d48d174e82285595baa66890"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a099c95b9a26488749a7bade28dd45192"><td class="memItemLeft" align="right" valign="top">struct rte_mempool *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsector_handle_info.html#a099c95b9a26488749a7bade28dd45192">p_bufferPool</a> [<a class="el" href="xran__common_8h.html#a5a5013ea633c2924f1e36bf1e3479c6f">XRAN_MAX_POOLS_PER_SECTOR_NR</a>]</td></tr>
85 <tr class="separator:a099c95b9a26488749a7bade28dd45192"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a331562c12e62e7bae882440025872c95"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsector_handle_info.html#a331562c12e62e7bae882440025872c95">bufferPoolElmSz</a> [<a class="el" href="xran__common_8h.html#a5a5013ea633c2924f1e36bf1e3479c6f">XRAN_MAX_POOLS_PER_SECTOR_NR</a>]</td></tr>
87 <tr class="separator:a331562c12e62e7bae882440025872c95"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:af7c3fd31d7919760d9a11bd48b9ad804"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsector_handle_info.html#af7c3fd31d7919760d9a11bd48b9ad804">bufferPoolNumElm</a> [<a class="el" href="xran__common_8h.html#a5a5013ea633c2924f1e36bf1e3479c6f">XRAN_MAX_POOLS_PER_SECTOR_NR</a>]</td></tr>
89 <tr class="separator:af7c3fd31d7919760d9a11bd48b9ad804"><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">
93 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00144">144</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
94 </div><h2 class="groupheader">Field Documentation</h2>
95 <a id="a331562c12e62e7bae882440025872c95"></a>
96 <h2 class="memtitle"><span class="permalink"><a href="#a331562c12e62e7bae882440025872c95">&#9670;&nbsp;</a></span>bufferPoolElmSz</h2>
97
98 <div class="memitem">
99 <div class="memproto">
100       <table class="memname">
101         <tr>
102           <td class="memname">uint32_t bufferPoolElmSz[<a class="el" href="xran__common_8h.html#a5a5013ea633c2924f1e36bf1e3479c6f">XRAN_MAX_POOLS_PER_SECTOR_NR</a>]</td>
103         </tr>
104       </table>
105 </div><div class="memdoc">
106
107 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00155">155</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
108
109 </div>
110 </div>
111 <a id="af7c3fd31d7919760d9a11bd48b9ad804"></a>
112 <h2 class="memtitle"><span class="permalink"><a href="#af7c3fd31d7919760d9a11bd48b9ad804">&#9670;&nbsp;</a></span>bufferPoolNumElm</h2>
113
114 <div class="memitem">
115 <div class="memproto">
116       <table class="memname">
117         <tr>
118           <td class="memname">uint32_t bufferPoolNumElm[<a class="el" href="xran__common_8h.html#a5a5013ea633c2924f1e36bf1e3479c6f">XRAN_MAX_POOLS_PER_SECTOR_NR</a>]</td>
119         </tr>
120       </table>
121 </div><div class="memdoc">
122
123 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00156">156</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
124
125 </div>
126 </div>
127 <a id="a7f385bf2d48d174e82285595baa66890"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#a7f385bf2d48d174e82285595baa66890">&#9670;&nbsp;</a></span>nBufferPoolIndex</h2>
129
130 <div class="memitem">
131 <div class="memproto">
132       <table class="memname">
133         <tr>
134           <td class="memname">uint32_t nBufferPoolIndex</td>
135         </tr>
136       </table>
137 </div><div class="memdoc">
138 <p>&lt; number of antennas supported per link Buffer poolIndex </p>
139
140 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00152">152</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
141
142 </div>
143 </div>
144 <a id="a3e89a68b1b304e37badf1e8a62a38527"></a>
145 <h2 class="memtitle"><span class="permalink"><a href="#a3e89a68b1b304e37badf1e8a62a38527">&#9670;&nbsp;</a></span>nIndex</h2>
146
147 <div class="memitem">
148 <div class="memproto">
149       <table class="memname">
150         <tr>
151           <td class="memname">uint16_t nIndex</td>
152         </tr>
153       </table>
154 </div><div class="memdoc">
155 <p>&lt; Structure that contains the information to describe the instance i.e service type, virtual function, package Id etc.. </p>
156
157 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00148">148</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
158
159 </div>
160 </div>
161 <a id="a6fa55fef5f643eb92ae1f3890bb239d6"></a>
162 <h2 class="memtitle"><span class="permalink"><a href="#a6fa55fef5f643eb92ae1f3890bb239d6">&#9670;&nbsp;</a></span>nXranPort</h2>
163
164 <div class="memitem">
165 <div class="memproto">
166       <table class="memname">
167         <tr>
168           <td class="memname">uint16_t nXranPort</td>
169         </tr>
170       </table>
171 </div><div class="memdoc">
172
173 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00149">149</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
174
175 </div>
176 </div>
177 <a id="a099c95b9a26488749a7bade28dd45192"></a>
178 <h2 class="memtitle"><span class="permalink"><a href="#a099c95b9a26488749a7bade28dd45192">&#9670;&nbsp;</a></span>p_bufferPool</h2>
179
180 <div class="memitem">
181 <div class="memproto">
182       <table class="memname">
183         <tr>
184           <td class="memname">struct rte_mempool* p_bufferPool[<a class="el" href="xran__common_8h.html#a5a5013ea633c2924f1e36bf1e3479c6f">XRAN_MAX_POOLS_PER_SECTOR_NR</a>]</td>
185         </tr>
186       </table>
187 </div><div class="memdoc">
188
189 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00154">154</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
190
191 </div>
192 </div>
193 <hr/>The documentation for this struct was generated from the following file:<ul>
194 <li><a class="el" href="xran__common_8h_source.html">xran_common.h</a></li>
195 </ul>
196 </div><!-- contents -->
197 <!-- start footer part -->
198 <hr class="footer"/><address class="footer"><small>
199 Generated by &#160;<a href="http://www.doxygen.org/index.html">
200 <img class="footer" src="doxygen.png" alt="doxygen"/>
201 </a> 1.8.13
202 </small></address>
203 </body>
204 </html>