Code Review / o-du / phy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
add Doxygen documentation
[o-du/phy.git] / docs / API / group__xran__common__pkt.html
diff --git a/docs/API/group__xran__common__pkt.html b/docs/API/group__xran__common__pkt.html
new file mode 100644 (file)
index 0000000..91b081a
--- /dev/null
+++ b/docs/API/group__xran__common__pkt.html
@@ -0,0 +1,198 @@
+<!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: XRAN Packet definitions and functions</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>
+</div><!-- top -->
+<!-- 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 class="header">
+  <div class="summary">
+<a href="#nested-classes">Data Structures</a> &#124;
+<a href="#enum-members">Enumerations</a> &#124;
+<a href="#var-members">Variables</a>  </div>
+  <div class="headertitle">
+<div class="title">XRAN Packet definitions and functions</div>  </div>
+</div><!--header-->
+<div class="contents">
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Data Structures</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structecpri__seq__id.html">ecpri_seq_id</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__cmn__hdr.html">xran_ecpri_cmn_hdr</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__ecpri__hdr.html">xran_ecpri_hdr</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structradio__app__common__hdr.html">radio_app_common_hdr</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcompression__hdr.html">compression_hdr</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__pkt__comm__hdr.html">xran_pkt_comm_hdr</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__up__pkt__hdr.html">xran_up_pkt_hdr</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeth__xran__up__pkt__hdr.html">eth_xran_up_pkt_hdr</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
+Enumerations</h2></td></tr>
+<tr class="memitem:ga5f49588115e2d0a807ad613ae866384a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xran__common__pkt.html#ga5f49588115e2d0a807ad613ae866384a">ecpri_msg_type</a> { <br />
+&#160;&#160;<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aaef46b9a1a9d9f7c3276e1e99b02ef6de">ECPRI_IQ_DATA</a> = 0x00, 
+<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa83e30716d1c67fc4c96aed3dc63306e7">ECPRI_BIT_SEQUENCE</a> = 0x01, 
+<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa54c48b34d68f3445f6108e416a655955">ECPRI_RT_CONTROL_DATA</a> = 0x02, 
+<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aaa63937b639e3635a13a385109df8883b">ECPRI_GEN_DATA_TRANSFER</a> = 0x03, 
+<br />
+&#160;&#160;<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa030da92cf8a6e8fe6ef5dda2d8d6869b">ECPRI_REMOTE_MEM_ACCESS</a> = 0x04, 
+<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa83e33b4f939bf5f34675c575efef7725">ECPRI_DELAY_MEASUREMENT</a> = 0x05, 
+<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa58c3ff60f86b8a738082deeee4e3f1ab">ECPRI_REMOTE_RESET</a> = 0x06, 
+<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa2936c4480b2bb50029755835dca9727d">ECPRI_EVENT_INDICATION</a> = 0x07, 
+<br />
+&#160;&#160;<a class="el" href="group__xran__common__pkt.html#gga5f49588115e2d0a807ad613ae866384aa02a7dc510de42e21631982f2c60be2f1">ECPRI_MSG_TYPE_MAX</a>
+<br />
+ }</td></tr>
+<tr class="separator:ga5f49588115e2d0a807ad613ae866384a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga9c60a23fdae979ad1842b255790d1558"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xran__common__pkt.html#ga9c60a23fdae979ad1842b255790d1558">xran_pkt_dir</a> { <a class="el" href="group__xran__common__pkt.html#gga9c60a23fdae979ad1842b255790d1558a404255db3f05419798875bfb763e1c05">XRAN_DIR_UL</a> = 0, 
+<a class="el" href="group__xran__common__pkt.html#gga9c60a23fdae979ad1842b255790d1558a19f3d3cee814f10e4f3bf7d80194083f">XRAN_DIR_DL</a> = 1, 
+<a class="el" href="group__xran__common__pkt.html#gga9c60a23fdae979ad1842b255790d1558a927c0750db0e35def0b5e1a088a5b9e4">XRAN_DIR_MAX</a>
+ }</td></tr>
+<tr class="separator:ga9c60a23fdae979ad1842b255790d1558"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
+Variables</h2></td></tr>
+<tr class="memitem:ga303c201bb1ad2f72aa29dd1375efaf72"><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="group__xran__common__pkt.html#ga303c201bb1ad2f72aa29dd1375efaf72">__rte_packed</a></td></tr>
+<tr class="separator:ga303c201bb1ad2f72aa29dd1375efaf72"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<p>Definitions and support functions to process XRAN packet </p>
+<h2 class="groupheader">Enumeration Type Documentation</h2>
+<a id="ga5f49588115e2d0a807ad613ae866384a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga5f49588115e2d0a807ad613ae866384a">&#9670;&nbsp;</a></span>ecpri_msg_type</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">enum <a class="el" href="group__xran__common__pkt.html#ga5f49588115e2d0a807ad613ae866384a">ecpri_msg_type</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>eCPRI message types as per eCPRI spec 3.2.4. Message Types </p>
+<table class="fieldtable">
+<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aaef46b9a1a9d9f7c3276e1e99b02ef6de"></a>ECPRI_IQ_DATA&#160;</td><td class="fielddoc"><p>U-plane: IQ data </p>
+</td></tr>
+<tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa83e30716d1c67fc4c96aed3dc63306e7"></a>ECPRI_BIT_SEQUENCE&#160;</td><td class="fielddoc"></td></tr>
+<tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa54c48b34d68f3445f6108e416a655955"></a>ECPRI_RT_CONTROL_DATA&#160;</td><td class="fielddoc"><p>C-plane: Control </p>
+</td></tr>
+<tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aaa63937b639e3635a13a385109df8883b"></a>ECPRI_GEN_DATA_TRANSFER&#160;</td><td class="fielddoc"></td></tr>
+<tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa030da92cf8a6e8fe6ef5dda2d8d6869b"></a>ECPRI_REMOTE_MEM_ACCESS&#160;</td><td class="fielddoc"></td></tr>
+<tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa83e33b4f939bf5f34675c575efef7725"></a>ECPRI_DELAY_MEASUREMENT&#160;</td><td class="fielddoc"></td></tr>
+<tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa58c3ff60f86b8a738082deeee4e3f1ab"></a>ECPRI_REMOTE_RESET&#160;</td><td class="fielddoc"></td></tr>
+<tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa2936c4480b2bb50029755835dca9727d"></a>ECPRI_EVENT_INDICATION&#160;</td><td class="fielddoc"></td></tr>
+<tr><td class="fieldname"><a id="gga5f49588115e2d0a807ad613ae866384aa02a7dc510de42e21631982f2c60be2f1"></a>ECPRI_MSG_TYPE_MAX&#160;</td><td class="fielddoc"></td></tr>
+</table>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00075">75</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
+
+</div>
+</div>
+<a id="ga9c60a23fdae979ad1842b255790d1558"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga9c60a23fdae979ad1842b255790d1558">&#9670;&nbsp;</a></span>xran_pkt_dir</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">enum <a class="el" href="group__xran__common__pkt.html#ga9c60a23fdae979ad1842b255790d1558">xran_pkt_dir</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Enum used to set xRAN packet data direction (gNB Tx/Rx 5.4.4.1) uplink or downlink </p>
+<table class="fieldtable">
+<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9c60a23fdae979ad1842b255790d1558a404255db3f05419798875bfb763e1c05"></a>XRAN_DIR_UL&#160;</td><td class="fielddoc"><p>UL direction </p>
+</td></tr>
+<tr><td class="fieldname"><a id="gga9c60a23fdae979ad1842b255790d1558a19f3d3cee814f10e4f3bf7d80194083f"></a>XRAN_DIR_DL&#160;</td><td class="fielddoc"><p>DL direction </p>
+</td></tr>
+<tr><td class="fieldname"><a id="gga9c60a23fdae979ad1842b255790d1558a927c0750db0e35def0b5e1a088a5b9e4"></a>XRAN_DIR_MAX&#160;</td><td class="fielddoc"></td></tr>
+</table>
+
+<p class="definition">Definition at line <a class="el" href="xran__pkt_8h_source.html#l00146">146</a> of file <a class="el" href="xran__pkt_8h_source.html">xran_pkt.h</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Variable Documentation</h2>
+<a id="ga303c201bb1ad2f72aa29dd1375efaf72"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ga303c201bb1ad2f72aa29dd1375efaf72">&#9670;&nbsp;</a></span>__rte_packed</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">struct <a class="el" href="structeth__xran__up__pkt__hdr.html">eth_xran_up_pkt_hdr</a> __rte_packed</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+</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>
O-RAN DU Physical Layer