freertos: Add some comments about deleting tasks when using SMP

Some cases are not immediately obvious, so document them in comments.
This commit is contained in:
Angus Gratton
2021-04-13 03:40:10 +00:00
committed by bot
parent f7b859ac84
commit 191e649257
2 changed files with 8 additions and 6 deletions
@@ -3,12 +3,11 @@
* check if the task memory is freed immediately under the correct conditions.
*
* The behavior of vTaskDelete() results in the immediate freeing of task memory
* and the immediate execution of deletion callbacks under the following conditions...
* - When deleting a task that is not currently running on either core
* - When deleting a task that is pinned to the same core (with respect to
* the core that calls vTaskDelete()
* and the immediate execution of deletion callbacks for tasks which are not
* running, provided they are not pinned to the other core (due to FPU cleanup
* requirements).
*
* If the two conditions are not met, freeing of task memory and execution of
* If the condition is not met, freeing of task memory and execution of
* deletion callbacks will still be carried out by the Idle Task.
*/
#include <stdio.h>