add Doxygen documentation
[o-du/phy.git] / docs / API / xran__printf_8h.html
diff --git a/docs/API/xran__printf_8h.html b/docs/API/xran__printf_8h.html
new file mode 100644 (file)
index 0000000..50360f0
--- /dev/null
@@ -0,0 +1,383 @@
+<!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_printf.h File 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 id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="dir_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_5cc0cc0264b57168b75ca56bde6cc403.html">lib</a></li><li class="navelem"><a class="el" href="dir_9fc50806095da30fbd4a2dbe2e456ff5.html">src</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#define-members">Macros</a>  </div>
+  <div class="headertitle">
+<div class="title">xran_printf.h File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Modules provide debug prints and utility functions.  
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
+<code>#include &lt;stdlib.h&gt;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for xran_printf.h:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__printf_8h__incl.png" border="0" usemap="#xran__printf_8h" alt=""/></div>
+<map name="xran__printf_8h" id="xran__printf_8h">
+</map>
+</div>
+</div><div class="textblock"><div class="dynheader">
+This graph shows which files directly or indirectly include this file:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__printf_8h__dep__incl.png" border="0" usemap="#xran__printf_8hdep" alt=""/></div>
+<map name="xran__printf_8hdep" id="xran__printf_8hdep">
+<area shape="rect" id="node2" href="ethdi_8c.html" title="This file has all definitions for the Ethernet Data Interface Layer. " alt="" coords="5,80,67,107"/>
+<area shape="rect" id="node3" href="xran__app__frag_8c.html" title="xRAN application frgamentation for U&#45;plane packets " alt="" coords="91,80,205,107"/>
+<area shape="rect" id="node4" href="xran__common_8c.html" title="XRAN layer common functionality for both O&#45;DU and O&#45;RU as well as C&#45;plane and U&#45;plane. " alt="" coords="229,80,344,107"/>
+<area shape="rect" id="node5" href="xran__cp__api_8c.html" title="This file provides the API functions to build Control Plane Messages for XRAN Front Haul layer as def..." alt="" coords="369,80,471,107"/>
+<area shape="rect" id="node6" href="xran__frame__struct_8c.html" title="xran_frame_struct.c" alt="" coords="496,80,635,107"/>
+<area shape="rect" id="node7" href="xran__main_8c.html" title="XRAN main functionality module. " alt="" coords="659,80,752,107"/>
+<area shape="rect" id="node8" href="xran__sync__api_8c.html" title="This file provides implementation of synchronization related APIs (PTP/1588) for XRAN. " alt="" coords="776,80,893,107"/>
+<area shape="rect" id="node9" href="xran__timer_8c.html" title="This file provides implementation to Timing for XRAN. " alt="" coords="918,80,1013,107"/>
+<area shape="rect" id="node10" href="xran__transport_8c.html" title="This file provides the implementation for Transport lyaer (eCPRI) API. " alt="" coords="1037,80,1153,107"/>
+<area shape="rect" id="node11" href="xran__up__api_8c.html" title="This file provides the implementation of User Plane Messages APIs. " alt="" coords="1177,80,1279,107"/>
+</map>
+</div>
+</div>
+<p><a href="xran__printf_8h_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
+Macros</h2></td></tr>
+<tr class="memitem:abcb4ad51f1f16a398ff960ba4a0ed8c0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#abcb4ad51f1f16a398ff960ba4a0ed8c0">PRINTF_LOG_OK</a></td></tr>
+<tr class="separator:abcb4ad51f1f16a398ff960ba4a0ed8c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a467b83fc581fd7d20f8bf8c0af7240b9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a467b83fc581fd7d20f8bf8c0af7240b9">PRINTF_INF_OK</a></td></tr>
+<tr class="separator:a467b83fc581fd7d20f8bf8c0af7240b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa48f1da63506225983d78eeabd664382"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#aa48f1da63506225983d78eeabd664382">PRINTF_ERR_OK</a></td></tr>
+<tr class="separator:aa48f1da63506225983d78eeabd664382"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a677530742f5d55b5410c024f85794361"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a677530742f5d55b5410c024f85794361">print_log</a>(fmt,  args...)&#160;&#160;&#160;printf(&quot;%s:&quot; fmt &quot;\n&quot;, __FUNCTION__, ## args)</td></tr>
+<tr class="separator:a677530742f5d55b5410c024f85794361"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a417ba2c3b49b216e358bc340346bf1cf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a417ba2c3b49b216e358bc340346bf1cf">print_dbg</a>(fmt,  args...)</td></tr>
+<tr class="separator:a417ba2c3b49b216e358bc340346bf1cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a16c2c0a30b31515830a4a8eff6cf10b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a16c2c0a30b31515830a4a8eff6cf10b5">print_err</a>(fmt,  args...)&#160;&#160;&#160;printf(&quot;%s:[err] &quot; fmt &quot;\n&quot;, __FUNCTION__, ## args)</td></tr>
+<tr class="separator:a16c2c0a30b31515830a4a8eff6cf10b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4ca9250337e620175e2b71a1dc69d1d2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a4ca9250337e620175e2b71a1dc69d1d2">print_inf</a>&#160;&#160;&#160;printf</td></tr>
+<tr class="separator:a4ca9250337e620175e2b71a1dc69d1d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8c47e30913273d0d0599afdc0b39890a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a8c47e30913273d0d0599afdc0b39890a">_IASSERT_</a></td></tr>
+<tr class="separator:a8c47e30913273d0d0599afdc0b39890a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1474943d458f066f2f4be85a329d9028"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a1474943d458f066f2f4be85a329d9028">iAssert</a>(p)</td></tr>
+<tr class="separator:a1474943d458f066f2f4be85a329d9028"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0b1e75be8d28458f05360139be8c2555"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a0b1e75be8d28458f05360139be8c2555">_assert</a>(x)</td></tr>
+<tr class="separator:a0b1e75be8d28458f05360139be8c2555"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6907fcd45c00443dc2e3258a628208ca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__printf_8h.html#a6907fcd45c00443dc2e3258a628208ca">CHECK_NOT_NULL</a>(param,  returnValue)</td></tr>
+<tr class="separator:a6907fcd45c00443dc2e3258a628208ca"><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>Modules provide debug prints and utility functions. </p>
+<dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
+
+<p class="definition">Definition in file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+</div><h2 class="groupheader">Macro Definition Documentation</h2>
+<a id="a0b1e75be8d28458f05360139be8c2555"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0b1e75be8d28458f05360139be8c2555">&#9670;&nbsp;</a></span>_assert</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define _assert</td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">x</td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00097">97</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="a8c47e30913273d0d0599afdc0b39890a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8c47e30913273d0d0599afdc0b39890a">&#9670;&nbsp;</a></span>_IASSERT_</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define _IASSERT_</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00085">85</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="a6907fcd45c00443dc2e3258a628208ca"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6907fcd45c00443dc2e3258a628208ca">&#9670;&nbsp;</a></span>CHECK_NOT_NULL</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define CHECK_NOT_NULL</td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">param, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">returnValue&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00111">111</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="a1474943d458f066f2f4be85a329d9028"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1474943d458f066f2f4be85a329d9028">&#9670;&nbsp;</a></span>iAssert</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define iAssert</td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">p</td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00092">92</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="a417ba2c3b49b216e358bc340346bf1cf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a417ba2c3b49b216e358bc340346bf1cf">&#9670;&nbsp;</a></span>print_dbg</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define print_dbg</td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">fmt, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">args...&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00054">54</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="a16c2c0a30b31515830a4a8eff6cf10b5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a16c2c0a30b31515830a4a8eff6cf10b5">&#9670;&nbsp;</a></span>print_err</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define print_err</td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">fmt, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">args...&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td>&#160;&#160;&#160;printf(&quot;%s:[err] &quot; fmt &quot;\n&quot;, __FUNCTION__, ## args)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00062">62</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="a4ca9250337e620175e2b71a1dc69d1d2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4ca9250337e620175e2b71a1dc69d1d2">&#9670;&nbsp;</a></span>print_inf</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define print_inf&#160;&#160;&#160;printf</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00072">72</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="a677530742f5d55b5410c024f85794361"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a677530742f5d55b5410c024f85794361">&#9670;&nbsp;</a></span>print_log</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define print_log</td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">fmt, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">args...&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td>&#160;&#160;&#160;printf(&quot;%s:&quot; fmt &quot;\n&quot;, __FUNCTION__, ## args)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00042">42</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="aa48f1da63506225983d78eeabd664382"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa48f1da63506225983d78eeabd664382">&#9670;&nbsp;</a></span>PRINTF_ERR_OK</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define PRINTF_ERR_OK</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00037">37</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="a467b83fc581fd7d20f8bf8c0af7240b9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a467b83fc581fd7d20f8bf8c0af7240b9">&#9670;&nbsp;</a></span>PRINTF_INF_OK</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define PRINTF_INF_OK</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00036">36</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</div>
+</div>
+<a id="abcb4ad51f1f16a398ff960ba4a0ed8c0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#abcb4ad51f1f16a398ff960ba4a0ed8c0">&#9670;&nbsp;</a></span>PRINTF_LOG_OK</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define PRINTF_LOG_OK</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__printf_8h_source.html#l00035">35</a> of file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
+
+</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>