ucs2-lib/doc/html/group___g___u_c_s___t_r_a_c_e.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 <title>UNICENS: Tracing/Debugging</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <link rel="shortcut icon" type="image/x-icon" href="favicon.ico">
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtree.js"></script>
  14 <script type="text/javascript">
  15   $(document).ready(initResizable);
  16 </script>
  17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/search.js"></script>
  19 <script type="text/javascript">
  20   $(document).ready(function() { searchBox.OnSelectItem(0); });
  21 </script>
  22 <link href="style_html.css" rel="stylesheet" type="text/css" />
  23 <link href="inic.css" rel="stylesheet" type="text/css"/>
  24 </head>
  25 <body>
  26 <div class="GlobalWrapper">
  27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28 <div id="titlearea">
  29 <table cellspacing="0" cellpadding="0">
  30  <tbody>
  31  <tr>
  32   <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td>
  33   <td>
  34    <div id="projectname">UNICENS&#160;<span id="projectnumber">V2.1.0-3491</span></div>
  35    <div id="projectbrief">User Manual and API Reference</div>
  36     <div id="searchbox">        <div id="MSearchBox" class="MSearchBoxInactive">
  37         <span class="left">
  38           <img id="MSearchSelect" src="search/mag_sel.png"
  39                onmouseover="return searchBox.OnSearchSelectShow()"
  40                onmouseout="return searchBox.OnSearchSelectHide()"
  41                alt=""/>
  42           <input type="text" id="MSearchField" value="Search" accesskey="S"
  43                onfocus="searchBox.OnSearchFieldFocus(true)"
  44                onblur="searchBox.OnSearchFieldFocus(false)"
  45                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  46           </span><span class="right">
  47             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  48           </span>
  49         </div>
  50 </div>
  51   </td>
  52  </tr>
  53  </tbody>
  54 </table>
  55 </div>
  56 <!-- end header part -->
  57 <!-- Generated by Doxygen 1.8.2 -->
  58 <script type="text/javascript">
  59 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  60 </script>
  61 </div><!-- top -->
  62 <div id="side-nav" class="ui-resizable side-nav-resizable">
  63   <div id="nav-tree">
  64     <div id="nav-tree-contents">
  65       <div id="nav-sync" class="sync"></div>
  66     </div>
  67   </div>
  68   <div id="splitbar" style="-moz-user-select:none;"
  69        class="ui-resizable-handle">
  70   </div>
  71 </div>
  72 <script type="text/javascript">
  73 $(document).ready(function(){initNavTree('group___g___u_c_s___t_r_a_c_e.html','');});
  74 </script>
  75 <div id="doc-content">
  76 <!-- window showing the filter options -->
  77 <div id="MSearchSelectWindow"
  78      onmouseover="return searchBox.OnSearchSelectShow()"
  79      onmouseout="return searchBox.OnSearchSelectHide()"
  80      onkeydown="return searchBox.OnSearchSelectKey(event)">
  81 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  82
  83 <!-- iframe showing the search results (closed by default) -->
  84 <div id="MSearchResultsWindow">
  85 <iframe src="javascript:void(0)" frameborder="0"
  86         name="MSearchResults" id="MSearchResults">
  87 </iframe>
  88 </div>
  89
  90 <div class="header">
  91   <div class="summary">
  92 <a href="#groups">Topics</a> &#124;
  93 <a href="#define-members">Macros</a> &#124;
  94 <a href="#typedef-members">Callback Functions</a>  </div>
  95   <div class="headertitle">
  96 <div class="title">Tracing/Debugging</div>  </div>
  97 <div class="ingroups"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html">Initialization and Service</a></div></div><!--header-->
  98 <div class="contents">
  99
 100 <p>Tracing/Debugging Interface.
 101 <a href="#details">More...</a></p>
 102 <table class="memberdecls">
 103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
 104 Topics</h2></td></tr>
 105 <tr class="memitem:group___g___u_c_s___t_r_a_c_e___t_y_p_e_s"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___t_r_a_c_e___t_y_p_e_s.html">Tracing/Debugging Types</a></td></tr>
 106 <tr class="memdesc:group___g___u_c_s___t_r_a_c_e___t_y_p_e_s"><td class="mdescLeft">&#160;</td><td class="mdescRight">Referred types used by Tracing/Debugging Interface. <br/></td></tr>
 107 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 </table><table class="memberdecls">
 109 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
 110 Macros</h2></td></tr>
 111 <tr class="memitem:gaebb5aec06a7196b1247805a53a96f926"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___t_r_a_c_e_gaebb5aec06a7196b1247805a53a96f926.html#gaebb5aec06a7196b1247805a53a96f926">UCS_TR_INFO</a></td></tr>
 112 <tr class="memdesc:gaebb5aec06a7196b1247805a53a96f926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trace macro to capture trace info events.  <a href="#gaebb5aec06a7196b1247805a53a96f926"></a><br/></td></tr>
 113 <tr class="separator:gaebb5aec06a7196b1247805a53a96f926"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 <tr class="memitem:gaf7f45aee7bbbd7f4a58b71a5268ecdb6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___t_r_a_c_e_gaf7f45aee7bbbd7f4a58b71a5268ecdb6.html#gaf7f45aee7bbbd7f4a58b71a5268ecdb6">UCS_TR_ERROR</a></td></tr>
 115 <tr class="memdesc:gaf7f45aee7bbbd7f4a58b71a5268ecdb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trace macro to capture trace error events.  <a href="#gaf7f45aee7bbbd7f4a58b71a5268ecdb6"></a><br/></td></tr>
 116 <tr class="separator:gaf7f45aee7bbbd7f4a58b71a5268ecdb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 117 <tr class="memitem:ga038add4a7ca8adb0f60c34cedbfcf8b9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___t_r_a_c_e_ga038add4a7ca8adb0f60c34cedbfcf8b9.html#ga038add4a7ca8adb0f60c34cedbfcf8b9">UCS_TR_SIZE_BUFFER</a>&#160;&#160;&#160;256</td></tr>
 118 <tr class="memdesc:ga038add4a7ca8adb0f60c34cedbfcf8b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the needed buffer size to decode a trace entry.  <a href="#ga038add4a7ca8adb0f60c34cedbfcf8b9"></a><br/></td></tr>
 119 <tr class="separator:ga038add4a7ca8adb0f60c34cedbfcf8b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 </table><table class="memberdecls">
 121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 122 Callback Functions</h2></td></tr>
 123 <tr class="memitem:gaf18b6867951fd06359788f6595b78195"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___t_r_a_c_e_gaf18b6867951fd06359788f6595b78195.html#gaf18b6867951fd06359788f6595b78195">Ucs_DebugErrorMsgCb_t</a> )(<a class="el" href="struct_msg___most_tel__t.html">Msg_MostTel_t</a> *msg_ptr, void *user_ptr)</td></tr>
 124 <tr class="memdesc:gaf18b6867951fd06359788f6595b78195"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional callback function used to debug received raw messages with OpType UCS_OP_ERROR and UCS_OP_ERRORACK.  <a href="#gaf18b6867951fd06359788f6595b78195"></a><br/></td></tr>
 125 <tr class="separator:gaf18b6867951fd06359788f6595b78195"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 </table>
 127 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 128 <p>Tracing/Debugging Interface. </p>
 129 <p>The UCS Trace Interface is intended for debugging and logging purpose. There are 2 different trace options:</p>
 130 <ul>
 131 <li>The definition of trace macros to print out internal states, messages and errors. This option provides two trace classes: <code>info</code> and <code>error</code>. Each trace class can be activated by defining the respective macro UCS_TR_INFO UCS_TR_ERROR in the configuration header file <code>ucs_cfg.h</code>. While the <code>info</code> class is intended only for debugging purpose during development, the <code>error</code> class can also be active for logging purpose in a production system.</li>
 132 <li>Implementation of the callback function Ucs_DebugErrorMsgCb_t which is assigned during initialization. The callback function is fired on every received Error message from a local or remote INIC. </li>
 133 </ul>
 134 </div><!-- contents -->
 135 </div><!-- doc-content -->
 136 <!-- start footer part -->
 137 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 138   <ul>
 139     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
 140   </ul>
 141 </div>
 142 </body>
 143 <!--
 144 Generated on Mon Apr 3 2017 13:53:00 for UNICENS by
 145 Doxygen 1.8.2
 146 -->
 147 <script language="javascript">
 148 <!--
 149 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
 150 -->
 151 </script>
 152 </html>