add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__prach__cp__config.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_prach_cp_config 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_prach_cp_config Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_prach_cp_config:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__prach__cp__config__coll__graph.png" border="0" usemap="#xran__prach__cp__config_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:ad5150de5e1c141cfe288f260afb00830"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#ad5150de5e1c141cfe288f260afb00830">filterIdx</a></td></tr>
79 <tr class="separator:ad5150de5e1c141cfe288f260afb00830"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:ac54814779041bec5dcf8aec288d69b06"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#ac54814779041bec5dcf8aec288d69b06">startSymId</a></td></tr>
81 <tr class="separator:ac54814779041bec5dcf8aec288d69b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a6b13285aabf8f2f4598143b2670204c1"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a6b13285aabf8f2f4598143b2670204c1">startPrbc</a></td></tr>
83 <tr class="separator:a6b13285aabf8f2f4598143b2670204c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <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__prach__cp__config.html#aabc4fe26e40f742fd255e2bb8534de75">numPrbc</a></td></tr>
85 <tr class="separator:aabc4fe26e40f742fd255e2bb8534de75"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a664cb6ca464c69ef60a445fa4f4b3522"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a664cb6ca464c69ef60a445fa4f4b3522">numSymbol</a></td></tr>
87 <tr class="separator:a664cb6ca464c69ef60a445fa4f4b3522"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:aa68c277a66312b4b90819cccc055bdb7"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#aa68c277a66312b4b90819cccc055bdb7">timeOffset</a></td></tr>
89 <tr class="separator:aa68c277a66312b4b90819cccc055bdb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a3af58496c14a1c91c015aa6ffe7dca49"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a3af58496c14a1c91c015aa6ffe7dca49">freqOffset</a></td></tr>
91 <tr class="separator:a3af58496c14a1c91c015aa6ffe7dca49"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:a855041f3139611ca7478502e3241b2f1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a855041f3139611ca7478502e3241b2f1">nrofPrachInSlot</a></td></tr>
93 <tr class="separator:a855041f3139611ca7478502e3241b2f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:a2e544eaae35a5756272d62af4fa53a19"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a2e544eaae35a5756272d62af4fa53a19">occassionsInPrachSlot</a></td></tr>
95 <tr class="separator:a2e544eaae35a5756272d62af4fa53a19"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:a0f561e77fa0f040b637f4e04f6cd8078"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a0f561e77fa0f040b637f4e04f6cd8078">x</a></td></tr>
97 <tr class="separator:a0f561e77fa0f040b637f4e04f6cd8078"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:a1d627e83c5e0ae889b71ea0508991f29"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a1d627e83c5e0ae889b71ea0508991f29">y</a> [<a class="el" href="xran__common_8h.html#a342c40a4877f7760c65eca32523efea1">XRAN_PRACH_CANDIDATE_Y</a>]</td></tr>
99 <tr class="separator:a1d627e83c5e0ae889b71ea0508991f29"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <tr class="memitem:a3b00fdd9e145b9c7be29aa35c6f94fe1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a3b00fdd9e145b9c7be29aa35c6f94fe1">isPRACHslot</a> [<a class="el" href="xran__common_8h.html#af7a48e76794ce5d801ab6d0f848abb53">XRAN_PRACH_CANDIDATE_SLOT</a>]</td></tr>
101 <tr class="separator:a3b00fdd9e145b9c7be29aa35c6f94fe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <tr class="memitem:a38a5594e33178248d80ccde98a16262a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__cp__config.html#a38a5594e33178248d80ccde98a16262a">eAxC_offset</a></td></tr>
103 <tr class="separator:a38a5594e33178248d80ccde98a16262a"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 </table>
105 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
106 <div class="textblock">
107 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00125">125</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
108 </div><h2 class="groupheader">Field Documentation</h2>
109 <a id="a38a5594e33178248d80ccde98a16262a"></a>
110 <h2 class="memtitle"><span class="permalink"><a href="#a38a5594e33178248d80ccde98a16262a">&#9670;&nbsp;</a></span>eAxC_offset</h2>
111
112 <div class="memitem">
113 <div class="memproto">
114       <table class="memname">
115         <tr>
116           <td class="memname">uint8_t eAxC_offset</td>
117         </tr>
118       </table>
119 </div><div class="memdoc">
120 <p>starting eAxC for PRACH stream </p>
121
122 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00139">139</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
123
124 </div>
125 </div>
126 <a id="ad5150de5e1c141cfe288f260afb00830"></a>
127 <h2 class="memtitle"><span class="permalink"><a href="#ad5150de5e1c141cfe288f260afb00830">&#9670;&nbsp;</a></span>filterIdx</h2>
128
129 <div class="memitem">
130 <div class="memproto">
131       <table class="memname">
132         <tr>
133           <td class="memname">uint8_t filterIdx</td>
134         </tr>
135       </table>
136 </div><div class="memdoc">
137
138 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00127">127</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
139
140 </div>
141 </div>
142 <a id="a3af58496c14a1c91c015aa6ffe7dca49"></a>
143 <h2 class="memtitle"><span class="permalink"><a href="#a3af58496c14a1c91c015aa6ffe7dca49">&#9670;&nbsp;</a></span>freqOffset</h2>
144
145 <div class="memitem">
146 <div class="memproto">
147       <table class="memname">
148         <tr>
149           <td class="memname">int32_t freqOffset</td>
150         </tr>
151       </table>
152 </div><div class="memdoc">
153
154 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00133">133</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
155
156 </div>
157 </div>
158 <a id="a3b00fdd9e145b9c7be29aa35c6f94fe1"></a>
159 <h2 class="memtitle"><span class="permalink"><a href="#a3b00fdd9e145b9c7be29aa35c6f94fe1">&#9670;&nbsp;</a></span>isPRACHslot</h2>
160
161 <div class="memitem">
162 <div class="memproto">
163       <table class="memname">
164         <tr>
165           <td class="memname">uint8_t isPRACHslot[<a class="el" href="xran__common_8h.html#af7a48e76794ce5d801ab6d0f848abb53">XRAN_PRACH_CANDIDATE_SLOT</a>]</td>
166         </tr>
167       </table>
168 </div><div class="memdoc">
169
170 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00138">138</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
171
172 </div>
173 </div>
174 <a id="a855041f3139611ca7478502e3241b2f1"></a>
175 <h2 class="memtitle"><span class="permalink"><a href="#a855041f3139611ca7478502e3241b2f1">&#9670;&nbsp;</a></span>nrofPrachInSlot</h2>
176
177 <div class="memitem">
178 <div class="memproto">
179       <table class="memname">
180         <tr>
181           <td class="memname">uint8_t nrofPrachInSlot</td>
182         </tr>
183       </table>
184 </div><div class="memdoc">
185
186 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00134">134</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
187
188 </div>
189 </div>
190 <a id="aabc4fe26e40f742fd255e2bb8534de75"></a>
191 <h2 class="memtitle"><span class="permalink"><a href="#aabc4fe26e40f742fd255e2bb8534de75">&#9670;&nbsp;</a></span>numPrbc</h2>
192
193 <div class="memitem">
194 <div class="memproto">
195       <table class="memname">
196         <tr>
197           <td class="memname">uint8_t numPrbc</td>
198         </tr>
199       </table>
200 </div><div class="memdoc">
201
202 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00130">130</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
203
204 </div>
205 </div>
206 <a id="a664cb6ca464c69ef60a445fa4f4b3522"></a>
207 <h2 class="memtitle"><span class="permalink"><a href="#a664cb6ca464c69ef60a445fa4f4b3522">&#9670;&nbsp;</a></span>numSymbol</h2>
208
209 <div class="memitem">
210 <div class="memproto">
211       <table class="memname">
212         <tr>
213           <td class="memname">uint8_t numSymbol</td>
214         </tr>
215       </table>
216 </div><div class="memdoc">
217
218 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00131">131</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
219
220 </div>
221 </div>
222 <a id="a2e544eaae35a5756272d62af4fa53a19"></a>
223 <h2 class="memtitle"><span class="permalink"><a href="#a2e544eaae35a5756272d62af4fa53a19">&#9670;&nbsp;</a></span>occassionsInPrachSlot</h2>
224
225 <div class="memitem">
226 <div class="memproto">
227       <table class="memname">
228         <tr>
229           <td class="memname">uint8_t occassionsInPrachSlot</td>
230         </tr>
231       </table>
232 </div><div class="memdoc">
233
234 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00135">135</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
235
236 </div>
237 </div>
238 <a id="a6b13285aabf8f2f4598143b2670204c1"></a>
239 <h2 class="memtitle"><span class="permalink"><a href="#a6b13285aabf8f2f4598143b2670204c1">&#9670;&nbsp;</a></span>startPrbc</h2>
240
241 <div class="memitem">
242 <div class="memproto">
243       <table class="memname">
244         <tr>
245           <td class="memname">uint16_t startPrbc</td>
246         </tr>
247       </table>
248 </div><div class="memdoc">
249
250 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00129">129</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
251
252 </div>
253 </div>
254 <a id="ac54814779041bec5dcf8aec288d69b06"></a>
255 <h2 class="memtitle"><span class="permalink"><a href="#ac54814779041bec5dcf8aec288d69b06">&#9670;&nbsp;</a></span>startSymId</h2>
256
257 <div class="memitem">
258 <div class="memproto">
259       <table class="memname">
260         <tr>
261           <td class="memname">uint8_t startSymId</td>
262         </tr>
263       </table>
264 </div><div class="memdoc">
265
266 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00128">128</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
267
268 </div>
269 </div>
270 <a id="aa68c277a66312b4b90819cccc055bdb7"></a>
271 <h2 class="memtitle"><span class="permalink"><a href="#aa68c277a66312b4b90819cccc055bdb7">&#9670;&nbsp;</a></span>timeOffset</h2>
272
273 <div class="memitem">
274 <div class="memproto">
275       <table class="memname">
276         <tr>
277           <td class="memname">uint16_t timeOffset</td>
278         </tr>
279       </table>
280 </div><div class="memdoc">
281
282 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00132">132</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
283
284 </div>
285 </div>
286 <a id="a0f561e77fa0f040b637f4e04f6cd8078"></a>
287 <h2 class="memtitle"><span class="permalink"><a href="#a0f561e77fa0f040b637f4e04f6cd8078">&#9670;&nbsp;</a></span>x</h2>
288
289 <div class="memitem">
290 <div class="memproto">
291       <table class="memname">
292         <tr>
293           <td class="memname">uint8_t x</td>
294         </tr>
295       </table>
296 </div><div class="memdoc">
297
298 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00136">136</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
299
300 </div>
301 </div>
302 <a id="a1d627e83c5e0ae889b71ea0508991f29"></a>
303 <h2 class="memtitle"><span class="permalink"><a href="#a1d627e83c5e0ae889b71ea0508991f29">&#9670;&nbsp;</a></span>y</h2>
304
305 <div class="memitem">
306 <div class="memproto">
307       <table class="memname">
308         <tr>
309           <td class="memname">uint8_t y[<a class="el" href="xran__common_8h.html#a342c40a4877f7760c65eca32523efea1">XRAN_PRACH_CANDIDATE_Y</a>]</td>
310         </tr>
311       </table>
312 </div><div class="memdoc">
313
314 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00137">137</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
315
316 </div>
317 </div>
318 <hr/>The documentation for this struct was generated from the following file:<ul>
319 <li><a class="el" href="xran__common_8h_source.html">xran_common.h</a></li>
320 </ul>
321 </div><!-- contents -->
322 <!-- start footer part -->
323 <hr class="footer"/><address class="footer"><small>
324 Generated by &#160;<a href="http://www.doxygen.org/index.html">
325 <img class="footer" src="doxygen.png" alt="doxygen"/>
326 </a> 1.8.13
327 </small></address>
328 </body>
329 </html>