add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__prb__map.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_map 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_map 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_map:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__prb__map__coll__graph.png" border="0" usemap="#xran__prb__map_coll__map" alt="Collaboration graph"/></div>
74 <map name="xran__prb__map_coll__map" id="xran__prb__map_coll__map">
75 <area shape="rect" id="node2" href="structxran__prb__elm.html" title="{xran_prb_elm\n|+ nRBStart\l+ nRBSize\l+ nStartSymb\l+ numSymb\l+ nBeamIndex\l+ bf_weight_update\l+ compMethod\l+ iqWidth\l+ BeamFormingType\l+ @4\l|}" alt="" coords="239,204,383,413"/>
76 <area shape="rect" id="node3" 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"/>
77 <area shape="rect" id="node4" href="structxran__cp__bf__attribute.html" title="{xran_cp_bf_attribute\n|+ weight\l|}" alt="" coords="161,35,301,112"/>
78 <area shape="rect" id="node5" 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"/>
79 <area shape="rect" id="node6" href="structxran__cp__bf__precoding.html" title="{xran_cp_bf_precoding\n|+ weight\l|}" alt="" coords="480,35,629,112"/>
80 </map>
81 </div>
82 <table class="memberdecls">
83 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
84 Data Fields</h2></td></tr>
85 <tr class="memitem:a92abda0bec7c1c978fe96f87aad18067"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a92abda0bec7c1c978fe96f87aad18067">dir</a></td></tr>
86 <tr class="separator:a92abda0bec7c1c978fe96f87aad18067"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:a5ca9a2b3d2a5c902f8153e3e383049be"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a5ca9a2b3d2a5c902f8153e3e383049be">xran_port</a></td></tr>
88 <tr class="separator:a5ca9a2b3d2a5c902f8153e3e383049be"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:a1c85ead6321835264d2451291430a7da"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a1c85ead6321835264d2451291430a7da">band_id</a></td></tr>
90 <tr class="separator:a1c85ead6321835264d2451291430a7da"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <tr class="memitem:a7fd0cb6d38d73460d3eaba911462dc69"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a7fd0cb6d38d73460d3eaba911462dc69">cc_id</a></td></tr>
92 <tr class="separator:a7fd0cb6d38d73460d3eaba911462dc69"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 <tr class="memitem:a16b7b2d1f57da5ed39e7e3a026592a85"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a16b7b2d1f57da5ed39e7e3a026592a85">ru_port_id</a></td></tr>
94 <tr class="separator:a16b7b2d1f57da5ed39e7e3a026592a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:a689e28eeb2f378d4dc5f915a30f560db"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a689e28eeb2f378d4dc5f915a30f560db">tti_id</a></td></tr>
96 <tr class="separator:a689e28eeb2f378d4dc5f915a30f560db"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <tr class="memitem:afc7dda8bf6b9a76f94c88c3610d9c594"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#afc7dda8bf6b9a76f94c88c3610d9c594">start_sym_id</a></td></tr>
98 <tr class="separator:afc7dda8bf6b9a76f94c88c3610d9c594"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <tr class="memitem:a5a2ad8f5285dd33572e310069cdac3c4"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a5a2ad8f5285dd33572e310069cdac3c4">nPrbElm</a></td></tr>
100 <tr class="separator:a5a2ad8f5285dd33572e310069cdac3c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <tr class="memitem:a2357c89e196d6c8c53e29bf04d168b7e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__prb__elm.html">xran_prb_elm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prb__map.html#a2357c89e196d6c8c53e29bf04d168b7e">prbMap</a> [<a class="el" href="xran__fh__o__du_8h.html#a9435009d03a49d495b2b608129c64b61">XRAN_MAX_PRBS</a>]</td></tr>
102 <tr class="separator:a2357c89e196d6c8c53e29bf04d168b7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 </table>
104 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
105 <div class="textblock"><p>PRB map structure </p>
106
107 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00414">414</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
108 </div><h2 class="groupheader">Field Documentation</h2>
109 <a id="a1c85ead6321835264d2451291430a7da"></a>
110 <h2 class="memtitle"><span class="permalink"><a href="#a1c85ead6321835264d2451291430a7da">&#9670;&nbsp;</a></span>band_id</h2>
111
112 <div class="memitem">
113 <div class="memproto">
114       <table class="memname">
115         <tr>
116           <td class="memname">uint16_t band_id</td>
117         </tr>
118       </table>
119 </div><div class="memdoc">
120 <p>xran band id </p>
121
122 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00417">417</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
123
124 </div>
125 </div>
126 <a id="a7fd0cb6d38d73460d3eaba911462dc69"></a>
127 <h2 class="memtitle"><span class="permalink"><a href="#a7fd0cb6d38d73460d3eaba911462dc69">&#9670;&nbsp;</a></span>cc_id</h2>
128
129 <div class="memitem">
130 <div class="memproto">
131       <table class="memname">
132         <tr>
133           <td class="memname">uint16_t cc_id</td>
134         </tr>
135       </table>
136 </div><div class="memdoc">
137 <p>componnent carrier id [0 - (XRAN_MAX_SECTOR_NR-1)] </p>
138
139 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00418">418</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
140
141 </div>
142 </div>
143 <a id="a92abda0bec7c1c978fe96f87aad18067"></a>
144 <h2 class="memtitle"><span class="permalink"><a href="#a92abda0bec7c1c978fe96f87aad18067">&#9670;&nbsp;</a></span>dir</h2>
145
146 <div class="memitem">
147 <div class="memproto">
148       <table class="memname">
149         <tr>
150           <td class="memname">uint8_t dir</td>
151         </tr>
152       </table>
153 </div><div class="memdoc">
154 <p>DL or UL direction </p>
155
156 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00415">415</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
157
158 </div>
159 </div>
160 <a id="a5a2ad8f5285dd33572e310069cdac3c4"></a>
161 <h2 class="memtitle"><span class="permalink"><a href="#a5a2ad8f5285dd33572e310069cdac3c4">&#9670;&nbsp;</a></span>nPrbElm</h2>
162
163 <div class="memitem">
164 <div class="memproto">
165       <table class="memname">
166         <tr>
167           <td class="memname">uint32_t nPrbElm</td>
168         </tr>
169       </table>
170 </div><div class="memdoc">
171 <p>total number of PRB elements for given map [0- (XRAN_MAX_PRBS-1)] </p>
172
173 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00422">422</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
174
175 </div>
176 </div>
177 <a id="a2357c89e196d6c8c53e29bf04d168b7e"></a>
178 <h2 class="memtitle"><span class="permalink"><a href="#a2357c89e196d6c8c53e29bf04d168b7e">&#9670;&nbsp;</a></span>prbMap</h2>
179
180 <div class="memitem">
181 <div class="memproto">
182       <table class="memname">
183         <tr>
184           <td class="memname">struct <a class="el" href="structxran__prb__elm.html">xran_prb_elm</a> prbMap[<a class="el" href="xran__fh__o__du_8h.html#a9435009d03a49d495b2b608129c64b61">XRAN_MAX_PRBS</a>]</td>
185         </tr>
186       </table>
187 </div><div class="memdoc">
188
189 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00423">423</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
190
191 </div>
192 </div>
193 <a id="a16b7b2d1f57da5ed39e7e3a026592a85"></a>
194 <h2 class="memtitle"><span class="permalink"><a href="#a16b7b2d1f57da5ed39e7e3a026592a85">&#9670;&nbsp;</a></span>ru_port_id</h2>
195
196 <div class="memitem">
197 <div class="memproto">
198       <table class="memname">
199         <tr>
200           <td class="memname">uint16_t ru_port_id</td>
201         </tr>
202       </table>
203 </div><div class="memdoc">
204 <p>RU device antenna port id [0 - (XRAN_MAX_ANTENNA_NR-1) </p>
205
206 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00419">419</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
207
208 </div>
209 </div>
210 <a id="afc7dda8bf6b9a76f94c88c3610d9c594"></a>
211 <h2 class="memtitle"><span class="permalink"><a href="#afc7dda8bf6b9a76f94c88c3610d9c594">&#9670;&nbsp;</a></span>start_sym_id</h2>
212
213 <div class="memitem">
214 <div class="memproto">
215       <table class="memname">
216         <tr>
217           <td class="memname">uint8_t start_sym_id</td>
218         </tr>
219       </table>
220 </div><div class="memdoc">
221 <p>start symbol Id [0-13] </p>
222
223 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00421">421</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
224
225 </div>
226 </div>
227 <a id="a689e28eeb2f378d4dc5f915a30f560db"></a>
228 <h2 class="memtitle"><span class="permalink"><a href="#a689e28eeb2f378d4dc5f915a30f560db">&#9670;&nbsp;</a></span>tti_id</h2>
229
230 <div class="memitem">
231 <div class="memproto">
232       <table class="memname">
233         <tr>
234           <td class="memname">uint16_t tti_id</td>
235         </tr>
236       </table>
237 </div><div class="memdoc">
238 <p>xRAN slot id [0 - (max tti-1)] </p>
239
240 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00420">420</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
241
242 </div>
243 </div>
244 <a id="a5ca9a2b3d2a5c902f8153e3e383049be"></a>
245 <h2 class="memtitle"><span class="permalink"><a href="#a5ca9a2b3d2a5c902f8153e3e383049be">&#9670;&nbsp;</a></span>xran_port</h2>
246
247 <div class="memitem">
248 <div class="memproto">
249       <table class="memname">
250         <tr>
251           <td class="memname">uint8_t xran_port</td>
252         </tr>
253       </table>
254 </div><div class="memdoc">
255 <p>xran id of given RU [0-(XRAN_PORTS_NUM-1)] </p>
256
257 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00416">416</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
258
259 </div>
260 </div>
261 <hr/>The documentation for this struct was generated from the following file:<ul>
262 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
263 </ul>
264 </div><!-- contents -->
265 <!-- start footer part -->
266 <hr class="footer"/><address class="footer"><small>
267 Generated by &#160;<a href="http://www.doxygen.org/index.html">
268 <img class="footer" src="doxygen.png" alt="doxygen"/>
269 </a> 1.8.13
270 </small></address>
271 </body>
272 </html>