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
Gaurav Aggarwal ea9c26f524 Use highest numbered MPU regions for kernel
ARMv7-M allows overlapping MPU regions. When 2 MPU regions overlap, the
MPU configuration of the higher numbered MPU region is applied. For
example, if a memory area is covered by 2 MPU regions 0 and 1, the
memory permissions for MPU region 1 are applied.

We use 5 MPU regions for kernel code and kernel data protections and
leave the remaining for the application writer. We were using lowest
numbered MPU regions (0-4) for kernel protections and leaving the
remaining for the application writer. The application writer could
configure those higher numbered MPU regions to override kernel
protections.

This commit changes the code to use highest numbered MPU regions for
kernel protections and leave the remaining for the application writer.
This ensures that the application writer cannot override kernel
protections.

We thank the SecLab team at Northeastern University for reporting this
issue.

Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>
2022-09-17 00:03:08 +05:30
.github Add support for MISRA rule 20.7 (#546) 2022-08-19 15:51:57 +05:30
include Update of three badly terminated macro definitions (#555) 2022-09-08 10:33:41 -07:00
portable Use highest numbered MPU regions for kernel 2022-09-17 00:03:08 +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 Add configUSE_MINI_LIST_ITEM configuration option to enable the MiniListItem_t type. (#433) 2022-01-19 13:12:57 -08: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 Update History.txt (#535) 2022-08-07 22:31:47 +05:30
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 Add SBOM Generation in auto_release.yml (#524) 2022-07-28 10:35:29 -07:00
queue.c Add configUSE_MINI_LIST_ITEM configuration option to enable the MiniListItem_t type. (#433) 2022-01-19 13:12:57 -08:00
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 Added checks for index in ThreadLocalStorage APIs (#552) 2022-09-01 13:23:02 -07:00
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.