alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs(freertos/idf): Add IDF FreeRTOS upgarde migration notes for v5.2

Browse Source
This commit is contained in:
Darian Leung 2023-12-18 05:05:26 +08:00
parent 912f6c527c
commit 95a5d3ff36
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/en/migration-guides/release-5.x/5.2/system.rst
View File

@ -6,6 +6,19 @@ System
FreeRTOS
--------
IDF FreeRTOS Upgrade
^^^^^^^^^^^^^^^^^^^^
The IDF FreeRTOS kernel (which is a dual-core SMP implementation of FreeRTOS) has been upgraded to be based on Vanilla FreeRTOS v10.5.1. With this upgrade, the design and implementation of IDF FreeRTOS has also been changed significantly. As a result, users should take not of the following changes to kernel behavior and API:
- When enabling single-core mode via the :ref:`CONFIG_FREERTOS_UNICORE` option, the kernel's behavior will now be identical to Vanilla FreeRTOS (see :ref:`freertos-idf-single-core` for more details).
- For SMP related APIs that were added by IDF FreeRTOS, checks on ``xCoreID`` arguments are now stricter. Providing out of range values for ``xCoreID`` arguments will now trigger an assert.
- The following SMP related APIs are now deprecated and replaced due to naming consistency reasons:
- ``xTaskGetAffinity()`` is deprecated, call :cpp:func:`xTaskGetCoreID` instead.
- ``xTaskGetIdleTaskHandleForCPU()`` is deprecated, call :cpp:func:`xTaskGetIdleTaskHandleForCore` instead.
- ``xTaskGetCurrentTaskHandleForCPU()`` is deprecated, call :cpp:func:`xTaskGetCurrentTaskHandleForCore` instead.
Task Snapshot
^^^^^^^^^^^^^