gnuk/ChibiOS_2.0.8/docs/html/chvt_8h.html
2010-11-30 13:54:43 +09:00

102 lines
9.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: chvt.h File Reference</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&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<h1>chvt.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Time macros and structures.
<a href="#_details">More...</a></p>
<p><a href="chvt_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_virtual_timer.html">VirtualTimer</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual Timer descriptor structure. <a href="struct_virtual_timer.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_v_t_list.html">VTList</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual timers list header. <a href="struct_v_t_list.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gab64090e53ca84e2179acbbf61aa9c71f">S2ST</a>(sec)&nbsp;&nbsp;&nbsp;((<a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a>)((sec) * CH_FREQUENCY))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Time conversion utility. <a href="group__time.html#gab64090e53ca84e2179acbbf61aa9c71f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga0a7e7bc6c6225bd9652c4f1567f1bc6a">MS2ST</a>(msec)&nbsp;&nbsp;&nbsp;((<a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a>)(((((msec) - 1L) * CH_FREQUENCY) / 1000L) + 1L))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Time conversion utility. <a href="group__time.html#ga0a7e7bc6c6225bd9652c4f1567f1bc6a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga093b2a96d7a52eb5988739fff1b5a995">US2ST</a>(usec)&nbsp;&nbsp;&nbsp;((<a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a>)(((((usec) - 1L) * CH_FREQUENCY) / 1000000L) + 1L))</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Time conversion utility. <a href="group__time.html#ga093b2a96d7a52eb5988739fff1b5a995"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga3cc8210175b310d62e2043f752ccafee">chVTDoTickI</a>()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual timers ticker. <a href="group__time.html#ga3cc8210175b310d62e2043f752ccafee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gae54e6dd40bc7b9cdeb409393ec9e134a">chVTIsArmedI</a>(vtp)&nbsp;&nbsp;&nbsp;((vtp)-&gt;vt_func != NULL)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns TRUE if the speciified timer is armed. <a href="group__time.html#gae54e6dd40bc7b9cdeb409393ec9e134a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga137c8f67c450f34416a786d169be90e2">chTimeNow</a>()&nbsp;&nbsp;&nbsp;(vtlist.vt_systime)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current system time. <a href="group__time.html#ga137c8f67c450f34416a786d169be90e2"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2">vtfunc_t</a> )(void *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual Timer callback function. <a href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_virtual_timer.html">VirtualTimer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga56e290c9d94c0d1888c09df6af39c74a">VirtualTimer</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual Timer structure type. <a href="group__time.html#ga56e290c9d94c0d1888c09df6af39c74a"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga3f64863d042de0de89233bfeabe39b62">vt_init</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual Timers initialization. <a href="group__time.html#ga3f64863d042de0de89233bfeabe39b62"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga1c44c3a0bc64b2954d95cd98b2e7124e">chVTSetI</a> (<a class="el" href="struct_virtual_timer.html">VirtualTimer</a> *vtp, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time, <a class="el" href="group__time.html#gae6dbe55ffac66f346e05fd99cb4a76b2">vtfunc_t</a> vtfunc, void *par)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables a virtual timer. <a href="group__time.html#ga1c44c3a0bc64b2954d95cd98b2e7124e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga680d851a74e594cc965101e79891840f">chVTResetI</a> (<a class="el" href="struct_virtual_timer.html">VirtualTimer</a> *vtp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disables a Virtual Timer. <a href="group__time.html#ga680d851a74e594cc965101e79891840f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#ga47933e7381151ab9cc0888e53ced3847">chTimeIsWithin</a> (<a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> start, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> end)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks if the current system time is within the specified time window. <a href="group__time.html#ga47933e7381151ab9cc0888e53ced3847"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_v_t_list.html">VTList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gaf86fafcf8f7ea15d07e55f45dd80e3ac">vtlist</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual timers delta list header. <a href="group__time.html#gaf86fafcf8f7ea15d07e55f45dd80e3ac"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Time macros and structures. </p>
<p>Definition in file <a class="el" href="chvt_8h_source.html">chvt.h</a>.</p>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Nov 28 2010 14:09:50 for ChibiOS/RT by&nbsp;<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>