Merge branch 'refactor/make_adc2_wifi_private' into 'master'

clean up deprecated and private header files for driver and esp_hw_support component

See merge request espressif/esp-idf!16605

components/driver/esp32c3/adc2_init_cal.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2016-2022 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -8,8 +8,8 @@
 The linker will link constructor (adc2_init_code_calibration) only when any sections inside the same file (adc2_cal_include) is used.
 Don't put any other code into this file. */
 
-#include "adc2_wifi_private.h"
 #include "hal/adc_hal.h"
+#include "esp_private/adc2_wifi.h"
 #include "esp_private/adc_cali.h"
 
 /**

components/driver/esp32s2/adc2_init_cal.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2016-2022 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -8,8 +8,8 @@
 The linker will link constructor (adc2_init_code_calibration) only when any sections inside the same file (adc2_cal_include) is used.
 Don't put any other code into this file. */
 
-#include "adc2_wifi_private.h"
 #include "hal/adc_hal.h"
+#include "esp_private/adc2_wifi.h"
 #include "esp_private/adc_cali.h"
 
 /**

components/driver/include/esp_private/adc2_wifi.h

@@ -1,17 +1,18 @@
 /*
- * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
 
 #pragma once
 
+#include "sdkconfig.h"
+#include "esp_err.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#include "esp_err.h"
-#include "soc/soc_caps.h"
 
 /**
  * @brief For WIFI module to claim the usage of ADC2.

components/esp_hw_support/include/esp_intr.h

@@ -1,9 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2010-2021 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-#pragma once
-#warning esp_intr.h is deprecated, please include esp_intr_alloc.h instead
-#include "esp_intr_alloc.h"

components/esp_wifi/src/wifi_init.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -8,6 +8,7 @@
 #include <esp_wifi.h>
 #include "esp_log.h"
 #include "esp_private/wifi.h"
+#include "esp_private/adc2_wifi.h"
 #include "esp_pm.h"
 #include "esp_sleep.h"
 #include "esp_private/pm_impl.h"
@@ -16,7 +17,6 @@
 #include "esp_netif.h"
 #include "tcpip_adapter_compatible/tcpip_adapter_compat.h"
 #include "driver/adc.h"
-#include "driver/adc2_wifi_private.h"
 #include "esp_coexist_internal.h"
 #include "esp_phy_init.h"
 #include "phy.h"

components/xtensa/include/esp_panic.h

@@ -1,4 +0,0 @@
-#pragma once
-#warning "esp_panic.h is deprecated, please use esp_debug_helpers.h or/and esp_private/panic_reason.h"
-#include "esp_private/panic_reason.h"
-#include "esp_debug_helpers.h"

docs/en/migration-guides/peripherals.rst

@@ -16,3 +16,8 @@ Version before v5.0, spi flash functions in rom can be included by ``esp32**/rom
 Therefore, the common APIs are extracted to ``esp_rom_spiflash.h``. Although it's not a breaking change, it is strongly recommended to only use the functions with prefix ``esp_rom_spiflash`` included by ``esp_rom_spiflash.h`` for better cross-compatibility.
 
 To make the API clearer, we renamed the function ``esp_rom_spiflash_lock`` to ``esp_rom_spiflash_set_bp``. We renamed ``esp_rom_spiflash_unlock`` to ``esp_rom_spiflash_clear_bp``.
+
+ADC
+---
+
+Previous `driver/adc2_wifi_private.h` has been moved to `esp_private/adc2_wifi.h`.

docs/en/migration-guides/system.rst

@@ -41,4 +41,7 @@ The header ``task_snapshot.h`` has been removed from ``freertos/task.h``. ESP-ID
 
 ESP HW Support
 --------------
-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.
+
+- 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.
+- The header file ``esp_intr.h`` has been deleted. Please include ``esp_intr_alloc.h`` to allocate and manipulate interrupts.
+- 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.

tools/ci/check_copyright_ignore.txt

@@ -2425,7 +2425,6 @@ components/xtensa/esp32s3/include/xtensa/config/system.h
 components/xtensa/esp32s3/include/xtensa/config/tie-asm.h
 components/xtensa/esp32s3/include/xtensa/config/tie.h
 components/xtensa/include/eri.h
-components/xtensa/include/esp_panic.h
 components/xtensa/include/esp_private/panic_reason.h
 components/xtensa/include/xt_instr_macros.h
 components/xtensa/include/xt_trax.h