aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-01-21 21:44:42 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-01-21 21:44:42 +0000
commitb094fe9dc11e9aa1f017cb65766a16ecd42432d2 (patch)
treeadc935cfc61eae4b94c94f72895d1df53365bd83
parent239c51248d26bfc901a3a5ef1d185166fd2c9899 (diff)
downloadChibiOS-b094fe9dc11e9aa1f017cb65766a16ecd42432d2.tar.gz
ChibiOS-b094fe9dc11e9aa1f017cb65766a16ecd42432d2.tar.bz2
ChibiOS-b094fe9dc11e9aa1f017cb65766a16ecd42432d2.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@665 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--docs/ch.txt26
-rw-r--r--ports/ARM7-AT91SAM7X/port.dox2
-rw-r--r--ports/ARM7-LPC214x/port.dox2
-rw-r--r--ports/ARMCM3-STM32F103/port.dox2
-rw-r--r--ports/ARMCM3/port.dox5
-rw-r--r--ports/AVR/port.dox5
-rw-r--r--ports/MSP430/port.dox5
7 files changed, 25 insertions, 22 deletions
diff --git a/docs/ch.txt b/docs/ch.txt
index 86c1dba74..416811dc8 100644
--- a/docs/ch.txt
+++ b/docs/ch.txt
@@ -68,8 +68,7 @@
* @a Heap, @a Pool.
*
* @section api_suffixes API Names Suffixes
- * The suffix is not present for normal APIs but can be one of
- * the following:
+ * The suffix can be one of the following:
* - <b>None</b>, APIs without any suffix can be invoked only from the user
* code in the <b>Normal</b> state unless differently specified. See
* @ref system_states.
@@ -84,10 +83,12 @@
* - <b>Regular Interrupts</b>. Maskable interrupt sources that cannot
* preempt the kernel code and are thus able to invoke operating system APIs
* from within their handlers. The interrupt handlers belonging to this class
- * must be written following some rules. See the @ref System APIs group.
+ * must be written following some rules. See the @ref System APIs group and
+ * @ref article_interrupts.
* - <b>Fast Interrupts</b>. Maskable interrupt sources with the ability
- * to preempt the kernel code and thus have a lower latency. Such sources are
- * not supported on all the architectures.<br>
+ * to preempt the kernel code and thus have a lower latency and are less
+ * subject to jitter, see @ref article_jitter. Such sources are not
+ * supported on all the architectures.<br>
* Fast interrupts are not allowed to invoke any operating system API from
* within their handlers. Fast interrupt sources may however pend a lower
* priority regular interrupt where access to the operating system is
@@ -239,9 +240,9 @@
*
* @section warea Thread Working Area
* Each thread has its own stack, a Thread structure and some preemption
- * areas. All the structures are allocated into a "Thread working area",
- * a thread private heap, usually allocated in an array declared in your
- * code. Threads do not use any memory outside the allocated working area
+ * areas. All the structures are allocated into a "Thread Working Area",
+ * a thread private heap, usually statically declared in your code.
+ * Threads do not use any memory outside the allocated working area
* except when accessing static shared data.<br><br>
* @image html workspace.png
* <br>
@@ -250,9 +251,9 @@
* registers on the stack of the switched-out thread and popping the registers
* of the switched-in thread from its stack.
* The preemption area can be divided in up to three structures:
- * - External context.
- * - Interrupt stack.
- * - Internal context.
+ * - External Context.
+ * - Interrupt Stack.
+ * - Internal Context.
*
* See the @ref Core documentation for details, the area may change on
* the various ports and some structures may not be present (or be zero-sized).
@@ -262,8 +263,7 @@
/**
* @page Articles Articles
* @{
- * @brief ChibiOS/RT Articles and Code Examples
- *
+ * ChibiOS/RT Articles and Code Examples:
* - @subpage article_atomic
* - @subpage article_saveram
* - @subpage article_interrupts
diff --git a/ports/ARM7-AT91SAM7X/port.dox b/ports/ARM7-AT91SAM7X/port.dox
index b62dd3daf..8c72bfbb6 100644
--- a/ports/ARM7-AT91SAM7X/port.dox
+++ b/ports/ARM7-AT91SAM7X/port.dox
@@ -2,7 +2,7 @@
* @defgroup AT91SAM7X AT91SAM7X Support
* @{
* @brief AT91SAM7X specific support.
- * The AT91SAM7X support includes:
+ * @details The AT91SAM7X support includes:
* - Buffered, interrupt driven, serial driver.
* - EMAC driver with MII support.
* - A demo supporting the kernel test suite.
diff --git a/ports/ARM7-LPC214x/port.dox b/ports/ARM7-LPC214x/port.dox
index 279a92c04..5d7a4a591 100644
--- a/ports/ARM7-LPC214x/port.dox
+++ b/ports/ARM7-LPC214x/port.dox
@@ -2,7 +2,7 @@
* @defgroup LPC214x LPC214x Support
* @{
* @brief LPC214x specific support.
- * The LPC214x support includes:
+ * @details The LPC214x support includes:
* - VIC support code.
* - Buffered, interrupt driven, serial driver.
* - SSP driver.
diff --git a/ports/ARMCM3-STM32F103/port.dox b/ports/ARMCM3-STM32F103/port.dox
index 4d6e4ec31..08fd2d519 100644
--- a/ports/ARMCM3-STM32F103/port.dox
+++ b/ports/ARMCM3-STM32F103/port.dox
@@ -2,7 +2,7 @@
* @defgroup STM32F103 STM32F103 Support
* @{
* @brief STM32F103 specific support.
- * The STM32F103 support includes:
+ * @details The STM32F103 support includes:
* - Buffered, interrupt driven, serial driver.
* - A demo supporting the kernel test suite.
*
diff --git a/ports/ARMCM3/port.dox b/ports/ARMCM3/port.dox
index 28372e399..32f52337d 100644
--- a/ports/ARMCM3/port.dox
+++ b/ports/ARMCM3/port.dox
@@ -69,8 +69,9 @@
* @defgroup ARMCM3_CONF Configuration Options
* @{
* @brief ARM Cortex-M3 Configuration Options.
- * The ARMCM3 port allows some architecture-specific configurations settings
- * that can be specified externally, as example on the compiler command line:
+ * @details The ARMCM3 port allows some architecture-specific configurations
+ * settings that can be specified externally, as example on the compiler
+ * command line:
* - @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>
diff --git a/ports/AVR/port.dox b/ports/AVR/port.dox
index 2a789c5e4..8f455f208 100644
--- a/ports/AVR/port.dox
+++ b/ports/AVR/port.dox
@@ -40,8 +40,9 @@
* @defgroup AVR_CONF Configuration Options
* @{
* @brief AVR Configuration Options.
- * The AVR port allows some architecture-specific configurations settings
- * that can be specified externally, as example on the compiler command line:
+ * @details The AVR port allows some architecture-specific configurations
+ * settingsthat can be specified externally, as example on the compiler
+ * command line:
* - @p INT_REQUIRED_STACK, this value represent the amount of stack space
* used by the interrupt handlers.<br>
* The default for this value is @p 32, this space is allocated for each
diff --git a/ports/MSP430/port.dox b/ports/MSP430/port.dox
index d35317c75..108a44bd8 100644
--- a/ports/MSP430/port.dox
+++ b/ports/MSP430/port.dox
@@ -39,8 +39,9 @@
* @defgroup MSP430_CONF Configuration Options
* @{
* @brief MSP430 Configuration Options.
- * The MSP430 port allows some architecture-specific configurations settings
- * that can be specified externally, as example on the compiler command line:
+ * @details The MSP430 port allows some architecture-specific configurations
+ * settings that can be specified externally, as example on the compiler
+ * command line:
* - @p INT_REQUIRED_STACK, this value represent the amount of stack space
* used by the interrupt handlers.<br>
* The default for this value is @p 32, this space is allocated for each