docs/API/structradio__app__common__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: radio_app_common_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">radio_app_common_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 radio_app_common_hdr:</div>
  72 <div class="dyncontent">
  73 <div class="center"><img src="structradio__app__common__hdr__coll__graph.png" border="0" usemap="#radio__app__common__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:ab370897260617b317ee8957e470de1cc"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structradio__app__common__hdr.html#ab370897260617b317ee8957e470de1cc">filter_id</a>:4</td></tr>
  79 <tr class="separator:ab370897260617b317ee8957e470de1cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:a0058ea0059aba78a7a164c298c82de33"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structradio__app__common__hdr.html#a0058ea0059aba78a7a164c298c82de33">payl_ver</a>:3</td></tr>
  81 <tr class="separator:a0058ea0059aba78a7a164c298c82de33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:a40f66f521df9b1dbae9d0ee852c66e0d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structradio__app__common__hdr.html#a40f66f521df9b1dbae9d0ee852c66e0d">data_direction</a>:1</td></tr>
  83 <tr class="separator:a40f66f521df9b1dbae9d0ee852c66e0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:a03c1016ac46b9df250b994f242cf956a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structradio__app__common__hdr.html#a03c1016ac46b9df250b994f242cf956a">frame_id</a>:8</td></tr>
  85 <tr class="separator:a03c1016ac46b9df250b994f242cf956a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a9beac05a1b301143744ef1968d01cc55"><td class="memItemLeft" >union {</td></tr>
  87 <tr class="memitem:a900b69af7d674b8db3bceae754b4955a"><td class="memItemLeft" >&#160;&#160;&#160;uint16_t&#160;&#160;&#160;<a class="el" href="structradio__app__common__hdr.html#a900b69af7d674b8db3bceae754b4955a">value</a></td></tr>
  88 <tr class="separator:a900b69af7d674b8db3bceae754b4955a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:aeace60cac34459ee50c7a6601d28c70b"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  90 <tr class="memitem:acbbef8fd7acac33a2a461e15a43112ba"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint16_t&#160;&#160;&#160;<a class="el" href="structradio__app__common__hdr.html#acbbef8fd7acac33a2a461e15a43112ba">symb_id</a>:6</td></tr>
  91 <tr class="separator:acbbef8fd7acac33a2a461e15a43112ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a02c1d0a330aa46a1bfee985080d93cd4"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint16_t&#160;&#160;&#160;<a class="el" href="structradio__app__common__hdr.html#a02c1d0a330aa46a1bfee985080d93cd4">slot_id</a>:6</td></tr>
  93 <tr class="separator:a02c1d0a330aa46a1bfee985080d93cd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:a2c655c9f7a861ed572ea29f90392edda"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;uint16_t&#160;&#160;&#160;<a class="el" href="structradio__app__common__hdr.html#a2c655c9f7a861ed572ea29f90392edda">subframe_id</a>:4</td></tr>
  95 <tr class="separator:a2c655c9f7a861ed572ea29f90392edda"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:aeace60cac34459ee50c7a6601d28c70b"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
  97 <tr class="separator:aeace60cac34459ee50c7a6601d28c70b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 <tr class="memitem:a9beac05a1b301143744ef1968d01cc55"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structradio__app__common__hdr.html#a9beac05a1b301143744ef1968d01cc55">sf_slot_sym</a></td></tr>
  99 <tr class="separator:a9beac05a1b301143744ef1968d01cc55"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 </table>
 101 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 102 <div class="textblock"><p>Structure holds components of radio application header 5.4.4 Coding of Information Elements - Application Layer, Common for U-plane as per 6.3.2 DL/UL Data </p>
 103
 104 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00162">162</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 105 </div><h2 class="groupheader">Field Documentation</h2>
 106 <a id="a40f66f521df9b1dbae9d0ee852c66e0d"></a>
 107 <h2 class="memtitle"><span class="permalink"><a href="#a40f66f521df9b1dbae9d0ee852c66e0d">&#9670;&nbsp;</a></span>data_direction</h2>
 108
 109 <div class="memitem">
 110 <div class="memproto">
 111       <table class="memname">
 112         <tr>
 113           <td class="memname">uint8_t data_direction</td>
 114         </tr>
 115       </table>
 116 </div><div class="memdoc">
 117 <p>This parameter indicates the gNB data direction. </p>
 118
 119 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00173">173</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 120
 121 </div>
 122 </div>
 123 <a id="ab370897260617b317ee8957e470de1cc"></a>
 124 <h2 class="memtitle"><span class="permalink"><a href="#ab370897260617b317ee8957e470de1cc">&#9670;&nbsp;</a></span>filter_id</h2>
 125
 126 <div class="memitem">
 127 <div class="memproto">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname">uint8_t filter_id</td>
 131         </tr>
 132       </table>
 133 </div><div class="memdoc">
 134 <p>This parameter defines an index to the channel filter to be used between IQ data and air interface, both in DL and UL. For most physical channels filterIndex =0000b is used which indexes the standard channel filter, e.g. 100MHz channel filter for 100MHz nominal carrier bandwidth. (see 5.4.4.3 for more) </p>
 135
 136 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00165">165</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 137
 138 </div>
 139 </div>
 140 <a id="a03c1016ac46b9df250b994f242cf956a"></a>
 141 <h2 class="memtitle"><span class="permalink"><a href="#a03c1016ac46b9df250b994f242cf956a">&#9670;&nbsp;</a></span>frame_id</h2>
 142
 143 <div class="memitem">
 144 <div class="memproto">
 145       <table class="memname">
 146         <tr>
 147           <td class="memname">uint8_t frame_id</td>
 148         </tr>
 149       </table>
 150 </div><div class="memdoc">
 151 <p>This parameter is a counter for 10 ms frames (wrapping period 2.56 seconds) </p>
 152
 153 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00176">176</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 154
 155 </div>
 156 </div>
 157 <a id="a0058ea0059aba78a7a164c298c82de33"></a>
 158 <h2 class="memtitle"><span class="permalink"><a href="#a0058ea0059aba78a7a164c298c82de33">&#9670;&nbsp;</a></span>payl_ver</h2>
 159
 160 <div class="memitem">
 161 <div class="memproto">
 162       <table class="memname">
 163         <tr>
 164           <td class="memname">uint8_t payl_ver</td>
 165         </tr>
 166       </table>
 167 </div><div class="memdoc">
 168 <p>This parameter defines the payload protocol version valid for the following IEs in the application layer. In this version of the specification payloadVersion=001b shall be used. </p>
 169
 170 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00170">170</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 171
 172 </div>
 173 </div>
 174 <a id="a9beac05a1b301143744ef1968d01cc55"></a>
 175 <h2 class="memtitle"><span class="permalink"><a href="#a9beac05a1b301143744ef1968d01cc55">&#9670;&nbsp;</a></span>sf_slot_sym</h2>
 176
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">union { ... }  sf_slot_sym</td>
 182         </tr>
 183       </table>
 184 </div><div class="memdoc">
 185
 186 </div>
 187 </div>
 188 <a id="a02c1d0a330aa46a1bfee985080d93cd4"></a>
 189 <h2 class="memtitle"><span class="permalink"><a href="#a02c1d0a330aa46a1bfee985080d93cd4">&#9670;&nbsp;</a></span>slot_id</h2>
 190
 191 <div class="memitem">
 192 <div class="memproto">
 193       <table class="memname">
 194         <tr>
 195           <td class="memname">uint16_t slot_id</td>
 196         </tr>
 197       </table>
 198 </div><div class="memdoc">
 199 <p>This parameter is the slot number within a 1ms sub-frame. All slots in one sub-frame are counted by this parameter, slotId running from 0 to Nslot-1. In this version of the specification the maximum Nslot=16, All other values of the 6 bits are reserved for future use. </p>
 200
 201 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00185">185</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 202
 203 </div>
 204 </div>
 205 <a id="a2c655c9f7a861ed572ea29f90392edda"></a>
 206 <h2 class="memtitle"><span class="permalink"><a href="#a2c655c9f7a861ed572ea29f90392edda">&#9670;&nbsp;</a></span>subframe_id</h2>
 207
 208 <div class="memitem">
 209 <div class="memproto">
 210       <table class="memname">
 211         <tr>
 212           <td class="memname">uint16_t subframe_id</td>
 213         </tr>
 214       </table>
 215 </div><div class="memdoc">
 216 <p>This parameter is a counter for 1 ms sub-frames within 10ms frame. </p>
 217
 218 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00189">189</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 219
 220 </div>
 221 </div>
 222 <a id="acbbef8fd7acac33a2a461e15a43112ba"></a>
 223 <h2 class="memtitle"><span class="permalink"><a href="#acbbef8fd7acac33a2a461e15a43112ba">&#9670;&nbsp;</a></span>symb_id</h2>
 224
 225 <div class="memitem">
 226 <div class="memproto">
 227       <table class="memname">
 228         <tr>
 229           <td class="memname">uint16_t symb_id</td>
 230         </tr>
 231       </table>
 232 </div><div class="memdoc">
 233 <p>This parameter identifies the first symbol number within slot, to which the information of this message is applies. </p>
 234
 235 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00183">183</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
 236
 237 </div>
 238 </div>
 239 <a id="a900b69af7d674b8db3bceae754b4955a"></a>
 240 <h2 class="memtitle"><span class="permalink"><a href="#a900b69af7d674b8db3bceae754b4955a">&#9670;&nbsp;</a></span>value</h2>
 241
 242 <div class="memitem">
 243 <div class="memproto">
 244       <table class="memname">
 245         <tr>
 246           <td class="memname">uint16_t value</td>
 247         </tr>
 248       </table>
 249 </div><div class="memdoc">
 250
 251 <p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00181">181</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.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_8h_source.html">xran_pkt.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>