add Doxygen documentation
[o-du/phy.git] / docs / API / debug_8h.html
diff --git a/docs/API/debug_8h.html b/docs/API/debug_8h.html
new file mode 100644 (file)
index 0000000..c4d2f55
--- /dev/null
@@ -0,0 +1,319 @@
+<!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: debug.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_4b76f00ffa3e05ab9c225ea6671f6b6c.html">app</a></li><li class="navelem"><a class="el" href="dir_dd7de4ccd45f8474612b8f6c09959d91.html">src</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#define-members">Macros</a> &#124;
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">debug.h File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
+<code>#include &quot;<a class="el" href="config_8h_source.html">config.h</a>&quot;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for debug.h:</div>
+<div class="dyncontent">
+<div class="center"><img src="debug_8h__incl.png" border="0" usemap="#debug_8h" alt=""/></div>
+<map name="debug_8h" id="debug_8h">
+<area shape="rect" id="node3" href="config_8h.html" title="config.h" alt="" coords="615,80,683,107"/>
+<area shape="rect" id="node6" href="xran__fh__o__du_8h.html" title="This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN&#45;WG..." alt="" coords="655,155,766,181"/>
+</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="debug_8h__dep__incl.png" border="0" usemap="#debug_8hdep" alt=""/></div>
+<map name="debug_8hdep" id="debug_8hdep">
+<area shape="rect" id="node2" href="config_8c.html" title="config.c" alt="" coords="5,80,73,107"/>
+</map>
+</div>
+</div>
+<p><a href="debug_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:a835262f9c26026aab5f91a528f57ad8f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#a835262f9c26026aab5f91a528f57ad8f">MAX_FILE_NAME_LEN</a>&#160;&#160;&#160;(512)</td></tr>
+<tr class="separator:a835262f9c26026aab5f91a528f57ad8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:acae6916a00cd9660ab2ab69569e26d80"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#acae6916a00cd9660ab2ab69569e26d80">MAX_PATH_NAME_LEN</a>&#160;&#160;&#160;(1024)</td></tr>
+<tr class="separator:acae6916a00cd9660ab2ab69569e26d80"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a38df20643802da0ddcfe651c055892aa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#a38df20643802da0ddcfe651c055892aa">log_dbg</a>(fmt, ...)</td></tr>
+<tr class="separator:a38df20643802da0ddcfe651c055892aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a38df20643802da0ddcfe651c055892aa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#a38df20643802da0ddcfe651c055892aa">log_dbg</a>(fmt, ...)</td></tr>
+<tr class="separator:a38df20643802da0ddcfe651c055892aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1a973e10ccfdb6d28a538c8a9b022261"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#a1a973e10ccfdb6d28a538c8a9b022261">log_wrn</a>(fmt, ...)</td></tr>
+<tr class="separator:a1a973e10ccfdb6d28a538c8a9b022261"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad782f0c1a9fea27268fa70903f3cc4d7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#ad782f0c1a9fea27268fa70903f3cc4d7">log_err</a>(fmt, ...)</td></tr>
+<tr class="separator:ad782f0c1a9fea27268fa70903f3cc4d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:a42574ce0fd997ec42f57353f49235176"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#a42574ce0fd997ec42f57353f49235176">ShowData</a> (void *ptr, unsigned int size)</td></tr>
+<tr class="separator:a42574ce0fd997ec42f57353f49235176"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
+
+<p class="definition">Definition in file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
+</div><h2 class="groupheader">Macro Definition Documentation</h2>
+<a id="a38df20643802da0ddcfe651c055892aa"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a38df20643802da0ddcfe651c055892aa">&#9670;&nbsp;</a></span>log_dbg <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define log_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"><em>...</em>&#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="debug_8h_source.html#l00054">54</a> of file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
+
+</div>
+</div>
+<a id="a38df20643802da0ddcfe651c055892aa"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a38df20643802da0ddcfe651c055892aa">&#9670;&nbsp;</a></span>log_dbg <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define log_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"><em>...</em>&#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="debug_8h_source.html#l00054">54</a> of file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
+
+</div>
+</div>
+<a id="ad782f0c1a9fea27268fa70903f3cc4d7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad782f0c1a9fea27268fa70903f3cc4d7">&#9670;&nbsp;</a></span>log_err</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define log_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"><em>...</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<b>Value:</b><div class="fragment"><div class="line">fprintf(stderr,                     \</div><div class="line">        <span class="stringliteral">&quot;ERROR: %s(%d): &quot;</span> fmt <span class="stringliteral">&quot;\n&quot;</span>,             \</div><div class="line">        __FILE__,                       \</div><div class="line">        __LINE__, ##__VA_ARGS__)</div></div><!-- fragment -->
+<p class="definition">Definition at line <a class="el" href="debug_8h_source.html#l00059">59</a> of file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
+
+</div>
+</div>
+<a id="a1a973e10ccfdb6d28a538c8a9b022261"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1a973e10ccfdb6d28a538c8a9b022261">&#9670;&nbsp;</a></span>log_wrn</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define log_wrn</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"><em>...</em>&#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="debug_8h_source.html#l00055">55</a> of file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
+
+</div>
+</div>
+<a id="a835262f9c26026aab5f91a528f57ad8f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a835262f9c26026aab5f91a528f57ad8f">&#9670;&nbsp;</a></span>MAX_FILE_NAME_LEN</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define MAX_FILE_NAME_LEN&#160;&#160;&#160;(512)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="debug_8h_source.html#l00033">33</a> of file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
+
+</div>
+</div>
+<a id="acae6916a00cd9660ab2ab69569e26d80"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acae6916a00cd9660ab2ab69569e26d80">&#9670;&nbsp;</a></span>MAX_PATH_NAME_LEN</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define MAX_PATH_NAME_LEN&#160;&#160;&#160;(1024)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="debug_8h_source.html#l00034">34</a> of file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="a42574ce0fd997ec42f57353f49235176"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a42574ce0fd997ec42f57353f49235176">&#9670;&nbsp;</a></span>ShowData()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ShowData </td>
+          <td>(</td>
+          <td class="paramtype">void *&#160;</td>
+          <td class="paramname"><em>ptr</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">unsigned int&#160;</td>
+          <td class="paramname"><em>size</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="debug_8h_source.html#l00066">66</a> of file <a class="el" href="debug_8h_source.html">debug.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>