add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__ecpri__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_ecpri_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_ecpri_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_8h_source.html">xran_pkt.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_ecpri_hdr:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__ecpri__hdr__coll__graph.png" border="0" usemap="#xran__ecpri__hdr_coll__map" alt="Collaboration graph"/></div>
74 <map name="xran__ecpri__hdr_coll__map" id="xran__ecpri__hdr_coll__map">
75 <area shape="rect" id="node2" href="structecpri__seq__id.html" title="{ecpri_seq_id\n|+ seq_id\l+ sub_seq_id\l+ e_bit\l|}" alt="" coords="5,20,105,127"/>
76 <area shape="rect" id="node3" 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="130,5,269,141"/>
77 </map>
78 </div>
79 <table class="memberdecls">
80 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
81 Data Fields</h2></td></tr>
82 <tr class="memitem:aa90ff3ad961fe295cdffddc945999212"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__ecpri__cmn__hdr.html">xran_ecpri_cmn_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__hdr.html#aa90ff3ad961fe295cdffddc945999212">cmnhdr</a></td></tr>
83 <tr class="separator:aa90ff3ad961fe295cdffddc945999212"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:abe6f9630ee7939118e68d24d90434e0c"><td class="memItemLeft" align="right" valign="top">rte_be16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__hdr.html#abe6f9630ee7939118e68d24d90434e0c">ecpri_xtc_id</a></td></tr>
85 <tr class="separator:abe6f9630ee7939118e68d24d90434e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:aa5d2447d17b81766e3843a60296446e3"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__hdr.html#aa5d2447d17b81766e3843a60296446e3">ecpri_seq_id</a></td></tr>
87 <tr class="separator:aa5d2447d17b81766e3843a60296446e3"><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>Structure holds eCPRI transport header as per Table 3 1 : eCPRI Transport Header Field Definitions </p>
91
92 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00130">130</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
93 </div><h2 class="groupheader">Field Documentation</h2>
94 <a id="aa90ff3ad961fe295cdffddc945999212"></a>
95 <h2 class="memtitle"><span class="permalink"><a href="#aa90ff3ad961fe295cdffddc945999212">&#9670;&nbsp;</a></span>cmnhdr</h2>
96
97 <div class="memitem">
98 <div class="memproto">
99       <table class="memname">
100         <tr>
101           <td class="memname">struct <a class="el" href="structxran__ecpri__cmn__hdr.html">xran_ecpri_cmn_hdr</a> cmnhdr</td>
102         </tr>
103       </table>
104 </div><div class="memdoc">
105
106 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00132">132</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
107
108 </div>
109 </div>
110 <a id="aa5d2447d17b81766e3843a60296446e3"></a>
111 <h2 class="memtitle"><span class="permalink"><a href="#aa5d2447d17b81766e3843a60296446e3">&#9670;&nbsp;</a></span>ecpri_seq_id</h2>
112
113 <div class="memitem">
114 <div class="memproto">
115       <table class="memname">
116         <tr>
117           <td class="memname">struct <a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a> <a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a></td>
118         </tr>
119       </table>
120 </div><div class="memdoc">
121 <p>3.1.3.1.7 message identifier </p>
122
123 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00134">134</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
124
125 </div>
126 </div>
127 <a id="abe6f9630ee7939118e68d24d90434e0c"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#abe6f9630ee7939118e68d24d90434e0c">&#9670;&nbsp;</a></span>ecpri_xtc_id</h2>
129
130 <div class="memitem">
131 <div class="memproto">
132       <table class="memname">
133         <tr>
134           <td class="memname">rte_be16_t ecpri_xtc_id</td>
135         </tr>
136       </table>
137 </div><div class="memdoc">
138 <p>3.1.3.1.6 real time control data / IQ data transfer message series identifier </p>
139
140 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00133">133</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
141
142 </div>
143 </div>
144 <hr/>The documentation for this struct was generated from the following file:<ul>
145 <li><a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a></li>
146 </ul>
147 </div><!-- contents -->
148 <!-- start footer part -->
149 <hr class="footer"/><address class="footer"><small>
150 Generated by &#160;<a href="http://www.doxygen.org/index.html">
151 <img class="footer" src="doxygen.png" alt="doxygen"/>
152 </a> 1.8.13
153 </small></address>
154 </body>
155 </html>