hal: extract hal component from soc component

Author: ginkgm

components/bootloader/subproject/CMakeLists.txt

@@ -20,7 +20,7 @@ set(BOOTLOADER_BUILD 1)
 include("${IDF_PATH}/tools/cmake/project.cmake")
 set(common_req log esp_rom esp_common xtensa)
 if(LEGACY_INCLUDE_COMMON_HEADERS)
-    list(APPEND common_req soc)
+    list(APPEND common_req soc hal)
 endif()
 idf_build_set_property(__COMPONENT_REQUIRES_COMMON "${common_req}")
 idf_build_set_property(__OUTPUT_SDKCONFIG 0)

components/bootloader/subproject/Makefile

@@ -8,7 +8,7 @@ endif
 
 PROJECT_NAME := bootloader
 
-COMPONENTS := esptool_py bootloader_support log spi_flash micro-ecc soc main efuse esp_rom
+COMPONENTS := esptool_py bootloader_support log spi_flash micro-ecc soc main efuse esp_rom hal
 
 # Clear C and CXX from top level project
 CFLAGS =

components/bootloader_support/CMakeLists.txt

@@ -24,6 +24,7 @@ if(BOOTLOADER_BUILD)
     "src/${IDF_TARGET}/flash_encrypt.c"
     "src/${IDF_TARGET}/bootloader_${IDF_TARGET}.c"
     )
+    list(APPEND priv_requires hal)
 else()
     list(APPEND srcs
         "src/idf/bootloader_sha.c")

components/driver/CMakeLists.txt

@@ -44,15 +44,14 @@ if(IDF_TARGET STREQUAL "esp32s2")
                      "esp32s2/adc2_init_cal.c"
                      "spi_slave_hd.c"
                      "esp32s2/dac.c")
-    # currently only S2 beta has its own target-specific includes
     list(APPEND includes "esp32s2/include")
 endif()
 
 idf_component_register(SRCS "${srcs}"
                     INCLUDE_DIRS ${includes}
                     PRIV_INCLUDE_DIRS "include/driver"
                     PRIV_REQUIRES efuse esp_timer esp_ipc
-                    REQUIRES esp_ringbuf freertos soc) #cannot totally hide soc headers, since there are a lot arguments in the driver are chip-dependent
+                    REQUIRES esp_ringbuf freertos soc hal) # cannot totally hide soc headers, since there are a lot arguments in the driver are chip-dependent
 
 # uses C11 atomic feature
 set_source_files_properties(spi_master.c PROPERTIES COMPILE_FLAGS -std=gnu11)

components/esp_common/src/esp_err_to_name.c

@@ -527,7 +527,7 @@ static const esp_err_msg_t esp_err_msg_table[] = {
 #   ifdef      ESP_ERR_FLASH_OP_TIMEOUT
     ERR_TBL_IT(ESP_ERR_FLASH_OP_TIMEOUT),                       /* 24578 0x6002 */
 #   endif
-    // components/soc/include/hal/esp_flash_err.h
+    // components/hal/include/hal/esp_flash_err.h
 #   ifdef      ESP_ERR_FLASH_NOT_INITIALISED
     ERR_TBL_IT(ESP_ERR_FLASH_NOT_INITIALISED),                  /* 24579 0x6003 */
 #   endif

components/esp_rom/CMakeLists.txt

@@ -5,7 +5,7 @@ idf_component_register(SRCS "patches/esp_rom_crc.c"
                             "patches/esp_rom_uart.c" 
                        INCLUDE_DIRS include
                        PRIV_INCLUDE_DIRS "${target}"
-                       PRIV_REQUIRES soc)
+                       PRIV_REQUIRES soc hal)
 
 if(BOOTLOADER_BUILD)
     set(scripts

components/fatfs/test_fatfs_host/Makefile.files

@@ -34,6 +34,7 @@ INCLUDE_DIRS := \
 		esp_common/include \
 		bootloader_support/include \
 		app_update/include \
+		hal/include \
 		spi_flash/include \
 		wear_levelling/include \
 	)

