freertos-teensy - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #llm #machine-learning #deep-learning #linux #nodejs #java #windows #cli #vue #mcp #open-source

freertos-teensy

(★ 135)

FreeRTOS port with C++ std::thread support for ARM boards Teensy 4.0 and 4.1 (cortex-m4f and cortex-m7f)

파일 탐색기

최종 버전 다운로드 (.zip)

- - LICENSE.html
  - README.md
- - GitHub-FreeRTOS-Kernel-Home.url
  - History.txt
  - LICENSE.md
  - Quick_Start_Guide.url
  - README.md
- - .gitignore
  - platformio.ini
- - customYield.ino
  - customYield.md
  - main.cpp
  - yieldStuff.cpp
  - yieldStuff.h
- - .gitignore
  - platformio.ini
- - .clang-format
  - .gitignore
  - platformio.ini
- - .gitignore
  - platformio.ini
- - .gitignore
  - platformio.ini
- - .gitignore
  - platformio.ini
- - LICENSE.txt
- - condition_variable.cc
  - future.cc
  - LICENSE.txt
  - mutex.cc
- - .clang-format
  - event_responder_support.cpp
  - event_responder_support.h
  - port.c
  - portmacro.h
  - readme.txt
  - runtime_support.cpp
  - teensy.h
  - teensy_4.cpp
  - teensy_common.cpp
- arduino_freertos.h
- atomic.h
- critical_section.h
- croutine.c
- croutine.h
- deprecated_definitions.h
- event_groups.c
- event_groups.h
- FreeRTOS.h
- freertos_tasks_c_additions.h
- FreeRTOSConfig.h
- list.c
- list.h
- message_buffer.h
- mpu_prototypes.h
- mpu_syscall_numbers.h
- mpu_wrappers.h
- newlib-freertos.h
- picolibc-freertos.h
- portable.h
- projdefs.h
- queue.c
- queue.h
- semphr.h
- stack_macros.h
- StackMacros.h
- stdint.readme
- stream_buffer.c
- stream_buffer.h
- task.h
- tasks.c
- timers.c
- timers.h
.clang-format
.gitignore
cspell.config.yaml
library.json
library.properties
manifest.yml
MISRA.md
README.md
run_format.sh
sbom.spdx

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FreeRTOS Port for Teensy 4.0 and 4.1

This is a basic port of [FreeRTOS][FreeRTOS] for the [Teensy 4.0][Teensy] and [Teensy 4.1][Teensy] boards.

## Introduction

To make FreeRTOS work on the teensy boards I had to adjust the `EventResponder` class of the Teensy Arduino core library and optimized some minor parts. Therefore a custom [platform setting][TeensyPlatform] is used (`platform = https://github.com/tsandmann/platform-teensy`). It uses a more recent [compiler toolchain][ARMCrossCompiler] (e.g. to support C++20) and a slightly modified [Arduino core library][TeensyLibCore]. The latter is needed because FreeRTOS needs some interrupt vectors that are also used by the Arduino core (`SysTick` and `PendSV` for `EventResponder`) to be set up for the RTOS. The modified core library supports these services by running them ontop of the RTOS.

### Notice

Consider this as experimental code and work in progress. *If it breaks, you get to keep both pieces.*

## Current Limitations

* Updated libraries may cause some incompatibilities with the custom core library. More testing and documentation is needed before the custom core library change may be integrated in the official library.
* This is a port of FreeRTOS to run its kernel on the Teensy boards. It does **not** include thread-safe peripheral drivers, thread-safe teensy libraries and so on! If you want to use peripherals (e.g. serial ports, I2C, SPI, etc.) from different tasks, you may have to synchronize the access. On the other hand C-library calls like `malloc` or `free` are thread-safe due to provided guards for newlib.
* Documentation is very limited (including this readme).

## PlatformIO Usage

1. Install PlatformIO core as described [here][PIOInstall]
1. Clone this git repository: `git clone https://github.com/tsandmann/freertos-teensy`
1. Open an example of the cloned repo, e.g. `freertos-teensy/example/blink`
1. Select the correct project environment [PlatformIO toolbar][PIOToolbar] for your Teensy board, e.g. `teensy41`
1. Build project: use `Build` button on the [PlatformIO toolbar][PIOToolbar] or shortcut (`ctrl/cmd+alt+b`)
1. Upload firmware image
    * Connect USB cable to teensy board
    * Use `Upload` button on the [PlatformIO toolbar][PIOToolbar] or shortcut (`ctrl/cmd+alt+t`) and select "PlatformIO: Upload"
