mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
562af8f65e
This MR removes the common dependency from every IDF components to the SOC component. Currently, in the ``idf_functions.cmake`` script, we include the header path of SOC component by default for all components. But for better code organization (or maybe also benifits to the compiling speed), we may remove the dependency to SOC components for most components except the driver and kernel related components. In CMAKE, we have two kinds of header visibilities (set by include path visibility): (Assume component A --(depends on)--> B, B is the current component) 1. public (``COMPONENT_ADD_INCLUDEDIRS``): means this path is visible to other depending components (A) (visible to A and B) 2. private (``COMPONENT_PRIV_INCLUDEDIRS``): means this path is only visible to source files inside the component (visible to B only) and we have two kinds of depending ways: (Assume component A --(depends on)--> B --(depends on)--> C, B is the current component) 1. public (```COMPONENT_REQUIRES```): means B can access to public include path of C. All other components rely on you (A) will also be available for the public headers. (visible to A, B) 2. private (``COMPONENT_PRIV_REQUIRES``): means B can access to public include path of C, but don't propagate this relation to other components (A). (visible to B) 1. remove the common requirement in ``idf_functions.cmake``, this makes the SOC components invisible to all other components by default. 2. if a component (for example, DRIVER) really needs the dependency to SOC, add a private dependency to SOC for it. 3. some other components that don't really depends on the SOC may still meet some errors saying "can't find header soc/...", this is because it's depended component (DRIVER) incorrectly include the header of SOC in its public headers. Moving all this kind of #include into source files, or private headers 4. Fix the include requirements for some file which miss sufficient #include directives. (Previously they include some headers by the long long long header include link) This is a breaking change. Previous code may depends on the long include chain. You may need to include the following headers for some files after this commit: - soc/soc.h - soc/soc_memory_layout.h - driver/gpio.h - esp_sleep.h The major broken include chain includes: 1. esp_system.h no longer includes esp_sleep.h. The latter includes driver/gpio.h and driver/touch_pad.h. 2. ets_sys.h no longer includes soc/soc.h 3. freertos/portmacro.h no longer includes soc/soc_memory_layout.h some peripheral headers no longer includes their hw related headers, e.g. rom/gpio.h no longer includes soc/gpio_pins.h and soc/gpio_reg.h BREAKING CHANGE
114 lines
5.0 KiB
CMake
114 lines
5.0 KiB
CMake
set(COMPONENT_ADD_INCLUDEDIRS "port/include" "mbedtls/include")
|
|
set(COMPONENT_SRCS "mbedtls.c")
|
|
set(COMPONENT_REQUIRES lwip)
|
|
|
|
set(MBEDTLS_PRIV_REQUIRES ${IDF_COMPONENT_REQUIRES_COMMON} soc)
|
|
|
|
register_component()
|
|
|
|
# Only build mbedtls libraries
|
|
set(ENABLE_TESTING CACHE BOOL OFF)
|
|
set(ENABLE_PROGRAMS CACHE BOOL OFF)
|
|
|
|
# Use same policy between IDF and mbedtls build
|
|
function(project)
|
|
set(_args ARGV)
|
|
_project(${${_args}})
|
|
cmake_policy(SET CMP0022 NEW)
|
|
endfunction()
|
|
|
|
# Needed to for include_next includes to work from within mbedtls
|
|
include_directories("${COMPONENT_PATH}/port/include")
|
|
|
|
# Workaround issue with creating symbolic links due to issues with native
|
|
# path conversion (TO_NATIVE_PATH). The following summarizes what CMake invocations
|
|
# this workaround is for:
|
|
#
|
|
# 1. CMake from command line + Ninja = No errors
|
|
# 2. CMake from command line + MinGW Makefiles = Forward slash for paths, mklink mistakes path for a switch
|
|
# 3. CMake from MSYS + Ninja = No errors
|
|
# 4. CMake from MSYS + Unix Makefiles/MSYS Makefiles = Forward slash for paths, mklink mistakes path for a switch
|
|
#
|
|
# There are references to the issue in case (2) and (4) in https://github.com/ARMmbed/mbedtls/issues/1496,
|
|
# https://cmake.org/pipermail/cmake/2006-July/010193.html, and https://cmake.org/Bug/view.php?id=5939.
|
|
#
|
|
# This workaround is meant to circumvent logic inside link_to_source() function in mbedtls/mbedtls/CMakeLists.txt.
|
|
if(CMAKE_HOST_WIN32)
|
|
set(msystem $ENV{MSYSTEM})
|
|
if(MSYS OR msystem)
|
|
# Solves case (4). When in MSYS environment, instead opt to use the Unix equivalent of mklink.
|
|
set(CMAKE_HOST_UNIX 1)
|
|
else()
|
|
# Solves case (2). When invoked from command line, create the symbolic links ahead of link_to_source() invocations
|
|
# using a 'hybrid' path format resilient intermediary - in this case a Python wrapper for mklink. This is more unweildy
|
|
# than necessary, since string(REPLACE "/" "\\" ... does not actually work.
|
|
set(target_links "mbedtls/include/mbedtls"
|
|
"mbedtls/scripts")
|
|
foreach(target_link ${target_links})
|
|
file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/${target_link} link)
|
|
file(TO_NATIVE_PATH ${COMPONENT_PATH}/${target_link} target)
|
|
|
|
if(NOT EXISTS ${link})
|
|
if (IS_DIRECTORY ${target})
|
|
set(command ${PYTHON} ${COMPONENT_PATH}/mklink.py /j ${link} ${target})
|
|
else()
|
|
set(command ${PYTHON} ${COMPONENT_PATH}/mklink.py /h ${link} ${target})
|
|
endif()
|
|
|
|
execute_process(COMMAND ${command}
|
|
RESULT_VARIABLE result
|
|
ERROR_VARIABLE output)
|
|
|
|
if (NOT ${result} EQUAL 0)
|
|
message(FATAL_ERROR "Could not create symbolic link for: ${target} --> ${output}")
|
|
endif()
|
|
endif()
|
|
endforeach()
|
|
endif()
|
|
endif()
|
|
|
|
# Import mbedtls library targets
|
|
add_subdirectory(mbedtls)
|
|
|
|
# Use port specific implementation of net_socket.c instead of one from mbedtls
|
|
get_target_property(src_tls mbedtls SOURCES)
|
|
list(REMOVE_ITEM src_tls net_sockets.c)
|
|
set_property(TARGET mbedtls PROPERTY SOURCES ${src_tls})
|
|
|
|
set(mbedtls_targets mbedtls mbedcrypto mbedx509)
|
|
|
|
# Add port files to mbedtls targets
|
|
target_sources(mbedtls PRIVATE "${COMPONENT_PATH}/port/esp_bignum.c"
|
|
"${COMPONENT_PATH}/port/esp_hardware.c"
|
|
"${COMPONENT_PATH}/port/esp_mem.c"
|
|
"${COMPONENT_PATH}/port/esp_sha1.c"
|
|
"${COMPONENT_PATH}/port/esp_sha256.c"
|
|
"${COMPONENT_PATH}/port/esp_sha512.c"
|
|
"${COMPONENT_PATH}/port/mbedtls_debug.c"
|
|
"${COMPONENT_PATH}/port/net_sockets.c"
|
|
"${COMPONENT_PATH}/port/esp32/aes.c"
|
|
"${COMPONENT_PATH}/port/esp32/sha.c")
|
|
|
|
foreach(target ${mbedtls_targets})
|
|
# Propagate compile options to mbedtls library targets
|
|
target_include_directories(${target} PRIVATE "${IDF_INCLUDE_DIRECTORIES}")
|
|
target_compile_options(${target} PRIVATE "${IDF_COMPILE_OPTIONS};${IDF_C_COMPILE_OPTIONS}")
|
|
target_compile_definitions(${target} PRIVATE "${IDF_COMPILE_DEFINITIONS}")
|
|
target_compile_definitions(${target} PUBLIC -DMBEDTLS_CONFIG_FILE="mbedtls/esp_config.h")
|
|
|
|
# The mbedtls targets also depends on core components
|
|
foreach(common ${MBEDTLS_PRIV_REQUIRES})
|
|
component_get_target(common_target ${common})
|
|
set_property(TARGET ${target} APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${common_target})
|
|
set_property(TARGET ${target} APPEND PROPERTY LINK_LIBRARIES ${common_target})
|
|
endforeach()
|
|
endforeach()
|
|
|
|
# Link mbedtls libraries to component library
|
|
target_link_libraries(${COMPONENT_TARGET} ${mbedtls_targets})
|
|
|
|
# Catch usage of deprecated mbedTLS functions when building tests
|
|
if(mbedtls_test IN_LIST BUILD_TEST_COMPONENTS)
|
|
add_definitions(-DMBEDTLS_DEPRECATED_WARNING)
|
|
endif()
|