system.rst 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. Migrate System to ESP-IDF 5.0
  2. ==================================
  3. Inter-Processor Call
  4. -----------------------
  5. IPC (Inter-Processor Call) component has been moved to ``esp_system``.
  6. 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.
  7. ESP Clock
  8. ---------
  9. The old headers ``{IDF_TARGET_NAME}/clk.h``, ``esp_clk.h`` have been removed.
  10. Therefore, If you want to use the function with the prefix ``esp_clk`` please include ``esp_private/esp_clk.h`` instead.
  11. Cache Error Interrupt
  12. ---------------------
  13. The old headers ``{IDF_TARGET_NAME}/cache_err_int.h`` have been removed. Please include ``esp_private/cache_err_int.h`` instead.
  14. Brownout
  15. --------
  16. The header ``brownout.h`` has been made private. ESP-IDF developers should include ``esp_private/brownout.h`` instead.
  17. Trax
  18. ----
  19. The header ``trax.h`` has been made private. ESP-IDF developers should include ``esp_private/trax.h`` instead.
  20. ROM
  21. ---
  22. 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`).
  23. ESP HW Support
  24. --------------
  25. - The header files ``soc/cpu.h`` have been deleted and deprecated CPU util functions have been removed. ESP-IDF developers should include ``esp_cpu.h`` instead for equivalent functions.
  26. - The header file ``esp_intr.h`` has been deleted. Please include ``esp_intr_alloc.h`` to allocate and manipulate interrupts.
  27. - The header file ``esp_panic.h`` has been deleted. ESP-IDF developers should include ``esp_private/panic_reason.h`` to get supported panic reasons. And should include ``esp_debug_helpers.h`` to use any debug related helper functions, e.g. print backtrace.
  28. SOC dependency
  29. --------------
  30. - Public API headers who are listed in the Doxyfiles won't expose unstable and unnecessary soc header files like ``soc/soc.h``, ``soc/rtc.h``. That means, the user has to explicitly include them in their code if these "missing" header files are still wanted.
  31. - Kconfig option ``LEGACY_INCLUDE_COMMON_HEADERS`` is also removed.
  32. APP Trace
  33. ---------
  34. One of the timestamp sources has changed from the legacy timer group driver to the new :doc:`GPTimer <../api-reference/peripherals/gptimer>`. Kconfig choices like ``APPTRACE_SV_TS_SOURCE_TIMER00`` has been changed to ``APPTRACE_SV_TS_SOURCE_GPTIMER``. User doesn't need to choose the group and timer ID any more.