Skip to content

Commit 29f6808

Browse files
committed
doc: Update on switch to CMSIS_6
Add a note to announce the switch to CMSIS_6 for Cortex-M arch. Signed-off-by: Sudan Landge <[email protected]>
1 parent 6e9cfcd commit 29f6808

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

doc/hardware/arch/arm_cortex_m.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -632,8 +632,16 @@ script as well.
632632
CMSIS
633633
*****
634634

635-
Cortex-M CMSIS headers are hosted in a standalone module repository:
636-
`zephyrproject-rtos/cmsis <https://github.com/zephyrproject-rtos/cmsis>`_.
635+
Cortex-M CMSIS headers are provided through standalone module repositories:
636+
637+
- **CMSIS 5**: `zephyrproject-rtos/cmsis <https://github.com/zephyrproject-rtos/cmsis>`_
638+
- **CMSIS 6**: `zephyrproject-rtos/CMSIS_6 <https://github.com/zephyrproject-rtos/CMSIS_6>`_
639+
640+
Zephyr has begun transitioning to **CMSIS 6** as the default source for Cortex-M core headers.
641+
However, at present, Zephyr includes headers from **both** the CMSIS 6 and legacy CMSIS 5 modules.
642+
643+
The legacy CMSIS 5 headers remain available primarily for compatibility with vendor HALs, while all
644+
new architecture-level development should use **CMSIS 6** headers whenever possible.
637645

638646
:kconfig:option:`CONFIG_CPU_CORTEX_M` selects :kconfig:option:`CONFIG_HAS_CMSIS_CORE` to signify that
639647
CMSIS headers are available for all supported Cortex-M variants.

doc/releases/release-notes-4.2.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -771,3 +771,9 @@ Other notable changes
771771

772772
* Updated TF-M to version 2.1.2 (from 2.1.1). The release notes can be found at:
773773
https://trustedfirmware-m.readthedocs.io/en/tf-mv2.1.2/releases/2.1.2.html
774+
775+
* As of commit f726cb5123eda12feb8746e3acb34a1f7d7b0340, Zephyr now uses the ``CMSIS_6`` module
776+
(instead of ``cmsis`` which was CMSIS 5.9.0) for Cortex-M architectures.
777+
Other modules still relying on the older ``cmsis`` module are encouraged to migrate to ``CMSIS_6``.
778+
The path to the ``CMSIS_6`` module can be accessed via the ``CONFIG_ZEPHYR_CMSIS_6_MODULE_DIR`` configuration.
779+
Note: Zephyr will continue using the older ``cmsis`` module for Cortex-A and Cortex-R targets.

0 commit comments

Comments
 (0)