add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__section__desc.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_section_desc 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_section_desc 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_section_desc:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__section__desc__coll__graph.png" border="0" usemap="#xran__section__desc_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:aa82fd2a2292b3c25c7027b898fa53815"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#aa82fd2a2292b3c25c7027b898fa53815">section_id</a></td></tr>
79 <tr class="separator:aa82fd2a2292b3c25c7027b898fa53815"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:a4d1fb35f3f2d9f3556fbd1761a167255"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#a4d1fb35f3f2d9f3556fbd1761a167255">iq_buffer_offset</a></td></tr>
81 <tr class="separator:a4d1fb35f3f2d9f3556fbd1761a167255"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:ae55ac9499e5406559ad2ff0376dd0a68"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#ae55ac9499e5406559ad2ff0376dd0a68">iq_buffer_len</a></td></tr>
83 <tr class="separator:ae55ac9499e5406559ad2ff0376dd0a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a77f0d5374ee675db57c0b29946ca7744"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#a77f0d5374ee675db57c0b29946ca7744">pData</a></td></tr>
85 <tr class="separator:a77f0d5374ee675db57c0b29946ca7744"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:addb9297d816b26c680888115de8c9538"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__section__desc.html#addb9297d816b26c680888115de8c9538">pCtrl</a></td></tr>
87 <tr class="separator:addb9297d816b26c680888115de8c9538"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 </table>
89 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
90 <div class="textblock"><p>section descriptor for given number of PRBs used on U-plane packet creation </p>
91
92 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00382">382</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
93 </div><h2 class="groupheader">Field Documentation</h2>
94 <a id="ae55ac9499e5406559ad2ff0376dd0a68"></a>
95 <h2 class="memtitle"><span class="permalink"><a href="#ae55ac9499e5406559ad2ff0376dd0a68">&#9670;&nbsp;</a></span>iq_buffer_len</h2>
96
97 <div class="memitem">
98 <div class="memproto">
99       <table class="memname">
100         <tr>
101           <td class="memname">int16_t iq_buffer_len</td>
102         </tr>
103       </table>
104 </div><div class="memdoc">
105 <p>Length in bytes for the content of IQs with in main symb buffer </p>
106
107 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00386">386</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
108
109 </div>
110 </div>
111 <a id="a4d1fb35f3f2d9f3556fbd1761a167255"></a>
112 <h2 class="memtitle"><span class="permalink"><a href="#a4d1fb35f3f2d9f3556fbd1761a167255">&#9670;&nbsp;</a></span>iq_buffer_offset</h2>
113
114 <div class="memitem">
115 <div class="memproto">
116       <table class="memname">
117         <tr>
118           <td class="memname">int16_t iq_buffer_offset</td>
119         </tr>
120       </table>
121 </div><div class="memdoc">
122 <p>Offset in bytes for the content of IQs with in main symb buffer </p>
123
124 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00385">385</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
125
126 </div>
127 </div>
128 <a id="addb9297d816b26c680888115de8c9538"></a>
129 <h2 class="memtitle"><span class="permalink"><a href="#addb9297d816b26c680888115de8c9538">&#9670;&nbsp;</a></span>pCtrl</h2>
130
131 <div class="memitem">
132 <div class="memproto">
133       <table class="memname">
134         <tr>
135           <td class="memname">void* pCtrl</td>
136         </tr>
137       </table>
138 </div><div class="memdoc">
139 <p>optional poitner to mbuf </p>
140
141 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00389">389</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
142
143 </div>
144 </div>
145 <a id="a77f0d5374ee675db57c0b29946ca7744"></a>
146 <h2 class="memtitle"><span class="permalink"><a href="#a77f0d5374ee675db57c0b29946ca7744">&#9670;&nbsp;</a></span>pData</h2>
147
148 <div class="memitem">
149 <div class="memproto">
150       <table class="memname">
151         <tr>
152           <td class="memname">uint8_t* pData</td>
153         </tr>
154       </table>
155 </div><div class="memdoc">
156 <p>optional pointer to data buffer </p>
157
158 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00388">388</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
159
160 </div>
161 </div>
162 <a id="aa82fd2a2292b3c25c7027b898fa53815"></a>
163 <h2 class="memtitle"><span class="permalink"><a href="#aa82fd2a2292b3c25c7027b898fa53815">&#9670;&nbsp;</a></span>section_id</h2>
164
165 <div class="memitem">
166 <div class="memproto">
167       <table class="memname">
168         <tr>
169           <td class="memname">uint16_t section_id</td>
170         </tr>
171       </table>
172 </div><div class="memdoc">
173 <p>section id used for this element </p>
174
175 <p class="definition">Definition at line <a class="el" href="xran__fh__o__du_8h_source.html#l00383">383</a> of file <a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>.</p>
176
177 </div>
178 </div>
179 <hr/>The documentation for this struct was generated from the following file:<ul>
180 <li><a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a></li>
181 </ul>
182 </div><!-- contents -->
183 <!-- start footer part -->
184 <hr class="footer"/><address class="footer"><small>
185 Generated by &#160;<a href="http://www.doxygen.org/index.html">
186 <img class="footer" src="doxygen.png" alt="doxygen"/>
187 </a> 1.8.13
188 </small></address>
189 </body>
190 </html>