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: ch.hpp 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 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 >
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 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 > ch.hpp< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "ch_8hpp.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 < 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 ch.hpp< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief C++ wrapper classes and definitions.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > * @addtogroup cpp_library< / 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" > #include < < a class = "code" href = "ch_8h.html" title = "ChibiOS/RT main include file." > ch.h< / a > > < / span >
< a name = "l00035" > < / a > 00035
< a name = "l00036" > < / a > 00036 < span class = "preprocessor" > #ifndef _CH_HPP_< / span >
< a name = "l00037" > < / a > 00037 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _CH_HPP_< / span >
< a name = "l00038" > < / a > 00038 < span class = "preprocessor" > < / span >
< a name = "l00039" > < / a > 00039 < span class = "keyword" > namespace < / span > chibios_rt {
< a name = "l00040" > < / a > 00040 < span class = "comment" > < / span >
< a name = "l00041" > < / a > 00041 < span class = "comment" > /**< / span >
< a name = "l00042" > < / a > 00042 < span class = "comment" > * @brief Class encapsulating the base system functionalities.< / span >
< a name = "l00043" > < / a > 00043 < span class = "comment" > */< / span >
< a name = "l00044" > < / a > < a class = "code" href = "classchibios__rt_1_1_system.html" > 00044< / a > < span class = "keyword" > class < / span > < a class = "code" href = "classchibios__rt_1_1_system.html" title = "Class encapsulating the base system functionalities." > System< / a > {
< a name = "l00045" > < / a > 00045 < span class = "keyword" > public< / span > :< span class = "comment" > < / span >
< a name = "l00046" > < / a > 00046 < span class = "comment" > /**< / span >
< a name = "l00047" > < / a > 00047 < span class = "comment" > * @brief ChibiOS/RT initialization.< / span >
< a name = "l00048" > < / a > 00048 < span class = "comment" > * @details The system is initialized, the idle thread is spawned and the< / span >
< a name = "l00049" > < / a > 00049 < span class = "comment" > * current instruction flow becomes the main thread with priority< / span >
< a name = "l00050" > < / a > 00050 < span class = "comment" > * @p NORMALPRIO.< / span >
< a name = "l00051" > < / a > 00051 < span class = "comment" > */< / span >
< a name = "l00052" > < / a > 00052 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_system.html#a368a84ccf6f537f7ba732829cbb29281" title = "ChibiOS/RT initialization." > Init< / a > (< span class = "keywordtype" > void< / span > );
< 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 Kernel lock.< / span >
< a name = "l00056" > < / a > 00056 < span class = "comment" > *< / span >
< a name = "l00057" > < / a > 00057 < span class = "comment" > * @note On some ports it is faster to invoke chSysLock() directly because< / span >
< a name = "l00058" > < / a > 00058 < span class = "comment" > * inlining.< / span >
< a name = "l00059" > < / a > 00059 < span class = "comment" > */< / span >
< a name = "l00060" > < / a > 00060 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_system.html#a464d3fc171938b9387872fc9cdaa78a6" title = "Kernel lock." > Lock< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00061" > < / a > 00061 < span class = "comment" > < / span >
< a name = "l00062" > < / a > 00062 < span class = "comment" > /**< / span >
< a name = "l00063" > < / a > 00063 < span class = "comment" > * @brief Kernel unlock.< / span >
< a name = "l00064" > < / a > 00064 < span class = "comment" > *< / span >
< a name = "l00065" > < / a > 00065 < span class = "comment" > * @note On some ports it is faster to invoke chSysUnlock() directly< / span >
< a name = "l00066" > < / a > 00066 < span class = "comment" > * because inlining.< / span >
< a name = "l00067" > < / a > 00067 < span class = "comment" > */< / span >
< a name = "l00068" > < / a > 00068 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_system.html#affaa69004bd8f952aebce80cffff673f" title = "Kernel unlock." > Unlock< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00069" > < / a > 00069 < span class = "comment" > < / span >
< a name = "l00070" > < / a > 00070 < span class = "comment" > /**< / span >
< a name = "l00071" > < / a > 00071 < span class = "comment" > * @brief Returns the system time as system ticks.< / span >
< a name = "l00072" > < / a > 00072 < span class = "comment" > *< / span >
< a name = "l00073" > < / a > 00073 < span class = "comment" > * @note the system tick time interval is implementation dependent.< / span >
< a name = "l00074" > < / a > 00074 < span class = "comment" > */< / span >
< a name = "l00075" > < / a > 00075 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > < a class = "code" href = "classchibios__rt_1_1_system.html#a74fb442c63f2a34c0a81dbfa42319976" title = "Returns the system time as system ticks." > GetTime< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00076" > < / a > 00076 };
< a name = "l00077" > < / a > 00077 < span class = "comment" > < / span >
< a name = "l00078" > < / a > 00078 < span class = "comment" > /**< / span >
< a name = "l00079" > < / a > 00079 < span class = "comment" > * @brief Timer class.< / span >
< a name = "l00080" > < / a > 00080 < span class = "comment" > */< / span >
< a name = "l00081" > < / a > < a class = "code" href = "classchibios__rt_1_1_timer.html" > 00081< / a > < span class = "keyword" > class < / span > < a class = "code" href = "classchibios__rt_1_1_timer.html" title = "Timer class." > Timer< / a > {
< a name = "l00082" > < / a > 00082 < span class = "keyword" > public< / span > :< span class = "comment" > < / span >
< a name = "l00083" > < / a > 00083 < span class = "comment" > /**< / span >
< a name = "l00084" > < / a > 00084 < span class = "comment" > * @brief Embedded @p VirtualTimer structure.< / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > */< / span >
< a name = "l00086" > < / a > < a class = "code" href = "classchibios__rt_1_1_timer.html#a0b126ef3347ec88a54c11e10070d4270" > 00086< / a > < a class = "code" href = "group__time.html#ga56e290c9d94c0d1888c09df6af39c74a" title = "Virtual Timer structure type." > struct ::VirtualTimer< / a > < a class = "code" href = "classchibios__rt_1_1_timer.html#a0b126ef3347ec88a54c11e10070d4270" title = "Embedded VirtualTimer structure." > timer< / a > ;
< a name = "l00087" > < / a > 00087 < span class = "comment" > < / span >
< a name = "l00088" > < / a > 00088 < span class = "comment" > /**< / span >
< a name = "l00089" > < / a > 00089 < span class = "comment" > * @brief Starts the timer.< / span >
< a name = "l00090" > < / a > 00090 < span class = "comment" > *< / span >
< a name = "l00091" > < / a > 00091 < span class = "comment" > * @param time the time in system ticks< / span >
< a name = "l00092" > < / a > 00092 < span class = "comment" > * @param vtfunc the timer callback function< / span >
< a name = "l00093" > < / a > 00093 < span class = "comment" > * @param par the parameter for the callback function< / span >
< a name = "l00094" > < / a > 00094 < span class = "comment" > * @note It must be called with the interrupts disabled.< / span >
< a name = "l00095" > < / a > 00095 < span class = "comment" > * @note The associated function is invoked by an interrupt handler.< / span >
< a name = "l00096" > < / a > 00096 < span class = "comment" > */< / span >
< a name = "l00097" > < / a > 00097 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_timer.html#a375cb7ce8108c24336016a94efd8a787" title = "Starts the timer." > Set< / a > (< 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 = "l00098" > < / a > 00098 < span class = "comment" > < / span >
< a name = "l00099" > < / a > 00099 < span class = "comment" > /**< / span >
< a name = "l00100" > < / a > 00100 < span class = "comment" > * @brief Resets the timer.< / span >
< a name = "l00101" > < / a > 00101 < span class = "comment" > *< / span >
< a name = "l00102" > < / a > 00102 < span class = "comment" > * @note It must be called with the interrupts disabled.< / span >
< a name = "l00103" > < / a > 00103 < span class = "comment" > * @note The timer MUST be active when this function is invoked.< / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > */< / span >
< a name = "l00105" > < / a > 00105 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_timer.html#a065b7fbc2a055152c39505ae91ea9754" title = "Resets the timer." > Reset< / a > ();
< a name = "l00106" > < / a > 00106 < span class = "comment" > < / span >
< a name = "l00107" > < / a > 00107 < span class = "comment" > /**< / span >
< a name = "l00108" > < / a > 00108 < span class = "comment" > * @brief Returns the timer status.< / span >
< a name = "l00109" > < / a > 00109 < span class = "comment" > *< / span >
< a name = "l00110" > < / a > 00110 < span class = "comment" > * @retval TRUE The timer is armed.< / span >
< a name = "l00111" > < / a > 00111 < span class = "comment" > * @retval FALSE The timer already fired its callback.< / span >
< a name = "l00112" > < / a > 00112 < span class = "comment" > */< / span >
< a name = "l00113" > < / a > 00113 < span class = "keywordtype" > bool< / span > < a class = "code" href = "classchibios__rt_1_1_timer.html#a97e29d53a4aaf2ef997732be63fdee6e" title = "Returns the timer status." > IsArmed< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00114" > < / a > 00114 };
< a name = "l00115" > < / a > 00115 < span class = "comment" > < / span >
< a name = "l00116" > < / a > 00116 < span class = "comment" > /**< / span >
< a name = "l00117" > < / a > 00117 < span class = "comment" > * @brief Base class for a ChibiOS/RT thread.< / span >
< a name = "l00118" > < / a > 00118 < span class = "comment" > * @details The thread body is the virtual function @p Main().< / span >
< a name = "l00119" > < / a > 00119 < span class = "comment" > */< / span >
< a name = "l00120" > < / a > < a class = "code" href = "classchibios__rt_1_1_base_thread.html" > 00120< / a > < span class = "keyword" > class < / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html" title = "Base class for a ChibiOS/RT thread." > BaseThread< / a > {
< a name = "l00121" > < / a > 00121 < span class = "keyword" > public< / span > :< span class = "comment" > < / span >
< a name = "l00122" > < / a > 00122 < span class = "comment" > /**< / span >
< a name = "l00123" > < / a > 00123 < span class = "comment" > * @brief Pointer to the system thread.< / span >
< a name = "l00124" > < / a > 00124 < span class = "comment" > */< / span > < a class = "code" href = "struct_thread.html" title = "Structure representing a thread." > < / a >
< a name = "l00125" > < / a > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a5cfa916d9b0888507756a6d1be7e7778" > 00125< / a > < a class = "code" href = "struct_thread.html" title = "Structure representing a thread." > ::Thread< / a > *< a class = "code" href = "classchibios__rt_1_1_base_thread.html#a5cfa916d9b0888507756a6d1be7e7778" title = "Pointer to the system thread." > thread_ref< / a > ;
< a name = "l00126" > < / a > 00126 < span class = "comment" > < / span >
< a name = "l00127" > < / a > 00127 < span class = "comment" > /**< / span >
< a name = "l00128" > < / a > 00128 < span class = "comment" > * @brief Thread constructor.< / span >
< a name = "l00129" > < / a > 00129 < span class = "comment" > * @details The thread object is initialized and a system thread is< / span >
< a name = "l00130" > < / a > 00130 < span class = "comment" > * started.< / span >
< a name = "l00131" > < / a > 00131 < span class = "comment" > *< / span >
< a name = "l00132" > < / a > 00132 < span class = "comment" > * @param workspace pointer to the workspace area< / span >
< a name = "l00133" > < / a > 00133 < span class = "comment" > * @param wsize size of the workspace area< / span >
< a name = "l00134" > < / a > 00134 < span class = "comment" > * @param prio thread priority< / span >
< a name = "l00135" > < / a > 00135 < span class = "comment" > */< / span >
< a name = "l00136" > < / a > 00136 < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a48012dd4151de3d40aa5139b230ed627" title = "Thread constructor." > BaseThread< / a > (< span class = "keywordtype" > void< / span > *workspace, < span class = "keywordtype" > size_t< / span > wsize, < a class = "code" href = "group__types.html#ga5f2488ba73e5969cbc0f7033735374ee" title = "Priority, use the fastest unsigned type." > tprio_t< / a > prio);
< a name = "l00137" > < / a > 00137 < span class = "comment" > < / span >
< a name = "l00138" > < / a > 00138 < span class = "comment" > /**< / span >
< a name = "l00139" > < / a > 00139 < span class = "comment" > * @brief Thread exit.< / span >
< a name = "l00140" > < / a > 00140 < span class = "comment" > *< / span >
< a name = "l00141" > < / a > 00141 < span class = "comment" > * @param msg the exit message< / span >
< a name = "l00142" > < / a > 00142 < span class = "comment" > */< / span >
< a name = "l00143" > < / a > 00143 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#abc119aef948c9050d2e18a5a2686d88d" title = "Thread exit." > Exit< / a > (< a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > msg);
< a name = "l00144" > < / a > 00144
< a name = "l00145" > < / a > 00145 < span class = "preprocessor" > #if CH_USE_WAITEXIT< / span >
< a name = "l00146" > < / a > 00146 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00147" > < / a > 00147 < span class = "comment" > * @brief Synchronization on Thread exit.< / span >
< a name = "l00148" > < / a > 00148 < span class = "comment" > *< / span >
< a name = "l00149" > < / a > 00149 < span class = "comment" > * @return the exit message from the thread< / span >
< a name = "l00150" > < / a > 00150 < span class = "comment" > */< / span >
< a name = "l00151" > < / a > 00151 < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a8b4a3de70b98980e6836a48f3e97969c" title = "Synchronization on Thread exit." > Wait< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00152" > < / a > 00152 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_WAITEXIT */< / span >
< a name = "l00153" > < / a > 00153 < span class = "comment" > < / span >
< a name = "l00154" > < / a > 00154 < span class = "comment" > /**< / span >
< a name = "l00155" > < / a > 00155 < span class = "comment" > * @brief Resumes the thread.< / span >
< a name = "l00156" > < / a > 00156 < span class = "comment" > * @details The thread encapsulated into the object is resumed.< / span >
< a name = "l00157" > < / a > 00157 < span class = "comment" > */< / span >
< a name = "l00158" > < / a > 00158 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a6cde6d5b592476aded69ee10b5adc912" title = "Resumes the thread." > Resume< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00159" > < / a > 00159 < span class = "comment" > < / span >
< a name = "l00160" > < / a > 00160 < span class = "comment" > /**< / span >
< a name = "l00161" > < / a > 00161 < span class = "comment" > * @brief Changes the thread priority.< / span >
< a name = "l00162" > < / a > 00162 < span class = "comment" > *< / span >
< a name = "l00163" > < / a > 00163 < span class = "comment" > * @param newprio the new priority level< / span >
< a name = "l00164" > < / a > 00164 < span class = "comment" > */< / span >
< a name = "l00165" > < / a > 00165 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#aa824957049b5d62a4d23b0c9758b30a5" title = "Changes the thread priority." > SetPriority< / a > (< a class = "code" href = "group__types.html#ga5f2488ba73e5969cbc0f7033735374ee" title = "Priority, use the fastest unsigned type." > tprio_t< / a > newprio);
< a name = "l00166" > < / a > 00166 < span class = "comment" > < / span >
< a name = "l00167" > < / a > 00167 < span class = "comment" > /**< / span >
< a name = "l00168" > < / a > 00168 < span class = "comment" > * @brief Requests thread termination.< / span >
< a name = "l00169" > < / a > 00169 < span class = "comment" > * @details A termination flag is pended on the thread, it is thread< / span >
< a name = "l00170" > < / a > 00170 < span class = "comment" > * responsibility to detect it and exit.< / span >
< a name = "l00171" > < / a > 00171 < span class = "comment" > */< / span >
< a name = "l00172" > < / a > 00172 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a9391836cb66a13932044703d1833ae64" title = "Requests thread termination." > Terminate< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00173" > < / a > 00173 < span class = "comment" > < / span >
< a name = "l00174" > < / a > 00174 < span class = "comment" > /**< / span >
< a name = "l00175" > < / a > 00175 < span class = "comment" > * @brief Suspends the thread execution for the specified number of< / span >
< a name = "l00176" > < / a > 00176 < span class = "comment" > * system ticks.< / span >
< a name = "l00177" > < / a > 00177 < span class = "comment" > *< / span >
< a name = "l00178" > < / a > 00178 < span class = "comment" > * @param n the number of system ticks< / span >
< a name = "l00179" > < / a > 00179 < span class = "comment" > */< / span >
< a name = "l00180" > < / a > 00180 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a44de1239fc6517ddf735405dd7fc8463" title = "Suspends the thread execution for the specified number of system ticks." > Sleep< / a > (< a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > n);
< a name = "l00181" > < / a > 00181 < span class = "comment" > < / span >
< a name = "l00182" > < / a > 00182 < span class = "comment" > /**< / span >
< a name = "l00183" > < / a > 00183 < span class = "comment" > * @brief Suspends the thread execution until the specified time arrives.< / span >
< a name = "l00184" > < / a > 00184 < span class = "comment" > *< / span >
< a name = "l00185" > < / a > 00185 < span class = "comment" > * @param time the system time< / span >
< a name = "l00186" > < / a > 00186 < span class = "comment" > */< / span >
< a name = "l00187" > < / a > 00187 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a0589beba9bb4c959b3f49a82b24562eb" title = "Suspends the thread execution until the specified time arrives." > SleepUntil< / a > (< a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > time);
< a name = "l00188" > < / a > 00188
< a name = "l00189" > < / a > 00189 < span class = "preprocessor" > #if CH_USE_MESSAGES< / span >
< a name = "l00190" > < / a > 00190 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00191" > < / a > 00191 < span class = "comment" > * @brief Sends a message to the thread and returns the answer.< / span >
< a name = "l00192" > < / a > 00192 < span class = "comment" > *< / span >
< a name = "l00193" > < / a > 00193 < span class = "comment" > * @param tp the target thread< / span >
< a name = "l00194" > < / a > 00194 < span class = "comment" > * @param msg the sent message< / span >
< a name = "l00195" > < / a > 00195 < span class = "comment" > * @return The returned message.< / span >
< a name = "l00196" > < / a > 00196 < span class = "comment" > */< / span >
< a name = "l00197" > < / a > 00197 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a1557c9e6e0b61a7eb848ce928115973d" title = "Sends a message to the thread and returns the answer." > SendMessage< / a > (::< a class = "code" href = "struct_thread.html" title = "Structure representing a thread." > Thread< / a > *tp, < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > msg);
< a name = "l00198" > < / a > 00198 < span class = "comment" > < / span >
< a name = "l00199" > < / a > 00199 < span class = "comment" > /**< / span >
< a name = "l00200" > < / a > 00200 < span class = "comment" > * @brief Sends a message to the thread and returns the answer.< / span >
< a name = "l00201" > < / a > 00201 < span class = "comment" > *< / span >
< a name = "l00202" > < / a > 00202 < span class = "comment" > * @param msg the sent message< / span >
< a name = "l00203" > < / a > 00203 < span class = "comment" > * @return The returned message.< / span >
< a name = "l00204" > < / a > 00204 < span class = "comment" > */< / span >
< a name = "l00205" > < / a > 00205 < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a1557c9e6e0b61a7eb848ce928115973d" title = "Sends a message to the thread and returns the answer." > SendMessage< / a > (< a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > msg);
< a name = "l00206" > < / a > 00206 < span class = "comment" > < / span >
< a name = "l00207" > < / a > 00207 < span class = "comment" > /**< / span >
< a name = "l00208" > < / a > 00208 < span class = "comment" > * @brief Waits for a message and returns it.< / span >
< a name = "l00209" > < / a > 00209 < span class = "comment" > *< / span >
< a name = "l00210" > < / a > 00210 < span class = "comment" > * @return The incoming message.< / span >
< a name = "l00211" > < / a > 00211 < span class = "comment" > */< / span >
< a name = "l00212" > < / a > 00212 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#ae960dbec72042a9072e35984523694b8" title = "Waits for a message and returns it." > WaitMessage< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00213" > < / a > 00213 < span class = "comment" > < / span >
< a name = "l00214" > < / a > 00214 < span class = "comment" > /**< / span >
< a name = "l00215" > < / a > 00215 < span class = "comment" > * @brief Returns an enqueued message or @p NULL.< / span >
< a name = "l00216" > < / a > 00216 < span class = "comment" > *< / span >
< a name = "l00217" > < / a > 00217 < span class = "comment" > * @return The incoming message.< / span >
< a name = "l00218" > < / a > 00218 < span class = "comment" > * @retval NULL No incoming message.< / span >
< a name = "l00219" > < / a > 00219 < span class = "comment" > */< / span >
< a name = "l00220" > < / a > 00220 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#ab8e737914200f075bf02ade85876764d" title = "Returns an enqueued message or NULL." > GetMessage< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00221" > < / a > 00221 < span class = "comment" > < / span >
< a name = "l00222" > < / a > 00222 < span class = "comment" > /**< / span >
< a name = "l00223" > < / a > 00223 < span class = "comment" > * @brief Releases the next message in queue with a reply.< / span >
< a name = "l00224" > < / a > 00224 < span class = "comment" > *< / span >
< a name = "l00225" > < / a > 00225 < span class = "comment" > * @param msg the answer message< / span >
< a name = "l00226" > < / a > 00226 < span class = "comment" > */< / span >
< a name = "l00227" > < / a > 00227 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a4ecedb2d2b646ea4a9261c0e62f16945" title = "Releases the next message in queue with a reply." > ReleaseMessage< / a > (< a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > msg);
< a name = "l00228" > < / a > 00228 < span class = "comment" > < / span >
< a name = "l00229" > < / a > 00229 < span class = "comment" > /**< / span >
< a name = "l00230" > < / a > 00230 < span class = "comment" > * @brief Returns true if there is at least one message in queue.< / span >
< a name = "l00231" > < / a > 00231 < span class = "comment" > *< / span >
< a name = "l00232" > < / a > 00232 < span class = "comment" > * @retval TRUE A message is waiting in queue.< / span >
< a name = "l00233" > < / a > 00233 < span class = "comment" > * @retval FALSE A message is not waiting in queue.< / span >
< a name = "l00234" > < / a > 00234 < span class = "comment" > */< / span >
< a name = "l00235" > < / a > 00235 < span class = "keyword" > static< / span > < span class = "keywordtype" > bool< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#a4477cb3ed6fc3250638bb21d8199f573" title = "Returns true if there is at least one message in queue." > IsPendingMessage< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00236" > < / a > 00236 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_MESSAGES */< / span >
< a name = "l00237" > < / a > 00237 < span class = "comment" > < / span >
< a name = "l00238" > < / a > 00238 < span class = "comment" > /**< / span >
< a name = "l00239" > < / a > 00239 < span class = "comment" > * @brief Thread body function.< / span >
< a name = "l00240" > < / a > 00240 < span class = "comment" > *< / span >
< a name = "l00241" > < / a > 00241 < span class = "comment" > * @return The exit message.< / span >
< a name = "l00242" > < / a > 00242 < span class = "comment" > */< / span >
< a name = "l00243" > < / a > 00243 < span class = "keyword" > virtual< / span > < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_base_thread.html#ae973df26215c254288eaf844c7eef637" title = "Thread body function." > Main< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00244" > < / a > 00244 };
< a name = "l00245" > < / a > 00245 < span class = "comment" > < / span >
< a name = "l00246" > < / a > 00246 < span class = "comment" > /**< / span >
< a name = "l00247" > < / a > 00247 < span class = "comment" > * @brief Enhanced threads template class.< / span >
< a name = "l00248" > < / a > 00248 < span class = "comment" > * @details This class introduces thread names and static working area< / span >
< a name = "l00249" > < / a > 00249 < span class = "comment" > * allocation.< / span >
< a name = "l00250" > < / a > 00250 < span class = "comment" > *< / span >
< a name = "l00251" > < / a > 00251 < span class = "comment" > * @param N the working area size for the thread class< / span >
< a name = "l00252" > < / a > 00252 < span class = "comment" > */< / span >
< a name = "l00253" > < / a > 00253 < span class = "keyword" > template< / span > < < span class = "keywordtype" > int< / span > N>
< a name = "l00254" > < / a > < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html" > 00254< / a > < span class = "keyword" > class < / span > < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html" title = "Enhanced threads template class." > EnhancedThread< / a > : < span class = "keyword" > public< / span > < a class = "code" href = "classchibios__rt_1_1_base_thread.html" title = "Base class for a ChibiOS/RT thread." > BaseThread< / a > {
< a name = "l00255" > < / a > 00255 < span class = "keyword" > protected< / span > :
< a name = "l00256" > < / a > 00256 WORKING_AREA(wa, N); < span class = "comment" > // Thread working area.< / span >
< a name = "l00257" > < / a > 00257
< a name = "l00258" > < / a > 00258 < span class = "keyword" > public< / span > :< span class = "comment" > < / span >
< a name = "l00259" > < / a > 00259 < span class = "comment" > /**< / span >
< a name = "l00260" > < / a > 00260 < span class = "comment" > * @brief The thread name.< / span >
< a name = "l00261" > < / a > 00261 < span class = "comment" > */< / span >
< a name = "l00262" > < / a > < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html#aedae7f14a5898fe3d1b992b43fea42d7" > 00262< / a > < span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > *< a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html#aedae7f14a5898fe3d1b992b43fea42d7" title = "The thread name." > name< / a > ;
< a name = "l00263" > < / a > 00263 < span class = "comment" > < / span >
< a name = "l00264" > < / a > 00264 < span class = "comment" > /**< / span >
< a name = "l00265" > < / a > 00265 < span class = "comment" > * @brief Full constructor.< / span >
< a name = "l00266" > < / a > 00266 < span class = "comment" > * @details This constructor allows to set a priority level for the new< / span >
< a name = "l00267" > < / a > 00267 < span class = "comment" > * thread.< / span >
< a name = "l00268" > < / a > 00268 < span class = "comment" > * @param tname the name to be assigned to the thread< / span >
< a name = "l00269" > < / a > 00269 < span class = "comment" > * @param prio the priority to be assigned to the thread< / span >
< a name = "l00270" > < / a > 00270 < span class = "comment" > */< / span >
< a name = "l00271" > < / a > < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html#a7c156a84f336ec4e51e06d7580f0fd24" > 00271< / a > < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html#a7c156a84f336ec4e51e06d7580f0fd24" title = "Full constructor." > EnhancedThread< / a > (< span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > *tname, < a class = "code" href = "group__types.html#ga5f2488ba73e5969cbc0f7033735374ee" title = "Priority, use the fastest unsigned type." > tprio_t< / a > prio) :
< a name = "l00272" > < / a > 00272 < a class = "code" href = "classchibios__rt_1_1_base_thread.html" title = "Base class for a ChibiOS/RT thread." > BaseThread< / a > (wa, sizeof wa, prio) {
< a name = "l00273" > < / a > 00273
< a name = "l00274" > < / a > 00274 < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html#aedae7f14a5898fe3d1b992b43fea42d7" title = "The thread name." > name< / a > = tname;
< a name = "l00275" > < / a > 00275 }
< a name = "l00276" > < / a > 00276 < span class = "comment" > < / span >
< a name = "l00277" > < / a > 00277 < span class = "comment" > /**< / span >
< a name = "l00278" > < / a > 00278 < span class = "comment" > * @brief Simplified constructor.< / span >
< a name = "l00279" > < / a > 00279 < span class = "comment" > * @details This constructor allows to create a thread by simply< / span >
< a name = "l00280" > < / a > 00280 < span class = "comment" > * specifying a name. In is assumed @p NORMALPRIO as initial priority.< / span >
< a name = "l00281" > < / a > 00281 < span class = "comment" > *< / span >
< a name = "l00282" > < / a > 00282 < span class = "comment" > * @param tname the name to be assigned to the thread< / span >
< a name = "l00283" > < / a > 00283 < span class = "comment" > */< / span >
< a name = "l00284" > < / a > < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html#a5ff174c6f7baef875efeb41670a1ab3a" > 00284< / a > < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html#a7c156a84f336ec4e51e06d7580f0fd24" title = "Full constructor." > EnhancedThread< / a > (< span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > *tname) :
< a name = "l00285" > < / a > 00285 < a class = "code" href = "classchibios__rt_1_1_base_thread.html" title = "Base class for a ChibiOS/RT thread." > BaseThread< / a > (wa, sizeof wa, < a class = "code" href = "group__scheduler.html#gad6a6b28f0c1cf8e0da714ef771fb90a0" title = "Normal user priority." > NORMALPRIO< / a > ) {
< a name = "l00286" > < / a > 00286
< a name = "l00287" > < / a > 00287 < a class = "code" href = "classchibios__rt_1_1_enhanced_thread.html#aedae7f14a5898fe3d1b992b43fea42d7" title = "The thread name." > name< / a > = tname;
< a name = "l00288" > < / a > 00288 }
< a name = "l00289" > < / a > 00289 };
< a name = "l00290" > < / a > 00290
< a name = "l00291" > < / a > 00291 < span class = "preprocessor" > #if CH_USE_SEMAPHORES< / span >
< a name = "l00292" > < / a > 00292 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00293" > < / a > 00293 < span class = "comment" > * @brief Class encapsulating a semaphore.< / span >
< a name = "l00294" > < / a > 00294 < span class = "comment" > */< / span >
< a name = "l00295" > < / a > < a class = "code" href = "classchibios__rt_1_1_semaphore.html" > 00295< / a > < span class = "keyword" > class < / span > < a class = "code" href = "classchibios__rt_1_1_semaphore.html" title = "Class encapsulating a semaphore." > Semaphore< / a > {
< a name = "l00296" > < / a > 00296 < span class = "keyword" > public< / span > :< span class = "comment" > < / span >
< a name = "l00297" > < / a > 00297 < span class = "comment" > /**< / span >
< a name = "l00298" > < / a > 00298 < span class = "comment" > * @brief Embedded @p ::Semaphore structure.< / span >
< a name = "l00299" > < / a > 00299 < span class = "comment" > */< / span >
< a name = "l00300" > < / a > < a class = "code" href = "classchibios__rt_1_1_semaphore.html#a604ce05f129534b4b3ad76366f2d90c5" > 00300< / a > < a class = "code" href = "group__semaphores.html#gac28c458b44903a8093398ef50333c513" title = "Semaphore structure." > struct ::Semaphore< / a > < a class = "code" href = "classchibios__rt_1_1_semaphore.html#a604ce05f129534b4b3ad76366f2d90c5" title = "Embedded Semaphore structure." > sem< / a > ;
< a name = "l00301" > < / a > 00301 < span class = "comment" > < / span >
< a name = "l00302" > < / a > 00302 < span class = "comment" > /**< / span >
< a name = "l00303" > < / a > 00303 < span class = "comment" > * @brief Semaphore constructor.< / span >
< a name = "l00304" > < / a > 00304 < span class = "comment" > * @details The embedded @p ::Semaphore structure is initialized.< / span >
< a name = "l00305" > < / a > 00305 < span class = "comment" > *< / span >
< a name = "l00306" > < / a > 00306 < span class = "comment" > * @param n the semaphore counter value, must be greater or equal to zero< / span >
< a name = "l00307" > < / a > 00307 < span class = "comment" > */< / span >
< a name = "l00308" > < / a > 00308 < a class = "code" href = "classchibios__rt_1_1_semaphore.html#a0804607c066a7a373188cb8220203f8f" title = "Semaphore constructor." > Semaphore< / a > (< a class = "code" href = "group__types.html#ga090b3bab5602157ebf706a44041dc05e" title = "Counter, recommended fastest signed." > cnt_t< / a > n);
< a name = "l00309" > < / a > 00309 < span class = "comment" > < / span >
< a name = "l00310" > < / a > 00310 < span class = "comment" > /**< / span >
< a name = "l00311" > < / a > 00311 < span class = "comment" > * @brief Resets a semaphore.< / span >
< a name = "l00312" > < / a > 00312 < span class = "comment" > *< / span >
< a name = "l00313" > < / a > 00313 < span class = "comment" > * @param n the new semaphore counter value, must be greater or equal to zero< / span >
< a name = "l00314" > < / a > 00314 < span class = "comment" > */< / span >
< a name = "l00315" > < / a > 00315 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_semaphore.html#aecb934714ebe5658c857ef1021dd5f2b" title = "Resets a semaphore." > Reset< / a > (< a class = "code" href = "group__types.html#ga090b3bab5602157ebf706a44041dc05e" title = "Counter, recommended fastest signed." > cnt_t< / a > n);
< a name = "l00316" > < / a > 00316 < span class = "comment" > < / span >
< a name = "l00317" > < / a > 00317 < span class = "comment" > /**< / span >
< a name = "l00318" > < / a > 00318 < span class = "comment" > * @brief Wait operation on the semaphore.< / span >
< a name = "l00319" > < / a > 00319 < span class = "comment" > *< / span >
< a name = "l00320" > < / a > 00320 < span class = "comment" > * @retval RDY_OK if the semaphore was signaled or not taken.< / span >
< a name = "l00321" > < / a > 00321 < span class = "comment" > * @retval RDY_RESET if the semaphore was reset.< / span >
< a name = "l00322" > < / a > 00322 < span class = "comment" > */< / span >
< a name = "l00323" > < / a > 00323 < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_semaphore.html#abfb1b068e95063f490b27cc3b467f63f" title = "Wait operation on the semaphore." > Wait< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00324" > < / a > 00324 < span class = "comment" > < / span >
< a name = "l00325" > < / a > 00325 < span class = "comment" > /**< / span >
< a name = "l00326" > < / a > 00326 < span class = "comment" > * @brief Wait operation on the semaphore with timeout.< / span >
< a name = "l00327" > < / a > 00327 < span class = "comment" > *< / span >
< a name = "l00328" > < / a > 00328 < span class = "comment" > * @param time the number of ticks before the operation fails< / span >
< a name = "l00329" > < / a > 00329 < span class = "comment" > * @retval RDY_OK if the semaphore was signaled or not taken.< / span >
< a name = "l00330" > < / a > 00330 < span class = "comment" > * @retval RDY_RESET if the semaphore was reset.< / span >
< a name = "l00331" > < / a > 00331 < span class = "comment" > * @retval RDY_TIMEOUT if the semaphore was not signaled or reset within the< / span >
< a name = "l00332" > < / a > 00332 < span class = "comment" > * specified timeout.< / span >
< a name = "l00333" > < / a > 00333 < span class = "comment" > */< / span >
< a name = "l00334" > < / a > 00334 < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_semaphore.html#a589b4780f60d73929bd77a652b526868" title = "Wait operation on the semaphore with timeout." > WaitTimeout< / a > (< a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > time);
< a name = "l00335" > < / a > 00335 < span class = "comment" > < / span >
< a name = "l00336" > < / a > 00336 < span class = "comment" > /**< / span >
< a name = "l00337" > < / a > 00337 < span class = "comment" > * @brief Signal operation on the semaphore.< / span >
< a name = "l00338" > < / a > 00338 < span class = "comment" > * @details The semaphore is signaled, the next thread in queue, if any,< / span >
< a name = "l00339" > < / a > 00339 < span class = "comment" > * is awakened.< / span >
< a name = "l00340" > < / a > 00340 < span class = "comment" > */< / span >
< a name = "l00341" > < / a > 00341 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_semaphore.html#a202630db53afefbe5c419ee6d2eddab1" title = "Signal operation on the semaphore." > Signal< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00342" > < / a > 00342
< a name = "l00343" > < / a > 00343 < span class = "preprocessor" > #if CH_USE_SEMSW< / span >
< a name = "l00344" > < / a > 00344 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00345" > < / a > 00345 < span class = "comment" > * @brief Atomic signal and wait operations.< / span >
< a name = "l00346" > < / a > 00346 < span class = "comment" > *< / span >
< a name = "l00347" > < / a > 00347 < span class = "comment" > * @param ssem pointer to a @p Semaphore to be signaled< / span >
< a name = "l00348" > < / a > 00348 < span class = "comment" > * @param wsem pointer to a @p Semaphore to be wait on< / span >
< a name = "l00349" > < / a > 00349 < span class = "comment" > * @retval RDY_OK if the semaphore was signaled or not taken.< / span >
< a name = "l00350" > < / a > 00350 < span class = "comment" > * @retval RDY_RESET if the semaphore was reset.< / span >
< a name = "l00351" > < / a > 00351 < span class = "comment" > */< / span >
< a name = "l00352" > < / a > 00352 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_semaphore.html#a3f2ad5962e43c82fc56b1e0e76a58c9a" title = "Atomic signal and wait operations." > SignalWait< / a > (< a class = "code" href = "classchibios__rt_1_1_semaphore.html" title = "Class encapsulating a semaphore." > Semaphore< / a > *ssem, < a class = "code" href = "classchibios__rt_1_1_semaphore.html" title = "Class encapsulating a semaphore." > Semaphore< / a > *wsem);
< a name = "l00353" > < / a > 00353 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_SEMSW */< / span >
< a name = "l00354" > < / a > 00354 };
< a name = "l00355" > < / a > 00355 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_SEMAPHORES */< / span >
< a name = "l00356" > < / a > 00356
< a name = "l00357" > < / a > 00357 < span class = "preprocessor" > #if CH_USE_MUTEXES< / span >
< a name = "l00358" > < / a > 00358 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00359" > < / a > 00359 < span class = "comment" > * @brief Class encapsulating a mutex.< / span >
< a name = "l00360" > < / a > 00360 < span class = "comment" > */< / span >
< a name = "l00361" > < / a > < a class = "code" href = "classchibios__rt_1_1_mutex.html" > 00361< / a > < span class = "keyword" > class < / span > < a class = "code" href = "classchibios__rt_1_1_mutex.html" title = "Class encapsulating a mutex." > Mutex< / a > {
< a name = "l00362" > < / a > 00362 < span class = "keyword" > public< / span > :< span class = "comment" > < / span >
< a name = "l00363" > < / a > 00363 < span class = "comment" > /**< / span >
< a name = "l00364" > < / a > 00364 < span class = "comment" > * @brief Embedded @p ::Mutex structure.< / span >
< a name = "l00365" > < / a > 00365 < span class = "comment" > */< / span >
< a name = "l00366" > < / a > < a class = "code" href = "classchibios__rt_1_1_mutex.html#a6fe411dfe88642cc7c379a59ea931da2" > 00366< / a > < a class = "code" href = "group__mutexes.html#ga9b2dfabf6db35faa7fd04ea30834012d" title = "Mutex structure." > struct ::Mutex< / a > < a class = "code" href = "classchibios__rt_1_1_mutex.html#a6fe411dfe88642cc7c379a59ea931da2" title = "Embedded Mutex structure." > mutex< / a > ;
< a name = "l00367" > < / a > 00367 < span class = "comment" > < / span >
< a name = "l00368" > < / a > 00368 < span class = "comment" > /**< / span >
< a name = "l00369" > < / a > 00369 < span class = "comment" > * @brief Mutex constructor.< / span >
< a name = "l00370" > < / a > 00370 < span class = "comment" > * @details The embedded @p ::Mutex structure is initialized.< / span >
< a name = "l00371" > < / a > 00371 < span class = "comment" > */< / span >
< a name = "l00372" > < / a > 00372 < a class = "code" href = "classchibios__rt_1_1_mutex.html#a00b2ff557451955a905ecdca2855389b" title = "Mutex constructor." > Mutex< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00373" > < / a > 00373 < span class = "comment" > < / span >
< a name = "l00374" > < / a > 00374 < span class = "comment" > /**< / span >
< a name = "l00375" > < / a > 00375 < span class = "comment" > * @brief Tries a lock operation on the mutex.< / span >
< a name = "l00376" > < / a > 00376 < span class = "comment" > * @retval TRUE if the mutex was successfully acquired< / span >
< a name = "l00377" > < / a > 00377 < span class = "comment" > * @retval FALSE if the lock attempt failed.< / span >
< a name = "l00378" > < / a > 00378 < span class = "comment" > */< / span >
< a name = "l00379" > < / a > 00379 < span class = "keywordtype" > bool< / span > < a class = "code" href = "classchibios__rt_1_1_mutex.html#a787ecfd207fd25760a3c07517b69c148" title = "Tries a lock operation on the mutex." > TryLock< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00380" > < / a > 00380 < span class = "comment" > < / span >
< a name = "l00381" > < / a > 00381 < span class = "comment" > /**< / span >
< a name = "l00382" > < / a > 00382 < span class = "comment" > * @brief Locks the mutex.< / span >
< a name = "l00383" > < / a > 00383 < span class = "comment" > * @details Performs a lock operation on the mutex, if the mutex is< / span >
< a name = "l00384" > < / a > 00384 < span class = "comment" > * already locked then the thread enters the mutex priority queue and< / span >
< a name = "l00385" > < / a > 00385 < span class = "comment" > * waits.< / span >
< a name = "l00386" > < / a > 00386 < span class = "comment" > */< / span >
< a name = "l00387" > < / a > 00387 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_mutex.html#a1726d7244983f7be74fcfa9cfb63745f" title = "Locks the mutex." > Lock< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00388" > < / a > 00388 < span class = "comment" > < / span >
< a name = "l00389" > < / a > 00389 < span class = "comment" > /**< / span >
< a name = "l00390" > < / a > 00390 < span class = "comment" > * @brief Unlocks the mutex.< / span >
< a name = "l00391" > < / a > 00391 < span class = "comment" > * @details Performs an unlock operation on the mutex, the next waiting< / span >
< a name = "l00392" > < / a > 00392 < span class = "comment" > * thread, if any, is resumed and locks the mutex.< / span >
< a name = "l00393" > < / a > 00393 < span class = "comment" > */< / span >
< a name = "l00394" > < / a > 00394 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_mutex.html#a03150e8fa423f7e042661d350d238b84" title = "Unlocks the mutex." > Unlock< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00395" > < / a > 00395 < span class = "comment" > < / span >
< a name = "l00396" > < / a > 00396 < span class = "comment" > /**< / span >
< a name = "l00397" > < / a > 00397 < span class = "comment" > * @brief Unlocks all the mutexes owned by the invoking thread.< / span >
< a name = "l00398" > < / a > 00398 < span class = "comment" > * @details This operation is < b> MUCH MORE< /b> efficient than releasing< / span >
< a name = "l00399" > < / a > 00399 < span class = "comment" > * the mutexes one by one and not just because the call overhead, this< / span >
< a name = "l00400" > < / a > 00400 < span class = "comment" > * function does not have any overhead related to the priority inheritance< / span >
< a name = "l00401" > < / a > 00401 < span class = "comment" > * mechanism.< / span >
< a name = "l00402" > < / a > 00402 < span class = "comment" > */< / span >
< a name = "l00403" > < / a > 00403 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_mutex.html#ac149b2a2e188a1c00d1726671338b39d" title = "Unlocks all the mutexes owned by the invoking thread." > UnlockAll< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00404" > < / a > 00404 };
< a name = "l00405" > < / a > 00405
< a name = "l00406" > < / a > 00406 < span class = "preprocessor" > #if CH_USE_CONDVARS< / span >
< a name = "l00407" > < / a > 00407 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00408" > < / a > 00408 < span class = "comment" > * @brief Class encapsulating a conditional variable.< / span >
< a name = "l00409" > < / a > 00409 < span class = "comment" > */< / span >
< a name = "l00410" > < / a > < a class = "code" href = "classchibios__rt_1_1_cond_var.html" > 00410< / a > < span class = "keyword" > class < / span > < a class = "code" href = "classchibios__rt_1_1_cond_var.html" title = "Class encapsulating a conditional variable." > CondVar< / a > {
< a name = "l00411" > < / a > 00411 < span class = "keyword" > public< / span > :< span class = "comment" > < / span >
< a name = "l00412" > < / a > 00412 < span class = "comment" > /**< / span >
< a name = "l00413" > < / a > 00413 < span class = "comment" > * @brief Embedded @p ::CondVar structure.< / span >
< a name = "l00414" > < / a > 00414 < span class = "comment" > */< / span >
< a name = "l00415" > < / a > < a class = "code" href = "classchibios__rt_1_1_cond_var.html#a726124b6782ea9e073d6be739ad75f53" > 00415< / a > < a class = "code" href = "group__condvars.html#gae0fef080503c53ea65ef634f665ae06a" title = "CondVar structure." > struct ::CondVar< / a > < a class = "code" href = "classchibios__rt_1_1_cond_var.html#a726124b6782ea9e073d6be739ad75f53" title = "Embedded CondVar structure." > condvar< / a > ;
< a name = "l00416" > < / a > 00416 < span class = "comment" > < / span >
< a name = "l00417" > < / a > 00417 < span class = "comment" > /**< / span >
< a name = "l00418" > < / a > 00418 < span class = "comment" > * @brief CondVar constructor.< / span >
< a name = "l00419" > < / a > 00419 < span class = "comment" > * @details The embedded @p ::CondVar structure is initialized.< / span >
< a name = "l00420" > < / a > 00420 < span class = "comment" > */< / span >
< a name = "l00421" > < / a > 00421 < a class = "code" href = "classchibios__rt_1_1_cond_var.html#a1b9e183dd1c97f1a0104f57f47197ecc" title = "CondVar constructor." > CondVar< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00422" > < / a > 00422 < span class = "comment" > < / span >
< a name = "l00423" > < / a > 00423 < span class = "comment" > /**< / span >
< a name = "l00424" > < / a > 00424 < span class = "comment" > * @brief Signals the CondVar.< / span >
< a name = "l00425" > < / a > 00425 < span class = "comment" > * @details The next thread waiting on the @p CondVar, if any, is awakened.< / span >
< a name = "l00426" > < / a > 00426 < span class = "comment" > */< / span >
< a name = "l00427" > < / a > 00427 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_cond_var.html#a075c5724485b6f47bdf6f1f003154f02" title = "Signals the CondVar." > Signal< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00428" > < / a > 00428 < span class = "comment" > < / span >
< a name = "l00429" > < / a > 00429 < span class = "comment" > /**< / span >
< a name = "l00430" > < / a > 00430 < span class = "comment" > * @brief Broadcasts the CondVar.< / span >
< a name = "l00431" > < / a > 00431 < span class = "comment" > * @details All the threads waiting on the @p CondVar, if any, are awakened.< / span >
< a name = "l00432" > < / a > 00432 < span class = "comment" > */< / span >
< a name = "l00433" > < / a > 00433 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_cond_var.html#a0111c4947178c9ef6b15e03f24d2e861" title = "Broadcasts the CondVar." > Broadcast< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00434" > < / a > 00434 < span class = "comment" > < / span >
< a name = "l00435" > < / a > 00435 < span class = "comment" > /**< / span >
< a name = "l00436" > < / a > 00436 < span class = "comment" > * @brief Waits on the CondVar while releasing the controlling mutex.< / span >
< a name = "l00437" > < / a > 00437 < span class = "comment" > *< / span >
< a name = "l00438" > < / a > 00438 < span class = "comment" > * @return The wakep mode.< / span >
< a name = "l00439" > < / a > 00439 < span class = "comment" > * @retval RDY_OK if the condvar was signaled using chCondSignal().< / span >
< a name = "l00440" > < / a > 00440 < span class = "comment" > * @retval RDY_RESET if the condvar was signaled using chCondBroadcast().< / span >
< a name = "l00441" > < / a > 00441 < span class = "comment" > */< / span >
< a name = "l00442" > < / a > 00442 < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_cond_var.html#a37e0b0cb4ac5cbe6bbb56c51539284c8" title = "Waits on the CondVar while releasing the controlling mutex." > Wait< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00443" > < / a > 00443
< a name = "l00444" > < / a > 00444 < span class = "preprocessor" > #if CH_USE_CONDVARS_TIMEOUT< / span >
< a name = "l00445" > < / a > 00445 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00446" > < / a > 00446 < span class = "comment" > * @brief Waits on the CondVar while releasing the controlling mutex.< / span >
< a name = "l00447" > < / a > 00447 < span class = "comment" > *< / span >
< a name = "l00448" > < / a > 00448 < span class = "comment" > * @param time the number of ticks before the operation fails< / span >
< a name = "l00449" > < / a > 00449 < span class = "comment" > * @return The wakep mode.< / span >
< a name = "l00450" > < / a > 00450 < span class = "comment" > * @retval RDY_OK if the condvar was signaled using chCondSignal().< / span >
< a name = "l00451" > < / a > 00451 < span class = "comment" > * @retval RDY_RESET if the condvar was signaled using chCondBroadcast().< / span >
< a name = "l00452" > < / a > 00452 < span class = "comment" > * @retval RDY_TIMEOUT if the condvar was not signaled within the specified< / span >
< a name = "l00453" > < / a > 00453 < span class = "comment" > * timeout.< / span >
< a name = "l00454" > < / a > 00454 < span class = "comment" > */< / span >
< a name = "l00455" > < / a > 00455 < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "classchibios__rt_1_1_cond_var.html#a866a352fb3bc95f07abda728d4ae4906" title = "Waits on the CondVar while releasing the controlling mutex." > WaitTimeout< / a > (< a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > time);
< a name = "l00456" > < / a > 00456 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_CONDVARS_TIMEOUT */< / span >
< a name = "l00457" > < / a > 00457 };
< a name = "l00458" > < / a > 00458 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_CONDVARS */< / span >
< a name = "l00459" > < / a > 00459 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_MUTEXES */< / span >
< a name = "l00460" > < / a > 00460
< a name = "l00461" > < / a > 00461 < span class = "preprocessor" > #if CH_USE_EVENTS< / span >
< a name = "l00462" > < / a > 00462 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00463" > < / a > 00463 < span class = "comment" > * @brief Class encapsulating an event source.< / span >
< a name = "l00464" > < / a > 00464 < span class = "comment" > */< / span >
< a name = "l00465" > < / a > < a class = "code" href = "classchibios__rt_1_1_event.html" > 00465< / a > < span class = "keyword" > class < / span > < a class = "code" href = "classchibios__rt_1_1_event.html" title = "Class encapsulating an event source." > Event< / a > {
< a name = "l00466" > < / a > 00466 < span class = "keyword" > public< / span > :< span class = "comment" > < / span >
< a name = "l00467" > < / a > 00467 < span class = "comment" > /**< / span >
< a name = "l00468" > < / a > 00468 < span class = "comment" > * @brief Embedded @p ::EventSource structure.< / span >
< a name = "l00469" > < / a > 00469 < span class = "comment" > */< / span >
< a name = "l00470" > < / a > < a class = "code" href = "classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508" > 00470< / a > < a class = "code" href = "group__events.html#ga19ef0b2769d1df4d22250135a6de57b8" title = "Event Source structure." > struct ::EventSource< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#a39ab1be709273f81cd1f9318abfe1508" title = "Embedded EventSource structure." > event< / a > ;
< a name = "l00471" > < / a > 00471 < span class = "comment" > < / span >
< a name = "l00472" > < / a > 00472 < span class = "comment" > /**< / span >
< a name = "l00473" > < / a > 00473 < span class = "comment" > * @brief Event constructor.< / span >
< a name = "l00474" > < / a > 00474 < span class = "comment" > * @details The embedded @p ::EventSource structure is initialized.< / span >
< a name = "l00475" > < / a > 00475 < span class = "comment" > */< / span >
< a name = "l00476" > < / a > 00476 < a class = "code" href = "classchibios__rt_1_1_event.html#a4fad1d076cd31e2add80447f7980d8d2" title = "Event constructor." > Event< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00477" > < / a > 00477 < span class = "comment" > < / span >
< a name = "l00478" > < / a > 00478 < span class = "comment" > /**< / span >
< a name = "l00479" > < / a > 00479 < span class = "comment" > * @brief Registers a listener on the event source.< / span >
< a name = "l00480" > < / a > 00480 < span class = "comment" > *< / span >
< a name = "l00481" > < / a > 00481 < span class = "comment" > * @param elp pointer to the @p EventListener structure< / span >
< a name = "l00482" > < / a > 00482 < span class = "comment" > * @param eid numeric identifier assigned to the Event Listener< / span >
< a name = "l00483" > < / a > 00483 < span class = "comment" > */< / span >
< a name = "l00484" > < / a > 00484 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_event.html#a871e59df8f46225845806ebdec4e832c" title = "Registers a listener on the event source." > Register< / a > (< a class = "code" href = "struct_event_listener.html" title = "Event Listener structure." > EventListener< / a > *elp, < a class = "code" href = "group__types.html#gada5ed33935b8347e213aeb76582642e7" title = "Event Id, use fastest signed." > eventid_t< / a > eid);
< a name = "l00485" > < / a > 00485 < span class = "comment" > < / span >
< a name = "l00486" > < / a > 00486 < span class = "comment" > /**< / span >
< a name = "l00487" > < / a > 00487 < span class = "comment" > * @brief Registers an Event Listener on an Event Source.< / span >
< a name = "l00488" > < / a > 00488 < span class = "comment" > *< / span >
< a name = "l00489" > < / a > 00489 < span class = "comment" > * @param elp pointer to the @p EventListener structure< / span >
< a name = "l00490" > < / a > 00490 < span class = "comment" > * @param emask the mask of event flags to be pended to the thread when the< / span >
< a name = "l00491" > < / a > 00491 < span class = "comment" > * event source is broadcasted< / span >
< a name = "l00492" > < / a > 00492 < span class = "comment" > * @note Multiple Event Listeners can specify the same bits to be pended.< / span >
< a name = "l00493" > < / a > 00493 < span class = "comment" > */< / span >
< a name = "l00494" > < / a > 00494 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_event.html#a39acaf2436f139a798973308c1929031" title = "Registers an Event Listener on an Event Source." > RegisterMask< / a > (< a class = "code" href = "struct_event_listener.html" title = "Event Listener structure." > EventListener< / a > *elp, < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > emask);
< a name = "l00495" > < / a > 00495 < span class = "comment" > < / span >
< a name = "l00496" > < / a > 00496 < span class = "comment" > /**< / span >
< a name = "l00497" > < / a > 00497 < span class = "comment" > * @brief Unregisters a listener.< / span >
< a name = "l00498" > < / a > 00498 < span class = "comment" > * @details The specified listeners is no more signaled by the event< / span >
< a name = "l00499" > < / a > 00499 < span class = "comment" > * source.< / span >
< a name = "l00500" > < / a > 00500 < span class = "comment" > *< / span >
< a name = "l00501" > < / a > 00501 < span class = "comment" > * @param elp the listener to be unregistered< / span >
< a name = "l00502" > < / a > 00502 < span class = "comment" > */< / span >
< a name = "l00503" > < / a > 00503 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_event.html#a177bc72df220068c9d620b8e9f42f2f5" title = "Unregisters a listener." > Unregister< / a > (< a class = "code" href = "struct_event_listener.html" title = "Event Listener structure." > EventListener< / a > *elp);
< a name = "l00504" > < / a > 00504 < span class = "comment" > < / span >
< a name = "l00505" > < / a > 00505 < span class = "comment" > /**< / span >
< a name = "l00506" > < / a > 00506 < span class = "comment" > * @brief Broadcasts an event.< / span >
< a name = "l00507" > < / a > 00507 < span class = "comment" > * @details All the listeners registered on the event source are signaled.< / span >
< a name = "l00508" > < / a > 00508 < span class = "comment" > */< / span >
< a name = "l00509" > < / a > 00509 < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_event.html#a665b23d0d212b06107a27f118021238c" title = "Broadcasts an event." > Broadcast< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00510" > < / a > 00510 < span class = "comment" > < / span >
< a name = "l00511" > < / a > 00511 < span class = "comment" > /**< / span >
< a name = "l00512" > < / a > 00512 < span class = "comment" > * @brief Clears specified events from the pending events mask.< / span >
< a name = "l00513" > < / a > 00513 < span class = "comment" > *< / span >
< a name = "l00514" > < / a > 00514 < span class = "comment" > * @param mask the events to be cleared< / span >
< a name = "l00515" > < / a > 00515 < span class = "comment" > * @return The pending events that were cleared.< / span >
< a name = "l00516" > < / a > 00516 < span class = "comment" > */< / span >
< a name = "l00517" > < / a > 00517 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#ae3c7092d78ac9dda43c109b356826f41" title = "Clears specified events from the pending events mask." > Clear< / a > (< a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > mask);
< a name = "l00518" > < / a > 00518 < span class = "comment" > < / span >
< a name = "l00519" > < / a > 00519 < span class = "comment" > /**< / span >
< a name = "l00520" > < / a > 00520 < span class = "comment" > * @brief Makes an events mask pending in the current thread.< / span >
< a name = "l00521" > < / a > 00521 < span class = "comment" > * @details This functon is @b much faster than using @p Broadcast().< / span >
< a name = "l00522" > < / a > 00522 < span class = "comment" > *< / span >
< a name = "l00523" > < / a > 00523 < span class = "comment" > * @param mask the events to be pended< / span >
< a name = "l00524" > < / a > 00524 < span class = "comment" > * @return The current pending events mask.< / span >
< a name = "l00525" > < / a > 00525 < span class = "comment" > */< / span >
< a name = "l00526" > < / a > 00526 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#aca48258fbffb54c6e19bbb9016c4cee1" title = "Makes an events mask pending in the current thread." > Pend< / a > (< a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > mask);
< a name = "l00527" > < / a > 00527 < span class = "comment" > < / span >
< a name = "l00528" > < / a > 00528 < span class = "comment" > /**< / span >
< a name = "l00529" > < / a > 00529 < span class = "comment" > * @brief Invokes the event handlers associated with a mask.< / span >
< a name = "l00530" > < / a > 00530 < span class = "comment" > *< / span >
< a name = "l00531" > < / a > 00531 < span class = "comment" > * @param mask mask of the events to be dispatched< / span >
< a name = "l00532" > < / a > 00532 < span class = "comment" > * @param handlers an array of @p evhandler_t. The array must be< / span >
< a name = "l00533" > < / a > 00533 < span class = "comment" > * have indexes from zero up the higher registered event< / span >
< a name = "l00534" > < / a > 00534 < span class = "comment" > * identifier.< / span >
< a name = "l00535" > < / a > 00535 < span class = "comment" > */< / span >
< a name = "l00536" > < / a > 00536 < span class = "keyword" > static< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "classchibios__rt_1_1_event.html#afde2cfb76dbd552ebb05bc6c6c8b2969" title = "Invokes the event handlers associated with a mask." > Dispatch< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "group__events.html#ga1a153010620569dd0cac24da8952269f" title = "Event Handler callback function." > evhandler_t< / a > handlers[], < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > mask);
< a name = "l00537" > < / a > 00537 < span class = "comment" > < / span >
< a name = "l00538" > < / a > 00538 < span class = "comment" > /**< / span >
< a name = "l00539" > < / a > 00539 < span class = "comment" > * @brief Waits for a single event.< / span >
< a name = "l00540" > < / a > 00540 < span class = "comment" > * @details A pending event among those specified in @p ewmask is selected,< / span >
< a name = "l00541" > < / a > 00541 < span class = "comment" > * cleared and its mask returned.< / span >
< a name = "l00542" > < / a > 00542 < span class = "comment" > *< / span >
< a name = "l00543" > < / a > 00543 < span class = "comment" > * @param ewmask mask of the events that the function should wait for,< / span >
< a name = "l00544" > < / a > 00544 < span class = "comment" > * @p ALL_EVENTS enables all the events< / span >
< a name = "l00545" > < / a > 00545 < span class = "comment" > * @return The mask of the lowest id served and cleared event.< / span >
< a name = "l00546" > < / a > 00546 < span class = "comment" > * @note One and only one event is served in the function, the one with the< / span >
< a name = "l00547" > < / a > 00547 < span class = "comment" > * lowest event id. The function is meant to be invoked into a loop in< / span >
< a name = "l00548" > < / a > 00548 < span class = "comment" > * order to serve all the pending events.< br> < / span >
< a name = "l00549" > < / a > 00549 < span class = "comment" > * This means that Event Listeners with a lower event identifier have< / span >
< a name = "l00550" > < / a > 00550 < span class = "comment" > * an higher priority.< / span >
< a name = "l00551" > < / a > 00551 < span class = "comment" > */< / span >
< a name = "l00552" > < / a > 00552 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#a5853ef97699efe31a969c7fc200e09a1" title = "Waits for a single event." > WaitOne< / a > (< a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > ewmask);
< a name = "l00553" > < / a > 00553 < span class = "comment" > < / span >
< a name = "l00554" > < / a > 00554 < span class = "comment" > /**< / span >
< a name = "l00555" > < / a > 00555 < span class = "comment" > * @brief Waits for any of the specified events.< / span >
< a name = "l00556" > < / a > 00556 < span class = "comment" > * @details The function waits for any event among those specified in< / span >
< a name = "l00557" > < / a > 00557 < span class = "comment" > * @p ewmask to become pending then the events are cleared and returned.< / span >
< a name = "l00558" > < / a > 00558 < span class = "comment" > *< / span >
< a name = "l00559" > < / a > 00559 < span class = "comment" > * @param ewmask mask of the events that the function should wait for,< / span >
< a name = "l00560" > < / a > 00560 < span class = "comment" > * @p ALL_EVENTS enables all the events< / span >
< a name = "l00561" > < / a > 00561 < span class = "comment" > * @return The mask of the served and cleared events.< / span >
< a name = "l00562" > < / a > 00562 < span class = "comment" > */< / span >
< a name = "l00563" > < / a > 00563 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#aeb53e2435cf8f614ea51e3c90334d5ae" title = "Waits for any of the specified events." > WaitAny< / a > (< a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > ewmask);
< a name = "l00564" > < / a > 00564 < span class = "comment" > < / span >
< a name = "l00565" > < / a > 00565 < span class = "comment" > /**< / span >
< a name = "l00566" > < / a > 00566 < span class = "comment" > * @brief Waits for all the specified event flags then clears them.< / span >
< a name = "l00567" > < / a > 00567 < span class = "comment" > * @details The function waits for all the events specified in @p ewmask< / span >
< a name = "l00568" > < / a > 00568 < span class = "comment" > * to become pending then the events are cleared and returned.< / span >
< a name = "l00569" > < / a > 00569 < span class = "comment" > *< / span >
< a name = "l00570" > < / a > 00570 < span class = "comment" > * @param ewmask mask of the event ids that the function should wait for< / span >
< a name = "l00571" > < / a > 00571 < span class = "comment" > * @return The mask of the served and cleared events.< / span >
< a name = "l00572" > < / a > 00572 < span class = "comment" > */< / span >
< a name = "l00573" > < / a > 00573 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#a55bd3220048e77217f5f75af7697d46f" title = "Waits for all the specified event flags then clears them." > WaitAll< / a > (< a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > ewmask);
< a name = "l00574" > < / a > 00574
< a name = "l00575" > < / a > 00575 < span class = "preprocessor" > #if CH_USE_EVENTS_TIMEOUT< / span >
< a name = "l00576" > < / a > 00576 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00577" > < / a > 00577 < span class = "comment" > * @brief Waits for a single event.< / span >
< a name = "l00578" > < / a > 00578 < span class = "comment" > * @details A pending event among those specified in @p ewmask is selected,< / span >
< a name = "l00579" > < / a > 00579 < span class = "comment" > * cleared and its mask returned.< / span >
< a name = "l00580" > < / a > 00580 < span class = "comment" > * @param ewmask mask of the events that the function should wait for,< / span >
< a name = "l00581" > < / a > 00581 < span class = "comment" > * @p ALL_EVENTS enables all the events< / span >
< a name = "l00582" > < / a > 00582 < span class = "comment" > * @param time the number of ticks before the operation timouts< / span >
< a name = "l00583" > < / a > 00583 < span class = "comment" > * @return The mask of the lowest id served and cleared event.< / span >
< a name = "l00584" > < / a > 00584 < span class = "comment" > * @retval 0 if the specified timeout expired.< / span >
< a name = "l00585" > < / a > 00585 < span class = "comment" > * @note One and only one event is served in the function, the one with the< / span >
< a name = "l00586" > < / a > 00586 < span class = "comment" > * lowest event id. The function is meant to be invoked into a loop in< / span >
< a name = "l00587" > < / a > 00587 < span class = "comment" > * order to serve all the pending events.< br> < / span >
< a name = "l00588" > < / a > 00588 < span class = "comment" > * This means that Event Listeners with a lower event identifier have< / span >
< a name = "l00589" > < / a > 00589 < span class = "comment" > * an higher priority.< / span >
< a name = "l00590" > < / a > 00590 < span class = "comment" > */< / span >
< a name = "l00591" > < / a > 00591 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#ab8fc502561437fec0194653052202b82" title = "Waits for a single event." > WaitOneTimeout< / a > (< a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > ewmask, < a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > time);
< a name = "l00592" > < / a > 00592 < span class = "comment" > < / span >
< a name = "l00593" > < / a > 00593 < span class = "comment" > /**< / span >
< a name = "l00594" > < / a > 00594 < span class = "comment" > * @brief Waits for any of the specified events.< / span >
< a name = "l00595" > < / a > 00595 < span class = "comment" > * @details The function waits for any event among those specified in< / span >
< a name = "l00596" > < / a > 00596 < span class = "comment" > * @p ewmask to become pending then the events are cleared and returned.< / span >
< a name = "l00597" > < / a > 00597 < span class = "comment" > *< / span >
< a name = "l00598" > < / a > 00598 < span class = "comment" > * @param ewmask mask of the events that the function should wait for,< / span >
< a name = "l00599" > < / a > 00599 < span class = "comment" > * @p ALL_EVENTS enables all the events< / span >
< a name = "l00600" > < / a > 00600 < span class = "comment" > * @param time the number of ticks before the operation timouts< / span >
< a name = "l00601" > < / a > 00601 < span class = "comment" > * @return The mask of the served and cleared events.< / span >
< a name = "l00602" > < / a > 00602 < span class = "comment" > * @retval 0 if the specified timeout expired.< / span >
< a name = "l00603" > < / a > 00603 < span class = "comment" > */< / span >
< a name = "l00604" > < / a > 00604 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#a4870dfce1f2ace0ab434718b0960b960" title = "Waits for any of the specified events." > WaitAnyTimeout< / a > (< a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > ewmask, < a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > time);
< a name = "l00605" > < / a > 00605 < span class = "comment" > < / span >
< a name = "l00606" > < / a > 00606 < span class = "comment" > /**< / span >
< a name = "l00607" > < / a > 00607 < span class = "comment" > * @brief Waits for all the specified event flags then clears them.< / span >
< a name = "l00608" > < / a > 00608 < span class = "comment" > * @details The function waits for all the events specified in @p ewmask< / span >
< a name = "l00609" > < / a > 00609 < span class = "comment" > * to become pending then the events are cleared and returned.< / span >
< a name = "l00610" > < / a > 00610 < span class = "comment" > *< / span >
< a name = "l00611" > < / a > 00611 < span class = "comment" > * @param ewmask mask of the event ids that the function should wait for< / span >
< a name = "l00612" > < / a > 00612 < span class = "comment" > * @param time the number of ticks before the operation timouts< / span >
< a name = "l00613" > < / a > 00613 < span class = "comment" > * @return The mask of the served and cleared events.< / span >
< a name = "l00614" > < / a > 00614 < span class = "comment" > * @retval 0 if the specified timeout expired.< / span >
< a name = "l00615" > < / a > 00615 < span class = "comment" > */< / span >
< a name = "l00616" > < / a > 00616 < span class = "keyword" > static< / span > < a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > < a class = "code" href = "classchibios__rt_1_1_event.html#ab8c805f6b615e47050a75b16fd94492d" title = "Waits for all the specified event flags then clears them." > WaitAllTimeout< / a > (< a class = "code" href = "group__types.html#gabff0c32475baf20ea8c5c710d6e8b708" title = "Event Mask, recommended fastest unsigned." > eventmask_t< / a > ewmask, < a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > time);
< a name = "l00617" > < / a > 00617
< a name = "l00618" > < / a > 00618 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_EVENTS_TIMEOUT */< / span >
< a name = "l00619" > < / a > 00619 };
< a name = "l00620" > < / a > 00620 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_USE_EVENTS */< / span >
< a name = "l00621" > < / a > 00621 }
< a name = "l00622" > < / a > 00622
< a name = "l00623" > < / a > 00623 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _CH_HPP_ */< / span >
< a name = "l00624" > < / a > 00624 < span class = "comment" > < / span >
< a name = "l00625" > < / a > 00625 < 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-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:48 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 >
2010-08-10 03:11:02 +00:00
< / body >
< / html >