esp-idf

mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Jakob Hasse 9c965073d4 Merge branch 'feature/linux_backtraces' into 'master' refactor(linux): Improved error reporting See merge request espressif/esp-idf!30387		2024-04-25 15:57:07 +08:00
..
include/freertos	change(freertos/idf): Remove xCoreID TCB member for single-core	2023-12-02 15:46:07 +08:00
portable	refactor(linux): Improved error reporting	2024-04-24 18:12:45 +02:00
event_groups.c	fix(freertos/idf): Fix xEventGroupGetBitsFromISR() critical section	2023-11-03 15:41:39 +08:00
idf_changes.md	feat(freertos/idf): Add config option for FreeRTOS Timer Task core affinity	2023-11-16 11:42:40 +01:00
LICENSE.md	change(freertos/idf): Move v10.5.1 kernel files	2023-10-21 04:39:16 +08:00
list.c	change(freertos/idf): Move v10.5.1 kernel files	2023-10-21 04:39:16 +08:00
queue.c	refactor(freertos/idf): Update thread safety convenience macros	2023-11-03 15:41:46 +08:00
README.md	change(freertos/idf): Move v10.5.1 kernel files	2023-10-21 04:39:16 +08:00
sbom.yml	change(freertos/idf): Update version number, licenses, and sbom to v10.5.1	2023-10-21 04:39:16 +08:00
stream_buffer.c	change(freertos/idf): Move v10.5.1 kernel files	2023-10-21 04:39:16 +08:00
tasks.c	fix(freertos): Fix vTaskList() parameter print order	2024-04-24 17:19:38 +08:00
timers.c	feat(freertos/idf): Add config option for FreeRTOS Timer Task core affinity	2023-11-16 11:42:40 +01:00
uncrustify.cfg	change(freertos/idf): Move v10.5.1 kernel files	2023-10-21 04:39:16 +08:00

README.md

Getting started

This repository contains FreeRTOS kernel source/header files and kernel ports only. This repository is referenced as a submodule in FreeRTOS/FreeRTOS repository, which contains pre-configured demo application projects under FreeRTOS/Demo directory.

The easiest way to use FreeRTOS is to start with one of the pre-configured demo application projects. That way you will have the correct FreeRTOS source files included, and the correct include paths configured. Once a demo application is building and executing you can remove the demo application files, and start to add in your own application source files. See the FreeRTOS Kernel Quick Start Guide for detailed instructions and other useful links.

Additionally, for FreeRTOS kernel feature information refer to the Developer Documentation, and API Reference.

Getting help

If you have any questions or need assistance troubleshooting your FreeRTOS project, we have an active community that can help on the FreeRTOS Community Support Forum.

Cloning this repository

To clone using HTTPS:

git clone https://github.com/FreeRTOS/FreeRTOS-Kernel.git

Using SSH:

git clone git@github.com:FreeRTOS/FreeRTOS-Kernel.git

Repository structure

The root of this repository contains the three files that are common to every port - list.c, queue.c and tasks.c. The kernel is contained within these three files. croutine.c implements the optional co-routine functionality - which is normally only used on very memory limited systems.
The ./portable directory contains the files that are specific to a particular microcontroller and/or compiler. See the readme file in the ./portable directory for more information.
The ./include directory contains the real time kernel header files.

Code Formatting

FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the FreeRTOS/FreeRTOS repository.

Spelling

lexicon.txt contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling and you believe this is a mistake, then add the word to lexicon.txt. Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored.