add Doxygen documentation
[o-du/phy.git] / docs / API / structdata__section__hdr.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: data_section_hdr 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">data_section_hdr Struct Reference<div class="ingroups"><a class="el" href="group__xran__up__pkt.html">U-Plane XRAN Packet definitions and functions</a></div></div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for data_section_hdr:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structdata__section__hdr__coll__graph.png" border="0" usemap="#data__section__hdr_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:a9f1bf385f4549249e191e6563acbdecb"><td class="memItemLeft" >union {</td></tr>
79 <tr class="memitem:a9f9f2f87d8b5cc7e4af6ef3e2c4c8189"><td class="memItemLeft" >&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#a9f9f2f87d8b5cc7e4af6ef3e2c4c8189">all_bits</a></td></tr>
80 <tr class="separator:a9f9f2f87d8b5cc7e4af6ef3e2c4c8189"><td class="memSeparator" colspan="2">&#160;</td></tr>
81 <tr class="memitem:a0e0aaa059da6f49839fa06bd19c63c8f"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
82 <tr class="memitem:acb00c5e7ebe809fda7288c699eed867c"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#acb00c5e7ebe809fda7288c699eed867c">num_prbu</a>:8</td></tr>
83 <tr class="separator:acb00c5e7ebe809fda7288c699eed867c"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a486aca552c11b7046ca3066ebf4241dc"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#a486aca552c11b7046ca3066ebf4241dc">start_prbu</a>:10</td></tr>
85 <tr class="separator:a486aca552c11b7046ca3066ebf4241dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:aba23e80ad7dc1c3f7085ba3a2b4662bb"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#aba23e80ad7dc1c3f7085ba3a2b4662bb">sym_inc</a>:1</td></tr>
87 <tr class="separator:aba23e80ad7dc1c3f7085ba3a2b4662bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:ac91b2b11ae96c1a44e8a2fad473771c7"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#ac91b2b11ae96c1a44e8a2fad473771c7">rb</a>:1</td></tr>
89 <tr class="separator:ac91b2b11ae96c1a44e8a2fad473771c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a11d1616fb975ccafbc33ab590fe501c4"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint32_t&#160;&#160;&#160;<a class="el" href="structdata__section__hdr.html#a11d1616fb975ccafbc33ab590fe501c4">sect_id</a>:12</td></tr>
91 <tr class="separator:a11d1616fb975ccafbc33ab590fe501c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:a0e0aaa059da6f49839fa06bd19c63c8f"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
93 <tr class="separator:a0e0aaa059da6f49839fa06bd19c63c8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:a9f1bf385f4549249e191e6563acbdecb"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__section__hdr.html#a9f1bf385f4549249e191e6563acbdecb">fields</a></td></tr>
95 <tr class="separator:a9f1bf385f4549249e191e6563acbdecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 </table>
97 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
98 <div class="textblock"><p>Structure holding data section header fields It is repeated for every section ID in xRAN packet 5.4.5 Coding of Information Elements - Application Layer, Sections for U-plane as per 6.3.2 DL/UL Data </p>
99
100 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00067">67</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
101 </div><h2 class="groupheader">Field Documentation</h2>
102 <a id="a9f9f2f87d8b5cc7e4af6ef3e2c4c8189"></a>
103 <h2 class="memtitle"><span class="permalink"><a href="#a9f9f2f87d8b5cc7e4af6ef3e2c4c8189">&#9670;&nbsp;</a></span>all_bits</h2>
104
105 <div class="memitem">
106 <div class="memproto">
107       <table class="memname">
108         <tr>
109           <td class="memname">uint32_t all_bits</td>
110         </tr>
111       </table>
112 </div><div class="memdoc">
113
114 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00069">69</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
115
116 </div>
117 </div>
118 <a id="a9f1bf385f4549249e191e6563acbdecb"></a>
119 <h2 class="memtitle"><span class="permalink"><a href="#a9f1bf385f4549249e191e6563acbdecb">&#9670;&nbsp;</a></span>fields</h2>
120
121 <div class="memitem">
122 <div class="memproto">
123       <table class="memname">
124         <tr>
125           <td class="memname">union { ... }  fields</td>
126         </tr>
127       </table>
128 </div><div class="memdoc">
129
130 </div>
131 </div>
132 <a id="acb00c5e7ebe809fda7288c699eed867c"></a>
133 <h2 class="memtitle"><span class="permalink"><a href="#acb00c5e7ebe809fda7288c699eed867c">&#9670;&nbsp;</a></span>num_prbu</h2>
134
135 <div class="memitem">
136 <div class="memproto">
137       <table class="memname">
138         <tr>
139           <td class="memname">uint32_t num_prbu</td>
140         </tr>
141       </table>
142 </div><div class="memdoc">
143 <p>5.4.5.6 number of contiguous PRBs per control section </p>
144
145 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00071">71</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
146
147 </div>
148 </div>
149 <a id="ac91b2b11ae96c1a44e8a2fad473771c7"></a>
150 <h2 class="memtitle"><span class="permalink"><a href="#ac91b2b11ae96c1a44e8a2fad473771c7">&#9670;&nbsp;</a></span>rb</h2>
151
152 <div class="memitem">
153 <div class="memproto">
154       <table class="memname">
155         <tr>
156           <td class="memname">uint32_t rb</td>
157         </tr>
158       </table>
159 </div><div class="memdoc">
160 <p>5.4.5.2 resource block indicator, XRAN_RBIND_xxx </p>
161
162 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00074">74</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
163
164 </div>
165 </div>
166 <a id="a11d1616fb975ccafbc33ab590fe501c4"></a>
167 <h2 class="memtitle"><span class="permalink"><a href="#a11d1616fb975ccafbc33ab590fe501c4">&#9670;&nbsp;</a></span>sect_id</h2>
168
169 <div class="memitem">
170 <div class="memproto">
171       <table class="memname">
172         <tr>
173           <td class="memname">uint32_t sect_id</td>
174         </tr>
175       </table>
176 </div><div class="memdoc">
177 <p>5.4.5.1 section identifier </p>
178
179 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00075">75</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
180
181 </div>
182 </div>
183 <a id="a486aca552c11b7046ca3066ebf4241dc"></a>
184 <h2 class="memtitle"><span class="permalink"><a href="#a486aca552c11b7046ca3066ebf4241dc">&#9670;&nbsp;</a></span>start_prbu</h2>
185
186 <div class="memitem">
187 <div class="memproto">
188       <table class="memname">
189         <tr>
190           <td class="memname">uint32_t start_prbu</td>
191         </tr>
192       </table>
193 </div><div class="memdoc">
194 <p>5.4.5.4 starting PRB of control section </p>
195
196 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00072">72</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
197
198 </div>
199 </div>
200 <a id="aba23e80ad7dc1c3f7085ba3a2b4662bb"></a>
201 <h2 class="memtitle"><span class="permalink"><a href="#aba23e80ad7dc1c3f7085ba3a2b4662bb">&#9670;&nbsp;</a></span>sym_inc</h2>
202
203 <div class="memitem">
204 <div class="memproto">
205       <table class="memname">
206         <tr>
207           <td class="memname">uint32_t sym_inc</td>
208         </tr>
209       </table>
210 </div><div class="memdoc">
211 <p>5.4.5.3 symbol number increment command XRAN_SYMBOLNUMBER_xxxx </p>
212
213 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00073">73</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
214
215 </div>
216 </div>
217 <hr/>The documentation for this struct was generated from the following file:<ul>
218 <li><a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a></li>
219 </ul>
220 </div><!-- contents -->
221 <!-- start footer part -->
222 <hr class="footer"/><address class="footer"><small>
223 Generated by &#160;<a href="http://www.doxygen.org/index.html">
224 <img class="footer" src="doxygen.png" alt="doxygen"/>
225 </a> 1.8.13
226 </small></address>
227 </body>
228 </html>