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

Paul Helter f6b7bd6553 Using single name definition for libraries everywhere. (#558 )		2 years ago
.github	Remove local stack variable form MPU wrappers	3 years ago
include	Update doc comments in task.h (#570 )	3 years ago
portable	Adding in ability to support a library for freertos_config and a custom freertos_kernel_port (#558 )	2 years ago
.gitmodules	Move the community/partner supported ports to correct location (#361 )	4 years ago
CMakeLists.txt	Using single name definition for libraries everywhere. (#558 )	2 years ago
GitHub-FreeRTOS-Kernel-Home.url	Adding url to direct users to FreeRTOS-Kernel github page. (#32 )	5 years ago
History.txt	Version Change (#587 )	2 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	Add support for MISRA rule 20.7 (#546 )	3 years ago
event_groups.c	Added better pointer declaration readability (#567 )	3 years ago
list.c	Add configUSE_MINI_LIST_ITEM configuration option to enable the MiniListItem_t type. (#433 )	3 years ago
manifest.yml	Version Change (#587 )	2 years ago
queue.c	Removed the 'configASSERT( xInheritanceOccurred == pdFALSE )' assertion from xQueueSemaphoreTake as the reasoning behind it is wrong; it can trigger on wrongly on highly-contested semaphores on multicore systems. See https://forums.freertos.org/t/15967 (#576 )	2 years ago
stream_buffer.c	Add support for MISRA rule 20.7 (#546 )	3 years ago
tasks.c	Fix context switch when time slicing is off (#568 )	2 years ago
timers.c	Add configUSE_MINI_LIST_ITEM configuration option to enable the MiniListItem_t type. (#433 )	3 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.