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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<!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: Ucs_Network_StatusCb_t</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___n_e_t.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="contents">
<a class="anchor" id="gaf195e8ae396bc1fc358666fe50bf3f51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* Ucs_Network_StatusCb_t)(uint16_t change_mask, uint16_t events, <a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga6b0bec2ae9e4d0fb93eefd65752f0c74.html#ga6b0bec2ae9e4d0fb93eefd65752f0c74">Ucs_Network_Availability_t</a> availability, <a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gad5ed0387c3c156602826d50ce94c9df7.html#gad5ed0387c3c156602826d50ce94c9df7">Ucs_Network_AvailInfo_t</a> avail_info, <a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_gab4ec40bf01de998abc4f2ae34c26ac46.html#gab4ec40bf01de998abc4f2ae34c26ac46">Ucs_Network_AvailTransCause_t</a> avail_trans_cause, uint16_t node_address, uint8_t node_position, uint8_t max_position, uint16_t packet_bw, void *user_ptr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function signature used for the Network Status callback function. </p>
<table class="mns_ic_table">
<tr>
<td id="mns_ic_inic"> </td><td>The arguments of the result callback function correspond with the INIC's result for the function <a href="_p__u_m__o_s81118.html#MNSH3-MOSTNetworkStatus520">INIC.MOSTNetworkStatus</a>.</td></tr>
</table>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">change_mask</td><td>Indicates which parameters have been changed since the last function call. If a bit is set the corresponding parameter has been changed since the last update. <table class="doxtable">
<tr>
<th align="center">Bit Index </th><th align="center">Value (Hex) </th><th>Parameter</th></tr>
<tr>
<td align="center">0 </td><td align="center">0x01 </td><td>events </td></tr>
<tr>
<td align="center">1 </td><td align="center">0x02 </td><td>availability </td></tr>
<tr>
<td align="center">2 </td><td align="center">0x04 </td><td>avail_info </td></tr>
<tr>
<td align="center">3 </td><td align="center">0x08 </td><td>avail_trans_cause </td></tr>
<tr>
<td align="center">4 </td><td align="center">0x10 </td><td>node_address </td></tr>
<tr>
<td align="center">5 </td><td align="center">0x20 </td><td>node_position </td></tr>
<tr>
<td align="center">6 </td><td align="center">0x40 </td><td>max_position </td></tr>
<tr>
<td align="center">7 </td><td align="center">0x80 </td><td>packet_bw </td></tr>
</table>
</td></tr>
<tr><td class="paramname">events</td><td>The occurred network events. Events are only indicated once they occurred. I.e., the value is not handled as a continuous state. You can use the bitmask <a class="el" href="group___g___u_c_s___n_e_t___t_y_p_e_s_ga5f170c3358fc47999f969ee868d113ef.html#ga5f170c3358fc47999f969ee868d113ef">UCS_NETWORK_EVENT_NCE</a> to identify received events. <table class="mns_param_table">
<tr>
<td id="mns_param_small"> </td><td><code>Events</code></td></tr>
</table>
</td></tr>
<tr><td class="paramname">availability</td><td>The network availability.<table class="mns_param_table">
<tr>
<td id="mns_param_small"> </td><td><code>Availability</code></td></tr>
</table>
</td></tr>
<tr><td class="paramname">avail_info</td><td>The availability information.<table class="mns_param_table">
<tr>
<td id="mns_param_small"> </td><td><code>AvailabilityInfo</code></td></tr>
</table>
</td></tr>
<tr><td class="paramname">avail_trans_cause</td><td>The availability transition cause.<table class="mns_param_table">
<tr>
<td id="mns_param_small"> </td><td><code>AvailabilityTransitionCause</code></td></tr>
</table>
</td></tr>
<tr><td class="paramname">node_address</td><td>The current node address.<table class="mns_param_table">
<tr>
<td id="mns_param_small"> </td><td><code>NodeAddress</code></td></tr>
</table>
</td></tr>
<tr><td class="paramname">node_position</td><td>The current node position.<table class="mns_param_table">
<tr>
<td id="mns_param_small"> </td><td><code>NodePosition</code></td></tr>
</table>
</td></tr>
<tr><td class="paramname">max_position</td><td>The number of available nodes.<table class="mns_param_table">
<tr>
<td id="mns_param_small"> </td><td><code>MaxPosition</code></td></tr>
</table>
</td></tr>
<tr><td class="paramname">packet_bw</td><td>The packet bandwidth.<table class="mns_param_table">
<tr>
<td id="mns_param_small"> </td><td><code>PacketBW</code></td></tr>
</table>
</td></tr>
<tr><td class="paramname">user_ptr</td><td>User reference provided in <a class="el" href="struct_ucs___init_data__t.html">Ucs_InitData_t::user_ptr</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="group___g___u_c_s___n_e_t.html">Network</a></li>
<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:52:59 for UNICENS by
Doxygen 1.8.2
-->
<script language="javascript">
<!--
$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
-->
</script>
</html>
|
