change(doxyfile): move soc files to target specific doxygen

soc files relies on target variable, which not correct while there are multiple versions for one target

docs/conf_common.py

@@ -79,6 +79,10 @@ COEXISTENCE_DOCS = ['api-guides/coexist.rst']
 
 MM_SYNC_DOCS = ['api-reference/system/mm_sync.rst']
 
+CLK_TREE_DOCS = ['api-reference/peripherals/clk_tree.rst']
+
+UART_DOCS = ['api-reference/peripherals/uart.rst']
+
 SDMMC_DOCS = ['api-reference/peripherals/sdmmc_host.rst']
 
 SDIO_SLAVE_DOCS = ['api-reference/peripherals/sdio_slave.rst',
@@ -204,6 +208,8 @@ conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS,
                             'SOC_SUPPORT_COEXISTENCE':COEXISTENCE_DOCS,
                             'SOC_PSRAM_DMA_CAPABLE':MM_SYNC_DOCS,
                             'SOC_CACHE_INTERNAL_MEM_VIA_L1CACHE':MM_SYNC_DOCS,
+                            'SOC_CLK_TREE_SUPPORTED':CLK_TREE_DOCS,
+                            'SOC_UART_SUPPORTED':UART_DOCS,
                             'SOC_SDMMC_HOST_SUPPORTED':SDMMC_DOCS,
                             'SOC_SDIO_SLAVE_SUPPORTED':SDIO_SLAVE_DOCS,
                             'SOC_MCPWM_SUPPORTED':MCPWM_DOCS,

docs/doxygen/Doxyfile

@@ -288,11 +288,6 @@ INPUT = \
     $(PROJECT_PATH)/components/protocomm/include/crypto/srp6a/esp_srp.h \
     $(PROJECT_PATH)/components/pthread/include/esp_pthread.h \
     $(PROJECT_PATH)/components/sdmmc/include/sdmmc_cmd.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
     $(PROJECT_PATH)/components/spi_flash/include/esp_flash_spi_init.h \
     $(PROJECT_PATH)/components/spi_flash/include/esp_flash.h \
     $(PROJECT_PATH)/components/spi_flash/include/spi_flash_mmap.h \

docs/doxygen/Doxyfile_esp32

@@ -1,8 +1,13 @@
 INPUT += \
          $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \
          $(PROJECT_PATH)/components/esp_psram/include/esp32/himem.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
          $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
          $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
          $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \
          $(PROJECT_PATH)/components/ulp/ulp_common/include/$(IDF_TARGET)/ulp_common_defs.h \
          $(PROJECT_PATH)/components/ulp/ulp_fsm/include/$(IDF_TARGET)/ulp.h \

docs/doxygen/Doxyfile_esp32c2

@@ -2,3 +2,8 @@ INPUT += \
     $(PROJECT_PATH)/components/bt/include/esp32c2/include/esp_bt.h \
     $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
     $(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \

docs/doxygen/Doxyfile_esp32c3

@@ -2,3 +2,8 @@ INPUT += \
     $(PROJECT_PATH)/components/bt/include/esp32c3/include/esp_bt.h \
     $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
     $(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \

docs/doxygen/Doxyfile_esp32c5

@@ -1 +1,7 @@
+# TODO: IDF-9197 Use beta3 in doc temprory
 INPUT += \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/soc_caps.h \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/adc_channel.h \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/clk_tree_defs.h \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/gpio_num.h \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/uart_channel.h \

docs/doxygen/Doxyfile_esp32c6

@@ -13,3 +13,8 @@ INPUT += \
     $(PROJECT_PATH)/components/ulp/ulp_common/include/ulp_common.h \
     $(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_he_types.h \
     $(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_he.h \
+	$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \

docs/doxygen/Doxyfile_esp32h2

@@ -3,3 +3,8 @@ INPUT += \
     $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
     $(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \
     $(PROJECT_PATH)/components/esp_coex/include/esp_coex_i154.h \
+	$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \

docs/doxygen/Doxyfile_esp32p4

@@ -15,3 +15,8 @@ INPUT += \
     $(PROJECT_PATH)/components/hal/include/hal/jpeg_types.h \
     $(PROJECT_PATH)/components/esp_driver_jpeg/include/driver/jpeg_decode.h \
     $(PROJECT_PATH)/components/esp_driver_jpeg/include/driver/jpeg_types.h \
+	$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \

docs/doxygen/Doxyfile_esp32s2

@@ -1,7 +1,12 @@
 INPUT += \
          $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \
+		 $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
          $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
          $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
          $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \
          $(PROJECT_PATH)/components/ulp/ulp_common/include/$(IDF_TARGET)/ulp_common_defs.h \
          $(PROJECT_PATH)/components/ulp/ulp_fsm/include/$(IDF_TARGET)/ulp.h \

docs/doxygen/Doxyfile_esp32s3

@@ -1,7 +1,12 @@
 INPUT += \
          $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \
          $(PROJECT_PATH)/components/esp_lcd/rgb/include/esp_lcd_panel_rgb.h \
+		 $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
          $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
          $(PROJECT_PATH)/components/ulp/ulp_common/include/$(IDF_TARGET)/ulp_common_defs.h \
          $(PROJECT_PATH)/components/ulp/ulp_fsm/include/$(IDF_TARGET)/ulp.h \
          $(PROJECT_PATH)/components/touch_element/include/touch_element/touch_button.h \

docs/en/api-reference/peripherals/index.rst

@@ -10,7 +10,7 @@ Peripherals API
     :SOC_ADC_DMA_SUPPORTED: adc_continuous
     :SOC_ADC_SUPPORTED: adc_calibration
     :SOC_ANA_CMPR_SUPPORTED: ana_cmpr
-    clk_tree
+    :SOC_CLK_TREE_SUPPORTED: clk_tree
     :SOC_DAC_SUPPORTED: dac
     :SOC_ECDSA_SUPPORTED: ecdsa
     :SOC_ETM_SUPPORTED: etm

docs/zh_CN/api-reference/peripherals/index.rst

@@ -10,7 +10,7 @@
     :SOC_ADC_DMA_SUPPORTED: adc_continuous
     :SOC_ADC_SUPPORTED: adc_calibration
     :SOC_ANA_CMPR_SUPPORTED: ana_cmpr
-    clk_tree
+    :SOC_CLK_TREE_SUPPORTED: clk_tree
     :SOC_DAC_SUPPORTED: dac
     :SOC_ECDSA_SUPPORTED: ecdsa
     :SOC_ETM_SUPPORTED: etm

tools/ci/check_public_headers.py

@@ -2,12 +2,9 @@
 #
 # Checks all public headers in IDF in the ci
 #
-# SPDX-FileCopyrightText: 2020-2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-FileCopyrightText: 2020-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 #
-
-from __future__ import print_function, unicode_literals
-
 import argparse
 import fnmatch
 import json
@@ -16,9 +13,13 @@ import queue
 import re
 import subprocess
 import tempfile
-from io import open
+from threading import Event
-from threading import Event, Thread
+from threading import Thread
-from typing import List, Optional, Set, Tuple, Union
+from typing import List
+from typing import Optional
+from typing import Set
+from typing import Tuple
+from typing import Union
 
 
 class HeaderFailed(Exception):
@@ -105,7 +106,7 @@ class PublicHeaderChecker:
         self.kconfig_macro = re.compile(r'\bCONFIG_[A-Z0-9_]+')
         self.static_assert = re.compile(r'(_Static_assert|static_assert)')
         self.defines_assert = re.compile(r'#define[ \t]+ESP_STATIC_ASSERT')
-        self.auto_soc_header = re.compile(r'components/soc/esp[a-z0-9_]+/include(?:/rev[0-9]+)?/(soc|modem)/[a-zA-Z0-9_]+.h')
+        self.auto_soc_header = re.compile(r'components/soc/esp[a-z0-9_]+(?:/\w+)?/include(?:/rev[0-9]+)?/(soc|modem)/[a-zA-Z0-9_]+.h')
         self.assembly_nocode = r'^\s*(\.file|\.text|\.ident|\.option|\.attribute).*$'
         self.check_threads: List[Thread] = []
 

tools/ci/check_public_headers_exceptions.txt

@@ -97,6 +97,8 @@ components/esp_rom/include/esp32c3/rom/rtc.h
 components/esp_rom/include/esp32s2/rom/rtc.h
 components/esp_rom/include/esp32s3/rom/rtc.h
 components/esp_rom/include/esp32c2/rom/rtc.h
+# TODO: IDF-9197
+components/esp_rom/include/esp32c5/beta3/esp32c5/rom/rtc.h
 components/esp_rom/include/esp32c6/rom/rtc.h
 components/esp_rom/include/esp32h2/rom/rtc.h
 components/esp_rom/include/esp32p4/rom/rtc.h