add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__prach__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_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_config Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_prach_config:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__prach__config__coll__graph.png" border="0" usemap="#xran__prach__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:acb5fe8097b0115e038eb02d5900f66d6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#acb5fe8097b0115e038eb02d5900f66d6">nPrachConfIdx</a></td></tr>
79 <tr class="separator:acb5fe8097b0115e038eb02d5900f66d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:ab9b99e41ea39f16780f66a539aa872c8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#ab9b99e41ea39f16780f66a539aa872c8">nPrachSubcSpacing</a></td></tr>
81 <tr class="separator:ab9b99e41ea39f16780f66a539aa872c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a45ae197adc4010202a5b71d7b602bc0c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a45ae197adc4010202a5b71d7b602bc0c">nPrachZeroCorrConf</a></td></tr>
83 <tr class="separator:a45ae197adc4010202a5b71d7b602bc0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a26e6c95dfde831c2588d46dde588c751"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a26e6c95dfde831c2588d46dde588c751">nPrachRestrictSet</a></td></tr>
85 <tr class="separator:a26e6c95dfde831c2588d46dde588c751"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a66b19aaa946c36b309a3403b3d576c58"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a66b19aaa946c36b309a3403b3d576c58">nPrachRootSeqIdx</a></td></tr>
87 <tr class="separator:a66b19aaa946c36b309a3403b3d576c58"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:a5c648c99c04370a4e8767f919a2289bf"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a5c648c99c04370a4e8767f919a2289bf">nPrachFreqStart</a></td></tr>
89 <tr class="separator:a5c648c99c04370a4e8767f919a2289bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a3b43924c5ef23b0496d1a7adf2752dbf"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#a3b43924c5ef23b0496d1a7adf2752dbf">nPrachFreqOffset</a></td></tr>
91 <tr class="separator:a3b43924c5ef23b0496d1a7adf2752dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:ab3ca7a740428b7023b7e29197124983b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__prach__config.html#ab3ca7a740428b7023b7e29197124983b">nPrachFilterIdx</a></td></tr>
93 <tr class="separator:ab3ca7a740428b7023b7e29197124983b"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 </table>
95 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
96 <div class="textblock"><p>SRS configuration required for XRAN based FH </p>
97
98 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00429">429</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
99 </div><h2 class="groupheader">Field Documentation</h2>
100 <a id="acb5fe8097b0115e038eb02d5900f66d6"></a>
101 <h2 class="memtitle"><span class="permalink"><a href="#acb5fe8097b0115e038eb02d5900f66d6">&#9670;&nbsp;</a></span>nPrachConfIdx</h2>
102
103 <div class="memitem">
104 <div class="memproto">
105       <table class="memname">
106         <tr>
107           <td class="memname">uint8_t nPrachConfIdx</td>
108         </tr>
109       </table>
110 </div><div class="memdoc">
111 <p>PRACH Configuration Index </p>
112
113 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00432">432</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
114
115 </div>
116 </div>
117 <a id="ab3ca7a740428b7023b7e29197124983b"></a>
118 <h2 class="memtitle"><span class="permalink"><a href="#ab3ca7a740428b7023b7e29197124983b">&#9670;&nbsp;</a></span>nPrachFilterIdx</h2>
119
120 <div class="memitem">
121 <div class="memproto">
122       <table class="memname">
123         <tr>
124           <td class="memname">uint8_t nPrachFilterIdx</td>
125         </tr>
126       </table>
127 </div><div class="memdoc">
128 <p>PRACH Filter index </p>
129
130 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00443">443</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
131
132 </div>
133 </div>
134 <a id="a3b43924c5ef23b0496d1a7adf2752dbf"></a>
135 <h2 class="memtitle"><span class="permalink"><a href="#a3b43924c5ef23b0496d1a7adf2752dbf">&#9670;&nbsp;</a></span>nPrachFreqOffset</h2>
136
137 <div class="memitem">
138 <div class="memproto">
139       <table class="memname">
140         <tr>
141           <td class="memname">int32_t nPrachFreqOffset</td>
142         </tr>
143       </table>
144 </div><div class="memdoc">
145 <p>PRACH prach-frequency-offset </p>
146
147 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00442">442</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
148
149 </div>
150 </div>
151 <a id="a5c648c99c04370a4e8767f919a2289bf"></a>
152 <h2 class="memtitle"><span class="permalink"><a href="#a5c648c99c04370a4e8767f919a2289bf">&#9670;&nbsp;</a></span>nPrachFreqStart</h2>
153
154 <div class="memitem">
155 <div class="memproto">
156       <table class="memname">
157         <tr>
158           <td class="memname">uint16_t nPrachFreqStart</td>
159         </tr>
160       </table>
161 </div><div class="memdoc">
162 <p>PRACH prach-frequency-start </p>
163
164 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00441">441</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
165
166 </div>
167 </div>
168 <a id="a26e6c95dfde831c2588d46dde588c751"></a>
169 <h2 class="memtitle"><span class="permalink"><a href="#a26e6c95dfde831c2588d46dde588c751">&#9670;&nbsp;</a></span>nPrachRestrictSet</h2>
170
171 <div class="memitem">
172 <div class="memproto">
173       <table class="memname">
174         <tr>
175           <td class="memname">uint8_t nPrachRestrictSet</td>
176         </tr>
177       </table>
178 </div><div class="memdoc">
179 <p>PRACH restrictedSetConfig </p>
180
181 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00439">439</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
182
183 </div>
184 </div>
185 <a id="a66b19aaa946c36b309a3403b3d576c58"></a>
186 <h2 class="memtitle"><span class="permalink"><a href="#a66b19aaa946c36b309a3403b3d576c58">&#9670;&nbsp;</a></span>nPrachRootSeqIdx</h2>
187
188 <div class="memitem">
189 <div class="memproto">
190       <table class="memname">
191         <tr>
192           <td class="memname">uint16_t nPrachRootSeqIdx</td>
193         </tr>
194       </table>
195 </div><div class="memdoc">
196 <p>PRACH Root Sequence Index </p>
197
198 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00440">440</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
199
200 </div>
201 </div>
202 <a id="ab9b99e41ea39f16780f66a539aa872c8"></a>
203 <h2 class="memtitle"><span class="permalink"><a href="#ab9b99e41ea39f16780f66a539aa872c8">&#9670;&nbsp;</a></span>nPrachSubcSpacing</h2>
204
205 <div class="memitem">
206 <div class="memproto">
207       <table class="memname">
208         <tr>
209           <td class="memname">uint8_t nPrachSubcSpacing</td>
210         </tr>
211       </table>
212 </div><div class="memdoc">
213 <p>PRACH Sub-carrier spacing Value:0-&gt;1 For below 6GHz the values indicate 15kHz or 30kHz For above 6GHz the values indicate 60kHz or 120kHz </p>
214
215 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00433">433</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
216
217 </div>
218 </div>
219 <a id="a45ae197adc4010202a5b71d7b602bc0c"></a>
220 <h2 class="memtitle"><span class="permalink"><a href="#a45ae197adc4010202a5b71d7b602bc0c">&#9670;&nbsp;</a></span>nPrachZeroCorrConf</h2>
221
222 <div class="memitem">
223 <div class="memproto">
224       <table class="memname">
225         <tr>
226           <td class="memname">uint8_t nPrachZeroCorrConf</td>
227         </tr>
228       </table>
229 </div><div class="memdoc">
230 <p>PRACH zeroCorrelationZoneConfig </p>
231
232 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00438">438</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
233
234 </div>
235 </div>
236 <hr/>The documentation for this struct was generated from the following file:<ul>
237 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
238 </ul>
239 </div><!-- contents -->
240 <!-- start footer part -->
241 <hr class="footer"/><address class="footer"><small>
242 Generated by &#160;<a href="http://www.doxygen.org/index.html">
243 <img class="footer" src="doxygen.png" alt="doxygen"/>
244 </a> 1.8.13
245 </small></address>
246 </body>
247 </html>