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

yngki c1dff8fe95 Update History.txt (#160 ) * Update History.txt * Update History.txt Co-authored-by: Cobus van Eeden <35851496+cobusve@users.noreply.github.com>		4 years ago
.github	Removing general-inquiry.md to divert people to the forums. (#141 )	5 years ago
include	Use unsigned constant in pdMS_TO_TICKS(). (#147 )	4 years ago
portable	Fix: Comment - xTaskIncrementTick loop - to adhere to demo requirement (#162 )	4 years ago
CONTRIBUTING.md	Style: Make freertos.org = FreeRTOS.org and add https (#134 )	5 years ago
GitHub-FreeRTOS-Kernel-Home.url	Adding url to direct users to FreeRTOS-Kernel github page. (#32 )	5 years ago
History.txt	Update History.txt (#160 )	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	Style: Make freertos.org = FreeRTOS.org and add https (#134 )	5 years ago
SECURITY.md	Create SECURITY.md	5 years ago
croutine.c	Style: Change FreeRTOS websites in comments (#131 )	5 years ago
event_groups.c	Style: Change FreeRTOS websites in comments (#131 )	5 years ago
list.c	Style: Make freertos.org = FreeRTOS.org and add https (#134 )	5 years ago
queue.c	Style: Make freertos.org = FreeRTOS.org and add https (#134 )	5 years ago
stream_buffer.c	Style: Change FreeRTOS websites in comments (#131 )	5 years ago
tasks.c	Fix compiler warning in config assert() on 64 bit architecture (#158 )	4 years ago
timers.c	Style: Change FreeRTOS websites in comments (#131 )	5 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.