Merge branch 'change/remove_deprecated_esp_rom_status' into 'master'

change(rom): removed deprecated STATUS enum, use ETS_STATUS instead Closes IDF-7044 and DOC-12309 See merge request espressif/esp-idf!41860
2025-10-03 10:30:58 +02:00 · 2025-09-16 09:41:31 +08:00
parent 9cee386af9 8833953070
commit 166269fb93
15 changed files with 27 additions and 146 deletions
--- a/components/esp_rom/esp32/include/esp32/rom/ets_sys.h
+++ b/components/esp_rom/esp32/include/esp32/rom/ets_sys.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2010-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2010-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -624,17 +624,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32c2/include/esp32c2/rom/ets_sys.h
+++ b/components/esp_rom/esp32c2/include/esp32c2/rom/ets_sys.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2020-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2020-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -456,17 +456,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32c3/include/esp32c3/rom/ets_sys.h
+++ b/components/esp_rom/esp32c3/include/esp32c3/rom/ets_sys.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2020-2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2020-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -433,17 +433,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32c5/include/esp32c5/rom/ets_sys.h
+++ b/components/esp_rom/esp32c5/include/esp32c5/rom/ets_sys.h
@@ -410,17 +410,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
 * @brief Returns the offset from which the bootloader image is used to load.
 *
--- a/components/esp_rom/esp32c6/include/esp32c6/rom/ets_sys.h
+++ b/components/esp_rom/esp32c6/include/esp32c6/rom/ets_sys.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -410,17 +410,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32c61/include/esp32c61/rom/ets_sys.h
+++ b/components/esp_rom/esp32c61/include/esp32c61/rom/ets_sys.h
@@ -410,17 +410,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
 * @brief Returns the offset from which the bootloader image is used to load.
 *
--- a/components/esp_rom/esp32h2/include/esp32h2/rom/ets_sys.h
+++ b/components/esp_rom/esp32h2/include/esp32h2/rom/ets_sys.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -409,17 +409,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32h21/include/esp32h21/rom/ets_sys.h
+++ b/components/esp_rom/esp32h21/include/esp32h21/rom/ets_sys.h
@@ -409,17 +409,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32h4/include/esp32h4/rom/ets_sys.h
+++ b/components/esp_rom/esp32h4/include/esp32h4/rom/ets_sys.h
@@ -414,17 +414,6 @@ void ets_set_appcpu_boot_addr(uint32_t start);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32p4/include/esp32p4/rom/ets_sys.h
+++ b/components/esp_rom/esp32p4/include/esp32p4/rom/ets_sys.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -508,14 +508,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS;
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32p4/include/esp32p4/rom/uart.h
+++ b/components/esp_rom/esp32p4/include/esp32p4/rom/uart.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -228,7 +228,7 @@ void uart_buff_switch(uint8_t uart_no);
  *
  * @return OK.
  */
-STATUS uart_tx_one_char(uint8_t TxChar);
+ETS_STATUS uart_tx_one_char(uint8_t TxChar);

 /**
  * @brief Output a char to message exchange channel, wait until fifo not full.
@@ -238,7 +238,7 @@ STATUS uart_tx_one_char(uint8_t TxChar);
  *
  * @return OK.
  */
-STATUS uart_tx_one_char2(uint8_t TxChar);
+ETS_STATUS uart_tx_one_char2(uint8_t TxChar);

 /**
  * @brief Wait until uart tx full empty.
@@ -268,7 +268,7 @@ void uart_tx_wait_idle(uint8_t uart_no);
  * @return OK for successful.
  *         FAIL for failed.
  */
-STATUS uart_rx_one_char(uint8_t *pRxChar);
+ETS_STATUS uart_rx_one_char(uint8_t *pRxChar);

 /**
  * @brief Get an input char from message channel, wait until successful.
@@ -290,7 +290,7 @@ char uart_rx_one_char_block(void);
  *
  * @return OK.
  */
-STATUS UartRxString(uint8_t *pString, uint8_t MaxStrlen);
+ETS_STATUS UartRxString(uint8_t *pString, uint8_t MaxStrlen);

 /**
  * @brief Process uart received information in the interrupt handler.
@@ -313,7 +313,7 @@ void uart_rx_intr_handler(void *para);
  * @return OK for successful.
  *         FAIL for failed.
  */
