add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__up__pkt__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: xran_up_pkt_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">xran_up_pkt_hdr Struct Reference<div class="ingroups"><a class="el" href="group__xran__common__pkt.html">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 xran_up_pkt_hdr:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__up__pkt__hdr__coll__graph.png" border="0" usemap="#xran__up__pkt__hdr_coll__map" alt="Collaboration graph"/></div>
74 <map name="xran__up__pkt__hdr_coll__map" id="xran__up__pkt__hdr_coll__map">
75 <area shape="rect" id="node2" href="structdata__section__hdr.html" title="{data_section_hdr\n|+ all_bits\l+ num_prbu\l+ start_prbu\l+ sym_inc\l+ rb\l+ sect_id\l+ fields\l|}" alt="" coords="5,219,127,384"/>
76 <area shape="rect" id="node3" href="structradio__app__common__hdr.html" title="{radio_app_common_hdr\n|+ filter_id\l+ payl_ver\l+ data_direction\l+ frame_id\l+ value\l+ symb_id\l+ slot_id\l+ subframe_id\l+ sf_slot_sym\l|}" alt="" coords="151,204,311,399"/>
77 <area shape="rect" id="node4" href="structxran__ecpri__hdr.html" title="{xran_ecpri_hdr\n|+ ecpri_xtc_id\l|}" alt="" coords="335,263,442,340"/>
78 <area shape="rect" id="node5" href="structecpri__seq__id.html" title="{ecpri_seq_id\n|+ seq_id\l+ sub_seq_id\l+ e_bit\l|}" alt="" coords="267,20,367,127"/>
79 <area shape="rect" id="node6" href="structxran__ecpri__cmn__hdr.html" title="{xran_ecpri_cmn_hdr\n|+ ecpri_concat\l+ ecpri_resv\l+ ecpri_ver\l+ ecpri_mesg_type\l+ ecpri_payl_size\l|}" alt="" coords="391,5,530,141"/>
80 </map>
81 </div>
82 <table class="memberdecls">
83 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
84 Data Fields</h2></td></tr>
85 <tr class="memitem:ae84e1fad9281c0bfd9c07df6a570a4f0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__ecpri__hdr.html">xran_ecpri_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__hdr.html#ae84e1fad9281c0bfd9c07df6a570a4f0">ecpri_hdr</a></td></tr>
86 <tr class="separator:ae84e1fad9281c0bfd9c07df6a570a4f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:aaf6128cec538e7dde3f6a1045ea0ce54"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structradio__app__common__hdr.html">radio_app_common_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__hdr.html#aaf6128cec538e7dde3f6a1045ea0ce54">app_hdr</a></td></tr>
88 <tr class="separator:aaf6128cec538e7dde3f6a1045ea0ce54"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:ae6c3c6125160f3863ad8ef7d7673df50"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structdata__section__hdr.html">data_section_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__hdr.html#ae6c3c6125160f3863ad8ef7d7673df50">data_sec_hdr</a></td></tr>
90 <tr class="separator:ae6c3c6125160f3863ad8ef7d7673df50"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 </table>
92 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
93 <div class="textblock"><p>Structure holds complete xran u-plane packet header 3.1.1 Ethernet Encapsulation </p>
94
95 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00149">149</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
96 </div><h2 class="groupheader">Field Documentation</h2>
97 <a id="aaf6128cec538e7dde3f6a1045ea0ce54"></a>
98 <h2 class="memtitle"><span class="permalink"><a href="#aaf6128cec538e7dde3f6a1045ea0ce54">&#9670;&nbsp;</a></span>app_hdr</h2>
99
100 <div class="memitem">
101 <div class="memproto">
102       <table class="memname">
103         <tr>
104           <td class="memname">struct <a class="el" href="structradio__app__common__hdr.html">radio_app_common_hdr</a> app_hdr</td>
105         </tr>
106       </table>
107 </div><div class="memdoc">
108 <p>eCPRI Transport Header </p>
109
110 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00152">152</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
111
112 </div>
113 </div>
114 <a id="ae6c3c6125160f3863ad8ef7d7673df50"></a>
115 <h2 class="memtitle"><span class="permalink"><a href="#ae6c3c6125160f3863ad8ef7d7673df50">&#9670;&nbsp;</a></span>data_sec_hdr</h2>
116
117 <div class="memitem">
118 <div class="memproto">
119       <table class="memname">
120         <tr>
121           <td class="memname">struct <a class="el" href="structdata__section__hdr.html">data_section_hdr</a> data_sec_hdr</td>
122         </tr>
123       </table>
124 </div><div class="memdoc">
125
126 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00153">153</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
127
128 </div>
129 </div>
130 <a id="ae84e1fad9281c0bfd9c07df6a570a4f0"></a>
131 <h2 class="memtitle"><span class="permalink"><a href="#ae84e1fad9281c0bfd9c07df6a570a4f0">&#9670;&nbsp;</a></span>ecpri_hdr</h2>
132
133 <div class="memitem">
134 <div class="memproto">
135       <table class="memname">
136         <tr>
137           <td class="memname">struct <a class="el" href="structxran__ecpri__hdr.html">xran_ecpri_hdr</a> ecpri_hdr</td>
138         </tr>
139       </table>
140 </div><div class="memdoc">
141 <p>eCPRI Transport Header </p>
142
143 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00151">151</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
144
145 </div>
146 </div>
147 <hr/>The documentation for this struct was generated from the following file:<ul>
148 <li><a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a></li>
149 </ul>
150 </div><!-- contents -->
151 <!-- start footer part -->
152 <hr class="footer"/><address class="footer"><small>
153 Generated by &#160;<a href="http://www.doxygen.org/index.html">
154 <img class="footer" src="doxygen.png" alt="doxygen"/>
155 </a> 1.8.13
156 </small></address>
157 </body>
158 </html>