include(crosstool_version_check)
+#
+# Set some variables used by rest of the build
+#
+# Note at the time this macro is expanded, the config is not yet
+# loaded and the toolchain and project are not yet set
+#
macro(idf_set_global_variables)
# Note that CONFIG_xxx is not available when this function is called
# Tell cmake to drop executables in the top-level build dir
set(EXECUTABLE_OUTPUT_PATH "${CMAKE_BINARY_DIR}")
- # cmake cross-toolchain doesn't include any gcc binutils names
- set(CMAKE_OBJCOPY xtensa-esp32-elf-objcopy)
-
# path to idf.py tool
set(IDFTOOL ${PYTHON} "${IDF_PATH}/tools/idf.py")
function(idf_verify_environment)
if(NOT CMAKE_PROJECT_NAME)
- message(FATAL_ERROR "Project top-level CMakeLists.txt file must call project() before including project.cmake")
+ message(FATAL_ERROR "Internal error, IDF project.cmake should have set this variable already")
endif()
# Check toolchain is configured properly in cmake
if(NOT ( ${CMAKE_SYSTEM_NAME} STREQUAL "Generic" AND ${CMAKE_C_COMPILER} MATCHES xtensa))
- message(FATAL_ERROR "Project top-level CMakeLists.txt file needs to set CMAKE_TOOLCHAIN_FILE "
- "before including project.cmake.\n"
- "Update CMakeLists.txt to match the template project and delete CMakeCache.txt before "
- "re-running cmake.")
+ message(FATAL_ERROR "Internal error, toolchain has not been set correctly by project")
endif()
#
# Warn if the toolchain version doesn't match
#
+ # TODO: make these platform-specific for diff toolchains
gcc_version_check("5.2.0")
crosstool_version_check("1.22.0-80-g6c4433a")
set_default(PYTHON "python")
-# Verify the environment is configured correctly
-idf_verify_environment()
+# project
+#
+# This macro wraps the cmake 'project' command to add
+# all of the IDF-specific functionality required
+#
+# Implementation Note: This macro wraps 'project' on purpose, because cmake has some
+# backwards-compatible magic where if you don't call "project" in the top-level
+# CMakeLists file, it will call it implicitly. However, the implict project will not
+# have CMAKE_TOOLCHAIN_FILE set and therefore tries to create a native build project.
+#
+# Therefore, to keep all the IDF "build magic", the cleanest way is to keep the
+# top-level "project" call but customize it to do what we want in the IDF build...
+#
+macro(project name)
+ # Set global variables used by rest of the build
+ idf_set_global_variables()
-# Set global variables used by rest of the build
-idf_set_global_variables()
+ # Search COMPONENT_DIRS for COMPONENTS, make a list of full paths to each component in COMPONENT_PATHS
+ components_find_all("${COMPONENT_DIRS}" "${COMPONENTS}" COMPONENT_PATHS COMPONENTS)
-# Search COMPONENT_DIRS for COMPONENTS, make a list of full paths to each component in COMPONENT_PATHS
-components_find_all("${COMPONENT_DIRS}" "${COMPONENTS}" COMPONENT_PATHS COMPONENTS)
+ kconfig_set_variables()
-kconfig_set_variables()
+ kconfig_process_config()
-kconfig_process_config()
+ # Include sdkconfig.cmake so rest of the build knows the configuration
+ include(${SDKCONFIG_CMAKE})
-# Include sdkconfig.cmake so rest of the build knows the configuration
-include(${SDKCONFIG_CMAKE})
+ # Now the configuration is loaded, set the toolchain appropriately
+ #
+ # TODO: support more toolchains than just ESP32
+ set(CMAKE_TOOLCHAIN_FILE $ENV{IDF_PATH}/tools/cmake/toolchain-esp32.cmake)
-# Add some idf-wide definitions
-idf_set_global_compiler_options()
+ # Declare the actual cmake-level project
+ _project(${name} ASM C CXX)
-# Check git version (may trigger reruns of cmake)
-# & set GIT_REVISION/IDF_VER variable
-git_describe(GIT_REVISION)
-add_definitions(-DIDF_VER=\"${GIT_REVISION}\")
-git_submodule_check("${IDF_PATH}")
+ # Verify the environment is configured correctly
+ idf_verify_environment()
-# Include any top-level project_include.cmake files from components
-foreach(component ${COMPONENT_PATHS})
- include_if_exists("${component}/project_include.cmake")
-endforeach()
+ # Add some idf-wide definitions
+ idf_set_global_compiler_options()
-#
-# Add each component to the build as a library
-#
-foreach(component ${COMPONENT_PATHS})
- get_filename_component(component_name ${component} NAME)
- add_subdirectory(${component} ${component_name})
-endforeach()
+ # Check git version (may trigger reruns of cmake)
+ # & set GIT_REVISION/IDF_VER variable
+ git_describe(GIT_REVISION)
+ add_definitions(-DIDF_VER=\"${GIT_REVISION}\")
+ git_submodule_check("${IDF_PATH}")
-#
-# Add the app executable to the build (has name of PROJECT.elf)
-#
-idf_add_executable()
+ # Include any top-level project_include.cmake files from components
+ foreach(component ${COMPONENT_PATHS})
+ include_if_exists("${component}/project_include.cmake")
+ endforeach()
-# Write project description JSON file
-configure_file("${CMAKE_CURRENT_LIST_DIR}/project_description.json.in"
- "${CMAKE_BINARY_DIR}/project_description.json")
+ #
+ # Add each component to the build as a library
+ #
+ foreach(component ${COMPONENT_PATHS})
+ get_filename_component(component_name ${component} NAME)
+ add_subdirectory(${component} ${component_name})
+ endforeach()
-#
-# Finish component registration (add cross-dependencies, make
-# executable dependent on all components)
-#
-components_finish_registration()
+ #
+ # Add the app executable to the build (has name of PROJECT.elf)
+ #
+ idf_add_executable()
+
+ # Write project description JSON file
+ configure_file("${IDF_PATH}/tools/cmake/project_description.json.in"
+ "${CMAKE_BINARY_DIR}/project_description.json")
+
+ #
+ # Finish component registration (add cross-dependencies, make
+ # executable dependent on all components)
+ #
+ components_finish_registration()
+
+endmacro(project)
projects / esp-idf / commitdiff