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
YuguoWH 5b6c2ab085
Synopsys ARC update, with updated BSP support (#99)
Update BSP APIs to latest version
Remove unused macro which could have caused warnings
(Code Style) Manually align some macros

Signed-off-by: Yuguo Zou <yuguo.zou@synopsys.com>
2020-07-22 17:14:09 -07:00
.github Create pull_request_template.md 2020-03-17 13:11:11 -07:00
include Style: uncrustify kernel files 2020-07-08 10:24:06 -07:00
portable Synopsys ARC update, with updated BSP support (#99) 2020-07-22 17:14:09 -07:00
CONTRIBUTING.md Added CONTRIBUTING (#18) 2020-02-25 16:22:57 -08:00
croutine.c Style: uncrustify kernel files 2020-07-08 10:24:06 -07:00
event_groups.c Style: uncrustify kernel files 2020-07-08 10:24:06 -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 Updated History.txt for task notification array change (#65) 2020-05-28 09:55:17 -07:00
LICENSE.md Bring license in sync with FreeRTOS/FreeRTOS. (#20) 2020-02-27 14:33:46 -08:00
list.c Place privileged symbols correctly (#84) 2020-07-14 16:22:42 -07:00
queue.c Style: uncrustify kernel files 2020-07-08 10:24:06 -07:00
Quick_Start_Guide.url Add quick start guide. 2013-04-30 19:37:00 +00:00
README.md Replacing readme.txt with README.md. (#11) 2020-02-16 13:18:58 -08:00
SECURITY.md Create SECURITY.md 2020-03-17 13:08:50 -07:00
stream_buffer.c Style: uncrustify kernel files 2020-07-08 10:24:06 -07:00
tasks.c Place privileged symbols correctly (#84) 2020-07-14 16:22:42 -07:00
timers.c Place privileged symbols correctly (#84) 2020-07-14 16:22:42 -07: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.