1. Use a terminal program (e.g. minicom) to connect to the USB serial device
    * If you use minicom: goto `Serial port setup` settings and set `Serial Device` to your serial device (typically sth. like `/dev/cu.usbmodemXXXXXXX` or `/dev/tty.usbmodemXXXXXXX`)

## Teensyduino Usage

There is a test version available which can be used with Teensyduino. If you want to try it out:

1. Download the library [here](https://github.com/tsandmann/freertos-teensy/releases) as a zip archive.
1. In Teensyduino select "Sketch -> Include Library -> Add .ZIP Library" and specify the downloaded zip archive.
1. Create a new sketch in Teensyduino, e.g. `blink.ino`.
1. Copy the contents of [main.cpp](https://github.com/tsandmann/freertos-teensy/blob/master/example/blink/src/main.cpp) to it.
1. Compile and upload the sketch as usual.

Currently there are the following limitations for Teensyduino projects:

- There is no support for C++'s [`std::thread`][StdThread], [`std::jthread`][StdThread] or [Futures][StdThread] (custom compiler options for the library would be necessary which is currently not possible with arduino's IDE).
 - If the sketch (or any included library) uses the `EventResponder` [class](https://github.com/PaulStoffregen/cores/blob/bf413538ce5d331a4ac768e50c5668b9b6c1901f/teensy4/EventResponder.h#L67), the `EventResponder::attachInterrupt()` [variant](https://github.com/PaulStoffregen/cores/blob/bf413538ce5d331a4ac768e50c5668b9b6c1901f/teensy4/EventResponder.h#L111) must not be used, otherwise FreeRTOS will stop working. An update of the Teenys core library is required to make this work (this [Pull request](https://github.com/PaulStoffregen/cores/pull/683) needs to be merged for this).
 - For Teensy 4.x: To print useful stack traces (see [`void HardFault_HandlerC(unsigned int* hardfault_args)`](https://github.com/tsandmann/freertos-teensy/blob/master/src/portable/teensy_4.cpp#L351) and [`_Unwind_Reason_Code trace_fcn(_Unwind_Context* ctx, void* depth)`](https://github.com/tsandmann/freertos-teensy/blob/master/src/portable/teensy_common.cpp#L179)) in case of a crash or an exception, the code must be compiled by using the `-fasynchronous-unwind-tables` option to tell gcc to generate the needed unwind tables. Furthermore, an updated linker script is needed to put `.ARM.exidx` and `.ARM.extab` in the right place and some (startup) code to copy these tables into RAM. (libgcc's unwind code requires the unwind table at an address reachable by a 31-bit signed offset (+/- 0x3FFFFFFF) from executed instructions). To support call traces over C-library calls, newlib has to be compiled with `-fasynchronous-unwind-tables` option as well.
 - I haven't done much testing so far as I don't use Teensyduino for my projects.

[FreeRTOS]: https://www.freertos.org
[Teensy]: https://www.pjrc.com/teensy/index.html
[PlatformIO]: https://platformio.org
[PIOGithub]: https://github.com/platformio/platformio-core
[PIOInstall]: https://docs.platformio.org/en/latest/integration/ide/vscode.html#installation
[PioCliInstall]: https://docs.platformio.org/en/latest/core/installation.html#install-shell-commands
[PIOToolbar]: https://docs.platformio.org/en/latest/integration/ide/vscode.html#platformio-toolbar
[VSCode]: https://github.com/Microsoft/vscode
[PlatformIOIDE]: http://docs.platformio.org/en/latest/ide.html#ide
[TeensyPlatform]: https://github.com/tsandmann/platform-teensy
[ARMCrossCompiler]: https://github.com/tsandmann/arm-cortexm-toolchain-linux
[TeensyLibCore]: https://github.com/tsandmann/teensy-cores
[StdThread]: https://en.cppreference.com/w/cpp/thread