add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__cp__rbmap__list.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_cp_rbmap_list 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_cp_rbmap_list Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_cp_rbmap_list:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__cp__rbmap__list__coll__graph.png" border="0" usemap="#xran__cp__rbmap__list_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:acbe4924d3235876d0b54c3c9ef6f8149"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#acbe4924d3235876d0b54c3c9ef6f8149">grp_id</a></td></tr>
79 <tr class="separator:acbe4924d3235876d0b54c3c9ef6f8149"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:a23b2201c117393dd97c63e750e211d57"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a23b2201c117393dd97c63e750e211d57">sym_start</a></td></tr>
81 <tr class="separator:a23b2201c117393dd97c63e750e211d57"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:aa3855fbdf569667bde1830fe8033078a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#aa3855fbdf569667bde1830fe8033078a">sym_num</a></td></tr>
83 <tr class="separator:aa3855fbdf569667bde1830fe8033078a"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a1e0c8aee4bb2520855c655fc3f5ddb3e"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a1e0c8aee4bb2520855c655fc3f5ddb3e">rb_start</a></td></tr>
85 <tr class="separator:a1e0c8aee4bb2520855c655fc3f5ddb3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:af7735abb4d0e98bff75f6ca302402fd1"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#af7735abb4d0e98bff75f6ca302402fd1">rb_num</a></td></tr>
87 <tr class="separator:af7735abb4d0e98bff75f6ca302402fd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:abde12917f82ac21d3b35f788384b69d4"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#abde12917f82ac21d3b35f788384b69d4">iq_buff_offset</a></td></tr>
89 <tr class="separator:abde12917f82ac21d3b35f788384b69d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a4743b4bb624ddabc85672184430d9d70"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a4743b4bb624ddabc85672184430d9d70">iq_buff_len</a></td></tr>
91 <tr class="separator:a4743b4bb624ddabc85672184430d9d70"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:a599d618c91d4ce33661381801a7dca9a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a599d618c91d4ce33661381801a7dca9a">beam_id</a></td></tr>
93 <tr class="separator:a599d618c91d4ce33661381801a7dca9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:a1520b1ef6131bff6c14b88d849c266c5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a1520b1ef6131bff6c14b88d849c266c5">iqWidth</a></td></tr>
95 <tr class="separator:a1520b1ef6131bff6c14b88d849c266c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:aba2cd161fa32b47ca78d0a2e4cf605c3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#aba2cd161fa32b47ca78d0a2e4cf605c3">comp_meth</a></td></tr>
97 <tr class="separator:aba2cd161fa32b47ca78d0a2e4cf605c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:a0976e33e213bf38d277b829252a1ceaa"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__rbmap__list.html#a0976e33e213bf38d277b829252a1ceaa">pad0</a></td></tr>
99 <tr class="separator:a0976e33e213bf38d277b829252a1ceaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 </table>
101 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
102 <div class="textblock"><p>This structure to hold the information of RB allocation from PHY to send data for allocated RBs only. </p>
103
104 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00329">329</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
105 </div><h2 class="groupheader">Field Documentation</h2>
106 <a id="a599d618c91d4ce33661381801a7dca9a"></a>
107 <h2 class="memtitle"><span class="permalink"><a href="#a599d618c91d4ce33661381801a7dca9a">&#9670;&nbsp;</a></span>beam_id</h2>
108
109 <div class="memitem">
110 <div class="memproto">
111       <table class="memname">
112         <tr>
113           <td class="memname">uint16_t beam_id</td>
114         </tr>
115       </table>
116 </div><div class="memdoc">
117 <p>Bean Index </p>
118
119 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00341">341</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
120
121 </div>
122 </div>
123 <a id="aba2cd161fa32b47ca78d0a2e4cf605c3"></a>
124 <h2 class="memtitle"><span class="permalink"><a href="#aba2cd161fa32b47ca78d0a2e4cf605c3">&#9670;&nbsp;</a></span>comp_meth</h2>
125
126 <div class="memitem">
127 <div class="memproto">
128       <table class="memname">
129         <tr>
130           <td class="memname">uint8_t comp_meth</td>
131         </tr>
132       </table>
133 </div><div class="memdoc">
134 <p>Compression method </p>
135
136 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00343">343</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
137
138 </div>
139 </div>
140 <a id="acbe4924d3235876d0b54c3c9ef6f8149"></a>
141 <h2 class="memtitle"><span class="permalink"><a href="#acbe4924d3235876d0b54c3c9ef6f8149">&#9670;&nbsp;</a></span>grp_id</h2>
142
143 <div class="memitem">
144 <div class="memproto">
145       <table class="memname">
146         <tr>
147           <td class="memname">uint16_t grp_id</td>
148         </tr>
149       </table>
150 </div><div class="memdoc">
151 <p>group id for this entry, reserved for future use </p>
152
153 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00330">330</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
154
155 </div>
156 </div>
157 <a id="a4743b4bb624ddabc85672184430d9d70"></a>
158 <h2 class="memtitle"><span class="permalink"><a href="#a4743b4bb624ddabc85672184430d9d70">&#9670;&nbsp;</a></span>iq_buff_len</h2>
159
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname">int16_t iq_buff_len</td>
165         </tr>
166       </table>
167 </div><div class="memdoc">
168 <p>length IQs </p>
169
170 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00339">339</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
171
172 </div>
173 </div>
174 <a id="abde12917f82ac21d3b35f788384b69d4"></a>
175 <h2 class="memtitle"><span class="permalink"><a href="#abde12917f82ac21d3b35f788384b69d4">&#9670;&nbsp;</a></span>iq_buff_offset</h2>
176
177 <div class="memitem">
178 <div class="memproto">
179       <table class="memname">
180         <tr>
181           <td class="memname">int16_t iq_buff_offset</td>
182         </tr>
183       </table>
184 </div><div class="memdoc">
185 <p>Offset within Sym for start of IQs </p>
186
187 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00338">338</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
188
189 </div>
190 </div>
191 <a id="a1520b1ef6131bff6c14b88d849c266c5"></a>
192 <h2 class="memtitle"><span class="permalink"><a href="#a1520b1ef6131bff6c14b88d849c266c5">&#9670;&nbsp;</a></span>iqWidth</h2>
193
194 <div class="memitem">
195 <div class="memproto">
196       <table class="memname">
197         <tr>
198           <td class="memname">uint8_t iqWidth</td>
199         </tr>
200       </table>
201 </div><div class="memdoc">
202 <p>I and Q width in bits </p>
203
204 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00342">342</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
205
206 </div>
207 </div>
208 <a id="a0976e33e213bf38d277b829252a1ceaa"></a>
209 <h2 class="memtitle"><span class="permalink"><a href="#a0976e33e213bf38d277b829252a1ceaa">&#9670;&nbsp;</a></span>pad0</h2>
210
211 <div class="memitem">
212 <div class="memproto">
213       <table class="memname">
214         <tr>
215           <td class="memname">uint8_t pad0</td>
216         </tr>
217       </table>
218 </div><div class="memdoc">
219
220 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00344">344</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
221
222 </div>
223 </div>
224 <a id="af7735abb4d0e98bff75f6ca302402fd1"></a>
225 <h2 class="memtitle"><span class="permalink"><a href="#af7735abb4d0e98bff75f6ca302402fd1">&#9670;&nbsp;</a></span>rb_num</h2>
226
227 <div class="memitem">
228 <div class="memproto">
229       <table class="memname">
230         <tr>
231           <td class="memname">uint16_t rb_num</td>
232         </tr>
233       </table>
234 </div><div class="memdoc">
235 <p>Number of RBs </p>
236
237 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00336">336</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
238
239 </div>
240 </div>
241 <a id="a1e0c8aee4bb2520855c655fc3f5ddb3e"></a>
242 <h2 class="memtitle"><span class="permalink"><a href="#a1e0c8aee4bb2520855c655fc3f5ddb3e">&#9670;&nbsp;</a></span>rb_start</h2>
243
244 <div class="memitem">
245 <div class="memproto">
246       <table class="memname">
247         <tr>
248           <td class="memname">uint16_t rb_start</td>
249         </tr>
250       </table>
251 </div><div class="memdoc">
252 <p>Start RB position </p>
253
254 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00335">335</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
255
256 </div>
257 </div>
258 <a id="aa3855fbdf569667bde1830fe8033078a"></a>
259 <h2 class="memtitle"><span class="permalink"><a href="#aa3855fbdf569667bde1830fe8033078a">&#9670;&nbsp;</a></span>sym_num</h2>
260
261 <div class="memitem">
262 <div class="memproto">
263       <table class="memname">
264         <tr>
265           <td class="memname">uint8_t sym_num</td>
266         </tr>
267       </table>
268 </div><div class="memdoc">
269 <p>Number of symbols </p>
270
271 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00333">333</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
272
273 </div>
274 </div>
275 <a id="a23b2201c117393dd97c63e750e211d57"></a>
276 <h2 class="memtitle"><span class="permalink"><a href="#a23b2201c117393dd97c63e750e211d57">&#9670;&nbsp;</a></span>sym_start</h2>
277
278 <div class="memitem">
279 <div class="memproto">
280       <table class="memname">
281         <tr>
282           <td class="memname">uint8_t sym_start</td>
283         </tr>
284       </table>
285 </div><div class="memdoc">
286 <p>Start symbol ID </p>
287
288 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00332">332</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
289
290 </div>
291 </div>
292 <hr/>The documentation for this struct was generated from the following file:<ul>
293 <li><a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a></li>
294 </ul>
295 </div><!-- contents -->
296 <!-- start footer part -->
297 <hr class="footer"/><address class="footer"><small>
298 Generated by &#160;<a href="http://www.doxygen.org/index.html">
299 <img class="footer" src="doxygen.png" alt="doxygen"/>
300 </a> 1.8.13
301 </small></address>
302 </body>
303 </html>