config/zephyr/chip-module/CMakeLists.txt - third_party/github/project-chip/connectedhomeip - Git at Google

 #
 #   Copyright (c) 2022 Project CHIP Authors
 #
 #   Licensed under the Apache License, Version 2.0 (the "License");
 #   you may not use this file except in compliance with the License.
 #   You may obtain a copy of the License at
 #
 #       http://www.apache.org/licenses/LICENSE-2.0
 #
 #   Unless required by applicable law or agreed to in writing, software
 #   distributed under the License is distributed on an "AS IS" BASIS,
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 #

 #
 #   @file
 #     CMake sub-project defining 'chip' target which represents CHIP library
 #     Since CHIP doesn't provide native CMake support, ExternalProject
 #     module is used to build the required artifacts with GN meta-build
 #     system. It is assumed that find_package(Zephyr) has been called before
 #     including this file.
 #

 if (CONFIG_CHIP)

 include(ExternalProject)
 include(../zephyr-util.cmake)

 # ==============================================================================
 # Declare configuration variables and define constants
 # ==============================================================================

 # C/C++ compiler flags passed to CHIP build system
 list(APPEND CHIP_CFLAGS)

 # C compiler flags passed to CHIP build system
 list(APPEND CHIP_CFLAGS_C)

 # C++ compiler flags passed to CHIP build system
 list(APPEND CHIP_CFLAGS_CC)

 # CHIP libraries that the application should be linked with
 list(APPEND CHIP_LIBRARIES)

 # GN meta-build system arguments in the form of 'key1 = value1\nkey2 = value2...' string
 string(APPEND CHIP_GN_ARGS)

 # C/C++ compiler flags which should not be forwarded to CHIP
 # build system (e.g. because CHIP configures them on its own)
 set(CHIP_CFLAG_EXCLUDES
     "-fno-asynchronous-unwind-tables"
     "-fno-common"
     "-fno-defer-pop"
     "-fno-reorder-functions"
     "-ffunction-sections"
     "-fdata-sections"
     "-g*"
     "-O*"
     "-W*"
 )

 # ==============================================================================
 # Helper macros
 # ==============================================================================

 macro(chip_gn_arg_import FILE)
     string(APPEND CHIP_GN_ARGS "import(\"${FILE}\")\n")
 endmacro()

 macro(chip_gn_arg_string ARG STRING)
     string(APPEND CHIP_GN_ARGS "${ARG} = \"${STRING}\"\n")
 endmacro()

 macro(chip_gn_arg_bool ARG BOOLEAN)
     if (${BOOLEAN})
         string(APPEND CHIP_GN_ARGS "${ARG} = true\n")
     else()
         string(APPEND CHIP_GN_ARGS "${ARG} = false\n")
     endif()
 endmacro()

 macro(chip_gn_arg_cflags ARG CFLAGS)
     set(CFLAG_EXCLUDES "[")
     foreach(cflag ${CHIP_CFLAG_EXCLUDES})
         string(APPEND CFLAG_EXCLUDES "\"${cflag}\", ")
     endforeach()
     string(APPEND CFLAG_EXCLUDES "]")
     string(APPEND CHIP_GN_ARGS "${ARG} = filter_exclude(string_split(\"${CFLAGS}\"), ${CFLAG_EXCLUDES})\n")
 endmacro()

 # ==============================================================================
 # Prepare CHIP configuration based on the project Kconfig configuration
 # ==============================================================================

 if (NOT CHIP_ROOT)
     get_filename_component(CHIP_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../.. REALPATH)
 endif()

 set(GN_ROOT_TARGET ${CHIP_ROOT}/config/zephyr/chip-gn)

 if (CONFIG_POSIX_API)
     list(APPEND CHIP_CFLAGS
         -D_SYS__PTHREADTYPES_H_
         -isystem${ZEPHYR_BASE}/include/zephyr/posix
     )
 endif()

 list(APPEND CHIP_CFLAGS -isystem${ZEPHYR_BASE}/../modules/crypto/mbedtls/include/)

 zephyr_get_compile_flags(CHIP_CFLAGS_C C)
 zephyr_get_compile_flags(CHIP_CFLAGS_CC CXX)
 zephyr_get_gnu_cpp_standard(CHIP_CFLAGS_CC)

 convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS CHIP_CFLAGS)
 convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS_C CHIP_CFLAGS_C)
 convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS_CC CHIP_CFLAGS_CC)

 # Prepare CHIP libraries that the application should be linked with

 if (NOT CHIP_LIBRARIES)
     set(CHIP_LIBRARIES -lCHIP)
 endif()

 if (CONFIG_CHIP_LIB_SHELL)
     list(APPEND CHIP_LIBRARIES -lCHIPShell)
 endif()

 if (CONFIG_CHIP_PW_RPC)
     list(APPEND CHIP_LIBRARIES -lPwRpc)
 endif()


 # Set up CHIP project configuration file

 if (CONFIG_CHIP_PROJECT_CONFIG)
     get_filename_component(CHIP_PROJECT_CONFIG
         ${CONFIG_CHIP_PROJECT_CONFIG}
         REALPATH
         BASE_DIR ${CMAKE_SOURCE_DIR}
     )
     set(CHIP_PROJECT_CONFIG "<${CHIP_PROJECT_CONFIG}>")
 else()
     set(CHIP_PROJECT_CONFIG "")
 endif()

 # Set up custom OpenThread configuration

 if (CONFIG_CHIP_OPENTHREAD_CONFIG)
     get_filename_component(CHIP_OPENTHREAD_CONFIG
         ${CONFIG_CHIP_OPENTHREAD_CONFIG}
         REALPATH
         BASE_DIR ${CMAKE_SOURCE_DIR}
     )
     zephyr_set_openthread_config(${CHIP_OPENTHREAD_CONFIG})
 endif()

 # Find required programs

 find_program(GN_EXECUTABLE gn)
 if (${GN_EXECUTABLE} STREQUAL GN_EXECUTABLE-NOTFOUND)
     message(FATAL_ERROR "The 'gn' command was not found. Make sure you have GN installed.")
 else()
     # Parse the 'gn --version' output to find the installed version.
     set(MIN_GN_VERSION 1000)
     execute_process(
         COMMAND
         ${GN_EXECUTABLE} --version
         OUTPUT_VARIABLE gn_version_output
         ERROR_VARIABLE  gn_error_output
         RESULT_VARIABLE gn_status
     )

     if(${gn_status} EQUAL 0)
         if(gn_version_output VERSION_LESS ${MIN_GN_VERSION})
             message(FATAL_ERROR "Found unsuitable version of 'gn'. Required is at least ${MIN_GN_VERSION}")
         endif()
     else()
         message(FATAL_ERROR "Could NOT find working gn: Found gn (${GN_EXECUTABLE}), but failed to load with:\n ${gn_error_output}")
     endif()
 endif()

 find_package(Python3 REQUIRED)

 # ==============================================================================
 # Generate configuration for CHIP GN build system
 # ==============================================================================
 chip_gn_arg_cflags("target_cflags"                          ${CHIP_CFLAGS})
 chip_gn_arg_cflags("target_cflags_c"                        ${CHIP_CFLAGS_C})
 chip_gn_arg_cflags("target_cflags_cc"                       ${CHIP_CFLAGS_CC})
 chip_gn_arg_string("zephyr_ar"                              ${CMAKE_AR})
 chip_gn_arg_string("zephyr_cc"                              ${CMAKE_C_COMPILER})
 chip_gn_arg_string("zephyr_cxx"                             ${CMAKE_CXX_COMPILER})
 chip_gn_arg_string("chip_project_config_include"            "${CHIP_PROJECT_CONFIG}")
 chip_gn_arg_string("chip_system_project_config_include"     "${CHIP_PROJECT_CONFIG}")
 chip_gn_arg_bool  ("is_debug"                               CONFIG_DEBUG)
 chip_gn_arg_bool  ("chip_enable_openthread"                 CONFIG_NET_L2_OPENTHREAD)
 chip_gn_arg_bool  ("chip_openthread_ftd"                    CONFIG_OPENTHREAD_FTD)
 chip_gn_arg_bool  ("chip_inet_config_enable_ipv4"           CONFIG_NET_IPV4)
 chip_gn_arg_bool  ("chip_build_tests"                       CONFIG_CHIP_BUILD_TESTS)
 chip_gn_arg_bool  ("chip_inet_config_enable_tcp_endpoint"   CONFIG_CHIP_BUILD_TESTS)
 chip_gn_arg_bool  ("chip_build_libshell"                    CONFIG_CHIP_LIB_SHELL)

 if (CONFIG_CHIP_ENABLE_DNSSD_SRP)
     chip_gn_arg_string("chip_mdns" "platform")
 endif()

 file(GENERATE OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/args.gn CONTENT ${CHIP_GN_ARGS})

 # ==============================================================================
 # Define 'chip-gn' target that builds CHIP library(ies) with GN build system
 # ==============================================================================

 ExternalProject_Add(
     chip-gn
     PREFIX                  ${CMAKE_CURRENT_BINARY_DIR}
     SOURCE_DIR              ${CHIP_ROOT}
     BINARY_DIR              ${CMAKE_CURRENT_BINARY_DIR}
     CONFIGURE_COMMAND       ${GN_EXECUTABLE}
                                 --root=${CHIP_ROOT}
                                 --root-target=${GN_ROOT_TARGET}
                                 --dotfile=${GN_ROOT_TARGET}/.gn
                                 --script-executable=${Python3_EXECUTABLE}
                                 gen --check --fail-on-unused-args ${CMAKE_CURRENT_BINARY_DIR}
     BUILD_COMMAND           ninja
     INSTALL_COMMAND         ""
     BUILD_BYPRODUCTS        ${CHIP_LIBRARIES}
     BUILD_ALWAYS            TRUE
     USES_TERMINAL_CONFIGURE TRUE
     USES_TERMINAL_BUILD     TRUE
 )
 add_dependencies(chip-gn kernel)

 # ==============================================================================
 # Define 'chip' target that exposes CHIP headers & libraries to the application
 # ==============================================================================

 zephyr_interface_library_named(chip)
 target_compile_definitions(chip INTERFACE CHIP_HAVE_CONFIG_H)
 target_include_directories(chip INTERFACE
     ${CHIP_ROOT}/src
     ${CHIP_ROOT}/src/include
     ${CHIP_ROOT}/src/lib
     ${CHIP_ROOT}/third_party/nlassert/repo/include
     ${CMAKE_CURRENT_BINARY_DIR}/gen/include
 )
 target_link_directories(chip INTERFACE ${CMAKE_CURRENT_BINARY_DIR}/lib)

 if (CONFIG_CHIP_LIB_SHELL)
     target_link_options(chip INTERFACE -Wl,--whole-archive -lCHIPShell -Wl,--no-whole-archive)
 endif()

 target_link_libraries(chip INTERFACE -Wl,--start-group ${CHIP_LIBRARIES} -Wl,--end-group)
 add_dependencies(chip chip-gn)

 endif() # CONFIG_CHIP
	#
	# Copyright (c) 2022 Project CHIP Authors
	#
	# Licensed under the Apache License, Version 2.0 (the "License");
	# you may not use this file except in compliance with the License.
	# You may obtain a copy of the License at
	#
	# http://www.apache.org/licenses/LICENSE-2.0
	#
	# Unless required by applicable law or agreed to in writing, software
	# distributed under the License is distributed on an "AS IS" BASIS,
	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	# See the License for the specific language governing permissions and
	# limitations under the License.
	#

	#
	# @file
	# CMake sub-project defining 'chip' target which represents CHIP library
	# Since CHIP doesn't provide native CMake support, ExternalProject
	# module is used to build the required artifacts with GN meta-build
	# system. It is assumed that find_package(Zephyr) has been called before
	# including this file.
	#

	if (CONFIG_CHIP)

	include(ExternalProject)
	include(../zephyr-util.cmake)

	# ==============================================================================
	# Declare configuration variables and define constants
	# ==============================================================================

	# C/C++ compiler flags passed to CHIP build system
	list(APPEND CHIP_CFLAGS)

	# C compiler flags passed to CHIP build system
	list(APPEND CHIP_CFLAGS_C)

	# C++ compiler flags passed to CHIP build system
	list(APPEND CHIP_CFLAGS_CC)

	# CHIP libraries that the application should be linked with
	list(APPEND CHIP_LIBRARIES)

	# GN meta-build system arguments in the form of 'key1 = value1\nkey2 = value2...' string
	string(APPEND CHIP_GN_ARGS)

	# C/C++ compiler flags which should not be forwarded to CHIP
	# build system (e.g. because CHIP configures them on its own)
	set(CHIP_CFLAG_EXCLUDES
	"-fno-asynchronous-unwind-tables"
	"-fno-common"
	"-fno-defer-pop"
	"-fno-reorder-functions"
	"-ffunction-sections"
	"-fdata-sections"
	"-g*"
	"-O*"
	"-W*"
	)

	# ==============================================================================
	# Helper macros
	# ==============================================================================

	macro(chip_gn_arg_import FILE)
	string(APPEND CHIP_GN_ARGS "import(\"${FILE}\")\n")
	endmacro()

	macro(chip_gn_arg_string ARG STRING)
	string(APPEND CHIP_GN_ARGS "${ARG} = \"${STRING}\"\n")
	endmacro()

	macro(chip_gn_arg_bool ARG BOOLEAN)
	if (${BOOLEAN})
	string(APPEND CHIP_GN_ARGS "${ARG} = true\n")
	else()
	string(APPEND CHIP_GN_ARGS "${ARG} = false\n")
	endif()
	endmacro()

	macro(chip_gn_arg_cflags ARG CFLAGS)
	set(CFLAG_EXCLUDES "[")
	foreach(cflag ${CHIP_CFLAG_EXCLUDES})
	string(APPEND CFLAG_EXCLUDES "\"${cflag}\", ")
	endforeach()
	string(APPEND CFLAG_EXCLUDES "]")
	string(APPEND CHIP_GN_ARGS "${ARG} = filter_exclude(string_split(\"${CFLAGS}\"), ${CFLAG_EXCLUDES})\n")
	endmacro()

	# ==============================================================================
	# Prepare CHIP configuration based on the project Kconfig configuration
	# ==============================================================================

	if (NOT CHIP_ROOT)
	get_filename_component(CHIP_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../.. REALPATH)
	endif()

	set(GN_ROOT_TARGET ${CHIP_ROOT}/config/zephyr/chip-gn)

	if (CONFIG_POSIX_API)
	list(APPEND CHIP_CFLAGS
	-D_SYS__PTHREADTYPES_H_
	-isystem${ZEPHYR_BASE}/include/zephyr/posix
	)
	endif()

	list(APPEND CHIP_CFLAGS -isystem${ZEPHYR_BASE}/../modules/crypto/mbedtls/include/)

	zephyr_get_compile_flags(CHIP_CFLAGS_C C)
	zephyr_get_compile_flags(CHIP_CFLAGS_CC CXX)
	zephyr_get_gnu_cpp_standard(CHIP_CFLAGS_CC)

	convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS CHIP_CFLAGS)
	convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS_C CHIP_CFLAGS_C)
	convert_list_of_flags_to_string_of_flags(CHIP_CFLAGS_CC CHIP_CFLAGS_CC)

	# Prepare CHIP libraries that the application should be linked with

	if (NOT CHIP_LIBRARIES)
	set(CHIP_LIBRARIES -lCHIP)
	endif()

	if (CONFIG_CHIP_LIB_SHELL)
	list(APPEND CHIP_LIBRARIES -lCHIPShell)
	endif()

	if (CONFIG_CHIP_PW_RPC)
	list(APPEND CHIP_LIBRARIES -lPwRpc)
	endif()


	# Set up CHIP project configuration file

	if (CONFIG_CHIP_PROJECT_CONFIG)
	get_filename_component(CHIP_PROJECT_CONFIG
	${CONFIG_CHIP_PROJECT_CONFIG}
	REALPATH
	BASE_DIR ${CMAKE_SOURCE_DIR}
	)
	set(CHIP_PROJECT_CONFIG "<${CHIP_PROJECT_CONFIG}>")
	else()
	set(CHIP_PROJECT_CONFIG "")
	endif()

	# Set up custom OpenThread configuration

	if (CONFIG_CHIP_OPENTHREAD_CONFIG)
	get_filename_component(CHIP_OPENTHREAD_CONFIG
	${CONFIG_CHIP_OPENTHREAD_CONFIG}
	REALPATH
	BASE_DIR ${CMAKE_SOURCE_DIR}
	)
	zephyr_set_openthread_config(${CHIP_OPENTHREAD_CONFIG})
	endif()

	# Find required programs

	find_program(GN_EXECUTABLE gn)
	if (${GN_EXECUTABLE} STREQUAL GN_EXECUTABLE-NOTFOUND)
	message(FATAL_ERROR "The 'gn' command was not found. Make sure you have GN installed.")
	else()
	# Parse the 'gn --version' output to find the installed version.
	set(MIN_GN_VERSION 1000)
	execute_process(
	COMMAND
	${GN_EXECUTABLE} --version
	OUTPUT_VARIABLE gn_version_output
	ERROR_VARIABLE gn_error_output
	RESULT_VARIABLE gn_status
	)

	if(${gn_status} EQUAL 0)
	if(gn_version_output VERSION_LESS ${MIN_GN_VERSION})
	message(FATAL_ERROR "Found unsuitable version of 'gn'. Required is at least ${MIN_GN_VERSION}")
	endif()
	else()
	message(FATAL_ERROR "Could NOT find working gn: Found gn (${GN_EXECUTABLE}), but failed to load with:\n ${gn_error_output}")
	endif()
	endif()

	find_package(Python3 REQUIRED)

	# ==============================================================================
	# Generate configuration for CHIP GN build system
	# ==============================================================================
	chip_gn_arg_cflags("target_cflags" ${CHIP_CFLAGS})
	chip_gn_arg_cflags("target_cflags_c" ${CHIP_CFLAGS_C})
	chip_gn_arg_cflags("target_cflags_cc" ${CHIP_CFLAGS_CC})
	chip_gn_arg_string("zephyr_ar" ${CMAKE_AR})
	chip_gn_arg_string("zephyr_cc" ${CMAKE_C_COMPILER})
	chip_gn_arg_string("zephyr_cxx" ${CMAKE_CXX_COMPILER})
	chip_gn_arg_string("chip_project_config_include" "${CHIP_PROJECT_CONFIG}")
	chip_gn_arg_string("chip_system_project_config_include" "${CHIP_PROJECT_CONFIG}")
	chip_gn_arg_bool ("is_debug" CONFIG_DEBUG)
	chip_gn_arg_bool ("chip_enable_openthread" CONFIG_NET_L2_OPENTHREAD)
	chip_gn_arg_bool ("chip_openthread_ftd" CONFIG_OPENTHREAD_FTD)
	chip_gn_arg_bool ("chip_inet_config_enable_ipv4" CONFIG_NET_IPV4)
	chip_gn_arg_bool ("chip_build_tests" CONFIG_CHIP_BUILD_TESTS)
	chip_gn_arg_bool ("chip_inet_config_enable_tcp_endpoint" CONFIG_CHIP_BUILD_TESTS)
	chip_gn_arg_bool ("chip_build_libshell" CONFIG_CHIP_LIB_SHELL)

	if (CONFIG_CHIP_ENABLE_DNSSD_SRP)
	chip_gn_arg_string("chip_mdns" "platform")
	endif()

	file(GENERATE OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/args.gn CONTENT ${CHIP_GN_ARGS})

	# ==============================================================================
	# Define 'chip-gn' target that builds CHIP library(ies) with GN build system
	# ==============================================================================

	ExternalProject_Add(
	chip-gn
	PREFIX ${CMAKE_CURRENT_BINARY_DIR}
	SOURCE_DIR ${CHIP_ROOT}
	BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}
	CONFIGURE_COMMAND ${GN_EXECUTABLE}
	--root=${CHIP_ROOT}
	--root-target=${GN_ROOT_TARGET}
	--dotfile=${GN_ROOT_TARGET}/.gn
	--script-executable=${Python3_EXECUTABLE}
	gen --check --fail-on-unused-args ${CMAKE_CURRENT_BINARY_DIR}
	BUILD_COMMAND ninja
	INSTALL_COMMAND ""
	BUILD_BYPRODUCTS ${CHIP_LIBRARIES}
	BUILD_ALWAYS TRUE
	USES_TERMINAL_CONFIGURE TRUE
	USES_TERMINAL_BUILD TRUE
	)
	add_dependencies(chip-gn kernel)

	# ==============================================================================
	# Define 'chip' target that exposes CHIP headers & libraries to the application
	# ==============================================================================

	zephyr_interface_library_named(chip)
	target_compile_definitions(chip INTERFACE CHIP_HAVE_CONFIG_H)
	target_include_directories(chip INTERFACE
	${CHIP_ROOT}/src
	${CHIP_ROOT}/src/include
	${CHIP_ROOT}/src/lib
	${CHIP_ROOT}/third_party/nlassert/repo/include
	${CMAKE_CURRENT_BINARY_DIR}/gen/include
	)
	target_link_directories(chip INTERFACE ${CMAKE_CURRENT_BINARY_DIR}/lib)

	if (CONFIG_CHIP_LIB_SHELL)
	target_link_options(chip INTERFACE -Wl,--whole-archive -lCHIPShell -Wl,--no-whole-archive)
	endif()

	target_link_libraries(chip INTERFACE -Wl,--start-group ${CHIP_LIBRARIES} -Wl,--end-group)
	add_dependencies(chip chip-gn)

	endif() # CONFIG_CHIP