1# 2# Copyright (c) 2023-2024, Arm Limited and Contributors. All rights reserved. 3# 4# SPDX-License-Identifier: BSD-3-Clause 5# 6 7# 8# TF-A uses three toolchains: 9# 10# - The host toolchain (`host`) for building native tools 11# - The AArch32 toolchain (`aarch32`) for building Arm AArch32 images 12# - The AArch64 toolchain (`aarch64`) for building Arm AArch64 images 13# 14# In the main Makefile only one of the two Arm toolchains is enabled in any 15# given build, but individual tools and libraries may need access to both. 16# 17 18ifndef toolchain-mk 19 toolchain-mk := $(lastword $(MAKEFILE_LIST)) 20 21 include $(dir $(toolchain-mk))build_env.mk 22 include $(dir $(toolchain-mk))utilities.mk 23 24 # 25 # Make assigns generic default values to `CC`, `CPP`, `AS`, etc. if they 26 # are not explicitly assigned values by the user. These are usually okay 27 # for very simple programs when building for the host system, but we 28 # need greater control over the toolchain flow. 29 # 30 # Therefore, we undefine these built-in variables if they have default 31 # values, so that we can provide our own default values later instead. 32 # 33 34 ifeq ($(origin CC),default) 35 undefine CC 36 endif 37 38 ifeq ($(origin CPP),default) 39 undefine CPP 40 endif 41 42 ifeq ($(origin AS),default) 43 undefine AS 44 endif 45 46 ifeq ($(origin AR),default) 47 undefine AR 48 endif 49 50 ifeq ($(origin LD),default) 51 undefine LD 52 endif 53 54 # 55 # The full list of toolchains supported by TF-A. 56 # 57 # Each of these toolchains defines a file of the same name in the 58 # `toolchains` directory, which must configure the following variables: 59 # 60 # - <toolchain>-name 61 # 62 # A human-readable name for the toolchain, 63 # 64 # Additionally, for every tool class, it must also define: 65 # 66 # - <toolchain>-<tool-class>-parameter 67 # 68 # The command line or environment variable used to set the tool for 69 # for the given tool class. 70 # 71 # - <toolchain>-<tool-class>-default 72 # 73 # The default command to use for the given tool class if the user 74 # does not explicitly provide one, and if the command could not be 75 # derived from the C compiler. 76 # 77 # - <toolchain>-<tool-class>-id-default 78 # 79 # The default tool identifier used if the tool for the given tool 80 # class cannot be identified. 81 # 82 83 toolchains := host # Used for host targets 84 toolchains += aarch32 # Used for AArch32 targets 85 toolchains += aarch64 # Used for AArch64 targets 86 toolchains += rk3399-m0 # Used for RK3399 Cortex-M0 targets 87 88 include $(toolchains:%=$(dir $(toolchain-mk))toolchains/%.mk) 89 90 # 91 # Configure tool classes that we recognize. 92 # 93 # In the context of this build system, a tool class identifies a 94 # specific role or type of tool in the toolchain. 95 # 96 97 toolchain-tool-classes := cc 98 toolchain-tool-class-name-cc := C compiler 99 100 toolchain-tool-classes += cpp 101 toolchain-tool-class-name-cpp := C preprocessor 102 103 toolchain-tool-classes += as 104 toolchain-tool-class-name-as := assembler 105 106 toolchain-tool-classes += ld 107 toolchain-tool-class-name-ld := linker 108 109 toolchain-tool-classes += oc 110 toolchain-tool-class-name-oc := object copier 111 112 toolchain-tool-classes += od 113 toolchain-tool-class-name-od := object dumper 114 115 toolchain-tool-classes += ar 116 toolchain-tool-class-name-ar := archiver 117 118 toolchain-tool-classes += dtc 119 toolchain-tool-class-name-dtc := device tree compiler 120 121 # 122 # Configure tools that we recognize. 123 # 124 # Here we declare the list of specific toolchain tools that we know how 125 # to interact with. We don't organize these into tool classes yet - that 126 # happens further down. 127 # 128 129 # Arm® Compiler for Embedded 130 toolchain-tools := arm-clang 131 toolchain-tool-name-arm-clang := Arm® Compiler for Embedded `armclang` 132 133 toolchain-tools += arm-link 134 toolchain-tool-name-arm-link := Arm® Compiler for Embedded `armlink` 135 136 toolchain-tools += arm-ar 137 toolchain-tool-name-arm-ar := Arm® Compiler for Embedded `armar` 138 139 toolchain-tools += arm-fromelf 140 toolchain-tool-name-arm-fromelf := Arm® Compiler for Embedded `fromelf` 141 142 # LLVM Project 143 toolchain-tools += llvm-clang 144 toolchain-tool-name-llvm-clang := LLVM Clang (`clang`) 145 146 toolchain-tools += llvm-lld 147 toolchain-tool-name-llvm-lld := LLVM LLD (`lld`) 148 149 toolchain-tools += llvm-objcopy 150 toolchain-tool-name-llvm-objcopy := LLVM `llvm-objcopy` 151 152 toolchain-tools += llvm-objdump 153 toolchain-tool-name-llvm-objdump := LLVM `llvm-objdump` 154 155 toolchain-tools += llvm-ar 156 toolchain-tool-name-llvm-ar := LLVM `llvm-ar` 157 158 # GNU Compiler Collection & GNU Binary Utilities 159 toolchain-tools += gnu-gcc 160 toolchain-tool-name-gnu-gcc := GNU GCC (`gcc`) 161 162 toolchain-tools += gnu-ld 163 toolchain-tool-name-gnu-ld := GNU LD (`ld.bfd`) 164 165 toolchain-tools += gnu-objcopy 166 toolchain-tool-name-gnu-objcopy := GNU `objcopy` 167 168 toolchain-tools += gnu-objdump 169 toolchain-tool-name-gnu-objdump := GNU `objdump` 170 171 toolchain-tools += gnu-ar 172 toolchain-tool-name-gnu-ar := GNU `ar` 173 174 # Other tools 175 toolchain-tools += generic-dtc 176 toolchain-tool-name-generic-dtc := Device Tree Compiler (`dtc`) 177 178 # 179 # Assign tools to tool classes. 180 # 181 # Multifunctional tools, i.e. tools which can perform multiple roles in 182 # a toolchain, may be specified in multiple tool class lists. For 183 # example, a C compiler which can also perform the role of a linker may 184 # be placed in both `toolchain-tools-cc` and `toolchain-tools-ld`. 185 # 186 187 # C-related tools 188 toolchain-tools-cc := arm-clang llvm-clang gnu-gcc # C compilers 189 toolchain-tools-cpp := arm-clang llvm-clang gnu-gcc # C preprocessors 190 191 # Assembly-related tools 192 toolchain-tools-as := arm-clang llvm-clang gnu-gcc # Assemblers 193 194 # Linking and object-handling tools 195 toolchain-tools-ld := arm-clang arm-link llvm-clang llvm-lld gnu-gcc gnu-ld # Linkers 196 toolchain-tools-oc := arm-fromelf llvm-objcopy gnu-objcopy # Object copiers 197 toolchain-tools-od := arm-fromelf llvm-objdump gnu-objdump # Object dumpers 198 toolchain-tools-ar := arm-ar llvm-ar gnu-ar # Archivers 199 200 # Other tools 201 toolchain-tools-dtc := generic-dtc # Device tree compilers 202 203 # 204 # Helper functions to identify toolchain tools. 205 # 206 # The functions defined in this section return a tool identifier when 207 # given a path to a binary. We generally check a help or version string 208 # to more reliably identify tools than by looking at the path alone 209 # (e.g. `gcc` on macOS is actually Apple Clang). 210 # 211 # Each tool-guessing function (`toolchain-guess-tool-$(tool)`) takes a 212 # single argument giving the path to the tool to guess, and returns a 213 # non-empty value if the tool corresponds to the tool identifier 214 # `$(tool)`: 215 # 216 # $(call toolchain-guess-tool-llvm-clang,aarch64-none-elf-gcc) # <empty> 217 # $(call toolchain-guess-tool-gnu-gcc,aarch64-none-elf-gcc) # <non-empty> 218 # 219 # The `toolchain-guess-tool` function tries to find the corresponding tool 220 # identifier for a tool given its path. It takes two arguments: 221 # 222 # - $(1): a list of candidate tool identifiers to check 223 # - $(2): the path to the tool to identify 224 # 225 # If any of the guess functions corresponding to candidate tool 226 # identifiers return a non-empty value then the tool identifier of the 227 # first function to do so is returned: 228 # 229 # $(call toolchain-guess-tool,gnu-gcc llvm-clang,armclang) # <empty> 230 # $(call toolchain-guess-tool,gnu-gcc llvm-clang,clang-14) # llvm-clang 231 # $(call toolchain-guess-tool,gnu-gcc llvm-clang,aarch64-none-elf-gcc-12) # gnu-gcc 232 # 233 # Tools are checked in the order that they are provided, and the first 234 # match is returned. 235 # 236 237 # Arm Compiler for Embedded 238 toolchain-guess-tool-arm-clang = $(shell $(1) --version 2>&1 <$(nul) | grep -o "Tool: armclang") 239 toolchain-guess-tool-arm-link = $(shell $(1) --help 2>&1 <$(nul) | grep -o "Tool: armlink") 240 toolchain-guess-tool-arm-fromelf = $(shell $(1) --help 2>&1 <$(nul) | grep -o "Tool: fromelf") 241 toolchain-guess-tool-arm-ar = $(shell $(1) --version 2>&1 <$(nul) | grep -o "Tool: armar") 242 243 # LLVM Project 244 toolchain-guess-tool-llvm-clang = $(shell $(1) -v 2>&1 <$(nul) | grep -o "clang version") 245 toolchain-guess-tool-llvm-lld = $(shell $(1) --help 2>&1 <$(nul) | grep -o "OVERVIEW: lld") 246 toolchain-guess-tool-llvm-objcopy = $(shell $(1) --help 2>&1 <$(nul) | grep -o "llvm-objcopy tool") 247 toolchain-guess-tool-llvm-objdump = $(shell $(1) --help 2>&1 <$(nul) | grep -o "llvm object file dumper") 248 toolchain-guess-tool-llvm-ar = $(shell $(1) --help 2>&1 <$(nul) | grep -o "LLVM Archiver") 249 250 # GNU Compiler Collection & GNU Binary Utilities 251 toolchain-guess-tool-gnu-gcc = $(shell $(1) -v 2>&1 <$(nul) | grep -o "gcc version") 252 toolchain-guess-tool-gnu-ld = $(shell $(1) -v 2>&1 <$(nul) | grep -o "GNU ld") 253 toolchain-guess-tool-gnu-objcopy = $(shell $(1) --version 2>&1 <$(nul) | grep -o "GNU objcopy") 254 toolchain-guess-tool-gnu-objdump = $(shell $(1) --version 2>&1 <$(nul) | grep -o "GNU objdump") 255 toolchain-guess-tool-gnu-ar = $(shell $(1) --version 2>&1 <$(nul) | grep -o "GNU ar") 256 257 # Other tools 258 toolchain-guess-tool-generic-dtc = $(shell $(1) --version 2>&1 <$(nul) | grep -o "Version: DTC") 259 260 toolchain-guess-tool = $(firstword $(foreach candidate,$(1), \ 261 $(if $(call toolchain-guess-tool-$(candidate),$(2)),$(candidate)))) 262 263 # 264 # Warn the user that a tool could not be identified. 265 # 266 # Parameters: 267 # 268 # - $1: The toolchain that the tool belongs to. 269 # - $2: The tool class that the tool belongs to. 270 # 271 272 define toolchain-warn-unrecognized 273 $(warning ) 274 $(warning The configured $($(1)-name) $(toolchain-tool-class-name-$(2)) could not be identified and may not be supported:) 275 $(warning ) 276 $(warning $(space) $($(1)-$(2))$(if $($(1)-$(2)-parameter), (via `$($(1)-$(2)-parameter)`))) 277 $(warning ) 278 $(warning The default $($(1)-name) $(toolchain-tool-class-name-$(2)) is:) 279 $(warning ) 280 $(warning $(space) $($(1)-$(2)-default)) 281 $(warning ) 282 $(warning The following tools are supported:) 283 $(warning ) 284 285 $(foreach tool,$(toolchain-tools-$(2)), \ 286 $(warning $(space) - $(toolchain-tool-name-$(tool)))) 287 288 $(warning ) 289 $(warning The build system will treat this $(toolchain-tool-class-name-$(2)) as $(toolchain-tool-name-$($(1)-$(2)-id-default)).) 290 $(warning ) 291 endef 292 293 # 294 # Locate and identify tools belonging to each toolchain. 295 # 296 # Each tool class in each toolchain receives a variable of the form 297 # `$(toolchain)-$(tool)` giving the associated path to the program. For 298 # example: 299 # 300 # - `aarch64-ld` gives the linker for the AArch64 toolchain, 301 # - `aarch32-oc` gives the object copier for the AArch32 toolchain, and 302 # - `host-cc` gives the C compiler for the host toolchain. 303 # 304 # For each of these variables, if no program path is explicitly provided 305 # by the parent Makefile then the C compiler is queried (if supported) 306 # for its location. 307 # 308 # If the C compiler cannot provide the location (or the tool class *is* 309 # the C compiler), then it is assigned a default value specific for that 310 # toolchain. 311 # 312 313 toolchain-guess-arm-clang-cpp = $(1) 314 toolchain-guess-arm-clang-as = $(1) 315 toolchain-guess-arm-clang-ld = # Fall back to `$(toolchain)-ld-default` 316 toolchain-guess-arm-clang-oc = # Fall back to `$(toolchain)-oc-default` 317 toolchain-guess-arm-clang-od = # Fall back to `$(toolchain)-od-default` 318 toolchain-guess-arm-clang-ar = # Fall back to `$(toolchain)-ar-default` 319 320 toolchain-guess-llvm-clang-cpp = $(1) 321 toolchain-guess-llvm-clang-as = $(1) 322 toolchain-guess-llvm-clang-ld = $(shell $(1) --print-prog-name ld.lld 2>$(nul)) 323 toolchain-guess-llvm-clang-oc = $(shell $(1) --print-prog-name llvm-objcopy 2>$(nul)) 324 toolchain-guess-llvm-clang-od = $(shell $(1) --print-prog-name llvm-objdump 2>$(nul)) 325 toolchain-guess-llvm-clang-ar = $(shell $(1) --print-prog-name llvm-ar 2>$(nul)) 326 327 toolchain-guess-gnu-gcc-cpp = $(1) 328 toolchain-guess-gnu-gcc-as = $(1) 329 toolchain-guess-gnu-gcc-ld = $(1) 330 toolchain-guess-gnu-gcc-oc = $(shell $(1) --print-prog-name objcopy 2>$(nul)) 331 toolchain-guess-gnu-gcc-od = $(shell $(1) --print-prog-name objdump 2>$(nul)) 332 toolchain-guess-gnu-gcc-ar = $(shell $(1) --print-prog-name ar 2>$(nul)) 333 334 # 335 # Configure a toolchain. 336 # 337 # Parameters: 338 # 339 # - $1: The toolchain to configure. 340 # 341 # This function iterates over all tool classes and configures them for 342 # the provided toolchain. Toolchain tools are initialized lazily and 343 # on-demand based on the first read of the tool path or identifier 344 # variables. 345 # 346 347 define toolchain-configure 348 $$(foreach tool-class,$$(toolchain-tool-classes), \ 349 $$(eval $$(call toolchain-configure-tool,$1,$$(tool-class)))) 350 endef 351 352 # 353 # Configure a specific tool within a toolchain. 354 # 355 # Parameters: 356 # 357 # - $1: The toolchain to configure. 358 # - $2: The tool class to configure. 359 # 360 361 define toolchain-configure-tool 362 $1-$2-configure = $\ 363 $$(eval $$(call toolchain-determine-tool,$1,$2)) 364 365 # 366 # When either of the following variables are read for the first 367 # time, the appropriate tool is determined and *both* variables 368 # are overwritten with their final values. 369 # 370 371 $1-$2 = $$($1-$2-configure)$$($1-$2) 372 $1-$2-id = $$($1-$2-configure)$$($1-$2-id) 373 endef 374 375 # 376 # Determines and identifies a tool. 377 # 378 # Parameters: 379 # 380 # - $1: The toolchain identifier. 381 # - $2: The tool class. 382 # 383 # Tool identification happens by reading the designated tool parameter 384 # to get the user-specified command for the tool (e.g. `CC` or `LD`). If 385 # no tool parameter is defined then try to derive the tool from the C 386 # compiler. 387 # 388 # If all else fails, fall back to the default command defined by the 389 # toolchain makefile. 390 # 391 392 define toolchain-determine-tool 393 toolchain-$1-$2-guess = $$(if $$(filter-out cc,$2),$\ 394 $$(call toolchain-guess-$$($1-cc-id)-$2,$$($1-cc))) 395 396 toolchain-$1-$2-shell = $$(or $$($$($1-$2-parameter)),$\ 397 $$(toolchain-$1-$2-guess),$$($1-$2-default)) 398 399 $1-$2 := $(if $(call which,$$(toolchain-$1-$2-shell)),$\ 400 $$(call escape-shell,$$(toolchain-$1-$2-shell)),$\ 401 $$(toolchain-$1-$2-shell)) 402 403 $1-$2-id := $$(or \ 404 $$(call toolchain-guess-tool,$$(toolchain-tools-$2),$$($1-$2)),$\ 405 $$(strip $$(call toolchain-warn-unrecognized,$1,$2)$$($1-$2-id-default))) 406 endef 407 408 $(foreach toolchain,$(toolchains), \ 409 $(eval $(call toolchain-configure,$(toolchain)))) 410endif 411