Skip to content

Commit 8ba180d

Browse files
committed
Enhanced documentation to state that ARM Compiler v6 is not supported by FreeRTOS.
1 parent ac1b401 commit 8ba180d

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

DoxyGen/General/src/cmsis_freertos.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,11 @@ multi-core systems, and has a binary compatible interface across ABI compliant c
1919

2020
Using this software pack, users can choose between a native FreeRTOS implementation or one that is adhering to the
2121
CMSIS-RTOS2 API and using FreeRTOS under the hood. The CMSIS-RTOS2 API enables programmers to create portable application
22-
code to be used with different RTOS kernels (for example
23-
<a class="el" href="http://www.keil.com/mdk5/cmsis/rtx">Keil RTX5</a>).
22+
code to be used with different RTOS kernels (for example <a class="el" href="http://www.keil.com/mdk5/cmsis/rtx">Keil RTX5</a>).
23+
24+
\b Note: FreeRTOS does not support ARM Compiler v6, yet! Please refere to the
25+
<a target="_blank" href="http://www.freertos.org/FreeRTOS_Support_Forum_Archive/May_2016/freertos_Anyone_Working_on_a_Port_to_Keil_ARM_Compiler_6.4_ARMCLANG_9deb244ej.html">
26+
FreeRTOS Support Archive.</a>
2427

2528
This documentation shows you:
2629
- how to \ref cre_freertos_proj "create a new microcontroller project" using FreeRTOS from scratch.
@@ -225,6 +228,7 @@ This lists the technical data of CMSIS-FreeRTOS.
225228
\section td_limitations Limitations
226229

227230
The following list briefly describes the limitations and unsupported features of the CMSIS-RTOS2 wrapper for FreeRTOS:
231+
- ARM Compiler v6 is not supported by FreeRTOS, yet.
228232
- Static memory allocation will only work if \a all memory (from attributes structure) is provided statically. In order to
229233
allocate object memory statically, you need to:
230234
- provide the memory for control blocks and stack in the \c osThreadAttr_t structure for threads.

0 commit comments

Comments
 (0)