990643ebe8
* Fix support for stepping maximum number of ticks This commit fixes support for tickless implementations that call vTaskStepTick() with the maximum number of allowed ticks to step. vTaskStepTick() --------------- Function vTaskStepTick() provides a way for the tickless idle implementation to account for ticks that elapse during tickless idle. The maximum number of stepped ticks allowed is the number passed to portSUPPRESS_TICKS_AND_SLEEP(). It is the number of ticks between xTickCount and xNextTaskUnblockTime. vTaskStepTick() is specifically intended for use with tickless idle, so it always executes with the scheduler disabled. For reference, compare it with the more general function xTaskCatchUpTicks(). Without this Change ------------------- Prior to this commit, if a task is supposed to wake at xTickCount == 0xFFFFFFFF, then when tickless idle ends, function vTaskStepTick() sets the tick to 0xFFFFFFFF but the task remains on the delayed list because xTaskIncrementTick() does not execute. One tick later, xTaskIncrementTick() executes because it's time to increment xTickCount to 0x00000000. An assertion failure occurs in taskSWITCH_DELAYED_LISTS() because the delayed task list is not empty. Other examples of valling vTaskStepTick() with the maximum allowed number of ticks merely result in a task waking one tick late. Default Tickless Implementations -------------------------------- Note that the default tickless implementations never pass the maximum allowed value to vTaskStepTick(). The default implementations use the tick interrupt to finish the sleep and allow that one tick to be counted normally via the tick ISR and xTaskIncrementTick(). * Protect xPendedTicks with critical section Function xTaskIncrementTick() increments xPendedTicks when the scheduler is disabled. That function typically executes inside the tick ISR. So code in xTaskCatchUpTicks() must mask interrupts when modifying xPendedTicks. * uncrustify tasks.c * Update tasks.c Style changes only - added comment and indentation to the two modified files. * uncrustify * Add test coverage for new conditional * Add typecast Co-authored-by: Cobus van Eeden <35851496+cobusve@users.noreply.github.com> Co-authored-by: Joseph Julicher <jjulicher@mac.com> Co-authored-by: RichardBarry <3073890+RichardBarry@users.noreply.github.com> |
||
|---|---|---|
| .github | ||
| include | ||
| portable | ||
| .gitmodules | ||
| croutine.c | ||
| event_groups.c | ||
| GitHub-FreeRTOS-Kernel-Home.url | ||
| History.txt | ||
| LICENSE.md | ||
| list.c | ||
| queue.c | ||
| Quick_Start_Guide.url | ||
| README.md | ||
| stream_buffer.c | ||
| tasks.c | ||
| timers.c | ||
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
./portabledirectory contains the files that are specific to a particular microcontroller and/or compiler. See the readme file in the./portabledirectory for more information. -
The
./includedirectory 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.