mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
199 lines
21 KiB
HTML
199 lines
21 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.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.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<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="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<h1>chvt.h</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="chvt_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 chvt.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Time macros and structures.</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"> * @{</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> */</span>
|
|
<a name="l00034"></a>00034
|
|
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef _CHVT_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _CHVT_H_</span>
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00038"></a>00038 <span class="comment">/**</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * @brief Time conversion utility.</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> * @details Converts from seconds to system ticks number.</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * @note The result is rounded upward to the next tick boundary.</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> */</span>
|
|
<a name="l00043"></a><a class="code" href="group__time.html#gab64090e53ca84e2179acbbf61aa9c71f">00043</a> <span class="preprocessor">#define S2ST(sec) ((systime_t)((sec) * CH_FREQUENCY))</span>
|
|
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00045"></a>00045 <span class="comment">/**</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> * @brief Time conversion utility.</span>
|
|
<a name="l00047"></a>00047 <span class="comment"> * @details Converts from milliseconds to system ticks number.</span>
|
|
<a name="l00048"></a>00048 <span class="comment"> * @note The result is rounded upward to the next tick boundary.</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> */</span>
|
|
<a name="l00050"></a><a class="code" href="group__time.html#ga0a7e7bc6c6225bd9652c4f1567f1bc6a">00050</a> <span class="preprocessor">#define MS2ST(msec) ((systime_t)(((((msec) - 1L) * CH_FREQUENCY) / 1000L) + 1L))</span>
|
|
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00052"></a>00052 <span class="comment">/**</span>
|
|
<a name="l00053"></a>00053 <span class="comment"> * @brief Time conversion utility.</span>
|
|
<a name="l00054"></a>00054 <span class="comment"> * @details Converts from microseconds to system ticks number.</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> * @note The result is rounded upward to the next tick boundary.</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> */</span>
|
|
<a name="l00057"></a><a class="code" href="group__time.html#ga093b2a96d7a52eb5988739fff1b5a995">00057</a> <span class="preprocessor">#define US2ST(usec) ((systime_t)(((((usec) - 1L) * CH_FREQUENCY) / 1000000L) + 1L))</span>
|
|
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00059"></a>00059 <span class="comment">/**</span>
|
|
<a name="l00060"></a>00060 <span class="comment"> * @brief Virtual Timer callback function.</span>
|
|
<a name="l00061"></a>00061 <span class="comment"> */</span>
|
|
<a name="l00062"></a><a class="code" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2">00062</a> <span class="keyword">typedef</span> void (*<a class="code" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2" title="Virtual Timer callback function.">vtfunc_t</a>)(<span class="keywordtype">void</span> *);
|
|
<a name="l00063"></a>00063 <span class="comment"></span>
|
|
<a name="l00064"></a>00064 <span class="comment">/**</span>
|
|
<a name="l00065"></a>00065 <span class="comment"> * @brief Virtual Timer structure type.</span>
|
|
<a name="l00066"></a>00066 <span class="comment"> */</span>
|
|
<a name="l00067"></a><a class="code" href="group__time.html#ga56e290c9d94c0d1888c09df6af39c74a">00067</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> <a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a>;
|
|
<a name="l00068"></a>00068 <span class="comment"></span>
|
|
<a name="l00069"></a>00069 <span class="comment">/**</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> * @extends DeltaList</span>
|
|
<a name="l00071"></a>00071 <span class="comment"> *</span>
|
|
<a name="l00072"></a>00072 <span class="comment"> * @brief Virtual Timer descriptor structure.</span>
|
|
<a name="l00073"></a>00073 <span class="comment"> */</span>
|
|
<a name="l00074"></a><a class="code" href="struct_virtual_timer.html">00074</a> <span class="keyword">struct </span><a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> {
|
|
<a name="l00075"></a><a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f">00075</a> <a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> *<a class="code" href="struct_virtual_timer.html#a7130d3aa62ec1ee1c71a1034278cd60f" title="Next timer in the delta list.">vt_next</a>; <span class="comment">/**< @brief Next timer in the delta</span>
|
|
<a name="l00076"></a>00076 <span class="comment"> list. */</span>
|
|
<a name="l00077"></a><a class="code" href="struct_virtual_timer.html#ab2a1ca6407192845f2cb04ba9775c593">00077</a> <a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> *<a class="code" href="struct_virtual_timer.html#ab2a1ca6407192845f2cb04ba9775c593" title="Previous timer in the delta list.">vt_prev</a>; <span class="comment">/**< @brief Previous timer in the delta</span>
|
|
<a name="l00078"></a>00078 <span class="comment"> list. */</span>
|
|
<a name="l00079"></a><a class="code" href="struct_virtual_timer.html#a81422ae4e1d42f486d678bf85772573f">00079</a> <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> <a class="code" href="struct_virtual_timer.html#a81422ae4e1d42f486d678bf85772573f" title="Time delta before timeout.">vt_time</a>; <span class="comment">/**< @brief Time delta before timeout. */</span>
|
|
<a name="l00080"></a><a class="code" href="struct_virtual_timer.html#aac8307916bebf903e4f3e783910cf0e6">00080</a> <a class="code" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2" title="Virtual Timer callback function.">vtfunc_t</a> <a class="code" href="struct_virtual_timer.html#aac8307916bebf903e4f3e783910cf0e6" title="Timer callback function pointer.">vt_func</a>; <span class="comment">/**< @brief Timer callback function</span>
|
|
<a name="l00081"></a>00081 <span class="comment"> pointer. */</span>
|
|
<a name="l00082"></a><a class="code" href="struct_virtual_timer.html#aa86e3ff1de8fa6c58f2267ed6bc09cb1">00082</a> <span class="keywordtype">void</span> *<a class="code" href="struct_virtual_timer.html#aa86e3ff1de8fa6c58f2267ed6bc09cb1" title="Timer callback function parameter.">vt_par</a>; <span class="comment">/**< @brief Timer callback function</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> parameter. */</span>
|
|
<a name="l00084"></a>00084 };
|
|
<a name="l00085"></a>00085 <span class="comment"></span>
|
|
<a name="l00086"></a>00086 <span class="comment">/**</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * @brief Virtual timers list header.</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> * @note The delta list is implemented as a double link bidirectional list</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> * in order to make the unlink time constant, the reset of a virtual</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> * timer is often used in the code.</span>
|
|
<a name="l00091"></a>00091 <span class="comment"> */</span>
|
|
<a name="l00092"></a><a class="code" href="struct_v_t_list.html">00092</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
<a name="l00093"></a><a class="code" href="struct_v_t_list.html#a18ed6321ebb9d1d4977bc3b1a8d6531d">00093</a> <a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> *vt_next; <span class="comment">/**< @brief Next timer in the delta</span>
|
|
<a name="l00094"></a>00094 <span class="comment"> list. */</span>
|
|
<a name="l00095"></a><a class="code" href="struct_v_t_list.html#a0e89630d5a1b82bb6bfbca1465cfa1f7">00095</a> <a class="code" href="struct_virtual_timer.html" title="Virtual Timer descriptor structure.">VirtualTimer</a> *vt_prev; <span class="comment">/**< @brief Last timer in the delta</span>
|
|
<a name="l00096"></a>00096 <span class="comment"> list. */</span>
|
|
<a name="l00097"></a><a class="code" href="struct_v_t_list.html#a565bf88a53b8ee8a5cd20f42d94b05c6">00097</a> <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> vt_time; <span class="comment">/**< @brief Must be initialized to -1. */</span>
|
|
<a name="l00098"></a><a class="code" href="struct_v_t_list.html#ac2964dcbab06e6498301aaf51d508d77">00098</a> <span class="keyword">volatile</span> <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> vt_systime; <span class="comment">/**< @brief System Time counter. */</span>
|
|
<a name="l00099"></a>00099 } <a class="code" href="struct_v_t_list.html" title="Virtual timers list header.">VTList</a>;
|
|
<a name="l00100"></a>00100
|
|
<a name="l00101"></a>00101 <span class="keyword">extern</span> <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="l00102"></a>00102 <span class="comment"></span>
|
|
<a name="l00103"></a>00103 <span class="comment">/**</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> * @brief Virtual timers ticker.</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> */</span>
|
|
<a name="l00106"></a><a class="code" href="group__time.html#ga3cc8210175b310d62e2043f752ccafee">00106</a> <span class="preprocessor">#define chVTDoTickI() { \</span>
|
|
<a name="l00107"></a>00107 <span class="preprocessor"> vtlist.vt_systime++; \</span>
|
|
<a name="l00108"></a>00108 <span class="preprocessor"> if (&vtlist != (VTList *)vtlist.vt_next) { \</span>
|
|
<a name="l00109"></a>00109 <span class="preprocessor"> VirtualTimer *vtp; \</span>
|
|
<a name="l00110"></a>00110 <span class="preprocessor"> \</span>
|
|
<a name="l00111"></a>00111 <span class="preprocessor"> --vtlist.vt_next->vt_time; \</span>
|
|
<a name="l00112"></a>00112 <span class="preprocessor"> while (!(vtp = vtlist.vt_next)->vt_time) { \</span>
|
|
<a name="l00113"></a>00113 <span class="preprocessor"> vtfunc_t fn = vtp->vt_func; \</span>
|
|
<a name="l00114"></a>00114 <span class="preprocessor"> vtp->vt_func = (vtfunc_t)NULL; \</span>
|
|
<a name="l00115"></a>00115 <span class="preprocessor"> vtp->vt_next->vt_prev = (void *)&vtlist; \</span>
|
|
<a name="l00116"></a>00116 <span class="preprocessor"> (&vtlist)->vt_next = vtp->vt_next; \</span>
|
|
<a name="l00117"></a>00117 <span class="preprocessor"> fn(vtp->vt_par); \</span>
|
|
<a name="l00118"></a>00118 <span class="preprocessor"> } \</span>
|
|
<a name="l00119"></a>00119 <span class="preprocessor"> } \</span>
|
|
<a name="l00120"></a>00120 <span class="preprocessor">}</span>
|
|
<a name="l00121"></a>00121 <span class="preprocessor"></span>
|
|
<a name="l00122"></a>00122 <span class="comment">/*</span>
|
|
<a name="l00123"></a>00123 <span class="comment"> * Virtual Timers APIs.</span>
|
|
<a name="l00124"></a>00124 <span class="comment"> */</span>
|
|
<a name="l00125"></a>00125 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00126"></a>00126 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00127"></a>00127 <span class="preprocessor">#endif</span>
|
|
<a name="l00128"></a>00128 <span class="preprocessor"></span> <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="l00129"></a>00129 <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="l00130"></a>00130 <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="l00131"></a>00131 <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="l00132"></a>00132 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00133"></a>00133 <span class="preprocessor"></span>}
|
|
<a name="l00134"></a>00134 <span class="preprocessor">#endif</span>
|
|
<a name="l00135"></a>00135 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00136"></a>00136 <span class="comment">/**</span>
|
|
<a name="l00137"></a>00137 <span class="comment"> * @brief Returns TRUE if the speciified timer is armed.</span>
|
|
<a name="l00138"></a>00138 <span class="comment"> */</span>
|
|
<a name="l00139"></a><a class="code" href="group__time.html#gae54e6dd40bc7b9cdeb409393ec9e134a">00139</a> <span class="preprocessor">#define chVTIsArmedI(vtp) ((vtp)->vt_func != NULL)</span>
|
|
<a name="l00140"></a>00140 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00141"></a>00141 <span class="comment">/**</span>
|
|
<a name="l00142"></a>00142 <span class="comment"> * @brief Current system time.</span>
|
|
<a name="l00143"></a>00143 <span class="comment"> * @details Returns the number of system ticks since the @p chSysInit()</span>
|
|
<a name="l00144"></a>00144 <span class="comment"> * invocation.</span>
|
|
<a name="l00145"></a>00145 <span class="comment"> * @note The counter can reach its maximum and then restart from zero.</span>
|
|
<a name="l00146"></a>00146 <span class="comment"> * @note This function is designed to work with the @p chThdSleepUntil().</span>
|
|
<a name="l00147"></a>00147 <span class="comment"> *</span>
|
|
<a name="l00148"></a>00148 <span class="comment"> * @return The system time in ticks.r</span>
|
|
<a name="l00149"></a>00149 <span class="comment"> */</span>
|
|
<a name="l00150"></a><a class="code" href="group__time.html#ga137c8f67c450f34416a786d169be90e2">00150</a> <span class="preprocessor">#define chTimeNow() (vtlist.vt_systime)</span>
|
|
<a name="l00151"></a>00151 <span class="preprocessor"></span>
|
|
<a name="l00152"></a>00152 <span class="preprocessor">#endif </span><span class="comment">/* _CHVT_H_ */</span>
|
|
<a name="l00153"></a>00153 <span class="comment"></span>
|
|
<a name="l00154"></a>00154 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|