components/hal/CMakeLists.txt

@@ -0,0 +1,73 @@
+idf_build_get_property(target IDF_TARGET)
+
+set(srcs    "wdt_hal_iram.c"
+            "mpu_hal.c")
+set(includes "${target}/include" "include")
+
+if(NOT BOOTLOADER_BUILD)
+    list(APPEND srcs
+                "cpu_hal.c"
+                "rmt_hal.c"
+                "rtc_io_hal.c"
+                "dac_hal.c"
+                "adc_hal.c"
+                "spi_hal.c"
+                "spi_hal_iram.c"
+                "spi_slave_hal.c"
+                "spi_slave_hal_iram.c"
+                "touch_sensor_hal.c"
+                "pcnt_hal.c"
+                "i2s_hal.c"
+                "sigmadelta_hal.c"
+                "timer_hal.c"
+                "ledc_hal.c"
+                "ledc_hal_iram.c"
+                "i2c_hal.c"
+                "i2c_hal_iram.c"
+                "gpio_hal.c"
+                "uart_hal.c"
+                "uart_hal_iram.c"
+                "spi_flash_hal.c"
+                "spi_flash_hal_iram.c"
+                "soc_hal.c"
+                "twai_hal.c")
+
+    if(${target} STREQUAL "esp32")
+        list(APPEND srcs
+                    "mcpwm_hal.c"
+                    "sdio_slave_hal.c"
+                    "esp32/adc_hal.c"
+                    "esp32/brownout_hal.c"
+                    "esp32/touch_sensor_hal.c")
+        if(NOT BOOTLOADER_BUILD AND CONFIG_ETH_USE_ESP32_EMAC)
+            list(APPEND srcs "esp32/emac_hal.c")
+        endif()
+    endif()
+
+    if(${target} STREQUAL "esp32s2")
+        list(APPEND srcs
+                    "spi_flash_hal_gpspi.c"
+                    "spi_slave_hd_hal.c"
+                    "esp32s2/adc_hal.c"
+                    "esp32s2/brownout_hal.c"
+                    "esp32s2/cp_dma_hal.c"
+                    "esp32s2/systimer_hal.c"
+                    "esp32s2/touch_sensor_hal.c"
+                    "esp32s2/usb_hal.c")
+    endif()
+
+    if(${target} STREQUAL "esp32s3")
+        list(APPEND srcs
+            "esp32s3/brownout_hal.c"
+            "esp32s3/systimer_hal.c"
+            "esp32s3/touch_sensor_hal.c")
+    endif()
+endif()
+
+idf_component_register(SRCS ${srcs}
+                       INCLUDE_DIRS ${includes}
+                       PRIV_INCLUDE_DIRS ${priv_include}
+                       REQUIRES soc
+                       LDFRAGMENTS linker.lf)
+
+

components/soc/src/hal/adc_hal.c renamed to components/hal/adc_hal.c

@@ -0,0 +1,10 @@
+COMPONENT_SRCDIRS := . esp32
+COMPONENT_ADD_INCLUDEDIRS := esp32/include include
+COMPONENT_ADD_LDFRAGMENTS += linker.lf
+
+COMPONENT_OBJEXCLUDE += ./spi_slave_hd_hal.o ./spi_flash_hal_gpspi.o ./spi_slave_hd_hal.o
+
+ifndef CONFIG_ETH_USE_ESP32_EMAC
+    COMPONENT_OBJEXCLUDE += esp32/emac_hal.o
+endif
+

components/hal/component.mk

@@ -0,0 +1,17 @@
+[mapping:hal]
+archive: libhal.a
+entries:
+    spi_hal_iram (noflash)
+    spi_slave_hal_iram (noflash)
+    if UART_ISR_IN_IRAM = y:
+        uart_hal_iram (noflash)
+    else:
+        uart_hal_iram (default)
+    spi_flash_hal_iram (noflash)
+    ledc_hal_iram (noflash)
+    i2c_hal_iram (noflash)
+    spi_flash_hal_gpspi (noflash)
+    cpu_hal (noflash)
+    soc_hal (noflash)
+    wdt_hal_iram (noflash)
+    systimer_hal (noflash)

