len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-09-12 09:07:46 -04:00
Code Issues Projects Releases Packages Wiki Activity
Mirror/fork of freertos kernel
2887 commits 3 branches 99 tags 173 MiB
Find a file
Michael Bruno 5644234153 Remove inline function from timers.h 
Inline function converted to macro. This should now build when
optimizations are off and inlining is disabled.
2021-01-20 11:57:34 -05:00
.github Add XMOS XCore ports 2021-01-19 18:56:10 -05:00
include Remove inline function from timers.h 2021-01-20 11:57:34 -05:00
portable Fix compiler warnings in xcore ports 2021-01-20 09:59:10 -05:00
.gitattributes Add git attributes (#245) 2021-01-15 12:04:31 -07:00
croutine.c Add XMOS XCore ports 2021-01-19 18:56:10 -05:00
event_groups.c Add XMOS XCore ports 2021-01-19 18:56:10 -05: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 Add XMOS XCore ports 2021-01-19 18:56:10 -05:00
LICENSE.md Bring license in sync with FreeRTOS/FreeRTOS. (#20) 2020-02-27 14:33:46 -08:00
list.c Add XMOS XCore ports 2021-01-19 18:56:10 -05:00
queue.c Add XMOS XCore ports 2021-01-19 18:56:10 -05:00
Quick_Start_Guide.url Add XMOS XCore ports 2021-01-19 18:56:10 -05:00
README.md FreeRTOS Kernel Spelling Update (#170) 2020-09-16 11:17:39 -07:00
stream_buffer.c Add XMOS XCore ports 2021-01-19 18:56:10 -05:00
tasks.c Add XMOS XCore ports 2021-01-19 18:56:10 -05:00
timers.c Fix compiler warnings in xcore ports 2021-01-20 09:59:10 -05: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.

Code Formatting

FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the FreeRTOS/FreeRTOS repository.

Spelling

lexicon.txt contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling and you believe this is a mistake, then add the word to lexicon.txt. Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored.