aboutsummaryrefslogtreecommitdiffstats
path: root/os
diff options
context:
space:
mode:
Diffstat (limited to 'os')
-rw-r--r--os/hal/platforms/STM32/platform.dox2
-rw-r--r--os/ports/GCC/ARMCMx/STM32F103/cmparams.h9
-rw-r--r--os/ports/GCC/ARMCMx/STM32F103/port.mk14
-rw-r--r--os/ports/GCC/ARMCMx/chcore.c6
-rw-r--r--os/ports/GCC/ARMCMx/chcore.h6
-rw-r--r--os/ports/GCC/ARMCMx/chtypes.h4
-rw-r--r--os/ports/GCC/ARMCMx/crt0.s6
-rw-r--r--os/ports/GCC/ARMCMx/nvic.c6
-rw-r--r--os/ports/GCC/ARMCMx/nvic.h6
-rw-r--r--os/ports/GCC/ARMCMx/port.dox80
10 files changed, 71 insertions, 68 deletions
diff --git a/os/hal/platforms/STM32/platform.dox b/os/hal/platforms/STM32/platform.dox
index 0eae343e2..3afdf9b70 100644
--- a/os/hal/platforms/STM32/platform.dox
+++ b/os/hal/platforms/STM32/platform.dox
@@ -30,7 +30,7 @@
* - A demo supporting the kernel test suite.
* - A demo that demonstrate the FatFs use with the MMC driver.
* .
- * @ingroup ARMCM3
+ * @ingroup ARMCMx
*/
/**
diff --git a/os/ports/GCC/ARMCMx/STM32F103/cmparams.h b/os/ports/GCC/ARMCMx/STM32F103/cmparams.h
index 29b4093be..e810d1868 100644
--- a/os/ports/GCC/ARMCMx/STM32F103/cmparams.h
+++ b/os/ports/GCC/ARMCMx/STM32F103/cmparams.h
@@ -18,10 +18,13 @@
*/
/**
- * @file ARMCM3/STM32F103/cmparams.h
- * @brief ARM Cortex-M3 STM32 specific parameters.
+ * @file ARMCMx/STM32F103/cmparams.h
+ * @brief ARM Cortex-M3 STM32F10x specific parameters.
*
- * @addtogroup ARMCM3_STM32F103
+ * @defgroup ARMCMx_STM32F10x STM32F10x specific parameters
+ * @ingroup ARMCMx
+ * @details This file contains the Cortex-M3 specific parameters for the
+ * STM32F10x platform.
* @{
*/
diff --git a/os/ports/GCC/ARMCMx/STM32F103/port.mk b/os/ports/GCC/ARMCMx/STM32F103/port.mk
index c656f7b10..758d400c2 100644
--- a/os/ports/GCC/ARMCMx/STM32F103/port.mk
+++ b/os/ports/GCC/ARMCMx/STM32F103/port.mk
@@ -1,10 +1,10 @@
# List of the ChibiOS/RT Cortex-M3 port files.
-PORTSRC = ${CHIBIOS}/os/ports/GCC/ARMCM3/chcore.c \
- ${CHIBIOS}/os/ports/GCC/ARMCM3/nvic.c \
- ${CHIBIOS}/os/ports/GCC/ARMCM3/cmsis/core_cm3.c
+PORTSRC = ${CHIBIOS}/os/ports/GCC/ARMCMx/chcore.c \
+ ${CHIBIOS}/os/ports/GCC/ARMCMx/nvic.c \
+ ${CHIBIOS}/os/ports/GCC/ARMCMx/cmsis/core_cm3.c
-PORTASM = ${CHIBIOS}/os/ports/GCC/ARMCM3/crt0.s
+PORTASM = ${CHIBIOS}/os/ports/GCC/ARMCMx/crt0.s
-PORTINC = ${CHIBIOS}/os/ports/GCC/ARMCM3 \
- ${CHIBIOS}/os/ports/GCC/ARMCM3/STM32F103 \
- ${CHIBIOS}/os/ports/GCC/ARMCM3/cmsis
+PORTINC = ${CHIBIOS}/os/ports/GCC/ARMCMx \
+ ${CHIBIOS}/os/ports/GCC/ARMCMx/STM32F103 \
+ ${CHIBIOS}/os/ports/GCC/ARMCMx/cmsis
diff --git a/os/ports/GCC/ARMCMx/chcore.c b/os/ports/GCC/ARMCMx/chcore.c
index 350adf9b0..1015f030d 100644
--- a/os/ports/GCC/ARMCMx/chcore.c
+++ b/os/ports/GCC/ARMCMx/chcore.c
@@ -18,10 +18,10 @@
*/
/**
- * @file ARMCM3/chcore.c
- * @brief ARM Cortex-M3 architecture port code.
+ * @file ARMCMx/chcore.c
+ * @brief ARM Cortex-Mx architecture port code.
*
- * @addtogroup ARMCM3_CORE
+ * @addtogroup ARMCMx_CORE
* @{
*/
diff --git a/os/ports/GCC/ARMCMx/chcore.h b/os/ports/GCC/ARMCMx/chcore.h
index a615386d2..4f355ecd0 100644
--- a/os/ports/GCC/ARMCMx/chcore.h
+++ b/os/ports/GCC/ARMCMx/chcore.h
@@ -18,10 +18,10 @@
*/
/**
- * @file ARMCM3/chcore.h
- * @brief ARM Cortex-M3 architecture port macros and structures.
+ * @file ARMCMx/chcore.h
+ * @brief ARM Cortex-Mx architecture port macros and structures.
*
- * @addtogroup ARMCM3_CORE
+ * @addtogroup ARMCMx_CORE
* @{
*/
diff --git a/os/ports/GCC/ARMCMx/chtypes.h b/os/ports/GCC/ARMCMx/chtypes.h
index f89ba4dc8..be89b04bf 100644
--- a/os/ports/GCC/ARMCMx/chtypes.h
+++ b/os/ports/GCC/ARMCMx/chtypes.h
@@ -18,9 +18,9 @@
*/
/**
- * @file ARMCM3/chtypes.h
+ * @file ARMCMx/chtypes.h
* @brief ARM Cortex-M3 architecture port system types.
- * @addtogroup ARMCM3_CORE
+ * @addtogroup ARMCMx_CORE
* @{
*/
diff --git a/os/ports/GCC/ARMCMx/crt0.s b/os/ports/GCC/ARMCMx/crt0.s
index 792ae1534..bb40ed950 100644
--- a/os/ports/GCC/ARMCMx/crt0.s
+++ b/os/ports/GCC/ARMCMx/crt0.s
@@ -18,9 +18,9 @@
*/
/**
- * @file ARMCM3/crt0.s
- * @brief Generic ARM Cortex-M3 startup file for ChibiOS/RT.
- * @addtogroup ARMCM3_CORE
+ * @file ARMCMx/crt0.s
+ * @brief Generic ARM Cortex-Mx startup file for ChibiOS/RT.
+ * @addtogroup ARMCMx_CORE
* @{
*/
/** @cond never */
diff --git a/os/ports/GCC/ARMCMx/nvic.c b/os/ports/GCC/ARMCMx/nvic.c
index 44a80584a..67551ec1d 100644
--- a/os/ports/GCC/ARMCMx/nvic.c
+++ b/os/ports/GCC/ARMCMx/nvic.c
@@ -18,9 +18,9 @@
*/
/**
- * @file ARMCM3/nvic.c
- * @brief Cortex-M3 NVIC support code.
- * @addtogroup ARMCM3_NVIC
+ * @file ARMCMx/nvic.c
+ * @brief Cortex-Mx NVIC support code.
+ * @addtogroup ARMCMx_NVIC
* @{
*/
diff --git a/os/ports/GCC/ARMCMx/nvic.h b/os/ports/GCC/ARMCMx/nvic.h
index 0538af307..8a9950fcf 100644
--- a/os/ports/GCC/ARMCMx/nvic.h
+++ b/os/ports/GCC/ARMCMx/nvic.h
@@ -18,9 +18,9 @@
*/
/**
- * @file ARMCM3/nvic.h
- * @brief Cortex-M3 NVIC support macros and structures.
- * @addtogroup ARMCM3_NVIC
+ * @file ARMCMx/nvic.h
+ * @brief Cortex-Mx NVIC support macros and structures.
+ * @addtogroup ARMCMx_NVIC
* @{
*/
diff --git a/os/ports/GCC/ARMCMx/port.dox b/os/ports/GCC/ARMCMx/port.dox
index e0c1ce350..6ec32f56f 100644
--- a/os/ports/GCC/ARMCMx/port.dox
+++ b/os/ports/GCC/ARMCMx/port.dox
@@ -18,35 +18,35 @@
*/
/**
- * @defgroup ARMCM3 ARM Cortex-M3
- * @details The ARM Cortex-M3 architecture is quite complex for a
- * microcontroller and some explanations are required about the port choices.
+ * @defgroup ARMCMx ARM Cortex-Mx
+ * @details This port supports the ARM Cortex-Mx architectures, specifically
+ * the Cortex-M0 and the Cortex-M3.
*
- * @section ARMCM3_STATES Mapping of the System States in the ARM Cortex-M3 port
+ * @section ARMCMx_STATES Mapping of the System States in the ARM Cortex-Mx port
* The ChibiOS/RT logical @ref system_states are mapped as follow in the ARM
- * Cortex-M3 port:
+ * Cortex-Mx port:
* - <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
- * set at @p BASEPRI_USER level, interrupts are not masked. The processor
- * is running in thread-privileged mode.
+ * @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
- * masked but the BASEPRI register is set to @p BASEPRI_KERNEL thus masking
- * any interrupt source with lower or equal priority. The processor
+ * masked but the BASEPRI register is set to @p CORTEX_BASEPRI_KERNEL thus
+ * masking any interrupt source with lower or equal priority. The processor
* is running in thread-privileged mode.
* - <b>Disabled</b>. Interrupt sources are globally masked. The processor
* is running in thread-privileged mode.
* - <b>Sleep</b>. This state is entered with the execution of the specific
* instruction @p <b>wfi</b>.
* - <b>S-Locked</b>. In this state the interrupt sources are not globally
- * masked but the BASEPRI register is set to @p BASEPRI_KERNEL thus masking
- * any interrupt source with lower or equal priority. The processor
+ * masked but the BASEPRI register is set to @p CORTEX_BASEPRI_KERNEL thus
+ * masking any interrupt source with lower or equal priority. The processor
* is running in thread-privileged mode.
* - <b>I-Locked</b>. In this state the interrupt sources are not globally
- * masked but the BASEPRI register is set to @p BASEPRI_KERNEL thus masking
- * any interrupt source with lower or equal priority. The processor
+ * masked but the BASEPRI register is set to @p CORTEX_BASEPRI_KERNEL thus
+ * masking any interrupt source with lower or equal priority. The processor
* is running in exception-privileged mode.
* - <b>Serving Regular Interrupt</b>. In this state the interrupt sources are
* not globally masked but only interrupts with higher priority can preempt
@@ -54,15 +54,15 @@
* - <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 to be in 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 ARMCM3_NOTES The ARM Cortex-M3 port notes
- * The ARM Cortex-M3 port is organized as follow:
+ * @section ARMCMx_NOTES The ARM Cortex-Mx port notes
+ * The ARM Cortex-Mx port is organized as follow:
* - The @p main() function is invoked in thread-privileged mode.
* - Each thread has a private process stack, the system has a single main
* stack where all the interrupts and exceptions are processed.
@@ -70,8 +70,8 @@
* to be zero.
* - The threads are started in thread-privileged mode with BASEPRI level
* 0x00 (disabled).
- * - The kernel raises its BASEPRI level to @p BASEPRI_KERNEL in order to
- * protect the kernel data structures.
+ * - The kernel raises its BASEPRI level to @p CORTEX_BASEPRI_KERNEL in order
+ * to protect the kernel data structures.
* - Interrupt nesting and the other advanced NVIC features are supported.
* - The SVC instruction and vector, with parameter #0, is internally used
* for commanded context switching.<br>
@@ -83,9 +83,9 @@
*/
/**
- * @defgroup ARMCM3_CONF Configuration Options
- * @brief ARM Cortex-M3 Configuration Options.
- * @details The ARMCM3 port allows some architecture-specific configurations
+ * @defgroup ARMCMx_CONF Configuration Options
+ * @brief ARM Cortex-Mx Configuration Options.
+ * @details The ARMCMx 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
@@ -94,35 +94,35 @@
* In the current implementation this value is guaranteed to be zero so
* there is no need to modify this value unless changes are done at the
* interrupts handling code.
- * - @p BASEPRI_USER, this is the @p BASEPRI value for the user threads. The
- * default value is @p 0 (disabled).<br>
+ * - @p CORTEX_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.
- * - @p BASEPRI_KERNEL, this is the @p BASEPRI value for the kernel lock code.
- * The default value is 0x40.<br>
+ * Cortex-Mx technical reference manual for a detailed description.
+ * - @p CORTEX_BASEPRI_KERNEL, this is the @p BASEPRI value for the kernel lock
+ * code.<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.
+ * Cortex-Mx technical reference manual for a detailed description.
* - @p ENABLE_WFI_IDLE, if set to @p 1 enables the use of the @p <b>wfi</b>
* 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.
* .
- * @ingroup ARMCM3
+ * @ingroup ARMCMx
*/
/**
- * @defgroup ARMCM3_CORE Core Port Implementation
- * @brief ARM Cortex-M3 specific port code, structures and macros.
+ * @defgroup ARMCMx_CORE Core Port Implementation
+ * @brief ARM Cortex-Mx specific port code, structures and macros.
*
- * @ingroup ARMCM3
+ * @ingroup ARMCMx
*/
/**
- * @defgroup ARMCM3_STARTUP Startup Support
- * @brief ARM Cortex-M3 startup code support.
+ * @defgroup ARMCMx_STARTUP Startup Support
+ * @brief ARM Cortex-Mx startup code support.
* @details ChibiOS/RT provides its own generic startup file for the ARM
- * Cortex-M3 port.
+ * Cortex-Mx port.
* Of course it is not mandatory to use it but care should be taken about the
* startup phase details.
*
@@ -158,13 +158,13 @@
* - @p _bss_start BSS start location.
* - @p _bss_end BSS end location +1.
* .
- * @ingroup ARMCM3
- * @file ARMCM3/crt0.s Startup code.
+ * @ingroup ARMCMx
+ * @file ARMCMx/crt0.s Startup code.
*/
/**
- * @defgroup ARMCM3_NVIC NVIC Support
- * @brief ARM Cortex-M3 NVIC support.
+ * @defgroup ARMCMx_NVIC NVIC Support
+ * @brief ARM Cortex-Mx NVIC support.
*
- * @ingroup ARMCM3
+ * @ingroup ARMCMx
*/
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-24 04:07:05 +0000