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: chconf.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 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 > chconf.h< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "chconf_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 < 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 templates/chconf.h< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief Configuration file template.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > * @details A copy of this file must be placed in each project directory, it< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * contains the application specific kernel settings.< / span >
< a name = "l00032" > < / a > 00032 < span class = "comment" > *< / span >
< a name = "l00033" > < / a > 00033 < span class = "comment" > * @addtogroup config< / span >
< a name = "l00034" > < / a > 00034 < span class = "comment" > * @details Kernel related settings and hooks.< / span >
< a name = "l00035" > < / a > 00035 < span class = "comment" > * @{< / span >
< a name = "l00036" > < / a > 00036 < span class = "comment" > */< / span >
< a name = "l00037" > < / a > 00037
< a name = "l00038" > < / a > 00038 < span class = "preprocessor" > #ifndef _CHCONF_H_< / span >
< a name = "l00039" > < / a > 00039 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _CHCONF_H_< / span >
< a name = "l00040" > < / a > 00040 < span class = "preprocessor" > < / span >
< a name = "l00041" > < / a > 00041 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00042" > < / a > 00042 < span class = "comment" > /* Kernel parameters. */< / span >
< a name = "l00043" > < / a > 00043 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00044" > < / a > 00044 < span class = "comment" > < / span >
< a name = "l00045" > < / a > 00045 < span class = "comment" > /**< / span >
< a name = "l00046" > < / a > 00046 < span class = "comment" > * @brief System tick frequency.< / span >
< a name = "l00047" > < / a > 00047 < span class = "comment" > * @details Frequency of the system timer that drives the system ticks. This< / span >
< a name = "l00048" > < / a > 00048 < span class = "comment" > * setting also defines the system tick time unit.< / span >
< a name = "l00049" > < / a > 00049 < span class = "comment" > */< / span >
< a name = "l00050" > < / a > 00050 < span class = "preprocessor" > #if !defined(CH_FREQUENCY) || defined(__DOXYGEN__)< / span >
< a name = "l00051" > < / a > < a class = "code" href = "group__config.html#ga195ab8ff3340a18d4513cbaf915078f2" > 00051< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_FREQUENCY 1000< / span >
< a name = "l00052" > < / a > 00052 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00053" > < / a > 00053 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00054" > < / a > 00054 < span class = "comment" > /**< / span >
< a name = "l00055" > < / a > 00055 < span class = "comment" > * @brief Round robin interval.< / span >
< a name = "l00056" > < / a > 00056 < span class = "comment" > * @details This constant is the number of system ticks allowed for the< / span >
< a name = "l00057" > < / a > 00057 < span class = "comment" > * threads before preemption occurs. Setting this value to zero< / span >
< a name = "l00058" > < / a > 00058 < span class = "comment" > * disables the preemption for threads with equal priority and the< / span >
< a name = "l00059" > < / a > 00059 < span class = "comment" > * round robin becomes cooperative. Note that higher priority< / span >
< a name = "l00060" > < / a > 00060 < span class = "comment" > * threads can still preempt, the kernel is always preemptive.< / span >
< a name = "l00061" > < / a > 00061 < span class = "comment" > *< / span >
< a name = "l00062" > < / a > 00062 < span class = "comment" > * @note Disabling the round robin preemption makes the kernel more compact< / span >
< a name = "l00063" > < / a > 00063 < span class = "comment" > * and generally faster.< / span >
< a name = "l00064" > < / a > 00064 < span class = "comment" > */< / span >
< a name = "l00065" > < / a > 00065 < span class = "preprocessor" > #if !defined(CH_TIME_QUANTUM) || defined(__DOXYGEN__)< / span >
< a name = "l00066" > < / a > < a class = "code" href = "group__config.html#ga3c6800242611cf244a38c4a870e8515a" > 00066< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_TIME_QUANTUM 20< / span >
< a name = "l00067" > < / a > 00067 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00068" > < / a > 00068 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00069" > < / a > 00069 < span class = "comment" > /**< / span >
< a name = "l00070" > < / a > 00070 < span class = "comment" > * @brief Nested locks.< / span >
< a name = "l00071" > < / a > 00071 < span class = "comment" > * @details If enabled then the use of nested @p chSysLock() / @p chSysUnlock()< / span >
< a name = "l00072" > < / a > 00072 < span class = "comment" > * operations is allowed.< br> < / span >
< a name = "l00073" > < / a > 00073 < span class = "comment" > * For performance and code size reasons the recommended setting< / span >
< a name = "l00074" > < / a > 00074 < span class = "comment" > * is to leave this option disabled.< br> < / span >
< a name = "l00075" > < / a > 00075 < span class = "comment" > * You may use this option if you need to merge ChibiOS/RT with< / span >
< a name = "l00076" > < / a > 00076 < span class = "comment" > * external libraries that require nested lock/unlock operations.< / span >
< a name = "l00077" > < / a > 00077 < span class = "comment" > *< / span >
< a name = "l00078" > < / a > 00078 < span class = "comment" > * @note T he default is @p FALSE.< / span >
< a name = "l00079" > < / a > 00079 < span class = "comment" > */< / span >
< a name = "l00080" > < / a > 00080 < span class = "preprocessor" > #if !defined(CH_USE_NESTED_LOCKS) || defined(__DOXYGEN__)< / span >
< a name = "l00081" > < / a > < a class = "code" href = "group__config.html#gacc5d718a9ef515a18211ff2bcd0a31dc" > 00081< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_NESTED_LOCKS FALSE< / span >
< a name = "l00082" > < / a > 00082 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00083" > < / a > 00083 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00084" > < / a > 00084 < span class = "comment" > /**< / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > * @brief Managed RAM size.< / span >
< a name = "l00086" > < / a > 00086 < span class = "comment" > * @details Size of the RAM area to be managed by the OS. If set to zero< / span >
< a name = "l00087" > < / a > 00087 < span class = "comment" > * then the whole available RAM is used. The core memory is made< / span >
< a name = "l00088" > < / a > 00088 < span class = "comment" > * available to the heap allocator and/or can be used directly through< / span >
< a name = "l00089" > < / a > 00089 < span class = "comment" > * the simplified core memory allocator.< / span >
< a name = "l00090" > < / a > 00090 < span class = "comment" > *< / span >
< a name = "l00091" > < / a > 00091 < span class = "comment" > * @note In order to let the OS manage the whole RAM the linker script must< / span >
< a name = "l00092" > < / a > 00092 < span class = "comment" > * provide the @p __heap_base__ and @p __heap_end__ symbols.< / span >
< a name = "l00093" > < / a > 00093 < span class = "comment" > * @note Requires @p CH_USE_COREMEM.< / span >
< a name = "l00094" > < / a > 00094 < span class = "comment" > */< / span >
< a name = "l00095" > < / a > 00095 < span class = "preprocessor" > #if !defined(CH_MEMCORE_SIZE) || defined(__DOXYGEN__)< / span >
< a name = "l00096" > < / a > < a class = "code" href = "group__config.html#gac73902e3c40b375483f9dde71e83253d" > 00096< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_MEMCORE_SIZE 0< / span >
< a name = "l00097" > < / a > 00097 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00098" > < / a > 00098 < span class = "preprocessor" > < / span >
< a name = "l00099" > < / a > 00099 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00100" > < / a > 00100 < span class = "comment" > /* Performance options. */< / span >
< a name = "l00101" > < / a > 00101 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00102" > < / a > 00102 < span class = "comment" > < / span >
< a name = "l00103" > < / a > 00103 < span class = "comment" > /**< / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > * @brief OS optimization.< / span >
< a name = "l00105" > < / a > 00105 < span class = "comment" > * @details If enabled then time efficient rather than space efficient code< / span >
< a name = "l00106" > < / a > 00106 < span class = "comment" > * is used when two possible implementations exist.< / span >
< a name = "l00107" > < / a > 00107 < span class = "comment" > *< / span >
< a name = "l00108" > < / a > 00108 < span class = "comment" > * @note This is not related to the compiler optimization options.< / span >
< a name = "l00109" > < / a > 00109 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00110" > < / a > 00110 < span class = "comment" > */< / span >
< a name = "l00111" > < / a > 00111 < span class = "preprocessor" > #if !defined(CH_OPTIMIZE_SPEED) || defined(__DOXYGEN__)< / span >
< a name = "l00112" > < / a > < a class = "code" href = "group__config.html#gaa5a3d403206b04dfa43ee769e8a220c6" > 00112< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_OPTIMIZE_SPEED TRUE< / span >
< a name = "l00113" > < / a > 00113 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00114" > < / a > 00114 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00115" > < / a > 00115 < span class = "comment" > /**< / span >
< a name = "l00116" > < / a > 00116 < span class = "comment" > * @brief Exotic optimization.< / span >
< a name = "l00117" > < / a > 00117 < span class = "comment" > * @details If defined then a CPU register is used as storage for the global< / span >
< a name = "l00118" > < / a > 00118 < span class = "comment" > * @p currp variable. Caching this variable in a register greatly< / span >
< a name = "l00119" > < / a > 00119 < span class = "comment" > * improves both space and time OS efficiency. A side effect is that< / span >
< a name = "l00120" > < / a > 00120 < span class = "comment" > * one less register has to be saved during the context switch< / span >
< a name = "l00121" > < / a > 00121 < span class = "comment" > * resulting in lower RAM usage and faster context switch.< / span >
< a name = "l00122" > < / a > 00122 < span class = "comment" > *< / span >
< a name = "l00123" > < / a > 00123 < span class = "comment" > * @note This option is only usable with the GCC compiler and is only useful< / span >
< a name = "l00124" > < / a > 00124 < span class = "comment" > * on processors with many registers like ARM cores.< / span >
< a name = "l00125" > < / a > 00125 < span class = "comment" > * @note If this option is enabled then ALL the libraries linked to the< / span >
< a name = "l00126" > < / a > 00126 < span class = "comment" > * ChibiOS/RT code < b> must< /b> be recompiled with the GCC option @p< / span >
< a name = "l00127" > < / a > 00127 < span class = "comment" > * -ffixed-@< reg@> .< / span >
< a name = "l00128" > < / a > 00128 < span class = "comment" > * @note This option must be enabled in the Makefile, it is listed here for< / span >
< a name = "l00129" > < / a > 00129 < span class = "comment" > * documentation only.< / span >
< a name = "l00130" > < / a > 00130 < span class = "comment" > */< / span >
< a name = "l00131" > < / a > 00131 < span class = "preprocessor" > #if defined(__DOXYGEN__)< / span >
< a name = "l00132" > < / a > < a class = "code" href = "group__config.html#ga7176099cb271e334cde4e3c4e256086b" > 00132< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_CURRP_REGISTER_CACHE " reg" < / span >
< a name = "l00133" > < / a > 00133 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00134" > < / a > 00134 < span class = "preprocessor" > < / span >
< a name = "l00135" > < / a > 00135 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00136" > < / a > 00136 < span class = "comment" > /* Subsystem options. */< / span >
< 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" > /**< / span >
< a name = "l00140" > < / a > 00140 < span class = "comment" > * @brief Threads registry APIs.< / span >
< a name = "l00141" > < / a > 00141 < span class = "comment" > * @details If enabled then the registry APIs are included in the kernel.< / span >
< a name = "l00142" > < / a > 00142 < span class = "comment" > *< / span >
< a name = "l00143" > < / a > 00143 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00144" > < / a > 00144 < span class = "comment" > */< / span >
< a name = "l00145" > < / a > 00145 < span class = "preprocessor" > #if !defined(CH_USE_REGISTRY) || defined(__DOXYGEN__)< / span >
< a name = "l00146" > < / a > < a class = "code" href = "group__config.html#ga881045654c5c0b04081bf89da3fe4534" > 00146< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_REGISTRY TRUE< / span >
< a name = "l00147" > < / a > 00147 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00148" > < / a > 00148 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00149" > < / a > 00149 < span class = "comment" > /**< / span >
< a name = "l00150" > < / a > 00150 < span class = "comment" > * @brief Threads synchronization APIs.< / span >
< a name = "l00151" > < / a > 00151 < span class = "comment" > * @details If enabled then the @p chThdWait() function is included in< / span >
< a name = "l00152" > < / a > 00152 < span class = "comment" > * the kernel.< / span >
< a name = "l00153" > < / a > 00153 < span class = "comment" > *< / span >
< a name = "l00154" > < / a > 00154 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00155" > < / a > 00155 < span class = "comment" > */< / span >
< a name = "l00156" > < / a > 00156 < span class = "preprocessor" > #if !defined(CH_USE_WAITEXIT) || defined(__DOXYGEN__)< / span >
< a name = "l00157" > < / a > < a class = "code" href = "group__config.html#gac5e6308f66b8fdb57f0c849ed22b3d95" > 00157< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_WAITEXIT TRUE< / span >
< a name = "l00158" > < / a > 00158 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00159" > < / a > 00159 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00160" > < / a > 00160 < span class = "comment" > /**< / span >
< a name = "l00161" > < / a > 00161 < span class = "comment" > * @brief Semaphores APIs.< / span >
< a name = "l00162" > < / a > 00162 < span class = "comment" > * @details If enabled then the Semaphores APIs are included in the kernel.< / span >
< a name = "l00163" > < / a > 00163 < span class = "comment" > *< / span >
< a name = "l00164" > < / a > 00164 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00165" > < / a > 00165 < span class = "comment" > */< / span >
< a name = "l00166" > < / a > 00166 < span class = "preprocessor" > #if !defined(CH_USE_SEMAPHORES) || defined(__DOXYGEN__)< / span >
< a name = "l00167" > < / a > < a class = "code" href = "group__config.html#gab88f410fdc6a67192194a8431d991b27" > 00167< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_SEMAPHORES TRUE< / span >
< a name = "l00168" > < / a > 00168 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / 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 Semaphores queuing mode.< / span >
< a name = "l00172" > < / a > 00172 < span class = "comment" > * @details If enabled then the threads are enqueued on semaphores by< / span >
< a name = "l00173" > < / a > 00173 < span class = "comment" > * priority rather than in FIFO order.< / span >
< a name = "l00174" > < / a > 00174 < span class = "comment" > *< / span >
< a name = "l00175" > < / a > 00175 < span class = "comment" > * @note The default is @p FALSE. Enable this if you have special requirements.< / span >
< a name = "l00176" > < / a > 00176 < span class = "comment" > * @note Requires @p CH_USE_SEMAPHORES.< / span >
< a name = "l00177" > < / a > 00177 < span class = "comment" > */< / span >
< a name = "l00178" > < / a > 00178 < span class = "preprocessor" > #if !defined(CH_USE_SEMAPHORES_PRIORITY) || defined(__DOXYGEN__)< / span >
< a name = "l00179" > < / a > < a class = "code" href = "group__config.html#ga866568c0387963f11c078a8d939c2284" > 00179< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_SEMAPHORES_PRIORITY FALSE< / span >
< a name = "l00180" > < / a > 00180 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00181" > < / a > 00181 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00182" > < / a > 00182 < span class = "comment" > /**< / span >
< a name = "l00183" > < / a > 00183 < span class = "comment" > * @brief Atomic semaphore API.< / span >
< a name = "l00184" > < / a > 00184 < span class = "comment" > * @details If enabled then the semaphores the @p chSemSignalWait() API< / span >
< a name = "l00185" > < / a > 00185 < span class = "comment" > * is included in the kernel.< / span >
< a name = "l00186" > < / a > 00186 < span class = "comment" > *< / span >
< a name = "l00187" > < / a > 00187 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00188" > < / a > 00188 < span class = "comment" > * @note Requires @p CH_USE_SEMAPHORES.< / span >
< a name = "l00189" > < / a > 00189 < span class = "comment" > */< / span >
< a name = "l00190" > < / a > 00190 < span class = "preprocessor" > #if !defined(CH_USE_SEMSW) || defined(__DOXYGEN__)< / span >
< a name = "l00191" > < / a > < a class = "code" href = "group__config.html#gae9e6ff0fe1964761ea6e1bce51d8ee59" > 00191< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_SEMSW TRUE< / span >
< a name = "l00192" > < / a > 00192 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00193" > < / a > 00193 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00194" > < / a > 00194 < span class = "comment" > /**< / span >
< a name = "l00195" > < / a > 00195 < span class = "comment" > * @brief Mutexes APIs.< / span >
< a name = "l00196" > < / a > 00196 < span class = "comment" > * @details If enabled then the mutexes APIs are included in the kernel.< / span >
< a name = "l00197" > < / a > 00197 < span class = "comment" > *< / span >
< a name = "l00198" > < / a > 00198 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00199" > < / a > 00199 < span class = "comment" > */< / span >
< a name = "l00200" > < / a > 00200 < span class = "preprocessor" > #if !defined(CH_USE_MUTEXES) || defined(__DOXYGEN__)< / span >
< a name = "l00201" > < / a > < a class = "code" href = "group__config.html#ga4f461a7b5edbff2405b7b40d2bb238a6" > 00201< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_MUTEXES TRUE< / span >
< a name = "l00202" > < / a > 00202 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00203" > < / a > 00203 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00204" > < / a > 00204 < span class = "comment" > /**< / span >
< a name = "l00205" > < / a > 00205 < span class = "comment" > * @brief Conditional Variables APIs.< / span >
< a name = "l00206" > < / a > 00206 < span class = "comment" > * @details If enabled then the conditional variables APIs are included< / span >
< a name = "l00207" > < / a > 00207 < span class = "comment" > * in the kernel.< / span >
< a name = "l00208" > < / a > 00208 < span class = "comment" > *< / span >
< a name = "l00209" > < / a > 00209 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00210" > < / a > 00210 < span class = "comment" > * @note Requires @p CH_USE_MUTEXES.< / span >
< a name = "l00211" > < / a > 00211 < span class = "comment" > */< / span >
< a name = "l00212" > < / a > 00212 < span class = "preprocessor" > #if !defined(CH_USE_CONDVARS) || defined(__DOXYGEN__)< / span >
< a name = "l00213" > < / a > < a class = "code" href = "group__config.html#ga24fd7fe539fd6094b5db3215e1721c9c" > 00213< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_CONDVARS TRUE< / span >
< a name = "l00214" > < / a > 00214 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00215" > < / a > 00215 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00216" > < / a > 00216 < span class = "comment" > /**< / span >
< a name = "l00217" > < / a > 00217 < span class = "comment" > * @brief Conditional Variables APIs with timeout.< / span >
< a name = "l00218" > < / a > 00218 < span class = "comment" > * @details If enabled then the conditional variables APIs with timeout< / span >
< a name = "l00219" > < / a > 00219 < span class = "comment" > * specification are included in the kernel.< / span >
< a name = "l00220" > < / a > 00220 < span class = "comment" > *< / span >
< a name = "l00221" > < / a > 00221 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00222" > < / a > 00222 < span class = "comment" > * @note Requires @p CH_USE_CONDVARS.< / span >
< a name = "l00223" > < / a > 00223 < span class = "comment" > */< / span >
< a name = "l00224" > < / a > 00224 < span class = "preprocessor" > #if !defined(CH_USE_CONDVARS_TIMEOUT) || defined(__DOXYGEN__)< / span >
< a name = "l00225" > < / a > < a class = "code" href = "group__config.html#gaccc2c032c409bced696f75877e270979" > 00225< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_CONDVARS_TIMEOUT TRUE< / span >
< a name = "l00226" > < / a > 00226 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00227" > < / a > 00227 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00228" > < / a > 00228 < span class = "comment" > /**< / span >
< a name = "l00229" > < / a > 00229 < span class = "comment" > * @brief Events Flags APIs.< / span >
< a name = "l00230" > < / a > 00230 < span class = "comment" > * @details If enabled then the event flags APIs are included in the kernel.< / span >
< a name = "l00231" > < / a > 00231 < span class = "comment" > *< / span >
< a name = "l00232" > < / a > 00232 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00233" > < / a > 00233 < span class = "comment" > */< / span >
< a name = "l00234" > < / a > 00234 < span class = "preprocessor" > #if !defined(CH_USE_EVENTS) || defined(__DOXYGEN__)< / span >
< a name = "l00235" > < / a > < a class = "code" href = "group__config.html#ga5e3ac686cd33ad40a89aaaf97b3dc781" > 00235< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_EVENTS TRUE< / span >
< a name = "l00236" > < / a > 00236 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00237" > < / a > 00237 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00238" > < / a > 00238 < span class = "comment" > /**< / span >
< a name = "l00239" > < / a > 00239 < span class = "comment" > * @brief Events Flags APIs with timeout.< / span >
< a name = "l00240" > < / a > 00240 < span class = "comment" > * @details If enabled then the events APIs with timeout specification< / span >
< a name = "l00241" > < / a > 00241 < span class = "comment" > * are included in the kernel.< / span >
< a name = "l00242" > < / a > 00242 < span class = "comment" > *< / span >
< a name = "l00243" > < / a > 00243 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00244" > < / a > 00244 < span class = "comment" > * @note Requires @p CH_USE_EVENTS.< / span >
< a name = "l00245" > < / a > 00245 < span class = "comment" > */< / span >
< a name = "l00246" > < / a > 00246 < span class = "preprocessor" > #if !defined(CH_USE_EVENTS_TIMEOUT) || defined(__DOXYGEN__)< / span >
< a name = "l00247" > < / a > < a class = "code" href = "group__config.html#ga64a6ad752750f42fe2474d3e7f191a71" > 00247< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_EVENTS_TIMEOUT TRUE< / span >
< a name = "l00248" > < / a > 00248 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00249" > < / a > 00249 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00250" > < / a > 00250 < span class = "comment" > /**< / span >
< a name = "l00251" > < / a > 00251 < span class = "comment" > * @brief Synchronous Messages APIs.< / span >
< a name = "l00252" > < / a > 00252 < span class = "comment" > * @details If enabled then the synchronous messages APIs are included< / span >
< a name = "l00253" > < / a > 00253 < span class = "comment" > * in the kernel.< / span >
< a name = "l00254" > < / a > 00254 < span class = "comment" > *< / span >
< a name = "l00255" > < / a > 00255 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00256" > < / a > 00256 < span class = "comment" > */< / span >
< a name = "l00257" > < / a > 00257 < span class = "preprocessor" > #if !defined(CH_USE_MESSAGES) || defined(__DOXYGEN__)< / span >
< a name = "l00258" > < / a > < a class = "code" href = "group__config.html#ga3823e336736d522bbfaf780c86746482" > 00258< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_MESSAGES TRUE< / span >
< a name = "l00259" > < / a > 00259 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00260" > < / a > 00260 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00261" > < / a > 00261 < span class = "comment" > /**< / span >
< a name = "l00262" > < / a > 00262 < span class = "comment" > * @brief Synchronous Messages queuing mode.< / span >
< a name = "l00263" > < / a > 00263 < span class = "comment" > * @details If enabled then messages are served by priority rather than in< / span >
< a name = "l00264" > < / a > 00264 < span class = "comment" > * FIFO order.< / span >
< a name = "l00265" > < / a > 00265 < span class = "comment" > *< / span >
< a name = "l00266" > < / a > 00266 < span class = "comment" > * @note The default is @p FALSE. Enable this if you have special requirements.< / span >
< a name = "l00267" > < / a > 00267 < span class = "comment" > * @note Requires @p CH_USE_MESSAGES.< / span >
< a name = "l00268" > < / a > 00268 < span class = "comment" > */< / span >
< a name = "l00269" > < / a > 00269 < span class = "preprocessor" > #if !defined(CH_USE_MESSAGES_PRIORITY) || defined(__DOXYGEN__)< / span >
< a name = "l00270" > < / a > < a class = "code" href = "group__config.html#gaf48947f33ed7a44a7701d84d83d94a1c" > 00270< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_MESSAGES_PRIORITY FALSE< / span >
< a name = "l00271" > < / a > 00271 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00272" > < / a > 00272 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00273" > < / a > 00273 < span class = "comment" > /**< / span >
< a name = "l00274" > < / a > 00274 < span class = "comment" > * @brief Mailboxes APIs.< / span >
< a name = "l00275" > < / a > 00275 < span class = "comment" > * @details If enabled then the asynchronous messages (mailboxes) APIs are< / span >
< a name = "l00276" > < / a > 00276 < span class = "comment" > * included in the kernel.< / span >
< a name = "l00277" > < / a > 00277 < span class = "comment" > *< / span >
< a name = "l00278" > < / a > 00278 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00279" > < / a > 00279 < span class = "comment" > * @note Requires @p CH_USE_SEMAPHORES.< / span >
< a name = "l00280" > < / a > 00280 < span class = "comment" > */< / span >
< a name = "l00281" > < / a > 00281 < span class = "preprocessor" > #if !defined(CH_USE_MAILBOXES) || defined(__DOXYGEN__)< / span >
< a name = "l00282" > < / a > < a class = "code" href = "group__config.html#ga6cf1736db681617019f96c4c209d2716" > 00282< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_MAILBOXES TRUE< / span >
< a name = "l00283" > < / a > 00283 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00284" > < / a > 00284 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00285" > < / a > 00285 < span class = "comment" > /**< / span >
< a name = "l00286" > < / a > 00286 < span class = "comment" > * @brief I/O Queues APIs.< / span >
< a name = "l00287" > < / a > 00287 < span class = "comment" > * @details If enabled then the I/O queues APIs are included in the kernel.< / span >
< a name = "l00288" > < / a > 00288 < span class = "comment" > *< / span >
< a name = "l00289" > < / a > 00289 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00290" > < / a > 00290 < span class = "comment" > * @note Requires @p CH_USE_SEMAPHORES.< / span >
< a name = "l00291" > < / a > 00291 < span class = "comment" > */< / span >
< a name = "l00292" > < / a > 00292 < span class = "preprocessor" > #if !defined(CH_USE_QUEUES) || defined(__DOXYGEN__)< / span >
< a name = "l00293" > < / a > < a class = "code" href = "group__config.html#gaabe4bd52d2fd1b180ebba1d1e8243051" > 00293< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_QUEUES TRUE< / span >
< a name = "l00294" > < / a > 00294 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00295" > < / a > 00295 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00296" > < / a > 00296 < span class = "comment" > /**< / span >
< a name = "l00297" > < / a > 00297 < span class = "comment" > * @brief Core Memory Manager APIs.< / span >
< a name = "l00298" > < / a > 00298 < span class = "comment" > * @details If enabled then the core memory manager APIs are included< / span >
< a name = "l00299" > < / a > 00299 < span class = "comment" > * in the kernel.< / span >
< a name = "l00300" > < / a > 00300 < span class = "comment" > *< / span >
< a name = "l00301" > < / a > 00301 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00302" > < / a > 00302 < span class = "comment" > */< / span >
< a name = "l00303" > < / a > 00303 < span class = "preprocessor" > #if !defined(CH_USE_MEMCORE) || defined(__DOXYGEN__)< / span >
< a name = "l00304" > < / a > < a class = "code" href = "group__config.html#gaff85f4d919dac30a337ce2f34e2fa1af" > 00304< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_MEMCORE TRUE< / span >
< a name = "l00305" > < / a > 00305 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00306" > < / a > 00306 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00307" > < / a > 00307 < span class = "comment" > /**< / span >
< a name = "l00308" > < / a > 00308 < span class = "comment" > * @brief Heap Allocator APIs.< / span >
< a name = "l00309" > < / a > 00309 < span class = "comment" > * @details If enabled then the memory heap allocator APIs are included< / span >
< a name = "l00310" > < / a > 00310 < span class = "comment" > * in the kernel.< / span >
< a name = "l00311" > < / a > 00311 < span class = "comment" > *< / span >
< a name = "l00312" > < / a > 00312 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00313" > < / a > 00313 < span class = "comment" > * @note Requires @p CH_USE_COREMEM and either @p CH_USE_MUTEXES or< / span >
< a name = "l00314" > < / a > 00314 < span class = "comment" > * @p CH_USE_SEMAPHORES.< / span >
< a name = "l00315" > < / a > 00315 < span class = "comment" > * @note Mutexes are recommended.< / span >
< a name = "l00316" > < / a > 00316 < span class = "comment" > */< / span >
< a name = "l00317" > < / a > 00317 < span class = "preprocessor" > #if !defined(CH_USE_HEAP) || defined(__DOXYGEN__)< / span >
< a name = "l00318" > < / a > < a class = "code" href = "group__config.html#gaaeb266ab6131572f1d8f164bddf2da3f" > 00318< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_HEAP TRUE< / span >
< a name = "l00319" > < / a > 00319 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00320" > < / a > 00320 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00321" > < / a > 00321 < span class = "comment" > /**< / span >
< a name = "l00322" > < / a > 00322 < span class = "comment" > * @brief C-runtime allocator.< / span >
< a name = "l00323" > < / a > 00323 < span class = "comment" > * @details If enabled the the heap allocator APIs just wrap the C-runtime< / span >
< a name = "l00324" > < / a > 00324 < span class = "comment" > * @p malloc() and @p free() functions.< / span >
< a name = "l00325" > < / a > 00325 < span class = "comment" > *< / span >
< a name = "l00326" > < / a > 00326 < span class = "comment" > * @note The default is @p FALSE.< / span >
< a name = "l00327" > < / a > 00327 < span class = "comment" > * @note Requires @p CH_USE_HEAP.< / span >
< a name = "l00328" > < / a > 00328 < span class = "comment" > * @note The C-runtime may or may not require @p CH_USE_COREMEM, see the< / span >
< a name = "l00329" > < / a > 00329 < span class = "comment" > * appropriate documentation.< / span >
< a name = "l00330" > < / a > 00330 < span class = "comment" > */< / span >
< a name = "l00331" > < / a > 00331 < span class = "preprocessor" > #if !defined(CH_USE_MALLOC_HEAP) || defined(__DOXYGEN__)< / span >
< a name = "l00332" > < / a > < a class = "code" href = "group__config.html#ga4785d390f3a787916c5a5c41e953577d" > 00332< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_MALLOC_HEAP FALSE< / span >
< a name = "l00333" > < / a > 00333 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00334" > < / a > 00334 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00335" > < / a > 00335 < span class = "comment" > /**< / span >
< a name = "l00336" > < / a > 00336 < span class = "comment" > * @brief Memory Pools Allocator APIs.< / span >
< a name = "l00337" > < / a > 00337 < span class = "comment" > * @details If enabled then the memory pools allocator APIs are included< / span >
< a name = "l00338" > < / a > 00338 < span class = "comment" > * in the kernel.< / span >
< a name = "l00339" > < / a > 00339 < span class = "comment" > *< / span >
< a name = "l00340" > < / a > 00340 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00341" > < / a > 00341 < span class = "comment" > */< / span >
< a name = "l00342" > < / a > 00342 < span class = "preprocessor" > #if !defined(CH_USE_MEMPOOLS) || defined(__DOXYGEN__)< / span >
< a name = "l00343" > < / a > < a class = "code" href = "group__config.html#gac456517b37f104d2226fef50310c79f8" > 00343< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_MEMPOOLS TRUE< / span >
< a name = "l00344" > < / a > 00344 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00345" > < / a > 00345 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00346" > < / a > 00346 < span class = "comment" > /**< / span >
< a name = "l00347" > < / a > 00347 < span class = "comment" > * @brief Dynamic Threads APIs.< / span >
< a name = "l00348" > < / a > 00348 < span class = "comment" > * @details If enabled then the dynamic threads creation APIs are included< / span >
< a name = "l00349" > < / a > 00349 < span class = "comment" > * in the kernel.< / span >
< a name = "l00350" > < / a > 00350 < span class = "comment" > *< / span >
< a name = "l00351" > < / a > 00351 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00352" > < / a > 00352 < span class = "comment" > * @note Requires @p CH_USE_WAITEXIT.< / span >
< a name = "l00353" > < / a > 00353 < span class = "comment" > * @note Requires @p CH_USE_HEAP and/or @p CH_USE_MEMPOOLS.< / span >
< a name = "l00354" > < / a > 00354 < span class = "comment" > */< / span >
< a name = "l00355" > < / a > 00355 < span class = "preprocessor" > #if !defined(CH_USE_DYNAMIC) || defined(__DOXYGEN__)< / span >
< a name = "l00356" > < / a > < a class = "code" href = "group__config.html#gaae4996e24bbee7d66528671cec8b8749" > 00356< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_USE_DYNAMIC TRUE< / span >
< a name = "l00357" > < / a > 00357 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00358" > < / a > 00358 < span class = "preprocessor" > < / span >
< a name = "l00359" > < / a > 00359 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00360" > < / a > 00360 < span class = "comment" > /* Debug options. */< / span >
< a name = "l00361" > < / a > 00361 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00362" > < / a > 00362 < span class = "comment" > < / span >
< a name = "l00363" > < / a > 00363 < span class = "comment" > /**< / span >
< a name = "l00364" > < / a > 00364 < span class = "comment" > * @brief Debug option, parameters checks.< / span >
< a name = "l00365" > < / a > 00365 < span class = "comment" > * @details If enabled then the checks on the API functions input< / span >
< a name = "l00366" > < / a > 00366 < span class = "comment" > * parameters are activated.< / span >
< a name = "l00367" > < / a > 00367 < span class = "comment" > *< / span >
< a name = "l00368" > < / a > 00368 < span class = "comment" > * @note The default is @p FALSE.< / span >
< a name = "l00369" > < / a > 00369 < span class = "comment" > */< / span >
< a name = "l00370" > < / a > 00370 < span class = "preprocessor" > #if !defined(CH_DBG_ENABLE_CHECKS) || defined(__DOXYGEN__)< / span >
< a name = "l00371" > < / a > < a class = "code" href = "group__config.html#gaef984ca3bfd8a71478ad55ce6e56a8bb" > 00371< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_DBG_ENABLE_CHECKS FALSE< / span >
< a name = "l00372" > < / a > 00372 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00373" > < / a > 00373 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00374" > < / a > 00374 < span class = "comment" > /**< / span >
< a name = "l00375" > < / a > 00375 < span class = "comment" > * @brief Debug option, consistency checks.< / span >
< a name = "l00376" > < / a > 00376 < span class = "comment" > * @details If enabled then all the assertions in the kernel code are< / span >
< a name = "l00377" > < / a > 00377 < span class = "comment" > * activated. This includes consistency checks inside the kernel,< / span >
< a name = "l00378" > < / a > 00378 < span class = "comment" > * runtime anomalies and port-defined checks.< / span >
< a name = "l00379" > < / a > 00379 < span class = "comment" > *< / span >
< a name = "l00380" > < / a > 00380 < span class = "comment" > * @note The default is @p FALSE.< / span >
< a name = "l00381" > < / a > 00381 < span class = "comment" > */< / span >
< a name = "l00382" > < / a > 00382 < span class = "preprocessor" > #if !defined(CH_DBG_ENABLE_ASSERTS) || defined(__DOXYGEN__)< / span >
< a name = "l00383" > < / a > < a class = "code" href = "group__config.html#gad602fd2546073869a10859158d865b9b" > 00383< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_DBG_ENABLE_ASSERTS FALSE< / span >
< a name = "l00384" > < / a > 00384 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00385" > < / a > 00385 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00386" > < / a > 00386 < span class = "comment" > /**< / span >
< a name = "l00387" > < / a > 00387 < span class = "comment" > * @brief Debug option, trace buffer.< / span >
< a name = "l00388" > < / a > 00388 < span class = "comment" > * @details If enabled then the context switch circular trace buffer is< / span >
< a name = "l00389" > < / a > 00389 < span class = "comment" > * activated.< / span >
< a name = "l00390" > < / a > 00390 < span class = "comment" > *< / span >
< a name = "l00391" > < / a > 00391 < span class = "comment" > * @note The default is @p FALSE.< / span >
< a name = "l00392" > < / a > 00392 < span class = "comment" > */< / span >
< a name = "l00393" > < / a > 00393 < span class = "preprocessor" > #if !defined(CH_DBG_ENABLE_TRACE) || defined(__DOXYGEN__)< / span >
< a name = "l00394" > < / a > < a class = "code" href = "group__config.html#ga8bc4cfd861131aeb3c880347d0068229" > 00394< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_DBG_ENABLE_TRACE FALSE< / span >
< a name = "l00395" > < / a > 00395 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00396" > < / a > 00396 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00397" > < / a > 00397 < span class = "comment" > /**< / span >
< a name = "l00398" > < / a > 00398 < span class = "comment" > * @brief Debug option, stack checks.< / span >
< a name = "l00399" > < / a > 00399 < span class = "comment" > * @details If enabled then a runtime stack check is performed.< / span >
< a name = "l00400" > < / a > 00400 < span class = "comment" > *< / span >
< a name = "l00401" > < / a > 00401 < span class = "comment" > * @note The default is @p FALSE.< / span >
< a name = "l00402" > < / a > 00402 < span class = "comment" > * @note The stack check is performed in a architecture/port dependent way.< / span >
< a name = "l00403" > < / a > 00403 < span class = "comment" > * It may not be implemented or some ports.< / span >
< a name = "l00404" > < / a > 00404 < span class = "comment" > * @note The default failure mode is to halt the system with the global< / span >
< a name = "l00405" > < / a > 00405 < span class = "comment" > * @p panic_msg variable set to @p NULL.< / span >
< a name = "l00406" > < / a > 00406 < span class = "comment" > */< / span >
< a name = "l00407" > < / a > 00407 < span class = "preprocessor" > #if !defined(CH_DBG_ENABLE_STACK_CHECK) || defined(__DOXYGEN__)< / span >
< a name = "l00408" > < / a > < a class = "code" href = "group__config.html#gab93d9ee904f15d4f2c26ef2a1394a1d7" > 00408< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_DBG_ENABLE_STACK_CHECK FALSE< / span >
< a name = "l00409" > < / a > 00409 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00410" > < / a > 00410 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00411" > < / a > 00411 < span class = "comment" > /**< / span >
< a name = "l00412" > < / a > 00412 < span class = "comment" > * @brief Debug option, stacks initialization.< / span >
< a name = "l00413" > < / a > 00413 < span class = "comment" > * @details If enabled then the threads working area is filled with a byte< / span >
< a name = "l00414" > < / a > 00414 < span class = "comment" > * value when a thread is created. This can be useful for the< / span >
< a name = "l00415" > < / a > 00415 < span class = "comment" > * runtime measurement of the used stack.< / span >
< a name = "l00416" > < / a > 00416 < span class = "comment" > *< / span >
< a name = "l00417" > < / a > 00417 < span class = "comment" > * @note The default is @p FALSE.< / span >
< a name = "l00418" > < / a > 00418 < span class = "comment" > */< / span >
< a name = "l00419" > < / a > 00419 < span class = "preprocessor" > #if !defined(CH_DBG_FILL_THREADS) || defined(__DOXYGEN__)< / span >
< a name = "l00420" > < / a > < a class = "code" href = "group__config.html#ga6a859dd249adfb66b9bbf809061ea06c" > 00420< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_DBG_FILL_THREADS FALSE< / span >
< a name = "l00421" > < / a > 00421 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00422" > < / a > 00422 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00423" > < / a > 00423 < span class = "comment" > /**< / span >
< a name = "l00424" > < / a > 00424 < span class = "comment" > * @brief Debug option, threads profiling.< / span >
< a name = "l00425" > < / a > 00425 < span class = "comment" > * @details If enabled then a field is added to the @p Thread structure that< / span >
< a name = "l00426" > < / a > 00426 < span class = "comment" > * counts the system ticks occurred while executing the thread.< / span >
< a name = "l00427" > < / a > 00427 < span class = "comment" > *< / span >
< a name = "l00428" > < / a > 00428 < span class = "comment" > * @note The default is @p TRUE.< / span >
< a name = "l00429" > < / a > 00429 < span class = "comment" > * @note This debug option is defaulted to TRUE because it is required by< / span >
< a name = "l00430" > < / a > 00430 < span class = "comment" > * some test cases into the test suite.< / span >
< a name = "l00431" > < / a > 00431 < span class = "comment" > */< / span >
< a name = "l00432" > < / a > 00432 < span class = "preprocessor" > #if !defined(CH_DBG_THREADS_PROFILING) || defined(__DOXYGEN__)< / span >
< a name = "l00433" > < / a > < a class = "code" href = "group__config.html#gadc9c00c2e5b6e766ded8dfa77c0c90c1" > 00433< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define CH_DBG_THREADS_PROFILING TRUE< / span >
< a name = "l00434" > < / a > 00434 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00435" > < / a > 00435 < span class = "preprocessor" > < / span >
< a name = "l00436" > < / a > 00436 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00437" > < / a > 00437 < span class = "comment" > /* Kernel hooks. */< / span >
< a name = "l00438" > < / a > 00438 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00439" > < / a > 00439 < span class = "comment" > < / span >
< a name = "l00440" > < / a > 00440 < span class = "comment" > /**< / span >
< a name = "l00441" > < / a > 00441 < span class = "comment" > * @brief Threads descriptor structure hook.< / span >
< a name = "l00442" > < / a > 00442 < span class = "comment" > * @details User fields added to the end of the @p Thread structure.< / span >
< a name = "l00443" > < / a > 00443 < span class = "comment" > */< / span >
< a name = "l00444" > < / a > 00444 < span class = "preprocessor" > #if !defined(THREAD_EXT_FIELDS) || defined(__DOXYGEN__)< / span >
< a name = "l00445" > < / a > < a class = "code" href = "group__config.html#gaba26fd717f33330fa56dcc7919a3f02f" > 00445< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define THREAD_EXT_FIELDS \< / span >
< a name = "l00446" > < / a > 00446 < span class = "preprocessor" > struct { \< / span >
< a name = "l00447" > < / a > 00447 < span class = "preprocessor" > < / span > < span class = "comment" > /* Add threads custom fields here.*/< / span > \
< a name = "l00448" > < / a > 00448 };
< a name = "l00449" > < / a > 00449 < span class = "preprocessor" > #endif< / span >
< a name = "l00450" > < / a > 00450 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00451" > < / a > 00451 < span class = "comment" > /**< / span >
< a name = "l00452" > < / a > 00452 < span class = "comment" > * @brief Threads initialization hook.< / span >
< a name = "l00453" > < / a > 00453 < span class = "comment" > * @details User initialization code added to the @p chThdInit() API.< / span >
< a name = "l00454" > < / a > 00454 < span class = "comment" > *< / span >
< a name = "l00455" > < / a > 00455 < span class = "comment" > * @note It is invoked from within @p chThdInit() and implicitily from all< / span >
< a name = "l00456" > < / a > 00456 < span class = "comment" > * the threads creation APIs.< / span >
< a name = "l00457" > < / a > 00457 < span class = "comment" > */< / span >
< a name = "l00458" > < / a > 00458 < span class = "preprocessor" > #if !defined(THREAD_EXT_INIT) || defined(__DOXYGEN__)< / span >
< a name = "l00459" > < / a > < a class = "code" href = "group__config.html#ga758e6ac94f0ad132cd747325719e4d2f" > 00459< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define THREAD_EXT_INIT(tp) { \< / span >
< a name = "l00460" > < / a > 00460 < span class = "preprocessor" > < / span > < span class = "comment" > /* Add threads initialization code here.*/< / span > \
< a name = "l00461" > < / a > 00461 }
< a name = "l00462" > < / a > 00462 < span class = "preprocessor" > #endif< / span >
< a name = "l00463" > < / a > 00463 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00464" > < / a > 00464 < span class = "comment" > /**< / span >
< a name = "l00465" > < / a > 00465 < span class = "comment" > * @brief Threads finalization hook.< / span >
< a name = "l00466" > < / a > 00466 < span class = "comment" > * @details User finalization code added to the @p chThdExit() API.< / span >
< a name = "l00467" > < / a > 00467 < span class = "comment" > *< / span >
< a name = "l00468" > < / a > 00468 < span class = "comment" > * @note It is inserted into lock zone.< / span >
< a name = "l00469" > < / a > 00469 < span class = "comment" > * @note It is also invoked when the threads simply return in order to< / span >
< a name = "l00470" > < / a > 00470 < span class = "comment" > * terminate.< / span >
< a name = "l00471" > < / a > 00471 < span class = "comment" > */< / span >
< a name = "l00472" > < / a > 00472 < span class = "preprocessor" > #if !defined(THREAD_EXT_EXIT) || defined(__DOXYGEN__)< / span >
< a name = "l00473" > < / a > < a class = "code" href = "group__config.html#ga5137c8f67dd4fa75e99824a95a3fa746" > 00473< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define THREAD_EXT_EXIT(tp) { \< / span >
< a name = "l00474" > < / a > 00474 < span class = "preprocessor" > < / span > < span class = "comment" > /* Add threads finalization code here.*/< / span > \
< a name = "l00475" > < / a > 00475 }
< a name = "l00476" > < / a > 00476 < span class = "preprocessor" > #endif< / span >
< a name = "l00477" > < / a > 00477 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00478" > < / a > 00478 < span class = "comment" > /**< / span >
< a name = "l00479" > < / a > 00479 < span class = "comment" > * @brief Idle Loop hook.< / span >
< a name = "l00480" > < / a > 00480 < span class = "comment" > * @details This hook is continuously invoked by the idle thread loop.< / span >
< a name = "l00481" > < / a > 00481 < span class = "comment" > */< / span >
< a name = "l00482" > < / a > 00482 < span class = "preprocessor" > #if !defined(IDLE_LOOP_HOOK) || defined(__DOXYGEN__)< / span >
< a name = "l00483" > < / a > < a class = "code" href = "group__config.html#gae52e2c3230a9e87d16befd547c2f92ef" > 00483< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define IDLE_LOOP_HOOK() { \< / span >
< a name = "l00484" > < / a > 00484 < span class = "preprocessor" > < / span > < span class = "comment" > /* Idle loop code here.*/< / span > \
< a name = "l00485" > < / a > 00485 }
< a name = "l00486" > < / a > 00486 < span class = "preprocessor" > #endif< / span >
< a name = "l00487" > < / a > 00487 < span class = "preprocessor" > < / span >
< a name = "l00488" > < / a > 00488 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00489" > < / a > 00489 < span class = "comment" > /* Port-specific settings (override port settings defaulted in chcore.h). */< / span >
< a name = "l00490" > < / a > 00490 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00491" > < / a > 00491
< a name = "l00492" > < / a > 00492 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _CHCONF_H_ */< / span >
< a name = "l00493" > < / a > 00493 < span class = "comment" > < / span >
< a name = "l00494" > < / a > 00494 < 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 >
