git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3017 35acf78f-673a-0410-8e92-d51de3d6d3f4

4 files changed, 100 insertions, 37 deletions

diff --git a/os/ports/GCC/ARMCMx/crt0.c b/os/ports/GCC/ARMCMx/crt0.c
index 685231ed1..0bb88dd83 100644
--- a/os/ports/GCC/ARMCMx/crt0.c
+++ b/os/ports/GCC/ARMCMx/crt0.c
@@ -21,7 +21,7 @@
  * @file    ARMCMx/crt0.c

  * @brief   Generic ARMvx-M (Cortex-M0/M1/M3/M4) startup file for ChibiOS/RT.

  *

- * @addtogroup ARMCMx_CORE

+ * @addtogroup ARMCMx_STARTUP

  * @{

  */

 

diff --git a/os/ports/GCC/ARMCMx/port.dox b/os/ports/GCC/ARMCMx/port.dox
index 689791c2f..8f5efc9aa 100644
--- a/os/ports/GCC/ARMCMx/port.dox
+++ b/os/ports/GCC/ARMCMx/port.dox
@@ -159,17 +159,24 @@
  * - @p IDLE_THREAD_STACK_SIZE, stack area size to be assigned to the IDLE

  *   thread. Usually there is no need to change this value unless inserting

  *   code in the IDLE thread using the @p IDLE_LOOP_HOOK hook macro.

- * - @p CORTEX_BASEPRI_KERNEL, this is the @p BASEPRI value for the kernel lock

- *   code. Code running at higher priority levels must not invoke any OS API.

- *   This setting is specific to the ARMv7-M architecture.

  * - @p CORTEX_PRIORITY_SYSTICK, priority of the SYSTICK handler.

- * - @p CORTEX_PRIORITY_SVCALL, priority of the SVCALL handler.

  * - @p CORTEX_PRIORITY_PENDSV, priority of the PENDSV handler.

  * - @p CORTEX_ENABLE_WFI_IDLE, if set to @p TRUE enables the use of the

  *   @p <b>wfi</b> instruction from within the idle loop. This option is

  *   defaulted to FALSE because it can create problems with some debuggers.

  *   Setting this option to TRUE reduces the system power requirements.

  * .

+ * @section ARMCMx_CONF_1 ARMv6-M specific options

+ * The following options are specific for the ARMv6-M architecture:

+ * - @p CORTEX_ALTERNATE_SWITCH, when activated makes the OS use the PendSV

+ *   exception instead of NMI as preemption handler.

+ * .

+ * @section ARMCMx_CONF_2 ARMv7-M specific options

+ * The following options are specific for the ARMv6-M architecture:

+ * - @p CORTEX_PRIORITY_SVCALL, priority of the SVCALL handler.

+ * - @p CORTEX_SIMPLIFIED_PRIORITY, when enabled activates the Compact kernel

+ *   mode.

+ * .

  * @ingroup ARMCMx

  */

 

@@ -219,15 +226,19 @@
  * @section ARMCMx_STARTUP_2 Expected linker symbols

  * The startup code starts at the symbol @p ResetHandler and expects the

  * following symbols to be defined in the linker script:

- * - @p __ram_end__ RAM end location +1.

+ * - @p __ram_end__ End of RAM.

  * - @p __main_stack_size__ Exception stack size.

  * - @p __process_stack_size__ Process stack size. This is the stack area used

  *      by the @p main() function.

- * - @p _textdata address of the data segment source read only data.

- * - @p _data data segment start location.

- * - @p _edata data segment end location +1.

- * - @p _bss_start BSS start location.

- * - @p _bss_end BSS end location +1.

+ * - @p _textdata Address of the data segment source read only data.

+ * - @p _data Start of the data segment.

+ * - @p _edata End of the data segment end location.

+ * - @p _bss_start Start of the BSS.

+ * - @p _bss_end End of the BSS segment.

+ * - @p __init_array_start Start of the constructors array.

+ * - @p __init_array_end End of the constructors array.

+ * - @p __fini_array_start Start of the destructors array.

+ * - @p __fini_array_end End of the destructors array.

  * .

  * @ingroup ARMCMx

  */

diff --git a/os/ports/IAR/ARMCMx/port.dox b/os/ports/IAR/ARMCMx/port.dox
index 22bd3cea3..3e10318ce 100644
--- a/os/ports/IAR/ARMCMx/port.dox
+++ b/os/ports/IAR/ARMCMx/port.dox
@@ -26,9 +26,28 @@
  * This port supports all the cores implementing the ARMv6-M and ARMv7-M

  * architectures.

  *

- * @section IAR_ARMCMx_STATES_A System logical states in ARMv6-M mode

- * The ChibiOS/RT logical @ref system_states are mapped as follow in the ARM

- * Cortex-M0 port:

+ * @section IAR_ARMCMx_MODES Kernel Modes

+ * The Cortex-Mx port supports two distinct kernel modes:

+ * - <b>Advanced Kernel</b> mode. In this mode the kernel only masks

+ *   interrupt sources with priorities below or equal to the

+ *   @p CORTEX_BASEPRI_KERNEL level. Higher priorities are not affected by

+ *   the kernel critical sections and can be used for fast interrupts.

+ *   This mode is not available in the ARMv6-M architecture which does not

+ *   support priority masking.

+ * - <b>Compact Kernel</b> mode. In this mode the kernel handles IRQ priorities

+ *   in a simplified way, all interrupt sources are disabled when the kernel

+ *   enters into a critical zone and re-enabled on exit. This is simple and

+ *   adequate for most applications, this mode results in a more compact and

+ *   faster kernel.

+ * .

+ * The selection of the mode is performed using the port configuration option

+ * @p CORTEX_SIMPLIFIED_PRIORITY. Apart from the different handling of

+ * interrupts there are no other differences between the two modes. The

+ * kernel API is exactly the same.

+ *

+ * @section IAR_ARMCMx_STATES_A System logical states in Compact Kernel mode

+ * The ChibiOS/RT logical @ref system_states are mapped as follow in Compact

+ * Kernel mode:

  * - <b>Init</b>. This state is represented by the startup code and the

  *   initialization code before @p chSysInit() is executed. It has not a

  *   special hardware state associated.

@@ -53,21 +72,21 @@
  *   mode.

  * - <b>Serving Fast Interrupt</b>. This state is not implemented in the

  *   ARMv6-M implementation.

- * - <b>Serving Non-Maskable Interrupt</b>. The Cortex-M3 has a specific

+ * - <b>Serving Non-Maskable Interrupt</b>. The Cortex-Mx has a specific

  *   asynchronous NMI vector and several synchronous fault vectors that can

  *   be considered belonging to this category.

  * - <b>Halted</b>. Implemented as an infinite loop after globally masking all

  *   the maskable interrupt sources. The ARM state is whatever the processor

  *   was running when @p chSysHalt() was invoked.

  *

- * @section IAR_ARMCMx_STATES_B System logical states in ARMv7-M mode

- * The ChibiOS/RT logical @ref system_states are mapped as follow in the ARM

- * Cortex-M3 port:

+ * @section IAR_ARMCMx_STATES_B System logical states in Advanced Kernel mode

+ * The ChibiOS/RT logical @ref system_states are mapped as follow in the

+ * Advanced Kernel mode:

  * - <b>Init</b>. This state is represented by the startup code and the

  *   initialization code before @p chSysInit() is executed. It has not a

  *   special hardware state associated.

  * - <b>Normal</b>. This is the state the system has after executing

- *   @p chSysInit(). In this state the ARM Cortex-M3 has the BASEPRI register

+ *   @p chSysInit(). In this state the ARM Cortex-Mx has the BASEPRI register

  *   set at @p CORTEX_BASEPRI_USER level, interrupts are not masked. The

  *   processor is running in thread-privileged mode.

  * - <b>Suspended</b>. In this state the interrupt sources are not globally

@@ -93,7 +112,7 @@
  * - <b>Serving Fast Interrupt</b>. It is basically the same of the SRI state

  *   but it is not possible to switch to the I-Locked state because fast

  *   interrupts can preempt the kernel critical zone.

- * - <b>Serving Non-Maskable Interrupt</b>. The Cortex-M3 has a specific

+ * - <b>Serving Non-Maskable Interrupt</b>. The Cortex-Mx has a specific

  *   asynchronous NMI vector and several synchronous fault vectors that can

  *   be considered belonging to this category.

  * - <b>Halted</b>. Implemented as an infinite loop after globally masking all

@@ -140,17 +159,24 @@
  * - @p IDLE_THREAD_STACK_SIZE, stack area size to be assigned to the IDLE

  *   thread. Usually there is no need to change this value unless inserting

  *   code in the IDLE thread using the @p IDLE_LOOP_HOOK hook macro.

- * - @p CORTEX_BASEPRI_KERNEL, this is the @p BASEPRI value for the kernel lock

- *   code. Code running at higher priority levels must not invoke any OS API.

- *   This setting is specific to the ARMv7-M architecture.

  * - @p CORTEX_PRIORITY_SYSTICK, priority of the SYSTICK handler.

- * - @p CORTEX_PRIORITY_SVCALL, priority of the SVCALL handler.

  * - @p CORTEX_PRIORITY_PENDSV, priority of the PENDSV handler.

  * - @p CORTEX_ENABLE_WFI_IDLE, if set to @p TRUE enables the use of the

  *   @p <b>wfi</b> instruction from within the idle loop. This option is

  *   defaulted to FALSE because it can create problems with some debuggers.

  *   Setting this option to TRUE reduces the system power requirements.

  * .

+ * @section IAR_ARMCMx_CONF_1 ARMv6-M specific options

+ * The following options are specific for the ARMv6-M architecture:

+ * - @p CORTEX_ALTERNATE_SWITCH, when activated makes the OS use the PendSV

+ *   exception instead of NMI as preemption handler.

+ * .

+ * @section IAR_ARMCMx_CONF_2 ARMv7-M specific options

+ * The following options are specific for the ARMv6-M architecture:

+ * - @p CORTEX_PRIORITY_SVCALL, priority of the SVCALL handler.

+ * - @p CORTEX_SIMPLIFIED_PRIORITY, when enabled activates the Compact kernel

+ *   mode.

+ * .

  * @ingroup IAR_ARMCMx

  */

 

diff --git a/os/ports/RVCT/ARMCMx/port.dox b/os/ports/RVCT/ARMCMx/port.dox
index 83793d5d4..c69fcdd27 100644
--- a/os/ports/RVCT/ARMCMx/port.dox
+++ b/os/ports/RVCT/ARMCMx/port.dox
@@ -26,9 +26,28 @@
  * This port supports all the cores implementing the ARMv6-M and ARMv7-M

  * architectures.

  *

- * @section RVCT_ARMCMx_STATES_A System logical states in ARMv6-M mode

- * The ChibiOS/RT logical @ref system_states are mapped as follow in the ARM

- * Cortex-M0 port:

+ * @section RVCT_ARMCMx_MODES Kernel Modes

+ * The Cortex-Mx port supports two distinct kernel modes:

+ * - <b>Advanced Kernel</b> mode. In this mode the kernel only masks

+ *   interrupt sources with priorities below or equal to the

+ *   @p CORTEX_BASEPRI_KERNEL level. Higher priorities are not affected by

+ *   the kernel critical sections and can be used for fast interrupts.

+ *   This mode is not available in the ARMv6-M architecture which does not

+ *   support priority masking.

+ * - <b>Compact Kernel</b> mode. In this mode the kernel handles IRQ priorities

+ *   in a simplified way, all interrupt sources are disabled when the kernel

+ *   enters into a critical zone and re-enabled on exit. This is simple and

+ *   adequate for most applications, this mode results in a more compact and

+ *   faster kernel.

+ * .

+ * The selection of the mode is performed using the port configuration option

+ * @p CORTEX_SIMPLIFIED_PRIORITY. Apart from the different handling of

+ * interrupts there are no other differences between the two modes. The

+ * kernel API is exactly the same.

+ *

+ * @section RVCT_ARMCMx_STATES_A System logical states in Compact Kernel mode

+ * The ChibiOS/RT logical @ref system_states are mapped as follow in Compact

+ * Kernel mode:

  * - <b>Init</b>. This state is represented by the startup code and the

  *   initialization code before @p chSysInit() is executed. It has not a

  *   special hardware state associated.

@@ -53,21 +72,21 @@
  *   mode.

  * - <b>Serving Fast Interrupt</b>. This state is not implemented in the

  *   ARMv6-M implementation.

- * - <b>Serving Non-Maskable Interrupt</b>. The Cortex-M3 has a specific

+ * - <b>Serving Non-Maskable Interrupt</b>. The Cortex-Mx has a specific

  *   asynchronous NMI vector and several synchronous fault vectors that can

  *   be considered belonging to this category.

  * - <b>Halted</b>. Implemented as an infinite loop after globally masking all

  *   the maskable interrupt sources. The ARM state is whatever the processor

  *   was running when @p chSysHalt() was invoked.

  *

- * @section RVCT_ARMCMx_STATES_B System logical states in ARMv7-M mode

- * The ChibiOS/RT logical @ref system_states are mapped as follow in the ARM

- * Cortex-M3 port:

+ * @section RVCT_ARMCMx_STATES_B System logical states in Advanced Kernel mode

+ * The ChibiOS/RT logical @ref system_states are mapped as follow in the

+ * Advanced Kernel mode:

  * - <b>Init</b>. This state is represented by the startup code and the

  *   initialization code before @p chSysInit() is executed. It has not a

  *   special hardware state associated.

  * - <b>Normal</b>. This is the state the system has after executing

- *   @p chSysInit(). In this state the ARM Cortex-M3 has the BASEPRI register

+ *   @p chSysInit(). In this state the ARM Cortex-Mx has the BASEPRI register

  *   set at @p CORTEX_BASEPRI_USER level, interrupts are not masked. The

  *   processor is running in thread-privileged mode.

  * - <b>Suspended</b>. In this state the interrupt sources are not globally

@@ -93,7 +112,7 @@
  * - <b>Serving Fast Interrupt</b>. It is basically the same of the SRI state

  *   but it is not possible to switch to the I-Locked state because fast

  *   interrupts can preempt the kernel critical zone.

- * - <b>Serving Non-Maskable Interrupt</b>. The Cortex-M3 has a specific

+ * - <b>Serving Non-Maskable Interrupt</b>. The Cortex-Mx has a specific

  *   asynchronous NMI vector and several synchronous fault vectors that can

  *   be considered belonging to this category.

  * - <b>Halted</b>. Implemented as an infinite loop after globally masking all

@@ -140,17 +159,24 @@
  * - @p IDLE_THREAD_STACK_SIZE, stack area size to be assigned to the IDLE

  *   thread. Usually there is no need to change this value unless inserting

  *   code in the IDLE thread using the @p IDLE_LOOP_HOOK hook macro.

- * - @p CORTEX_BASEPRI_KERNEL, this is the @p BASEPRI value for the kernel lock

- *   code. Code running at higher priority levels must not invoke any OS API.

- *   This setting is specific to the ARMv7-M architecture.

  * - @p CORTEX_PRIORITY_SYSTICK, priority of the SYSTICK handler.

- * - @p CORTEX_PRIORITY_SVCALL, priority of the SVCALL handler.

  * - @p CORTEX_PRIORITY_PENDSV, priority of the PENDSV handler.

  * - @p CORTEX_ENABLE_WFI_IDLE, if set to @p TRUE enables the use of the

  *   @p <b>wfi</b> instruction from within the idle loop. This option is

  *   defaulted to FALSE because it can create problems with some debuggers.

  *   Setting this option to TRUE reduces the system power requirements.

  * .

+ * @section RVCT_ARMCMx_CONF_1 ARMv6-M specific options

+ * The following options are specific for the ARMv6-M architecture:

+ * - @p CORTEX_ALTERNATE_SWITCH, when activated makes the OS use the PendSV

+ *   exception instead of NMI as preemption handler.

+ * .

+ * @section RVCT_ARMCMx_CONF_2 ARMv7-M specific options

+ * The following options are specific for the ARMv6-M architecture:

+ * - @p CORTEX_PRIORITY_SVCALL, priority of the SVCALL handler.

+ * - @p CORTEX_SIMPLIFIED_PRIORITY, when enabled activates the Compact kernel

+ *   mode.

+ * .

  * @ingroup RVCT_ARMCMx

  */