Skip to content

Commit b853f01

Browse files
wearyzennashif
authored andcommitted
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 <sudan.landge@arm.com>
1 parent 219fae6 commit b853f01

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-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/migration-guide-4.2.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -585,6 +585,20 @@ Other subsystems
585585
Modules
586586
*******
587587

588+
CMSIS
589+
=====
590+
591+
* Cortex-M boards/socs now require the ``CMSIS_6`` module to build properly (instead of ``cmsis``
592+
which was CMSIS 5.9.0).
593+
If trying to build a Cortex-M board, do a ``west update`` to make sure that ``CMSIS_6`` module is
594+
available before running ``west build`` or other commands.
595+
596+
Boards or SOCs or modules using the older ``cmsis`` module either with a local copy or via the
597+
:kconfig:option:`CONFIG_ZEPHYR_CMSIS_MODULE_DIR` are requested to move to the ``CMSIS_6`` module
598+
which can be accessed via the :kconfig:option:`CONFIG_ZEPHYR_CMSIS_6_MODULE_DIR` configuration.
599+
600+
Note: Zephyr will continue using the older ``cmsis`` module for Cortex-A and Cortex-R targets.
601+
588602
Architectures
589603
*************
590604

0 commit comments

Comments
 (0)