esp-idf/components/freertos/FreeRTOS-Kernel
Darian Leung 39cf3638ae change(freertos): Deprecate usage of vPortCleanUpTCB() by applications
Previously, if CONFIG_FREERTOS_ENABLE_STATIC_TASK_CLEAN_UP was enabled, users
would provide a definition for a vPortCleanUpTCB() hook function that is called
right before a task's memory is freed in prvDeleteTCB(). However,
vPortCleanUpTCB() will be reclaimed by ESP-IDF for internal use in v6.0.

This commit introduces the following changes...

Introduced a new CONFIG_FREERTOS_TASK_PRE_DELETION_HOOK option:

- Provides the same pre-deletion hook functionality. But users now define
vTaskPreDeletionHook() instead.
- CONFIG_FREERTOS_ENABLE_STATIC_TASK_CLEAN_UP still exists, but is marked as
deprecated. This is to maintain compatibility with existing applications
that already define vPortCleanUpTCB().
- Removed redundant --wl --wrap workaround with vPortCleanUpTCB()
- Added todo notes to remove support for user defined vPortCleanUpTCB()
completely in v6.0.
- Updated test cases to use new CONFIG_FREERTOS_TASK_PRE_DELETION_HOOK option

Freed up portCLEAN_UP_TCB() to call a new internal vPortTCBPreDeleteHook():

- vPortTCBPreDeleteHook() now replaces the previous "wrapped" implementation
of vPortCleanUpTCB().
- vPortTCBPreDeleteHook() is an internal task pre-delete hook for IDF FreeRTOS
ports to inject some pre-deletion operations.
- Internal pre-delete hook now invokes user provided vTaskPreDeletionHook()
if enabled.
- Relocated vPortTCBPreDeleteHook() to correct section in port.c
2023-08-23 17:50:08 +08:00
..
include/freertos freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00
portable change(freertos): Deprecate usage of vPortCleanUpTCB() by applications 2023-08-23 17:50:08 +08:00
croutine.c freertos: Uncrustify IDF FreeRTOS 2022-11-02 19:49:40 +08:00
event_groups.c freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00
GitHub-FreeRTOS-Kernel-Home.url freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
History.txt freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
LICENSE.md freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
list.c freertos(IDF): Sync cosmetic differences to v10.4.3 2022-11-10 18:37:42 +08:00
queue.c freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00
Quick_Start_Guide.url freertos: update freertos folder structure to match upstream 2021-10-29 12:05:13 +08:00
stream_buffer.c freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00
tasks.c feat(freertos): Added changes for multi-core RISC-V port for FreeRTOS 2023-08-22 15:35:15 +08:00
timers.c freertos: Add GetStaticBuffer functions 2023-04-12 11:45:06 +08:00
uncrustify.cfg freertos: Add uncrustiy config files for IDF FreeRTOS v10.4.3 2022-11-02 19:42:19 +08:00