add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__cp__radioapp__section6.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_radioapp_section6 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_radioapp_section6 Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_cp_radioapp_section6:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__cp__radioapp__section6__coll__graph.png" border="0" usemap="#xran__cp__radioapp__section6_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:ab73e0a6442bf42de3e9110afca7b4ec4"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#ab73e0a6442bf42de3e9110afca7b4ec4">regularizationFactor</a>:16</td></tr>
79 <tr class="separator:ab73e0a6442bf42de3e9110afca7b4ec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:a64c04119c39e8dbcf00f4ae22968b1eb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#a64c04119c39e8dbcf00f4ae22968b1eb">ueId</a>:15</td></tr>
81 <tr class="separator:a64c04119c39e8dbcf00f4ae22968b1eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:ad63f9c3cee58cacccc463bc3c3313cc6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#ad63f9c3cee58cacccc463bc3c3313cc6">ef</a>:1</td></tr>
83 <tr class="separator:ad63f9c3cee58cacccc463bc3c3313cc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a02b265f2198407df96202e1dfdc5c7dd"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#a02b265f2198407df96202e1dfdc5c7dd">startPrbch</a>:2</td></tr>
85 <tr class="separator:a02b265f2198407df96202e1dfdc5c7dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a52f6623d45fec4bf9c14898f7e53db34"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#a52f6623d45fec4bf9c14898f7e53db34">symInc</a>:1</td></tr>
87 <tr class="separator:a52f6623d45fec4bf9c14898f7e53db34"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:affa3adbd50cd4af2018ba1fc0e8c3e31"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#affa3adbd50cd4af2018ba1fc0e8c3e31">rb</a>:1</td></tr>
89 <tr class="separator:affa3adbd50cd4af2018ba1fc0e8c3e31"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:acb7bc06bed6f6408d719334fc41698c7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#acb7bc06bed6f6408d719334fc41698c7">reserved</a>:4</td></tr>
91 <tr class="separator:acb7bc06bed6f6408d719334fc41698c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:ae0ba1ea05777c0190eb5d898d177f37d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#ae0ba1ea05777c0190eb5d898d177f37d">startPrbcl</a>:8</td></tr>
93 <tr class="separator:ae0ba1ea05777c0190eb5d898d177f37d"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:aabc4fe26e40f742fd255e2bb8534de75"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section6.html#aabc4fe26e40f742fd255e2bb8534de75">numPrbc</a>:8</td></tr>
95 <tr class="separator:aabc4fe26e40f742fd255e2bb8534de75"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 </table>
97 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
98 <div class="textblock"><p>Section definition for type 5: Channel Information (Table 5-6) Not supported in this release </p>
99
100 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00457">457</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
101 </div><h2 class="groupheader">Field Documentation</h2>
102 <a id="ad63f9c3cee58cacccc463bc3c3313cc6"></a>
103 <h2 class="memtitle"><span class="permalink"><a href="#ad63f9c3cee58cacccc463bc3c3313cc6">&#9670;&nbsp;</a></span>ef</h2>
104
105 <div class="memitem">
106 <div class="memproto">
107       <table class="memname">
108         <tr>
109           <td class="memname">uint32_t ef</td>
110         </tr>
111       </table>
112 </div><div class="memdoc">
113 <p>5.4.5.8 extension flag </p>
114
115 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00460">460</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
116
117 </div>
118 </div>
119 <a id="aabc4fe26e40f742fd255e2bb8534de75"></a>
120 <h2 class="memtitle"><span class="permalink"><a href="#aabc4fe26e40f742fd255e2bb8534de75">&#9670;&nbsp;</a></span>numPrbc</h2>
121
122 <div class="memitem">
123 <div class="memproto">
124       <table class="memname">
125         <tr>
126           <td class="memname">uint8_t numPrbc</td>
127         </tr>
128       </table>
129 </div><div class="memdoc">
130 <p>5.4.5.6 number of contiguous PRBs per control section </p>
131
132 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00466">466</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
133
134 </div>
135 </div>
136 <a id="affa3adbd50cd4af2018ba1fc0e8c3e31"></a>
137 <h2 class="memtitle"><span class="permalink"><a href="#affa3adbd50cd4af2018ba1fc0e8c3e31">&#9670;&nbsp;</a></span>rb</h2>
138
139 <div class="memitem">
140 <div class="memproto">
141       <table class="memname">
142         <tr>
143           <td class="memname">uint8_t rb</td>
144         </tr>
145       </table>
146 </div><div class="memdoc">
147 <p>5.4.5.2 resource block indicator, XRAN_RBIND_xxx </p>
148
149 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00463">463</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
150
151 </div>
152 </div>
153 <a id="ab73e0a6442bf42de3e9110afca7b4ec4"></a>
154 <h2 class="memtitle"><span class="permalink"><a href="#ab73e0a6442bf42de3e9110afca7b4ec4">&#9670;&nbsp;</a></span>regularizationFactor</h2>
155
156 <div class="memitem">
157 <div class="memproto">
158       <table class="memname">
159         <tr>
160           <td class="memname">uint32_t regularizationFactor</td>
161         </tr>
162       </table>
163 </div><div class="memdoc">
164 <p>5.4.5.12 regularization Factor </p>
165
166 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00458">458</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
167
168 </div>
169 </div>
170 <a id="acb7bc06bed6f6408d719334fc41698c7"></a>
171 <h2 class="memtitle"><span class="permalink"><a href="#acb7bc06bed6f6408d719334fc41698c7">&#9670;&nbsp;</a></span>reserved</h2>
172
173 <div class="memitem">
174 <div class="memproto">
175       <table class="memname">
176         <tr>
177           <td class="memname">uint8_t reserved</td>
178         </tr>
179       </table>
180 </div><div class="memdoc">
181
182 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00464">464</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
183
184 </div>
185 </div>
186 <a id="a02b265f2198407df96202e1dfdc5c7dd"></a>
187 <h2 class="memtitle"><span class="permalink"><a href="#a02b265f2198407df96202e1dfdc5c7dd">&#9670;&nbsp;</a></span>startPrbch</h2>
188
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname">uint8_t startPrbch</td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197 <p>5.4.5.4 starting PRB of control section </p>
198
199 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00461">461</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
200
201 </div>
202 </div>
203 <a id="ae0ba1ea05777c0190eb5d898d177f37d"></a>
204 <h2 class="memtitle"><span class="permalink"><a href="#ae0ba1ea05777c0190eb5d898d177f37d">&#9670;&nbsp;</a></span>startPrbcl</h2>
205
206 <div class="memitem">
207 <div class="memproto">
208       <table class="memname">
209         <tr>
210           <td class="memname">uint8_t startPrbcl</td>
211         </tr>
212       </table>
213 </div><div class="memdoc">
214 <p>5.4.5.4 starting PRB of control section </p>
215
216 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00465">465</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
217
218 </div>
219 </div>
220 <a id="a52f6623d45fec4bf9c14898f7e53db34"></a>
221 <h2 class="memtitle"><span class="permalink"><a href="#a52f6623d45fec4bf9c14898f7e53db34">&#9670;&nbsp;</a></span>symInc</h2>
222
223 <div class="memitem">
224 <div class="memproto">
225       <table class="memname">
226         <tr>
227           <td class="memname">uint8_t symInc</td>
228         </tr>
229       </table>
230 </div><div class="memdoc">
231 <p>5.4.5.3 symbol number increment command XRAN_SYMBOLNUMBER_xxxx </p>
232
233 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00462">462</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
234
235 </div>
236 </div>
237 <a id="a64c04119c39e8dbcf00f4ae22968b1eb"></a>
238 <h2 class="memtitle"><span class="permalink"><a href="#a64c04119c39e8dbcf00f4ae22968b1eb">&#9670;&nbsp;</a></span>ueId</h2>
239
240 <div class="memitem">
241 <div class="memproto">
242       <table class="memname">
243         <tr>
244           <td class="memname">uint32_t ueId</td>
245         </tr>
246       </table>
247 </div><div class="memdoc">
248 <p>5.4.5.10 UE identifier </p>
249
250 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00459">459</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
251
252 </div>
253 </div>
254 <hr/>The documentation for this struct was generated from the following file:<ul>
255 <li><a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a></li>
256 </ul>
257 </div><!-- contents -->
258 <!-- start footer part -->
259 <hr class="footer"/><address class="footer"><small>
260 Generated by &#160;<a href="http://www.doxygen.org/index.html">
261 <img class="footer" src="doxygen.png" alt="doxygen"/>
262 </a> 1.8.13
263 </small></address>
264 </body>
265 </html>