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

j4cbo f37bcd5c14 Wrap macros in do { ... } while( 0 ) (#240 )		4 years ago
.github	Wrap macros in do { ... } while( 0 ) (#240 )	4 years ago
include	Create macro versions of uxListRemove() and vListInsertEnd() for use in xTaskIncrementTick(). This provides a minor optimisation to remove the need for a few function calls. (#241 )	4 years ago
portable	Wrap macros in do { ... } while( 0 ) (#240 )	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 URL in history.txt (#259 )	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	Update parent repository primary branch name from "master" to "main". (#304 )	4 years ago
croutine.c	[AUTO][RELEASE]: Bump file header version to "10.4.3"	4 years ago
event_groups.c	Check NULL pointer input for vEventGroupDelete. (#293 )	4 years ago
list.c	Update comment in list.c (#276 )	4 years ago
queue.c	Fix regression in vQueueAddToRegistry. (#315 )	4 years ago
stream_buffer.c	Fix error introduced when merging #264 . (#286 )	4 years ago
tasks.c	Create macro versions of uxListRemove() and vListInsertEnd() for use in xTaskIncrementTick(). This provides a minor optimisation to remove the need for a few function calls. (#241 )	4 years ago
timers.c	[kernel & MemMang] use space to replace tab and remove meaningless space in the end of each line (#314 )	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.