change(xtensa): Deprecate ".../xtensa_api.h" include path

This commit deprecates the "freertos/xtensa_api.h" and "xtensa/xtensa_api.h" include paths. Users should use "xtensa_api.h" instead. - Replace legacy include paths - Removed some unnecessary includes of "xtensa_api.h" - Replaced some calls with "esp_cpu_..." equivalents - Add warning to compatibility header
2024-10-05 20:47:46 -04:00 · 2023-10-27 17:41:49 +08:00 · 2023-10-27 17:41:49 +08:00 · 2204c8e137
commit 2204c8e137
parent 0fb0fc8654
30 changed files with 22 additions and 43 deletions
--- a/components/bt/controller/esp32/bt.c
+++ b/components/bt/controller/esp32/bt.c
@ -16,8 +16,8 @@
 #include "freertos/task.h"
 #include "freertos/queue.h"
 #include "freertos/semphr.h"
-#include "freertos/xtensa_api.h"
 #include "freertos/portmacro.h"
+#include "xtensa_api.h" // Replace with interrupt allocator API (IDF-3891)
 #include "xtensa/core-macros.h"
 #include "esp_types.h"
 #include "esp_mac.h"
--- a/components/bt/controller/esp32c3/bt.c
+++ b/components/bt/controller/esp32c3/bt.c
@ -43,8 +43,6 @@
 #include "riscv/interrupt.h"
 #include "esp32c3/rom/rom_layout.h"
 #else //CONFIG_IDF_TARGET_ESP32S3
-#include "freertos/xtensa_api.h"
-#include "xtensa/core-macros.h"
 #include "esp32s3/rom/rom_layout.h"
 #endif
 #if CONFIG_BT_ENABLED
--- a/components/driver/touch_sensor/esp32/touch_sensor.c
+++ b/components/driver/touch_sensor/esp32/touch_sensor.c
@ -13,7 +13,6 @@
 #include "soc/rtc.h"
 #include "soc/periph_defs.h"
 #include "freertos/FreeRTOS.h"
-#include "freertos/xtensa_api.h"
 #include "freertos/semphr.h"
 #include "esp_timer.h"
 #include "esp_intr_alloc.h"
--- a/components/driver/touch_sensor/esp32s2/touch_sensor.c
+++ b/components/driver/touch_sensor/esp32s2/touch_sensor.c
@ -11,7 +11,6 @@
 #include "sys/lock.h"
 #include "soc/soc_pins.h"
 #include "freertos/FreeRTOS.h"
-#include "freertos/xtensa_api.h"
 #include "freertos/semphr.h"
 #include "freertos/timers.h"
 #include "esp_intr_alloc.h"
--- a/components/driver/touch_sensor/esp32s3/touch_sensor.c
+++ b/components/driver/touch_sensor/esp32s3/touch_sensor.c
@ -11,7 +11,6 @@
 #include "sys/lock.h"
 #include "soc/soc_pins.h"
 #include "freertos/FreeRTOS.h"
-#include "freertos/xtensa_api.h"
 #include "freertos/semphr.h"
 #include "freertos/timers.h"
 #include "esp_intr_alloc.h"
--- a/components/esp_hw_support/include/esp_cpu.h
+++ b/components/esp_hw_support/include/esp_cpu.h
@ -12,7 +12,7 @@
 #include <assert.h>
 #include "soc/soc_caps.h"
 #ifdef __XTENSA__
-#include "xtensa/xtensa_api.h"
+#include "xtensa_api.h"
 #include "xt_utils.h"
 #elif __riscv
 #include "riscv/rv_utils.h"
--- a/components/esp_system/port/soc/esp32/system_internal.c
+++ b/components/esp_system/port/soc/esp32/system_internal.c
@ -22,7 +22,6 @@
 #include "soc/rtc.h"
 #include "esp_private/rtc_clk.h"
 #include "hal/wdt_hal.h"
-#include "freertos/xtensa_api.h"
 #include "soc/soc_memory_layout.h"
 #include "esp_private/cache_err_int.h"

