add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__frame__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_frame_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_frame_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_frame_config:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__frame__config__coll__graph.png" border="0" usemap="#xran__frame__config_coll__map" alt="Collaboration graph"/></div>
74 <map name="xran__frame__config_coll__map" id="xran__frame__config_coll__map">
75 <area shape="rect" id="node2" href="structxran__slot__config.html" title="{xran_slot_config\n|+ nSymbolType\l+ reserved\l|}" alt="" coords="21,5,138,97"/>
76 </map>
77 </div>
78 <table class="memberdecls">
79 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
80 Data Fields</h2></td></tr>
81 <tr class="memitem:a3b86317723a592e240c0047e53a6326d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__frame__config.html#a3b86317723a592e240c0047e53a6326d">nFrameDuplexType</a></td></tr>
82 <tr class="separator:a3b86317723a592e240c0047e53a6326d"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:a78b2fab8e8d6a6424c2712d528fd9a58"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__frame__config.html#a78b2fab8e8d6a6424c2712d528fd9a58">nNumerology</a></td></tr>
84 <tr class="separator:a78b2fab8e8d6a6424c2712d528fd9a58"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <tr class="memitem:a53a1d989c6dee827495401b1973c9ef8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__frame__config.html#a53a1d989c6dee827495401b1973c9ef8">nTddPeriod</a></td></tr>
86 <tr class="separator:a53a1d989c6dee827495401b1973c9ef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:a4664e9a9005020b4a98ada2d256906e2"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__slot__config.html">xran_slot_config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__frame__config.html#a4664e9a9005020b4a98ada2d256906e2">sSlotConfig</a> [<a class="el" href="xran__fh__o__du_8h.html#aba79881ec9b30850184b4f5f6b0afc39">XRAN_MAX_TDD_PERIODICITY</a>]</td></tr>
88 <tr class="separator:a4664e9a9005020b4a98ada2d256906e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 </table>
90 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
91 <div class="textblock"><p>XRAN front haul frame config </p>
92
93 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00459">459</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
94 </div><h2 class="groupheader">Field Documentation</h2>
95 <a id="a3b86317723a592e240c0047e53a6326d"></a>
96 <h2 class="memtitle"><span class="permalink"><a href="#a3b86317723a592e240c0047e53a6326d">&#9670;&nbsp;</a></span>nFrameDuplexType</h2>
97
98 <div class="memitem">
99 <div class="memproto">
100       <table class="memname">
101         <tr>
102           <td class="memname">uint8_t nFrameDuplexType</td>
103         </tr>
104       </table>
105 </div><div class="memdoc">
106 <p>Frame Duplex type: 0 -&gt; FDD, 1 -&gt; TDD </p>
107
108 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00460">460</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
109
110 </div>
111 </div>
112 <a id="a78b2fab8e8d6a6424c2712d528fd9a58"></a>
113 <h2 class="memtitle"><span class="permalink"><a href="#a78b2fab8e8d6a6424c2712d528fd9a58">&#9670;&nbsp;</a></span>nNumerology</h2>
114
115 <div class="memitem">
116 <div class="memproto">
117       <table class="memname">
118         <tr>
119           <td class="memname">uint8_t nNumerology</td>
120         </tr>
121       </table>
122 </div><div class="memdoc">
123 <p>Numerology, determine sub carrier spacing, Value: 0-&gt;4 0: 15khz, 1: 30khz, 2: 60khz 3: 120khz, 4: 240khz </p>
124
125 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00461">461</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
126
127 </div>
128 </div>
129 <a id="a53a1d989c6dee827495401b1973c9ef8"></a>
130 <h2 class="memtitle"><span class="permalink"><a href="#a53a1d989c6dee827495401b1973c9ef8">&#9670;&nbsp;</a></span>nTddPeriod</h2>
131
132 <div class="memitem">
133 <div class="memproto">
134       <table class="memname">
135         <tr>
136           <td class="memname">uint8_t nTddPeriod</td>
137         </tr>
138       </table>
139 </div><div class="memdoc">
140 <p>TDD period </p>
141
142 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00464">464</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
143
144 </div>
145 </div>
146 <a id="a4664e9a9005020b4a98ada2d256906e2"></a>
147 <h2 class="memtitle"><span class="permalink"><a href="#a4664e9a9005020b4a98ada2d256906e2">&#9670;&nbsp;</a></span>sSlotConfig</h2>
148
149 <div class="memitem">
150 <div class="memproto">
151       <table class="memname">
152         <tr>
153           <td class="memname">struct <a class="el" href="structxran__slot__config.html">xran_slot_config</a> sSlotConfig[<a class="el" href="xran__fh__o__du_8h.html#aba79881ec9b30850184b4f5f6b0afc39">XRAN_MAX_TDD_PERIODICITY</a>]</td>
154         </tr>
155       </table>
156 </div><div class="memdoc">
157 <p>TDD Slot configuration - If nFrameDuplexType = TDD(1), then this config defines the slot config type for each slot. </p>
158
159 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00465">465</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
160
161 </div>
162 </div>
163 <hr/>The documentation for this struct was generated from the following file:<ul>
164 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
165 </ul>
166 </div><!-- contents -->
167 <!-- start footer part -->
168 <hr class="footer"/><address class="footer"><small>
169 Generated by &#160;<a href="http://www.doxygen.org/index.html">
170 <img class="footer" src="doxygen.png" alt="doxygen"/>
171 </a> 1.8.13
172 </small></address>
173 </body>
174 </html>