add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__section__gen__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: xran_section_gen_info 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_section_gen_info 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_section_gen_info:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__section__gen__info__coll__graph.png" border="0" usemap="#xran__section__gen__info_coll__map" alt="Collaboration graph"/></div>
74 <map name="xran__section__gen__info_coll__map" id="xran__section__gen__info_coll__map">
75 <area shape="rect" id="node2" href="structxran__sectionext5__info.html" title="{xran_sectionext5_info\n|+ num_sets\l+ csf\l+ mcScaleReMask\l+ mcScaleOffset\l+ mc\l|}" alt="" coords="5,248,155,384"/>
76 <area shape="rect" id="node3" href="structxran__sectionext4__info.html" title="{xran_sectionext4_info\n|+ csf\l+ pad0\l+ modCompScaler\l|}" alt="" coords="179,263,328,369"/>
77 <area shape="rect" id="node4" href="structxran__sectionext3__info.html" title="{xran_sectionext3_info\n|+ codebookIdx\l+ layerId\l+ numLayers\l+ txScheme\l+ crsReMask\l+ crsShift\l+ crsSymNum\l+ beamIdAP1\l+ beamIdAP2\l+ beamIdAP3\l|}" alt="" coords="352,211,501,421"/>
78 <area shape="rect" id="node5" href="structxran__sectionext2__info.html" title="{xran_sectionext2_info\n|+ bfAzPtWidth\l+ bfAzPt\l+ bfZePtWidth\l+ bfZePt\l+ bfAz3ddWidth\l+ bfAz3dd\l+ bfZe3ddWidth\l+ bfZe3dd\l+ bfAzSI\l+ bfZeSI\l|}" alt="" coords="525,211,675,421"/>
79 <area shape="rect" id="node6" href="structxran__sectionext1__info.html" title="{xran_sectionext1_info\n|+ rbNumber\l+ bfwNumber\l+ bfwiqWidth\l+ bfwCompMeth\l+ p_bfwIQ\l+ bfwIQ_sz\l+ exponent\l+ blockScaler\l+ compBitWidthShift\l+ activeBeamspaceCoeffMask\l+ bfwCompParam\l|}" alt="" coords="699,204,901,428"/>
80 <area shape="rect" id="node7" href="structxran__section__info.html" title="{xran_section_info\n|+ type\l+ startSymId\l+ numSymbol\l+ symInc\l+ id\l+ reMask\l+ startPrbc\l+ numPrbc\l+ rb\l+ compMeth\land 7 more...\l|}" alt="" coords="926,204,1050,428"/>
81 <area shape="rect" id="node8" 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="923,5,1053,141"/>
82 </map>
83 </div>
84 <table class="memberdecls">
85 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
86 Data Fields</h2></td></tr>
87 <tr class="memitem:a6ccd48a36736101737e9b419d7a3cc85"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__section__info.html">xran_section_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__gen__info.html#a6ccd48a36736101737e9b419d7a3cc85">info</a></td></tr>
88 <tr class="separator:a6ccd48a36736101737e9b419d7a3cc85"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:aa561d89cbc570e39183c64a5095a6053"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__gen__info.html#aa561d89cbc570e39183c64a5095a6053">exDataSize</a></td></tr>
90 <tr class="separator:aa561d89cbc570e39183c64a5095a6053"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <tr class="memitem:ab8e4e63c68495e71cca8e6ea069b9218"><td class="memItemLeft" >struct {</td></tr>
92 <tr class="memitem:acb5cfd209ba75c853d03f701e7f91679"><td class="memItemLeft" >&#160;&#160;&#160;uint16_t&#160;&#160;&#160;<a class="el" href="structxran__section__gen__info.html#acb5cfd209ba75c853d03f701e7f91679">type</a></td></tr>
93 <tr class="separator:acb5cfd209ba75c853d03f701e7f91679"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:a8aed22e2c7b283705ec82e0120515618"><td class="memItemLeft" >&#160;&#160;&#160;uint16_t&#160;&#160;&#160;<a class="el" href="structxran__section__gen__info.html#a8aed22e2c7b283705ec82e0120515618">len</a></td></tr>
95 <tr class="separator:a8aed22e2c7b283705ec82e0120515618"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:a735984d41155bc1032e09bece8f8d66d"><td class="memItemLeft" >&#160;&#160;&#160;void *&#160;&#160;&#160;<a class="el" href="structxran__section__gen__info.html#a735984d41155bc1032e09bece8f8d66d">data</a></td></tr>
97 <tr class="separator:a735984d41155bc1032e09bece8f8d66d"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:ab8e4e63c68495e71cca8e6ea069b9218"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__gen__info.html#ab8e4e63c68495e71cca8e6ea069b9218">exData</a> [<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td></tr>
99 <tr class="separator:ab8e4e63c68495e71cca8e6ea069b9218"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <tr class="memitem:ac1c64088df7167c5a46bf9a5bb746534"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__sectionext1__info.html">xran_sectionext1_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__gen__info.html#ac1c64088df7167c5a46bf9a5bb746534">m_ext1</a> [<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td></tr>
101 <tr class="separator:ac1c64088df7167c5a46bf9a5bb746534"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <tr class="memitem:a9da3976c12b7433a90917228f7069381"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__sectionext2__info.html">xran_sectionext2_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__gen__info.html#a9da3976c12b7433a90917228f7069381">m_ext2</a> [<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td></tr>
103 <tr class="separator:a9da3976c12b7433a90917228f7069381"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <tr class="memitem:aa252bcb2bac0467e0262920ec34285a0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__sectionext3__info.html">xran_sectionext3_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__gen__info.html#aa252bcb2bac0467e0262920ec34285a0">m_ext3</a> [<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td></tr>
105 <tr class="separator:aa252bcb2bac0467e0262920ec34285a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:adaf7350928e8b26da41ded39ba7295e5"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__sectionext4__info.html">xran_sectionext4_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__gen__info.html#adaf7350928e8b26da41ded39ba7295e5">m_ext4</a> [<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td></tr>
107 <tr class="separator:adaf7350928e8b26da41ded39ba7295e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 <tr class="memitem:a6948d126d229683da976877b617fbd8e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__sectionext5__info.html">xran_sectionext5_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__gen__info.html#a6948d126d229683da976877b617fbd8e">m_ext5</a> [<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td></tr>
109 <tr class="separator:a6948d126d229683da976877b617fbd8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 </table>
111 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
112 <div class="textblock"><p>This structure to hold the information to generate the sections of C-Plane message </p>
113
114 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00295">295</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
115 </div><h2 class="groupheader">Field Documentation</h2>
116 <a id="a735984d41155bc1032e09bece8f8d66d"></a>
117 <h2 class="memtitle"><span class="permalink"><a href="#a735984d41155bc1032e09bece8f8d66d">&#9670;&nbsp;</a></span>data</h2>
118
119 <div class="memitem">
120 <div class="memproto">
121       <table class="memname">
122         <tr>
123           <td class="memname">void* data</td>
124         </tr>
125       </table>
126 </div><div class="memdoc">
127 <p>pointer to extension data </p>
128
129 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00303">303</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
130
131 </div>
132 </div>
133 <a id="ab8e4e63c68495e71cca8e6ea069b9218"></a>
134 <h2 class="memtitle"><span class="permalink"><a href="#ab8e4e63c68495e71cca8e6ea069b9218">&#9670;&nbsp;</a></span>exData</h2>
135
136 <div class="memitem">
137 <div class="memproto">
138       <table class="memname">
139         <tr>
140           <td class="memname">struct { ... }   exData[<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td>
141         </tr>
142       </table>
143 </div><div class="memdoc">
144 <p>the array to store section extension </p>
145
146 </div>
147 </div>
148 <a id="aa561d89cbc570e39183c64a5095a6053"></a>
149 <h2 class="memtitle"><span class="permalink"><a href="#aa561d89cbc570e39183c64a5095a6053">&#9670;&nbsp;</a></span>exDataSize</h2>
150
151 <div class="memitem">
152 <div class="memproto">
153       <table class="memname">
154         <tr>
155           <td class="memname">uint32_t exDataSize</td>
156         </tr>
157       </table>
158 </div><div class="memdoc">
159 <p>The number of Extensions or type 6/7 data </p>
160
161 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00298">298</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
162
163 </div>
164 </div>
165 <a id="a6ccd48a36736101737e9b419d7a3cc85"></a>
166 <h2 class="memtitle"><span class="permalink"><a href="#a6ccd48a36736101737e9b419d7a3cc85">&#9670;&nbsp;</a></span>info</h2>
167
168 <div class="memitem">
169 <div class="memproto">
170       <table class="memname">
171         <tr>
172           <td class="memname">struct <a class="el" href="structxran__section__info.html">xran_section_info</a> info</td>
173         </tr>
174       </table>
175 </div><div class="memdoc">
176 <p>The information for section </p>
177
178 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00296">296</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
179
180 </div>
181 </div>
182 <a id="a8aed22e2c7b283705ec82e0120515618"></a>
183 <h2 class="memtitle"><span class="permalink"><a href="#a8aed22e2c7b283705ec82e0120515618">&#9670;&nbsp;</a></span>len</h2>
184
185 <div class="memitem">
186 <div class="memproto">
187       <table class="memname">
188         <tr>
189           <td class="memname">uint16_t len</td>
190         </tr>
191       </table>
192 </div><div class="memdoc">
193 <p>length of extension data </p>
194
195 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00302">302</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
196
197 </div>
198 </div>
199 <a id="ac1c64088df7167c5a46bf9a5bb746534"></a>
200 <h2 class="memtitle"><span class="permalink"><a href="#ac1c64088df7167c5a46bf9a5bb746534">&#9670;&nbsp;</a></span>m_ext1</h2>
201
202 <div class="memitem">
203 <div class="memproto">
204       <table class="memname">
205         <tr>
206           <td class="memname">struct <a class="el" href="structxran__sectionext1__info.html">xran_sectionext1_info</a> m_ext1[<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td>
207         </tr>
208       </table>
209 </div><div class="memdoc">
210
211 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00305">305</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
212
213 </div>
214 </div>
215 <a id="a9da3976c12b7433a90917228f7069381"></a>
216 <h2 class="memtitle"><span class="permalink"><a href="#a9da3976c12b7433a90917228f7069381">&#9670;&nbsp;</a></span>m_ext2</h2>
217
218 <div class="memitem">
219 <div class="memproto">
220       <table class="memname">
221         <tr>
222           <td class="memname">struct <a class="el" href="structxran__sectionext2__info.html">xran_sectionext2_info</a> m_ext2[<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td>
223         </tr>
224       </table>
225 </div><div class="memdoc">
226
227 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00306">306</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
228
229 </div>
230 </div>
231 <a id="aa252bcb2bac0467e0262920ec34285a0"></a>
232 <h2 class="memtitle"><span class="permalink"><a href="#aa252bcb2bac0467e0262920ec34285a0">&#9670;&nbsp;</a></span>m_ext3</h2>
233
234 <div class="memitem">
235 <div class="memproto">
236       <table class="memname">
237         <tr>
238           <td class="memname">struct <a class="el" href="structxran__sectionext3__info.html">xran_sectionext3_info</a> m_ext3[<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td>
239         </tr>
240       </table>
241 </div><div class="memdoc">
242
243 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00307">307</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
244
245 </div>
246 </div>
247 <a id="adaf7350928e8b26da41ded39ba7295e5"></a>
248 <h2 class="memtitle"><span class="permalink"><a href="#adaf7350928e8b26da41ded39ba7295e5">&#9670;&nbsp;</a></span>m_ext4</h2>
249
250 <div class="memitem">
251 <div class="memproto">
252       <table class="memname">
253         <tr>
254           <td class="memname">struct <a class="el" href="structxran__sectionext4__info.html">xran_sectionext4_info</a> m_ext4[<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td>
255         </tr>
256       </table>
257 </div><div class="memdoc">
258
259 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00308">308</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
260
261 </div>
262 </div>
263 <a id="a6948d126d229683da976877b617fbd8e"></a>
264 <h2 class="memtitle"><span class="permalink"><a href="#a6948d126d229683da976877b617fbd8e">&#9670;&nbsp;</a></span>m_ext5</h2>
265
266 <div class="memitem">
267 <div class="memproto">
268       <table class="memname">
269         <tr>
270           <td class="memname">struct <a class="el" href="structxran__sectionext5__info.html">xran_sectionext5_info</a> m_ext5[<a class="el" href="xran__cp__api_8h.html#a68331320b5c982a49c45ae15be297dc1">XRAN_MAX_NUM_EXTENSIONS</a>]</td>
271         </tr>
272       </table>
273 </div><div class="memdoc">
274
275 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00309">309</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
276
277 </div>
278 </div>
279 <a id="acb5cfd209ba75c853d03f701e7f91679"></a>
280 <h2 class="memtitle"><span class="permalink"><a href="#acb5cfd209ba75c853d03f701e7f91679">&#9670;&nbsp;</a></span>type</h2>
281
282 <div class="memitem">
283 <div class="memproto">
284       <table class="memname">
285         <tr>
286           <td class="memname">uint16_t type</td>
287         </tr>
288       </table>
289 </div><div class="memdoc">
290 <p>the type of section extension </p>
291
292 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00301">301</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
293
294 </div>
295 </div>
296 <hr/>The documentation for this struct was generated from the following file:<ul>
297 <li><a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a></li>
298 </ul>
299 </div><!-- contents -->
300 <!-- start footer part -->
301 <hr class="footer"/><address class="footer"><small>
302 Generated by &#160;<a href="http://www.doxygen.org/index.html">
303 <img class="footer" src="doxygen.png" alt="doxygen"/>
304 </a> 1.8.13
305 </small></address>
306 </body>
307 </html>