@ -61,7 +60,7 @@ void IRAM_ATTR esp_system_reset_modules_on_exit(void)
 void IRAM_ATTR esp_restart_noos(void)
 {
    // Disable interrupts
-    xt_ints_off(0xFFFFFFFF);
+    esp_cpu_intr_disable(0xFFFFFFFF);

    // Enable RTC watchdog for 1 second
    wdt_hal_context_t rtc_wdt_ctx;
--- a/components/esp_system/port/soc/esp32s2/system_internal.c
+++ b/components/esp_system/port/soc/esp32s2/system_internal.c
@ -22,7 +22,6 @@
 #include "soc/syscon_reg.h"
 #include "soc/rtc_periph.h"
 #include "hal/wdt_hal.h"
-#include "freertos/xtensa_api.h"
 #include "soc/soc_memory_layout.h"

 #include "esp32s2/rom/rtc.h"
@ -61,7 +60,7 @@ void IRAM_ATTR esp_system_reset_modules_on_exit(void)
 void IRAM_ATTR esp_restart_noos(void)
 {
    // Disable interrupts
-    xt_ints_off(0xFFFFFFFF);
+    esp_cpu_intr_disable(0xFFFFFFFF);

    // Enable RTC watchdog for 1 second
    wdt_hal_context_t rtc_wdt_ctx;
--- a/components/esp_system/port/soc/esp32s3/system_internal.c
+++ b/components/esp_system/port/soc/esp32s3/system_internal.c
@ -21,7 +21,6 @@
 #include "soc/syscon_reg.h"
 #include "soc/rtc_periph.h"
 #include "hal/wdt_hal.h"
-#include "freertos/xtensa_api.h"
 #include "soc/soc_memory_layout.h"

 #include "esp32s3/rom/cache.h"
@ -68,7 +67,7 @@ void IRAM_ATTR esp_system_reset_modules_on_exit(void)
 void IRAM_ATTR esp_restart_noos(void)
 {
    // Disable interrupts
-    xt_ints_off(0xFFFFFFFF);
+    esp_cpu_intr_disable(0xFFFFFFFF);

    // Enable RTC watchdog for 1 second
    wdt_hal_context_t rtc_wdt_ctx;
--- a/components/esp_system/test_apps/esp_system_unity_tests/main/test_backtrace.c
+++ b/components/esp_system/test_apps/esp_system_unity_tests/main/test_backtrace.c
@ -15,7 +15,7 @@

 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
-#include "freertos/xtensa_api.h"
+#include "xtensa_api.h" // Replace with interrupt allocator API (IDF-3891)
 #include "esp_intr_alloc.h"
 #include "esp_rom_sys.h"
 #include "esp_rom_uart.h"
--- a/components/esp_wifi/esp32/esp_adapter.c
+++ b/components/esp_wifi/esp32/esp_adapter.c
@ -17,7 +17,7 @@
 #include "freertos/semphr.h"
 #include "freertos/event_groups.h"
 #include "freertos/portmacro.h"
-#include "freertos/xtensa_api.h"
+#include "xtensa_api.h"     // Replace with interrupt allocator API (IDF-3891)
 #include "esp_types.h"
 #include "esp_random.h"
 #include "esp_mac.h"
--- a/components/esp_wifi/esp32s2/esp_adapter.c
+++ b/components/esp_wifi/esp32s2/esp_adapter.c
@ -17,7 +17,7 @@
 #include "freertos/semphr.h"
 #include "freertos/event_groups.h"
 #include "freertos/portmacro.h"
-#include "freertos/xtensa_api.h"
+#include "xtensa_api.h" // Replace with interrupt allocator API (IDF-3891)
 #include "esp_types.h"
 #include "esp_random.h"
 #include "esp_mac.h"
--- a/components/esp_wifi/esp32s3/esp_adapter.c
+++ b/components/esp_wifi/esp32s3/esp_adapter.c
@ -17,7 +17,7 @@
 #include "freertos/semphr.h"
 #include "freertos/event_groups.h"
 #include "freertos/portmacro.h"
-#include "freertos/xtensa_api.h"
+#include "xtensa_api.h" // Replace with interrupt allocator API (IDF-3891)
 #include "esp_types.h"
 #include "esp_random.h"
 #include "esp_mac.h"
--- a/components/freertos/FreeRTOS-Kernel-SMP/portable/xtensa/include/freertos/portmacro.h
+++ b/components/freertos/FreeRTOS-Kernel-SMP/portable/xtensa/include/freertos/portmacro.h
@ -424,7 +424,7 @@ portmacro.h. Therefore, we need to keep these headers around for now to allow th
 #include "portbenchmark.h"
 #include <limits.h>
 #include <xtensa/config/system.h>
-#include <xtensa/xtensa_api.h>
+#include <xtensa_api.h>

 /* [refactor-todo] introduce a port wrapper function to avoid including esp_timer.h into the public header */
 #if CONFIG_FREERTOS_RUN_TIME_STATS_USING_ESP_TIMER
--- a/components/freertos/FreeRTOS-Kernel/portable/xtensa/include/freertos/portmacro.h
+++ b/components/freertos/FreeRTOS-Kernel/portable/xtensa/include/freertos/portmacro.h
@ -61,7 +61,7 @@
 /* [refactor-todo] These includes are not directly used in this file. They are kept into to prevent a breaking change. Remove these. */
 #include <limits.h>
 #include <xtensa/config/system.h>
-#include <xtensa/xtensa_api.h>
+#include <xtensa_api.h>

 /* [refactor-todo] introduce a port wrapper function to avoid including esp_timer.h into the public header */
 #if CONFIG_FREERTOS_RUN_TIME_STATS_USING_ESP_TIMER
--- a/components/freertos/test_apps/freertos/performance/test_isr_latency.c
+++ b/components/freertos/test_apps/freertos/performance/test_isr_latency.c
@ -18,7 +18,7 @@
 #include "test_utils.h"
 #if CONFIG_IDF_TARGET_ARCH_XTENSA
 #include "xtensa/hal.h"
-#include "freertos/xtensa_api.h"
+#include "xtensa_api.h"     // Replace with interrupt allocator API (IDF-3891)
 #define TEST_SET_INT_MASK(mask) xt_set_intset(mask)
 #define TEST_CLR_INT_MASK(mask) xt_set_intclear(mask)
 #elif CONFIG_IDF_TARGET_ARCH_RISCV
--- a/components/freertos/test_apps/freertos/port/test_fpu_in_isr.c
+++ b/components/freertos/test_apps/freertos/port/test_fpu_in_isr.c
@ -16,7 +16,7 @@
 #if SOC_CPU_HAS_FPU && CONFIG_FREERTOS_FPU_IN_ISR

 // We can use xtensa API here as currently, non of the RISC-V targets have an FPU
-#include "xtensa/xtensa_api.h"
+#include "xtensa_api.h"     // Replace with interrupt allocator API (IDF-3891)
 #include "esp_intr_alloc.h"

 #define SW_ISR_LEVEL_1      7
--- a/components/freertos/test_apps/freertos/port/test_xtensa_loadstore_handler.c
+++ b/components/freertos/test_apps/freertos/port/test_xtensa_loadstore_handler.c
@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@ -15,10 +15,7 @@
 #include "esp_random.h"
 #include "unity.h"

-#if CONFIG_IDF_TARGET_ARCH_XTENSA
-#include "freertos/xtensa_api.h"
-
-#ifdef CONFIG_ESP32_IRAM_AS_8BIT_ACCESSIBLE_MEMORY
+#if CONFIG_IDF_TARGET_ARCH_XTENSA && CONFIG_ESP32_IRAM_AS_8BIT_ACCESSIBLE_MEMORY
 TEST_CASE("LoadStore Exception handler", "[freertos]")
 {
    int32_t val0 = 0xDEADBEEF;
@ -128,5 +125,4 @@ TEST_CASE("LoadStore Exception handler", "[freertos]")
    TEST_ASSERT_TRUE(heap_caps_check_integrity_all(true));
    heap_caps_free(arr);
 }
-#endif // CONFIG_ESP32_IRAM_AS_8BIT_ACCESSIBLE_MEMORY
-#endif // CONFIG_IDF_TARGET_ARCH_XTENSA
+#endif // CONFIG_IDF_TARGET_ARCH_XTENSA && CONFIG_ESP32_IRAM_AS_8BIT_ACCESSIBLE_MEMORY
--- a/components/xtensa/deprecated_include/freertos/xtensa_api.h
+++ b/components/xtensa/deprecated_include/freertos/xtensa_api.h
@ -6,6 +6,6 @@

 #pragma once

-/* This header file has been moved, thus `#include <freertos/xtensa_api.h>` is deprecated. Please use `#include <xtensa_api.h>` instead */
-/* Todo: IDF-7230 */
-#include <xtensa/xtensa_api.h>
+#warning "This header file has been moved, thus `#include <freertos/xtensa_api.h>` is deprecated. Please use `#include <xtensa_api.h>` instead"
+
+#include <xtensa_api.h>
--- a/components/xtensa/deprecated_include/xtensa/xtensa_api.h
+++ b/components/xtensa/deprecated_include/xtensa/xtensa_api.h
@ -6,6 +6,6 @@

 #pragma once

-/* This header file has been moved, thus `#include <xtensa/xtensa_api.h>` is deprecated. Please use `#include <xtensa_api.h>` instead */
-/* Todo: IDF-7230 */
+#warning "This header file has been moved, thus `#include <xtensa/xtensa_api.h>` is deprecated. Please use `#include <xtensa_api.h>` instead"
+
 #include <xtensa_api.h>
--- a/components/xtensa/xtensa_intr.c
+++ b/components/xtensa/xtensa_intr.c
@ -31,7 +31,7 @@

 #include <xtensa/config/core.h>
 #include "esp_attr.h"
-#include "xtensa/xtensa_api.h"
+#include "xtensa_api.h"
 #include "sdkconfig.h"
 #include "esp_rom_sys.h"

--- a/examples/bluetooth/bluedroid/classic_bt/a2dp_sink/main/bt_app_core.c
+++ b/examples/bluetooth/bluedroid/classic_bt/a2dp_sink/main/bt_app_core.c
@ -7,7 +7,6 @@
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOSConfig.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
--- a/examples/bluetooth/bluedroid/classic_bt/bt_l2cap_client/main/bt_app_core.c
+++ b/examples/bluetooth/bluedroid/classic_bt/bt_l2cap_client/main/bt_app_core.c
@ -7,7 +7,6 @@
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOSConfig.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
--- a/examples/bluetooth/bluedroid/classic_bt/bt_l2cap_server/main/bt_app_core.c
+++ b/examples/bluetooth/bluedroid/classic_bt/bt_l2cap_server/main/bt_app_core.c
@ -7,7 +7,6 @@
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOSConfig.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
--- a/examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/main/console_uart.c
+++ b/examples/bluetooth/bluedroid/classic_bt/bt_spp_initiator/main/console_uart.c
@ -5,7 +5,6 @@
 */

 #include "driver/uart.h"
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 #include "freertos/queue.h"
--- a/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/main/spp_task.c
+++ b/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_acceptor/main/spp_task.c
@ -7,7 +7,6 @@
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOSConfig.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
--- a/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/main/spp_task.c
+++ b/examples/bluetooth/bluedroid/classic_bt/bt_spp_vfs_initiator/main/spp_task.c
@ -7,7 +7,6 @@
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOSConfig.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
--- a/examples/bluetooth/bluedroid/classic_bt/hfp_ag/main/bt_app_core.c
+++ b/examples/bluetooth/bluedroid/classic_bt/hfp_ag/main/bt_app_core.c
@ -7,7 +7,6 @@
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOSConfig.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
--- a/examples/bluetooth/bluedroid/classic_bt/hfp_hf/main/bt_app_core.c
+++ b/examples/bluetooth/bluedroid/classic_bt/hfp_hf/main/bt_app_core.c
@ -7,7 +7,6 @@
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOSConfig.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
--- a/examples/bluetooth/bluedroid/coex/a2dp_gatts_coex/main/bt_app_core.c
+++ b/examples/bluetooth/bluedroid/coex/a2dp_gatts_coex/main/bt_app_core.c
@ -7,7 +7,6 @@
 #include <stdint.h>
 #include <string.h>
 #include <stdbool.h>
-#include "freertos/xtensa_api.h"
 #include "freertos/FreeRTOSConfig.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"