|
207
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
|
3 |
<title>CanFestival: /home/epimerde/documents/tc11/CanFestival-3/include/lifegrd.h File Reference</title>
|
|
|
4 |
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
|
5 |
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
|
6 |
</head><body>
|
|
|
7 |
<!-- Generated by Doxygen 1.5.1 -->
|
|
|
8 |
<div class="tabs">
|
|
|
9 |
<ul>
|
|
|
10 |
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
|
11 |
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
|
12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
|
13 |
<li id="current"><a href="files.html"><span>Files</span></a></li>
|
|
|
14 |
</ul></div>
|
|
|
15 |
<div class="tabs">
|
|
|
16 |
<ul>
|
|
|
17 |
<li><a href="files.html"><span>File List</span></a></li>
|
|
|
18 |
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
|
19 |
</ul></div>
|
|
|
20 |
<h1>/home/epimerde/documents/tc11/CanFestival-3/include/lifegrd.h File Reference</h1><code>#include <<a class="el" href="win32_2applicfg_8h-source.html">applicfg.h</a>></code><br>
|
|
|
21 |
<code>#include "<a class="el" href="data_8h-source.html">data.h</a>"</code><br>
|
|
|
22 |
|
|
|
23 |
<p>
|
|
|
24 |
<a href="lifegrd_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
|
25 |
<tr><td></td></tr>
|
|
|
26 |
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
|
|
|
27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="lifegrd_8h.html#eca3959d33fceb33487363a0493d3b7d">heartbeatError_t</a> (UNS8)</td></tr>
|
|
|
28 |
|
|
|
29 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
|
|
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lifegrd_8h.html#5249eb891f5677b80ccf01e604748524">_heartbeatError</a> (UNS8 heartbeatID)</td></tr>
|
|
|
31 |
|
|
|
32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="states_8h.html#5891f63a4c9243179838389a93d084e2">e_nodeState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lifegrd_8h.html#627254070e45c23f1776e12c524492ff">getNodeState</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS8 nodeId)</td></tr>
|
|
|
33 |
|
|
|
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lifegrd_8h.html#8896f6846e4d020390f6953f3d98aa21">heartbeatInit</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d)</td></tr>
|
|
|
35 |
|
|
|
36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lifegrd_8h.html#1b73047269c2a02065e12af18c6053c7">heartbeatStop</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d)</td></tr>
|
|
|
37 |
|
|
|
38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lifegrd_8h.html#b3248945e06e8b05518beddf665f174d">proceedNODE_GUARD</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, <a class="el" href="structMessage.html">Message</a> *m)</td></tr>
|
|
|
39 |
|
|
|
40 |
</table>
|
|
|
41 |
<hr><h2>Typedef Documentation</h2>
|
|
|
42 |
<a class="anchor" name="eca3959d33fceb33487363a0493d3b7d"></a><!-- doxytag: member="lifegrd.h::heartbeatError_t" ref="eca3959d33fceb33487363a0493d3b7d" args="(UNS8)" -->
|
|
|
43 |
<div class="memitem">
|
|
|
44 |
<div class="memproto">
|
|
|
45 |
<table class="memname">
|
|
|
46 |
<tr>
|
|
|
47 |
<td class="memname">typedef void(*) <a class="el" href="lifegrd_8h.html#eca3959d33fceb33487363a0493d3b7d">heartbeatError_t</a>(UNS8) </td>
|
|
|
48 |
</tr>
|
|
|
49 |
</table>
|
|
|
50 |
</div>
|
|
|
51 |
<div class="memdoc">
|
|
|
52 |
|
|
|
53 |
<p>
|
|
|
54 |
|
|
|
55 |
<p>
|
|
|
56 |
Definition at line <a class="el" href="lifegrd_8h-source.html#l00029">29</a> of file <a class="el" href="lifegrd_8h-source.html">lifegrd.h</a>.
|
|
|
57 |
</div>
|
|
|
58 |
</div><p>
|
|
|
59 |
<hr><h2>Function Documentation</h2>
|
|
|
60 |
<a class="anchor" name="5249eb891f5677b80ccf01e604748524"></a><!-- doxytag: member="lifegrd.h::_heartbeatError" ref="5249eb891f5677b80ccf01e604748524" args="(UNS8 heartbeatID)" -->
|
|
|
61 |
<div class="memitem">
|
|
|
62 |
<div class="memproto">
|
|
|
63 |
<table class="memname">
|
|
|
64 |
<tr>
|
|
|
65 |
<td class="memname">void _heartbeatError </td>
|
|
|
66 |
<td>(</td>
|
|
|
67 |
<td class="paramtype">UNS8 </td>
|
|
|
68 |
<td class="paramname"> <em>heartbeatID</em> </td>
|
|
|
69 |
<td> ) </td>
|
|
|
70 |
<td width="100%"></td>
|
|
|
71 |
</tr>
|
|
|
72 |
</table>
|
|
|
73 |
</div>
|
|
|
74 |
<div class="memdoc">
|
|
|
75 |
|
|
|
76 |
<p>
|
|
|
77 |
|
|
|
78 |
<p>
|
|
|
79 |
Definition at line <a class="el" href="lifegrd_8c-source.html#l00184">184</a> of file <a class="el" href="lifegrd_8c-source.html">lifegrd.c</a>.
|
|
|
80 |
</div>
|
|
|
81 |
</div><p>
|
|
|
82 |
<a class="anchor" name="627254070e45c23f1776e12c524492ff"></a><!-- doxytag: member="lifegrd.h::getNodeState" ref="627254070e45c23f1776e12c524492ff" args="(CO_Data *d, UNS8 nodeId)" -->
|
|
|
83 |
<div class="memitem">
|
|
|
84 |
<div class="memproto">
|
|
|
85 |
<table class="memname">
|
|
|
86 |
<tr>
|
|
|
87 |
<td class="memname"><a class="el" href="states_8h.html#5891f63a4c9243179838389a93d084e2">e_nodeState</a> getNodeState </td>
|
|
|
88 |
<td>(</td>
|
|
|
89 |
<td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
|
|
|
90 |
<td class="paramname"> <em>d</em>, </td>
|
|
|
91 |
</tr>
|
|
|
92 |
<tr>
|
|
|
93 |
<td class="paramkey"></td>
|
|
|
94 |
<td></td>
|
|
|
95 |
<td class="paramtype">UNS8 </td>
|
|
|
96 |
<td class="paramname"> <em>nodeId</em></td><td> </td>
|
|
|
97 |
</tr>
|
|
|
98 |
<tr>
|
|
|
99 |
<td></td>
|
|
|
100 |
<td>)</td>
|
|
|
101 |
<td></td><td></td><td width="100%"></td>
|
|
|
102 |
</tr>
|
|
|
103 |
</table>
|
|
|
104 |
</div>
|
|
|
105 |
<div class="memdoc">
|
|
|
106 |
|
|
|
107 |
<p>
|
|
|
108 |
To read the state of a node This can be used by the master after having sent a life guard request, of by any node if it is waiting for heartbeat.
|
|
|
109 |
<p>
|
|
|
110 |
Definition at line <a class="el" href="lifegrd_8c-source.html#l00033">33</a> of file <a class="el" href="lifegrd_8c-source.html">lifegrd.c</a>.
|
|
|
111 |
<p>
|
|
|
112 |
References <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, and <a class="el" href="data_8h-source.html#l00075">struct_CO_Data::NMTable</a>.
|
|
|
113 |
</div>
|
|
|
114 |
</div><p>
|
|
|
115 |
<a class="anchor" name="8896f6846e4d020390f6953f3d98aa21"></a><!-- doxytag: member="lifegrd.h::heartbeatInit" ref="8896f6846e4d020390f6953f3d98aa21" args="(CO_Data *d)" -->
|
|
|
116 |
<div class="memitem">
|
|
|
117 |
<div class="memproto">
|
|
|
118 |
<table class="memname">
|
|
|
119 |
<tr>
|
|
|
120 |
<td class="memname">void heartbeatInit </td>
|
|
|
121 |
<td>(</td>
|
|
|
122 |
<td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
|
|
|
123 |
<td class="paramname"> <em>d</em> </td>
|
|
|
124 |
<td> ) </td>
|
|
|
125 |
<td width="100%"></td>
|
|
|
126 |
</tr>
|
|
|
127 |
</table>
|
|
|
128 |
</div>
|
|
|
129 |
<div class="memdoc">
|
|
|
130 |
|
|
|
131 |
<p>
|
|
|
132 |
Start heartbeat consumer and producer with respect to 0x1016 and 0x1017 object dictionary entries
|
|
|
133 |
<p>
|
|
|
134 |
Definition at line <a class="el" href="lifegrd_8c-source.html#l00147">147</a> of file <a class="el" href="lifegrd_8c-source.html">lifegrd.c</a>.
|
|
|
135 |
<p>
|
|
|
136 |
References <a class="el" href="lifegrd_8c-source.html#l00041">ConsumerHearbeatAlarm()</a>, <a class="el" href="data_8h-source.html#l00069">struct_CO_Data::ConsumerHeartbeatCount</a>, <a class="el" href="data_8h-source.html#l00070">struct_CO_Data::ConsumerHeartbeatEntries</a>, <a class="el" href="data_8h-source.html#l00071">struct_CO_Data::ConsumerHeartBeatTimers</a>, <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00156">MS_TO_TIMEVAL</a>, <a class="el" href="lifegrd_8c-source.html#l00139">OnHeartbeatProducerUpdate()</a>, <a class="el" href="lifegrd_8c-source.html#l00113">ProducerHearbeatAlarm()</a>, <a class="el" href="data_8h-source.html#l00072">struct_CO_Data::ProducerHeartBeatTime</a>, <a class="el" href="data_8h-source.html#l00073">struct_CO_Data::ProducerHeartBeatTimer</a>, <a class="el" href="objacces_8c-source.html#l00297">RegisterSetODentryCallBack()</a>, <a class="el" href="timer_8c-source.html#l00038">SetAlarm()</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00150">TIMEVAL</a>, <a class="el" href="data_8h-source.html#l00089">struct_CO_Data::toggle</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00140">UNS16</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00141">UNS32</a>, and <a class="el" href="hcs12_2applicfg_8h-source.html#l00139">UNS8</a>.
|
|
|
137 |
</div>
|
|
|
138 |
</div><p>
|
|
|
139 |
<a class="anchor" name="1b73047269c2a02065e12af18c6053c7"></a><!-- doxytag: member="lifegrd.h::heartbeatStop" ref="1b73047269c2a02065e12af18c6053c7" args="(CO_Data *d)" -->
|
|
|
140 |
<div class="memitem">
|
|
|
141 |
<div class="memproto">
|
|
|
142 |
<table class="memname">
|
|
|
143 |
<tr>
|
|
|
144 |
<td class="memname">void heartbeatStop </td>
|
|
|
145 |
<td>(</td>
|
|
|
146 |
<td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
|
|
|
147 |
<td class="paramname"> <em>d</em> </td>
|
|
|
148 |
<td> ) </td>
|
|
|
149 |
<td width="100%"></td>
|
|
|
150 |
</tr>
|
|
|
151 |
</table>
|
|
|
152 |
</div>
|
|
|
153 |
<div class="memdoc">
|
|
|
154 |
|
|
|
155 |
<p>
|
|
|
156 |
Stop heartbeat consumer and producer
|
|
|
157 |
<p>
|
|
|
158 |
Definition at line <a class="el" href="lifegrd_8c-source.html#l00173">173</a> of file <a class="el" href="lifegrd_8c-source.html">lifegrd.c</a>.
|
|
|
159 |
<p>
|
|
|
160 |
References <a class="el" href="data_8h-source.html#l00069">struct_CO_Data::ConsumerHeartbeatCount</a>, <a class="el" href="data_8h-source.html#l00071">struct_CO_Data::ConsumerHeartBeatTimers</a>, <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, <a class="el" href="timer_8c-source.html#l00087">DelAlarm()</a>, <a class="el" href="data_8h-source.html#l00073">struct_CO_Data::ProducerHeartBeatTimer</a>, and <a class="el" href="hcs12_2applicfg_8h-source.html#l00139">UNS8</a>.
|
|
|
161 |
</div>
|
|
|
162 |
</div><p>
|
|
|
163 |
<a class="anchor" name="b3248945e06e8b05518beddf665f174d"></a><!-- doxytag: member="lifegrd.h::proceedNODE_GUARD" ref="b3248945e06e8b05518beddf665f174d" args="(CO_Data *d, Message *m)" -->
|
|
|
164 |
<div class="memitem">
|
|
|
165 |
<div class="memproto">
|
|
|
166 |
<table class="memname">
|
|
|
167 |
<tr>
|
|
|
168 |
<td class="memname">void proceedNODE_GUARD </td>
|
|
|
169 |
<td>(</td>
|
|
|
170 |
<td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> * </td>
|
|
|
171 |
<td class="paramname"> <em>d</em>, </td>
|
|
|
172 |
</tr>
|
|
|
173 |
<tr>
|
|
|
174 |
<td class="paramkey"></td>
|
|
|
175 |
<td></td>
|
|
|
176 |
<td class="paramtype"><a class="el" href="structMessage.html">Message</a> * </td>
|
|
|
177 |
<td class="paramname"> <em>m</em></td><td> </td>
|
|
|
178 |
</tr>
|
|
|
179 |
<tr>
|
|
|
180 |
<td></td>
|
|
|
181 |
<td>)</td>
|
|
|
182 |
<td></td><td></td><td width="100%"></td>
|
|
|
183 |
</tr>
|
|
|
184 |
</table>
|
|
|
185 |
</div>
|
|
|
186 |
<div class="memdoc">
|
|
|
187 |
|
|
|
188 |
<p>
|
|
|
189 |
This function is responsible to process a canopen-message which seams to be an NMT Error Control Messages. At them moment we assume that every NMT error control message is a heartbeat message. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
|
190 |
<table border="0" cellspacing="2" cellpadding="0">
|
|
|
191 |
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="structMessage.html">Message</a></em> </td><td>The CAN-message which has to be analysed. If a BootUp message is detected, it will return the nodeId of the Slave who booted up </td></tr>
|
|
|
192 |
</table>
|
|
|
193 |
</dl>
|
|
|
194 |
|
|
|
195 |
<p>
|
|
|
196 |
Definition at line <a class="el" href="lifegrd_8c-source.html#l00050">50</a> of file <a class="el" href="lifegrd_8c-source.html">lifegrd.c</a>.
|
|
|
197 |
<p>
|
|
|
198 |
References <a class="el" href="data_8h-source.html#l00047">struct_CO_Data::bDeviceNodeId</a>, <a class="el" href="data_8h-source.html#l00090">struct_CO_Data::canHandle</a>, <a class="el" href="canOpenDriver_8c-source.html#l00505">canSend()</a>, <a class="el" href="can_8h-source.html#l00042">Message::cob_id</a>, <a class="el" href="lifegrd_8c-source.html#l00041">ConsumerHearbeatAlarm()</a>, <a class="el" href="data_8h-source.html#l00069">struct_CO_Data::ConsumerHeartbeatCount</a>, <a class="el" href="data_8h-source.html#l00070">struct_CO_Data::ConsumerHeartbeatEntries</a>, <a class="el" href="data_8h-source.html#l00071">struct_CO_Data::ConsumerHeartBeatTimers</a>, <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, <a class="el" href="can_8h-source.html#l00046">Message::data</a>, <a class="el" href="timer_8c-source.html#l00087">DelAlarm()</a>, <a class="el" href="objdictdef_8h-source.html#l00132">GET_NODE_ID</a>, <a class="el" href="states_8h.html#3136d2815abe9d284f985e0a7ec68646eb3ae26d7a1629aa0fc6c83f46306cf5">Initialisation</a>, <a class="el" href="can_8h-source.html#l00045">Message::len</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00156">MS_TO_TIMEVAL</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00190">MSG_WAR</a>, <a class="el" href="data_8h-source.html#l00075">struct_CO_Data::NMTable</a>, <a class="el" href="data_8h-source.html#l00061">struct_CO_Data::nodeState</a>, <a class="el" href="can_8h-source.html#l00043">Message::rtr</a>, <a class="el" href="timer_8c-source.html#l00038">SetAlarm()</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00150">TIMEVAL</a>, <a class="el" href="data_8h-source.html#l00089">struct_CO_Data::toggle</a>, <a class="el" href="states_8h.html#3136d2815abe9d284f985e0a7ec68646cb4b5cb64be091d76f846380eb0afe59">Unknown_state</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00141">UNS32</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00139">UNS8</a>, and <a class="el" href="can_8h-source.html#l00036">SHORT_CAN::w</a>.
|
|
|
199 |
</div>
|
|
|
200 |
</div><p>
|
|
|
201 |
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 4 16:29:07 2007 for CanFestival by
|
|
|
202 |
<a href="http://www.doxygen.org/index.html">
|
|
|
203 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
|
|
|
204 |
</body>
|
|
|
205 |
</html>
|