add Doxygen documentation
[o-du/phy.git] / docs / API / structradio__app__common__hdr.html
diff --git a/docs/API/structradio__app__common__hdr.html b/docs/API/structradio__app__common__hdr.html
new file mode 100644 (file)
index 0000000..0110955
--- /dev/null
@@ -0,0 +1,266 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>o-du/phy: radio_app_common_hdr Struct Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">o-du/phy
+   </div>
+   <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-attribs">Data Fields</a>  </div>
+  <div class="headertitle">
+<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>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for radio_app_common_hdr:</div>
+<div class="dyncontent">
+<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>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Data Fields</h2></td></tr>
+<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>
+<tr class="separator:ab370897260617b317ee8957e470de1cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a0058ea0059aba78a7a164c298c82de33"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a40f66f521df9b1dbae9d0ee852c66e0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a03c1016ac46b9df250b994f242cf956a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9beac05a1b301143744ef1968d01cc55"><td class="memItemLeft" >union {</td></tr>
+<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>
+<tr class="separator:a900b69af7d674b8db3bceae754b4955a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aeace60cac34459ee50c7a6601d28c70b"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
+<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>
+<tr class="separator:acbbef8fd7acac33a2a461e15a43112ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a02c1d0a330aa46a1bfee985080d93cd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a2c655c9f7a861ed572ea29f90392edda"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aeace60cac34459ee50c7a6601d28c70b"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
+<tr class="separator:aeace60cac34459ee50c7a6601d28c70b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a9beac05a1b301143744ef1968d01cc55"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<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>
+
+<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>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a40f66f521df9b1dbae9d0ee852c66e0d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a40f66f521df9b1dbae9d0ee852c66e0d">&#9670;&nbsp;</a></span>data_direction</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t data_direction</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>This parameter indicates the gNB data direction. </p>
+
+<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>
+
+</div>
+</div>
+<a id="ab370897260617b317ee8957e470de1cc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab370897260617b317ee8957e470de1cc">&#9670;&nbsp;</a></span>filter_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t filter_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<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>
+
+<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>
+
+</div>
+</div>
+<a id="a03c1016ac46b9df250b994f242cf956a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a03c1016ac46b9df250b994f242cf956a">&#9670;&nbsp;</a></span>frame_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t frame_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>This parameter is a counter for 10 ms frames (wrapping period 2.56 seconds) </p>
+
+<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>
+
+</div>
+</div>
+<a id="a0058ea0059aba78a7a164c298c82de33"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0058ea0059aba78a7a164c298c82de33">&#9670;&nbsp;</a></span>payl_ver</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t payl_ver</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<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>
+
+<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>
+
+</div>
+</div>
+<a id="a9beac05a1b301143744ef1968d01cc55"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9beac05a1b301143744ef1968d01cc55">&#9670;&nbsp;</a></span>sf_slot_sym</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">union { ... }  sf_slot_sym</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="a02c1d0a330aa46a1bfee985080d93cd4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a02c1d0a330aa46a1bfee985080d93cd4">&#9670;&nbsp;</a></span>slot_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t slot_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<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>
+
+<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>
+
+</div>
+</div>
+<a id="a2c655c9f7a861ed572ea29f90392edda"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2c655c9f7a861ed572ea29f90392edda">&#9670;&nbsp;</a></span>subframe_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t subframe_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>This parameter is a counter for 1 ms sub-frames within 10ms frame. </p>
+
+<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>
+
+</div>
+</div>
+<a id="acbbef8fd7acac33a2a461e15a43112ba"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acbbef8fd7acac33a2a461e15a43112ba">&#9670;&nbsp;</a></span>symb_id</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t symb_id</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>This parameter identifies the first symbol number within slot, to which the information of this message is applies. </p>
+
+<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>
+
+</div>
+</div>
+<a id="a900b69af7d674b8db3bceae754b4955a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a900b69af7d674b8db3bceae754b4955a">&#9670;&nbsp;</a></span>value</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t value</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<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>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a></li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>