components/soc/src/hal/cpu_hal.c renamed to components/hal/cpu_hal.c

@@ -36,7 +36,7 @@ else
 COMPILER := gcc
 endif
 
-CPPFLAGS += -I../include -I../src -I./ -I../../esp_common/include -I../../esp32/include -I ../../mbedtls/mbedtls/include -I ../../spi_flash/include -I ../../soc/include -I ../../xtensa/include -I ../../../tools/catch -fprofile-arcs -ftest-coverage
+CPPFLAGS += -I../include -I../src -I./ -I../../esp_common/include -I../../esp32/include -I ../../mbedtls/mbedtls/include -I ../../spi_flash/include -I ../../hal/include -I ../../xtensa/include -I ../../../tools/catch -fprofile-arcs -ftest-coverage
 CFLAGS += -fprofile-arcs -ftest-coverage
 CXXFLAGS += -std=c++11 -Wall -Werror
 LDFLAGS += -lstdc++ -Wall -fprofile-arcs -ftest-coverage

components/soc/src/hal/dac_hal.c renamed to components/hal/dac_hal.c

@@ -3,51 +3,19 @@ idf_build_get_property(target IDF_TARGET)
 idf_component_register(SRCS "src/cpu_util.c"
                             "src/memory_layout_utils.c"
                             "src/lldesc.c"
-                            "src/hal/cpu_hal.c"
-                            "src/hal/rmt_hal.c"
-                            "src/hal/rtc_io_hal.c"
-                            "src/hal/dac_hal.c"
-                            "src/hal/adc_hal.c"
-                            "src/hal/spi_hal.c"
-                            "src/hal/spi_hal_iram.c"
-                            "src/hal/spi_slave_hal.c"
-                            "src/hal/spi_slave_hal_iram.c"
-                            "src/hal/touch_sensor_hal.c"
                             "src/soc_include_legacy_warn.c"
-                            "src/hal/pcnt_hal.c"
-                            "src/hal/i2s_hal.c"
-                            "src/hal/sigmadelta_hal.c"
-                            "src/hal/timer_hal.c"
-                            "src/hal/ledc_hal.c"
-                            "src/hal/ledc_hal_iram.c"
-                            "src/hal/i2c_hal.c"
-                            "src/hal/i2c_hal_iram.c"
-                            "src/hal/gpio_hal.c"
-                            "src/hal/uart_hal.c"
-                            "src/hal/uart_hal_iram.c"
-                            "src/hal/spi_flash_hal.c"
-                            "src/hal/spi_flash_hal_iram.c"
-                            "src/hal/mpu_hal.c"
-                            "src/hal/soc_hal.c"
-                            "src/hal/wdt_hal_iram.c"
                             "src/compare_set.c"
-                            "src/hal/twai_hal.c"
+                       REQUIRES hal #cpu.h directly includes HAL header
                        PRIV_REQUIRES ${target}
                        LDFRAGMENTS linker.lf)
 
-if(CONFIG_IDF_TARGET_ESP32)
-    target_sources(${COMPONENT_LIB} PRIVATE "src/hal/mcpwm_hal.c"
-                                            "src/hal/sdio_slave_hal.c")
-elseif(CONFIG_IDF_TARGET_ESP32S2)
-    target_sources(${COMPONENT_LIB} PRIVATE "src/hal/spi_flash_hal_gpspi.c")
-    target_sources(${COMPONENT_LIB} PRIVATE "src/hal/spi_slave_hd_hal.c")
-endif()
 
 # Since there can be chip-specific HAL headers which can include the common
 # HAL header via include_next, process the build scripts here first so that
 # include directories appear first in the compile command.
 add_subdirectory(src/${target})
 target_include_directories(${COMPONENT_LIB} PUBLIC include)
+target_link_libraries(${COMPONENT_LIB} PRIVATE idf::hal)
 
 add_subdirectory(soc)
 target_link_libraries(${COMPONENT_LIB} PUBLIC "soc_${target}")

