esp-idf/docs/en/migration-guides/system.rst
Omar Chebib fcd11ba125 FreeRTOS: Remove task_snapshot inclusion from task.h
Remove ESP's addition of task_snapshot.h from task.h. This line was
added previously for backward compatibility. For IDF v5.0, this can
be removed.
2021-12-21 07:10:22 +00:00

41 lines
1.5 KiB
ReStructuredText

Migrate System to ESP-IDF 5.0
==================================
Inter-Processor Call
-----------------------
IPC (Inter-Processor Call) component has been moved to ``esp_system``.
Thus, any project presenting a ``CMakeLists.txt`` file with the parameters ``PRIV_REQUIRES esp_ipc`` or ``REQUIRES esp_ipc``, should be modified to simply remove these options as ``esp_system`` component is included by default.
ESP Clock
---------
The old headers ``{IDF_TARGET_NAME}/clk.h``, ``esp_clk.h`` have been removed.
Therefore, If you want to use the function with the prefix ``esp_clk`` please include ``esp_private/esp_clk.h`` instead.
Cache Error Interrupt
---------------------
The old headers ``{IDF_TARGET_NAME}/cache_err_int.h`` have been removed. Please include ``esp_private/cache_err_int.h`` instead.
Brownout
--------
The header ``brownout.h`` has been made private. ESP-IDF developers should include ``esp_private/brownout.h`` instead.
Trax
----
The header ``trax.h`` has been made private. ESP-IDF developers should include ``esp_private/trax.h`` instead.
ROM
---
Deprecated ROM related header files from `components/esp32/rom/` (old include path: `rom/*.h`) have been deleted. Please update to use the new target-specific path from `components/esp_rom/include/{IDF_TARGET_NAME}/` (new include path: `{IDF_TARGET_NAME}/rom/*.h`).
Tasks snapshot
--------------
The header ``task_snapshot.h`` has been removed from ``freertos/task.h``. ESP-IDF developers should include ``"freertos/task_snapshot.h``` in case they need tasks snapshot API.