mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
108 lines
8.5 KiB
HTML
108 lines
8.5 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>ChibiOS/RT: evtimer.h Source File</title>
|
|
<link href="custom.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<table style="text-align: center; width: 100%;" border="0"
|
|
cellpadding="2" cellspacing="2">
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
|
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
|
<td style="width: 80px;"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr size="1">
|
|
<!-- Generated by Doxygen 1.6.3 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>evtimer.h</h1><a href="evtimer_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"> ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"></span>
|
|
<a name="l00004"></a>00004 <span class="comment"> This file is part of ChibiOS/RT.</span>
|
|
<a name="l00005"></a>00005 <span class="comment"></span>
|
|
<a name="l00006"></a>00006 <span class="comment"> ChibiOS/RT is free software; you can redistribute it and/or modify</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 3 of the License, or</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
|
|
<a name="l00010"></a>00010 <span class="comment"></span>
|
|
<a name="l00011"></a>00011 <span class="comment"> ChibiOS/RT is distributed in the hope that it will be useful,</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
|
|
<a name="l00015"></a>00015 <span class="comment"></span>
|
|
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
|
|
<a name="l00018"></a>00018 <span class="comment"></span>
|
|
<a name="l00019"></a>00019 <span class="comment"> ---</span>
|
|
<a name="l00020"></a>00020 <span class="comment"></span>
|
|
<a name="l00021"></a>00021 <span class="comment"> A special exception to the GPL can be applied should you wish to distribute</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> a combined work that includes ChibiOS/RT, without being obliged to provide</span>
|
|
<a name="l00023"></a>00023 <span class="comment"> the source code for any proprietary components. See the file exception.txt</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> for full details of how and when the exception can be applied.</span>
|
|
<a name="l00025"></a>00025 <span class="comment">*/</span>
|
|
<a name="l00026"></a>00026 <span class="comment"></span>
|
|
<a name="l00027"></a>00027 <span class="comment">/**</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * @file evtimer.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Events Generator Timer structures and macros.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> * @addtogroup event_timer</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @{</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> */</span>
|
|
<a name="l00033"></a>00033
|
|
<a name="l00034"></a>00034 <span class="preprocessor">#ifndef _EVTIMER_H_</span>
|
|
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#define _EVTIMER_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00037"></a>00037 <span class="comment">/**</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> * @brief Event timer structure.</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> */</span>
|
|
<a name="l00040"></a><a class="code" href="struct_ev_timer.html">00040</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
<a name="l00041"></a>00041 <a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> et_vt;
|
|
<a name="l00042"></a>00042 <a class="code" href="struct_event_source.html" title="Event Source structure.">EventSource</a> et_es;
|
|
<a name="l00043"></a>00043 <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> et_interval;
|
|
<a name="l00044"></a>00044 } <a class="code" href="struct_ev_timer.html" title="Event timer structure.">EvTimer</a>;
|
|
<a name="l00045"></a>00045
|
|
<a name="l00046"></a>00046 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00048"></a>00048 <span class="preprocessor">#endif</span>
|
|
<a name="l00049"></a>00049 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__event__timer.html#gaa58fe826b42e0d64f32b6a40f54bb430" title="Starts the timer.">evtStart</a>(<a class="code" href="struct_ev_timer.html" title="Event timer structure.">EvTimer</a> *etp);
|
|
<a name="l00050"></a>00050 <span class="keywordtype">void</span> <a class="code" href="group__event__timer.html#ga667900146fd2bc35721e072ae5b0e433" title="Stops the timer.">evtStop</a>(<a class="code" href="struct_ev_timer.html" title="Event timer structure.">EvTimer</a> *etp);
|
|
<a name="l00051"></a>00051 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00052"></a>00052 <span class="preprocessor"></span>}
|
|
<a name="l00053"></a>00053 <span class="preprocessor">#endif</span>
|
|
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00055"></a>00055 <span class="comment">/**</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> * @brief Initializes an @p EvTimer structure.</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> *</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> * @param etp the EvTimer structure to be initialized</span>
|
|
<a name="l00059"></a>00059 <span class="comment"> * @param time the interval in system ticks</span>
|
|
<a name="l00060"></a>00060 <span class="comment"> */</span>
|
|
<a name="l00061"></a><a class="code" href="group__event__timer.html#ga610eb103e3c967651e3212dc8c3f126b">00061</a> <span class="preprocessor">#define evtInit(etp, time) { \</span>
|
|
<a name="l00062"></a>00062 <span class="preprocessor"> chEvtInit(&(etp)->et_es); \</span>
|
|
<a name="l00063"></a>00063 <span class="preprocessor"> (etp)->et_vt.vt_func = NULL; \</span>
|
|
<a name="l00064"></a>00064 <span class="preprocessor"> (etp)->et_interval = (time); \</span>
|
|
<a name="l00065"></a>00065 <span class="preprocessor">}</span>
|
|
<a name="l00066"></a>00066 <span class="preprocessor"></span>
|
|
<a name="l00067"></a>00067 <span class="preprocessor">#endif </span><span class="comment">/* _EVTIMER_H_ */</span>
|
|
<a name="l00068"></a>00068 <span class="comment"></span>
|
|
<a name="l00069"></a>00069 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Jul 11 13:13:01 2010 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.3</small></address>
|
|
</body>
|
|
</html>
|