-STATUS uart_rx_readbuff( RcvMsgBuff *pRxBuff, uint8_t *pRxByte);
+ETS_STATUS uart_rx_readbuff( RcvMsgBuff *pRxBuff, uint8_t *pRxByte);

 /**
  * @brief Get all chars from receive buffer.
@@ -324,7 +324,7 @@ STATUS uart_rx_readbuff( RcvMsgBuff *pRxBuff, uint8_t *pRxByte);
  * @return OK for successful.
  *         FAIL for failed.
  */
-STATUS UartGetCmdLn(uint8_t *pCmdLn);
+ETS_STATUS UartGetCmdLn(uint8_t *pCmdLn);

 /**
  * @brief Get uart configuration struct.
@@ -374,7 +374,7 @@ int recv_packet(uint8_t *p, int len, uint8_t is_sync);
  * @return OK for successful.
  *         FAIL for failed.
  */
-STATUS SendMsg(uint8_t *pData, uint16_t DataLen);
+ETS_STATUS SendMsg(uint8_t *pData, uint16_t DataLen);

 /**
  * @brief Receive an packet from download tool, with SLIP escaping.
@@ -390,7 +390,7 @@ STATUS SendMsg(uint8_t *pData, uint16_t DataLen);
  * @return OK for successful.
  *         FAIL for failed.
  */
-STATUS RcvMsg(uint8_t *pData, uint16_t MaxDataLen, uint8_t is_sync);
+ETS_STATUS RcvMsg(uint8_t *pData, uint16_t MaxDataLen, uint8_t is_sync);

 /**
  * @brief Check if this UART is in download connection.
--- a/components/esp_rom/esp32s2/include/esp32s2/rom/ets_sys.h
+++ b/components/esp_rom/esp32s2/include/esp32s2/rom/ets_sys.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2010-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2010-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -574,17 +574,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/components/esp_rom/esp32s3/include/esp32s3/rom/ets_sys.h
+++ b/components/esp_rom/esp32s3/include/esp32s3/rom/ets_sys.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2010-2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2010-2025 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -546,17 +546,6 @@ void intr_matrix_set(int cpu_no, uint32_t model_num, uint32_t intr_num);

 #define ETS_MEM_BAR() asm volatile ( "" : : : "memory" )

-#ifdef ESP_PLATFORM
-// Remove in IDF v6.0 (IDF-7044)
-typedef enum {
-    OK = 0,
-    FAIL,
-    PENDING,
-    BUSY,
-    CANCEL,
-} STATUS __attribute__((deprecated("Use ETS_STATUS instead")));
-#endif
-
 /**
  * @}
  */
--- a/docs/en/migration-guides/release-6.x/6.0/system.rst
+++ b/docs/en/migration-guides/release-6.x/6.0/system.rst
@@ -60,6 +60,11 @@ The deprecated ``intr_types.h`` header file has been removed. Please include the

 The deprecated ``esp_private/interrupt_deprecated.h`` header file, which was available to users through the ``riscv/interrupt.h`` header, has been removed. The deprecated functions are no longer available, please use the non-deprecated versions instead.

+ROM Headers
+-----------
+
+The deprecated ``STATUS`` type has been removed from ``ets_sys.h`` ROM header files. Please use ``ETS_STATUS`` instead.
+
 App Trace
 ----------

--- a/docs/zh_CN/migration-guides/release-6.x/6.0/system.rst
+++ b/docs/zh_CN/migration-guides/release-6.x/6.0/system.rst
@@ -60,6 +60,11 @@ Xtensa 特殊寄存器头文件已更新，使用新的命名约定。旧的 ``s

 已弃用的头文件 ``esp_private/interrupt_deprecated.h`` 已被移除，已弃用的函数不再可用，请改用非弃用版本。

+ROM 头文件
+-----------
+
+已从 ``ets_sys.h`` ROM 头文件中移除了已弃用的 ``STATUS`` 类型。请改用 ``ETS_STATUS``。
+
 App 追踪
 ----------