docs/API/xran__printf_8h.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: xran_printf.h File 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 id="nav-path" class="navpath">
  61   <ul>
  62 <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>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#define-members">Macros</a>  </div>
  68   <div class="headertitle">
  69 <div class="title">xran_printf.h File Reference</div>  </div>
  70 </div><!--header-->
  71 <div class="contents">
  72
  73 <p>Modules provide debug prints and utility functions.
  74 <a href="#details">More...</a></p>
  75 <div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
  76 <code>#include &lt;stdlib.h&gt;</code><br />
  77 </div><div class="textblock"><div class="dynheader">
  78 Include dependency graph for xran_printf.h:</div>
  79 <div class="dyncontent">
  80 <div class="center"><img src="xran__printf_8h__incl.png" border="0" usemap="#xran__printf_8h" alt=""/></div>
  81 <map name="xran__printf_8h" id="xran__printf_8h">
  82 </map>
  83 </div>
  84 </div><div class="textblock"><div class="dynheader">
  85 This graph shows which files directly or indirectly include this file:</div>
  86 <div class="dyncontent">
  87 <div class="center"><img src="xran__printf_8h__dep__incl.png" border="0" usemap="#xran__printf_8hdep" alt=""/></div>
  88 <map name="xran__printf_8hdep" id="xran__printf_8hdep">
  89 <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"/>
  90 <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"/>
  91 <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"/>
  92 <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"/>
  93 <area shape="rect" id="node6" href="xran__frame__struct_8c.html" title="xran_frame_struct.c" alt="" coords="496,80,635,107"/>
  94 <area shape="rect" id="node7" href="xran__main_8c.html" title="XRAN main functionality module. " alt="" coords="659,80,752,107"/>
  95 <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"/>
  96 <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"/>
  97 <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"/>
  98 <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"/>
  99 </map>
 100 </div>
 101 </div>
 102 <p><a href="xran__printf_8h_source.html">Go to the source code of this file.</a></p>
 103 <table class="memberdecls">
 104 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
 105 Macros</h2></td></tr>
 106 <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>
 107 <tr class="separator:abcb4ad51f1f16a398ff960ba4a0ed8c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <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>
 109 <tr class="separator:a467b83fc581fd7d20f8bf8c0af7240b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 110 <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>
 111 <tr class="separator:aa48f1da63506225983d78eeabd664382"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 <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>
 113 <tr class="separator:a677530742f5d55b5410c024f85794361"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 <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>
 115 <tr class="separator:a417ba2c3b49b216e358bc340346bf1cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 <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>
 117 <tr class="separator:a16c2c0a30b31515830a4a8eff6cf10b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 <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>
 119 <tr class="separator:a4ca9250337e620175e2b71a1dc69d1d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 <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>
 121 <tr class="separator:a8c47e30913273d0d0599afdc0b39890a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <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>
 123 <tr class="separator:a1474943d458f066f2f4be85a329d9028"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <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>
 125 <tr class="separator:a0b1e75be8d28458f05360139be8c2555"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <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>
 127 <tr class="separator:a6907fcd45c00443dc2e3258a628208ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 </table>
 129 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 130 <div class="textblock"><p>Modules provide debug prints and utility functions. </p>
 131 <dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
 132
 133 <p class="definition">Definition in file <a class="el" href="xran__printf_8h_source.html">xran_printf.h</a>.</p>
 134 </div><h2 class="groupheader">Macro Definition Documentation</h2>
 135 <a id="a0b1e75be8d28458f05360139be8c2555"></a>
 136 <h2 class="memtitle"><span class="permalink"><a href="#a0b1e75be8d28458f05360139be8c2555">&#9670;&nbsp;</a></span>_assert</h2>
 137
 138 <div class="memitem">
 139 <div class="memproto">
 140       <table class="memname">
 141         <tr>
 142           <td class="memname">#define _assert</td>
 143           <td>(</td>
 144           <td class="paramtype">&#160;</td>
 145           <td class="paramname">x</td><td>)</td>
 146           <td></td>
 147         </tr>
 148       </table>
 149 </div><div class="memdoc">
 150
 151 <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>
 152
 153 </div>
 154 </div>
 155 <a id="a8c47e30913273d0d0599afdc0b39890a"></a>
 156 <h2 class="memtitle"><span class="permalink"><a href="#a8c47e30913273d0d0599afdc0b39890a">&#9670;&nbsp;</a></span>_IASSERT_</h2>
 157
 158 <div class="memitem">
 159 <div class="memproto">
 160       <table class="memname">
 161         <tr>
 162           <td class="memname">#define _IASSERT_</td>
 163         </tr>
 164       </table>
 165 </div><div class="memdoc">
 166
 167 <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>
 168
 169 </div>
 170 </div>
 171 <a id="a6907fcd45c00443dc2e3258a628208ca"></a>
 172 <h2 class="memtitle"><span class="permalink"><a href="#a6907fcd45c00443dc2e3258a628208ca">&#9670;&nbsp;</a></span>CHECK_NOT_NULL</h2>
 173
 174 <div class="memitem">
 175 <div class="memproto">
 176       <table class="memname">
 177         <tr>
 178           <td class="memname">#define CHECK_NOT_NULL</td>
 179           <td>(</td>
 180           <td class="paramtype">&#160;</td>
 181           <td class="paramname">param, </td>
 182         </tr>
 183         <tr>
 184           <td class="paramkey"></td>
 185           <td></td>
 186           <td class="paramtype">&#160;</td>
 187           <td class="paramname">returnValue&#160;</td>
 188         </tr>
 189         <tr>
 190           <td></td>
 191           <td>)</td>
 192           <td></td><td></td>
 193         </tr>
 194       </table>
 195 </div><div class="memdoc">
 196
 197 <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>
 198
 199 </div>
 200 </div>
 201 <a id="a1474943d458f066f2f4be85a329d9028"></a>
 202 <h2 class="memtitle"><span class="permalink"><a href="#a1474943d458f066f2f4be85a329d9028">&#9670;&nbsp;</a></span>iAssert</h2>
 203
 204 <div class="memitem">
 205 <div class="memproto">
 206       <table class="memname">
 207         <tr>
 208           <td class="memname">#define iAssert</td>
 209           <td>(</td>
 210           <td class="paramtype">&#160;</td>
 211           <td class="paramname">p</td><td>)</td>
 212           <td></td>
 213         </tr>
 214       </table>
 215 </div><div class="memdoc">
 216
 217 <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>
 218
 219 </div>
 220 </div>
 221 <a id="a417ba2c3b49b216e358bc340346bf1cf"></a>
 222 <h2 class="memtitle"><span class="permalink"><a href="#a417ba2c3b49b216e358bc340346bf1cf">&#9670;&nbsp;</a></span>print_dbg</h2>
 223
 224 <div class="memitem">
 225 <div class="memproto">
 226       <table class="memname">
 227         <tr>
 228           <td class="memname">#define print_dbg</td>
 229           <td>(</td>
 230           <td class="paramtype">&#160;</td>
 231           <td class="paramname">fmt, </td>
 232         </tr>
 233         <tr>
 234           <td class="paramkey"></td>
 235           <td></td>
 236           <td class="paramtype">&#160;</td>
 237           <td class="paramname">args...&#160;</td>
 238         </tr>
 239         <tr>
 240           <td></td>
 241           <td>)</td>
 242           <td></td><td></td>
 243         </tr>
 244       </table>
 245 </div><div class="memdoc">
 246
 247 <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>
 248
 249 </div>
 250 </div>
 251 <a id="a16c2c0a30b31515830a4a8eff6cf10b5"></a>
 252 <h2 class="memtitle"><span class="permalink"><a href="#a16c2c0a30b31515830a4a8eff6cf10b5">&#9670;&nbsp;</a></span>print_err</h2>
 253
 254 <div class="memitem">
 255 <div class="memproto">
 256       <table class="memname">
 257         <tr>
 258           <td class="memname">#define print_err</td>
 259           <td>(</td>
 260           <td class="paramtype">&#160;</td>
 261           <td class="paramname">fmt, </td>
 262         </tr>
 263         <tr>
 264           <td class="paramkey"></td>
 265           <td></td>
 266           <td class="paramtype">&#160;</td>
 267           <td class="paramname">args...&#160;</td>
 268         </tr>
 269         <tr>
 270           <td></td>
 271           <td>)</td>
 272           <td></td><td>&#160;&#160;&#160;printf(&quot;%s:[err] &quot; fmt &quot;\n&quot;, __FUNCTION__, ## args)</td>
 273         </tr>
 274       </table>
 275 </div><div class="memdoc">
 276
 277 <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>
 278
 279 </div>
 280 </div>
 281 <a id="a4ca9250337e620175e2b71a1dc69d1d2"></a>
 282 <h2 class="memtitle"><span class="permalink"><a href="#a4ca9250337e620175e2b71a1dc69d1d2">&#9670;&nbsp;</a></span>print_inf</h2>
 283
 284 <div class="memitem">
 285 <div class="memproto">
 286       <table class="memname">
 287         <tr>
 288           <td class="memname">#define print_inf&#160;&#160;&#160;printf</td>
 289         </tr>
 290       </table>
 291 </div><div class="memdoc">
 292
 293 <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>
 294
 295 </div>
 296 </div>
 297 <a id="a677530742f5d55b5410c024f85794361"></a>
 298 <h2 class="memtitle"><span class="permalink"><a href="#a677530742f5d55b5410c024f85794361">&#9670;&nbsp;</a></span>print_log</h2>
 299
 300 <div class="memitem">
 301 <div class="memproto">
 302       <table class="memname">
 303         <tr>
 304           <td class="memname">#define print_log</td>
 305           <td>(</td>
 306           <td class="paramtype">&#160;</td>
 307           <td class="paramname">fmt, </td>
 308         </tr>
 309         <tr>
 310           <td class="paramkey"></td>
 311           <td></td>
 312           <td class="paramtype">&#160;</td>
 313           <td class="paramname">args...&#160;</td>
 314         </tr>
 315         <tr>
 316           <td></td>
 317           <td>)</td>
 318           <td></td><td>&#160;&#160;&#160;printf(&quot;%s:&quot; fmt &quot;\n&quot;, __FUNCTION__, ## args)</td>
 319         </tr>
 320       </table>
 321 </div><div class="memdoc">
 322
 323 <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>
 324
 325 </div>
 326 </div>
 327 <a id="aa48f1da63506225983d78eeabd664382"></a>
 328 <h2 class="memtitle"><span class="permalink"><a href="#aa48f1da63506225983d78eeabd664382">&#9670;&nbsp;</a></span>PRINTF_ERR_OK</h2>
 329
 330 <div class="memitem">
 331 <div class="memproto">
 332       <table class="memname">
 333         <tr>
 334           <td class="memname">#define PRINTF_ERR_OK</td>
 335         </tr>
 336       </table>
 337 </div><div class="memdoc">
 338
 339 <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>
 340
 341 </div>
 342 </div>
 343 <a id="a467b83fc581fd7d20f8bf8c0af7240b9"></a>
 344 <h2 class="memtitle"><span class="permalink"><a href="#a467b83fc581fd7d20f8bf8c0af7240b9">&#9670;&nbsp;</a></span>PRINTF_INF_OK</h2>
 345
 346 <div class="memitem">
 347 <div class="memproto">
 348       <table class="memname">
 349         <tr>
 350           <td class="memname">#define PRINTF_INF_OK</td>
 351         </tr>
 352       </table>
 353 </div><div class="memdoc">
 354
 355 <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>
 356
 357 </div>
 358 </div>
 359 <a id="abcb4ad51f1f16a398ff960ba4a0ed8c0"></a>
 360 <h2 class="memtitle"><span class="permalink"><a href="#abcb4ad51f1f16a398ff960ba4a0ed8c0">&#9670;&nbsp;</a></span>PRINTF_LOG_OK</h2>
 361
 362 <div class="memitem">
 363 <div class="memproto">
 364       <table class="memname">
 365         <tr>
 366           <td class="memname">#define PRINTF_LOG_OK</td>
 367         </tr>
 368       </table>
 369 </div><div class="memdoc">
 370
 371 <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>
 372
 373 </div>
 374 </div>
 375 </div><!-- contents -->
 376 <!-- start footer part -->
 377 <hr class="footer"/><address class="footer"><small>
 378 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 379 <img class="footer" src="doxygen.png" alt="doxygen"/>
 380 </a> 1.8.13
 381 </small></address>
 382 </body>
 383 </html>