components/soc/src/esp32/adc_hal.c renamed to components/hal/esp32/adc_hal.c

@@ -1,8 +1,7 @@
 SOC_NAME := $(IDF_TARGET)
 
-COMPONENT_SRCDIRS := src src/hal
+COMPONENT_SRCDIRS := src
 COMPONENT_ADD_INCLUDEDIRS :=
-COMPONENT_OBJEXCLUDE += src/hal/spi_slave_hd_hal.o
 
 # Since there can be chip-specific HAL headers which can include the common
 # HAL header via include_next, process the build scripts here first so that

components/soc/src/esp32/brownout_hal.c renamed to components/hal/esp32/brownout_hal.c

@@ -9,18 +9,4 @@ entries:
     rtc_sleep (noflash_text)
     rtc_time (noflash_text)
     rtc_wdt (noflash_text)
-    spi_hal_iram (noflash)
-    spi_slave_hal_iram (noflash)
-    if UART_ISR_IN_IRAM = y:
-        uart_hal_iram (noflash)
-    else:
-        uart_hal_iram (default)
-    spi_flash_hal_iram (noflash)
-    ledc_hal_iram (noflash)
-    i2c_hal_iram (noflash)
-    spi_flash_hal_gpspi (noflash)
     lldesc (noflash)
-    cpu_hal (noflash)
-    soc_hal (noflash)
-    wdt_hal_iram (noflash)
-    systimer_hal (noflash)

components/soc/src/esp32/emac_hal.c renamed to components/hal/esp32/emac_hal.c

