Mercurial Mercurial > canfestival / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
doc/doxygen/html/lifegrd_8h.html
changeset 207 b6572d0336c3 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/doxygen/html/lifegrd_8h.html	Mon Jun 04 17:59:50 2007 +0200
@@ -0,0 +1,205 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>CanFestival: /home/epimerde/documents/tc11/CanFestival-3/include/lifegrd.h File Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.1 -->
+<div class="tabs">
+  <ul>
+    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
+    <li id="current"><a href="files.html"><span>Files</span></a></li>
+  </ul></div>
+<div class="tabs">
+  <ul>
+    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    <li><a href="globals.html"><span>Globals</span></a></li>
+  </ul></div>
+<h1>/home/epimerde/documents/tc11/CanFestival-3/include/lifegrd.h File Reference</h1><code>#include &lt;<a class="el" href="win32_2applicfg_8h-source.html">applicfg.h</a>&gt;</code><br>
+<code>#include &quot;<a class="el" href="data_8h-source.html">data.h</a>&quot;</code><br>
+
+<p>
+<a href="lifegrd_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*)&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lifegrd_8h.html#eca3959d33fceb33487363a0493d3b7d">heartbeatError_t</a> (UNS8)</td></tr>
+
+<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lifegrd_8h.html#5249eb891f5677b80ccf01e604748524">_heartbeatError</a> (UNS8 heartbeatID)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="states_8h.html#5891f63a4c9243179838389a93d084e2">e_nodeState</a>&nbsp;</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>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</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>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</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>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</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>
+
+</table>
+<hr><h2>Typedef Documentation</h2>
+<a class="anchor" name="eca3959d33fceb33487363a0493d3b7d"></a><!-- doxytag: member="lifegrd.h::heartbeatError_t" ref="eca3959d33fceb33487363a0493d3b7d" args="(UNS8)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">typedef void(*) <a class="el" href="lifegrd_8h.html#eca3959d33fceb33487363a0493d3b7d">heartbeatError_t</a>(UNS8)          </td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+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>.
+</div>
+</div><p>
+<hr><h2>Function Documentation</h2>
+<a class="anchor" name="5249eb891f5677b80ccf01e604748524"></a><!-- doxytag: member="lifegrd.h::_heartbeatError" ref="5249eb891f5677b80ccf01e604748524" args="(UNS8 heartbeatID)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void _heartbeatError           </td>
+          <td>(</td>
+          <td class="paramtype">UNS8&nbsp;</td>
+          <td class="paramname"> <em>heartbeatID</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+
+<p>
+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>.
+</div>
+</div><p>
+<a class="anchor" name="627254070e45c23f1776e12c524492ff"></a><!-- doxytag: member="lifegrd.h::getNodeState" ref="627254070e45c23f1776e12c524492ff" args="(CO_Data *d, UNS8 nodeId)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="states_8h.html#5891f63a4c9243179838389a93d084e2">e_nodeState</a> getNodeState           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
+          <td class="paramname"> <em>d</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">UNS8&nbsp;</td>
+          <td class="paramname"> <em>nodeId</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+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. 
+<p>
+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>.
+<p>
+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>.
+</div>
+</div><p>
+<a class="anchor" name="8896f6846e4d020390f6953f3d98aa21"></a><!-- doxytag: member="lifegrd.h::heartbeatInit" ref="8896f6846e4d020390f6953f3d98aa21" args="(CO_Data *d)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void heartbeatInit           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
+          <td class="paramname"> <em>d</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Start heartbeat consumer and producer with respect to 0x1016 and 0x1017 object dictionary entries 
+<p>
+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>.
+<p>
+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>.
+</div>
+</div><p>
+<a class="anchor" name="1b73047269c2a02065e12af18c6053c7"></a><!-- doxytag: member="lifegrd.h::heartbeatStop" ref="1b73047269c2a02065e12af18c6053c7" args="(CO_Data *d)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void heartbeatStop           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
+          <td class="paramname"> <em>d</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+Stop heartbeat consumer and producer 
+<p>
+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>.
+<p>
+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>.
+</div>
+</div><p>
+<a class="anchor" name="b3248945e06e8b05518beddf665f174d"></a><!-- doxytag: member="lifegrd.h::proceedNODE_GUARD" ref="b3248945e06e8b05518beddf665f174d" args="(CO_Data *d, Message *m)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void proceedNODE_GUARD           </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
+          <td class="paramname"> <em>d</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
+          <td class="paramname"> <em>m</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td width="100%"></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+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>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="structMessage.html">Message</a></em>&nbsp;</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>
+  </table>
+</dl>
+
+<p>
+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>.
+<p>
+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>.
+</div>
+</div><p>
+<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 4 16:29:07 2007 for CanFestival by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
+</body>
+</html>
canfestival