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

alfred gedeon eac2b9a271 Fix Linux port Valgrind errors (#56 ) Fix Valgrind uninitialized variables warning. Co-authored-by: Alfred Gedeon <gedeonag@amazon.com>		5 years ago
.github	Create pull_request_template.md	5 years ago
include	Improve documentation for the ulTaskNotifyValueClear() and xTaskCatchUpTicks() API functions.	5 years ago
portable	Fix Linux port Valgrind errors (#56 )	5 years ago
CONTRIBUTING.md	Added CONTRIBUTING (#18 )	5 years ago
GitHub-FreeRTOS-Kernel-Home.url	Adding url to direct users to FreeRTOS-Kernel github page. (#32 )	5 years ago
History.txt	version bump to v10.3.1 (#16 )	5 years ago
LICENSE.md	Bring license in sync with FreeRTOS/FreeRTOS. (#20 )	5 years ago
Quick_Start_Guide.url	Add quick start guide.	12 years ago
README.md	Replacing readme.txt with README.md. (#11 )	5 years ago
SECURITY.md	Create SECURITY.md	5 years ago
croutine.c	Updates vCoRoutineSchedule() so it returns without doing anything if if the co-routine internal data structures have not been initialised. The internal data structures are initialised when the first co-routine is created.	5 years ago
event_groups.c	version bump to v10.3.1 (#16 )	5 years ago
list.c	version bump to v10.3.1 (#16 )	5 years ago
queue.c	Small typo on L1287 (#14 )	5 years ago
stream_buffer.c	version bump to v10.3.1 (#16 )	5 years ago
tasks.c	pxTCB is no longer needed in this local function.	5 years ago
timers.c	version bump to v10.3.1 (#16 )	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.