Mirror/fork of freertos kernel
Find a file
RichardBarry a0906b60e5 Change the previously single ulNotifiedValue and ucNotifyState members of the TCB into an array dimensioned by the new configNUMBER_OF_TASK_NOTIFICATIONS, after which each task can optionally have zero or more task notifications values and states that can be used individually.
Default configNUMBER_OF_TASK_NOTIFICATIONS to 1 if it is left undefined so the default behaviour is to have one task notification, as per previous versions of code.
Update all the task notification API functions to accept the index of the task notification being used.  This has required the introduction of 'generic' versions of some functions, with the pre-exisitng API functions being converted to macros that call the generic version of the API function with the index set to 0 for backward compatibility.
Not yet added functions that can use anything other than the first task notification slot.
2020-05-12 19:02:47 -07:00
.github Create pull_request_template.md 2020-03-17 13:11:11 -07:00
include Change the previously single ulNotifiedValue and ucNotifyState members of the TCB into an array dimensioned by the new configNUMBER_OF_TASK_NOTIFICATIONS, after which each task can optionally have zero or more task notifications values and states that can be used individually. 2020-05-12 19:02:47 -07:00
portable fix: CLEAR MIE BIT IN INITIAL RISC-V MSTATUS VALUE 2020-05-01 13:43:51 -07:00
CONTRIBUTING.md Added CONTRIBUTING (#18) 2020-02-25 16:22:57 -08:00
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. 2020-02-26 10:45:32 -08:00
event_groups.c version bump to v10.3.1 (#16) 2020-02-18 22:03:54 -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 version bump to v10.3.1 (#16) 2020-02-18 22:03:54 -08:00
LICENSE.md Bring license in sync with FreeRTOS/FreeRTOS. (#20) 2020-02-27 14:33:46 -08:00
list.c version bump to v10.3.1 (#16) 2020-02-18 22:03:54 -08:00
queue.c fix: CLEAR MIE BIT IN INITIAL RISC-V MSTATUS VALUE 2020-05-01 13:43:51 -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 version bump to v10.3.1 (#16) 2020-02-18 22:03:54 -08:00
tasks.c Change the previously single ulNotifiedValue and ucNotifyState members of the TCB into an array dimensioned by the new configNUMBER_OF_TASK_NOTIFICATIONS, after which each task can optionally have zero or more task notifications values and states that can be used individually. 2020-05-12 19:02:47 -07:00
timers.c version bump to v10.3.1 (#16) 2020-02-18 22:03:54 -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.