Makefile

   1 #
   2 # Copyright (c) 2013-2019, ARM Limited and Contributors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: BSD-3-Clause
   5 #
   6
   7 #
   8 # Trusted Firmware Version
   9 #
  10 VERSION_MAJOR                   := 2
  11 VERSION_MINOR                   := 1
  12
  13 # Default goal is build all images
  14 .DEFAULT_GOAL                   := all
  15
  16 # Avoid any implicit propagation of command line variable definitions to
  17 # sub-Makefiles, like CFLAGS that we reserved for the firmware images'
  18 # usage. Other command line options like "-s" are still propagated as usual.
  19 MAKEOVERRIDES =
  20
  21 MAKE_HELPERS_DIRECTORY := make_helpers/
  22 include ${MAKE_HELPERS_DIRECTORY}build_macros.mk
  23 include ${MAKE_HELPERS_DIRECTORY}build_env.mk
  24
  25 ################################################################################
  26 # Default values for build configurations, and their dependencies
  27 ################################################################################
  28
  29 include ${MAKE_HELPERS_DIRECTORY}defaults.mk
  30
  31 # Assertions enabled for DEBUG builds by default
  32 ENABLE_ASSERTIONS               := ${DEBUG}
  33 ENABLE_PMF                      := ${ENABLE_RUNTIME_INSTRUMENTATION}
  34 PLAT                            := ${DEFAULT_PLAT}
  35
  36 ################################################################################
  37 # Checkpatch script options
  38 ################################################################################
  39
  40 CHECKCODE_ARGS          :=      --no-patch
  41 # Do not check the coding style on imported library files or documentation files
  42 INC_LIB_DIRS_TO_CHECK   :=      $(sort $(filter-out                     \
  43                                         include/lib/libfdt              \
  44                                         include/lib/libc,               \
  45                                         $(wildcard include/lib/*)))
  46 INC_DIRS_TO_CHECK       :=      $(sort $(filter-out                     \
  47                                         include/lib,                    \
  48                                         $(wildcard include/*)))
  49 LIB_DIRS_TO_CHECK       :=      $(sort $(filter-out                     \
  50                                         lib/compiler-rt                 \
  51                                         lib/libfdt%                     \
  52                                         lib/libc,                       \
  53                                         $(wildcard lib/*)))
  54 ROOT_DIRS_TO_CHECK      :=      $(sort $(filter-out                     \
  55                                         lib                             \
  56                                         include                         \
  57                                         docs                            \
  58                                         %.rst,                          \
  59                                         $(wildcard *)))
  60 CHECK_PATHS             :=      ${ROOT_DIRS_TO_CHECK}                   \
  61                                 ${INC_DIRS_TO_CHECK}                    \
  62                                 ${INC_LIB_DIRS_TO_CHECK}                \
  63                                 ${LIB_DIRS_TO_CHECK}
  64
  65
  66 ################################################################################
  67 # Process build options
  68 ################################################################################
  69
  70 # Verbose flag
  71 ifeq (${V},0)
  72         Q:=@
  73         ECHO:=@echo
  74         CHECKCODE_ARGS  +=      --no-summary --terse
  75 else
  76         Q:=
  77         ECHO:=$(ECHO_QUIET)
  78 endif
  79
  80 ifneq ($(findstring s,$(filter-out --%,$(MAKEFLAGS))),)
  81         Q:=@
  82         ECHO:=$(ECHO_QUIET)
  83 endif
  84
  85 export Q ECHO
  86
  87 # Process Debug flag
  88 $(eval $(call add_define,DEBUG))
  89 ifneq (${DEBUG}, 0)
  90         BUILD_TYPE      :=      debug
  91         TF_CFLAGS       +=      -g
  92
  93         ifneq ($(findstring clang,$(notdir $(CC))),)
  94              ASFLAGS            +=      -g
  95         else
  96              ASFLAGS            +=      -g -Wa,--gdwarf-2
  97         endif
  98
  99         # Use LOG_LEVEL_INFO by default for debug builds
 100         LOG_LEVEL       :=      40
 101 else
 102         BUILD_TYPE      :=      release
 103         # Use LOG_LEVEL_NOTICE by default for release builds
 104         LOG_LEVEL       :=      20
 105 endif
 106
 107 # Default build string (git branch and commit)
 108 ifeq (${BUILD_STRING},)
 109         BUILD_STRING    :=      $(shell git describe --always --dirty --tags 2> /dev/null)
 110 endif
 111 VERSION_STRING          :=      v${VERSION_MAJOR}.${VERSION_MINOR}(${BUILD_TYPE}):${BUILD_STRING}
 112
 113 # The cert_create tool cannot generate certificates individually, so we use the
 114 # target 'certificates' to create them all
 115 ifneq (${GENERATE_COT},0)
 116         FIP_DEPS += certificates
 117         FWU_FIP_DEPS += fwu_certificates
 118 endif
 119
 120 # Process BRANCH_PROTECTION value and set
 121 # Pointer Authentication and Branch Target Identification flags
 122 ifeq (${BRANCH_PROTECTION},0)
 123         # Default value turns off all types of branch protection
 124         BP_OPTION := none
 125 else ifneq (${ARCH},aarch64)
 126         $(error BRANCH_PROTECTION requires AArch64)
 127 else ifeq (${BRANCH_PROTECTION},1)
 128         # Enables all types of branch protection features
 129         BP_OPTION := standard
 130         ENABLE_BTI := 1
 131         ENABLE_PAUTH := 1
 132 else ifeq (${BRANCH_PROTECTION},2)
 133         # Return address signing to its standard level
 134         BP_OPTION := pac-ret
 135         ENABLE_PAUTH := 1
 136 else ifeq (${BRANCH_PROTECTION},3)
 137         # Extend the signing to include leaf functions
 138         BP_OPTION := pac-ret+leaf
 139         ENABLE_PAUTH := 1
 140 else
 141         $(error Unknown BRANCH_PROTECTION value ${BRANCH_PROTECTION})
 142 endif
 143
 144 ################################################################################
 145 # Toolchain
 146 ################################################################################
 147
 148 HOSTCC                  :=      gcc
 149 export HOSTCC
 150
 151 CC                      :=      ${CROSS_COMPILE}gcc
 152 CPP                     :=      ${CROSS_COMPILE}cpp
 153 AS                      :=      ${CROSS_COMPILE}gcc
 154 AR                      :=      ${CROSS_COMPILE}ar
 155 LINKER                  :=      ${CROSS_COMPILE}ld
 156 OC                      :=      ${CROSS_COMPILE}objcopy
 157 OD                      :=      ${CROSS_COMPILE}objdump
 158 NM                      :=      ${CROSS_COMPILE}nm
 159 PP                      :=      ${CROSS_COMPILE}gcc -E
 160 DTC                     :=      dtc
 161
 162 # Use ${LD}.bfd instead if it exists (as absolute path or together with $PATH).
 163 ifneq ($(strip $(wildcard ${LD}.bfd) \
 164         $(foreach dir,$(subst :, ,${PATH}),$(wildcard ${dir}/${LINKER}.bfd))),)
 165 LINKER                  :=      ${LINKER}.bfd
 166 endif
 167
 168 ifeq (${ARM_ARCH_MAJOR},7)
 169 target32-directive      =       -target arm-none-eabi
 170 # Will set march32-directive from platform configuration
 171 else
 172 target32-directive      =       -target armv8a-none-eabi
 173
 174 # Set the compiler's target architecture profile based on ARM_ARCH_MINOR option
 175 ifeq (${ARM_ARCH_MINOR},0)
 176 march32-directive       =       -march=armv8-a
 177 march64-directive       =       -march=armv8-a
 178 else
 179 march32-directive       =       -march=armv8.${ARM_ARCH_MINOR}-a
 180 march64-directive       =       -march=armv8.${ARM_ARCH_MINOR}-a
 181 endif
 182 endif
 183
 184 ifneq ($(findstring armclang,$(notdir $(CC))),)
 185 TF_CFLAGS_aarch32       =       -target arm-arm-none-eabi $(march32-directive)
 186 TF_CFLAGS_aarch64       =       -target aarch64-arm-none-eabi $(march64-directive)
 187 LD                      =       $(LINKER)
 188 AS                      =       $(CC) -c -x assembler-with-cpp $(TF_CFLAGS_$(ARCH))
 189 CPP                     =       $(CC) -E $(TF_CFLAGS_$(ARCH))
 190 PP                      =       $(CC) -E $(TF_CFLAGS_$(ARCH))
 191 else ifneq ($(findstring clang,$(notdir $(CC))),)
 192 TF_CFLAGS_aarch32       =       $(target32-directive) $(march32-directive)
 193 TF_CFLAGS_aarch64       =       -target aarch64-elf $(march64-directive)
 194 LD                      =       $(LINKER)
 195 AS                      =       $(CC) -c -x assembler-with-cpp $(TF_CFLAGS_$(ARCH))
 196 CPP                     =       $(CC) -E
 197 PP                      =       $(CC) -E
 198 else
 199 TF_CFLAGS_aarch32       =       $(march32-directive)
 200 TF_CFLAGS_aarch64       =       $(march64-directive)
 201 LD                      =       $(LINKER)
 202 endif
 203
 204 ifeq (${AARCH32_INSTRUCTION_SET},A32)
 205 TF_CFLAGS_aarch32       +=      -marm
 206 else ifeq (${AARCH32_INSTRUCTION_SET},T32)
 207 TF_CFLAGS_aarch32       +=      -mthumb
 208 else
 209 $(error Error: Unknown AArch32 instruction set ${AARCH32_INSTRUCTION_SET})
 210 endif
 211
 212 TF_CFLAGS_aarch32       +=      -mno-unaligned-access
 213 TF_CFLAGS_aarch64       +=      -mgeneral-regs-only -mstrict-align
 214
 215 ifneq (${BP_OPTION},none)
 216 TF_CFLAGS_aarch64       +=      -mbranch-protection=${BP_OPTION}
 217 endif
 218
 219 ASFLAGS_aarch32         =       $(march32-directive)
 220 ASFLAGS_aarch64         =       $(march64-directive)
 221
 222 WARNING1 := -Wextra
 223 WARNING1 += -Wmissing-declarations
 224 WARNING1 += -Wmissing-format-attribute
 225 WARNING1 += -Wmissing-prototypes
 226 WARNING1 += -Wold-style-definition
 227 WARNING1 += -Wunused-const-variable
 228
 229 WARNING2 := -Waggregate-return
 230 WARNING2 += -Wcast-align
 231 WARNING2 += -Wnested-externs
 232 WARNING2 += -Wshadow
 233 WARNING2 += -Wlogical-op
 234 WARNING2 += -Wmissing-field-initializers
 235 WARNING2 += -Wsign-compare
 236
 237 WARNING3 := -Wbad-function-cast
 238 WARNING3 += -Wcast-qual
 239 WARNING3 += -Wconversion
 240 WARNING3 += -Wpacked
 241 WARNING3 += -Wpadded
 242 WARNING3 += -Wpointer-arith
 243 WARNING3 += -Wredundant-decls
 244 WARNING3 += -Wswitch-default
 245
 246 ifeq (${W},1)
 247 WARNINGS := $(WARNING1)
 248 else ifeq (${W},2)
 249 WARNINGS := $(WARNING1) $(WARNING2)
 250 else ifeq (${W},3)
 251 WARNINGS := $(WARNING1) $(WARNING2) $(WARNING3)
 252 endif
 253
 254 WARNINGS        +=              -Wunused -Wno-unused-parameter  \
 255                                 -Wdisabled-optimization         \
 256                                 -Wvla
 257
 258 ifeq ($(findstring clang,$(notdir $(CC))),)
 259 # not using clang
 260 WARNINGS        +=              -Wunused-but-set-variable       \
 261                                 -Wmaybe-uninitialized           \
 262                                 -Wpacked-bitfield-compat        \
 263                                 -Wshift-overflow=2
 264 else
 265 # using clang
 266 WARNINGS        +=              -Wshift-overflow -Wshift-sign-overflow
 267 endif
 268
 269 ifneq (${E},0)
 270 ERRORS := -Werror
 271 endif
 272
 273 CPPFLAGS                =       ${DEFINES} ${INCLUDES} ${MBEDTLS_INC} -nostdinc         \
 274                                 -Wmissing-include-dirs $(ERRORS) $(WARNINGS)
 275 ASFLAGS                 +=      $(CPPFLAGS) $(ASFLAGS_$(ARCH))                  \
 276                                 -ffreestanding -Wa,--fatal-warnings
 277 TF_CFLAGS               +=      $(CPPFLAGS) $(TF_CFLAGS_$(ARCH))                \
 278                                 -ffreestanding -fno-builtin -Wall -std=gnu99    \
 279                                 -Os -ffunction-sections -fdata-sections
 280
 281 ifeq (${SANITIZE_UB},on)
 282 TF_CFLAGS               +=      -fsanitize=undefined -fno-sanitize-recover
 283 endif
 284 ifeq (${SANITIZE_UB},trap)
 285 TF_CFLAGS               +=      -fsanitize=undefined -fno-sanitize-recover      \
 286                                 -fsanitize-undefined-trap-on-error
 287 endif
 288
 289 GCC_V_OUTPUT            :=      $(shell $(CC) -v 2>&1)
 290
 291 ifneq ($(findstring armlink,$(notdir $(LD))),)
 292 TF_LDFLAGS              +=      --diag_error=warning --lto_level=O1
 293 TF_LDFLAGS              +=      --remove --info=unused,unusedsymbols
 294 else
 295 TF_LDFLAGS              +=      --fatal-warnings -O1
 296 TF_LDFLAGS              +=      --gc-sections
 297 endif
 298 TF_LDFLAGS              +=      $(TF_LDFLAGS_$(ARCH))
 299
 300 DTC_FLAGS               +=      -I dts -O dtb
 301 DTC_CPPFLAGS            +=      -nostdinc -Iinclude -undef -x assembler-with-cpp
 302
 303 ################################################################################
 304 # Common sources and include directories
 305 ################################################################################
 306 include lib/compiler-rt/compiler-rt.mk
 307
 308 BL_COMMON_SOURCES       +=      common/bl_common.c                      \
 309                                 common/tf_log.c                         \
 310                                 common/${ARCH}/debug.S                  \
 311                                 drivers/console/multi_console.c         \
 312                                 lib/${ARCH}/cache_helpers.S             \
 313                                 lib/${ARCH}/misc_helpers.S              \
 314                                 plat/common/plat_bl_common.c            \
 315                                 plat/common/plat_log_common.c           \
 316                                 plat/common/${ARCH}/plat_common.c       \
 317                                 plat/common/${ARCH}/platform_helpers.S  \
 318                                 ${COMPILER_RT_SRCS}
 319
 320 ifeq ($(notdir $(CC)),armclang)
 321 BL_COMMON_SOURCES       +=      lib/${ARCH}/armclang_printf.S
 322 endif
 323
 324 ifeq (${SANITIZE_UB},on)
 325 BL_COMMON_SOURCES       +=      plat/common/ubsan.c
 326 endif
 327
 328 INCLUDES                +=      -Iinclude                               \
 329                                 -Iinclude/arch/${ARCH}                  \
 330                                 -Iinclude/lib/cpus/${ARCH}              \
 331                                 -Iinclude/lib/el3_runtime/${ARCH}       \
 332                                 ${PLAT_INCLUDES}                        \
 333                                 ${SPD_INCLUDES}
 334
 335 include common/backtrace/backtrace.mk
 336
 337 ################################################################################
 338 # Generic definitions
 339 ################################################################################
 340
 341 include ${MAKE_HELPERS_DIRECTORY}plat_helpers.mk
 342
 343 BUILD_BASE              :=      ./build
 344 BUILD_PLAT              :=      ${BUILD_BASE}/${PLAT}/${BUILD_TYPE}
 345
 346 SPDS                    :=      $(sort $(filter-out none, $(patsubst services/spd/%,%,$(wildcard services/spd/*))))
 347
 348 # Platforms providing their own TBB makefile may override this value
 349 INCLUDE_TBBR_MK         :=      1
 350
 351
 352 ################################################################################
 353 # Include SPD Makefile if one has been specified
 354 ################################################################################
 355
 356 ifneq (${SPD},none)
 357 ifeq (${ARCH},aarch32)
 358         $(error "Error: SPD is incompatible with AArch32.")
 359 endif
 360 ifdef EL3_PAYLOAD_BASE
 361         $(warning "SPD and EL3_PAYLOAD_BASE are incompatible build options.")
 362         $(warning "The SPD and its BL32 companion will be present but ignored.")
 363 endif
 364         # We expect to locate an spd.mk under the specified SPD directory
 365         SPD_MAKE        :=      $(wildcard services/spd/${SPD}/${SPD}.mk)
 366
 367         ifeq (${SPD_MAKE},)
 368                 $(error Error: No services/spd/${SPD}/${SPD}.mk located)
 369         endif
 370         $(info Including ${SPD_MAKE})
 371         include ${SPD_MAKE}
 372
 373         # If there's BL32 companion for the chosen SPD, we expect that the SPD's
 374         # Makefile would set NEED_BL32 to "yes". In this case, the build system
 375         # supports two mutually exclusive options:
 376         # * BL32 is built from source: then BL32_SOURCES must contain the list
 377         #   of source files to build BL32
 378         # * BL32 is a prebuilt binary: then BL32 must point to the image file
 379         #   that will be included in the FIP
 380         # If both BL32_SOURCES and BL32 are defined, the binary takes precedence
 381         # over the sources.
 382 endif
 383
 384 ################################################################################
 385 # Include the platform specific Makefile after the SPD Makefile (the platform
 386 # makefile may use all previous definitions in this file)
 387 ################################################################################
 388
 389 include ${PLAT_MAKEFILE_FULL}
 390
 391 $(eval $(call MAKE_PREREQ_DIR,${BUILD_PLAT}))
 392
 393 ifeq (${ARM_ARCH_MAJOR},7)
 394 include make_helpers/armv7-a-cpus.mk
 395 endif
 396
 397 ifeq ($(ENABLE_PIE),1)
 398     TF_CFLAGS           +=      -fpie
 399     TF_LDFLAGS          +=      -pie --no-dynamic-linker
 400 else
 401     PIE_FOUND           :=      $(findstring --enable-default-pie,${GCC_V_OUTPUT})
 402     ifneq ($(PIE_FOUND),)
 403         TF_CFLAGS               +=      -fno-PIE
 404     endif
 405 endif
 406
 407 # Include the CPU specific operations makefile, which provides default
 408 # values for all CPU errata workarounds and CPU specific optimisations.
 409 # This can be overridden by the platform.
 410 include lib/cpus/cpu-ops.mk
 411
 412 ifeq (${ARCH},aarch32)
 413 NEED_BL32 := yes
 414
 415 ################################################################################
 416 # Build `AARCH32_SP` as BL32 image for AArch32
 417 ################################################################################
 418 ifneq (${AARCH32_SP},none)
 419 # We expect to locate an sp.mk under the specified AARCH32_SP directory
 420 AARCH32_SP_MAKE :=      $(wildcard bl32/${AARCH32_SP}/${AARCH32_SP}.mk)
 421
 422 ifeq (${AARCH32_SP_MAKE},)
 423   $(error Error: No bl32/${AARCH32_SP}/${AARCH32_SP}.mk located)
 424 endif
 425
 426 $(info Including ${AARCH32_SP_MAKE})
 427 include ${AARCH32_SP_MAKE}
 428 endif
 429
 430 endif
 431
 432 ################################################################################
 433 # Include libc if not overridden
 434 ################################################################################
 435 ifeq (${OVERRIDE_LIBC},0)
 436 include lib/libc/libc.mk
 437 endif
 438
 439 ################################################################################
 440 # Check incompatible options
 441 ################################################################################
 442
 443 ifdef EL3_PAYLOAD_BASE
 444         ifdef PRELOADED_BL33_BASE
 445                 $(warning "PRELOADED_BL33_BASE and EL3_PAYLOAD_BASE are \
 446                 incompatible build options. EL3_PAYLOAD_BASE has priority.")
 447         endif
 448         ifneq (${GENERATE_COT},0)
 449                 $(error "GENERATE_COT and EL3_PAYLOAD_BASE are incompatible build options.")
 450         endif
 451         ifneq (${TRUSTED_BOARD_BOOT},0)
 452                 $(error "TRUSTED_BOARD_BOOT and EL3_PAYLOAD_BASE are incompatible build options.")
 453         endif
 454 endif
 455
 456 ifeq (${NEED_BL33},yes)
 457         ifdef EL3_PAYLOAD_BASE
 458                 $(warning "BL33 image is not needed when option \
 459                 BL33_PAYLOAD_BASE is used and won't be added to the FIP file.")
 460         endif
 461         ifdef PRELOADED_BL33_BASE
 462                 $(warning "BL33 image is not needed when option \
 463                 PRELOADED_BL33_BASE is used and won't be added to the FIP \
 464                 file.")
 465         endif
 466 endif
 467
 468 # When building for systems with hardware-assisted coherency, there's no need to
 469 # use USE_COHERENT_MEM. Require that USE_COHERENT_MEM must be set to 0 too.
 470 ifeq ($(HW_ASSISTED_COHERENCY)-$(USE_COHERENT_MEM),1-1)
 471 $(error USE_COHERENT_MEM cannot be enabled with HW_ASSISTED_COHERENCY)
 472 endif
 473
 474 #For now, BL2_IN_XIP_MEM is only supported when BL2_AT_EL3 is 1.
 475 ifeq ($(BL2_AT_EL3)-$(BL2_IN_XIP_MEM),0-1)
 476 $(error "BL2_IN_XIP_MEM is only supported when BL2_AT_EL3 is enabled")
 477 endif
 478
 479 # For RAS_EXTENSION, require that EAs are handled in EL3 first
 480 ifeq ($(RAS_EXTENSION),1)
 481     ifneq ($(HANDLE_EA_EL3_FIRST),1)
 482         $(error For RAS_EXTENSION, HANDLE_EA_EL3_FIRST must also be 1)
 483     endif
 484 endif
 485
 486 # When FAULT_INJECTION_SUPPORT is used, require that RAS_EXTENSION is enabled
 487 ifeq ($(FAULT_INJECTION_SUPPORT),1)
 488     ifneq ($(RAS_EXTENSION),1)
 489         $(error For FAULT_INJECTION_SUPPORT, RAS_EXTENSION must also be 1)
 490     endif
 491 endif
 492
 493 # DYN_DISABLE_AUTH can be set only when TRUSTED_BOARD_BOOT=1
 494 ifeq ($(DYN_DISABLE_AUTH), 1)
 495     ifeq (${TRUSTED_BOARD_BOOT}, 0)
 496         $(error "TRUSTED_BOARD_BOOT must be enabled for DYN_DISABLE_AUTH to be set.")
 497     endif
 498 endif
 499
 500 # If pointer authentication is used in the firmware, make sure that all the
 501 # registers associated to it are also saved and restored.
 502 # Not doing it would leak the value of the keys used by EL3 to EL1 and S-EL1.
 503 ifeq ($(ENABLE_PAUTH),1)
 504     ifeq ($(CTX_INCLUDE_PAUTH_REGS),0)
 505         $(error Pointer Authentication requires CTX_INCLUDE_PAUTH_REGS=1)
 506     endif
 507 endif
 508
 509 ifeq ($(CTX_INCLUDE_PAUTH_REGS),1)
 510     ifneq (${ARCH},aarch64)
 511         $(error CTX_INCLUDE_PAUTH_REGS requires AArch64)
 512     else
 513         $(info CTX_INCLUDE_PAUTH_REGS is an experimental feature)
 514     endif
 515 endif
 516
 517 ifeq ($(ENABLE_PAUTH),1)
 518     $(info Pointer Authentication is an experimental feature)
 519 endif
 520
 521 ifeq ($(ENABLE_BTI),1)
 522     $(info Branch Protection is an experimental feature)
 523 endif
 524
 525 ################################################################################
 526 # Process platform overrideable behaviour
 527 ################################################################################
 528
 529 # Using BL2 implies that a BL33 image also needs to be supplied for the FIP and
 530 # Certificate generation tools. This flag can be overridden by the platform.
 531 ifdef BL2_SOURCES
 532         ifdef EL3_PAYLOAD_BASE
 533                 # If booting an EL3 payload there is no need for a BL33 image
 534                 # in the FIP file.
 535                 NEED_BL33               :=      no
 536         else
 537                 ifdef PRELOADED_BL33_BASE
 538                         # If booting a BL33 preloaded image there is no need of
 539                         # another one in the FIP file.
 540                         NEED_BL33               :=      no
 541                 else
 542                         NEED_BL33               ?=      yes
 543                 endif
 544         endif
 545 endif
 546
 547 # If SCP_BL2 is given, we always want FIP to include it.
 548 ifdef SCP_BL2
 549         NEED_SCP_BL2            :=      yes
 550 endif
 551
 552 # For AArch32, BL31 is not currently supported.
 553 ifneq (${ARCH},aarch32)
 554     ifdef BL31_SOURCES
 555         # When booting an EL3 payload, there is no need to compile the BL31 image nor
 556         # put it in the FIP.
 557         ifndef EL3_PAYLOAD_BASE
 558             NEED_BL31 := yes
 559         endif
 560     endif
 561 endif
 562
 563 # Process TBB related flags
 564 ifneq (${GENERATE_COT},0)
 565         # Common cert_create options
 566         ifneq (${CREATE_KEYS},0)
 567                 $(eval CRT_ARGS += -n)
 568                 $(eval FWU_CRT_ARGS += -n)
 569                 ifneq (${SAVE_KEYS},0)
 570                         $(eval CRT_ARGS += -k)
 571                         $(eval FWU_CRT_ARGS += -k)
 572                 endif
 573         endif
 574         # Include TBBR makefile (unless the platform indicates otherwise)
 575         ifeq (${INCLUDE_TBBR_MK},1)
 576                 include make_helpers/tbbr/tbbr_tools.mk
 577         endif
 578 endif
 579
 580 ifneq (${FIP_ALIGN},0)
 581 FIP_ARGS += --align ${FIP_ALIGN}
 582 endif
 583
 584 ################################################################################
 585 # Include libraries' Makefile that are used in all BL
 586 ################################################################################
 587
 588 include lib/stack_protector/stack_protector.mk
 589
 590 ################################################################################
 591 # Auxiliary tools (fiptool, cert_create, etc)
 592 ################################################################################
 593
 594 # Variables for use with Certificate Generation Tool
 595 CRTTOOLPATH             ?=      tools/cert_create
 596 CRTTOOL                 ?=      ${CRTTOOLPATH}/cert_create${BIN_EXT}
 597
 598 # Variables for use with Firmware Image Package
 599 FIPTOOLPATH             ?=      tools/fiptool
 600 FIPTOOL                 ?=      ${FIPTOOLPATH}/fiptool${BIN_EXT}
 601
 602 # Variables for use with sptool
 603 SPTOOLPATH              ?=      tools/sptool
 604 SPTOOL                  ?=      ${SPTOOLPATH}/sptool${BIN_EXT}
 605
 606 # Variables for use with ROMLIB
 607 ROMLIBPATH              ?=      lib/romlib
 608
 609 ################################################################################
 610 # Include BL specific makefiles
 611 ################################################################################
 612 ifdef BL1_SOURCES
 613 NEED_BL1 := yes
 614 include bl1/bl1.mk
 615 endif
 616
 617 ifdef BL2_SOURCES
 618 NEED_BL2 := yes
 619 include bl2/bl2.mk
 620 endif
 621
 622 ifdef BL2U_SOURCES
 623 NEED_BL2U := yes
 624 include bl2u/bl2u.mk
 625 endif
 626
 627 ifeq (${NEED_BL31},yes)
 628 ifdef BL31_SOURCES
 629 include bl31/bl31.mk
 630 endif
 631 endif
 632
 633 ifdef FDT_SOURCES
 634 NEED_FDT := yes
 635 endif
 636
 637 ################################################################################
 638 # Build options checks
 639 ################################################################################
 640
 641 $(eval $(call assert_boolean,COLD_BOOT_SINGLE_CPU))
 642 $(eval $(call assert_boolean,CREATE_KEYS))
 643 $(eval $(call assert_boolean,CTX_INCLUDE_AARCH32_REGS))
 644 $(eval $(call assert_boolean,CTX_INCLUDE_FPREGS))
 645 $(eval $(call assert_boolean,CTX_INCLUDE_PAUTH_REGS))
 646 $(eval $(call assert_boolean,DEBUG))
 647 $(eval $(call assert_boolean,DYN_DISABLE_AUTH))
 648 $(eval $(call assert_boolean,EL3_EXCEPTION_HANDLING))
 649 $(eval $(call assert_boolean,ENABLE_AMU))
 650 $(eval $(call assert_boolean,ENABLE_ASSERTIONS))
 651 $(eval $(call assert_boolean,ENABLE_MPAM_FOR_LOWER_ELS))
 652 $(eval $(call assert_boolean,ENABLE_PIE))
 653 $(eval $(call assert_boolean,ENABLE_PMF))
 654 $(eval $(call assert_boolean,ENABLE_PSCI_STAT))
 655 $(eval $(call assert_boolean,ENABLE_RUNTIME_INSTRUMENTATION))
 656 $(eval $(call assert_boolean,ENABLE_SPE_FOR_LOWER_ELS))
 657 $(eval $(call assert_boolean,ENABLE_SPM))
 658 $(eval $(call assert_boolean,ENABLE_SVE_FOR_NS))
 659 $(eval $(call assert_boolean,ERROR_DEPRECATED))
 660 $(eval $(call assert_boolean,FAULT_INJECTION_SUPPORT))
 661 $(eval $(call assert_boolean,GENERATE_COT))
 662 $(eval $(call assert_boolean,GICV2_G0_FOR_EL3))
 663 $(eval $(call assert_boolean,HANDLE_EA_EL3_FIRST))
 664 $(eval $(call assert_boolean,HW_ASSISTED_COHERENCY))
 665 $(eval $(call assert_boolean,NS_TIMER_SWITCH))
 666 $(eval $(call assert_boolean,OVERRIDE_LIBC))
 667 $(eval $(call assert_boolean,PL011_GENERIC_UART))
 668 $(eval $(call assert_boolean,PROGRAMMABLE_RESET_ADDRESS))
 669 $(eval $(call assert_boolean,PSCI_EXTENDED_STATE_ID))
 670 $(eval $(call assert_boolean,RAS_EXTENSION))
 671 $(eval $(call assert_boolean,RESET_TO_BL31))
 672 $(eval $(call assert_boolean,SAVE_KEYS))
 673 $(eval $(call assert_boolean,SEPARATE_CODE_AND_RODATA))
 674 $(eval $(call assert_boolean,SPIN_ON_BL1_EXIT))
 675 $(eval $(call assert_boolean,SPM_MM))
 676 $(eval $(call assert_boolean,TRUSTED_BOARD_BOOT))
 677 $(eval $(call assert_boolean,USE_COHERENT_MEM))
 678 $(eval $(call assert_boolean,USE_ROMLIB))
 679 $(eval $(call assert_boolean,USE_TBBR_DEFS))
 680 $(eval $(call assert_boolean,WARMBOOT_ENABLE_DCACHE_EARLY))
 681 $(eval $(call assert_boolean,BL2_AT_EL3))
 682 $(eval $(call assert_boolean,BL2_IN_XIP_MEM))
 683
 684 $(eval $(call assert_numeric,ARM_ARCH_MAJOR))
 685 $(eval $(call assert_numeric,ARM_ARCH_MINOR))
 686 $(eval $(call assert_numeric,BRANCH_PROTECTION))
 687
 688 ifeq ($(filter $(SANITIZE_UB), on off trap),)
 689         $(error "Invalid value for SANITIZE_UB: can be one of on, off, trap")
 690 endif
 691
 692 ################################################################################
 693 # Add definitions to the cpp preprocessor based on the current build options.
 694 # This is done after including the platform specific makefile to allow the
 695 # platform to overwrite the default options
 696 ################################################################################
 697
 698 $(eval $(call add_define,ARM_ARCH_MAJOR))
 699 $(eval $(call add_define,ARM_ARCH_MINOR))
 700 $(eval $(call add_define,COLD_BOOT_SINGLE_CPU))
 701 $(eval $(call add_define,CTX_INCLUDE_AARCH32_REGS))
 702 $(eval $(call add_define,CTX_INCLUDE_FPREGS))
 703 $(eval $(call add_define,CTX_INCLUDE_PAUTH_REGS))
 704 $(eval $(call add_define,EL3_EXCEPTION_HANDLING))
 705 $(eval $(call add_define,ENABLE_AMU))
 706 $(eval $(call add_define,ENABLE_ASSERTIONS))
 707 $(eval $(call add_define,ENABLE_BTI))
 708 $(eval $(call add_define,ENABLE_MPAM_FOR_LOWER_ELS))
 709 $(eval $(call add_define,ENABLE_PAUTH))
 710 $(eval $(call add_define,ENABLE_PIE))
 711 $(eval $(call add_define,ENABLE_PMF))
 712 $(eval $(call add_define,ENABLE_PSCI_STAT))
 713 $(eval $(call add_define,ENABLE_RUNTIME_INSTRUMENTATION))
 714 $(eval $(call add_define,ENABLE_SPE_FOR_LOWER_ELS))
 715 $(eval $(call add_define,ENABLE_SPM))
 716 $(eval $(call add_define,ENABLE_SVE_FOR_NS))
 717 $(eval $(call add_define,ERROR_DEPRECATED))
 718 $(eval $(call add_define,FAULT_INJECTION_SUPPORT))
 719 $(eval $(call add_define,GICV2_G0_FOR_EL3))
 720 $(eval $(call add_define,HANDLE_EA_EL3_FIRST))
 721 $(eval $(call add_define,HW_ASSISTED_COHERENCY))
 722 $(eval $(call add_define,LOG_LEVEL))
 723 $(eval $(call add_define,NS_TIMER_SWITCH))
 724 $(eval $(call add_define,PL011_GENERIC_UART))
 725 $(eval $(call add_define,PLAT_${PLAT}))
 726 $(eval $(call add_define,PROGRAMMABLE_RESET_ADDRESS))
 727 $(eval $(call add_define,PSCI_EXTENDED_STATE_ID))
 728 $(eval $(call add_define,RAS_EXTENSION))
 729 $(eval $(call add_define,RESET_TO_BL31))
 730 $(eval $(call add_define,SEPARATE_CODE_AND_RODATA))
 731 $(eval $(call add_define,RECLAIM_INIT_CODE))
 732 $(eval $(call add_define,SPD_${SPD}))
 733 $(eval $(call add_define,SPIN_ON_BL1_EXIT))
 734 $(eval $(call add_define,SPM_MM))
 735 $(eval $(call add_define,TRUSTED_BOARD_BOOT))
 736 $(eval $(call add_define,USE_COHERENT_MEM))
 737 $(eval $(call add_define,USE_ROMLIB))
 738 $(eval $(call add_define,USE_TBBR_DEFS))
 739 $(eval $(call add_define,WARMBOOT_ENABLE_DCACHE_EARLY))
 740 $(eval $(call add_define,BL2_AT_EL3))
 741 $(eval $(call add_define,BL2_IN_XIP_MEM))
 742
 743 ifeq (${SANITIZE_UB},trap)
 744         $(eval $(call add_define,MONITOR_TRAPS))
 745 endif
 746
 747 # Define the EL3_PAYLOAD_BASE flag only if it is provided.
 748 ifdef EL3_PAYLOAD_BASE
 749         $(eval $(call add_define,EL3_PAYLOAD_BASE))
 750 else
 751         # Define the PRELOADED_BL33_BASE flag only if it is provided and
 752         # EL3_PAYLOAD_BASE is not defined, as it has priority.
 753         ifdef PRELOADED_BL33_BASE
 754                 $(eval $(call add_define,PRELOADED_BL33_BASE))
 755         endif
 756 endif
 757
 758 # Define the DYN_DISABLE_AUTH flag only if set.
 759 ifeq (${DYN_DISABLE_AUTH},1)
 760 $(eval $(call add_define,DYN_DISABLE_AUTH))
 761 endif
 762
 763 ifneq ($(findstring armlink,$(notdir $(LD))),)
 764 $(eval $(call add_define,USE_ARM_LINK))
 765 endif
 766
 767 ################################################################################
 768 # Build targets
 769 ################################################################################
 770
 771 .PHONY: all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool sptool fip fwu_fip certtool dtbs
 772 .SUFFIXES:
 773
 774 all: msg_start
 775
 776 msg_start:
 777         @echo "Building ${PLAT}"
 778
 779 ifeq (${ERROR_DEPRECATED},0)
 780 # Check if deprecated declarations and cpp warnings should be treated as error or not.
 781 ifneq ($(findstring clang,$(notdir $(CC))),)
 782     CPPFLAGS            +=      -Wno-error=deprecated-declarations
 783 else
 784     CPPFLAGS            +=      -Wno-error=deprecated-declarations -Wno-error=cpp
 785 endif
 786 # __ASSEMBLY__ is deprecated in favor of the compiler-builtin __ASSEMBLER__.
 787 ASFLAGS += -D__ASSEMBLY__
 788 # AARCH32/AARCH64 macros are deprecated in favor of the compiler-builtin __aarch64__.
 789 ifeq (${ARCH},aarch32)
 790         $(eval $(call add_define,AARCH32))
 791 else
 792         $(eval $(call add_define,AARCH64))
 793 endif
 794 endif # !ERROR_DEPRECATED
 795
 796 $(eval $(call MAKE_LIB_DIRS))
 797 $(eval $(call MAKE_LIB,c))
 798
 799 # Expand build macros for the different images
 800 ifeq (${NEED_BL1},yes)
 801 $(eval $(call MAKE_BL,1))
 802 endif
 803
 804 ifeq (${NEED_BL2},yes)
 805 ifeq (${BL2_AT_EL3}, 0)
 806 FIP_BL2_ARGS := tb-fw
 807 endif
 808
 809 $(if ${BL2}, $(eval $(call TOOL_ADD_IMG,bl2,--${FIP_BL2_ARGS})),\
 810         $(eval $(call MAKE_BL,2,${FIP_BL2_ARGS})))
 811 endif
 812
 813 ifeq (${NEED_SCP_BL2},yes)
 814 $(eval $(call TOOL_ADD_IMG,scp_bl2,--scp-fw))
 815 endif
 816
 817 ifeq (${NEED_BL31},yes)
 818 BL31_SOURCES += ${SPD_SOURCES}
 819 $(if ${BL31}, $(eval $(call TOOL_ADD_IMG,bl31,--soc-fw)),\
 820         $(eval $(call MAKE_BL,31,soc-fw)))
 821 endif
 822
 823 # If a BL32 image is needed but neither BL32 nor BL32_SOURCES is defined, the
 824 # build system will call TOOL_ADD_IMG to print a warning message and abort the
 825 # process. Note that the dependency on BL32 applies to the FIP only.
 826 ifeq (${NEED_BL32},yes)
 827
 828 BUILD_BL32 := $(if $(BL32),,$(if $(BL32_SOURCES),1))
 829
 830 $(if ${BUILD_BL32}, $(eval $(call MAKE_BL,32,tos-fw)),\
 831         $(eval $(call TOOL_ADD_IMG,bl32,--tos-fw)))
 832 endif
 833
 834 # Add the BL33 image if required by the platform
 835 ifeq (${NEED_BL33},yes)
 836 $(eval $(call TOOL_ADD_IMG,bl33,--nt-fw))
 837 endif
 838
 839 ifeq (${NEED_BL2U},yes)
 840 $(if ${BL2U}, $(eval $(call TOOL_ADD_IMG,bl2u,--ap-fwu-cfg,FWU_)),\
 841         $(eval $(call MAKE_BL,2u,ap-fwu-cfg,FWU_)))
 842 endif
 843
 844 # Expand build macros for the different images
 845 ifeq (${NEED_FDT},yes)
 846     $(eval $(call MAKE_DTBS,$(BUILD_PLAT)/fdts,$(FDT_SOURCES)))
 847 endif
 848
 849 locate-checkpatch:
 850 ifndef CHECKPATCH
 851         $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/scripts/checkpatch.pl")
 852 else
 853 ifeq (,$(wildcard ${CHECKPATCH}))
 854         $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/scripts/checkpatch.pl")
 855 endif
 856 endif
 857
 858 clean:
 859         @echo "  CLEAN"
 860         $(call SHELL_REMOVE_DIR,${BUILD_PLAT})
 861         ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
 862         ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
 863         ${Q}${MAKE} --no-print-directory -C ${ROMLIBPATH} clean
 864
 865 realclean distclean:
 866         @echo "  REALCLEAN"
 867         $(call SHELL_REMOVE_DIR,${BUILD_BASE})
 868         $(call SHELL_DELETE_ALL, ${CURDIR}/cscope.*)
 869         ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
 870         ${Q}${MAKE} --no-print-directory -C ${SPTOOLPATH} clean
 871         ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
 872         ${Q}${MAKE} --no-print-directory -C ${ROMLIBPATH} clean
 873
 874 checkcodebase:          locate-checkpatch
 875         @echo "  CHECKING STYLE"
 876         @if test -d .git ; then                                         \
 877                 git ls-files | grep -E -v 'libfdt|libc|docs|\.rst' |    \
 878                 while read GIT_FILE ;                                   \
 879                 do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ;      \
 880                 done ;                                                  \
 881         else                                                            \
 882                  find . -type f -not -iwholename "*.git*"               \
 883                  -not -iwholename "*build*"                             \
 884                  -not -iwholename "*libfdt*"                            \
 885                  -not -iwholename "*libc*"                              \
 886                  -not -iwholename "*docs*"                              \
 887                  -not -iwholename "*.rst"                               \
 888                  -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ;       \
 889         fi
 890
 891 checkpatch:             locate-checkpatch
 892         @echo "  CHECKING STYLE"
 893         @if test -n "${CHECKPATCH_OPTS}"; then                          \
 894                 echo "    with ${CHECKPATCH_OPTS} option(s)";           \
 895         fi
 896         ${Q}COMMON_COMMIT=$$(git merge-base HEAD ${BASE_COMMIT});       \
 897         for commit in `git rev-list $$COMMON_COMMIT..HEAD`; do          \
 898                 printf "\n[*] Checking style of '$$commit'\n\n";        \
 899                 git log --format=email "$$commit~..$$commit"            \
 900                         -- ${CHECK_PATHS} |                             \
 901                         ${CHECKPATCH} ${CHECKPATCH_OPTS} - || true;     \
 902                 git diff --format=email "$$commit~..$$commit"           \
 903                         -- ${CHECK_PATHS} |                             \
 904                         ${CHECKPATCH}  ${CHECKPATCH_OPTS} - || true;    \
 905         done
 906
 907 certtool: ${CRTTOOL}
 908
 909 .PHONY: ${CRTTOOL}
 910 ${CRTTOOL}:
 911         ${Q}${MAKE} PLAT=${PLAT} USE_TBBR_DEFS=${USE_TBBR_DEFS} --no-print-directory -C ${CRTTOOLPATH}
 912         @${ECHO_BLANK_LINE}
 913         @echo "Built $@ successfully"
 914         @${ECHO_BLANK_LINE}
 915
 916 ifneq (${GENERATE_COT},0)
 917 certificates: ${CRT_DEPS} ${CRTTOOL}
 918         ${Q}${CRTTOOL} ${CRT_ARGS}
 919         @${ECHO_BLANK_LINE}
 920         @echo "Built $@ successfully"
 921         @echo "Certificates can be found in ${BUILD_PLAT}"
 922         @${ECHO_BLANK_LINE}
 923 endif
 924
 925 ${BUILD_PLAT}/${FIP_NAME}: ${FIP_DEPS} ${FIPTOOL}
 926         ${Q}${FIPTOOL} create ${FIP_ARGS} $@
 927         ${Q}${FIPTOOL} info $@
 928         @${ECHO_BLANK_LINE}
 929         @echo "Built $@ successfully"
 930         @${ECHO_BLANK_LINE}
 931
 932 ifneq (${GENERATE_COT},0)
 933 fwu_certificates: ${FWU_CRT_DEPS} ${CRTTOOL}
 934         ${Q}${CRTTOOL} ${FWU_CRT_ARGS}
 935         @${ECHO_BLANK_LINE}
 936         @echo "Built $@ successfully"
 937         @echo "FWU certificates can be found in ${BUILD_PLAT}"
 938         @${ECHO_BLANK_LINE}
 939 endif
 940
 941 ${BUILD_PLAT}/${FWU_FIP_NAME}: ${FWU_FIP_DEPS} ${FIPTOOL}
 942         ${Q}${FIPTOOL} create ${FWU_FIP_ARGS} $@
 943         ${Q}${FIPTOOL} info $@
 944         @${ECHO_BLANK_LINE}
 945         @echo "Built $@ successfully"
 946         @${ECHO_BLANK_LINE}
 947
 948 fiptool: ${FIPTOOL}
 949 fip: ${BUILD_PLAT}/${FIP_NAME}
 950 fwu_fip: ${BUILD_PLAT}/${FWU_FIP_NAME}
 951
 952 .PHONY: ${FIPTOOL}
 953 ${FIPTOOL}:
 954         ${Q}${MAKE} CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" --no-print-directory -C ${FIPTOOLPATH}
 955
 956 sptool: ${SPTOOL}
 957 .PHONY: ${SPTOOL}
 958 ${SPTOOL}:
 959         ${Q}${MAKE} CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" --no-print-directory -C ${SPTOOLPATH}
 960
 961 .PHONY: libraries
 962 romlib.bin: libraries
 963         ${Q}${MAKE} PLAT_DIR=${PLAT_DIR} BUILD_PLAT=${BUILD_PLAT} ENABLE_BTI=${ENABLE_BTI} ARM_ARCH_MINOR=${ARM_ARCH_MINOR} INCLUDES='${INCLUDES}' DEFINES='${DEFINES}' --no-print-directory -C ${ROMLIBPATH} all
 964
 965 cscope:
 966         @echo "  CSCOPE"
 967         ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files
 968         ${Q}cscope -b -q -k
 969
 970 help:
 971         @echo "usage: ${MAKE} [PLAT=<platform>] [OPTIONS] [TARGET]"
 972         @echo ""
 973         @echo "PLAT is used to specify which platform you wish to build."
 974         @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
 975         @echo ""
 976         @echo "platform = ${PLATFORM_LIST}"
 977         @echo ""
 978         @echo "Please refer to the User Guide for a list of all supported options."
 979         @echo "Note that the build system doesn't track dependencies for build "
 980         @echo "options. Therefore, if any of the build options are changed "
 981         @echo "from a previous build, a clean build must be performed."
 982         @echo ""
 983         @echo "Supported Targets:"
 984         @echo "  all            Build all individual bootloader binaries"
 985         @echo "  bl1            Build the BL1 binary"
 986         @echo "  bl2            Build the BL2 binary"
 987         @echo "  bl2u           Build the BL2U binary"
 988         @echo "  bl31           Build the BL31 binary"
 989         @echo "  bl32           Build the BL32 binary. If ARCH=aarch32, then "
 990         @echo "                 this builds secure payload specified by AARCH32_SP"
 991         @echo "  certificates   Build the certificates (requires 'GENERATE_COT=1')"
 992         @echo "  fip            Build the Firmware Image Package (FIP)"
 993         @echo "  fwu_fip        Build the FWU Firmware Image Package (FIP)"
 994         @echo "  checkcodebase  Check the coding style of the entire source tree"
 995         @echo "  checkpatch     Check the coding style on changes in the current"
 996         @echo "                 branch against BASE_COMMIT (default origin/master)"
 997         @echo "  clean          Clean the build for the selected platform"
 998         @echo "  cscope         Generate cscope index"
 999         @echo "  distclean      Remove all build artifacts for all platforms"
1000         @echo "  certtool       Build the Certificate generation tool"
1001         @echo "  fiptool        Build the Firmware Image Package (FIP) creation tool"
1002         @echo "  sptool         Build the Secure Partition Package creation tool"
1003         @echo "  dtbs           Build the Device Tree Blobs (if required for the platform)"
1004         @echo ""
1005         @echo "Note: most build targets require PLAT to be set to a specific platform."
1006         @echo ""
1007         @echo "example: build all targets for the FVP platform:"
1008         @echo "  CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"