CloudEdge/FreeRTOS-Kernel
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
2,742 Commits 1 Branch 0 Tags 112 MiB
C 93.4%
Assembly 5.8%
CMake 0.6%
5d28744feb
Go to file
RichardBarry 5d28744feb Improve documentation for the ulTaskNotifyValueClear() and xTaskCatchUpTicks() API functions. 
Move the prototype and documentation for xTaskCatchUpTicks() into the correct place in the task.h header file (in the public documentation from the private documentation).
Rename the variable that holds the return value in xTaskCatchUpTicks() to more accurately represent its meaning.
2020-03-15 20:24:18 -07:00
include Improve documentation for the ulTaskNotifyValueClear() and xTaskCatchUpTicks() API functions. 2020-03-15 20:24:18 -07:00
portable The Windows port layer is built with both MSVC and GCC. GCC generated a warning relating to the variable lWaitForYield being set but not used. This change removes the variable. 2020-03-15 20:24:18 -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
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 Small typo on L1287 (#14) 2020-02-19 14:05:48 -08: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
stream_buffer.c version bump to v10.3.1 (#16) 2020-02-18 22:03:54 -08:00
tasks.c Improve documentation for the ulTaskNotifyValueClear() and xTaskCatchUpTicks() API functions. 2020-03-15 20:24:18 -07:00
timers.c version bump to v10.3.1 (#16) 2020-02-18 22:03:54 -08:00

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.