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 += -Wunused -Wno-unused-parameter
 224 WARNING1 += -Wmissing-declarations
 225 WARNING1 += -Wmissing-format-attribute
 226 WARNING1 += -Wmissing-prototypes
 227 WARNING1 += -Wold-style-definition
 228 WARNING1 += -Wunused-but-set-variable
 229 WARNING1 += -Wunused-const-variable
 230
 231 WARNING2 := -Waggregate-return
 232 WARNING2 += -Wcast-align
 233 WARNING2 += -Wdisabled-optimization
 234 WARNING2 += -Wnested-externs
 235 WARNING2 += -Wshadow
 236 WARNING2 += -Wlogical-op
 237 WARNING2 += -Wmissing-field-initializers
 238 WARNING2 += -Wsign-compare
 239 WARNING2 += -Wmaybe-uninitialized
 240
 241 WARNING3 := -Wbad-function-cast
 242 WARNING3 += -Wcast-qual
 243 WARNING3 += -Wconversion
 244 WARNING3 += -Wpacked
 245 WARNING3 += -Wpadded
 246 WARNING3 += -Wpointer-arith
 247 WARNING3 += -Wredundant-decls
 248 WARNING3 += -Wswitch-default
 249 WARNING3 += -Wpacked-bitfield-compat
 250 WARNING3 += -Wvla
 251
 252 ifeq (${W},1)
 253 WARNINGS := $(WARNING1)
 254 else ifeq (${W},2)
 255 WARNINGS := $(WARNING1) $(WARNING2)
 256 else ifeq (${W},3)
 257 WARNINGS := $(WARNING1) $(WARNING2) $(WARNING3)
 258 endif
 259
 260 ifneq (${E},0)
 261 ERRORS := -Werror
 262 endif
 263
 264 CPPFLAGS                =       ${DEFINES} ${INCLUDES} ${MBEDTLS_INC} -nostdinc         \
 265                                 -Wmissing-include-dirs $(ERRORS) $(WARNINGS)
 266 ASFLAGS                 +=      $(CPPFLAGS) $(ASFLAGS_$(ARCH))                  \
 267                                 -D__ASSEMBLY__ -ffreestanding                   \
 268                                 -Wa,--fatal-warnings
 269 TF_CFLAGS               +=      $(CPPFLAGS) $(TF_CFLAGS_$(ARCH))                \
 270                                 -ffreestanding -fno-builtin -Wall -std=gnu99    \
 271                                 -Os -ffunction-sections -fdata-sections
 272
 273 GCC_V_OUTPUT            :=      $(shell $(CC) -v 2>&1)
 274
 275 ifneq ($(findstring armlink,$(notdir $(LD))),)
 276 TF_LDFLAGS              +=      --diag_error=warning --lto_level=O1
 277 TF_LDFLAGS              +=      --remove --info=unused,unusedsymbols
 278 else
 279 TF_LDFLAGS              +=      --fatal-warnings -O1
 280 TF_LDFLAGS              +=      --gc-sections
 281 endif
 282 TF_LDFLAGS              +=      $(TF_LDFLAGS_$(ARCH))
 283
 284 DTC_FLAGS               +=      -I dts -O dtb
 285 DTC_CPPFLAGS            +=      -nostdinc -Iinclude -undef -x assembler-with-cpp
 286
 287 ################################################################################
 288 # Common sources and include directories
 289 ################################################################################
 290 include lib/compiler-rt/compiler-rt.mk
 291
 292 BL_COMMON_SOURCES       +=      common/bl_common.c                      \
 293                                 common/tf_log.c                         \
 294                                 common/${ARCH}/debug.S                  \
 295                                 drivers/console/multi_console.c         \
 296                                 lib/${ARCH}/cache_helpers.S             \
 297                                 lib/${ARCH}/misc_helpers.S              \
 298                                 plat/common/plat_bl_common.c            \
 299                                 plat/common/plat_log_common.c           \
 300                                 plat/common/${ARCH}/plat_common.c       \
 301                                 plat/common/${ARCH}/platform_helpers.S  \
 302                                 ${COMPILER_RT_SRCS}
 303
 304 ifeq ($(notdir $(CC)),armclang)
 305 BL_COMMON_SOURCES       +=      lib/${ARCH}/armclang_printf.S
 306 endif
 307
 308 INCLUDES                +=      -Iinclude                               \
 309                                 -Iinclude/arch/${ARCH}                  \
 310                                 -Iinclude/lib/cpus/${ARCH}              \
 311                                 -Iinclude/lib/el3_runtime/${ARCH}       \
 312                                 ${PLAT_INCLUDES}                        \
 313                                 ${SPD_INCLUDES}
 314
 315 include common/backtrace/backtrace.mk
 316
 317 ################################################################################
 318 # Generic definitions
 319 ################################################################################
 320
 321 include ${MAKE_HELPERS_DIRECTORY}plat_helpers.mk
 322
 323 BUILD_BASE              :=      ./build
 324 BUILD_PLAT              :=      ${BUILD_BASE}/${PLAT}/${BUILD_TYPE}
 325
 326 SPDS                    :=      $(sort $(filter-out none, $(patsubst services/spd/%,%,$(wildcard services/spd/*))))
 327
 328 # Platforms providing their own TBB makefile may override this value
 329 INCLUDE_TBBR_MK         :=      1
 330
 331
 332 ################################################################################
 333 # Include SPD Makefile if one has been specified
 334 ################################################################################
 335
 336 ifneq (${SPD},none)
 337 ifeq (${ARCH},aarch32)
 338         $(error "Error: SPD is incompatible with AArch32.")
 339 endif
 340 ifdef EL3_PAYLOAD_BASE
 341         $(warning "SPD and EL3_PAYLOAD_BASE are incompatible build options.")
 342         $(warning "The SPD and its BL32 companion will be present but ignored.")
 343 endif
 344         # We expect to locate an spd.mk under the specified SPD directory
 345         SPD_MAKE        :=      $(wildcard services/spd/${SPD}/${SPD}.mk)
 346
 347         ifeq (${SPD_MAKE},)
 348                 $(error Error: No services/spd/${SPD}/${SPD}.mk located)
 349         endif
 350         $(info Including ${SPD_MAKE})
 351         include ${SPD_MAKE}
 352
 353         # If there's BL32 companion for the chosen SPD, we expect that the SPD's
 354         # Makefile would set NEED_BL32 to "yes". In this case, the build system
 355         # supports two mutually exclusive options:
 356         # * BL32 is built from source: then BL32_SOURCES must contain the list
 357         #   of source files to build BL32
 358         # * BL32 is a prebuilt binary: then BL32 must point to the image file
 359         #   that will be included in the FIP
 360         # If both BL32_SOURCES and BL32 are defined, the binary takes precedence
 361         # over the sources.
 362 endif
 363
 364 ################################################################################
 365 # Include the platform specific Makefile after the SPD Makefile (the platform
 366 # makefile may use all previous definitions in this file)
 367 ################################################################################
 368
 369 include ${PLAT_MAKEFILE_FULL}
 370
 371 $(eval $(call MAKE_PREREQ_DIR,${BUILD_PLAT}))
 372
 373 ifeq (${ARM_ARCH_MAJOR},7)
 374 include make_helpers/armv7-a-cpus.mk
 375 endif
 376
 377 ifeq ($(ENABLE_PIE),1)
 378     TF_CFLAGS           +=      -fpie
 379     TF_LDFLAGS          +=      -pie --no-dynamic-linker
 380 else
 381     PIE_FOUND           :=      $(findstring --enable-default-pie,${GCC_V_OUTPUT})
 382     ifneq ($(PIE_FOUND),)
 383         TF_CFLAGS               +=      -fno-PIE
 384     endif
 385 endif
 386
 387 # Include the CPU specific operations makefile, which provides default
 388 # values for all CPU errata workarounds and CPU specific optimisations.
 389 # This can be overridden by the platform.
 390 include lib/cpus/cpu-ops.mk
 391
 392 ifeq (${ARCH},aarch32)
 393 NEED_BL32 := yes
 394
 395 ################################################################################
 396 # Build `AARCH32_SP` as BL32 image for AArch32
 397 ################################################################################
 398 ifneq (${AARCH32_SP},none)
 399 # We expect to locate an sp.mk under the specified AARCH32_SP directory
 400 AARCH32_SP_MAKE :=      $(wildcard bl32/${AARCH32_SP}/${AARCH32_SP}.mk)
 401
 402 ifeq (${AARCH32_SP_MAKE},)
 403   $(error Error: No bl32/${AARCH32_SP}/${AARCH32_SP}.mk located)
 404 endif
 405
 406 $(info Including ${AARCH32_SP_MAKE})
 407 include ${AARCH32_SP_MAKE}
 408 endif
 409
 410 endif
 411
 412 ################################################################################
 413 # Include libc if not overridden
 414 ################################################################################
 415 ifeq (${OVERRIDE_LIBC},0)
 416 include lib/libc/libc.mk
 417 endif
 418
 419 ################################################################################
 420 # Check incompatible options
 421 ################################################################################
 422
 423 ifdef EL3_PAYLOAD_BASE
 424         ifdef PRELOADED_BL33_BASE
 425                 $(warning "PRELOADED_BL33_BASE and EL3_PAYLOAD_BASE are \
 426                 incompatible build options. EL3_PAYLOAD_BASE has priority.")
 427         endif
 428         ifneq (${GENERATE_COT},0)
 429                 $(error "GENERATE_COT and EL3_PAYLOAD_BASE are incompatible build options.")
 430         endif
 431         ifneq (${TRUSTED_BOARD_BOOT},0)
 432                 $(error "TRUSTED_BOARD_BOOT and EL3_PAYLOAD_BASE are incompatible build options.")
 433         endif
 434 endif
 435
 436 ifeq (${NEED_BL33},yes)
 437         ifdef EL3_PAYLOAD_BASE
 438                 $(warning "BL33 image is not needed when option \
 439                 BL33_PAYLOAD_BASE is used and won't be added to the FIP file.")
 440         endif
 441         ifdef PRELOADED_BL33_BASE
 442                 $(warning "BL33 image is not needed when option \
 443                 PRELOADED_BL33_BASE is used and won't be added to the FIP \
 444                 file.")
 445         endif
 446 endif
 447
 448 # When building for systems with hardware-assisted coherency, there's no need to
 449 # use USE_COHERENT_MEM. Require that USE_COHERENT_MEM must be set to 0 too.
 450 ifeq ($(HW_ASSISTED_COHERENCY)-$(USE_COHERENT_MEM),1-1)
 451 $(error USE_COHERENT_MEM cannot be enabled with HW_ASSISTED_COHERENCY)
 452 endif
 453
 454 #For now, BL2_IN_XIP_MEM is only supported when BL2_AT_EL3 is 1.
 455 ifeq ($(BL2_AT_EL3)-$(BL2_IN_XIP_MEM),0-1)
 456 $(error "BL2_IN_XIP_MEM is only supported when BL2_AT_EL3 is enabled")
 457 endif
 458
 459 # For RAS_EXTENSION, require that EAs are handled in EL3 first
 460 ifeq ($(RAS_EXTENSION),1)
 461     ifneq ($(HANDLE_EA_EL3_FIRST),1)
 462         $(error For RAS_EXTENSION, HANDLE_EA_EL3_FIRST must also be 1)
 463     endif
 464 endif
 465
 466 # When FAULT_INJECTION_SUPPORT is used, require that RAS_EXTENSION is enabled
 467 ifeq ($(FAULT_INJECTION_SUPPORT),1)
 468     ifneq ($(RAS_EXTENSION),1)
 469         $(error For FAULT_INJECTION_SUPPORT, RAS_EXTENSION must also be 1)
 470     endif
 471 endif
 472
 473 # DYN_DISABLE_AUTH can be set only when TRUSTED_BOARD_BOOT=1
 474 ifeq ($(DYN_DISABLE_AUTH), 1)
 475     ifeq (${TRUSTED_BOARD_BOOT}, 0)
 476         $(error "TRUSTED_BOARD_BOOT must be enabled for DYN_DISABLE_AUTH to be set.")
 477     endif
 478 endif
 479
 480 # If pointer authentication is used in the firmware, make sure that all the
 481 # registers associated to it are also saved and restored.
 482 # Not doing it would leak the value of the keys used by EL3 to EL1 and S-EL1.
 483 ifeq ($(ENABLE_PAUTH),1)
 484     ifeq ($(CTX_INCLUDE_PAUTH_REGS),0)
 485         $(error Pointer Authentication requires CTX_INCLUDE_PAUTH_REGS=1)
 486     endif
 487 endif
 488
 489 ifeq ($(CTX_INCLUDE_PAUTH_REGS),1)
 490     ifneq (${ARCH},aarch64)
 491         $(error CTX_INCLUDE_PAUTH_REGS requires AArch64)
 492     else
 493         $(info CTX_INCLUDE_PAUTH_REGS is an experimental feature)
 494     endif
 495 endif
 496
 497 ifeq ($(ENABLE_PAUTH),1)
 498     $(info Pointer Authentication is an experimental feature)
 499 endif
 500
 501 ifeq ($(ENABLE_BTI),1)
 502     $(info Branch Protection is an experimental feature)
 503 endif
 504
 505 ################################################################################
 506 # Process platform overrideable behaviour
 507 ################################################################################
 508
 509 # Using the ARM Trusted Firmware BL2 implies that a BL33 image also needs to be
 510 # supplied for the FIP and Certificate generation tools. This flag can be
 511 # overridden by the platform.
 512 ifdef BL2_SOURCES
 513         ifdef EL3_PAYLOAD_BASE
 514                 # If booting an EL3 payload there is no need for a BL33 image
 515                 # in the FIP file.
 516                 NEED_BL33               :=      no
 517         else
 518                 ifdef PRELOADED_BL33_BASE
 519                         # If booting a BL33 preloaded image there is no need of
 520                         # another one in the FIP file.
 521                         NEED_BL33               :=      no
 522                 else
 523                         NEED_BL33               ?=      yes
 524                 endif
 525         endif
 526 endif
 527
 528 # If SCP_BL2 is given, we always want FIP to include it.
 529 ifdef SCP_BL2
 530         NEED_SCP_BL2            :=      yes
 531 endif
 532
 533 # For AArch32, BL31 is not currently supported.
 534 ifneq (${ARCH},aarch32)
 535     ifdef BL31_SOURCES
 536         # When booting an EL3 payload, there is no need to compile the BL31 image nor
 537         # put it in the FIP.
 538         ifndef EL3_PAYLOAD_BASE
 539             NEED_BL31 := yes
 540         endif
 541     endif
 542 endif
 543
 544 # Process TBB related flags
 545 ifneq (${GENERATE_COT},0)
 546         # Common cert_create options
 547         ifneq (${CREATE_KEYS},0)
 548                 $(eval CRT_ARGS += -n)
 549                 $(eval FWU_CRT_ARGS += -n)
 550                 ifneq (${SAVE_KEYS},0)
 551                         $(eval CRT_ARGS += -k)
 552                         $(eval FWU_CRT_ARGS += -k)
 553                 endif
 554         endif
 555         # Include TBBR makefile (unless the platform indicates otherwise)
 556         ifeq (${INCLUDE_TBBR_MK},1)
 557                 include make_helpers/tbbr/tbbr_tools.mk
 558         endif
 559 endif
 560
 561 ifneq (${FIP_ALIGN},0)
 562 FIP_ARGS += --align ${FIP_ALIGN}
 563 endif
 564
 565 ################################################################################
 566 # Include libraries' Makefile that are used in all BL
 567 ################################################################################
 568
 569 include lib/stack_protector/stack_protector.mk
 570
 571 ################################################################################
 572 # Auxiliary tools (fiptool, cert_create, etc)
 573 ################################################################################
 574
 575 # Variables for use with Certificate Generation Tool
 576 CRTTOOLPATH             ?=      tools/cert_create
 577 CRTTOOL                 ?=      ${CRTTOOLPATH}/cert_create${BIN_EXT}
 578
 579 # Variables for use with Firmware Image Package
 580 FIPTOOLPATH             ?=      tools/fiptool
 581 FIPTOOL                 ?=      ${FIPTOOLPATH}/fiptool${BIN_EXT}
 582
 583 # Variables for use with sptool
 584 SPTOOLPATH              ?=      tools/sptool
 585 SPTOOL                  ?=      ${SPTOOLPATH}/sptool${BIN_EXT}
 586
 587 # Variables for use with ROMLIB
 588 ROMLIBPATH              ?=      lib/romlib
 589
 590 ################################################################################
 591 # Include BL specific makefiles
 592 ################################################################################
 593 ifdef BL1_SOURCES
 594 NEED_BL1 := yes
 595 include bl1/bl1.mk
 596 endif
 597
 598 ifdef BL2_SOURCES
 599 NEED_BL2 := yes
 600 include bl2/bl2.mk
 601 endif
 602
 603 ifdef BL2U_SOURCES
 604 NEED_BL2U := yes
 605 include bl2u/bl2u.mk
 606 endif
 607
 608 ifeq (${NEED_BL31},yes)
 609 ifdef BL31_SOURCES
 610 include bl31/bl31.mk
 611 endif
 612 endif
 613
 614 ifdef FDT_SOURCES
 615 NEED_FDT := yes
 616 endif
 617
 618 ################################################################################
 619 # Build options checks
 620 ################################################################################
 621
 622 $(eval $(call assert_boolean,COLD_BOOT_SINGLE_CPU))
 623 $(eval $(call assert_boolean,CREATE_KEYS))
 624 $(eval $(call assert_boolean,CTX_INCLUDE_AARCH32_REGS))
 625 $(eval $(call assert_boolean,CTX_INCLUDE_FPREGS))
 626 $(eval $(call assert_boolean,CTX_INCLUDE_PAUTH_REGS))
 627 $(eval $(call assert_boolean,DEBUG))
 628 $(eval $(call assert_boolean,DYN_DISABLE_AUTH))
 629 $(eval $(call assert_boolean,EL3_EXCEPTION_HANDLING))
 630 $(eval $(call assert_boolean,ENABLE_AMU))
 631 $(eval $(call assert_boolean,ENABLE_ASSERTIONS))
 632 $(eval $(call assert_boolean,ENABLE_MPAM_FOR_LOWER_ELS))
 633 $(eval $(call assert_boolean,ENABLE_PIE))
 634 $(eval $(call assert_boolean,ENABLE_PMF))
 635 $(eval $(call assert_boolean,ENABLE_PSCI_STAT))
 636 $(eval $(call assert_boolean,ENABLE_RUNTIME_INSTRUMENTATION))
 637 $(eval $(call assert_boolean,ENABLE_SPE_FOR_LOWER_ELS))
 638 $(eval $(call assert_boolean,ENABLE_SPM))
 639 $(eval $(call assert_boolean,ENABLE_SVE_FOR_NS))
 640 $(eval $(call assert_boolean,ERROR_DEPRECATED))
 641 $(eval $(call assert_boolean,FAULT_INJECTION_SUPPORT))
 642 $(eval $(call assert_boolean,GENERATE_COT))
 643 $(eval $(call assert_boolean,GICV2_G0_FOR_EL3))
 644 $(eval $(call assert_boolean,HANDLE_EA_EL3_FIRST))
 645 $(eval $(call assert_boolean,HW_ASSISTED_COHERENCY))
 646 $(eval $(call assert_boolean,MULTI_CONSOLE_API))
 647 $(eval $(call assert_boolean,NS_TIMER_SWITCH))
 648 $(eval $(call assert_boolean,OVERRIDE_LIBC))
 649 $(eval $(call assert_boolean,PL011_GENERIC_UART))
 650 $(eval $(call assert_boolean,PROGRAMMABLE_RESET_ADDRESS))
 651 $(eval $(call assert_boolean,PSCI_EXTENDED_STATE_ID))
 652 $(eval $(call assert_boolean,RAS_EXTENSION))
 653 $(eval $(call assert_boolean,RESET_TO_BL31))
 654 $(eval $(call assert_boolean,SAVE_KEYS))
 655 $(eval $(call assert_boolean,SEPARATE_CODE_AND_RODATA))
 656 $(eval $(call assert_boolean,SPIN_ON_BL1_EXIT))
 657 $(eval $(call assert_boolean,SPM_MM))
 658 $(eval $(call assert_boolean,TRUSTED_BOARD_BOOT))
 659 $(eval $(call assert_boolean,USE_COHERENT_MEM))
 660 $(eval $(call assert_boolean,USE_ROMLIB))
 661 $(eval $(call assert_boolean,USE_TBBR_DEFS))
 662 $(eval $(call assert_boolean,WARMBOOT_ENABLE_DCACHE_EARLY))
 663 $(eval $(call assert_boolean,BL2_AT_EL3))
 664 $(eval $(call assert_boolean,BL2_IN_XIP_MEM))
 665
 666 $(eval $(call assert_numeric,ARM_ARCH_MAJOR))
 667 $(eval $(call assert_numeric,ARM_ARCH_MINOR))
 668 $(eval $(call assert_numeric,BRANCH_PROTECTION))
 669
 670 ################################################################################
 671 # Add definitions to the cpp preprocessor based on the current build options.
 672 # This is done after including the platform specific makefile to allow the
 673 # platform to overwrite the default options
 674 ################################################################################
 675
 676 $(eval $(call add_define,ARM_ARCH_MAJOR))
 677 $(eval $(call add_define,ARM_ARCH_MINOR))
 678 $(eval $(call add_define,COLD_BOOT_SINGLE_CPU))
 679 $(eval $(call add_define,CTX_INCLUDE_AARCH32_REGS))
 680 $(eval $(call add_define,CTX_INCLUDE_FPREGS))
 681 $(eval $(call add_define,CTX_INCLUDE_PAUTH_REGS))
 682 $(eval $(call add_define,EL3_EXCEPTION_HANDLING))
 683 $(eval $(call add_define,ENABLE_AMU))
 684 $(eval $(call add_define,ENABLE_ASSERTIONS))
 685 $(eval $(call add_define,ENABLE_BTI))
 686 $(eval $(call add_define,ENABLE_MPAM_FOR_LOWER_ELS))
 687 $(eval $(call add_define,ENABLE_PAUTH))
 688 $(eval $(call add_define,ENABLE_PIE))
 689 $(eval $(call add_define,ENABLE_PMF))
 690 $(eval $(call add_define,ENABLE_PSCI_STAT))
 691 $(eval $(call add_define,ENABLE_RUNTIME_INSTRUMENTATION))
 692 $(eval $(call add_define,ENABLE_SPE_FOR_LOWER_ELS))
 693 $(eval $(call add_define,ENABLE_SPM))
 694 $(eval $(call add_define,ENABLE_SVE_FOR_NS))
 695 $(eval $(call add_define,ERROR_DEPRECATED))
 696 $(eval $(call add_define,FAULT_INJECTION_SUPPORT))
 697 $(eval $(call add_define,GICV2_G0_FOR_EL3))
 698 $(eval $(call add_define,HANDLE_EA_EL3_FIRST))
 699 $(eval $(call add_define,HW_ASSISTED_COHERENCY))
 700 $(eval $(call add_define,LOG_LEVEL))
 701 $(eval $(call add_define,MULTI_CONSOLE_API))
 702 $(eval $(call add_define,NS_TIMER_SWITCH))
 703 $(eval $(call add_define,PL011_GENERIC_UART))
 704 $(eval $(call add_define,PLAT_${PLAT}))
 705 $(eval $(call add_define,PROGRAMMABLE_RESET_ADDRESS))
 706 $(eval $(call add_define,PSCI_EXTENDED_STATE_ID))
 707 $(eval $(call add_define,RAS_EXTENSION))
 708 $(eval $(call add_define,RESET_TO_BL31))
 709 $(eval $(call add_define,SEPARATE_CODE_AND_RODATA))
 710 $(eval $(call add_define,RECLAIM_INIT_CODE))
 711 $(eval $(call add_define,SPD_${SPD}))
 712 $(eval $(call add_define,SPIN_ON_BL1_EXIT))
 713 $(eval $(call add_define,SPM_MM))
 714 $(eval $(call add_define,TRUSTED_BOARD_BOOT))
 715 $(eval $(call add_define,USE_COHERENT_MEM))
 716 $(eval $(call add_define,USE_ROMLIB))
 717 $(eval $(call add_define,USE_TBBR_DEFS))
 718 $(eval $(call add_define,WARMBOOT_ENABLE_DCACHE_EARLY))
 719 $(eval $(call add_define,BL2_AT_EL3))
 720 $(eval $(call add_define,BL2_IN_XIP_MEM))
 721
 722 # Define the EL3_PAYLOAD_BASE flag only if it is provided.
 723 ifdef EL3_PAYLOAD_BASE
 724         $(eval $(call add_define,EL3_PAYLOAD_BASE))
 725 else
 726         # Define the PRELOADED_BL33_BASE flag only if it is provided and
 727         # EL3_PAYLOAD_BASE is not defined, as it has priority.
 728         ifdef PRELOADED_BL33_BASE
 729                 $(eval $(call add_define,PRELOADED_BL33_BASE))
 730         endif
 731 endif
 732 # Define the AARCH32/AARCH64 flag based on the ARCH flag
 733 ifeq (${ARCH},aarch32)
 734         $(eval $(call add_define,AARCH32))
 735 else
 736         $(eval $(call add_define,AARCH64))
 737 endif
 738
 739 # Define the DYN_DISABLE_AUTH flag only if set.
 740 ifeq (${DYN_DISABLE_AUTH},1)
 741 $(eval $(call add_define,DYN_DISABLE_AUTH))
 742 endif
 743
 744 ifneq ($(findstring armlink,$(notdir $(LD))),)
 745 $(eval $(call add_define,USE_ARM_LINK))
 746 endif
 747
 748 ################################################################################
 749 # Build targets
 750 ################################################################################
 751
 752 .PHONY: all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool sptool fip fwu_fip certtool dtbs
 753 .SUFFIXES:
 754
 755 all: msg_start
 756
 757 msg_start:
 758         @echo "Building ${PLAT}"
 759
 760 # Check if deprecated declarations and cpp warnings should be treated as error or not.
 761 ifeq (${ERROR_DEPRECATED},0)
 762 ifneq ($(findstring clang,$(notdir $(CC))),)
 763     CPPFLAGS            +=      -Wno-error=deprecated-declarations
 764 else
 765     CPPFLAGS            +=      -Wno-error=deprecated-declarations -Wno-error=cpp
 766 endif
 767 endif
 768
 769 $(eval $(call MAKE_LIB_DIRS))
 770 $(eval $(call MAKE_LIB,c))
 771
 772 # Expand build macros for the different images
 773 ifeq (${NEED_BL1},yes)
 774 $(eval $(call MAKE_BL,1))
 775 endif
 776
 777 ifeq (${NEED_BL2},yes)
 778 ifeq (${BL2_AT_EL3}, 0)
 779 FIP_BL2_ARGS := tb-fw
 780 endif
 781
 782 $(if ${BL2}, $(eval $(call TOOL_ADD_IMG,bl2,--${FIP_BL2_ARGS})),\
 783         $(eval $(call MAKE_BL,2,${FIP_BL2_ARGS})))
 784 endif
 785
 786 ifeq (${NEED_SCP_BL2},yes)
 787 $(eval $(call TOOL_ADD_IMG,scp_bl2,--scp-fw))
 788 endif
 789
 790 ifeq (${NEED_BL31},yes)
 791 BL31_SOURCES += ${SPD_SOURCES}
 792 $(if ${BL31}, $(eval $(call TOOL_ADD_IMG,bl31,--soc-fw)),\
 793         $(eval $(call MAKE_BL,31,soc-fw)))
 794 endif
 795
 796 # If a BL32 image is needed but neither BL32 nor BL32_SOURCES is defined, the
 797 # build system will call TOOL_ADD_IMG to print a warning message and abort the
 798 # process. Note that the dependency on BL32 applies to the FIP only.
 799 ifeq (${NEED_BL32},yes)
 800
 801 BUILD_BL32 := $(if $(BL32),,$(if $(BL32_SOURCES),1))
 802
 803 $(if ${BUILD_BL32}, $(eval $(call MAKE_BL,32,tos-fw)),\
 804         $(eval $(call TOOL_ADD_IMG,bl32,--tos-fw)))
 805 endif
 806
 807 # Add the BL33 image if required by the platform
 808 ifeq (${NEED_BL33},yes)
 809 $(eval $(call TOOL_ADD_IMG,bl33,--nt-fw))
 810 endif
 811
 812 ifeq (${NEED_BL2U},yes)
 813 $(if ${BL2U}, $(eval $(call TOOL_ADD_IMG,bl2u,--ap-fwu-cfg,FWU_)),\
 814         $(eval $(call MAKE_BL,2u,ap-fwu-cfg,FWU_)))
 815 endif
 816
 817 # Expand build macros for the different images
 818 ifeq (${NEED_FDT},yes)
 819     $(eval $(call MAKE_DTBS,$(BUILD_PLAT)/fdts,$(FDT_SOURCES)))
 820 endif
 821
 822 locate-checkpatch:
 823 ifndef CHECKPATCH
 824         $(error "Please set CHECKPATCH to point to the Linux checkpatch.pl file, eg: CHECKPATCH=../linux/scripts/checkpatch.pl")
 825 else
 826 ifeq (,$(wildcard ${CHECKPATCH}))
 827         $(error "The file CHECKPATCH points to cannot be found, use eg: CHECKPATCH=../linux/scripts/checkpatch.pl")
 828 endif
 829 endif
 830
 831 clean:
 832         @echo "  CLEAN"
 833         $(call SHELL_REMOVE_DIR,${BUILD_PLAT})
 834         ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
 835         ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
 836         ${Q}${MAKE} --no-print-directory -C ${ROMLIBPATH} clean
 837
 838 realclean distclean:
 839         @echo "  REALCLEAN"
 840         $(call SHELL_REMOVE_DIR,${BUILD_BASE})
 841         $(call SHELL_DELETE_ALL, ${CURDIR}/cscope.*)
 842         ${Q}${MAKE} --no-print-directory -C ${FIPTOOLPATH} clean
 843         ${Q}${MAKE} --no-print-directory -C ${SPTOOLPATH} clean
 844         ${Q}${MAKE} PLAT=${PLAT} --no-print-directory -C ${CRTTOOLPATH} clean
 845         ${Q}${MAKE} --no-print-directory -C ${ROMLIBPATH} clean
 846
 847 checkcodebase:          locate-checkpatch
 848         @echo "  CHECKING STYLE"
 849         @if test -d .git ; then                                         \
 850                 git ls-files | grep -E -v 'libfdt|libc|docs|\.rst' |    \
 851                 while read GIT_FILE ;                                   \
 852                 do ${CHECKPATCH} ${CHECKCODE_ARGS} -f $$GIT_FILE ;      \
 853                 done ;                                                  \
 854         else                                                            \
 855                  find . -type f -not -iwholename "*.git*"               \
 856                  -not -iwholename "*build*"                             \
 857                  -not -iwholename "*libfdt*"                            \
 858                  -not -iwholename "*libc*"                              \
 859                  -not -iwholename "*docs*"                              \
 860                  -not -iwholename "*.rst"                               \
 861                  -exec ${CHECKPATCH} ${CHECKCODE_ARGS} -f {} \; ;       \
 862         fi
 863
 864 checkpatch:             locate-checkpatch
 865         @echo "  CHECKING STYLE"
 866         @if test -n "${CHECKPATCH_OPTS}"; then                          \
 867                 echo "    with ${CHECKPATCH_OPTS} option(s)";           \
 868         fi
 869         ${Q}COMMON_COMMIT=$$(git merge-base HEAD ${BASE_COMMIT});       \
 870         for commit in `git rev-list $$COMMON_COMMIT..HEAD`; do          \
 871                 printf "\n[*] Checking style of '$$commit'\n\n";        \
 872                 git log --format=email "$$commit~..$$commit"            \
 873                         -- ${CHECK_PATHS} |                             \
 874                         ${CHECKPATCH} ${CHECKPATCH_OPTS} - || true;     \
 875                 git diff --format=email "$$commit~..$$commit"           \
 876                         -- ${CHECK_PATHS} |                             \
 877                         ${CHECKPATCH}  ${CHECKPATCH_OPTS} - || true;    \
 878         done
 879
 880 certtool: ${CRTTOOL}
 881
 882 .PHONY: ${CRTTOOL}
 883 ${CRTTOOL}:
 884         ${Q}${MAKE} PLAT=${PLAT} USE_TBBR_DEFS=${USE_TBBR_DEFS} --no-print-directory -C ${CRTTOOLPATH}
 885         @${ECHO_BLANK_LINE}
 886         @echo "Built $@ successfully"
 887         @${ECHO_BLANK_LINE}
 888
 889 ifneq (${GENERATE_COT},0)
 890 certificates: ${CRT_DEPS} ${CRTTOOL}
 891         ${Q}${CRTTOOL} ${CRT_ARGS}
 892         @${ECHO_BLANK_LINE}
 893         @echo "Built $@ successfully"
 894         @echo "Certificates can be found in ${BUILD_PLAT}"
 895         @${ECHO_BLANK_LINE}
 896 endif
 897
 898 ${BUILD_PLAT}/${FIP_NAME}: ${FIP_DEPS} ${FIPTOOL}
 899         ${Q}${FIPTOOL} create ${FIP_ARGS} $@
 900         ${Q}${FIPTOOL} info $@
 901         @${ECHO_BLANK_LINE}
 902         @echo "Built $@ successfully"
 903         @${ECHO_BLANK_LINE}
 904
 905 ifneq (${GENERATE_COT},0)
 906 fwu_certificates: ${FWU_CRT_DEPS} ${CRTTOOL}
 907         ${Q}${CRTTOOL} ${FWU_CRT_ARGS}
 908         @${ECHO_BLANK_LINE}
 909         @echo "Built $@ successfully"
 910         @echo "FWU certificates can be found in ${BUILD_PLAT}"
 911         @${ECHO_BLANK_LINE}
 912 endif
 913
 914 ${BUILD_PLAT}/${FWU_FIP_NAME}: ${FWU_FIP_DEPS} ${FIPTOOL}
 915         ${Q}${FIPTOOL} create ${FWU_FIP_ARGS} $@
 916         ${Q}${FIPTOOL} info $@
 917         @${ECHO_BLANK_LINE}
 918         @echo "Built $@ successfully"
 919         @${ECHO_BLANK_LINE}
 920
 921 fiptool: ${FIPTOOL}
 922 fip: ${BUILD_PLAT}/${FIP_NAME}
 923 fwu_fip: ${BUILD_PLAT}/${FWU_FIP_NAME}
 924
 925 .PHONY: ${FIPTOOL}
 926 ${FIPTOOL}:
 927         ${Q}${MAKE} CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" --no-print-directory -C ${FIPTOOLPATH}
 928
 929 sptool: ${SPTOOL}
 930 .PHONY: ${SPTOOL}
 931 ${SPTOOL}:
 932         ${Q}${MAKE} CPPFLAGS="-DVERSION='\"${VERSION_STRING}\"'" --no-print-directory -C ${SPTOOLPATH}
 933
 934 .PHONY: libraries
 935 romlib.bin: libraries
 936         ${Q}${MAKE} PLAT_DIR=${PLAT_DIR} BUILD_PLAT=${BUILD_PLAT} INCLUDES='${INCLUDES}' DEFINES='${DEFINES}' --no-print-directory -C ${ROMLIBPATH} all
 937
 938 cscope:
 939         @echo "  CSCOPE"
 940         ${Q}find ${CURDIR} -name "*.[chsS]" > cscope.files
 941         ${Q}cscope -b -q -k
 942
 943 help:
 944         @echo "usage: ${MAKE} PLAT=<${PLATFORM_LIST}> [OPTIONS] [TARGET]"
 945         @echo ""
 946         @echo "PLAT is used to specify which platform you wish to build."
 947         @echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
 948         @echo ""
 949         @echo "Please refer to the User Guide for a list of all supported options."
 950         @echo "Note that the build system doesn't track dependencies for build "
 951         @echo "options. Therefore, if any of the build options are changed "
 952         @echo "from a previous build, a clean build must be performed."
 953         @echo ""
 954         @echo "Supported Targets:"
 955         @echo "  all            Build all individual bootloader binaries"
 956         @echo "  bl1            Build the BL1 binary"
 957         @echo "  bl2            Build the BL2 binary"
 958         @echo "  bl2u           Build the BL2U binary"
 959         @echo "  bl31           Build the BL31 binary"
 960         @echo "  bl32           Build the BL32 binary. If ARCH=aarch32, then "
 961         @echo "                 this builds secure payload specified by AARCH32_SP"
 962         @echo "  certificates   Build the certificates (requires 'GENERATE_COT=1')"
 963         @echo "  fip            Build the Firmware Image Package (FIP)"
 964         @echo "  fwu_fip        Build the FWU Firmware Image Package (FIP)"
 965         @echo "  checkcodebase  Check the coding style of the entire source tree"
 966         @echo "  checkpatch     Check the coding style on changes in the current"
 967         @echo "                 branch against BASE_COMMIT (default origin/master)"
 968         @echo "  clean          Clean the build for the selected platform"
 969         @echo "  cscope         Generate cscope index"
 970         @echo "  distclean      Remove all build artifacts for all platforms"
 971         @echo "  certtool       Build the Certificate generation tool"
 972         @echo "  fiptool        Build the Firmware Image Package (FIP) creation tool"
 973         @echo "  sptool         Build the Secure Partition Package creation tool"
 974         @echo "  dtbs           Build the Device Tree Blobs (if required for the platform)"
 975         @echo ""
 976         @echo "Note: most build targets require PLAT to be set to a specific platform."
 977         @echo ""
 978         @echo "example: build all targets for the FVP platform:"
 979         @echo "  CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"