gnuk/ChibiOS_2.0.6/docs/html/chsys_8h_source.html

238 lines
22 KiB
HTML
Raw Normal View History

2010-08-10 03:11:02 +00:00
<!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: chsys.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">
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
<div class="navigation" id="top">
<div class="tabs">
2010-11-22 05:53:37 +00:00
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<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>
2010-11-22 05:53:37 +00:00
<div class="tabs2">
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="headertitle">
<h1>chsys.h</h1> </div>
</div>
<div class="contents">
<a href="chsys_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>
2010-08-10 03:11:02 +00:00
<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 &lt;http://www.gnu.org/licenses/&gt;.</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 chsys.h</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief System related macros and structures.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup system</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 _CHSYS_H_</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _CHSYS_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 Halts the system.</span>
<a name="l00040"></a>00040 <span class="comment"> * @details This function is invoked by the operating system when an</span>
<a name="l00041"></a>00041 <span class="comment"> * unrecoverable error is detected, as example because a programming</span>
<a name="l00042"></a>00042 <span class="comment"> * error in the application code that triggers an assertion while</span>
<a name="l00043"></a>00043 <span class="comment"> * in debug mode.</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a><a class="code" href="group__system.html#gad43b78f160a2c983792af3041cc4a536">00045</a> <span class="preprocessor">#define chSysHalt() port_halt()</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment">/**</span>
<a name="l00048"></a>00048 <span class="comment"> * @brief Performs a context switch.</span>
<a name="l00049"></a>00049 <span class="comment"> *</span>
<a name="l00050"></a>00050 <span class="comment"> * @param[in] ntp the thread to be switched in</span>
<a name="l00051"></a>00051 <span class="comment"> * @param[in] otp the thread to be switched out</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a><a class="code" href="group__system.html#ga63044a9140cf65d2272f06e05431e161">00053</a> <span class="preprocessor">#define chSysSwitchI(ntp, otp) port_switch(ntp, otp)</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 Raises the system interrupt priority mask to the maximum level.</span>
<a name="l00057"></a>00057 <span class="comment"> * @details All the maskable interrupt sources are disabled regardless their</span>
<a name="l00058"></a>00058 <span class="comment"> * hardware priority.</span>
<a name="l00059"></a>00059 <span class="comment"> * @note The implementation is architecture dependent, it may just disable</span>
<a name="l00060"></a>00060 <span class="comment"> * the interrupts or be exactly equivalent to @p chSysDisable().</span>
<a name="l00061"></a>00061 <span class="comment"> * @note Do not invoke this API from within a kernel lock.</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a><a class="code" href="group__system.html#ga0f6e07fb701e2006ba40db2ede3a4b5b">00063</a> <span class="preprocessor">#define chSysDisable() port_disable()</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment">/**</span>
<a name="l00066"></a>00066 <span class="comment"> * @brief Raises the system interrupt priority mask to system level.</span>
<a name="l00067"></a>00067 <span class="comment"> * @details The interrupt sources that should not be able to preempt the kernel</span>
<a name="l00068"></a>00068 <span class="comment"> * are disabled, interrupt sources with higher priority are still</span>
<a name="l00069"></a>00069 <span class="comment"> * enabled.</span>
<a name="l00070"></a>00070 <span class="comment"> * @note The implementation is architecture dependent, it may just disable</span>
<a name="l00071"></a>00071 <span class="comment"> * the interrupts.</span>
<a name="l00072"></a>00072 <span class="comment"> * @note Do not invoke this API from within a kernel lock.</span>
<a name="l00073"></a>00073 <span class="comment"> * @note This API is no replacement for @p chSysLock(), the @p chSysLock()</span>
<a name="l00074"></a>00074 <span class="comment"> * could do more than just disable the interrupts.</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a><a class="code" href="group__system.html#ga345a8b0ef36155654e5cf88a853365b4">00076</a> <span class="preprocessor">#define chSysSuspend() port_suspend()</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">/**</span>
<a name="l00079"></a>00079 <span class="comment"> * @brief Lowers the system interrupt priority mask to user level.</span>
<a name="l00080"></a>00080 <span class="comment"> * @details All the interrupt sources are enabled.</span>
<a name="l00081"></a>00081 <span class="comment"> * @note The implementation is architecture dependent, it may just enable</span>
<a name="l00082"></a>00082 <span class="comment"> * the interrupts.</span>
<a name="l00083"></a>00083 <span class="comment"> * @note Do not invoke this API from within a kernel lock.</span>
<a name="l00084"></a>00084 <span class="comment"> * @note This API is no replacement for @p chSysUnlock(), the</span>
<a name="l00085"></a>00085 <span class="comment"> * @p chSysUnlock() could do more than just enable the interrupts.</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a><a class="code" href="group__system.html#ga2f54701f43490a5de272cc3d32962b51">00087</a> <span class="preprocessor">#define chSysEnable() port_enable()</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment">/**</span>
<a name="l00090"></a>00090 <span class="comment"> * @brief Enters the kernel lock mode.</span>
<a name="l00091"></a>00091 <span class="comment"> * @note The use of kernel lock mode is not recommended in the user code,</span>
<a name="l00092"></a>00092 <span class="comment"> * it is a better idea to use the semaphores or mutexes instead.</span>
<a name="l00093"></a>00093 <span class="comment"> * @see CH_USE_NESTED_LOCKS</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="preprocessor">#if CH_USE_NESTED_LOCKS || defined(__DOXYGEN__)</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#if CH_OPTIMIZE_SPEED || defined(__DOXYGEN__)</span>
<a name="l00097"></a><a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42">00097</a> <span class="preprocessor"></span><span class="preprocessor">#define chSysLock() { \</span>
<a name="l00098"></a>00098 <span class="preprocessor"> if (currp-&gt;p_locks++ == 0) \</span>
<a name="l00099"></a>00099 <span class="preprocessor"> port_lock(); \</span>
<a name="l00100"></a>00100 <span class="preprocessor">}</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* CH_OPTIMIZE_SPEED */</span>
<a name="l00102"></a>00102 <span class="preprocessor">#else </span><span class="comment">/* !CH_USE_NESTED_LOCKS */</span>
<a name="l00103"></a>00103 <span class="preprocessor">#define chSysLock() port_lock()</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !CH_USE_NESTED_LOCKS */</span>
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment">/**</span>
<a name="l00107"></a>00107 <span class="comment"> * @brief Leaves the kernel lock mode.</span>
<a name="l00108"></a>00108 <span class="comment"> * @note The use of kernel lock mode is not recommended in the user code,</span>
<a name="l00109"></a>00109 <span class="comment"> * it is a better idea to use the semaphores or mutexes instead.</span>
<a name="l00110"></a>00110 <span class="comment"> * @see CH_USE_NESTED_LOCKS</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a>00112 <span class="preprocessor">#if CH_USE_NESTED_LOCKS || defined(__DOXYGEN__)</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span><span class="preprocessor">#if CH_OPTIMIZE_SPEED || defined(__DOXYGEN__)</span>
<a name="l00114"></a><a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e">00114</a> <span class="preprocessor"></span><span class="preprocessor">#define chSysUnlock() { \</span>
<a name="l00115"></a>00115 <span class="preprocessor"> if (--currp-&gt;p_locks == 0) \</span>
<a name="l00116"></a>00116 <span class="preprocessor"> port_unlock(); \</span>
<a name="l00117"></a>00117 <span class="preprocessor">}</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* CH_OPTIMIZE_SPEED */</span>
<a name="l00119"></a>00119 <span class="preprocessor">#else </span><span class="comment">/* !CH_USE_NESTED_LOCKS */</span>
<a name="l00120"></a>00120 <span class="preprocessor">#define chSysUnlock() port_unlock()</span>
<a name="l00121"></a>00121 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* !CH_USE_NESTED_LOCKS */</span>
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">/**</span>
<a name="l00124"></a>00124 <span class="comment"> * @brief Enters the kernel lock mode from within an interrupt handler.</span>
<a name="l00125"></a>00125 <span class="comment"> * @note This API may do nothing on some architectures, it is required</span>
<a name="l00126"></a>00126 <span class="comment"> * because on ports that support preemptable interrupt handlers</span>
<a name="l00127"></a>00127 <span class="comment"> * it is required to raise the interrupt mask to the same level of</span>
<a name="l00128"></a>00128 <span class="comment"> * the system mutual exclusion zone.&lt;br&gt;</span>
<a name="l00129"></a>00129 <span class="comment"> * It is good practice to invoke this API before invoking any I-class</span>
<a name="l00130"></a>00130 <span class="comment"> * syscall from an interrupt handler.</span>
<a name="l00131"></a>00131 <span class="comment"> * @note This API must be invoked exclusively from interrupt handlers.</span>
<a name="l00132"></a>00132 <span class="comment"> */</span>
<a name="l00133"></a><a class="code" href="group__system.html#gab826c6d946aa1eb839751246ea158a72">00133</a> <span class="preprocessor">#define chSysLockFromIsr() port_lock_from_isr()</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00135"></a>00135 <span class="comment">/**</span>
<a name="l00136"></a>00136 <span class="comment"> * @brief Leaves the kernel lock mode from within an interrupt handler.</span>
<a name="l00137"></a>00137 <span class="comment"> *</span>
<a name="l00138"></a>00138 <span class="comment"> * @note This API may do nothing on some architectures, it is required</span>
<a name="l00139"></a>00139 <span class="comment"> * because on ports that support preemptable interrupt handlers</span>
<a name="l00140"></a>00140 <span class="comment"> * it is required to raise the interrupt mask to the same level of</span>
<a name="l00141"></a>00141 <span class="comment"> * the system mutual exclusion zone.&lt;br&gt;</span>
<a name="l00142"></a>00142 <span class="comment"> * It is good practice to invoke this API after invoking any I-class</span>
<a name="l00143"></a>00143 <span class="comment"> * syscall from an interrupt handler.</span>
<a name="l00144"></a>00144 <span class="comment"> * @note This API must be invoked exclusively from interrupt handlers.</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a><a class="code" href="group__system.html#ga984fb4af1420b6a217714ed317224ec0">00146</a> <span class="preprocessor">#define chSysUnlockFromIsr() port_unlock_from_isr()</span>
<a name="l00147"></a>00147 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00148"></a>00148 <span class="comment">/**</span>
<a name="l00149"></a>00149 <span class="comment"> * @brief IRQ handler enter code.</span>
<a name="l00150"></a>00150 <span class="comment"> * @note Usually IRQ handlers functions are also declared naked.</span>
<a name="l00151"></a>00151 <span class="comment"> * @note On some architectures this macro can be empty.</span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a><a class="code" href="group__system.html#ga0d78c6e90e5f0a4eb52aaab37e45a494">00153</a> <span class="preprocessor">#define CH_IRQ_PROLOGUE() PORT_IRQ_PROLOGUE()</span>
<a name="l00154"></a>00154 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00155"></a>00155 <span class="comment">/**</span>
<a name="l00156"></a>00156 <span class="comment"> * @brief IRQ handler exit code.</span>
<a name="l00157"></a>00157 <span class="comment"> * @note Usually IRQ handlers function are also declared naked.</span>
<a name="l00158"></a>00158 <span class="comment"> * @note This macro usually performs the final reschedule by using</span>
<a name="l00159"></a>00159 <span class="comment"> * @p chSchRescRequiredI() and @p chSchDoRescheduleI().</span>
<a name="l00160"></a>00160 <span class="comment"> */</span>
<a name="l00161"></a><a class="code" href="group__system.html#ga864d6b8056d7d8f56322bbfcc8515d77">00161</a> <span class="preprocessor">#define CH_IRQ_EPILOGUE() PORT_IRQ_EPILOGUE()</span>
<a name="l00162"></a>00162 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment">/**</span>
<a name="l00164"></a>00164 <span class="comment"> * @brief Standard normal IRQ handler declaration.</span>
<a name="l00165"></a>00165 <span class="comment"> * @note @p id can be a function name or a vector number depending on the</span>
<a name="l00166"></a>00166 <span class="comment"> * port implementation.</span>
<a name="l00167"></a>00167 <span class="comment"> */</span>
<a name="l00168"></a><a class="code" href="group__system.html#ga52426c607fac82b1e0ad975b367f95e9">00168</a> <span class="preprocessor">#define CH_IRQ_HANDLER(id) PORT_IRQ_HANDLER(id)</span>
<a name="l00169"></a>00169 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment">/**</span>
<a name="l00171"></a>00171 <span class="comment"> * @brief Standard fast IRQ handler declaration.</span>
<a name="l00172"></a>00172 <span class="comment"> * @note @p id can be a function name or a vector number depending on the</span>
<a name="l00173"></a>00173 <span class="comment"> * port implementation.</span>
<a name="l00174"></a>00174 <span class="comment"> * @note Not all architectures support fast interrupts.</span>
<a name="l00175"></a>00175 <span class="comment"> */</span>
<a name="l00176"></a><a class="code" href="group__system.html#ga07883f8c07160bf1f95f8b8a783dbe38">00176</a> <span class="preprocessor">#define CH_FAST_IRQ_HANDLER(id) PORT_FAST_IRQ_HANDLER(id)</span>
<a name="l00177"></a>00177 <span class="preprocessor"></span>
<a name="l00178"></a>00178 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00179"></a>00179 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00180"></a>00180 <span class="preprocessor">#endif</span>
<a name="l00181"></a>00181 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__system.html#gafe2c7de6567e98e487e009e81e3be10b" title="ChibiOS/RT initialization.">chSysInit</a>(<span class="keywordtype">void</span>);
<a name="l00182"></a>00182 <span class="keywordtype">void</span> <a class="code" href="group__system.html#ga1e42ee112f4a5d2c95be07d523c247be" title="Handles time ticks for round robin preemption and timer increments.">chSysTimerHandlerI</a>(<span class="keywordtype">void</span>);
<a name="l00183"></a>00183 <span class="preprocessor">#if CH_USE_NESTED_LOCKS &amp;&amp; !CH_OPTIMIZE_SPEED</span>
<a name="l00184"></a>00184 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>(<span class="keywordtype">void</span>);
<a name="l00185"></a>00185 <span class="keywordtype">void</span> <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>(<span class="keywordtype">void</span>);
<a name="l00186"></a>00186 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_NESTED_LOCKS &amp;&amp; !CH_OPTIMIZE_SPEED */</span>
<a name="l00187"></a>00187 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00188"></a>00188 <span class="preprocessor"></span>}
<a name="l00189"></a>00189 <span class="preprocessor">#endif</span>
<a name="l00190"></a>00190 <span class="preprocessor"></span>
<a name="l00191"></a>00191 <span class="preprocessor">#endif </span><span class="comment">/* _CHSYS_H_ */</span>
<a name="l00192"></a>00192 <span class="comment"></span>
<a name="l00193"></a>00193 <span class="comment">/** @} */</span>
</pre></div></div>
2010-11-22 05:53:37 +00:00
</div>
2010-08-10 03:11:02 +00:00
<hr size="1"><address style="text-align: right;"><small>
2010-11-22 05:53:37 +00:00
Generated on Sun Oct 24 2010 09:40:37 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>
2010-08-10 03:11:02 +00:00
</body>
</html>