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