Mercurial Mercurial > canfestival / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
doc/doxygen/html/timer_8h-source.html
author etisserant
Thu, 11 Oct 2007 09:09:07 +0200
changeset 307 230d55cb75a4
parent 240 34654679f262
permissions -rw-r--r--
Updated .od files to keep compatible with $NODEID+... way to express OD entry values, as in EDS. 
<!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: include/timer.h Source File</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="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li id="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</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>
<div class="nav">
<a class="el" href="dir_bb27f6e70a4a8ab6966321815f15a33d.html">include</a></div>
<h1>timer.h</h1><a href="timer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">This file is part of CanFestival, a library implementing CanOpen Stack. </span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">Copyright (C): Edouard TISSERANT and Francis DUPIN</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">See COPYING file for copyrights details.</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">This library is free software; you can redistribute it and/or</span>
<a name="l00009"></a>00009 <span class="comment">modify it under the terms of the GNU Lesser General Public</span>
<a name="l00010"></a>00010 <span class="comment">License as published by the Free Software Foundation; either</span>
<a name="l00011"></a>00011 <span class="comment">version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment">This library is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00016"></a>00016 <span class="comment">Lesser General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">You should have received a copy of the GNU Lesser General Public</span>
<a name="l00019"></a>00019 <span class="comment">License along with this library; if not, write to the Free Software</span>
<a name="l00020"></a>00020 <span class="comment">Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00021"></a>00021 <span class="comment">*/</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef __timer_h__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define __timer_h__</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="win32_2timerscfg_8h.html">timerscfg.h</a>&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;<a class="code" href="win32_2applicfg_8h.html">applicfg.h</a>&gt;</span>
<a name="l00028"></a>00028 
<a name="l00029"></a><a class="code" href="timer_8h.html#92d252e2b6f4cf50c0e7450c20d5db48">00029</a> <span class="preprocessor">#define TIMER_HANDLE INTEGER16</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="data_8h.html">data.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="comment">/* --------- types and constants definitions --------- */</span>
<a name="l00034"></a>00034 <span class="preprocessor">#define TIMER_FREE 0</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#define TIMER_ARMED 1</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define TIMER_TRIG 2</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define TIMER_TRIG_PERIOD 3</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a>00039 <span class="preprocessor">#define TIMER_NONE -1</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a><a class="code" href="timer_8h.html#c8436e7543fa1329b00e570246071313">00041</a> <span class="keyword">typedef</span> void (*<a class="code" href="timer_8h.html#c8436e7543fa1329b00e570246071313">TimerCallback_t</a>)(<a class="code" href="structstruct__CO__Data.html">CO_Data</a>* d, <a class="code" href="hcs12_2applicfg_8h.html#a6a1b7af83d4106c1d1621bdb28d9c48">UNS32</a> id);
<a name="l00042"></a>00042 
<a name="l00043"></a><a class="code" href="structstruct__s__timer__entry.html">00043</a> <span class="keyword">struct </span><a class="code" href="structstruct__s__timer__entry.html">struct_s_timer_entry</a> {
<a name="l00044"></a><a class="code" href="structstruct__s__timer__entry.html#48f463cd0804517aeb60b27979143c56">00044</a>         <a class="code" href="hcs12_2applicfg_8h.html#c2e754635928189b98cf3f5b7e6dbffb">UNS8</a> <a class="code" href="structstruct__s__timer__entry.html#48f463cd0804517aeb60b27979143c56">state</a>;
<a name="l00045"></a><a class="code" href="structstruct__s__timer__entry.html#1f47508e63fb89e692b98e178a78268f">00045</a>         <a class="code" href="structstruct__CO__Data.html">CO_Data</a>* <a class="code" href="structstruct__s__timer__entry.html#1f47508e63fb89e692b98e178a78268f">d</a>;
<a name="l00046"></a><a class="code" href="structstruct__s__timer__entry.html#692e4f379d9b3976895df243e12ccacb">00046</a>         <a class="code" href="timer_8h.html#c8436e7543fa1329b00e570246071313">TimerCallback_t</a> <a class="code" href="structstruct__s__timer__entry.html#692e4f379d9b3976895df243e12ccacb">callback</a>; <span class="comment">/* The callback func. */</span>
<a name="l00047"></a><a class="code" href="structstruct__s__timer__entry.html#abba0eed61eee45a3b4bef93edaaf77f">00047</a>         <a class="code" href="hcs12_2applicfg_8h.html#a6a1b7af83d4106c1d1621bdb28d9c48">UNS32</a> <a class="code" href="structstruct__s__timer__entry.html#abba0eed61eee45a3b4bef93edaaf77f">id</a>; <span class="comment">/* The callback func. */</span>
<a name="l00048"></a><a class="code" href="structstruct__s__timer__entry.html#c85c662fac7a4d11ca7e993b180d53f3">00048</a>         <a class="code" href="hcs12_2applicfg_8h.html#dea5fb459bddd6fd539cdf665dd657e6">TIMEVAL</a> <a class="code" href="structstruct__s__timer__entry.html#c85c662fac7a4d11ca7e993b180d53f3">val</a>;
<a name="l00049"></a><a class="code" href="structstruct__s__timer__entry.html#fca0c6aa0fbf43db4e074f38cc6e5bf0">00049</a>         <a class="code" href="hcs12_2applicfg_8h.html#dea5fb459bddd6fd539cdf665dd657e6">TIMEVAL</a> <a class="code" href="structstruct__s__timer__entry.html#fca0c6aa0fbf43db4e074f38cc6e5bf0">interval</a>; <span class="comment">/* Periodicity */</span>
<a name="l00050"></a>00050 };
<a name="l00051"></a>00051 
<a name="l00052"></a><a class="code" href="timer_8h.html#9d8fd79aa2a97ffdf912d3de8fa75be8">00052</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structstruct__s__timer__entry.html">struct_s_timer_entry</a> <a class="code" href="timer_8h.html#9d8fd79aa2a97ffdf912d3de8fa75be8">s_timer_entry</a>;
<a name="l00053"></a>00053 
<a name="l00054"></a>00054 <span class="comment">/* ---------  prototypes --------- */</span>
<a name="l00055"></a>00055 <span class="comment">/*#define SetAlarm(d, id, callback, value, period) printf("%s, %d, SetAlarm(%s, %s, %s, %s, %s)\n",__FILE__, __LINE__, #d, #id, #callback, #value, #period); _SetAlarm(d, id, callback, value, period)*/</span>
<a name="l00056"></a>00056 <a class="code" href="timer_8h.html#92d252e2b6f4cf50c0e7450c20d5db48">TIMER_HANDLE</a> <a class="code" href="timer_8c.html#956b22f24089db4c367f40199f838a20">SetAlarm</a>(<a class="code" href="structstruct__CO__Data.html">CO_Data</a>* <a class="code" href="structstruct__s__timer__entry.html#1f47508e63fb89e692b98e178a78268f">d</a>, <a class="code" href="hcs12_2applicfg_8h.html#a6a1b7af83d4106c1d1621bdb28d9c48">UNS32</a> <span class="keywordtype">id</span>, <a class="code" href="timer_8h.html#c8436e7543fa1329b00e570246071313">TimerCallback_t</a> <a class="code" href="structstruct__s__timer__entry.html#692e4f379d9b3976895df243e12ccacb">callback</a>, <a class="code" href="hcs12_2applicfg_8h.html#dea5fb459bddd6fd539cdf665dd657e6">TIMEVAL</a> value, <a class="code" href="hcs12_2applicfg_8h.html#dea5fb459bddd6fd539cdf665dd657e6">TIMEVAL</a> period);
<a name="l00057"></a>00057 <a class="code" href="timer_8h.html#92d252e2b6f4cf50c0e7450c20d5db48">TIMER_HANDLE</a> <a class="code" href="timer_8c.html#12fe6467e1df03cc40dd6f76123c99f6">DelAlarm</a>(<a class="code" href="timer_8h.html#92d252e2b6f4cf50c0e7450c20d5db48">TIMER_HANDLE</a> handle);
<a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="timer_8c.html#7a5a515821c2e4fb2f66bac72389da00">TimeDispatch</a>(<span class="keywordtype">void</span>);
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="comment">/* ---------  to be defined in user app ---------*/</span>
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="timers__unix_8c.html#7996006c628d2df030b9684d7a86acd1">setTimer</a>(<a class="code" href="hcs12_2applicfg_8h.html#dea5fb459bddd6fd539cdf665dd657e6">TIMEVAL</a> value);
<a name="l00062"></a>00062 <a class="code" href="hcs12_2applicfg_8h.html#dea5fb459bddd6fd539cdf665dd657e6">TIMEVAL</a> <a class="code" href="canOpenDriver_8c.html#38b23a8ee3748bca3415967b90df1e15">getElapsedTime</a>(<span class="keywordtype">void</span>);
<a name="l00063"></a>00063 
<a name="l00064"></a>00064 <span class="preprocessor">#endif </span><span class="comment">/* #define __timer_h__ */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jul 2 19:10:16 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