len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2026-01-17 15:20:25 -05:00
Code Issues Projects Releases Packages Wiki Activity

Add catch up behavior to xTaskDelayUntil. (#1348)

Browse source 
Adds an explanation for why xTaskDelayUntil
can break from the configured frequency when
catching up for past events. More will be added
to the website documentation.
This commit is contained in:
Kody Stribrny 2025-12-23 09:30:36 -08:00 • committed by GitHub
parent 7d6890e650
commit 536914b2a4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
include/task.h
View file

@ -897,7 +897,8 @@ void vTaskDelay( const TickType_t xTicksToDelay ) PRIVILEGED_FUNCTION;
* *
* @return Value which can be used to check whether the task was actually delayed. * @return Value which can be used to check whether the task was actually delayed.
* Will be pdTRUE if the task way delayed and pdFALSE otherwise. A task will not * Will be pdTRUE if the task way delayed and pdFALSE otherwise. A task will not
* be delayed if the next expected wake time is in the past. * be delayed if the next expected wake time is in the past. This prevents periodic
* tasks from accumulating delays and allows them to resume their regular timing pattern.
* *
* Example usage: * Example usage:
* @code{c} * @code{c}