add Doxygen documentation
[o-du/phy.git] / docs / API / debug_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: debug.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_4b76f00ffa3e05ab9c225ea6671f6b6c.html">app</a></li><li class="navelem"><a class="el" href="dir_dd7de4ccd45f8474612b8f6c09959d91.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> &#124;
68 <a href="#func-members">Functions</a>  </div>
69   <div class="headertitle">
70 <div class="title">debug.h File Reference</div>  </div>
71 </div><!--header-->
72 <div class="contents">
73 <div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
74 <code>#include &quot;<a class="el" href="config_8h_source.html">config.h</a>&quot;</code><br />
75 </div><div class="textblock"><div class="dynheader">
76 Include dependency graph for debug.h:</div>
77 <div class="dyncontent">
78 <div class="center"><img src="debug_8h__incl.png" border="0" usemap="#debug_8h" alt=""/></div>
79 <map name="debug_8h" id="debug_8h">
80 <area shape="rect" id="node3" href="config_8h.html" title="config.h" alt="" coords="615,80,683,107"/>
81 <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"/>
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="debug_8h__dep__incl.png" border="0" usemap="#debug_8hdep" alt=""/></div>
88 <map name="debug_8hdep" id="debug_8hdep">
89 <area shape="rect" id="node2" href="config_8c.html" title="config.c" alt="" coords="5,80,73,107"/>
90 </map>
91 </div>
92 </div>
93 <p><a href="debug_8h_source.html">Go to the source code of this file.</a></p>
94 <table class="memberdecls">
95 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
96 Macros</h2></td></tr>
97 <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>
98 <tr class="separator:a835262f9c26026aab5f91a528f57ad8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <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>
100 <tr class="separator:acae6916a00cd9660ab2ab69569e26d80"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <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>
102 <tr class="separator:a38df20643802da0ddcfe651c055892aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 <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>
104 <tr class="separator:a38df20643802da0ddcfe651c055892aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 <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>
106 <tr class="separator:a1a973e10ccfdb6d28a538c8a9b022261"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <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>
108 <tr class="separator:ad782f0c1a9fea27268fa70903f3cc4d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 </table><table class="memberdecls">
110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
111 Functions</h2></td></tr>
112 <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>
113 <tr class="separator:a42574ce0fd997ec42f57353f49235176"><td class="memSeparator" colspan="2">&#160;</td></tr>
114 </table>
115 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
116 <div class="textblock"><dl class="section author"><dt>Author</dt><dd>Intel Corporation </dd></dl>
117
118 <p class="definition">Definition in file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
119 </div><h2 class="groupheader">Macro Definition Documentation</h2>
120 <a id="a38df20643802da0ddcfe651c055892aa"></a>
121 <h2 class="memtitle"><span class="permalink"><a href="#a38df20643802da0ddcfe651c055892aa">&#9670;&nbsp;</a></span>log_dbg <span class="overload">[1/2]</span></h2>
122
123 <div class="memitem">
124 <div class="memproto">
125       <table class="memname">
126         <tr>
127           <td class="memname">#define log_dbg</td>
128           <td>(</td>
129           <td class="paramtype">&#160;</td>
130           <td class="paramname">fmt, </td>
131         </tr>
132         <tr>
133           <td class="paramkey"></td>
134           <td></td>
135           <td class="paramtype">&#160;</td>
136           <td class="paramname"><em>...</em>&#160;</td>
137         </tr>
138         <tr>
139           <td></td>
140           <td>)</td>
141           <td></td><td></td>
142         </tr>
143       </table>
144 </div><div class="memdoc">
145
146 <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>
147
148 </div>
149 </div>
150 <a id="a38df20643802da0ddcfe651c055892aa"></a>
151 <h2 class="memtitle"><span class="permalink"><a href="#a38df20643802da0ddcfe651c055892aa">&#9670;&nbsp;</a></span>log_dbg <span class="overload">[2/2]</span></h2>
152
153 <div class="memitem">
154 <div class="memproto">
155       <table class="memname">
156         <tr>
157           <td class="memname">#define log_dbg</td>
158           <td>(</td>
159           <td class="paramtype">&#160;</td>
160           <td class="paramname">fmt, </td>
161         </tr>
162         <tr>
163           <td class="paramkey"></td>
164           <td></td>
165           <td class="paramtype">&#160;</td>
166           <td class="paramname"><em>...</em>&#160;</td>
167         </tr>
168         <tr>
169           <td></td>
170           <td>)</td>
171           <td></td><td></td>
172         </tr>
173       </table>
174 </div><div class="memdoc">
175
176 <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>
177
178 </div>
179 </div>
180 <a id="ad782f0c1a9fea27268fa70903f3cc4d7"></a>
181 <h2 class="memtitle"><span class="permalink"><a href="#ad782f0c1a9fea27268fa70903f3cc4d7">&#9670;&nbsp;</a></span>log_err</h2>
182
183 <div class="memitem">
184 <div class="memproto">
185       <table class="memname">
186         <tr>
187           <td class="memname">#define log_err</td>
188           <td>(</td>
189           <td class="paramtype">&#160;</td>
190           <td class="paramname">fmt, </td>
191         </tr>
192         <tr>
193           <td class="paramkey"></td>
194           <td></td>
195           <td class="paramtype">&#160;</td>
196           <td class="paramname"><em>...</em>&#160;</td>
197         </tr>
198         <tr>
199           <td></td>
200           <td>)</td>
201           <td></td><td></td>
202         </tr>
203       </table>
204 </div><div class="memdoc">
205 <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 -->
206 <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>
207
208 </div>
209 </div>
210 <a id="a1a973e10ccfdb6d28a538c8a9b022261"></a>
211 <h2 class="memtitle"><span class="permalink"><a href="#a1a973e10ccfdb6d28a538c8a9b022261">&#9670;&nbsp;</a></span>log_wrn</h2>
212
213 <div class="memitem">
214 <div class="memproto">
215       <table class="memname">
216         <tr>
217           <td class="memname">#define log_wrn</td>
218           <td>(</td>
219           <td class="paramtype">&#160;</td>
220           <td class="paramname">fmt, </td>
221         </tr>
222         <tr>
223           <td class="paramkey"></td>
224           <td></td>
225           <td class="paramtype">&#160;</td>
226           <td class="paramname"><em>...</em>&#160;</td>
227         </tr>
228         <tr>
229           <td></td>
230           <td>)</td>
231           <td></td><td></td>
232         </tr>
233       </table>
234 </div><div class="memdoc">
235
236 <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>
237
238 </div>
239 </div>
240 <a id="a835262f9c26026aab5f91a528f57ad8f"></a>
241 <h2 class="memtitle"><span class="permalink"><a href="#a835262f9c26026aab5f91a528f57ad8f">&#9670;&nbsp;</a></span>MAX_FILE_NAME_LEN</h2>
242
243 <div class="memitem">
244 <div class="memproto">
245       <table class="memname">
246         <tr>
247           <td class="memname">#define MAX_FILE_NAME_LEN&#160;&#160;&#160;(512)</td>
248         </tr>
249       </table>
250 </div><div class="memdoc">
251
252 <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>
253
254 </div>
255 </div>
256 <a id="acae6916a00cd9660ab2ab69569e26d80"></a>
257 <h2 class="memtitle"><span class="permalink"><a href="#acae6916a00cd9660ab2ab69569e26d80">&#9670;&nbsp;</a></span>MAX_PATH_NAME_LEN</h2>
258
259 <div class="memitem">
260 <div class="memproto">
261       <table class="memname">
262         <tr>
263           <td class="memname">#define MAX_PATH_NAME_LEN&#160;&#160;&#160;(1024)</td>
264         </tr>
265       </table>
266 </div><div class="memdoc">
267
268 <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>
269
270 </div>
271 </div>
272 <h2 class="groupheader">Function Documentation</h2>
273 <a id="a42574ce0fd997ec42f57353f49235176"></a>
274 <h2 class="memtitle"><span class="permalink"><a href="#a42574ce0fd997ec42f57353f49235176">&#9670;&nbsp;</a></span>ShowData()</h2>
275
276 <div class="memitem">
277 <div class="memproto">
278 <table class="mlabels">
279   <tr>
280   <td class="mlabels-left">
281       <table class="memname">
282         <tr>
283           <td class="memname">void ShowData </td>
284           <td>(</td>
285           <td class="paramtype">void *&#160;</td>
286           <td class="paramname"><em>ptr</em>, </td>
287         </tr>
288         <tr>
289           <td class="paramkey"></td>
290           <td></td>
291           <td class="paramtype">unsigned int&#160;</td>
292           <td class="paramname"><em>size</em>&#160;</td>
293         </tr>
294         <tr>
295           <td></td>
296           <td>)</td>
297           <td></td><td></td>
298         </tr>
299       </table>
300   </td>
301   <td class="mlabels-right">
302 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
303   </tr>
304 </table>
305 </div><div class="memdoc">
306
307 <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>
308
309 </div>
310 </div>
311 </div><!-- contents -->
312 <!-- start footer part -->
313 <hr class="footer"/><address class="footer"><small>
314 Generated by &#160;<a href="http://www.doxygen.org/index.html">
315 <img class="footer" src="doxygen.png" alt="doxygen"/>
316 </a> 1.8.13
317 </small></address>
318 </body>
319 </html>