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

This commit deprecates the "freertos/xtensa_context.h" and "xtensa/xtensa_context.h" include paths. Users should use "xtensa_context.h" instead. - Replace legacy include paths - Removed some unnecessary includes of "xtensa_api.h" - Add warning to compatibility header
2023-10-27 18:10:47 +08:00 · 2023-10-27 18:10:47 +08:00 · a5d5ee7445
commit a5d5ee7445
--- a/components/bt/controller/esp32/hli_vectors.S
+++ b/components/bt/controller/esp32/hli_vectors.S
@ -8,7 +8,7 @@
 #include <xtensa/coreasm.h>
 #include <xtensa/corebits.h>
 #include <xtensa/config/system.h>
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "sdkconfig.h"
 #include "soc/soc.h"

--- a/components/esp_gdbstub/src/port/xtensa/include/esp_gdbstub_arch.h
+++ b/components/esp_gdbstub/src/port/xtensa/include/esp_gdbstub_arch.h
@ -6,7 +6,7 @@

 #pragma once
 #include <stdint.h>
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "sdkconfig.h"

 #if CONFIG_IDF_TARGET_ESP32
--- a/components/esp_gdbstub/src/port/xtensa/xt_debugexception.S
+++ b/components/esp_gdbstub/src/port/xtensa/xt_debugexception.S
@ -7,7 +7,7 @@
 #include <xtensa/coreasm.h>
 #include <xtensa/corebits.h>
 #include <xtensa/config/system.h>
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"

    .section    .iram1,"ax"
    .global     _xt_panic_gdbstub
--- a/components/esp_hw_support/test_apps/esp_hw_support_unity_tests/main/test_dport_xt_highint5.S
+++ b/components/esp_hw_support/test_apps/esp_hw_support_unity_tests/main/test_dport_xt_highint5.S
@ -9,7 +9,7 @@
 #include <xtensa/coreasm.h>
 #include <xtensa/corebits.h>
 #include <xtensa/config/system.h>
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "esp_private/panic_reason.h"
 #include "soc/soc.h"
 #include "soc/dport_reg.h"
--- a/components/esp_system/port/arch/xtensa/debug_helpers.c
+++ b/components/esp_system/port/arch/xtensa/debug_helpers.c
@ -15,7 +15,7 @@
 #include "esp_cpu_utils.h"
 #include "esp_private/panic_internal.h"

-#include "xtensa/xtensa_context.h"
+#include "xtensa_context.h"

 #include "sdkconfig.h"

--- a/components/esp_system/port/arch/xtensa/esp_ipc_isr_handler.S
+++ b/components/esp_system/port/arch/xtensa/esp_ipc_isr_handler.S
@ -7,7 +7,7 @@
 #include <xtensa/coreasm.h>
 #include <xtensa/corebits.h>
 #include <xtensa/config/system.h>
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "esp_private/panic_reason.h"
 #include "sdkconfig.h"
 #include "soc/soc.h"
--- a/components/esp_system/port/arch/xtensa/expression_with_stack_asm.S
+++ b/components/esp_system/port/arch/xtensa/expression_with_stack_asm.S
@ -1,18 +1,10 @@
-// Copyright 2015-2019 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+/*
+ * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */

-#include <freertos/xtensa_context.h>
+#include <xtensa_context.h>

    .extern xtensa_shared_stack
    .extern xtensa_shared_stack_callback
--- a/components/esp_system/port/arch/xtensa/panic_arch.c
+++ b/components/esp_system/port/arch/xtensa/panic_arch.c
@ -4,7 +4,7 @@
 * SPDX-License-Identifier: Apache-2.0
 */

-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"

--- a/components/esp_system/port/soc/esp32/highint_hdl.S
+++ b/components/esp_system/port/soc/esp32/highint_hdl.S
@ -8,7 +8,7 @@
 #include <xtensa/coreasm.h>
 #include <xtensa/corebits.h>
 #include <xtensa/config/system.h>
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "freertos/xtensa_rtos.h"
 #include "esp_private/panic_reason.h"
 #include "sdkconfig.h"
