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: * - None, APIs without any suffix can be invoked only from the user * code in the Normal state unless differently specified. See * @ref system_states. @@ -84,10 +83,12 @@ * - Regular Interrupts. 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. * - Fast Interrupts. 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.
+ * 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.
* 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.

* @image html workspace.png *
@@ -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.
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.
* 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.
* The default for this value is @p 32, this space is allocated for each