aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2008-12-29 11:38:21 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2008-12-29 11:38:21 +0000
commit796f13d4fa6befdf9e524306d764a3f1483ab8f1 (patch)
treeaae00459209e7ef30ee8a2259e1cd48cd879deca /docs
parent698eb25d0632a0261dac7b0b3e3e9ae0f787768e (diff)
downloadChibiOS-796f13d4fa6befdf9e524306d764a3f1483ab8f1.tar.gz
ChibiOS-796f13d4fa6befdf9e524306d764a3f1483ab8f1.tar.bz2
ChibiOS-796f13d4fa6befdf9e524306d764a3f1483ab8f1.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@557 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'docs')
-rw-r--r--docs/ch.txt41
1 files changed, 40 insertions, 1 deletions
diff --git a/docs/ch.txt b/docs/ch.txt
index 884eb1f11..326fddc00 100644
--- a/docs/ch.txt
+++ b/docs/ch.txt
@@ -210,7 +210,8 @@
* @defgroup ARM7CONF Configuration Options
* @{
* <p>
- * The ARM7 port allows some architecture-specific configurations:
+ * The ARM7 port allows some architecture-specific configurations settings
+ * that can be specified externally, as example on the compiler command line:
* <ul>
* <li>@p INT_REQUIRED_STACK, this value represent the amount of stack space used
* by an interrupt handler between the @p extctx and @p intctx
@@ -294,6 +295,44 @@
/** @} */
/**
+ * @defgroup ARMCM3CONF Configuration Options
+ * @{
+ * <p>
+ * The ARMCM3 port allows some architecture-specific configurations settings
+ * that can be specified externally, as example on the compiler command line:
+ * <ul>
+ * <li>@p INT_REQUIRED_STACK, this value represent the amount of stack space used
+ * by an interrupt handler between the @p extctx and @p intctx
+ * structures.<br>
+ * In practice this value is the stack space used by the chSchDoReschedule()
+ * stack frame.<br>
+ * This value can be affected by a variety of external things like compiler
+ * version, compiler options, kernel settings (speed/size) and so on.<br>
+ * The default for this value is @p 0x10 which should be a safe value, you
+ * can trim this down by defining the macro externally. This would save
+ * some valuable RAM space for each thread present in the system.<br>
+ * The default value is set into <b>./ports/ARMCM3/chcore.h</b>.</li>
+ * <li>@p BASEPRI_USER, this is the @p BASEPRI value for the user threads. The
+ * default value is @p 0 (disabled).<br>
+ * Usually there is no need to change this value, please refer to the
+ * Cortex-M3 technical reference manual for a detailed description.</li>
+ * <li>@p BASEPRI_KERNEL, this is the @p BASEPRI value for the kernel lock code.
+ * The default value is 0x10.<br>
+ * Code running at higher priority levels must not invoke any OS API.<br>
+ * Usually there is no need to change this value, please refer to the
+ * Cortex-M3 technical reference manual for a detailed description.</li>
+ * <li>@p ENABLE_WFI_IDLE, if set to @p 1 enables the use of the @p wfi
+ * instruction from within the idle loop. This is defaulted to 0 because
+ * it can create problems with some debuggers. Setting this option to 1
+ * reduces the system power requirements.</li>
+ * </ul>
+ * </p>
+ * @ingroup ARMCM3
+ */
+/** @} */
+
+
+/**
* @defgroup STM32F103 STM32F103 Support
* @{
* <p>