Torsten Rasmussen | 8100717 | 2020-02-12 14:55:36 +0100 | [diff] [blame] | 1 | # SPDX-License-Identifier: Apache-2.0 |
| 2 | |
| 3 | # This file provides Zephyr Config Package functionality. |
| 4 | # |
| 5 | # The purpose of this files is to allow users to decide if they want to: |
| 6 | # - Use ZEPHYR_BASE environment setting for explicitly set select a zephyr installation |
| 7 | # - Support automatic Zephyr installation lookup through the use of find_package(ZEPHYR) |
| 8 | |
| 9 | # First check to see if user has provided a Zephyr base manually. |
| 10 | # Set Zephyr base to environment setting. |
| 11 | # It will be empty if not set in environment. |
Torsten Rasmussen | 8100717 | 2020-02-12 14:55:36 +0100 | [diff] [blame] | 12 | |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 13 | macro(include_boilerplate location) |
Torsten Rasmussen | 0a64b08 | 2022-03-01 09:40:17 +0100 | [diff] [blame] | 14 | set(Zephyr_DIR ${ZEPHYR_BASE}/share/zephyr-package/cmake CACHE PATH |
| 15 | "The directory containing a CMake configuration file for Zephyr." FORCE |
| 16 | ) |
Torsten Rasmussen | 61453e4 | 2021-12-16 17:13:54 +0100 | [diff] [blame] | 17 | list(PREPEND CMAKE_MODULE_PATH ${ZEPHYR_BASE}/cmake/modules) |
Torsten Rasmussen | 8829e82 | 2020-02-26 14:28:09 +0100 | [diff] [blame] | 18 | if(ZEPHYR_UNITTEST) |
Torsten Rasmussen | e4ccde3 | 2021-12-17 11:43:54 +0100 | [diff] [blame] | 19 | message(WARNING "The ZephyrUnittest CMake package has been deprecated.\n" |
| 20 | "ZephyrUnittest has been replaced with Zephyr CMake module 'unittest' \n" |
| 21 | "and can be loaded as: 'find_package(Zephyr COMPONENTS unittest)'" |
| 22 | ) |
Torsten Rasmussen | 8829e82 | 2020-02-26 14:28:09 +0100 | [diff] [blame] | 23 | set(ZephyrUnittest_FOUND True) |
Torsten Rasmussen | e4ccde3 | 2021-12-17 11:43:54 +0100 | [diff] [blame] | 24 | set(Zephyr_FIND_COMPONENTS unittest) |
Torsten Rasmussen | 8829e82 | 2020-02-26 14:28:09 +0100 | [diff] [blame] | 25 | else() |
| 26 | set(Zephyr_FOUND True) |
Torsten Rasmussen | 8829e82 | 2020-02-26 14:28:09 +0100 | [diff] [blame] | 27 | endif() |
| 28 | |
Torsten Rasmussen | 61453e4 | 2021-12-16 17:13:54 +0100 | [diff] [blame] | 29 | if(NOT DEFINED APPLICATION_SOURCE_DIR) |
| 30 | set(APPLICATION_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR} CACHE PATH |
| 31 | "Application Source Directory" |
| 32 | ) |
| 33 | endif() |
| 34 | |
| 35 | if(NOT DEFINED APPLICATION_BINARY_DIR) |
| 36 | set(APPLICATION_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE PATH |
| 37 | "Application Binary Directory" |
| 38 | ) |
| 39 | endif() |
| 40 | |
| 41 | set(__build_dir ${APPLICATION_BINARY_DIR}/zephyr) |
| 42 | set(PROJECT_BINARY_DIR ${__build_dir}) |
| 43 | |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 44 | if(NOT NO_BOILERPLATE) |
Torsten Rasmussen | 61453e4 | 2021-12-16 17:13:54 +0100 | [diff] [blame] | 45 | list(LENGTH Zephyr_FIND_COMPONENTS components_length) |
Jordan Yates | 568fb35 | 2022-02-21 17:22:37 +1000 | [diff] [blame] | 46 | # The module messages are intentionally higher than STATUS to avoid the -- prefix |
| 47 | # and make them more visible to users. This does result in them being output |
| 48 | # to stderr, but that is an implementation detail of cmake. |
Torsten Rasmussen | e4ccde3 | 2021-12-17 11:43:54 +0100 | [diff] [blame] | 49 | if(components_length EQUAL 0) |
Jordan Yates | 568fb35 | 2022-02-21 17:22:37 +1000 | [diff] [blame] | 50 | message(NOTICE "Loading Zephyr default modules (${location}).") |
Torsten Rasmussen | 61453e4 | 2021-12-16 17:13:54 +0100 | [diff] [blame] | 51 | include(zephyr_default NO_POLICY_SCOPE) |
| 52 | else() |
Jordan Yates | 568fb35 | 2022-02-21 17:22:37 +1000 | [diff] [blame] | 53 | message(NOTICE "Loading Zephyr module(s) (${location}): ${Zephyr_FIND_COMPONENTS}") |
Torsten Rasmussen | 61453e4 | 2021-12-16 17:13:54 +0100 | [diff] [blame] | 54 | foreach(component ${Zephyr_FIND_COMPONENTS}) |
Torsten Rasmussen | 31e90f1 | 2022-02-03 12:10:53 +0100 | [diff] [blame] | 55 | if(${component} MATCHES "^\([^:]*\):\(.*\)$") |
| 56 | string(REPLACE "," ";" SUB_COMPONENTS ${CMAKE_MATCH_2}) |
| 57 | set(component ${CMAKE_MATCH_1}) |
| 58 | endif() |
Torsten Rasmussen | 61453e4 | 2021-12-16 17:13:54 +0100 | [diff] [blame] | 59 | include(${component}) |
| 60 | endforeach() |
| 61 | endif() |
| 62 | else() |
| 63 | message(WARNING "The NO_BOILERPLATE setting has been deprecated.\n" |
| 64 | "Please use: 'find_package(Zephyr COMPONENTS <components>)'" |
| 65 | ) |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 66 | endif() |
| 67 | endmacro() |
| 68 | |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 69 | set(ENV_ZEPHYR_BASE $ENV{ZEPHYR_BASE}) |
| 70 | if((NOT DEFINED ZEPHYR_BASE) AND (DEFINED ENV_ZEPHYR_BASE)) |
Torsten Rasmussen | 8100717 | 2020-02-12 14:55:36 +0100 | [diff] [blame] | 71 | # Get rid of any double folder string before comparison, as example, user provides |
| 72 | # ZEPHYR_BASE=//path/to//zephyr_base/ |
| 73 | # must also work. |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 74 | get_filename_component(ZEPHYR_BASE ${ENV_ZEPHYR_BASE} ABSOLUTE) |
| 75 | set(ZEPHYR_BASE ${ZEPHYR_BASE} CACHE PATH "Zephyr base") |
| 76 | include_boilerplate("Zephyr base") |
| 77 | return() |
| 78 | endif() |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 79 | |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 80 | if (DEFINED ZEPHYR_BASE) |
| 81 | include_boilerplate("Zephyr base (cached)") |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 82 | return() |
Torsten Rasmussen | 8100717 | 2020-02-12 14:55:36 +0100 | [diff] [blame] | 83 | endif() |
| 84 | |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 85 | # If ZEPHYR_CANDIDATE is set, it means this file was include instead of called via find_package directly. |
| 86 | if(ZEPHYR_CANDIDATE) |
| 87 | set(IS_INCLUDED TRUE) |
Torsten Rasmussen | 8e929fd | 2020-03-09 15:26:21 +0100 | [diff] [blame] | 88 | else() |
| 89 | include(${CMAKE_CURRENT_LIST_DIR}/zephyr_package_search.cmake) |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 90 | endif() |
| 91 | |
| 92 | # Find out the current Zephyr base. |
| 93 | get_filename_component(CURRENT_ZEPHYR_DIR ${CMAKE_CURRENT_LIST_FILE}/${ZEPHYR_RELATIVE_DIR} ABSOLUTE) |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 94 | get_filename_component(CURRENT_WORKSPACE_DIR ${CMAKE_CURRENT_LIST_FILE}/${WORKSPACE_RELATIVE_DIR} ABSOLUTE) |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 95 | |
| 96 | string(FIND "${CMAKE_CURRENT_SOURCE_DIR}" "${CURRENT_ZEPHYR_DIR}/" COMMON_INDEX) |
| 97 | if (COMMON_INDEX EQUAL 0) |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 98 | # Project is in Zephyr repository. |
| 99 | # We are in Zephyr repository. |
| 100 | set(ZEPHYR_BASE ${CURRENT_ZEPHYR_DIR} CACHE PATH "Zephyr base") |
| 101 | include_boilerplate("Zephyr repository") |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 102 | return() |
| 103 | endif() |
| 104 | |
| 105 | if(IS_INCLUDED) |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 106 | # A higher level did the checking and included us and as we are not in Zephyr repository |
| 107 | # (checked above) then we must be in Zephyr workspace. |
| 108 | set(ZEPHYR_BASE ${CURRENT_ZEPHYR_DIR} CACHE PATH "Zephyr base") |
| 109 | include_boilerplate("Zephyr workspace") |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 110 | endif() |
| 111 | |
| 112 | if(NOT IS_INCLUDED) |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 113 | string(FIND "${CMAKE_CURRENT_SOURCE_DIR}" "${CURRENT_WORKSPACE_DIR}/" COMMON_INDEX) |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 114 | if (COMMON_INDEX EQUAL 0) |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 115 | # Project is in Zephyr workspace. |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 116 | # This means this Zephyr is likely the correct one, but there could be an alternative installed along-side |
| 117 | # Thus, check if there is an even better candidate. |
| 118 | # This check works the following way. |
| 119 | # CMake finds packages will look all packages registered in the user package registry. |
| 120 | # As this code is processed inside registered packages, we simply test if another package has a |
Nazar Kazakov | 9713f0d | 2022-02-24 12:00:55 +0000 | [diff] [blame] | 121 | # common path with the current sample. |
| 122 | # and if so, we will return here, and let CMake call into the other registered package for real |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 123 | # version checking. |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 124 | check_zephyr_package(CURRENT_WORKSPACE_DIR ${CURRENT_WORKSPACE_DIR}) |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 125 | |
Torsten Rasmussen | 8e929fd | 2020-03-09 15:26:21 +0100 | [diff] [blame] | 126 | if(ZEPHYR_PREFER) |
| 127 | check_zephyr_package(SEARCH_PARENTS CANDIDATES_PREFERENCE_LIST ${ZEPHYR_PREFER}) |
| 128 | endif() |
| 129 | |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 130 | # We are the best candidate, so let's include boiler plate. |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 131 | set(ZEPHYR_BASE ${CURRENT_ZEPHYR_DIR} CACHE PATH "Zephyr base") |
| 132 | include_boilerplate("Zephyr workspace") |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 133 | return() |
| 134 | endif() |
| 135 | |
Torsten Rasmussen | 8e929fd | 2020-03-09 15:26:21 +0100 | [diff] [blame] | 136 | check_zephyr_package(SEARCH_PARENTS CANDIDATES_PREFERENCE_LIST ${ZEPHYR_PREFER}) |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 137 | |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 138 | # Ending here means there were no candidates in workspace of the app. |
| 139 | # Thus, the app is built as a Zephyr Freestanding application. |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 140 | # CMake find_package has already done the version checking, so let's just include boiler plate. |
| 141 | # Previous find_package would have cleared Zephyr_FOUND variable, thus set it again. |
Torsten Rasmussen | caf596e | 2020-03-04 12:34:44 +0100 | [diff] [blame] | 142 | set(ZEPHYR_BASE ${CURRENT_ZEPHYR_DIR} CACHE PATH "Zephyr base") |
| 143 | include_boilerplate("Freestanding") |
Torsten Rasmussen | 555eb9b | 2020-02-18 14:06:44 +0100 | [diff] [blame] | 144 | endif() |