@@ -1,5 +1,4 @@
-set(srcs "adc_hal.c"
-    "brownout_hal.c"
+set(srcs
     "rtc_clk.c"
     "rtc_clk_init.c"
     "rtc_init.c"
@@ -8,17 +7,12 @@ set(srcs "adc_hal.c"
     "rtc_time.c"
     "rtc_wdt.c"
     "soc_memory_layout.c"
-    "touch_sensor_hal.c")
-
-if(NOT BOOTLOADER_BUILD AND CONFIG_ETH_USE_ESP32_EMAC)
-    list(APPEND srcs "emac_hal.c")
-endif()
+)
 
 add_prefix(srcs "${CMAKE_CURRENT_LIST_DIR}/" "${srcs}")
 
 target_sources(${COMPONENT_LIB} PRIVATE "${srcs}")
 target_include_directories(${COMPONENT_LIB} PUBLIC . include)
-target_include_directories(${COMPONENT_LIB} PRIVATE ../hal)
 
 if(NOT CMAKE_BUILD_EARLY_EXPANSION)
     set_source_files_properties("${CMAKE_CURRENT_LIST_DIR}/rtc_clk.c" PROPERTIES

components/soc/src/esp32/include/hal/adc_hal.h renamed to components/hal/esp32/include/hal/adc_hal.h

@@ -1,24 +1,18 @@
-set(srcs "adc_hal.c"
+set(srcs
         "dac_hal.c"
-        "brownout_hal.c"
-        "cp_dma_hal.c"
         "rtc_clk.c"
         "rtc_clk_init.c"
         "rtc_init.c"
         "rtc_pm.c"
         "rtc_sleep.c"
         "rtc_time.c"
         "rtc_wdt.c"
-        "soc_memory_layout.c"
-        "systimer_hal.c"
-        "touch_sensor_hal.c"
-        "usb_hal.c")
+        "soc_memory_layout.c")
 
 add_prefix(srcs "${CMAKE_CURRENT_LIST_DIR}/" "${srcs}")
 
 target_sources(${COMPONENT_LIB} PRIVATE "${srcs}")
 target_include_directories(${COMPONENT_LIB} PUBLIC . include)
-target_include_directories(${COMPONENT_LIB} PRIVATE ../hal)
 
 if(NOT CMAKE_BUILD_EARLY_EXPANSION)
     set_source_files_properties("${CMAKE_CURRENT_LIST_DIR}/rtc_clk.c" PROPERTIES

components/soc/src/esp32/include/hal/adc_ll.h renamed to components/hal/esp32/include/hal/adc_ll.h

@@ -1,19 +1,16 @@
-set(srcs "brownout_hal.c"
+set(srcs
         "rtc_clk_init.c"
         "rtc_clk.c"
         "rtc_init.c"
         "rtc_pm.c"
         "rtc_sleep.c"
         "rtc_time.c"
-        "soc_memory_layout.c"
-        "systimer_hal.c"
-        "touch_sensor_hal.c")
+        "soc_memory_layout.c")
 
 add_prefix(srcs "${CMAKE_CURRENT_LIST_DIR}/" "${srcs}")
 
 target_sources(${COMPONENT_LIB} PRIVATE "${srcs}")
 target_include_directories(${COMPONENT_LIB} PUBLIC . include)
-target_include_directories(${COMPONENT_LIB} PRIVATE ../hal)
 
 if(NOT CMAKE_BUILD_EARLY_EXPANSION)
     set_source_files_properties("${CMAKE_CURRENT_LIST_DIR}/rtc_clk.c" PROPERTIES

components/soc/src/esp32/include/hal/can_hal.h renamed to components/hal/esp32/include/hal/can_hal.h

@@ -45,6 +45,7 @@ else()
 endif()
 
 idf_component_register(SRCS "${srcs}"
+                    REQUIRES hal
                     PRIV_REQUIRES "${priv_requires}"
                     INCLUDE_DIRS include
                     PRIV_INCLUDE_DIRS private_include

components/soc/src/esp32/include/hal/can_ll.h renamed to components/hal/esp32/include/hal/can_ll.h

@@ -36,5 +36,6 @@ INCLUDE_DIRS := \
 	esp_timer/include \
 	bootloader_support/include \
 	app_update/include \
+	hal/include \
 	spi_flash/include \
 	)

components/soc/src/esp32/include/hal/can_types.h renamed to components/hal/esp32/include/hal/can_types.h

@@ -30,6 +30,7 @@ INCLUDE_DIRS := \
 	esp_timer/include \
 	bootloader_support/include \
 	app_update/include \
+	hal/include \
 	spi_flash/include \
 	)
 

components/soc/src/esp32/include/hal/clk_gate_ll.h renamed to components/hal/esp32/include/hal/clk_gate_ll.h

@@ -35,5 +35,6 @@ INCLUDE_DIRS := \
 	bootloader_support/include \
 	app_update/include \
 	spi_flash/include \
+	hal/include \
 	wear_levelling/include \
 	)

components/soc/src/esp32/include/hal/cpu_ll.h renamed to components/hal/esp32/include/hal/cpu_ll.h

@@ -33,5 +33,6 @@ INCLUDE_DIRS := \
 	esp32/include \
 	bootloader_support/include \
 	app_update/include \
+	hal/include \
 	spi_flash/include \
 	)

components/soc/src/esp32/include/hal/dac_ll.h renamed to components/hal/esp32/include/hal/dac_ll.h

@@ -25,5 +25,5 @@ idf_component_register(SRCS ${srcs}
                     PRIV_REQUIRES ${priv_requires})
 
 if(NOT BOOTLOADER_BUILD)
-    target_link_libraries(${COMPONENT_LIB} PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/${target}/libhal.a")
+    target_link_libraries(${COMPONENT_LIB} PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/${target}/libxt_hal.a")
 endif()

components/soc/src/esp32/include/hal/emac.h renamed to components/hal/esp32/include/hal/emac.h

@@ -1,6 +1,6 @@
 COMPONENT_ADD_INCLUDEDIRS := include esp32/include
 
-COMPONENT_ADD_LDFLAGS += $(COMPONENT_PATH)/esp32/libhal.a
+COMPONENT_ADD_LDFLAGS += $(COMPONENT_PATH)/esp32/libxt_hal.a
 
 COMPONENT_ADD_LDFRAGMENTS += linker.lf