espressif/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-08-06 17:30:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for the ulTaskNotifyValueClear() and xTaskCatchUpTicks() API functions.

Browse Source 
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.
This commit is contained in:
RichardBarry
2020-03-14 21:07:41 -07:00
committed by Yuhui Zheng
parent b49eec35f6
commit 5d28744feb
2 changed files with 55 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
tasks.c
View File

@ -2608,7 +2608,7 @@ implementations require configUSE_TICKLESS_IDLE to be set to a value other than
BaseType_t xTaskCatchUpTicks( TickType_t xTicksToCatchUp )
{
BaseType_t xYieldRequired = pdFALSE;
BaseType_t xYieldOccurred;
/* Must not be called with the scheduler suspended as the implementation
relies on xPendedTicks being wound down to 0 in xTaskResumeAll(). */
@ -2618,9 +2618,9 @@ BaseType_t xYieldRequired = pdFALSE;
the scheduler is suspended so the ticks are executed in xTaskResumeAll(). */
vTaskSuspendAll();
xPendedTicks += xTicksToCatchUp;
xYieldRequired = xTaskResumeAll();
xYieldOccurred = xTaskResumeAll();
return xYieldRequired;
return xYieldOccurred;
}
/*----------------------------------------------------------*/