add Doxygen documentation
[o-du/phy.git] / docs / API / struct_xran_lib_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: XranLibConfig 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">XranLibConfig Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68 <div class="dynheader">
69 Collaboration diagram for XranLibConfig:</div>
70 <div class="dyncontent">
71 <div class="center"><img src="struct_xran_lib_config__coll__graph.png" border="0" usemap="#_xran_lib_config_coll__map" alt="Collaboration graph"/></div>
72 </div>
73 <table class="memberdecls">
74 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
75 Data Fields</h2></td></tr>
76 <tr class="memitem:acd5189037e23e024ae8f03a90399e97e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_xran_lib_config.html#acd5189037e23e024ae8f03a90399e97e">nDriverCoreId</a></td></tr>
77 <tr class="separator:acd5189037e23e024ae8f03a90399e97e"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 <tr class="memitem:a0b246b8022911c0057e473e1fd41efd8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_xran_lib_config.html#a0b246b8022911c0057e473e1fd41efd8">nTimingAdvance</a></td></tr>
79 <tr class="separator:a0b246b8022911c0057e473e1fd41efd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:af75cbcbef6876a9c79b61b46572b6501"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_xran_lib_config.html#af75cbcbef6876a9c79b61b46572b6501">nFhConfig</a></td></tr>
81 <tr class="separator:af75cbcbef6876a9c79b61b46572b6501"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a0f7b4777832a26c80e4d58003813d70d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_xran_lib_config.html#a0f7b4777832a26c80e4d58003813d70d">nFhBufIntFlag</a></td></tr>
83 <tr class="separator:a0f7b4777832a26c80e4d58003813d70d"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:aba0c303e021d8d3d08a3f667f2662d9e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_xran_lib_config.html#aba0c303e021d8d3d08a3f667f2662d9e">nSectorNum</a></td></tr>
85 <tr class="separator:aba0c303e021d8d3d08a3f667f2662d9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a8bf802ca9b9dfa939a1fef031bb8f364"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_xran_lib_config.html#a8bf802ca9b9dfa939a1fef031bb8f364">nNrOfSlotInSf</a></td></tr>
87 <tr class="separator:a8bf802ca9b9dfa939a1fef031bb8f364"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:a6574f1a80394aabb048881d606e03f8e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_xran_lib_config.html#a6574f1a80394aabb048881d606e03f8e">nNrofSfInFrame</a></td></tr>
89 <tr class="separator:a6574f1a80394aabb048881d606e03f8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a42dface8348b0fea71cb9a2c334347e6"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_xran_lib_config.html#a42dface8348b0fea71cb9a2c334347e6">pFthInstanceHandles</a></td></tr>
91 <tr class="separator:a42dface8348b0fea71cb9a2c334347e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 </table>
93 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
94 <div class="textblock">
95 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00090">90</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
96 </div><h2 class="groupheader">Field Documentation</h2>
97 <a id="acd5189037e23e024ae8f03a90399e97e"></a>
98 <h2 class="memtitle"><span class="permalink"><a href="#acd5189037e23e024ae8f03a90399e97e">&#9670;&nbsp;</a></span>nDriverCoreId</h2>
99
100 <div class="memitem">
101 <div class="memproto">
102       <table class="memname">
103         <tr>
104           <td class="memname">uint32_t nDriverCoreId</td>
105         </tr>
106       </table>
107 </div><div class="memdoc">
108
109 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00092">92</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
110
111 </div>
112 </div>
113 <a id="a0f7b4777832a26c80e4d58003813d70d"></a>
114 <h2 class="memtitle"><span class="permalink"><a href="#a0f7b4777832a26c80e4d58003813d70d">&#9670;&nbsp;</a></span>nFhBufIntFlag</h2>
115
116 <div class="memitem">
117 <div class="memproto">
118       <table class="memname">
119         <tr>
120           <td class="memname">uint32_t nFhBufIntFlag</td>
121         </tr>
122       </table>
123 </div><div class="memdoc">
124
125 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00095">95</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
126
127 </div>
128 </div>
129 <a id="af75cbcbef6876a9c79b61b46572b6501"></a>
130 <h2 class="memtitle"><span class="permalink"><a href="#af75cbcbef6876a9c79b61b46572b6501">&#9670;&nbsp;</a></span>nFhConfig</h2>
131
132 <div class="memitem">
133 <div class="memproto">
134       <table class="memname">
135         <tr>
136           <td class="memname">uint32_t nFhConfig</td>
137         </tr>
138       </table>
139 </div><div class="memdoc">
140
141 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00094">94</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
142
143 </div>
144 </div>
145 <a id="a6574f1a80394aabb048881d606e03f8e"></a>
146 <h2 class="memtitle"><span class="permalink"><a href="#a6574f1a80394aabb048881d606e03f8e">&#9670;&nbsp;</a></span>nNrofSfInFrame</h2>
147
148 <div class="memitem">
149 <div class="memproto">
150       <table class="memname">
151         <tr>
152           <td class="memname">uint32_t nNrofSfInFrame</td>
153         </tr>
154       </table>
155 </div><div class="memdoc">
156
157 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00098">98</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
158
159 </div>
160 </div>
161 <a id="a8bf802ca9b9dfa939a1fef031bb8f364"></a>
162 <h2 class="memtitle"><span class="permalink"><a href="#a8bf802ca9b9dfa939a1fef031bb8f364">&#9670;&nbsp;</a></span>nNrOfSlotInSf</h2>
163
164 <div class="memitem">
165 <div class="memproto">
166       <table class="memname">
167         <tr>
168           <td class="memname">uint32_t nNrOfSlotInSf</td>
169         </tr>
170       </table>
171 </div><div class="memdoc">
172
173 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00097">97</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
174
175 </div>
176 </div>
177 <a id="aba0c303e021d8d3d08a3f667f2662d9e"></a>
178 <h2 class="memtitle"><span class="permalink"><a href="#aba0c303e021d8d3d08a3f667f2662d9e">&#9670;&nbsp;</a></span>nSectorNum</h2>
179
180 <div class="memitem">
181 <div class="memproto">
182       <table class="memname">
183         <tr>
184           <td class="memname">uint32_t nSectorNum</td>
185         </tr>
186       </table>
187 </div><div class="memdoc">
188
189 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00096">96</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
190
191 </div>
192 </div>
193 <a id="a0b246b8022911c0057e473e1fd41efd8"></a>
194 <h2 class="memtitle"><span class="permalink"><a href="#a0b246b8022911c0057e473e1fd41efd8">&#9670;&nbsp;</a></span>nTimingAdvance</h2>
195
196 <div class="memitem">
197 <div class="memproto">
198       <table class="memname">
199         <tr>
200           <td class="memname">uint32_t nTimingAdvance</td>
201         </tr>
202       </table>
203 </div><div class="memdoc">
204
205 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00093">93</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
206
207 </div>
208 </div>
209 <a id="a42dface8348b0fea71cb9a2c334347e6"></a>
210 <h2 class="memtitle"><span class="permalink"><a href="#a42dface8348b0fea71cb9a2c334347e6">&#9670;&nbsp;</a></span>pFthInstanceHandles</h2>
211
212 <div class="memitem">
213 <div class="memproto">
214       <table class="memname">
215         <tr>
216           <td class="memname">void* pFthInstanceHandles</td>
217         </tr>
218       </table>
219 </div><div class="memdoc">
220
221 <p class="definition">Definition at line <a class="el" href="sample-app_8c_source.html#l00099">99</a> of file <a class="el" href="sample-app_8c_source.html">sample-app.c</a>.</p>
222
223 </div>
224 </div>
225 <hr/>The documentation for this struct was generated from the following file:<ul>
226 <li><a class="el" href="sample-app_8c_source.html">sample-app.c</a></li>
227 </ul>
228 </div><!-- contents -->
229 <!-- start footer part -->
230 <hr class="footer"/><address class="footer"><small>
231 Generated by &#160;<a href="http://www.doxygen.org/index.html">
232 <img class="footer" src="doxygen.png" alt="doxygen"/>
233 </a> 1.8.13
234 </small></address>
235 </body>
236 </html>