add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__sectionext1__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_sectionext1_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_sectionext1_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_sectionext1_info:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__sectionext1__info__coll__graph.png" border="0" usemap="#xran__sectionext1__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:ad07777df733bfd87b118b5ea683fcb3b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#ad07777df733bfd87b118b5ea683fcb3b">rbNumber</a></td></tr>
79 <tr class="separator:ad07777df733bfd87b118b5ea683fcb3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:ab09d1df0b229edfd34c41706fcfa73e7"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#ab09d1df0b229edfd34c41706fcfa73e7">bfwNumber</a></td></tr>
81 <tr class="separator:ab09d1df0b229edfd34c41706fcfa73e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a3de53935627d11e11003c38bd6dca548"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#a3de53935627d11e11003c38bd6dca548">bfwiqWidth</a></td></tr>
83 <tr class="separator:a3de53935627d11e11003c38bd6dca548"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a489f0b868b86e577a5e515dc40987ba5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#a489f0b868b86e577a5e515dc40987ba5">bfwCompMeth</a></td></tr>
85 <tr class="separator:a489f0b868b86e577a5e515dc40987ba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a535b83a8653a891f80fc204eb1d9cb8b"><td class="memItemLeft" align="right" valign="top">int16_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#a535b83a8653a891f80fc204eb1d9cb8b">p_bfwIQ</a></td></tr>
87 <tr class="separator:a535b83a8653a891f80fc204eb1d9cb8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:ae4f265cd1e2941e2d7366085f6f0b598"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#ae4f265cd1e2941e2d7366085f6f0b598">bfwIQ_sz</a></td></tr>
89 <tr class="separator:ae4f265cd1e2941e2d7366085f6f0b598"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:ae3551ba3eeae98639805a8d3391d5b3d"><td class="memItemLeft" >union {</td></tr>
91 <tr class="memitem:af05d5abe7656953548edfb3eb5117659"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structxran__sectionext1__info.html#af05d5abe7656953548edfb3eb5117659">exponent</a></td></tr>
92 <tr class="separator:af05d5abe7656953548edfb3eb5117659"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 <tr class="memitem:ad32c6c9662025c7208ec099075b7ec27"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structxran__sectionext1__info.html#ad32c6c9662025c7208ec099075b7ec27">blockScaler</a></td></tr>
94 <tr class="separator:ad32c6c9662025c7208ec099075b7ec27"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:ac538592c50bd54df6d3c3dfb98fd1a96"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structxran__sectionext1__info.html#ac538592c50bd54df6d3c3dfb98fd1a96">compBitWidthShift</a></td></tr>
96 <tr class="separator:ac538592c50bd54df6d3c3dfb98fd1a96"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <tr class="memitem:abeddf07371133e2a155418d2ad6e6606"><td class="memItemLeft" >&#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="structxran__sectionext1__info.html#abeddf07371133e2a155418d2ad6e6606">activeBeamspaceCoeffMask</a> [<a class="el" href="xran__cp__api_8h.html#acf59e7a9af32c6c8c8dd3d7b1e6ee0ca">XRAN_MAX_BFW_N</a>]</td></tr>
98 <tr class="separator:abeddf07371133e2a155418d2ad6e6606"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <tr class="memitem:ae3551ba3eeae98639805a8d3391d5b3d"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__sectionext1__info.html#ae3551ba3eeae98639805a8d3391d5b3d">bfwCompParam</a></td></tr>
100 <tr class="separator:ae3551ba3eeae98639805a8d3391d5b3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 </table>
102 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
103 <div class="textblock">
104 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00209">209</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="abeddf07371133e2a155418d2ad6e6606"></a>
107 <h2 class="memtitle"><span class="permalink"><a href="#abeddf07371133e2a155418d2ad6e6606">&#9670;&nbsp;</a></span>activeBeamspaceCoeffMask</h2>
108
109 <div class="memitem">
110 <div class="memproto">
111       <table class="memname">
112         <tr>
113           <td class="memname">uint8_t activeBeamspaceCoeffMask[<a class="el" href="xran__cp__api_8h.html#acf59e7a9af32c6c8c8dd3d7b1e6ee0ca">XRAN_MAX_BFW_N</a>]</td>
114         </tr>
115       </table>
116 </div><div class="memdoc">
117
118 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00220">220</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
119
120 </div>
121 </div>
122 <a id="a489f0b868b86e577a5e515dc40987ba5"></a>
123 <h2 class="memtitle"><span class="permalink"><a href="#a489f0b868b86e577a5e515dc40987ba5">&#9670;&nbsp;</a></span>bfwCompMeth</h2>
124
125 <div class="memitem">
126 <div class="memproto">
127       <table class="memname">
128         <tr>
129           <td class="memname">uint8_t bfwCompMeth</td>
130         </tr>
131       </table>
132 </div><div class="memdoc">
133
134 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00213">213</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
135
136 </div>
137 </div>
138 <a id="ae3551ba3eeae98639805a8d3391d5b3d"></a>
139 <h2 class="memtitle"><span class="permalink"><a href="#ae3551ba3eeae98639805a8d3391d5b3d">&#9670;&nbsp;</a></span>bfwCompParam</h2>
140
141 <div class="memitem">
142 <div class="memproto">
143       <table class="memname">
144         <tr>
145           <td class="memname">union { ... }   bfwCompParam</td>
146         </tr>
147       </table>
148 </div><div class="memdoc">
149
150 </div>
151 </div>
152 <a id="ae4f265cd1e2941e2d7366085f6f0b598"></a>
153 <h2 class="memtitle"><span class="permalink"><a href="#ae4f265cd1e2941e2d7366085f6f0b598">&#9670;&nbsp;</a></span>bfwIQ_sz</h2>
154
155 <div class="memitem">
156 <div class="memproto">
157       <table class="memname">
158         <tr>
159           <td class="memname">int16_t bfwIQ_sz</td>
160         </tr>
161       </table>
162 </div><div class="memdoc">
163 <p>size of buffer with section extention information </p>
164
165 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00215">215</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
166
167 </div>
168 </div>
169 <a id="a3de53935627d11e11003c38bd6dca548"></a>
170 <h2 class="memtitle"><span class="permalink"><a href="#a3de53935627d11e11003c38bd6dca548">&#9670;&nbsp;</a></span>bfwiqWidth</h2>
171
172 <div class="memitem">
173 <div class="memproto">
174       <table class="memname">
175         <tr>
176           <td class="memname">uint8_t bfwiqWidth</td>
177         </tr>
178       </table>
179 </div><div class="memdoc">
180
181 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00212">212</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
182
183 </div>
184 </div>
185 <a id="ab09d1df0b229edfd34c41706fcfa73e7"></a>
186 <h2 class="memtitle"><span class="permalink"><a href="#ab09d1df0b229edfd34c41706fcfa73e7">&#9670;&nbsp;</a></span>bfwNumber</h2>
187
188 <div class="memitem">
189 <div class="memproto">
190       <table class="memname">
191         <tr>
192           <td class="memname">uint16_t bfwNumber</td>
193         </tr>
194       </table>
195 </div><div class="memdoc">
196 <p>number of bf weights in this section </p>
197
198 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00211">211</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
199
200 </div>
201 </div>
202 <a id="ad32c6c9662025c7208ec099075b7ec27"></a>
203 <h2 class="memtitle"><span class="permalink"><a href="#ad32c6c9662025c7208ec099075b7ec27">&#9670;&nbsp;</a></span>blockScaler</h2>
204
205 <div class="memitem">
206 <div class="memproto">
207       <table class="memname">
208         <tr>
209           <td class="memname">uint8_t blockScaler</td>
210         </tr>
211       </table>
212 </div><div class="memdoc">
213
214 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00218">218</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
215
216 </div>
217 </div>
218 <a id="ac538592c50bd54df6d3c3dfb98fd1a96"></a>
219 <h2 class="memtitle"><span class="permalink"><a href="#ac538592c50bd54df6d3c3dfb98fd1a96">&#9670;&nbsp;</a></span>compBitWidthShift</h2>
220
221 <div class="memitem">
222 <div class="memproto">
223       <table class="memname">
224         <tr>
225           <td class="memname">uint8_t compBitWidthShift</td>
226         </tr>
227       </table>
228 </div><div class="memdoc">
229
230 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00219">219</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
231
232 </div>
233 </div>
234 <a id="af05d5abe7656953548edfb3eb5117659"></a>
235 <h2 class="memtitle"><span class="permalink"><a href="#af05d5abe7656953548edfb3eb5117659">&#9670;&nbsp;</a></span>exponent</h2>
236
237 <div class="memitem">
238 <div class="memproto">
239       <table class="memname">
240         <tr>
241           <td class="memname">uint8_t exponent</td>
242         </tr>
243       </table>
244 </div><div class="memdoc">
245
246 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00217">217</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
247
248 </div>
249 </div>
250 <a id="a535b83a8653a891f80fc204eb1d9cb8b"></a>
251 <h2 class="memtitle"><span class="permalink"><a href="#a535b83a8653a891f80fc204eb1d9cb8b">&#9670;&nbsp;</a></span>p_bfwIQ</h2>
252
253 <div class="memitem">
254 <div class="memproto">
255       <table class="memname">
256         <tr>
257           <td class="memname">int16_t* p_bfwIQ</td>
258         </tr>
259       </table>
260 </div><div class="memdoc">
261 <p>pointer to formed section extention </p>
262
263 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00214">214</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
264
265 </div>
266 </div>
267 <a id="ad07777df733bfd87b118b5ea683fcb3b"></a>
268 <h2 class="memtitle"><span class="permalink"><a href="#ad07777df733bfd87b118b5ea683fcb3b">&#9670;&nbsp;</a></span>rbNumber</h2>
269
270 <div class="memitem">
271 <div class="memproto">
272       <table class="memname">
273         <tr>
274           <td class="memname">uint16_t rbNumber</td>
275         </tr>
276       </table>
277 </div><div class="memdoc">
278 <p>number RBs to ext1 chain </p>
279
280 <p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00210">210</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
281
282 </div>
283 </div>
284 <hr/>The documentation for this struct was generated from the following file:<ul>
285 <li><a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a></li>
286 </ul>
287 </div><!-- contents -->
288 <!-- start footer part -->
289 <hr class="footer"/><address class="footer"><small>
290 Generated by &#160;<a href="http://www.doxygen.org/index.html">
291 <img class="footer" src="doxygen.png" alt="doxygen"/>
292 </a> 1.8.13
293 </small></address>
294 </body>
295 </html>