This repository has been archived on 2023-11-05. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
2022-11-15 20:07:52 +00:00
.github Remove local stack variable form MPU wrappers 2022-09-17 00:03:08 +05:30
include Update doc comments in task.h (#570) 2022-09-28 21:42:05 +05:30
portable Add support for the configUSE_TASK_FPU_SUPPORT constant in the GCC/ARM_CR5 port (#584) 2022-11-14 10:48:47 +05:30
.gitmodules Move the community/partner supported ports to correct location (#361) 2021-06-29 18:36:49 -07:00
CMakeLists.txt Update CMakeLists.txt for Cortex-M55 and Cortex-M85 ports (#560) 2022-09-16 12:30:11 +05:30
croutine.c Add support for MISRA rule 20.7 (#546) 2022-08-19 15:51:57 +05:30
event_groups.c Added better pointer declaration readability (#567) 2022-09-26 14:43:30 -07:00
GitHub-FreeRTOS-Kernel-Home.url Adding url to direct users to FreeRTOS-Kernel github page. (#32) 2020-03-17 19:30:19 -07:00
History.txt Updating version number for LTS 2 Patch 2022-11-15 20:07:52 +00:00
LICENSE.md Bring license in sync with FreeRTOS/FreeRTOS. (#20) 2020-02-27 14:33:46 -08:00
list.c Add configUSE_MINI_LIST_ITEM configuration option to enable the MiniListItem_t type. (#433) 2022-01-19 13:12:57 -08:00
manifest.yml Updating version number for LTS 2 Patch 2022-11-15 20:07:52 +00:00
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) 2022-10-13 22:52:24 +05:30
Quick_Start_Guide.url Style: Make freertos.org = FreeRTOS.org and add https (#134) 2020-08-21 11:30:39 -07:00
README.md Update parent repository primary branch name from "master" to "main". (#304) 2021-04-09 09:42:35 -07:00
stream_buffer.c Add support for MISRA rule 20.7 (#546) 2022-08-19 15:51:57 +05:30
tasks.c Fix context switch when time slicing is off (#568) 2022-11-08 14:05:35 +05:30
timers.c Add configUSE_MINI_LIST_ITEM configuration option to enable the MiniListItem_t type. (#433) 2022-01-19 13:12:57 -08:00

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.