DoxyGen: Rework RTX migration guide kernel startup procedure. (Issue
@@ -10,11 +10,11 @@ modifications.
Only a few incompatibilities and limitations exist:
- Kernel startup\n
- The function \c osKernelRunning has been deprecated. "main" was usually a running thread in v1 implementations, which is
- not the case in v2 anymore. It was also possible to not even initialize and start the Kernel, but just to assume that
- "main" was a running thread. Portable code would typically initialize the Kernel (\ref osKernelInitialize) and then start
- the Kernel (\ref osKernelStart) or skip that part if \c osKernelRunning indicated that it is already running.\n
- The example code below shows how to overcome this situation.
+ - The function \c osKernelRunning has been removed in CMSIS-RTOS v2, use osKernelGetState() instead.
+ - Function \c main was usually a running thread in CMSIS-RTOS v1 implementations, which is not the case in CMSIS-RTOS v2
+ anymore. The Kernel was running even without calling corresponding APIs to initialize and start the Kernel explicitly.
+ In CMSIS-RTOS v2 the Kernel needs be initialized by calling osKernelInitialize() and must be started by calling
+ osKernelStart().
- OS tick\n
RTX5 uses the \ref CMSIS_RTOS_TickAPI to configure the tick interrupts. The interval calculation is typically based on
\c SystemCoreClock variable. Thus one has to assure this variable is set correctly before calling \ref osKernelStart.