--- a/components/esp_system/port/soc/esp32s2/highint_hdl.S
+++ b/components/esp_system/port/soc/esp32s2/highint_hdl.S
@ -1,22 +1,14 @@
-// Copyright 2015-2017 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+/*
+ * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */


 #include <xtensa/coreasm.h>
 #include <xtensa/corebits.h>
 #include <xtensa/config/system.h>
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "esp_private/panic_reason.h"
 #include "sdkconfig.h"
 #include "soc/soc.h"
--- a/components/esp_system/port/soc/esp32s3/highint_hdl.S
+++ b/components/esp_system/port/soc/esp32s3/highint_hdl.S
@ -8,7 +8,7 @@
 #include <xtensa/coreasm.h>
 #include <xtensa/corebits.h>
 #include <xtensa/config/system.h>
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "esp_private/panic_reason.h"
 #include "sdkconfig.h"
 #include "soc/soc.h"
--- a/components/espcoredump/src/port/xtensa/core_dump_port.c
+++ b/components/espcoredump/src/port/xtensa/core_dump_port.c
@ -14,7 +14,7 @@
 #include "soc/soc_memory_layout.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "esp_rom_sys.h"
 #include "esp_core_dump_common.h"
 #include "esp_core_dump_port.h"
--- a/components/freertos/FreeRTOS-Kernel-SMP/portable/xtensa/port.c
+++ b/components/freertos/FreeRTOS-Kernel-SMP/portable/xtensa/port.c
@ -13,7 +13,7 @@
 #include "portmacro.h"
 #include "spinlock.h"
 #include "xt_instr_macros.h"
-#include "xtensa/xtensa_context.h"
+#include "xtensa_context.h"
 #include "xtensa/corebits.h"
 #include "xtensa/config/core.h"
 #include "xtensa/config/core-isa.h"
--- a/components/freertos/FreeRTOS-Kernel/portable/xtensa/port.c
+++ b/components/freertos/FreeRTOS-Kernel/portable/xtensa/port.c
@ -37,7 +37,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <xtensa/config/core.h>
-#include <xtensa/xtensa_context.h>
+#include <xtensa_context.h>
 #include "soc/soc_caps.h"
 #include "esp_attr.h"
 #include "esp_private/crosscore_int.h"
--- a/components/xtensa/deprecated_include/freertos/xtensa_context.h
+++ b/components/xtensa/deprecated_include/freertos/xtensa_context.h
@ -6,6 +6,6 @@

 #pragma once

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

 #pragma once

-/* This header file has been moved, thus `#include <xtensa/xtensa_context.h>` is deprecated. Please use `#include <xtensa_context.h>` instead */
-/* Todo: IDF-7230 */
+#warning "This header file has been moved, thus `#include <xtensa/xtensa_context.h>` is deprecated. Please use `#include <xtensa_context.h>` instead"
+
 #include <xtensa_context.h>
--- a/components/xtensa/xtensa_intr_asm.S
+++ b/components/xtensa/xtensa_intr_asm.S
@ -36,7 +36,7 @@
 #include <xtensa/hal.h>
 #include <xtensa/config/core.h>

-#include "xtensa/xtensa_context.h"
+#include "xtensa_context.h"

 /*
 * When compiling for G0-only, we don't have FreeRTOS component.
--- a/tools/test_apps/system/memprot/main/esp32s2/test_panic.c
+++ b/tools/test_apps/system/memprot/main/esp32s2/test_panic.c
@ -4,7 +4,7 @@
 * SPDX-License-Identifier: Apache-2.0
 */

-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "esp_private/panic_internal.h"

 extern void esp_panic_handler(panic_info_t *info);
--- a/tools/test_apps/system/memprot/main/esp32s3/test_panic.c
+++ b/tools/test_apps/system/memprot/main/esp32s3/test_panic.c
@ -4,7 +4,7 @@
 * SPDX-License-Identifier: Apache-2.0
 */

-#include "freertos/xtensa_context.h"
+#include "xtensa_context.h"
 #include "esp_private/panic_internal.h"
 #include "hal/wdt_hal.h"

--- a/tools/test_apps/system/panic/main/panic_utils/memprot_panic_utils_xtensa.c
+++ b/tools/test_apps/system/panic/main/panic_utils/memprot_panic_utils_xtensa.c
@ -4,7 +4,6 @@
 * SPDX-License-Identifier: Apache-2.0
 */

-#include "freertos/xtensa_context.h"
 #include "esp_private/panic_internal.h"

 #include "esp_rom_sys.h"