add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__prb__elm.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_prb_elm 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_prb_elm 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_prb_elm:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__prb__elm__coll__graph.png" border="0" usemap="#xran__prb__elm_coll__map" alt="Collaboration graph"/></div>
74 <map name="xran__prb__elm_coll__map" id="xran__prb__elm_coll__map">
75 <area shape="rect" id="node2" href="structxran__cp__bf__weight.html" title="{xran_cp_bf_weight\n|+ nAntElmTRx\l+ p_ext_section\l+ ext_section_sz\l|}" alt="" coords="5,20,136,127"/>
76 <area shape="rect" id="node3" href="structxran__cp__bf__attribute.html" title="{xran_cp_bf_attribute\n|+ weight\l|}" alt="" coords="161,35,301,112"/>
77 <area shape="rect" id="node4" href="structxran__section__desc.html" title="{xran_section_desc\n|+ section_id\l+ iq_buffer_offset\l+ iq_buffer_len\l+ pData\l+ pCtrl\l|}" alt="" coords="325,5,456,141"/>
78 <area shape="rect" id="node5" href="structxran__cp__bf__precoding.html" title="{xran_cp_bf_precoding\n|+ weight\l|}" alt="" coords="480,35,629,112"/>
79 </map>
80 </div>
81 <table class="memberdecls">
82 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
83 Data Fields</h2></td></tr>
84 <tr class="memitem:a5248ad5c1a177b8b9d5ef60f710652bc"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a5248ad5c1a177b8b9d5ef60f710652bc">nRBStart</a></td></tr>
85 <tr class="separator:a5248ad5c1a177b8b9d5ef60f710652bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a18adf7163dacc5bd7dd344fb1216f729"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a18adf7163dacc5bd7dd344fb1216f729">nRBSize</a></td></tr>
87 <tr class="separator:a18adf7163dacc5bd7dd344fb1216f729"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:a5acab5eec7096fb7732c804f71f02a4d"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a5acab5eec7096fb7732c804f71f02a4d">nStartSymb</a></td></tr>
89 <tr class="separator:a5acab5eec7096fb7732c804f71f02a4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:ad2586af82c76901c361a2d08a6ba553b"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#ad2586af82c76901c361a2d08a6ba553b">numSymb</a></td></tr>
91 <tr class="separator:ad2586af82c76901c361a2d08a6ba553b"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:aba198438bbacf8f73b6bfa481b365ce5"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#aba198438bbacf8f73b6bfa481b365ce5">nBeamIndex</a></td></tr>
93 <tr class="separator:aba198438bbacf8f73b6bfa481b365ce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:a0cae38b481020301f9e6831c27b5058b"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a0cae38b481020301f9e6831c27b5058b">bf_weight_update</a></td></tr>
95 <tr class="separator:a0cae38b481020301f9e6831c27b5058b"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:ad73157f14fa98c54fb563244c1327933"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#ad73157f14fa98c54fb563244c1327933">compMethod</a></td></tr>
97 <tr class="separator:ad73157f14fa98c54fb563244c1327933"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:a36f5a0cedd274c3ec55f81535f06e0de"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a36f5a0cedd274c3ec55f81535f06e0de">iqWidth</a></td></tr>
99 <tr class="separator:a36f5a0cedd274c3ec55f81535f06e0de"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <tr class="memitem:a8b8b1bd49f0c7c15063d74dd4ad48cde"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a8b8b1bd49f0c7c15063d74dd4ad48cde">BeamFormingType</a></td></tr>
101 <tr class="separator:a8b8b1bd49f0c7c15063d74dd4ad48cde"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <tr class="memitem:a6c405fdd34c38d29b355cd051527ad9b"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__section__desc.html">xran_section_desc</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#a6c405fdd34c38d29b355cd051527ad9b">p_sec_desc</a> [<a class="el" href="xran__fh__o__du_8h.html#a87d92ec177ed9c388685a91051f66205">XRAN_NUM_OF_SYMBOL_PER_SLOT</a>]</td></tr>
103 <tr class="separator:a6c405fdd34c38d29b355cd051527ad9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <tr class="memitem:af868e8b704cfa4b2cfc9f02b14bb8ca4"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__cp__bf__weight.html">xran_cp_bf_weight</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__elm.html#af868e8b704cfa4b2cfc9f02b14bb8ca4">bf_weight</a></td></tr>
105 <tr class="separator:af868e8b704cfa4b2cfc9f02b14bb8ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:a792a3f6fb505ec20367144c2cd79f295"><td class="memItemLeft" >union {</td></tr>
107 <tr class="memitem:a3e5b780c49cb9d6ec97dcd4762f8ac34"><td class="memItemLeft" >&#160;&#160;&#160;struct <a class="el" href="structxran__cp__bf__attribute.html">xran_cp_bf_attribute</a>&#160;&#160;&#160;<a class="el" href="structxran__prb__elm.html#a3e5b780c49cb9d6ec97dcd4762f8ac34">bf_attribute</a></td></tr>
108 <tr class="separator:a3e5b780c49cb9d6ec97dcd4762f8ac34"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 <tr class="memitem:a78ed222752b307427c62c9f4c1e4c8be"><td class="memItemLeft" >&#160;&#160;&#160;struct <a class="el" href="structxran__cp__bf__precoding.html">xran_cp_bf_precoding</a>&#160;&#160;&#160;<a class="el" href="structxran__prb__elm.html#a78ed222752b307427c62c9f4c1e4c8be">bf_precoding</a></td></tr>
110 <tr class="separator:a78ed222752b307427c62c9f4c1e4c8be"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <tr class="memitem:a792a3f6fb505ec20367144c2cd79f295"><td class="memItemLeft" valign="top">};&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
112 <tr class="separator:a792a3f6fb505ec20367144c2cd79f295"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 </table>
114 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
115 <div class="textblock"><p>PRB element structure </p>
116
117 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00393">393</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
118 </div><h2 class="groupheader">Field Documentation</h2>
119 <a id="a792a3f6fb505ec20367144c2cd79f295"></a>
120 <h2 class="memtitle"><span class="permalink"><a href="#a792a3f6fb505ec20367144c2cd79f295">&#9670;&nbsp;</a></span>@4</h2>
121
122 <div class="memitem">
123 <div class="memproto">
124       <table class="memname">
125         <tr>
126           <td class="memname">union { ... } </td>
127         </tr>
128       </table>
129 </div><div class="memdoc">
130
131 </div>
132 </div>
133 <a id="a8b8b1bd49f0c7c15063d74dd4ad48cde"></a>
134 <h2 class="memtitle"><span class="permalink"><a href="#a8b8b1bd49f0c7c15063d74dd4ad48cde">&#9670;&nbsp;</a></span>BeamFormingType</h2>
135
136 <div class="memitem">
137 <div class="memproto">
138       <table class="memname">
139         <tr>
140           <td class="memname">int16_t BeamFormingType</td>
141         </tr>
142       </table>
143 </div><div class="memdoc">
144 <p>index based, weights based or attribute based beam forming </p>
145
146 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00402">402</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
147
148 </div>
149 </div>
150 <a id="a3e5b780c49cb9d6ec97dcd4762f8ac34"></a>
151 <h2 class="memtitle"><span class="permalink"><a href="#a3e5b780c49cb9d6ec97dcd4762f8ac34">&#9670;&nbsp;</a></span>bf_attribute</h2>
152
153 <div class="memitem">
154 <div class="memproto">
155       <table class="memname">
156         <tr>
157           <td class="memname">struct <a class="el" href="structxran__cp__bf__attribute.html">xran_cp_bf_attribute</a> bf_attribute</td>
158         </tr>
159       </table>
160 </div><div class="memdoc">
161
162 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00408">408</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
163
164 </div>
165 </div>
166 <a id="a78ed222752b307427c62c9f4c1e4c8be"></a>
167 <h2 class="memtitle"><span class="permalink"><a href="#a78ed222752b307427c62c9f4c1e4c8be">&#9670;&nbsp;</a></span>bf_precoding</h2>
168
169 <div class="memitem">
170 <div class="memproto">
171       <table class="memname">
172         <tr>
173           <td class="memname">struct <a class="el" href="structxran__cp__bf__precoding.html">xran_cp_bf_precoding</a> bf_precoding</td>
174         </tr>
175       </table>
176 </div><div class="memdoc">
177
178 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00409">409</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
179
180 </div>
181 </div>
182 <a id="af868e8b704cfa4b2cfc9f02b14bb8ca4"></a>
183 <h2 class="memtitle"><span class="permalink"><a href="#af868e8b704cfa4b2cfc9f02b14bb8ca4">&#9670;&nbsp;</a></span>bf_weight</h2>
184
185 <div class="memitem">
186 <div class="memproto">
187       <table class="memname">
188         <tr>
189           <td class="memname">struct <a class="el" href="structxran__cp__bf__weight.html">xran_cp_bf_weight</a> bf_weight</td>
190         </tr>
191       </table>
192 </div><div class="memdoc">
193 <p>beam forming information relevant for given RBs </p>
194
195 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00405">405</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
196
197 </div>
198 </div>
199 <a id="a0cae38b481020301f9e6831c27b5058b"></a>
200 <h2 class="memtitle"><span class="permalink"><a href="#a0cae38b481020301f9e6831c27b5058b">&#9670;&nbsp;</a></span>bf_weight_update</h2>
201
202 <div class="memitem">
203 <div class="memproto">
204       <table class="memname">
205         <tr>
206           <td class="memname">int16_t bf_weight_update</td>
207         </tr>
208       </table>
209 </div><div class="memdoc">
210
211 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00399">399</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
212
213 </div>
214 </div>
215 <a id="ad73157f14fa98c54fb563244c1327933"></a>
216 <h2 class="memtitle"><span class="permalink"><a href="#ad73157f14fa98c54fb563244c1327933">&#9670;&nbsp;</a></span>compMethod</h2>
217
218 <div class="memitem">
219 <div class="memproto">
220       <table class="memname">
221         <tr>
222           <td class="memname">int16_t compMethod</td>
223         </tr>
224       </table>
225 </div><div class="memdoc">
226 <p>need to update beam weights or not compression index for given PRB </p>
227
228 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00400">400</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
229
230 </div>
231 </div>
232 <a id="a36f5a0cedd274c3ec55f81535f06e0de"></a>
233 <h2 class="memtitle"><span class="permalink"><a href="#a36f5a0cedd274c3ec55f81535f06e0de">&#9670;&nbsp;</a></span>iqWidth</h2>
234
235 <div class="memitem">
236 <div class="memproto">
237       <table class="memname">
238         <tr>
239           <td class="memname">int16_t iqWidth</td>
240         </tr>
241       </table>
242 </div><div class="memdoc">
243 <p>compression bit width for given PRB </p>
244
245 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00401">401</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
246
247 </div>
248 </div>
249 <a id="aba198438bbacf8f73b6bfa481b365ce5"></a>
250 <h2 class="memtitle"><span class="permalink"><a href="#aba198438bbacf8f73b6bfa481b365ce5">&#9670;&nbsp;</a></span>nBeamIndex</h2>
251
252 <div class="memitem">
253 <div class="memproto">
254       <table class="memname">
255         <tr>
256           <td class="memname">int16_t nBeamIndex</td>
257         </tr>
258       </table>
259 </div><div class="memdoc">
260 <p>beam index for given PRB </p>
261
262 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00398">398</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
263
264 </div>
265 </div>
266 <a id="a18adf7163dacc5bd7dd344fb1216f729"></a>
267 <h2 class="memtitle"><span class="permalink"><a href="#a18adf7163dacc5bd7dd344fb1216f729">&#9670;&nbsp;</a></span>nRBSize</h2>
268
269 <div class="memitem">
270 <div class="memproto">
271       <table class="memname">
272         <tr>
273           <td class="memname">int16_t nRBSize</td>
274         </tr>
275       </table>
276 </div><div class="memdoc">
277 <p>number of RBs used </p>
278
279 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00395">395</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
280
281 </div>
282 </div>
283 <a id="a5248ad5c1a177b8b9d5ef60f710652bc"></a>
284 <h2 class="memtitle"><span class="permalink"><a href="#a5248ad5c1a177b8b9d5ef60f710652bc">&#9670;&nbsp;</a></span>nRBStart</h2>
285
286 <div class="memitem">
287 <div class="memproto">
288       <table class="memname">
289         <tr>
290           <td class="memname">int16_t nRBStart</td>
291         </tr>
292       </table>
293 </div><div class="memdoc">
294 <p>start RB of RB allocation </p>
295
296 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00394">394</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
297
298 </div>
299 </div>
300 <a id="a5acab5eec7096fb7732c804f71f02a4d"></a>
301 <h2 class="memtitle"><span class="permalink"><a href="#a5acab5eec7096fb7732c804f71f02a4d">&#9670;&nbsp;</a></span>nStartSymb</h2>
302
303 <div class="memitem">
304 <div class="memproto">
305       <table class="memname">
306         <tr>
307           <td class="memname">int16_t nStartSymb</td>
308         </tr>
309       </table>
310 </div><div class="memdoc">
311 <p>start symbol ID </p>
312
313 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00396">396</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
314
315 </div>
316 </div>
317 <a id="ad2586af82c76901c361a2d08a6ba553b"></a>
318 <h2 class="memtitle"><span class="permalink"><a href="#ad2586af82c76901c361a2d08a6ba553b">&#9670;&nbsp;</a></span>numSymb</h2>
319
320 <div class="memitem">
321 <div class="memproto">
322       <table class="memname">
323         <tr>
324           <td class="memname">int16_t numSymb</td>
325         </tr>
326       </table>
327 </div><div class="memdoc">
328 <p>number of symbols </p>
329
330 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00397">397</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
331
332 </div>
333 </div>
334 <a id="a6c405fdd34c38d29b355cd051527ad9b"></a>
335 <h2 class="memtitle"><span class="permalink"><a href="#a6c405fdd34c38d29b355cd051527ad9b">&#9670;&nbsp;</a></span>p_sec_desc</h2>
336
337 <div class="memitem">
338 <div class="memproto">
339       <table class="memname">
340         <tr>
341           <td class="memname">struct <a class="el" href="structxran__section__desc.html">xran_section_desc</a>* p_sec_desc[<a class="el" href="xran__fh__o__du_8h.html#a87d92ec177ed9c388685a91051f66205">XRAN_NUM_OF_SYMBOL_PER_SLOT</a>]</td>
342         </tr>
343       </table>
344 </div><div class="memdoc">
345 <p>section desctiptors to U-plane data given RBs </p>
346
347 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00404">404</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
348
349 </div>
350 </div>
351 <hr/>The documentation for this struct was generated from the following file:<ul>
352 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
353 </ul>
354 </div><!-- contents -->
355 <!-- start footer part -->
356 <hr class="footer"/><address class="footer"><small>
357 Generated by &#160;<a href="http://www.doxygen.org/index.html">
358 <img class="footer" src="doxygen.png" alt="doxygen"/>
359 </a> 1.8.13
360 </small></address>
361 </body>
362 </html>