CMSIS-RTOS: System Configuration

| CMSIS-RTOS Version 1.03 Real-Time Operating System: API and RTX Reference Implementation.

- Main Page
- Usage and Description
- Reference

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
System Configuration

The CMSIS-RTOS RTX provides system-wide settings for:

- Settings for Round-Robin Thread Switching
- User Timer Management

# Settings for Round-Robin Thread Switching

CMSIS-RTOS RTX may be configured to use round-robin multitasking thread switching. Round-robin allows quasi-parallel execution of several threads of the same priority. Threads are not really executed concurrently, but are scheduled where the available CPU time is divided into time slices and CMSIS-RTOS RTX assigns a time slice to each thread. Because the time slice is typically short (only a few milliseconds), it appears as though threads execute simultaneously.

Round-robin thread switching functions as follows:

- the tick is preloaded with the timeout value when a thread switch occurs
- the tick is decremented (if not already zero) each system tick if the same thread is still executing
- when the tick reaches 0 it indicates that a timeout has occurred. If there is another thread ready with the same priority, then the system switches to that thread and the tick is preloaded with timeout again.

In other words, threads execute for the duration of their time slice (unless a thread's time slice is given up). Then, RTX switches to the next thread that is in READY state and has the same priority. If no other thread with the same priority is ready to run, the current running thread resumes it execution.

Note
  When switching to higher priority threads, the round-robin timeout value is reset.

Round-Robin multitasking is controlled with the #define OS_ROBIN. The time slice period is configured (in RTX Timer ticks) with the #define OS_ROBINTOUT.

Code Example:

The following example shows a simple CMSIS-RTOS RTX program that uses Round-Robin Multitasking. The two threads in this program are counter loops. RTX starts executing job 1, which is the function named job1. This function creates another task called job2. After job1 executes for its time slice, RTX switches to job2. After job2 executes for its time slice, RTX switches back to job1. This process repeats indefinitely.

#include "cmsis_os.h" // CMSIS-RTOS header file
int counter1;
int counter2;
void job1 (void const *arg) {
while (1) { // loop forever
counter1++; // update the counter
}
}
void job2 (void const *arg) {
while (1) { // loop forever
counter2++; // update the counter
}
}
osThreadDef (job1, osPriorityAboveNormal, 1, 0);
osThreadDef (job2, osPriorityAboveNormal, 1, 0);
int main (void) {
osKernelInitialize (); // setup kernel
osThreadCreate (osThread(job1), NULL); // create threads
osThreadCreate (osThread(job2), NULL);
osKernelStart (); // start kernel
}

Note
  Rather than waiting for a thread time slice to expire, use CMSIS-RTOS functions to signal to the RTX kernel that it can switch to another task. The function osThreadYield passes control to other threads without Round-Robin Multitasking.

# User Timer Management

CMSIS-RTOS RTX supports Timer Management which provides timer callback functions. The Timer Management is configured with the following #defines:

Name | #define | Description
--- | --- | ---
User Timers | `OS_TIMERS` | Enables the Timer Management. When disabled, the osTimerThread is not created.
Timer Thread Priority | `OS_TIMERPRIO` | Specifies the priority of the osTimerThread that executes the timer callback functions.
Timer Thread stack size [bytes] | `OS_TIMERSTKSZ` | Specifies the stack size (in words) for the the osTimerThread.
Timer Callback Queue size | `OS_TIMERCBQS` | Specifies the maximum number of concurrent timer callbacks.

Note
  Refer to CMSIS-RTOS RTX Threads for more information about the osTimerThread.

# ISR FIFO Queue size

ISR functions store requests to this buffer, when they are called from the interrupt handler. The default value for #define OS_FIFOSZ is 16.