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