blob: 3e632da1c0726108c713ca0f02e8db331bbeec2e [file] [log] [blame]
Raef Coles9ec67e62020-07-10 09:40:35 +01001#-------------------------------------------------------------------------------
Raef Coles88ff7992024-01-11 10:27:05 +00002# Copyright (c) 2020-2024, Arm Limited. All rights reserved.
Chris Brand4b381f82022-12-01 16:30:23 -08003# Copyright (c) 2022 Cypress Semiconductor Corporation (an Infineon company)
4# or an affiliate of Cypress Semiconductor Corporation. All rights reserved.
Raef Coles9ec67e62020-07-10 09:40:35 +01005#
6# SPDX-License-Identifier: BSD-3-Clause
7#
8#-------------------------------------------------------------------------------
David Hu1249f0d2023-12-04 22:57:56 +08009cmake_minimum_required(VERSION 3.21)
Raef Coles9ec67e62020-07-10 09:40:35 +010010
Raef Coles9ec67e62020-07-10 09:40:35 +010011SET(CMAKE_SYSTEM_NAME Generic)
Raef Coles9ec67e62020-07-10 09:40:35 +010012
13set(CMAKE_C_COMPILER armclang)
Rajkumar Kanagarajcd831592022-05-04 11:44:03 +020014set(CMAKE_CXX_COMPILER armclang)
Raef Coles69817322020-10-19 14:14:14 +010015set(CMAKE_ASM_COMPILER armasm)
Raef Coles9ec67e62020-07-10 09:40:35 +010016
17set(LINKER_VENEER_OUTPUT_FLAG --import_cmse_lib_out=)
Raef Coles69817322020-10-19 14:14:14 +010018set(COMPILER_CMSE_FLAG $<$<COMPILE_LANGUAGE:C>:-mcmse>)
Raef Coles9ec67e62020-07-10 09:40:35 +010019
20# This variable name is a bit of a misnomer. The file it is set to is included
21# at a particular step in the compiler initialisation. It is used here to
22# configure the extensions for object files. Despite the name, it also works
23# with the Ninja generator.
24set(CMAKE_USER_MAKE_RULES_OVERRIDE ${CMAKE_CURRENT_LIST_DIR}/cmake/set_extensions.cmake)
25
Dávid Házi50c18282024-10-10 12:37:28 +000026# CMAKE_C_COMPILER_VERSION is not guaranteed to be defined.
27EXECUTE_PROCESS( COMMAND ${CMAKE_C_COMPILER} --version OUTPUT_VARIABLE ARMCLANG_VERSION )
28string(REGEX MATCH "([0-9]+\.[0-9]+)" ARMCLANG_VERSION "${ARMCLANG_VERSION}")
29set(ARMCLANG_VERSION ${CMAKE_MATCH_1})
30
Raef Coles6d987ba2023-07-24 12:06:15 +010031if(NOT DEFINED CMAKE_OBJCOPY)
32 set(CMAKE_OBJCOPY ${CROSS_COMPILE}-objcopy CACHE FILEPATH "Path to objcopy")
33endif()
34
Dávid Házi50c18282024-10-10 12:37:28 +000035if (DEFINED TFM_SYSTEM_PROCESSOR)
36 set(CMAKE_SYSTEM_PROCESSOR ${TFM_SYSTEM_PROCESSOR})
Raef Coles69817322020-10-19 14:14:14 +010037
Dávid Házi50c18282024-10-10 12:37:28 +000038 if (TFM_SYSTEM_ARCHITECTURE STREQUAL "armv8.1-m.main")
39 message(WARNING "MVE is not yet supported using ARMCLANG")
40 string(APPEND CMAKE_SYSTEM_PROCESSOR "+nomve")
41 endif()
42
43 if (DEFINED TFM_SYSTEM_DSP)
44 if(NOT TFM_SYSTEM_DSP)
45 string(APPEND CMAKE_SYSTEM_PROCESSOR "+nodsp")
46 endif()
47 endif()
48
49 # ARMCLANG specifies that '+nofp' is available on following M-profile cpus:
50 # 'cortex-m4', 'cortex-m7', 'cortex-m33', 'cortex-m35p', 'cortex-m55' and 'cortex-m85'.
51 # Build fails if other M-profile cpu, such as 'cortex-m23', is added with '+nofp'.
52 # Explicitly list those cpu to align with ARMCLANG description.
53 if (NOT CONFIG_TFM_FLOAT_ABI STREQUAL "hard" AND
54 (TFM_SYSTEM_PROCESSOR STREQUAL "cortex-m4"
55 OR TFM_SYSTEM_PROCESSOR STREQUAL "cortex-m7"
56 OR TFM_SYSTEM_PROCESSOR STREQUAL "cortex-m33"
57 OR TFM_SYSTEM_PROCESSOR STREQUAL "cortex-m35p"
58 OR TFM_SYSTEM_PROCESSOR STREQUAL "cortex-m55"
59 OR TFM_SYSTEM_PROCESSOR STREQUAL "cortex-m85"))
60 string(APPEND CMAKE_SYSTEM_PROCESSOR "+nofp")
61 endif()
62
63 string(REGEX REPLACE "\\+nodsp" ".no_dsp" CMAKE_ASM_CPU_FLAG "${CMAKE_SYSTEM_PROCESSOR}")
64 string(REGEX REPLACE "\\+nomve" ".no_mve" CMAKE_ASM_CPU_FLAG "${CMAKE_ASM_CPU_FLAG}")
65 string(REGEX REPLACE "\\+nofp" ".no_fp" CMAKE_ASM_CPU_FLAG "${CMAKE_ASM_CPU_FLAG}")
66else()
67 set(CMAKE_ASM_CPU_FLAG ${TFM_SYSTEM_ARCHITECTURE})
68
69 # Armasm uses different syntax than armclang for architecture targets
70 string(REGEX REPLACE "\\armv" "" CMAKE_ASM_CPU_FLAG "${CMAKE_ASM_CPU_FLAG}")
71 string(REGEX REPLACE "\\armv" "" CMAKE_ASM_CPU_FLAG "${CMAKE_ASM_CPU_FLAG}")
72
73 # Modifiers are additive instead of subtractive (.fp Vs .no_fp)
74 if (TFM_SYSTEM_DSP)
75 string(APPEND CMAKE_ASM_CPU_FLAG ".dsp")
76 endif()
77
78 if (CONFIG_TFM_FLOAT_ABI STREQUAL "hard")
79 string(APPEND CMAKE_ASM_CPU_FLAG ".fp")
80 endif()
81endif()
82
83# CMAKE_SYSTEM_ARCH is an ARMCLANG CMAKE internal variable, used to set
84# compile and linker flags up until CMake 3.21 where CMP0123 was introduced:
85# https://cmake.org/cmake/help/latest/policy/CMP0123.html
86# Another use of this variable is to statisfy a requirement for ARMCLANG to
87# set either the target CPU or the Architecture. This variable needs to be
88# set to allow targeting architectures without a specific CPU.
89set(CMAKE_SYSTEM_ARCH ${TFM_SYSTEM_ARCHITECTURE})
90
91set(CMAKE_C_COMPILER_TARGET arm-${CROSS_COMPILE})
92set(CMAKE_CXX_COMPILER_TARGET arm-${CROSS_COMPILE})
93set(CMAKE_ASM_COMPILER_TARGET arm-${CROSS_COMPILE})
94
95# MVE is currently not supported in case of armclang
96if (TFM_SYSTEM_ARCHITECTURE STREQUAL "armv8.1-m.main")
97 string(APPEND CMAKE_SYSTEM_ARCH "+nomve")
98endif()
99
100if (DEFINED TFM_SYSTEM_DSP)
101 if(NOT TFM_SYSTEM_DSP)
102 string(APPEND CMAKE_SYSTEM_ARCH "+nodsp")
103 endif()
104endif()
105
106# Cmake's ARMClang support has several issues with compiler validation. To
107# avoid these, we set the list of supported -mcpu and -march variables to
108# the ones we intend to use so that the validation will never fail.
109include(Compiler/ARMClang)
110set(CMAKE_C_COMPILER_PROCESSOR_LIST ${CMAKE_SYSTEM_PROCESSOR})
111set(CMAKE_C_COMPILER_ARCH_LIST ${CMAKE_SYSTEM_ARCH})
112set(CMAKE_CXX_COMPILER_PROCESSOR_LIST ${CMAKE_SYSTEM_PROCESSOR})
113set(CMAKE_CXX_COMPILER_ARCH_LIST ${CMAKE_SYSTEM_ARCH})
114set(CMAKE_ASM_COMPILER_PROCESSOR_LIST ${CMAKE_SYSTEM_PROCESSOR})
115set(CMAKE_ASM_COMPILER_ARCH_LIST ${CMAKE_SYSTEM_ARCH})
116
117add_compile_options(
118 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-Wno-ignored-optimization-argument>
119 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-Wno-unused-command-line-argument>
120 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-Wall>
121 # Don't error when the MBEDTLS_NULL_ENTROPY warning is shown
122 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-Wno-error=cpp>
123 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-c>
124 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-fdata-sections>
125 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-ffunction-sections>
126 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-fno-builtin>
127 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-fshort-enums>
128 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-fshort-wchar>
129 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-funsigned-char>
130 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-masm=auto>
131 $<$<OR:$<COMPILE_LANGUAGE:C>,$<COMPILE_LANGUAGE:CXX>>:-nostdlib>
132 $<$<COMPILE_LANGUAGE:C>:-std=c99>
133 $<$<COMPILE_LANGUAGE:CXX>:-std=c++11>
134 $<$<COMPILE_LANGUAGE:ASM>:--cpu=${CMAKE_ASM_CPU_FLAG}>
135 $<$<AND:$<COMPILE_LANGUAGE:C>,$<BOOL:${TFM_DEBUG_SYMBOLS}>>:-g>
136 $<$<AND:$<COMPILE_LANGUAGE:CXX>,$<BOOL:${TFM_DEBUG_SYMBOLS}>>:-g>
137)
138
139add_link_options(
140 ${MEMORY_USAGE_FLAG}
141 --strict
142 --symbols
143 --xref
144 $<$<AND:$<VERSION_GREATER:${TFM_ISOLATION_LEVEL},1>,$<STREQUAL:"${TEST_PSA_API}","IPC">>:--no-merge>
145 # Suppress link warnings that are consistant (and therefore hopefully
146 # harmless)
147 # https://developer.arm.com/documentation/100074/0608/linker-errors-and-warnings/list-of-the-armlink-error-and-warning-messages
148 # Empty region description
149 --diag_suppress=6312
150 # Ns section matches pattern
151 --diag_suppress=6314
152 # Duplicate input files
153 --diag_suppress=6304
154 # Pattern only matches removed unused sections.
155 --diag_suppress=6329
156)
Raef Coles69817322020-10-19 14:14:14 +0100157
Kevin Pengc32279d2022-02-10 11:11:55 +0800158if(CONFIG_TFM_MEMORY_USAGE_QUIET)
Jimmy Brisson1f9b7c82021-12-14 10:53:36 -0600159 set(MEMORY_USAGE_FLAG "")
160else()
161 set(MEMORY_USAGE_FLAG --info=summarysizes,sizes,totals,unused,veneers)
162endif()
163
Dávid Házi50c18282024-10-10 12:37:28 +0000164if (ARMCLANG_VERSION VERSION_LESS 6.13)
165 message(FATAL_ERROR "Please select newer Arm compiler version starting from 6.13.")
166endif()
Raef Coles69817322020-10-19 14:14:14 +0100167
Dávid Házi50c18282024-10-10 12:37:28 +0000168if (ARMCLANG_VERSION VERSION_GREATER_EQUAL 6.15 AND
169 ARMCLANG_VERSION VERSION_LESS 6.18)
170 message(FATAL_ERROR "Armclang 6.15~6.17 may cause MemManage fault."
171 " This defect has been fixed since Armclang 6.18."
172 " See [SDCOMP-59788] in Armclang 6.18 release note for details."
173 " Please use other Armclang versions instead.")
174endif()
175
176if (CMAKE_SYSTEM_PROCESSOR)
177 set(CMAKE_C_FLAGS "-mcpu=${CMAKE_SYSTEM_PROCESSOR}")
178 set(CMAKE_CXX_FLAGS "-mcpu=${CMAKE_SYSTEM_PROCESSOR}")
179 set(CMAKE_C_LINK_FLAGS "--cpu=${CMAKE_SYSTEM_PROCESSOR}")
180 set(CMAKE_CXX_LINK_FLAGS "--cpu=${CMAKE_SYSTEM_PROCESSOR}")
181 set(CMAKE_ASM_LINK_FLAGS "--cpu=${CMAKE_SYSTEM_PROCESSOR}")
182 # But armlink doesn't support this +dsp syntax
183 string(REGEX REPLACE "\\+nodsp" "" CMAKE_C_LINK_FLAGS "${CMAKE_C_LINK_FLAGS}")
184 string(REGEX REPLACE "\\+nodsp" "" CMAKE_CXX_LINK_FLAGS "${CMAKE_CXX_LINK_FLAGS}")
185 string(REGEX REPLACE "\\+nodsp" "" CMAKE_ASM_LINK_FLAGS "${CMAKE_ASM_LINK_FLAGS}")
186 # And uses different syntax for +nofp
187 string(REGEX REPLACE "\\+nofp" ".no_fp" CMAKE_C_LINK_FLAGS "${CMAKE_C_LINK_FLAGS}")
188 string(REGEX REPLACE "\\+nofp" ".no_fp" CMAKE_CXX_LINK_FLAGS "${CMAKE_CXX_LINK_FLAGS}")
189 string(REGEX REPLACE "\\+nofp" ".no_fp" CMAKE_ASM_LINK_FLAGS "${CMAKE_ASM_LINK_FLAGS}")
190
191 string(REGEX REPLACE "\\+nomve" ".no_mve" CMAKE_C_LINK_FLAGS "${CMAKE_C_LINK_FLAGS}")
192 string(REGEX REPLACE "\\+nomve" ".no_mve" CMAKE_CXX_LINK_FLAGS "${CMAKE_CXX_LINK_FLAGS}")
193 string(REGEX REPLACE "\\+nomve" ".no_mve" CMAKE_ASM_LINK_FLAGS "${CMAKE_ASM_LINK_FLAGS}")
194else()
195 set(CMAKE_C_FLAGS "-march=${CMAKE_SYSTEM_ARCH}")
196 set(CMAKE_CXX_FLAGS "-march=${CMAKE_SYSTEM_ARCH}")
197endif()
198
199set(CMAKE_ASM_FLAGS ${CMAKE_ASM_FLAGS_INIT})
200
201set(BL2_COMPILER_CP_FLAG
202 $<$<COMPILE_LANGUAGE:C>:-mfpu=softvfp>
203 $<$<COMPILE_LANGUAGE:ASM>:--fpu=softvfp>
204)
205# As BL2 does not use hardware FPU, specify '--fpu=SoftVFP' explicitly to use software
206# library functions for BL2 to override any implicit FPU option, such as '--cpu' option.
207# Because the implicit hardware FPU option enforces BL2 to initialize FPU but hardware FPU
208# is not actually enabled in BL2, it will cause BL2 runtime fault.
209set(BL2_LINKER_CP_OPTION --fpu=SoftVFP)
210
211set(BL1_COMPILER_CP_FLAG
212 $<$<COMPILE_LANGUAGE:C>:-mfpu=softvfp>
213 $<$<COMPILE_LANGUAGE:ASM>:--fpu=softvfp>
214)
215set(BL1_LINKER_CP_OPTION --fpu=SoftVFP)
216
217if (CONFIG_TFM_FLOAT_ABI STREQUAL "hard")
218 set(COMPILER_CP_FLAG
219 $<$<COMPILE_LANGUAGE:C>:-mfloat-abi=hard>
Raef Coles9ec67e62020-07-10 09:40:35 +0100220 )
Dávid Házi50c18282024-10-10 12:37:28 +0000221 if (CONFIG_TFM_ENABLE_FP)
222 set(COMPILER_CP_FLAG
223 $<$<COMPILE_LANGUAGE:C>:-mfpu=${CONFIG_TFM_FP_ARCH};-mfloat-abi=hard>
224 $<$<COMPILE_LANGUAGE:ASM>:--fpu=${CONFIG_TFM_FP_ARCH_ASM}>
225 )
226 # armasm and armlink have the same option "--fpu" and are both used to
227 # specify the target FPU architecture. So the supported FPU architecture
228 # names can be shared by armasm and armlink.
229 set(LINKER_CP_OPTION --fpu=${CONFIG_TFM_FP_ARCH_ASM})
Gabor Abonyi866571c2021-10-07 13:56:19 +0200230 endif()
Dávid Házi50c18282024-10-10 12:37:28 +0000231else()
232 set(COMPILER_CP_FLAG
chesun01a94a9c72023-02-14 16:19:51 +0800233 $<$<COMPILE_LANGUAGE:C>:-mfpu=softvfp>
234 $<$<COMPILE_LANGUAGE:ASM>:--fpu=softvfp>
235 )
Dávid Házi50c18282024-10-10 12:37:28 +0000236 set(LINKER_CP_OPTION --fpu=SoftVFP)
237endif()
chesun01ea11c822022-12-15 15:53:05 +0800238
Dávid Házi50c18282024-10-10 12:37:28 +0000239# Workaround for issues with --depend-single-line with armasm and Ninja
240if (CMAKE_GENERATOR STREQUAL "Ninja")
241 set( CMAKE_DEPFILE_FLAGS_ASM "--depend=<OBJECT>.d")
242endif()
Dávid Házi5575f922024-04-15 21:14:11 +0200243
Dávid Házi50c18282024-10-10 12:37:28 +0000244set(CMAKE_C_FLAGS_MINSIZEREL "-Oz -DNDEBUG")
245
246#
247# Pointer Authentication Code and Branch Target Identification (PACBTI) Options
248#
249if (${CONFIG_TFM_BRANCH_PROTECTION_FEAT} STREQUAL BRANCH_PROTECTION_NONE)
250 set(BRANCH_PROTECTION_OPTIONS "none")
251elseif(${CONFIG_TFM_BRANCH_PROTECTION_FEAT} STREQUAL BRANCH_PROTECTION_STANDARD)
252 set(BRANCH_PROTECTION_OPTIONS "standard")
253elseif(${CONFIG_TFM_BRANCH_PROTECTION_FEAT} STREQUAL BRANCH_PROTECTION_PACRET)
254 set(BRANCH_PROTECTION_OPTIONS "pac-ret")
255elseif(${CONFIG_TFM_BRANCH_PROTECTION_FEAT} STREQUAL BRANCH_PROTECTION_PACRET_LEAF)
256 set(BRANCH_PROTECTION_OPTIONS "pac-ret+leaf")
257elseif(${CONFIG_TFM_BRANCH_PROTECTION_FEAT} STREQUAL BRANCH_PROTECTION_BTI)
258 set(BRANCH_PROTECTION_OPTIONS "bti")
259endif()
260
261if(NOT ${CONFIG_TFM_BRANCH_PROTECTION_FEAT} STREQUAL BRANCH_PROTECTION_DISABLED)
262 if(ARMCLANG_VERSION VERSION_LESS 6.18)
263 message(FATAL_ERROR "Your compiler does not support BRANCH_PROTECTION")
chesun01ea11c822022-12-15 15:53:05 +0800264 else()
Dávid Házi50c18282024-10-10 12:37:28 +0000265 if((TFM_SYSTEM_PROCESSOR MATCHES "cortex-m85") AND
266 (TFM_SYSTEM_ARCHITECTURE STREQUAL "armv8.1-m.main"))
267 message(NOTICE "BRANCH_PROTECTION enabled with: ${BRANCH_PROTECTION_OPTIONS}")
chesun01ea11c822022-12-15 15:53:05 +0800268
Dávid Házi50c18282024-10-10 12:37:28 +0000269 string(APPEND CMAKE_C_FLAGS " -mbranch-protection=${BRANCH_PROTECTION_OPTIONS}")
270 string(APPEND CMAKE_CXX_FLAGS " -mbranch-protection=${BRANCH_PROTECTION_OPTIONS}")
Raef Colesd29c7f72020-11-05 14:12:06 +0000271
Dávid Házi50c18282024-10-10 12:37:28 +0000272 add_link_options(--library_security=pacbti-m)
Nicola Mazzucatofc1bf772024-05-07 16:21:33 +0100273 else()
Dávid Házi50c18282024-10-10 12:37:28 +0000274 message(FATAL_ERROR "Your architecture does not support BRANCH_PROTECTION")
Nicola Mazzucatofc1bf772024-05-07 16:21:33 +0100275 endif()
276 endif()
Dávid Házi50c18282024-10-10 12:37:28 +0000277endif()
Raef Coles69817322020-10-19 14:14:14 +0100278
Raef Coles9ec67e62020-07-10 09:40:35 +0100279# Behaviour for handling scatter files is so wildly divergent between compilers
280# that this macro is required.
281macro(target_add_scatter_file target)
282 target_link_options(${target}
283 PRIVATE
284 --scatter=$<TARGET_OBJECTS:${target}_scatter>
285 )
286
Raef Coles9ec67e62020-07-10 09:40:35 +0100287 add_library(${target}_scatter OBJECT)
288 foreach(scatter_file ${ARGN})
289 target_sources(${target}_scatter
290 PRIVATE
291 ${scatter_file}
292 )
293 # Cmake cannot use generator expressions in the
294 # set_source_file_properties command, so instead we just parse the regex
295 # for the filename and set the property on all files, regardless of if
296 # the generator expression would evaluate to true or not.
297 string(REGEX REPLACE ".*>:(.*)>$" "\\1" SCATTER_FILE_PATH "${scatter_file}")
298 set_source_files_properties(${SCATTER_FILE_PATH}
299 PROPERTIES
300 LANGUAGE C
Anton Komlev04cac672024-07-23 17:11:59 +0100301 KEEP_EXTENSION True # Don't use .o extension for the preprocessed file
Raef Coles9ec67e62020-07-10 09:40:35 +0100302 )
303 endforeach()
304
Anton Komlev1a103552022-02-11 15:40:26 +0000305 add_dependencies(${target}
306 ${target}_scatter
307 )
308
Anubhav Raina8a5d3b12024-07-10 18:15:57 +0100309 set_property(TARGET ${target} APPEND PROPERTY LINK_DEPENDS $<TARGET_OBJECTS:${target}_scatter>)
Anton Komlev1a103552022-02-11 15:40:26 +0000310
Raef Coles9ec67e62020-07-10 09:40:35 +0100311 target_link_libraries(${target}_scatter
312 platform_region_defs
313 psa_interface
Xinyu Zhangeeb19ac2023-06-19 18:09:20 +0800314 tfm_config
Raef Coles9ec67e62020-07-10 09:40:35 +0100315 )
316
317 target_compile_options(${target}_scatter
318 PRIVATE
319 -E
320 -xc
321 )
Anton Komlev04cac672024-07-23 17:11:59 +0100322
323 # Scatter file shall be preprocessed by manifest tool in isolation level 2,3
324 add_dependencies(${target}_scatter
325 manifest_tool
326 )
Raef Coles9ec67e62020-07-10 09:40:35 +0100327endmacro()
328
329macro(add_convert_to_bin_target target)
330 get_target_property(bin_dir ${target} RUNTIME_OUTPUT_DIRECTORY)
331
332 add_custom_target(${target}_bin
333 SOURCES ${bin_dir}/${target}.bin
334 )
335 add_custom_command(OUTPUT ${bin_dir}/${target}.bin
336 DEPENDS ${target}
337 COMMAND fromelf
338 --bincombined $<TARGET_FILE:${target}>
339 --output=${bin_dir}/${target}.bin
340 )
341
342 add_custom_target(${target}_elf
343 SOURCES ${bin_dir}/${target}.elf
344 )
345 add_custom_command(OUTPUT ${bin_dir}/${target}.elf
346 DEPENDS ${target}
347 COMMAND fromelf
348 --elf $<TARGET_FILE:${target}>
349 --output=${bin_dir}/${target}.elf
350 )
351
352 add_custom_target(${target}_hex
353 SOURCES ${bin_dir}/${target}.hex
354 )
355 add_custom_command(OUTPUT ${bin_dir}/${target}.hex
356 DEPENDS ${target}
357 COMMAND fromelf
358 --i32combined $<TARGET_FILE:${target}>
359 --output=${bin_dir}/${target}.hex
360 )
361
362 add_custom_target(${target}_binaries
363 ALL
364 DEPENDS ${target}_bin
365 DEPENDS ${target}_elf
366 DEPENDS ${target}_hex
367 )
368endmacro()
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000369
Anubhav Raina54c359a2023-12-07 14:09:06 +0000370macro(target_share_symbols target)
Raef Coles4351ec22021-04-26 09:20:50 +0100371 get_target_property(TARGET_TYPE ${target} TYPE)
372 if (NOT TARGET_TYPE STREQUAL "EXECUTABLE")
373 message(FATAL_ERROR "${target} is not an executable. Symbols cannot be shared from libraries.")
374 endif()
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000375
Bence Balogh027b6ba2024-04-09 16:34:06 +0200376 foreach(symbol_file ${ARGN})
Anubhav Raina54c359a2023-12-07 14:09:06 +0000377 FILE(STRINGS ${symbol_file} SYMBOLS
378 LENGTH_MINIMUM 1
379 )
380 list(APPEND KEEP_SYMBOL_LIST ${SYMBOLS})
381 endforeach()
382
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000383
Anubhav Raina053923e2024-07-11 11:57:49 +0100384 # strip all the symbols except those provided as arguments. Long inline
Raef Coles4351ec22021-04-26 09:20:50 +0100385 # python scripts aren't ideal, but this is both portable and possibly easier
386 # to maintain than trying to filter files at build time in cmake.
Anubhav Raina053923e2024-07-11 11:57:49 +0100387 add_custom_target(${target}_shared_symbols
Raef Coles4351ec22021-04-26 09:20:50 +0100388 VERBATIM
Anubhav Raina053923e2024-07-11 11:57:49 +0100389 COMMAND python3
390 -c "from sys import argv; import re; f = open(argv[1], 'rt'); p = [x.replace('*', '.*') for x in argv[2:]]; l = [x for x in f.readlines() if re.search(r'(?=('+'$|'.join(p + ['SYMDEFS']) + r'))', x)]; f.close(); f = open(argv[1], 'wt'); f.writelines(l); f.close();"
391 $<TARGET_FILE_DIR:${target}>/${target}${CODE_SHARING_OUTPUT_FILE_SUFFIX}
392 ${KEEP_SYMBOL_LIST}
393 )
394
395 # Ensure ${target} is build before $<TARGET_FILE:${target}> is used to generate ${target}_shared_symbols
396 add_dependencies(${target}_shared_symbols ${target})
397 # Allow the global clean target to rm the ${target}_shared_symbols created
398 set_target_properties(${target}_shared_symbols PROPERTIES
399 ADDITIONAL_CLEAN_FILES $<TARGET_FILE_DIR:${target}>/${target}${CODE_SHARING_OUTPUT_FILE_SUFFIX}
400 )
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000401
Raef Coles08b0c5c2023-05-03 11:56:28 +0100402 # Force the target to not remove the symbols if they're unused.
403 list(TRANSFORM KEEP_SYMBOL_LIST PREPEND --undefined=)
Raef Coles4351ec22021-04-26 09:20:50 +0100404 target_link_options(${target}
405 PRIVATE
406 ${KEEP_SYMBOL_LIST}
Bence Balogh52198b02024-06-20 15:50:12 +0200407 # This is needed because the symbol file can contain functions
408 # that are not defined in every build configuration.
409 # The L6474E is:
410 # "Symbol referenced by --undefined or --undefined_and_export
411 # switch could not be resolved by a static library."
412 --diag_warning 6474
Raef Coles4351ec22021-04-26 09:20:50 +0100413 )
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000414
Anubhav Raina053923e2024-07-11 11:57:49 +0100415 # Ask armclang to produce a symdefs file
Raef Coles4351ec22021-04-26 09:20:50 +0100416 target_link_options(${target}
417 PRIVATE
Raef Coles88ff7992024-01-11 10:27:05 +0000418 --symdefs=$<TARGET_FILE_DIR:${target}>/${target}${CODE_SHARING_OUTPUT_FILE_SUFFIX}
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000419 )
420endmacro()
421
Raef Coles4351ec22021-04-26 09:20:50 +0100422macro(target_link_shared_code target)
423 get_target_property(TARGET_SOURCE_DIR ${target} SOURCE_DIR)
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000424
Raef Coles4351ec22021-04-26 09:20:50 +0100425 foreach(symbol_provider ${ARGN})
426 if (TARGET ${symbol_provider})
427 get_target_property(SYMBOL_PROVIDER_TYPE ${symbol_provider} TYPE)
428 if (NOT SYMBOL_PROVIDER_TYPE STREQUAL "EXECUTABLE")
429 message(FATAL_ERROR "${symbol_provider} is not an executable. Symbols cannot be shared from libraries.")
430 endif()
431 endif()
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000432
Anubhav Raina053923e2024-07-11 11:57:49 +0100433 # Ensure ${symbol_provider}_shared_symbols is built before ${target}
434 add_dependencies(${target} ${symbol_provider}_shared_symbols)
435 # ${symbol_provider}_shared_symbols - a custom target is always considered out-of-date
436 # To only link when necessary, depend on ${symbol_provider} instead
437 set_property(TARGET ${target} APPEND PROPERTY LINK_DEPENDS $<TARGET_OBJECTS:${symbol_provider}>)
Dávid Házif7ef8f02024-02-20 22:04:53 +0100438 target_link_options(${target} PRIVATE LINKER:$<TARGET_FILE_DIR:${symbol_provider}>/${symbol_provider}${CODE_SHARING_INPUT_FILE_SUFFIX})
Raef Coles4351ec22021-04-26 09:20:50 +0100439 endforeach()
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000440endmacro()
441
Raef Coles4351ec22021-04-26 09:20:50 +0100442macro(target_strip_symbols target)
443 set(SYMBOL_LIST "${ARGN}")
444 list(TRANSFORM SYMBOL_LIST PREPEND --strip-symbol=)
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000445
Raef Coles4351ec22021-04-26 09:20:50 +0100446 # TODO we assume that arm-none-eabi-objcopy is available - since we're using
447 # armclang this isn't necessarily true.
448 add_custom_command(
449 TARGET ${target}
450 POST_BUILD
Raef Coles6d987ba2023-07-24 12:06:15 +0100451 COMMAND ${CMAKE_OBJCOPY}
Raef Coles4351ec22021-04-26 09:20:50 +0100452 ARGS $<TARGET_FILE:${target}> --wildcard ${SYMBOL_LIST} $<TARGET_FILE:${target}>
453 )
454endmacro()
455
456macro(target_strip_symbols_from_dependency target dependency)
457 set(SYMBOL_LIST "${ARGN}")
458 list(TRANSFORM SYMBOL_LIST PREPEND --strip-symbol=)
459
460 # TODO we assume that arm-none-eabi-objcopy is available - since we're using
461 # armclang this isn't necessarily true.
462 add_custom_command(
463 TARGET ${target}
464 PRE_LINK
Raef Coles6d987ba2023-07-24 12:06:15 +0100465 COMMAND ${CMAKE_OBJCOPY}
Raef Coles4351ec22021-04-26 09:20:50 +0100466 ARGS $<TARGET_FILE:${dependency}> --wildcard ${SYMBOL_LIST} $<TARGET_FILE:${dependency}>
467 )
468endmacro()
469
470macro(target_weaken_symbols target)
471 set(SYMBOL_LIST "${ARGN}")
472 list(TRANSFORM SYMBOL_LIST PREPEND --weaken-symbol=)
473
474 # TODO we assume that arm-none-eabi-objcopy is available - since we're using
475 # armclang this isn't necessarily true.
476 add_custom_command(
477 TARGET ${target}
478 POST_BUILD
Raef Coles6d987ba2023-07-24 12:06:15 +0100479 COMMAND ${CMAKE_OBJCOPY}
Raef Coles4351ec22021-04-26 09:20:50 +0100480 ARGS $<TARGET_FILE:${target}> --wildcard ${SYMBOL_LIST} $<TARGET_FILE:${target}>
481 )
482endmacro()
483
484macro(target_weaken_symbols_from_dependency target dependency)
485 set(SYMBOL_LIST "${ARGN}")
486 list(TRANSFORM SYMBOL_LIST PREPEND --weaken-symbol=)
487
488 # TODO we assume that arm-none-eabi-objcopy is available - since we're using
489 # armclang this isn't necessarily true.
490 add_custom_command(
491 TARGET ${target}
492 PRE_LINK
Raef Coles6d987ba2023-07-24 12:06:15 +0100493 COMMAND ${CMAKE_OBJCOPY}
Raef Coles4351ec22021-04-26 09:20:50 +0100494 ARGS $<TARGET_FILE:${dependency}> --wildcard ${SYMBOL_LIST} $<TARGET_FILE:${dependency}>
Tamas Banf8b0b2d2020-10-26 13:03:13 +0000495 )
496endmacro()