README.md
1## Overview
2
3This directory provides a FreeRTOS-Kernel port that can be used with the Raspberry Pi Pico SDK. It supports:
4
5 * Simple CMake INTERFACE libraries, to provide the FreeRTOS-Kernel and also the individual allocator types, without copying code into the user's project.
6 * Running the FreeRTOS-Kernel and tasks on either core 0 or core 1
7 * Use of SDK synchronization primitives (such as mutexes, semaphores, queues from pico_sync) between FreeRTOS tasks and code executing on the other core, or in IRQ handlers.
8
9Note that a FreeRTOS SMP version of this port is also available in the FreeRTOS-Kernel smp branch, which additionally supports utilizing both RP2040 CPU cores for FreeRTOS tasks simultaneously.
10
11## Using this port
12
13You can copy [FreeRTOS-Kernel-import.cmake](FreeRTOS-Kernel-import.cmake) into your project, and
14add the following in your `CMakeLists.txt`:
15
16```cmake
17include(FreeRTOS_Kernel_import.cmake)
18```
19
20This will locate the FreeRTOS kernel if it is a direct sub-module of your project, or if you provide the
21`FREERTOS_KERNEL_PATH` variable in your environment or via `-DFREERTOS_KERNEL_PATH=/path/to/FreeRTOS-Kernel` on the CMake command line.
22
23**NOTE:** If you are using version 1.3.1 or older of the Raspberry Pi Pico SDK then this line must appear before the
24`pico_sdk_init()` and will cause FreeRTOS to be included/required in all RP2040 targets in your project. After this SDK
25version, you can include the FreeRTOS-Kernel support later in your CMake build (possibly in a subdirectory) and the
26FreeRTOS-Kernel support will only apply to those targets which explicitly include FreeRTOS support.
27
28As an alternative to the `import` statement above, you can just add this directory directly via thw following (with
29the same placement restrictions related to the Raspberry Pi Pico SDK version above):
30
31```cmake
32add_subdirectory(path/to/this/directory FreeRTOS-Kernel)
33```
34
35
36## Advanced Configuration
37
38Some additional `config` options are defined [here](include/rp2040_config.h) which control some low level implementation details.
39
40## Known Limitations
41
42- Tickless idle has not currently been tested, and is likely non-functional
43
