You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: interop/cmsis/rtos2/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# CMSIS-RTOS2 Wrapper (`interop/cmsis-rtos2`)
1
+
# CMSIS-RTOS2 Wrapper (`interop/cmsis/rtos2`)
2
2
3
3
STK provides a complete **CMSIS-RTOS2** compatibility layer (`cmsis_os2_stk.cpp`) that maps the standard ARM [CMSIS-RTOS2 C API](https://arm-software.github.io/CMSIS_6/latest/RTOS2/group__CMSIS__RTOS.html) (`cmsis_os2.h` v2.3.0) onto the STK C++ kernel. This allows you to use STK as a drop-in RTOS backend in any project that targets the CMSIS-RTOS2 interface, including code generated by STM32CubeMX, MCUXpresso, or any other CMSIS-aware IDE or middleware stack.
4
4
@@ -24,9 +24,9 @@ See reference [CMSIS-RTOS2 example](https://github.com/SuperTinyKernel-RTOS/stk/
24
24
***Thread capacity:** Controlled by the `CMSIS_STK_MAX_THREADS` macro (default: 16). Increase it if more concurrent threads are needed.
***Timeouts:** CMSIS tick values are passed through directly as STK ticks (1:1 when tick resolution is 1 ms / `PERIODICITY_DEFAULT`). `osWaitForever` is translated to `stk::WAIT_INFINITE`.
27
-
***Thread flags & event flags:** Backed by `stk::sync::EventFlags`— STK's native 32-bit multi-flag synchronization primitive with ISR-safe `Set`/`Clear` and `ANY`/`ALL`/`NO_CLEAR` wait options.
28
-
***Message queues:** Backed by `stk::sync::MessageQueue`— STK's native fixed-capacity, fixed-message-size ring-buffer with integrated blocking `Put`/`Get`, ISR-safe `TryPut`/`TryGet`, and configurable timeouts.
29
-
***Memory pools:** Backed by `stk::memory::BlockMemoryPool`— STK's O(1), zero-fragmentation fixed-block allocator.
27
+
***Thread flags & event flags:** Backed by `stk::sync::EventFlags`- STK's native 32-bit multi-flag synchronization primitive with ISR-safe `Set`/`Clear` and `ANY`/`ALL`/`NO_CLEAR` wait options.
28
+
***Message queues:** Backed by `stk::sync::MessageQueue`- STK's native fixed-capacity, fixed-message-size ring-buffer with integrated blocking `Put`/`Get`, ISR-safe `TryPut`/`TryGet`, and configurable timeouts.
29
+
***Memory pools:** Backed by `stk::memory::BlockMemoryPool`- STK's O(1), zero-fragmentation fixed-block allocator.
30
30
***Timers:** Backed by `stk::time::TimerHost`. A single global `TimerHost` is created on the first `osTimerNew()` call.
31
31
***Static vs. heap allocation:** All CMSIS objects support the standard `cb_mem` / `cb_size` placement-new path (zero heap usage when caller provides memory), falling back to `operator new` when no buffer is supplied.
32
32
***Stack memory:** Thread stacks can be caller-supplied (`attr->stack_mem`) or heap-allocated. The default stack size is `CMSIS_STK_DEFAULT_STACK_WORDS` (default: 256 words).
0 commit comments