FreeRTOS-Kernel

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

David Chalco 18f714f786 Update release date (#217 )		4 years ago
.github	Added CODEOWNERS file (#209 )	4 years ago
include	Fix: C++ compiler warning (#203 )	4 years ago
portable	Ensure interrupts are enabled at first task start (#214 )	4 years ago
GitHub-FreeRTOS-Kernel-Home.url	Adding url to direct users to FreeRTOS-Kernel github page. (#32 )	5 years ago
History.txt	Update release date (#217 )	4 years ago
LICENSE.md	Bring license in sync with FreeRTOS/FreeRTOS. (#20 )	5 years ago
Quick_Start_Guide.url	Style: Make freertos.org = FreeRTOS.org and add https (#134 )	5 years ago
README.md	FreeRTOS Kernel Spelling Update (#170 )	4 years ago
croutine.c	Update version number to 10.4.1 (#173 )	4 years ago
event_groups.c	Update version number to 10.4.1 (#173 )	4 years ago
list.c	Update version number to 10.4.1 (#173 )	4 years ago
queue.c	Update version number to 10.4.1 (#173 )	4 years ago
stream_buffer.c	xStreamBufferSend() caps the maximum amount of data a stream buffer can send to the maximum capacity of the buffer - however the value to which the length is capped was wrong, and is correct by this check in. Likewise when sending to a message buffer if the send length is too long the block time is set to 0 to ensure the sending task does not wait indefinitely for the impossible send to complete - but the length check was wrong, and is corrected by this check in. (#195 )	4 years ago
tasks.c	Fix missed yield in xTaskResumeFromISR (#207 )	4 years ago
timers.c	Update version number to 10.4.1 (#173 )	4 years ago

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.