docs/API/structxran__cp__radioapp__common__header.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_cp_radioapp_common_header 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_cp_radioapp_common_header Struct Reference</div>  </div>
  66 </div><!--header-->
  67 <div class="contents">
  68
  69 <p><code>#include &lt;<a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>&gt;</code></p>
  70 <div class="dynheader">
  71 Collaboration diagram for xran_cp_radioapp_common_header:</div>
  72 <div class="dyncontent">
  73 <div class="center"><img src="structxran__cp__radioapp__common__header__coll__graph.png" border="0" usemap="#xran__cp__radioapp__common__header_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:a158cc4eb9be778527f9afe0bf9df19e0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a158cc4eb9be778527f9afe0bf9df19e0">startSymbolId</a>:6</td></tr>
  79 <tr class="separator:a158cc4eb9be778527f9afe0bf9df19e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:ae287404c8c0fa4fb464abf8f6a516346"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#ae287404c8c0fa4fb464abf8f6a516346">slotId</a>:6</td></tr>
  81 <tr class="separator:ae287404c8c0fa4fb464abf8f6a516346"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:aa948cf928c529d24f8d536fb480094f2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#aa948cf928c529d24f8d536fb480094f2">subframeId</a>:4</td></tr>
  83 <tr class="separator:aa948cf928c529d24f8d536fb480094f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:a15a5e5806d950f2d75550c17b007153c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a15a5e5806d950f2d75550c17b007153c">frameId</a>:8</td></tr>
  85 <tr class="separator:a15a5e5806d950f2d75550c17b007153c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a6275bf84e65f219845e03cf9535f893a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a6275bf84e65f219845e03cf9535f893a">filterIndex</a>:4</td></tr>
  87 <tr class="separator:a6275bf84e65f219845e03cf9535f893a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:a06cacc53918b2e51a13fc506b4351d63"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a06cacc53918b2e51a13fc506b4351d63">payloadVer</a>:3</td></tr>
  89 <tr class="separator:a06cacc53918b2e51a13fc506b4351d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:a87c3e6cd307a5ee7d853ec7254fcd010"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a87c3e6cd307a5ee7d853ec7254fcd010">dataDirection</a>:1</td></tr>
  91 <tr class="separator:a87c3e6cd307a5ee7d853ec7254fcd010"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a879dd7efae60d48d1c20349a00feee87"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#a879dd7efae60d48d1c20349a00feee87">numOfSections</a></td></tr>
  93 <tr class="separator:a879dd7efae60d48d1c20349a00feee87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:ae273caa235b1c6085de4ad13886f82c9"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__common__header.html#ae273caa235b1c6085de4ad13886f82c9">sectionType</a></td></tr>
  95 <tr class="separator:ae273caa235b1c6085de4ad13886f82c9"><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>Common Radio Application Header for C-Plane </p>
  99
 100 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00061">61</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 101 </div><h2 class="groupheader">Field Documentation</h2>
 102 <a id="a87c3e6cd307a5ee7d853ec7254fcd010"></a>
 103 <h2 class="memtitle"><span class="permalink"><a href="#a87c3e6cd307a5ee7d853ec7254fcd010">&#9670;&nbsp;</a></span>dataDirection</h2>
 104
 105 <div class="memitem">
 106 <div class="memproto">
 107       <table class="memname">
 108         <tr>
 109           <td class="memname">uint32_t dataDirection</td>
 110         </tr>
 111       </table>
 112 </div><div class="memdoc">
 113 <p>5.4.4.1 data direction (gNB Tx/Rx) </p>
 114
 115 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00068">68</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 116
 117 </div>
 118 </div>
 119 <a id="a6275bf84e65f219845e03cf9535f893a"></a>
 120 <h2 class="memtitle"><span class="permalink"><a href="#a6275bf84e65f219845e03cf9535f893a">&#9670;&nbsp;</a></span>filterIndex</h2>
 121
 122 <div class="memitem">
 123 <div class="memproto">
 124       <table class="memname">
 125         <tr>
 126           <td class="memname">uint32_t filterIndex</td>
 127         </tr>
 128       </table>
 129 </div><div class="memdoc">
 130 <p>5.4.4.3 filter index, XRAN_FILTERINDEX_xxxx </p>
 131
 132 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00066">66</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 133
 134 </div>
 135 </div>
 136 <a id="a15a5e5806d950f2d75550c17b007153c"></a>
 137 <h2 class="memtitle"><span class="permalink"><a href="#a15a5e5806d950f2d75550c17b007153c">&#9670;&nbsp;</a></span>frameId</h2>
 138
 139 <div class="memitem">
 140 <div class="memproto">
 141       <table class="memname">
 142         <tr>
 143           <td class="memname">uint32_t frameId</td>
 144         </tr>
 145       </table>
 146 </div><div class="memdoc">
 147 <p>5.4.4.4 frame identifier </p>
 148
 149 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00065">65</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 150
 151 </div>
 152 </div>
 153 <a id="a879dd7efae60d48d1c20349a00feee87"></a>
 154 <h2 class="memtitle"><span class="permalink"><a href="#a879dd7efae60d48d1c20349a00feee87">&#9670;&nbsp;</a></span>numOfSections</h2>
 155
 156 <div class="memitem">
 157 <div class="memproto">
 158       <table class="memname">
 159         <tr>
 160           <td class="memname">uint8_t numOfSections</td>
 161         </tr>
 162       </table>
 163 </div><div class="memdoc">
 164 <p>5.4.4.8 number of sections </p>
 165
 166 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00069">69</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 167
 168 </div>
 169 </div>
 170 <a id="a06cacc53918b2e51a13fc506b4351d63"></a>
 171 <h2 class="memtitle"><span class="permalink"><a href="#a06cacc53918b2e51a13fc506b4351d63">&#9670;&nbsp;</a></span>payloadVer</h2>
 172
 173 <div class="memitem">
 174 <div class="memproto">
 175       <table class="memname">
 176         <tr>
 177           <td class="memname">uint32_t payloadVer</td>
 178         </tr>
 179       </table>
 180 </div><div class="memdoc">
 181 <p>5.4.4.2 payload version, should be 1 </p>
 182
 183 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00067">67</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 184
 185 </div>
 186 </div>
 187 <a id="ae273caa235b1c6085de4ad13886f82c9"></a>
 188 <h2 class="memtitle"><span class="permalink"><a href="#ae273caa235b1c6085de4ad13886f82c9">&#9670;&nbsp;</a></span>sectionType</h2>
 189
 190 <div class="memitem">
 191 <div class="memproto">
 192       <table class="memname">
 193         <tr>
 194           <td class="memname">uint8_t sectionType</td>
 195         </tr>
 196       </table>
 197 </div><div class="memdoc">
 198 <p>5.4.4.9 section type </p>
 199
 200 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00070">70</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 201
 202 </div>
 203 </div>
 204 <a id="ae287404c8c0fa4fb464abf8f6a516346"></a>
 205 <h2 class="memtitle"><span class="permalink"><a href="#ae287404c8c0fa4fb464abf8f6a516346">&#9670;&nbsp;</a></span>slotId</h2>
 206
 207 <div class="memitem">
 208 <div class="memproto">
 209       <table class="memname">
 210         <tr>
 211           <td class="memname">uint32_t slotId</td>
 212         </tr>
 213       </table>
 214 </div><div class="memdoc">
 215 <p>5.4.4.6 slot identifier </p>
 216
 217 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00063">63</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 218
 219 </div>
 220 </div>
 221 <a id="a158cc4eb9be778527f9afe0bf9df19e0"></a>
 222 <h2 class="memtitle"><span class="permalink"><a href="#a158cc4eb9be778527f9afe0bf9df19e0">&#9670;&nbsp;</a></span>startSymbolId</h2>
 223
 224 <div class="memitem">
 225 <div class="memproto">
 226       <table class="memname">
 227         <tr>
 228           <td class="memname">uint32_t startSymbolId</td>
 229         </tr>
 230       </table>
 231 </div><div class="memdoc">
 232 <p>5.4.4.7 start symbol identifier </p>
 233
 234 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00062">62</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 235
 236 </div>
 237 </div>
 238 <a id="aa948cf928c529d24f8d536fb480094f2"></a>
 239 <h2 class="memtitle"><span class="permalink"><a href="#aa948cf928c529d24f8d536fb480094f2">&#9670;&nbsp;</a></span>subframeId</h2>
 240
 241 <div class="memitem">
 242 <div class="memproto">
 243       <table class="memname">
 244         <tr>
 245           <td class="memname">uint32_t subframeId</td>
 246         </tr>
 247       </table>
 248 </div><div class="memdoc">
 249 <p>5.4.4.5 subframe identifier </p>
 250
 251 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00064">64</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
 252
 253 </div>
 254 </div>
 255 <hr/>The documentation for this struct was generated from the following file:<ul>
 256 <li><a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a></li>
 257 </ul>
 258 </div><!-- contents -->
 259 <!-- start footer part -->
 260 <hr class="footer"/><address class="footer"><small>
 261 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 262 <img class="footer" src="doxygen.png" alt="doxygen"/>
 263 </a> 1.8.13
 264 </small></address>
 265 </body>
 266 </html>