mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
168 lines
19 KiB
HTML
168 lines
19 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: chvt.c 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>chvt.c</h1><a href="chvt_8c.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 chvt.c</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Time and Virtual Timers related code.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup time</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * @details Time and Virtual Timers related APIs and services.</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> * @{</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> */</span>
|
|
<a name="l00035"></a>00035
|
|
<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>"</span>
|
|
<a name="l00037"></a>00037 <span class="comment"></span>
|
|
<a name="l00038"></a>00038 <span class="comment">/**</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * @brief Virtual timers delta list header.</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> */</span>
|
|
<a name="l00041"></a><a class="code" href="group__time.html#gaf86fafcf8f7ea15d07e55f45dd80e3ac">00041</a> <a class="code" href="struct_v_t_list.html" title="Virtual timers list header.">VTList</a> <a class="code" href="group__time.html#gaf86fafcf8f7ea15d07e55f45dd80e3ac" title="Virtual timers delta list header.">vtlist</a>;
|
|
<a name="l00042"></a>00042 <span class="comment"></span>
|
|
<a name="l00043"></a>00043 <span class="comment">/**</span>
|
|
<a name="l00044"></a>00044 <span class="comment"> * @brief Virtual Timers initialization.</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> * @note Internal use only.</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> */</span>
|
|
<a name="l00047"></a><a class="code" href="group__time.html#ga3f64863d042de0de89233bfeabe39b62">00047</a> <span class="keywordtype">void</span> <a class="code" href="group__time.html#ga3f64863d042de0de89233bfeabe39b62" title="Virtual Timers initialization.">vt_init</a>(<span class="keywordtype">void</span>) {
|
|
<a name="l00048"></a>00048
|
|
<a name="l00049"></a>00049 vtlist.<a class="code" href="struct_v_t_list.html#a18ed6321ebb9d1d4977bc3b1a8d6531d" title="Next timer in the delta list.">vt_next</a> = vtlist.<a class="code" href="struct_v_t_list.html#a0e89630d5a1b82bb6bfbca1465cfa1f7" title="Last timer in the delta list.">vt_prev</a> = (<span class="keywordtype">void</span> *)&vtlist;
|
|
<a name="l00050"></a>00050 vtlist.<a class="code" href="struct_v_t_list.html#a565bf88a53b8ee8a5cd20f42d94b05c6" title="Must be initialized to -1.">vt_time</a> = (<a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a>)-1;
|
|
<a name="l00051"></a>00051 vtlist.<a class="code" href="struct_v_t_list.html#ac2964dcbab06e6498301aaf51d508d77" title="System Time counter.">vt_systime</a> = 0;
|
|
<a name="l00052"></a>00052 }
|
|
<a name="l00053"></a>00053 <span class="comment"></span>
|
|
<a name="l00054"></a>00054 <span class="comment">/**</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> * @brief Enables a virtual timer.</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> * @note The associated function is invoked by an interrupt handler within</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> * the I-Locked state, see @ref system_states.</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> *</span>
|
|
<a name="l00059"></a>00059 <span class="comment"> * @param[out] vtp the @p VirtualTimer structure pointer</span>
|
|
<a name="l00060"></a>00060 <span class="comment"> * @param[in] time the number of time ticks, the value @p TIME_INFINITE</span>
|
|
<a name="l00061"></a>00061 <span class="comment"> * is notallowed. The value @p TIME_IMMEDIATE is allowed</span>
|
|
<a name="l00062"></a>00062 <span class="comment"> * but interpreted as a normal time specification not as</span>
|
|
<a name="l00063"></a>00063 <span class="comment"> * an immediate timeout specification.</span>
|
|
<a name="l00064"></a>00064 <span class="comment"> * @param[in] vtfunc the timer callback function. After invoking the</span>
|
|
<a name="l00065"></a>00065 <span class="comment"> * callback the timer is disabled and the structure can</span>
|
|
<a name="l00066"></a>00066 <span class="comment"> * be disposed or reused.</span>
|
|
<a name="l00067"></a>00067 <span class="comment"> * @param[in] par a parameter that will be passed to the callback</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> * function</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> */</span>
|
|
<a name="l00070"></a><a class="code" href="group__time.html#ga1c44c3a0bc64b2954d95cd98b2e7124e">00070</a> <span class="keywordtype">void</span> <a class="code" href="group__time.html#ga1c44c3a0bc64b2954d95cd98b2e7124e" title="Enables a virtual timer.">chVTSetI</a>(<a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> *vtp, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> time, <a class="code" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2" title="Virtual Timer callback function.">vtfunc_t</a> vtfunc, <span class="keywordtype">void</span> *par) {
|
|
<a name="l00071"></a>00071 <a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> *p;
|
|
<a name="l00072"></a>00072
|
|
<a name="l00073"></a>00073 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((vtp != NULL) && (vtfunc != NULL) && (time != <a class="code" href="group__scheduler.html#gae1568cf3090c973c3bc47f86ae2f5afb" title="Infinite time specification for all the syscalls with a timeout specification.">TIME_INFINITE</a>),
|
|
<a name="l00074"></a>00074 <span class="stringliteral">"chVTSetI"</span>);
|
|
<a name="l00075"></a>00075
|
|
<a name="l00076"></a>00076 vtp-><a class="code" href="struct_virtual_timer.html#aa86e3ff1de8fa6c58f2267ed6bc09cb1" title="Timer callback function parameter.">vt_par</a> = par;
|
|
<a name="l00077"></a>00077 vtp-><a class="code" href="struct_virtual_timer.html#aac8307916bebf903e4f3e783910cf0e6" title="Timer callback function pointer.">vt_func</a> = vtfunc;
|
|
<a name="l00078"></a>00078 p = vtlist.<a class="code" href="struct_v_t_list.html#a18ed6321ebb9d1d4977bc3b1a8d6531d" title="Next timer in the delta list.">vt_next</a>;
|
|
<a name="l00079"></a>00079 <span class="keywordflow">while</span> (p-><a class="code" href="struct_virtual_timer.html#a81422ae4e1d42f486d678bf85772573f" title="Time delta before timeout.">vt_time</a> < time) {
|
|
<a name="l00080"></a>00080 time -= p-><a class="code" href="struct_virtual_timer.html#a81422ae4e1d42f486d678bf85772573f" title="Time delta before timeout.">vt_time</a>;
|
|
<a name="l00081"></a>00081 p = p-><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a>;
|
|
<a name="l00082"></a>00082 }
|
|
<a name="l00083"></a>00083
|
|
<a name="l00084"></a>00084 vtp-><a class="code" href="struct_virtual_timer.html#ab2a1ca6407192845f2cb04ba9775c593" title="Previous timer in the delta list.">vt_prev</a> = (vtp-><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a> = p)->vt_prev;
|
|
<a name="l00085"></a>00085 vtp-><a class="code" href="struct_virtual_timer.html#ab2a1ca6407192845f2cb04ba9775c593" title="Previous timer in the delta list.">vt_prev</a>-><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a> = p-><a class="code" href="struct_virtual_timer.html#ab2a1ca6407192845f2cb04ba9775c593" title="Previous timer in the delta list.">vt_prev</a> = vtp;
|
|
<a name="l00086"></a>00086 vtp-><a class="code" href="struct_virtual_timer.html#a81422ae4e1d42f486d678bf85772573f" title="Time delta before timeout.">vt_time</a> = time;
|
|
<a name="l00087"></a>00087 <span class="keywordflow">if</span> (p != (<span class="keywordtype">void</span> *)&vtlist)
|
|
<a name="l00088"></a>00088 p-><a class="code" href="struct_virtual_timer.html#a81422ae4e1d42f486d678bf85772573f" title="Time delta before timeout.">vt_time</a> -= time;
|
|
<a name="l00089"></a>00089 }
|
|
<a name="l00090"></a>00090 <span class="comment"></span>
|
|
<a name="l00091"></a>00091 <span class="comment">/**</span>
|
|
<a name="l00092"></a>00092 <span class="comment"> * @brief Disables a Virtual Timer.</span>
|
|
<a name="l00093"></a>00093 <span class="comment"> * @note The timer MUST be active when this function is invoked.</span>
|
|
<a name="l00094"></a>00094 <span class="comment"> *</span>
|
|
<a name="l00095"></a>00095 <span class="comment"> * @param[in] vtp the @p VirtualTimer structure pointer</span>
|
|
<a name="l00096"></a>00096 <span class="comment"> */</span>
|
|
<a name="l00097"></a><a class="code" href="group__time.html#ga680d851a74e594cc965101e79891840f">00097</a> <span class="keywordtype">void</span> <a class="code" href="group__time.html#ga680d851a74e594cc965101e79891840f" title="Disables a Virtual Timer.">chVTResetI</a>(<a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> *vtp) {
|
|
<a name="l00098"></a>00098
|
|
<a name="l00099"></a>00099 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(vtp != NULL, <span class="stringliteral">"chVTResetI"</span>);
|
|
<a name="l00100"></a>00100 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>(vtp-><a class="code" href="struct_virtual_timer.html#aac8307916bebf903e4f3e783910cf0e6" title="Timer callback function pointer.">vt_func</a> != NULL,
|
|
<a name="l00101"></a>00101 <span class="stringliteral">"chVTResetI(), #1"</span>,
|
|
<a name="l00102"></a>00102 <span class="stringliteral">"timer not set or already triggered"</span>);
|
|
<a name="l00103"></a>00103
|
|
<a name="l00104"></a>00104 <span class="keywordflow">if</span> (vtp-><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a> != (<span class="keywordtype">void</span> *)&vtlist)
|
|
<a name="l00105"></a>00105 vtp-><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a>-><a class="code" href="struct_virtual_timer.html#a81422ae4e1d42f486d678bf85772573f" title="Time delta before timeout.">vt_time</a> += vtp-><a class="code" href="struct_virtual_timer.html#a81422ae4e1d42f486d678bf85772573f" title="Time delta before timeout.">vt_time</a>;
|
|
<a name="l00106"></a>00106 vtp-><a class="code" href="struct_virtual_timer.html#ab2a1ca6407192845f2cb04ba9775c593" title="Previous timer in the delta list.">vt_prev</a>-><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a> = vtp-><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a>;
|
|
<a name="l00107"></a>00107 vtp-><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a>-><a class="code" href="struct_virtual_timer.html#ab2a1ca6407192845f2cb04ba9775c593" title="Previous timer in the delta list.">vt_prev</a> = vtp-><a class="code" href="struct_virtual_timer.html#ab2a1ca6407192845f2cb04ba9775c593" title="Previous timer in the delta list.">vt_prev</a>;
|
|
<a name="l00108"></a>00108 vtp-><a class="code" href="struct_virtual_timer.html#aac8307916bebf903e4f3e783910cf0e6" title="Timer callback function pointer.">vt_func</a> = (<a class="code" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2" title="Virtual Timer callback function.">vtfunc_t</a>)NULL;
|
|
<a name="l00109"></a>00109 }
|
|
<a name="l00110"></a>00110 <span class="comment"></span>
|
|
<a name="l00111"></a>00111 <span class="comment">/**</span>
|
|
<a name="l00112"></a>00112 <span class="comment"> * @brief Checks if the current system time is within the specified time</span>
|
|
<a name="l00113"></a>00113 <span class="comment"> * window.</span>
|
|
<a name="l00114"></a>00114 <span class="comment"> * @note When start==end then the function returns always true because the</span>
|
|
<a name="l00115"></a>00115 <span class="comment"> * whole time range is specified.</span>
|
|
<a name="l00116"></a>00116 <span class="comment"> *</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> * @param[in] start the start of the time window (inclusive)</span>
|
|
<a name="l00118"></a>00118 <span class="comment"> * @param[in] end the end of the time window (non inclusive)</span>
|
|
<a name="l00119"></a>00119 <span class="comment"> * @retval TRUE current time within the specified time window.</span>
|
|
<a name="l00120"></a>00120 <span class="comment"> * @retval FALSE current time not within the specified time window.</span>
|
|
<a name="l00121"></a>00121 <span class="comment"> */</span>
|
|
<a name="l00122"></a><a class="code" href="group__time.html#ga47933e7381151ab9cc0888e53ced3847">00122</a> <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> <a class="code" href="group__time.html#ga47933e7381151ab9cc0888e53ced3847" title="Checks if the current system time is within the specified time window.">chTimeIsWithin</a>(<a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> start, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> end) {
|
|
<a name="l00123"></a>00123
|
|
<a name="l00124"></a>00124 <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> time = <a class="code" href="group__time.html#ga137c8f67c450f34416a786d169be90e2" title="Current system time.">chTimeNow</a>();
|
|
<a name="l00125"></a>00125 <span class="keywordflow">return</span> end > start ? (time >= start) && (time < end) :
|
|
<a name="l00126"></a>00126 (time >= start) || (time < end);
|
|
<a name="l00127"></a>00127 }
|
|
<a name="l00128"></a>00128 <span class="comment"></span>
|
|
<a name="l00129"></a>00129 <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>
|