xref: /optee_os/mk/config.mk (revision 4c4212e9eef66fb249aa816ecba051be908dae4b)
1120c43adSJerome Forissier# Default configuration values for OP-TEE core (all platforms).
2120c43adSJerome Forissier#
3120c43adSJerome Forissier# Platform-specific overrides are in core/arch/arm32/plat-*/conf.mk.
4120c43adSJerome Forissier# Some subsystem-specific defaults are not here but rather in */sub.mk.
5120c43adSJerome Forissier#
6120c43adSJerome Forissier# Configuration values may be assigned from multiple sources.
7120c43adSJerome Forissier# From higher to lower priority:
8120c43adSJerome Forissier#
9120c43adSJerome Forissier#   1. Make arguments ('make CFG_FOO=bar...')
10120c43adSJerome Forissier#   2. The file specified by $(CFG_OPTEE_CONFIG) (if defined)
11120c43adSJerome Forissier#   3. The environment ('CFG_FOO=bar make...')
12120c43adSJerome Forissier#   4. The platform-specific configuration file: core/arch/arm32/plat-*/conf.mk
13120c43adSJerome Forissier#   5. This file
14120c43adSJerome Forissier#   6. Subsystem-specific makefiles (*/sub.mk)
15120c43adSJerome Forissier#
16b5569a68SPascal Brand# Actual values used during the build are output to $(out-dir)/conf.mk
17120c43adSJerome Forissier# (CFG_* variables only).
18120c43adSJerome Forissier
19a75f2e14SJerome Forissier# Cross-compiler prefix and suffix
20a75f2e14SJerome ForissierCROSS_COMPILE ?= arm-linux-gnueabihf-
21c042fbefSJerome ForissierCROSS_COMPILE32 ?= $(CROSS_COMPILE)
22c042fbefSJerome ForissierCROSS_COMPILE64 ?= aarch64-linux-gnu-
23a75f2e14SJerome ForissierCOMPILER ?= gcc
24a75f2e14SJerome Forissier
25b09cddcaSJerome Forissier# For convenience
26b09cddcaSJerome Forissierifdef CFLAGS
27b09cddcaSJerome ForissierCFLAGS32 ?= $(CFLAGS)
28b09cddcaSJerome ForissierCFLAGS64 ?= $(CFLAGS)
29b09cddcaSJerome Forissierendif
30b09cddcaSJerome Forissier
31120c43adSJerome Forissier# Compiler warning level.
32120c43adSJerome Forissier# Supported values: undefined, 1, 2 and 3. 3 gives more warnings.
33b0104773SPascal BrandWARNS ?= 3
34b0104773SPascal Brand
35b4faf480SDick Olsson# Path to the Python interpreter used by the build system.
36b4faf480SDick Olsson# This variable is set to the default python3 interpreter in the user's
37b4faf480SDick Olsson# path. But build environments that require more explicit control can
38b4faf480SDick Olsson# set the path to a specific interpreter through this variable.
39b4faf480SDick OlssonPYTHON3 ?= python3
40b4faf480SDick Olsson
413f17b838SEtienne Carriere# Define DEBUG=1 to compile without optimization (forces -O0)
42b0104773SPascal Brand# DEBUG=1
430e6830baSEtienne Carriereifeq ($(DEBUG),1)
440e6830baSEtienne Carriere# For backwards compatibility
450e6830baSEtienne Carriere$(call force,CFG_CC_OPT_LEVEL,0)
460e6830baSEtienne Carriere$(call force,CFG_DEBUG_INFO,y)
470e6830baSEtienne Carriereendif
480e6830baSEtienne Carriere
490e6830baSEtienne Carriere# CFG_CC_OPT_LEVEL sets compiler optimization level passed with -O directive.
500e6830baSEtienne Carriere# Optimize for size by default, usually gives good performance too.
510e6830baSEtienne CarriereCFG_CC_OPT_LEVEL ?= s
520e6830baSEtienne Carriere
530e6830baSEtienne Carriere# Enabling CFG_DEBUG_INFO makes debug information embedded in core.
540e6830baSEtienne CarriereCFG_DEBUG_INFO ?= y
55b0104773SPascal Brand
564ec2358eSJerome Forissier# If y, enable debug features of the TEE core (assertions and lock checks
574ec2358eSJerome Forissier# are enabled, panic and assert messages are more verbose, data and prefetch
584ec2358eSJerome Forissier# aborts show a stack dump). When disabled, the NDEBUG directive is defined
594ec2358eSJerome Forissier# so assertions are disabled.
604ec2358eSJerome ForissierCFG_TEE_CORE_DEBUG ?= y
61b0104773SPascal Brand
623f58e4ecSOvidiu Mihalachi# Log levels for the TEE core. Defines which core messages are displayed
633f58e4ecSOvidiu Mihalachi# on the secure console. Disabling core log (level set to 0) also disables
643f58e4ecSOvidiu Mihalachi# logs from the TAs.
6509ca9f8bSJerome Forissier# 0: none
6609ca9f8bSJerome Forissier# 1: error
6714c68b3cSJerome Forissier# 2: error + info
6814c68b3cSJerome Forissier# 3: error + info + debug
6914c68b3cSJerome Forissier# 4: error + info + debug + flow
7014c68b3cSJerome ForissierCFG_TEE_CORE_LOG_LEVEL ?= 2
713f58e4ecSOvidiu Mihalachi
723f58e4ecSOvidiu Mihalachi# TA log level
733f58e4ecSOvidiu Mihalachi# If user-mode library libutils.a is built with CFG_TEE_TA_LOG_LEVEL=0,
743f58e4ecSOvidiu Mihalachi# TA tracing is disabled regardless of the value of CFG_TEE_TA_LOG_LEVEL
753f58e4ecSOvidiu Mihalachi# when the TA is built.
76e0042c88SPascal BrandCFG_TEE_TA_LOG_LEVEL ?= 1
77b0104773SPascal Brand
787c876f12SPascal Brand# TA enablement
797c876f12SPascal Brand# When defined to "y", TA traces are output according to
807c876f12SPascal Brand# CFG_TEE_TA_LOG_LEVEL. Otherwise, they are not output at all
817c876f12SPascal BrandCFG_TEE_CORE_TA_TRACE ?= y
82b0104773SPascal Brand
838c8e1441SJerome Forissier# If y, enable the memory leak detection feature in the bget memory allocator.
848c8e1441SJerome Forissier# When this feature is enabled, calling mdbg_check(1) will print a list of all
858c8e1441SJerome Forissier# the currently allocated buffers and the location of the allocation (file and
868c8e1441SJerome Forissier# line number).
878c8e1441SJerome Forissier# Note: make sure the log level is high enough for the messages to show up on
888c8e1441SJerome Forissier# the secure console! For instance:
898c8e1441SJerome Forissier# - To debug user-mode (TA) allocations: build OP-TEE *and* the TA with:
908c8e1441SJerome Forissier#   $ make CFG_TEE_TA_MALLOC_DEBUG=y CFG_TEE_TA_LOG_LEVEL=3
918c8e1441SJerome Forissier# - To debug TEE core allocations: build OP-TEE with:
928c8e1441SJerome Forissier#   $ make CFG_TEE_CORE_MALLOC_DEBUG=y CFG_TEE_CORE_LOG_LEVEL=3
930fcbddd4SSY ChiuCFG_TEE_CORE_MALLOC_DEBUG ?= n
940fcbddd4SSY ChiuCFG_TEE_TA_MALLOC_DEBUG ?= n
95c2ce4186SJens Wiklander# Prints an error message and dumps the stack on failed memory allocations
96c2ce4186SJens Wiklander# using malloc() and friends.
97c2ce4186SJens WiklanderCFG_CORE_DUMP_OOM ?= $(CFG_TEE_CORE_MALLOC_DEBUG)
980fcbddd4SSY Chiu
992bfab756SJerome Forissier# Mask to select which messages are prefixed with long debugging information
10064fad262SVolodymyr Babchuk# (severity, core ID, thread ID, component name, function name, line number)
10164fad262SVolodymyr Babchuk# based on the message level. If BIT(level) is set, the long prefix is shown.
1022bfab756SJerome Forissier# Otherwise a short prefix is used (severity and component name only).
103f4aa5b11SJerome Forissier# Levels: 0=none 1=error 2=info 3=debug 4=flow
1042bfab756SJerome ForissierCFG_MSG_LONG_PREFIX_MASK ?= 0x1a
105f4aa5b11SJerome Forissier
106120c43adSJerome Forissier# PRNG configuration
1077018ae01SSY Chiu# If CFG_WITH_SOFTWARE_PRNG is enabled, crypto provider provided
1087018ae01SSY Chiu# software PRNG implementation is used.
109391a3854SAndrew Davis# Otherwise, you need to implement hw_get_random_bytes() for your platform
1107018ae01SSY ChiuCFG_WITH_SOFTWARE_PRNG ?= y
111120c43adSJerome Forissier
112120c43adSJerome Forissier# Number of threads
113120c43adSJerome ForissierCFG_NUM_THREADS ?= 2
114ab35d7adSCedric Chaumont
115ab35d7adSCedric Chaumont# API implementation version
116ab35d7adSCedric ChaumontCFG_TEE_API_VERSION ?= GPD-1.1-dev
117ab35d7adSCedric Chaumont
118ab35d7adSCedric Chaumont# Implementation description (implementation-dependent)
119ab35d7adSCedric ChaumontCFG_TEE_IMPL_DESCR ?= OPTEE
120ab35d7adSCedric Chaumont
12129cff5cfSJerome Forissier# Should OPTEE_SMC_CALL_GET_OS_REVISION return a build identifier to Normal
12229cff5cfSJerome Forissier# World?
12329cff5cfSJerome ForissierCFG_OS_REV_REPORTS_GIT_SHA1 ?= y
12429cff5cfSJerome Forissier
12535c507f2SJerome Forissier# The following values are not extracted from the "git describe" output because
12635c507f2SJerome Forissier# we might be outside of a Git environment, or the tree may have been cloned
12735c507f2SJerome Forissier# with limited depth not including any tag, so there is really no guarantee
12835c507f2SJerome Forissier# that TEE_IMPL_VERSION contains the major and minor revision numbers.
129a83aec29SJerome ForissierCFG_OPTEE_REVISION_MAJOR ?= 3
130afacf356SJerome ForissierCFG_OPTEE_REVISION_MINOR ?= 19
1313bfa418bSJerome ForissierCFG_OPTEE_REVISION_EXTRA ?=
132ab35d7adSCedric Chaumont
13348ca43e8SJerome Forissier# Trusted OS implementation version
13448ca43e8SJerome ForissierTEE_IMPL_VERSION ?= $(shell git describe --always --dirty=-dev 2>/dev/null || \
1353bfa418bSJerome Forissier		      echo Unknown_$(CFG_OPTEE_REVISION_MAJOR).$(CFG_OPTEE_REVISION_MINOR))$(CFG_OPTEE_REVISION_EXTRA)
13648ca43e8SJerome Forissierifeq ($(CFG_OS_REV_REPORTS_GIT_SHA1),y)
13748ca43e8SJerome ForissierTEE_IMPL_GIT_SHA1 := 0x$(shell git rev-parse --short=8 HEAD 2>/dev/null || echo 0)
13848ca43e8SJerome Forissierelse
13948ca43e8SJerome ForissierTEE_IMPL_GIT_SHA1 := 0x0
14048ca43e8SJerome Forissierendif
14148ca43e8SJerome Forissier
142ab35d7adSCedric Chaumont# Trusted OS implementation manufacturer name
143ab35d7adSCedric ChaumontCFG_TEE_MANUFACTURER ?= LINARO
144ab35d7adSCedric Chaumont
145ab35d7adSCedric Chaumont# Trusted firmware version
146ab35d7adSCedric ChaumontCFG_TEE_FW_IMPL_VERSION ?= FW_IMPL_UNDEF
147ab35d7adSCedric Chaumont
148ab35d7adSCedric Chaumont# Trusted OS implementation manufacturer name
149ab35d7adSCedric ChaumontCFG_TEE_FW_MANUFACTURER ?= FW_MAN_UNDEF
150ab35d7adSCedric Chaumont
151b44708c1SJerome Forissier# Rich Execution Environment (REE) file system support: normal world OS
152b44708c1SJerome Forissier# provides the actual storage.
153b44708c1SJerome Forissier# This is the default FS when enabled (i.e., the one used when
154b44708c1SJerome Forissier# TEE_STORAGE_PRIVATE is passed to the trusted storage API)
155b44708c1SJerome ForissierCFG_REE_FS ?= y
156bc420748SJens Wiklander
15788e6e089SJerome Forissier# RPMB file system support
15888e6e089SJerome ForissierCFG_RPMB_FS ?= n
15988e6e089SJerome Forissier
160f5411aafSJudy Wang# Enable roll-back protection of REE file system using RPMB.
161f5411aafSJudy Wang# Roll-back protection only works if CFG_RPMB_FS = y.
162f5411aafSJudy WangCFG_REE_FS_INTEGRITY_RPMB ?= $(CFG_RPMB_FS)
163f5411aafSJudy Wang$(eval $(call cfg-depends-all,CFG_REE_FS_INTEGRITY_RPMB,CFG_RPMB_FS))
164f5411aafSJudy Wang
16588e6e089SJerome Forissier# Device identifier used when CFG_RPMB_FS = y.
16688e6e089SJerome Forissier# The exact meaning of this value is platform-dependent. On Linux, the
16788e6e089SJerome Forissier# tee-supplicant process will open /dev/mmcblk<id>rpmb
16888e6e089SJerome ForissierCFG_RPMB_FS_DEV_ID ?= 0
16988e6e089SJerome Forissier
1707d97159bSManuel Huber# This config variable determines the number of entries read in from RPMB at
1717d97159bSManuel Huber# once whenever a function traverses the RPMB FS. Increasing the default value
1727d97159bSManuel Huber# has the following consequences:
1737d97159bSManuel Huber# - More memory required on heap. A single FAT entry currently has a size of
1747d97159bSManuel Huber#   256 bytes.
1757d97159bSManuel Huber# - Potentially significant speed-ups for RPMB I/O. Depending on how many
1767d97159bSManuel Huber#   entries a function needs to traverse, the number of time-consuming RPMB
1777d97159bSManuel Huber#   read-in operations can be reduced.
1787d97159bSManuel Huber# Chosing a proper value is both platform- (available memory) and use-case-
1797d97159bSManuel Huber# dependent (potential number of FAT fs entries), so overwrite in platform
1807d97159bSManuel Huber# config files
1817d97159bSManuel HuberCFG_RPMB_FS_RD_ENTRIES ?= 8
1827d97159bSManuel Huber
1835f68d784SManuel Huber# Enables caching of FAT FS entries when set to a value greater than zero.
1845f68d784SManuel Huber# When enabled, the cache stores the first 'CFG_RPMB_FS_CACHE_ENTRIES' FAT FS
1855f68d784SManuel Huber# entries. The cache is populated when FAT FS entries are initially read in.
1865f68d784SManuel Huber# When traversing the FAT FS entries, we read from the cache instead of reading
1875f68d784SManuel Huber# in the entries from RPMB storage. Consequently, when a FAT FS entry is
1885f68d784SManuel Huber# written, the cache is updated. In scenarios where an estimate of the number
1895f68d784SManuel Huber# of FAT FS entries can be made, the cache may be specifically tailored to
1905f68d784SManuel Huber# store all entries. The caching can improve RPMB I/O at the cost
1915f68d784SManuel Huber# of additional memory.
1925f68d784SManuel Huber# Without caching, we temporarily require
1935f68d784SManuel Huber# CFG_RPMB_FS_RD_ENTRIES*sizeof(struct rpmb_fat_entry) bytes of heap memory
1945f68d784SManuel Huber# while traversing the FAT FS (e.g. in read_fat).
1955f68d784SManuel Huber# For example 8*256 bytes = 2kB while in read_fat.
1965f68d784SManuel Huber# With caching, we constantly require up to
1975f68d784SManuel Huber# CFG_RPMB_FS_CACHE_ENTRIES*sizeof(struct rpmb_fat_entry) bytes of heap memory
1985f68d784SManuel Huber# depending on how many elements are in the cache, and additional temporary
1995f68d784SManuel Huber# CFG_RPMB_FS_RD_ENTRIES*sizeof(struct rpmb_fat_entry) bytes of heap memory
2005f68d784SManuel Huber# in case the cache is too small to hold all elements when traversing.
2015f68d784SManuel HuberCFG_RPMB_FS_CACHE_ENTRIES ?= 0
2025f68d784SManuel Huber
2038443e88eSEtienne Carriere# Print RPMB data frames sent to and received from the RPMB device
2048443e88eSEtienne CarriereCFG_RPMB_FS_DEBUG_DATA ?= n
2058443e88eSEtienne Carriere
2068443e88eSEtienne Carriere# Clear RPMB content at cold boot
2078443e88eSEtienne CarriereCFG_RPMB_RESET_FAT ?= n
2088443e88eSEtienne Carriere
2098443e88eSEtienne Carriere# Use a hard coded RPMB key instead of deriving it from the platform HUK
2108443e88eSEtienne CarriereCFG_RPMB_TESTKEY ?= n
2118443e88eSEtienne Carriere
212ed1993b7SJerome Forissier# Enables RPMB key programming by the TEE, in case the RPMB partition has not
213ed1993b7SJerome Forissier# been configured yet.
214ed1993b7SJerome Forissier# !!! Security warning !!!
215ed1993b7SJerome Forissier# Do *NOT* enable this in product builds, as doing so would allow the TEE to
216ed1993b7SJerome Forissier# leak the RPMB key.
217ed1993b7SJerome Forissier# This option is useful in the following situations:
218ed1993b7SJerome Forissier# - Testing
219ed1993b7SJerome Forissier# - RPMB key provisioning in a controlled environment (factory setup)
220ed1993b7SJerome ForissierCFG_RPMB_WRITE_KEY ?= n
221ed1993b7SJerome Forissier
22207fda6c7SJerome Forissier_CFG_WITH_SECURE_STORAGE := $(call cfg-one-enabled,CFG_REE_FS CFG_RPMB_FS)
22307fda6c7SJerome Forissier
2243ecd96bbSVesa Jääskeläinen# Signing key for OP-TEE TA's
2253ecd96bbSVesa Jääskeläinen# When performing external HSM signing for TA's TA_SIGN_KEY can be set to dummy
2263ecd96bbSVesa Jääskeläinen# key and then set TA_PUBLIC_KEY to match public key from the HSM.
2273ecd96bbSVesa Jääskeläinen# TA_PUBLIC_KEY's public key will be embedded into OP-TEE OS.
228bc420748SJens WiklanderTA_SIGN_KEY ?= keys/default_ta.pem
2293ecd96bbSVesa JääskeläinenTA_PUBLIC_KEY ?= $(TA_SIGN_KEY)
230c4553de7SJerome Forissier
231c34d0d91SJens Wiklander# Subkeys is a complement to the normal TA_SIGN_KEY where a subkey is used
232c34d0d91SJens Wiklander# to verify a TA instead. To sign a TA using a previously prepared subkey
233c34d0d91SJens Wiklander# two new options are added, TA_SUBKEY_ARGS and TA_SUBKEY_DEPS.  It is
234c34d0d91SJens Wiklander# typically used by assigning the following in the TA Makefile:
235c34d0d91SJens Wiklander# BINARY = <TA-uuid-string>
236c34d0d91SJens Wiklander# TA_SIGN_KEY = subkey.pem
237c34d0d91SJens Wiklander# TA_SUBKEY_ARGS = --subkey subkey.bin --name subkey_ta
238c34d0d91SJens Wiklander# TA_SUBKEY_DEPS = subkey.bin
239c34d0d91SJens Wiklander# See the documentation for more details on subkeys.
240c34d0d91SJens Wiklander
241c4553de7SJerome Forissier# Include lib/libutils/isoc in the build? Most platforms need this, but some
242c4553de7SJerome Forissier# may not because they obtain the isoc functions from elsewhere
243c4553de7SJerome ForissierCFG_LIBUTILS_WITH_ISOC ?= y
244fce4cfa1SJens Wiklander
2450de9a5fbSJens Wiklander# Enables floating point support for user TAs
2460de9a5fbSJens Wiklander# ARM32: EABI defines both a soft-float ABI and a hard-float ABI,
2470de9a5fbSJens Wiklander#	 hard-float is basically a super set of soft-float. Hard-float
2480de9a5fbSJens Wiklander#	 requires all the support routines provided for soft-float, but the
2490de9a5fbSJens Wiklander#	 compiler may choose to optimize to not use some of them and use
2500de9a5fbSJens Wiklander#	 the floating-point registers instead.
2510de9a5fbSJens Wiklander# ARM64: EABI doesn't define a soft-float ABI, everything is hard-float (or
2520de9a5fbSJens Wiklander#	 nothing with ` -mgeneral-regs-only`)
2530de9a5fbSJens Wiklander# With CFG_TA_FLOAT_SUPPORT enabled TA code is free use floating point types
2540de9a5fbSJens WiklanderCFG_TA_FLOAT_SUPPORT ?= y
255923c1f34SJens Wiklander
2567411e0e1SJerome Forissier# Stack unwinding: print a stack dump to the console on core or TA abort, or
2577411e0e1SJerome Forissier# when a TA panics.
25831a29642SJerome Forissier# If CFG_UNWIND is enabled, both the kernel and user mode call stacks can be
25931a29642SJerome Forissier# unwound (not paged TAs, however).
26031a29642SJerome Forissier# Note that 32-bit ARM code needs unwind tables for this to work, so enabling
26131a29642SJerome Forissier# this option will increase the size of the 32-bit TEE binary by a few KB.
26231a29642SJerome Forissier# Similarly, TAs have to be compiled with -funwind-tables (default when the
26331a29642SJerome Forissier# option is set) otherwise they can't be unwound.
2647411e0e1SJerome Forissier# Warning: since the unwind sequence for user-mode (TA) code is implemented in
2657411e0e1SJerome Forissier# the privileged layer of OP-TEE, enabling this feature will weaken the
2667411e0e1SJerome Forissier# user/kernel isolation. Therefore it should be disabled in release builds.
2673f17b838SEtienne Carriereifeq ($(CFG_TEE_CORE_DEBUG),y)
26831a29642SJerome ForissierCFG_UNWIND ?= y
269923c1f34SJens Wiklanderendif
2706fbac37eSJens Wiklander
2716fbac37eSJens Wiklander# Enable support for dynamically loaded user TAs
2726fbac37eSJens WiklanderCFG_WITH_USER_TA ?= y
2732a142248SJens Wiklander
27424d49094SJerome Forissier# Choosing the architecture(s) of user-mode libraries (used by TAs)
27524d49094SJerome Forissier#
27624d49094SJerome Forissier# Platforms may define a list of supported architectures for user-mode code
27724d49094SJerome Forissier# by setting $(supported-ta-targets). Valid values are "ta_arm32", "ta_arm64",
27824d49094SJerome Forissier# "ta_arm32 ta_arm64" and "ta_arm64 ta_arm32".
27924d49094SJerome Forissier# $(supported-ta-targets) defaults to "ta_arm32" when the TEE core is 32-bits,
28024d49094SJerome Forissier# and "ta_arm32 ta_arm64" when it is 64-bits (that is, when CFG_ARM64_core=y).
28124d49094SJerome Forissier# The first entry in $(supported-ta-targets) has a special role, see
28224d49094SJerome Forissier# CFG_USER_TA_TARGET_<ta-name> below.
28324d49094SJerome Forissier#
28424d49094SJerome Forissier# CFG_USER_TA_TARGETS may be defined to restrict $(supported-ta-targets) or
28524d49094SJerome Forissier# change the order of the values.
28624d49094SJerome Forissier#
28724d49094SJerome Forissier# The list of TA architectures is ultimately stored in $(ta-targets).
28824d49094SJerome Forissier
28924d49094SJerome Forissier# CFG_USER_TA_TARGET_<ta-name> (for example, CFG_USER_TA_TARGET_avb), if
29024d49094SJerome Forissier# defined, selects the unique TA architecture mode for building the in-tree TA
29124d49094SJerome Forissier# <ta-name>. Can be either ta_arm32 or ta_arm64.
29224d49094SJerome Forissier# By default, in-tree TAs are built using the first architecture specified in
29324d49094SJerome Forissier# $(ta-targets).
29424d49094SJerome Forissier
2957dfff131SJerome Forissier# Address Space Layout Randomization for user-mode Trusted Applications
2967dfff131SJerome Forissier#
2977dfff131SJerome Forissier# When this flag is enabled, the ELF loader will introduce a random offset
2987dfff131SJerome Forissier# when mapping the application in user space. ASLR makes the exploitation of
2997dfff131SJerome Forissier# memory corruption vulnerabilities more difficult.
30087372da4SJens WiklanderCFG_TA_ASLR ?= y
3017dfff131SJerome Forissier
3027dfff131SJerome Forissier# How much ASLR may shift the base address (in pages). The base address is
3037dfff131SJerome Forissier# randomly shifted by an integer number of pages comprised between these two
3047dfff131SJerome Forissier# values. Bigger ranges are more secure because they make the addresses harder
3057dfff131SJerome Forissier# to guess at the expense of using more memory for the page tables.
3067dfff131SJerome ForissierCFG_TA_ASLR_MIN_OFFSET_PAGES ?= 0
3077dfff131SJerome ForissierCFG_TA_ASLR_MAX_OFFSET_PAGES ?= 128
3087dfff131SJerome Forissier
309170e9084SJens Wiklander# Address Space Layout Randomization for TEE Core
310170e9084SJens Wiklander#
311170e9084SJens Wiklander# When this flag is enabled, the early init code will introduce a random
312170e9084SJens Wiklander# offset when mapping TEE Core. ASLR makes the exploitation of memory
313170e9084SJens Wiklander# corruption vulnerabilities more difficult.
31487372da4SJens WiklanderCFG_CORE_ASLR ?= y
315170e9084SJens Wiklander
31645507d10SKhoa Hoang# Stack Protection for TEE Core
31745507d10SKhoa Hoang# This flag enables the compiler stack protection mechanisms -fstack-protector.
31845507d10SKhoa Hoang# It will check the stack canary value before returning from a function to
31945507d10SKhoa Hoang# prevent buffer overflow attacks. Stack protector canary logic will be added
32045507d10SKhoa Hoang# for vulnerable functions that contain:
32145507d10SKhoa Hoang# - A character array larger than 8 bytes.
32245507d10SKhoa Hoang# - An 8-bit integer array larger than 8 bytes.
32345507d10SKhoa Hoang# - A call to alloca() with either a variable size or a constant size bigger
32445507d10SKhoa Hoang#   than 8 bytes.
32545507d10SKhoa HoangCFG_CORE_STACK_PROTECTOR ?= n
32645507d10SKhoa Hoang# This enable stack protector flag -fstack-protector-strong. Stack protector
32745507d10SKhoa Hoang# canary logic will be added for vulnerable functions that contain:
32845507d10SKhoa Hoang# - An array of any size and type.
32945507d10SKhoa Hoang# - A call to alloca().
33045507d10SKhoa Hoang# - A local variable that has its address taken.
33145507d10SKhoa HoangCFG_CORE_STACK_PROTECTOR_STRONG ?= y
33245507d10SKhoa Hoang# This enable stack protector flag -fstack-protector-all. Stack protector canary
33345507d10SKhoa Hoang# logic will be added to all functions regardless of their vulnerability.
33445507d10SKhoa HoangCFG_CORE_STACK_PROTECTOR_ALL ?= n
33545507d10SKhoa Hoang# Stack Protection for TA
33645507d10SKhoa HoangCFG_TA_STACK_PROTECTOR ?= n
33745507d10SKhoa HoangCFG_TA_STACK_PROTECTOR_STRONG ?= y
33845507d10SKhoa HoangCFG_TA_STACK_PROTECTOR_ALL ?= n
33945507d10SKhoa Hoang
34045507d10SKhoa Hoang_CFG_CORE_STACK_PROTECTOR := $(call cfg-one-enabled, CFG_CORE_STACK_PROTECTOR \
34145507d10SKhoa Hoang						     CFG_CORE_STACK_PROTECTOR_STRONG \
34245507d10SKhoa Hoang						     CFG_CORE_STACK_PROTECTOR_ALL)
34345507d10SKhoa Hoang_CFG_TA_STACK_PROTECTOR := $(call cfg-one-enabled, CFG_TA_STACK_PROTECTOR \
34445507d10SKhoa Hoang						   CFG_TA_STACK_PROTECTOR_STRONG \
34545507d10SKhoa Hoang						   CFG_TA_STACK_PROTECTOR_ALL)
34645507d10SKhoa Hoang
347ee664c19SJerome Forissier# Load user TAs from the REE filesystem via tee-supplicant
348ee664c19SJerome ForissierCFG_REE_FS_TA ?= y
349ee664c19SJerome Forissier
3507db24ad6SJerome Forissier# Pre-authentication of TA binaries loaded from the REE filesystem
3517db24ad6SJerome Forissier#
3527db24ad6SJerome Forissier# - If CFG_REE_FS_TA_BUFFERED=y: load TA binary into a temporary buffer in the
3537db24ad6SJerome Forissier#   "Secure DDR" pool, check the signature, then process the file only if it is
3547db24ad6SJerome Forissier#   valid.
3557db24ad6SJerome Forissier# - If disabled: hash the binaries as they are being processed and verify the
3567db24ad6SJerome Forissier#   signature as a last step.
357e6e68745SJerome ForissierCFG_REE_FS_TA_BUFFERED ?= n
3587db24ad6SJerome Forissier$(eval $(call cfg-depends-all,CFG_REE_FS_TA_BUFFERED,CFG_REE_FS_TA))
3597db24ad6SJerome Forissier
360300faa62SEtienne Carriere# When CFG_REE_FS=y and CFG_RPMB_FS=y:
361300faa62SEtienne Carriere# Allow secure storage in the REE FS to be entirely deleted without causing
362300faa62SEtienne Carriere# anti-rollback errors. That is, rm /data/tee/dirf.db or rm -rf /data/tee (or
363300faa62SEtienne Carriere# whatever path is configured in tee-supplicant as CFG_TEE_FS_PARENT_PATH)
364300faa62SEtienne Carriere# can be used to reset the secure storage to a clean, empty state.
365300faa62SEtienne Carriere# Typically used for testing only since it weakens storage security.
366300faa62SEtienne CarriereCFG_REE_FS_ALLOW_RESET ?= n
367300faa62SEtienne Carriere
368d0c63614SJerome Forissier# Support for loading user TAs from a special section in the TEE binary.
369d0c63614SJerome Forissier# Such TAs are available even before tee-supplicant is available (hence their
370d0c63614SJerome Forissier# name), but note that many services exported to TAs may need tee-supplicant,
371d0c63614SJerome Forissier# so early use is limited to a subset of the TEE Internal Core API (crypto...)
372d0c63614SJerome Forissier# To use this feature, set EARLY_TA_PATHS to the paths to one or more TA ELF
373d0c63614SJerome Forissier# file(s). For example:
374d0c63614SJerome Forissier#   $ make ... \
375d0c63614SJerome Forissier#     EARLY_TA_PATHS="path/to/8aaaf200-2450-11e4-abe2-0002a5d5c51b.stripped.elf \
376d0c63614SJerome Forissier#                     path/to/cb3e5ba0-adf1-11e0-998b-0002a5d5c51b.stripped.elf"
377d0c63614SJerome Forissier# Typical build steps:
378d0c63614SJerome Forissier#   $ make ta_dev_kit CFG_EARLY_TA=y # Create the dev kit (user mode libraries,
379d0c63614SJerome Forissier#                                    # headers, makefiles), ready to build TAs.
380d0c63614SJerome Forissier#                                    # CFG_EARLY_TA=y is optional, it prevents
381d0c63614SJerome Forissier#                                    # later library recompilations.
382d0c63614SJerome Forissier#   <build some TAs>
383d0c63614SJerome Forissier#   $ make EARLY_TA_PATHS=<paths>    # Build OP-TEE and embbed the TA(s)
3843638ea32SJens Wiklander#
3853638ea32SJens Wiklander# Another option is CFG_IN_TREE_EARLY_TAS which is used to point at
3863638ea32SJens Wiklander# in-tree TAs. CFG_IN_TREE_EARLY_TAS is formatted as:
3873638ea32SJens Wiklander# <name-of-ta>/<uuid>
3883638ea32SJens Wiklander# for instance avb/023f8f1a-292a-432b-8fc4-de8471358067
3893638ea32SJens Wiklanderifneq ($(EARLY_TA_PATHS)$(CFG_IN_TREE_EARLY_TAS),)
390d0c63614SJerome Forissier$(call force,CFG_EARLY_TA,y)
391d0c63614SJerome Forissierelse
392d0c63614SJerome ForissierCFG_EARLY_TA ?= n
393d0c63614SJerome Forissierendif
394dea46be3SJelle Sels
39505ee04a8SJelle Selsifeq ($(CFG_EARLY_TA),y)
39605ee04a8SJelle Sels$(call force,CFG_EMBEDDED_TS,y)
39705ee04a8SJelle Selsendif
39805ee04a8SJelle Sels
399dea46be3SJelle Selsifneq ($(SP_PATHS),)
400dea46be3SJelle Sels$(call force,CFG_EMBEDDED_TS,y)
401dea46be3SJelle Selselse
402dea46be3SJelle SelsCFG_SECURE_PARTITION ?= n
403dea46be3SJelle Selsendif
404dea46be3SJelle Sels
40505ee04a8SJelle Selsifeq ($(CFG_SECURE_PARTITION),y)
40605ee04a8SJelle Sels$(call force,CFG_EMBEDDED_TS,y)
40705ee04a8SJelle Selsendif
40805ee04a8SJelle Sels
409dea46be3SJelle Selsifeq ($(CFG_EMBEDDED_TS),y)
410509a9802SJerome Forissier$(call force,CFG_ZLIB,y)
411509a9802SJerome Forissierendif
412d0c63614SJerome Forissier
413c082c54dSEtienne Carriere# By default the early TAs are compressed in the TEE binary, it is possible to
414c082c54dSEtienne Carriere# not compress them with CFG_EARLY_TA_COMPRESS=n
415c082c54dSEtienne CarriereCFG_EARLY_TA_COMPRESS ?= y
416c082c54dSEtienne Carriere
417a884c935SJens Wiklander# Enable paging, requires SRAM, can't be enabled by default
418a884c935SJens WiklanderCFG_WITH_PAGER ?= n
419a884c935SJens Wiklander
420b757e307SJens Wiklander# Use the pager for user TAs
421b757e307SJens WiklanderCFG_PAGED_USER_TA ?= $(CFG_WITH_PAGER)
422b757e307SJens Wiklander
423b757e307SJens Wiklander# If paging of user TAs, that is, R/W paging default to enable paging of
424b757e307SJens Wiklander# TAG and IV in order to reduce heap usage.
425b757e307SJens WiklanderCFG_CORE_PAGE_TAG_AND_IV ?= $(CFG_PAGED_USER_TA)
426b757e307SJens Wiklander
427ab0df69eSJerome Forissier# Runtime lock dependency checker: ensures that a proper locking hierarchy is
428ab0df69eSJerome Forissier# used in the TEE core when acquiring and releasing mutexes. Any violation will
429ab0df69eSJerome Forissier# cause a panic as soon as the invalid locking condition is detected. If
4302288b071SJerome Forissier# CFG_UNWIND and CFG_LOCKDEP_RECORD_STACK are both enabled, the algorithm
4312288b071SJerome Forissier# records the call stacks when locks are taken, and prints them when a
4322288b071SJerome Forissier# potential deadlock is found.
433ab0df69eSJerome Forissier# Expect a significant performance impact when enabling this.
434ab0df69eSJerome ForissierCFG_LOCKDEP ?= n
4352288b071SJerome ForissierCFG_LOCKDEP_RECORD_STACK ?= y
436ab0df69eSJerome Forissier
437bde8a250SJoakim Bech# BestFit algorithm in bget reduces the fragmentation of the heap when running
438ab0df69eSJerome Forissier# with the pager enabled or lockdep
439ab0df69eSJerome ForissierCFG_CORE_BGET_BESTFIT ?= $(call cfg-one-enabled, CFG_WITH_PAGER CFG_LOCKDEP)
440bde8a250SJoakim Bech
441be715239SJens Wiklander# Enable support for detected undefined behavior in C
4421d171f95SJens Wiklander# Uses a lot of memory, can't be enabled by default
443be715239SJens WiklanderCFG_CORE_SANITIZE_UNDEFINED ?= n
444b908c675SJens Wiklander
4451d171f95SJens Wiklander# Enable Kernel Address sanitizer, has a huge performance impact, uses a
4461d171f95SJens Wiklander# lot of memory and need platform specific adaptations, can't be enabled by
4471d171f95SJens Wiklander# default
4481d171f95SJens WiklanderCFG_CORE_SANITIZE_KADDRESS ?= n
4491d171f95SJens Wiklander
45035e770dfSJerome Forissier# Add stack guards before/after stacks and periodically check them
45135e770dfSJerome ForissierCFG_WITH_STACK_CANARIES ?= y
45235e770dfSJerome Forissier
453e2f03e07SJerome Forissier# Use compiler instrumentation to troubleshoot stack overflows.
454e2f03e07SJerome Forissier# When enabled, most C functions check the stack pointer against the current
455e2f03e07SJerome Forissier# stack limits on entry and panic immediately if it is out of range.
456e2f03e07SJerome ForissierCFG_CORE_DEBUG_CHECK_STACKS ?= n
457e2f03e07SJerome Forissier
458cca7b5ebSJorge Ramirez-Ortiz# Use when the default stack allocations are not sufficient.
459cca7b5ebSJorge Ramirez-OrtizCFG_STACK_THREAD_EXTRA ?= 0
460cca7b5ebSJorge Ramirez-OrtizCFG_STACK_TMP_EXTRA ?= 0
461cca7b5ebSJorge Ramirez-Ortiz
462b908c675SJens Wiklander# Device Tree support
463c95b9511SEtienne Carriere#
464c95b9511SEtienne Carriere# When CFG_DT is enabled core embeds the FDT library (libfdt) allowing
465c95b9511SEtienne Carriere# device tree blob (DTB) parsing from the core.
466c95b9511SEtienne Carriere#
467c95b9511SEtienne Carriere# When CFG_DT is enabled, the TEE _start function expects to find
468c95b9511SEtienne Carriere# the address of a DTB in register X2/R2 provided by the early boot stage
469c95b9511SEtienne Carriere# or value 0 if boot stage provides no DTB.
470c95b9511SEtienne Carriere#
4717c2317a7SGatien Chevallier# When CFG_EXTERNAL_DT is enabled, the external device tree ABI is implemented
4727c2317a7SGatien Chevallier# and the external device tree is expected to be used/modified. Its value
4737c2317a7SGatien Chevallier# defaults to CFG_DT.
4747c2317a7SGatien Chevallier#
475bf31bf10SImre Kis# When CFG_MAP_EXT_DT_SECURE is enabled the external device tree is expected to
476bf31bf10SImre Kis# be in the secure memory.
477bf31bf10SImre Kis#
478c95b9511SEtienne Carriere# When CFG_EMBED_DTB is enabled, CFG_EMBED_DTB_SOURCE_FILE shall define the
479c95b9511SEtienne Carriere# relative path of a DTS file located in core/arch/$(ARCH)/dts.
480c95b9511SEtienne Carriere# The DTS file is compiled into a DTB file which content is embedded in a
481c95b9511SEtienne Carriere# read-only section of the core.
482c95b9511SEtienne Carriereifneq ($(strip $(CFG_EMBED_DTB_SOURCE_FILE)),)
483c95b9511SEtienne CarriereCFG_EMBED_DTB ?= y
484c95b9511SEtienne Carriereendif
485c95b9511SEtienne Carriereifeq ($(CFG_EMBED_DTB),y)
486c95b9511SEtienne Carriere$(call force,CFG_DT,y)
487c95b9511SEtienne Carriereendif
488c95b9511SEtienne CarriereCFG_EMBED_DTB ?= n
489b908c675SJens WiklanderCFG_DT ?= n
4907c2317a7SGatien ChevallierCFG_EXTERNAL_DT ?= $(CFG_DT)
491bf31bf10SImre KisCFG_MAP_EXT_DT_SECURE ?= n
492bf31bf10SImre Kisifeq ($(CFG_MAP_EXT_DT_SECURE),y)
493bf31bf10SImre Kis$(call force,CFG_DT,y)
494bf31bf10SImre Kisendif
49576358becSJens Wiklander
49676358becSJens Wiklander# Maximum size of the Device Tree Blob, has to be large enough to allow
49776358becSJens Wiklander# editing of the supplied DTB.
49876358becSJens WiklanderCFG_DTB_MAX_SIZE ?= 0x10000
4994d62e91aSVictor Chong
500c36d2192SBalint Dobszay# Maximum size of the init info data passed to Secure Partitions.
501c36d2192SBalint DobszayCFG_SP_INIT_INFO_MAX_SIZE ?= 0x1000
502c36d2192SBalint Dobszay
5030a3ad9b6SBryan O'Donoghue# Device Tree Overlay support.
504c4544143SClément Léger# CFG_EXTERNAL_DTB_OVERLAY allows to append a DTB overlay into an existing
505c4544143SClément Léger# external DTB. The overlay is created when no valid DTB overlay is found.
506c4544143SClément Léger# CFG_GENERATE_DTB_OVERLAY allows to create a DTB overlay at external
507c4544143SClément Léger# DTB location.
508c4544143SClément Léger# External DTB location (physical address) is provided either by boot
509c4544143SClément Léger# argument arg2 or from CFG_DT_ADDR if defined.
510c4544143SClément Léger# A subsequent boot stage can then merge the generated overlay DTB into a main
5110a3ad9b6SBryan O'Donoghue# DTB using the standard fdt_overlay_apply() method.
5120a3ad9b6SBryan O'DonoghueCFG_EXTERNAL_DTB_OVERLAY ?= n
513c4544143SClément LégerCFG_GENERATE_DTB_OVERLAY ?= n
514c4544143SClément Léger
515c4544143SClément Légerifeq (y-y,$(CFG_EXTERNAL_DTB_OVERLAY)-$(CFG_GENERATE_DTB_OVERLAY))
516c4544143SClément Léger$(error CFG_EXTERNAL_DTB_OVERLAY and CFG_GENERATE_DTB_OVERLAY are exclusive)
517c4544143SClément Légerendif
518c4544143SClément Léger_CFG_USE_DTB_OVERLAY := $(call cfg-one-enabled,CFG_EXTERNAL_DTB_OVERLAY \
519c4544143SClément Léger			  CFG_GENERATE_DTB_OVERLAY)
5200a3ad9b6SBryan O'Donoghue
521313aa2a4SJens Wiklander# All embedded tests are supposed to be disabled by default, this flag
522313aa2a4SJens Wiklander# is used to control the default value of all other embedded tests
523313aa2a4SJens WiklanderCFG_ENABLE_EMBEDDED_TESTS ?= n
524313aa2a4SJens Wiklander
52535964dc9SEtienne Carriere# Enable core self tests and related pseudo TAs
526313aa2a4SJens WiklanderCFG_TEE_CORE_EMBED_INTERNAL_TESTS ?= $(CFG_ENABLE_EMBEDDED_TESTS)
5276d96f208Syanyan-wrs
52827e8d08dSJens Wiklander# Compiles bget_main_test() to be called from a test TA
52927e8d08dSJens WiklanderCFG_TA_BGET_TEST ?= $(CFG_ENABLE_EMBEDDED_TESTS)
53027e8d08dSJens Wiklander
531d783b681SEtienne Carriere# CFG_DT_DRIVER_EMBEDDED_TEST when enabled embedb DT driver probing tests.
532d783b681SEtienne Carriere# This also requires embeddeding a DTB with expected content.
533d783b681SEtienne Carriere# Defautl disable CFG_DRIVERS_CLK_EARLY_PROBE to probe clocks as other drivers.
534d783b681SEtienne Carriere# A probe deferral test mandates CFG_DRIVERS_DT_RECURSIVE_PROBE=n.
535d783b681SEtienne CarriereCFG_DT_DRIVER_EMBEDDED_TEST ?= n
536d783b681SEtienne Carriereifeq ($(CFG_DT_DRIVER_EMBEDDED_TEST),y)
537d783b681SEtienne CarriereCFG_DRIVERS_CLK ?= y
538d783b681SEtienne CarriereCFG_DRIVERS_RSTCTRL ?= y
539d783b681SEtienne CarriereCFG_DRIVERS_CLK_EARLY_PROBE ?= n
540d783b681SEtienne Carriere$(call force,CFG_DRIVERS_DT_RECURSIVE_PROBE,n,Mandated by CFG_DT_DRIVER_EMBEDDED_TEST)
541d783b681SEtienne Carriereendif
542d783b681SEtienne Carriere
5434101c34aSEtienne Carriere# CFG_DRIVERS_DT_RECURSIVE_PROBE when enabled forces a recursive subnode
5444101c34aSEtienne Carriere# parsing in the embedded DTB for driver probing. The alternative is
5454101c34aSEtienne Carriere# an exploration based on compatible drivers found. It is default disabled.
5464101c34aSEtienne CarriereCFG_DRIVERS_DT_RECURSIVE_PROBE ?= n
5474101c34aSEtienne Carriere
5486d96f208Syanyan-wrs# This option enables OP-TEE to respond to SMP boot request: the Rich OS
5496d96f208Syanyan-wrs# issues this to request OP-TEE to release secondaries cores out of reset,
5506d96f208Syanyan-wrs# with specific core number and non-secure entry address.
5516d96f208Syanyan-wrsCFG_BOOT_SECONDARY_REQUEST ?= n
5526d96f208Syanyan-wrs
553f5f914aaSJens Wiklander# Default heap size for Core, 64 kB
554f5f914aaSJens WiklanderCFG_CORE_HEAP_SIZE ?= 65536
555f3bb2312SJerome Forissier
556386fc264SVolodymyr Babchuk# Default size of nexus heap. 16 kB. Used only if CFG_VIRTUALIZATION
557386fc264SVolodymyr Babchuk# is enabled
558386fc264SVolodymyr BabchukCFG_CORE_NEX_HEAP_SIZE ?= 16384
559386fc264SVolodymyr Babchuk
560883c4be3SJerome Forissier# TA profiling.
561883c4be3SJerome Forissier# When this option is enabled, OP-TEE can execute Trusted Applications
562883c4be3SJerome Forissier# instrumented with GCC's -pg flag and will output profiling information
563883c4be3SJerome Forissier# in gmon.out format to /tmp/gmon-<ta_uuid>.out (path is defined in
564883c4be3SJerome Forissier# tee-supplicant)
5658800b01dSJerome Forissier# Note: this does not work well with shared libraries at the moment for a
5668800b01dSJerome Forissier# couple of reasons:
5678800b01dSJerome Forissier# 1. The profiling code assumes a unique executable section in the TA VA space.
5688800b01dSJerome Forissier# 2. The code used to detect at run time if the TA is intrumented assumes that
5698800b01dSJerome Forissier# the TA is linked statically.
570883c4be3SJerome ForissierCFG_TA_GPROF_SUPPORT ?= n
571f3bb2312SJerome Forissier
572b02ae382SSumit Garg# TA function tracing.
573b02ae382SSumit Garg# When this option is enabled, OP-TEE can execute Trusted Applications
574b02ae382SSumit Garg# instrumented with GCC's -pg flag and will output function tracing
575b02ae382SSumit Garg# information in ftrace.out format to /tmp/ftrace-<ta_uuid>.out (path is
576b02ae382SSumit Garg# defined in tee-supplicant)
577099918f6SSumit GargCFG_FTRACE_SUPPORT ?= n
578b02ae382SSumit Garg
579d408db99SJerome Forissier# How to make room when the function tracing buffer is full?
580d408db99SJerome Forissier# 'shift': shift the previously stored data by the amount needed in order
581d408db99SJerome Forissier#    to always keep the latest logs (slower, especially with big buffer sizes)
582d408db99SJerome Forissier# 'wrap': discard the previous data and start at the beginning of the buffer
583d408db99SJerome Forissier#    again (fast, but can result in a mostly empty buffer)
584d408db99SJerome Forissier# 'stop': stop logging new data
585d408db99SJerome ForissierCFG_FTRACE_BUF_WHEN_FULL ?= shift
586d408db99SJerome Forissier$(call cfg-check-value,FTRACE_BUF_WHEN_FULL,shift stop wrap)
587d408db99SJerome Forissier$(call force,_CFG_FTRACE_BUF_WHEN_FULL_$(CFG_FTRACE_BUF_WHEN_FULL),y)
588d408db99SJerome Forissier
589d1492098SJerome Forissier# Function tracing: unit to be used when displaying durations
590d1492098SJerome Forissier#  0: always display durations in microseconds
591d1492098SJerome Forissier# >0: if duration is greater or equal to the specified value (in microseconds),
592d1492098SJerome Forissier#     display it in milliseconds
593d1492098SJerome ForissierCFG_FTRACE_US_MS ?= 10000
594d1492098SJerome Forissier
595099918f6SSumit Garg# Core syscall function tracing.
596099918f6SSumit Garg# When this option is enabled, OP-TEE core is instrumented with GCC's
597099918f6SSumit Garg# -pg flag and will output syscall function graph in user TA ftrace
598099918f6SSumit Garg# buffer
599099918f6SSumit GargCFG_SYSCALL_FTRACE ?= n
600099918f6SSumit Garg$(call cfg-depends-all,CFG_SYSCALL_FTRACE,CFG_FTRACE_SUPPORT)
601099918f6SSumit Garg
602883c4be3SJerome Forissier# Enable to compile user TA libraries with profiling (-pg).
603099918f6SSumit Garg# Depends on CFG_TA_GPROF_SUPPORT or CFG_FTRACE_SUPPORT.
604735565dbSSumit GargCFG_ULIBS_MCOUNT ?= n
6050f8adafeSJerome Forissier# Profiling/tracing of syscall wrapper (utee_*)
6060f8adafeSJerome ForissierCFG_SYSCALL_WRAPPERS_MCOUNT ?= $(CFG_ULIBS_MCOUNT)
607883c4be3SJerome Forissier
6080f8adafeSJerome Forissierifeq (y,$(filter y,$(CFG_ULIBS_MCOUNT) $(CFG_SYSCALL_WRAPPERS_MCOUNT)))
609099918f6SSumit Gargifeq (,$(filter y,$(CFG_TA_GPROF_SUPPORT) $(CFG_FTRACE_SUPPORT)))
610883c4be3SJerome Forissier$(error Cannot instrument user libraries if user mode profiling is disabled)
611f3bb2312SJerome Forissierendif
612f3bb2312SJerome Forissierendif
613cb0b5954SJens Wiklander
6147fb525f1SJerome Forissier# Build libutee, libutils, libmbedtls as shared libraries.
61564718c93SJerome Forissier# - Static libraries are still generated when this is enabled, but TAs will use
61664718c93SJerome Forissier# the shared libraries unless explicitly linked with the -static flag.
61764718c93SJerome Forissier# - Shared libraries are made of two files: for example, libutee is
61864718c93SJerome Forissier#   libutee.so and 527f1a47-b92c-4a74-95bd-72f19f4a6f74.ta. The '.so' file
61964718c93SJerome Forissier#   is a totally standard shared object, and should be used to link against.
62064718c93SJerome Forissier#   The '.ta' file is a signed version of the '.so' and should be installed
62164718c93SJerome Forissier#   in the same way as TAs so that they can be found at runtime.
62264718c93SJerome ForissierCFG_ULIBS_SHARED ?= n
62364718c93SJerome Forissier
62439ef71afSEtienne Carriereifeq (y-y,$(CFG_TA_GPROF_SUPPORT)-$(CFG_ULIBS_SHARED))
62570aa7511SJerome Forissier$(error CFG_TA_GPROF_SUPPORT and CFG_ULIBS_SHARED are currently incompatible)
62670aa7511SJerome Forissierendif
62770aa7511SJerome Forissier
628cb0b5954SJens Wiklander# CFG_GP_SOCKETS
629cb0b5954SJens Wiklander# Enable Global Platform Sockets support
630cb0b5954SJens WiklanderCFG_GP_SOCKETS ?= y
63180a4e51dSEtienne Carriere
63280a4e51dSEtienne Carriere# Enable Secure Data Path support in OP-TEE core (TA may be invoked with
63380a4e51dSEtienne Carriere# invocation parameters referring to specific secure memories).
63480a4e51dSEtienne CarriereCFG_SECURE_DATA_PATH ?= n
63500da26ecSAndrew F. Davis
636c9720143SJens Wiklander# Enable storage for TAs in secure storage, depends on CFG_REE_FS=y
637c9720143SJens Wiklander# TA binaries are stored encrypted in the REE FS and are protected by
638c9720143SJens Wiklander# metadata in secure storage.
639c9720143SJens WiklanderCFG_SECSTOR_TA ?= $(call cfg-all-enabled,CFG_REE_FS CFG_WITH_USER_TA)
640c9720143SJens Wiklander$(eval $(call cfg-depends-all,CFG_SECSTOR_TA,CFG_REE_FS CFG_WITH_USER_TA))
641c9720143SJens Wiklander
64230668b28SJens Wiklander# Enable the pseudo TA that managages TA storage in secure storage
64330668b28SJens WiklanderCFG_SECSTOR_TA_MGMT_PTA ?= $(call cfg-all-enabled,CFG_SECSTOR_TA)
64430668b28SJens Wiklander$(eval $(call cfg-depends-all,CFG_SECSTOR_TA_MGMT_PTA,CFG_SECSTOR_TA))
645c9720143SJens Wiklander
6464bca302aSIgor Opaniuk# Enable the pseudo TA for misc. auxilary services, extending existing
64757e642f1SEtienne Carriere# GlobalPlatform TEE Internal Core API (for example, re-seeding RNG entropy
64857e642f1SEtienne Carriere# pool etc...)
64957e642f1SEtienne CarriereCFG_SYSTEM_PTA ?= $(CFG_WITH_USER_TA)
65057e642f1SEtienne Carriere$(eval $(call cfg-depends-all,CFG_SYSTEM_PTA,CFG_WITH_USER_TA))
6514bca302aSIgor Opaniuk
6520b611081SSumit Garg# Enable the pseudo TA for enumeration of TEE based devices for the normal
6530b611081SSumit Garg# world OS.
6540b611081SSumit GargCFG_DEVICE_ENUM_PTA ?= y
6550b611081SSumit Garg
6567e05ec25SJerome Forissier# The attestation pseudo TA provides an interface to request measurements of
6577e05ec25SJerome Forissier# a TA or the TEE binary.
6587e05ec25SJerome ForissierCFG_ATTESTATION_PTA ?= n
6597e05ec25SJerome Forissier$(eval $(call cfg-depends-all,CFG_ATTESTATION_PTA,_CFG_WITH_SECURE_STORAGE))
6607e05ec25SJerome Forissier
6617e05ec25SJerome Forissier# RSA key size (in bits) for the attestation PTA. Must be at least 528 given
6627e05ec25SJerome Forissier# other algorithm parameters (RSA PSS with SHA-256 and 32-byte salt), but
6637e05ec25SJerome Forissier# note that such a low value is not secure.
6647e05ec25SJerome Forissier# See https://tools.ietf.org/html/rfc8017#section-8.1.1 and
6657e05ec25SJerome Forissier# https://tools.ietf.org/html/rfc8017#section-9.1.1
6667e05ec25SJerome Forissier#  emLen >= hlen + sLen + 2 = 32 + 32 + 2 = 66
6677e05ec25SJerome Forissier#  emLen = ceil((modBits - 1) / 8) => emLen is the key size in bytes
6687e05ec25SJerome ForissierCFG_ATTESTATION_PTA_KEY_SIZE ?= 3072
6697e05ec25SJerome Forissier
67000da26ecSAndrew F. Davis# Define the number of cores per cluster used in calculating core position.
67100da26ecSAndrew F. Davis# The cluster number is shifted by this value and added to the core ID,
67200da26ecSAndrew F. Davis# so its value represents log2(cores/cluster).
67300da26ecSAndrew F. Davis# Default is 2**(2) = 4 cores per cluster.
67400da26ecSAndrew F. DavisCFG_CORE_CLUSTER_SHIFT ?= 2
675d81f93a7SVolodymyr Babchuk
6768be2de1aSImre Kis# Define the number of threads per core used in calculating processing
6778be2de1aSImre Kis# element's position. The core number is shifted by this value and added to
6788be2de1aSImre Kis# the thread ID, so its value represents log2(threads/core).
6798be2de1aSImre Kis# Default is 2**(0) = 1 threads per core.
6808be2de1aSImre KisCFG_CORE_THREAD_SHIFT ?= 0
6818be2de1aSImre Kis
68237a6b717SJens Wiklander# Enable support for dynamic shared memory (shared memory anywhere in
68337a6b717SJens Wiklander# non-secure memory).
68437a6b717SJens WiklanderCFG_CORE_DYN_SHM ?= y
68537a6b717SJens Wiklander
6868aeb6c94SJens Wiklander# Enable support for reserved shared memory (shared memory in a carved out
6878aeb6c94SJens Wiklander# memory area).
6888aeb6c94SJens WiklanderCFG_CORE_RESERVED_SHM ?= y
6898aeb6c94SJens Wiklander
690dd3afbacSJens Wiklander# Enables support for larger physical addresses, that is, it will define
691dd3afbacSJens Wiklander# paddr_t as a 64-bit type.
692dd3afbacSJens WiklanderCFG_CORE_LARGE_PHYS_ADDR ?= n
693e3458e03SJerome Forissier
694e3458e03SJerome Forissier# Define the maximum size, in bits, for big numbers in the Internal Core API
695e3458e03SJerome Forissier# Arithmetical functions. This does *not* influence the key size that may be
696e3458e03SJerome Forissier# manipulated through the Cryptographic API.
697e3458e03SJerome Forissier# Set this to a lower value to reduce the TA memory footprint.
698e3458e03SJerome ForissierCFG_TA_BIGNUM_MAX_BITS ?= 2048
699409d2ff0SJerome Forissier
700409d2ff0SJerome Forissier# Define the maximum size, in bits, for big numbers in the TEE core (privileged
701409d2ff0SJerome Forissier# layer).
702409d2ff0SJerome Forissier# This value is an upper limit for the key size in any cryptographic algorithm
703409d2ff0SJerome Forissier# implemented by the TEE core.
704409d2ff0SJerome Forissier# Set this to a lower value to reduce the memory footprint.
705409d2ff0SJerome ForissierCFG_CORE_BIGNUM_MAX_BITS ?= 4096
706a97bc4a0SJens Wiklander
7077fb525f1SJerome Forissier# Not used since libmpa was removed. Force the values to catch build scripts
7087fb525f1SJerome Forissier# that would set = n.
7097fb525f1SJerome Forissier$(call force,CFG_TA_MBEDTLS_MPI,y)
7107fb525f1SJerome Forissier$(call force,CFG_TA_MBEDTLS,y)
711a97bc4a0SJens Wiklander
712a97bc4a0SJens Wiklander# Compile the TA library mbedTLS with self test functions, the functions
713a97bc4a0SJens Wiklander# need to be called to test anything
714a97bc4a0SJens WiklanderCFG_TA_MBEDTLS_SELF_TEST ?= y
715017dfaf8SGabor Szekely
71668689d86SJens Wiklander# By default use tomcrypt as the main crypto lib providing an implementation
71768689d86SJens Wiklander# for the API in <crypto/crypto.h>
71868689d86SJens Wiklander# CFG_CRYPTOLIB_NAME is used as libname and
71968689d86SJens Wiklander# CFG_CRYPTOLIB_DIR is used as libdir when compiling the library
72077327d7aSEdison Ai#
72177327d7aSEdison Ai# It's also possible to configure to use mbedtls instead of tomcrypt.
72277327d7aSEdison Ai# Then the variables should be assigned as "CFG_CRYPTOLIB_NAME=mbedtls" and
72377327d7aSEdison Ai# "CFG_CRYPTOLIB_DIR=lib/libmbedtls" respectively.
72468689d86SJens WiklanderCFG_CRYPTOLIB_NAME ?= tomcrypt
72568689d86SJens WiklanderCFG_CRYPTOLIB_DIR ?= core/lib/libtomcrypt
72668689d86SJens Wiklander
7277fb525f1SJerome Forissier# Not used since libmpa was removed. Force the value to catch build scripts
7287fb525f1SJerome Forissier# that would set = n.
7297fb525f1SJerome Forissier$(call force,CFG_CORE_MBEDTLS_MPI,y)
7307fb525f1SJerome Forissier
73115216d4dSVolodymyr Babchuk# Enable virtualization support. OP-TEE will not work without compatible
73215216d4dSVolodymyr Babchuk# hypervisor if this option is enabled.
73315216d4dSVolodymyr BabchukCFG_VIRTUALIZATION ?= n
73415216d4dSVolodymyr Babchuk
73515216d4dSVolodymyr Babchukifeq ($(CFG_VIRTUALIZATION),y)
73615216d4dSVolodymyr Babchuk$(call force,CFG_CORE_RODATA_NOEXEC,y)
73715216d4dSVolodymyr Babchuk$(call force,CFG_CORE_RWDATA_NOEXEC,y)
738c4e8be26SVolodymyr Babchuk
739c4e8be26SVolodymyr Babchuk# Default number of virtual guests
740c4e8be26SVolodymyr BabchukCFG_VIRT_GUEST_COUNT ?= 2
74115216d4dSVolodymyr Babchukendif
74215216d4dSVolodymyr Babchuk
74317888736SJens Wiklander# Enables backwards compatible derivation of RPMB and SSK keys
74417888736SJens WiklanderCFG_CORE_HUK_SUBKEY_COMPAT ?= y
745a2087649SJerome Forissier
74633b38f8cSRuslan Piasetskyi# Use SoC specific tee_otp_get_die_id() implementation for SSK key generation.
74733b38f8cSRuslan Piasetskyi# This option depends on CFG_CORE_HUK_SUBKEY_COMPAT=y.
74833b38f8cSRuslan PiasetskyiCFG_CORE_HUK_SUBKEY_COMPAT_USE_OTP_DIE_ID ?= n
74933b38f8cSRuslan Piasetskyi
750a2087649SJerome Forissier# Compress and encode conf.mk into the TEE core, and show the encoded string on
751a2087649SJerome Forissier# boot (with severity TRACE_INFO).
752a2087649SJerome ForissierCFG_SHOW_CONF_ON_BOOT ?= n
753dd333f03SJavier Almansa Sobrino
754dd333f03SJavier Almansa Sobrino# Enables support for passing a TPM Event Log stored in secure memory
755145035ffSImre Kis# to a TA or FF-A SP, so a TPM Service could use it to extend any measurement
756dd333f03SJavier Almansa Sobrino# taken before the service was up and running.
757dd333f03SJavier Almansa SobrinoCFG_CORE_TPM_EVENT_LOG ?= n
758ae8c8068SEtienne Carriere
759ae8c8068SEtienne Carriere# When enabled, CFG_SCMI_MSG_DRIVERS embeds SCMI message drivers in the core.
760ae8c8068SEtienne Carriere# Refer to the supported SCMI features embedded upon CFG_SCMI_MSG_*
76128e51326SEtienne Carriere#
762a7a9e3baSEtienne Carriere# CFG_SCMI_MSG_CLOCK embeds SCMI clock protocol support.
76356a1f10eSEtienne Carriere# CFG_SCMI_MSG_RESET_DOMAIN embeds SCMI reset domain protocol support.
76428e51326SEtienne Carriere# CFG_SCMI_MSG_SMT embeds a SMT header in shared device memory buffers
765f37af03eSEtienne Carriere# CFG_SCMI_MSG_VOLTAGE_DOMAIN embeds SCMI voltage domain protocol support.
76628e51326SEtienne Carriere# CFG_SCMI_MSG_SMT_FASTCALL_ENTRY embeds fastcall SMC entry with SMT memory
76728e51326SEtienne Carriere# CFG_SCMI_MSG_SMT_INTERRUPT_ENTRY embeds interrupt entry with SMT memory
76828e51326SEtienne Carriere# CFG_SCMI_MSG_SMT_THREAD_ENTRY embeds threaded entry with SMT memory
769916cc52aSEtienne Carriere# CFG_SCMI_MSG_SHM_MSG embeds a MSG header in cached shared memory buffer
770ae8c8068SEtienne CarriereCFG_SCMI_MSG_DRIVERS ?= n
77128e51326SEtienne Carriereifeq ($(CFG_SCMI_MSG_DRIVERS),y)
772a7a9e3baSEtienne CarriereCFG_SCMI_MSG_CLOCK ?= n
77356a1f10eSEtienne CarriereCFG_SCMI_MSG_RESET_DOMAIN ?= n
774916cc52aSEtienne CarriereCFG_SCMI_MSG_SHM_MSG ?= n
775a58c4d70SEtienne CarriereCFG_SCMI_MSG_SMT ?= n
77628e51326SEtienne CarriereCFG_SCMI_MSG_SMT_FASTCALL_ENTRY ?= n
77728e51326SEtienne CarriereCFG_SCMI_MSG_SMT_INTERRUPT_ENTRY ?= n
77828e51326SEtienne CarriereCFG_SCMI_MSG_SMT_THREAD_ENTRY ?= n
77928e51326SEtienne CarriereCFG_SCMI_MSG_THREAD_ENTRY ?= n
780f37af03eSEtienne CarriereCFG_SCMI_MSG_VOLTAGE_DOMAIN ?= n
78128e51326SEtienne Carriere$(eval $(call cfg-depends-all,CFG_SCMI_MSG_SMT_FASTCALL_ENTRY,CFG_SCMI_MSG_SMT))
78228e51326SEtienne Carriere$(eval $(call cfg-depends-all,CFG_SCMI_MSG_SMT_INTERRUPT_ENTRY,CFG_SCMI_MSG_SMT))
783916cc52aSEtienne Carriere$(eval $(call cfg-depends-one,CFG_SCMI_MSG_SMT_THREAD_ENTRY,CFG_SCMI_MSG_SMT CFG_SCMI_MSG_SHM_MSG))
78416a5030fSEtienne Carriereifeq ($(CFG_SCMI_MSG_SMT),y)
78516a5030fSEtienne Carriere_CFG_SCMI_PTA_SMT_HEADER := y
78616a5030fSEtienne Carriereendif
78716a5030fSEtienne Carriereifeq ($(CFG_SCMI_MSG_SHM_MSG),y)
78816a5030fSEtienne Carriere_CFG_SCMI_PTA_MSG_HEADER := y
78916a5030fSEtienne Carriereendif
79028e51326SEtienne Carriereendif
79142471ecfSJens Wiklander
792*4c4212e9SVincent Guittot# CFG_SCMI_SCPFW, when enabled, embeds the reference SCMI server implementation
793*4c4212e9SVincent Guittot# from SCP-firmware package as an built-in SCMI stack in core. This
794*4c4212e9SVincent Guittot# configuration mandates target product identifier is configured with
795*4c4212e9SVincent Guittot# CFG_SCMI_SCPFW_PRODUCT and the SCP-firmware source tree path with
796*4c4212e9SVincent Guittot# CFG_SCP_FIRMWARE.
797*4c4212e9SVincent GuittotCFG_SCMI_SCPFW ?= n
798*4c4212e9SVincent Guittot
799*4c4212e9SVincent Guittotifeq ($(CFG_SCMI_SCPFW),y)
800*4c4212e9SVincent Guittot$(call force,CFG_SCMI_PTA,y,Required by CFG_SCMI_SCPFW)
801*4c4212e9SVincent Guittotifeq (,$(CFG_SCMI_SCPFW_PRODUCT))
802*4c4212e9SVincent Guittot$(error CFG_SCMI_SCPFW=y requires CFG_SCMI_SCPFW_PRODUCT configuration)
803*4c4212e9SVincent Guittotendif
804*4c4212e9SVincent Guittotifeq (,$(wildcard $(CFG_SCP_FIRMWARE)/CMakeLists.txt))
805*4c4212e9SVincent Guittot$(error CFG_SCMI_SCPFW=y requires CFG_SCP_FIRMWARE configuration)
806*4c4212e9SVincent Guittotendif
807*4c4212e9SVincent Guittotendif #CFG_SCMI_SCPFW
808*4c4212e9SVincent Guittot
809*4c4212e9SVincent Guittotifeq ($(CFG_SCMI_MSG_DRIVERS)-$(CFG_SCMI_SCPFW),y-y)
810*4c4212e9SVincent Guittot$(error CFG_SCMI_MSG_DRIVERS=y and CFG_SCMI_SCPFW=y are mutually exclusive)
811*4c4212e9SVincent Guittotendif
812*4c4212e9SVincent Guittot
813b0a1c250SEtienne Carriere# Enable SCMI PTA interface for REE SCMI agents
814b0a1c250SEtienne CarriereCFG_SCMI_PTA ?= n
81516a5030fSEtienne Carriereifeq ($(CFG_SCMI_PTA),y)
81616a5030fSEtienne Carriere_CFG_SCMI_PTA_SMT_HEADER ?= n
81716a5030fSEtienne Carriere_CFG_SCMI_PTA_MSG_HEADER ?= n
81816a5030fSEtienne Carriereendif
819b0a1c250SEtienne Carriere
82042471ecfSJens Wiklanderifneq ($(CFG_STMM_PATH),)
821f9cd31c5SJelle Sels$(call force,CFG_WITH_STMM_SP,y)
82242471ecfSJens Wiklanderelse
823f9cd31c5SJelle SelsCFG_WITH_STMM_SP ?= n
82442471ecfSJens Wiklanderendif
825f9cd31c5SJelle Selsifeq ($(CFG_WITH_STMM_SP),y)
82642471ecfSJens Wiklander$(call force,CFG_ZLIB,y)
82742471ecfSJens Wiklanderendif
8286915bbbbSJens Wiklander
8296915bbbbSJens Wiklander# When enabled checks that buffers passed to the GP Internal Core API
8306915bbbbSJens Wiklander# comply with the rules added as annotations as part of the definition of
8316915bbbbSJens Wiklander# the API. For example preventing buffers in non-secure shared memory when
8326915bbbbSJens Wiklander# not allowed.
8336915bbbbSJens WiklanderCFG_TA_STRICT_ANNOTATION_CHECKS ?= y
834c56cc686SJens Wiklander
835c56cc686SJens Wiklander# When enabled accepts the DES key sizes excluding parity bits as in
836c56cc686SJens Wiklander# the GP Internal API Specification v1.0
837c56cc686SJens WiklanderCFG_COMPAT_GP10_DES ?= y
838806a85faSJens Wiklander
839806a85faSJens Wiklander# Defines a limit for many levels TAs may call each others.
840806a85faSJens WiklanderCFG_CORE_MAX_SYSCALL_RECURSION ?= 4
841f2dad489SSergiy Kibrik
842f2dad489SSergiy Kibrik# Pseudo-TA to export hardware RNG output to Normal World
843f2dad489SSergiy Kibrik# RNG characteristics are platform specific
844f2dad489SSergiy KibrikCFG_HWRNG_PTA ?= n
845f2dad489SSergiy Kibrikifeq ($(CFG_HWRNG_PTA),y)
846f2dad489SSergiy Kibrik# Output rate of hw_get_random_bytes() in bytes per second, 0: not rate-limited
847f2dad489SSergiy KibrikCFG_HWRNG_RATE ?= 0
848f2dad489SSergiy Kibrik# Quality/entropy of hw_get_random_bytes() per 1024 bits of output data, in bits
849f2dad489SSergiy Kibrikifeq (,$(CFG_HWRNG_QUALITY))
850f2dad489SSergiy Kibrik$(error CFG_HWRNG_QUALITY not defined)
851f2dad489SSergiy Kibrikendif
852f2dad489SSergiy Kibrikendif
85388876632SEtienne Carriere
85488876632SEtienne Carriere# CFG_PREALLOC_RPC_CACHE, when enabled, makes core to preallocate
85588876632SEtienne Carriere# shared memory for each secure thread. When disabled, RPC shared
85688876632SEtienne Carriere# memory is released once the secure thread has completed is execution.
85788876632SEtienne Carriereifeq ($(CFG_WITH_PAGER),y)
85888876632SEtienne CarriereCFG_PREALLOC_RPC_CACHE ?= n
85988876632SEtienne Carriereendif
86088876632SEtienne CarriereCFG_PREALLOC_RPC_CACHE ?= y
8612305544bSClément Léger
8622305544bSClément Léger# When enabled, CFG_DRIVERS_CLK embeds a clock framework in OP-TEE core.
8632305544bSClément Léger# This clock framework allows to describe clock tree and provides functions to
8642305544bSClément Léger# get and configure the clocks.
865dbe94a85SClément Léger# CFG_DRIVERS_CLK_DT embeds devicetree clock parsing support
866804e32d7SClément Léger# CFG_DRIVERS_CLK_FIXED add support for "fixed-clock" compatible clocks
86717fd9102SEtienne Carriere# CFG_DRIVERS_CLK_EARLY_PROBE makes clocks probed at early_init initcall level.
8682305544bSClément LégerCFG_DRIVERS_CLK ?= n
869dbe94a85SClément LégerCFG_DRIVERS_CLK_DT ?= $(call cfg-all-enabled,CFG_DRIVERS_CLK CFG_DT)
870804e32d7SClément LégerCFG_DRIVERS_CLK_FIXED ?= $(CFG_DRIVERS_CLK_DT)
87117fd9102SEtienne CarriereCFG_DRIVERS_CLK_EARLY_PROBE ?= $(CFG_DRIVERS_CLK_DT)
872dbe94a85SClément Léger
873d547c99aSEtienne Carriere$(eval $(call cfg-depends-all,CFG_DRIVERS_CLK_DT,CFG_DRIVERS_CLK CFG_DT))
874d547c99aSEtienne Carriere$(eval $(call cfg-depends-all,CFG_DRIVERS_CLK_FIXED,CFG_DRIVERS_CLK_DT))
875d547c99aSEtienne Carriere
876c78b2c66SEtienne Carriere# When enabled, CFG_DRIVERS_RSTCTRL embeds a reset controller framework in
877c78b2c66SEtienne Carriere# OP-TEE core to provide reset controls on subsystems of the devices.
878c78b2c66SEtienne CarriereCFG_DRIVERS_RSTCTRL ?= n
879c78b2c66SEtienne Carriere
8809e42008dSJoakim Bech# The purpose of this flag is to show a print when booting up the device that
8819e42008dSJoakim Bech# indicates whether the board runs a standard developer configuration or not.
8829e42008dSJoakim Bech# A developer configuration doesn't necessarily has to be secure. The intention
8839e42008dSJoakim Bech# is that the one making products based on OP-TEE should override this flag in
8849e42008dSJoakim Bech# plat-xxx/conf.mk for the platform they're basing their products on after
8859e42008dSJoakim Bech# they've finalized implementing stubbed functionality (see OP-TEE
8869e42008dSJoakim Bech# documentation/Porting guidelines) as well as vendor specific security
8879e42008dSJoakim Bech# configuration.
8889e42008dSJoakim BechCFG_WARN_INSECURE ?= y
8899e42008dSJoakim Bech
890a748f9edSJens Wiklander# Enables warnings for declarations mixed with statements
891a748f9edSJens WiklanderCFG_WARN_DECL_AFTER_STATEMENT ?= y
892b7a623f8SRuchika Gupta
893b7a623f8SRuchika Gupta# Branch Target Identification (part of the ARMv8.5 Extensions) provides a
894b7a623f8SRuchika Gupta# mechanism to limit the set of locations to which computed branch instructions
895b7a623f8SRuchika Gupta# such as BR or BLR can jump. To make use of BTI in TEE core and ldelf on CPU's
896b7a623f8SRuchika Gupta# that support it, enable this option. A GCC toolchain built with
897b7a623f8SRuchika Gupta# --enable-standard-branch-protection is needed to use this option.
898b7a623f8SRuchika GuptaCFG_CORE_BTI ?= n
899b7a623f8SRuchika Gupta
900b7a623f8SRuchika Gupta$(eval $(call cfg-depends-all,CFG_CORE_BTI,CFG_ARM64_core))
901b7a623f8SRuchika Gupta
902b7a623f8SRuchika Gupta# To make use of BTI in user space libraries and TA's on CPU's that support it,
903b7a623f8SRuchika Gupta# enable this option.
904b7a623f8SRuchika GuptaCFG_TA_BTI ?= $(CFG_CORE_BTI)
905b7a623f8SRuchika Gupta
906b7a623f8SRuchika Gupta$(eval $(call cfg-depends-all,CFG_TA_BTI,CFG_ARM64_core))
907b7a623f8SRuchika Gupta
908b7a623f8SRuchika Guptaifeq (y-y,$(CFG_VIRTUALIZATION)-$(call cfg-one-enabled, CFG_TA_BTI CFG_CORE_BTI))
909b7a623f8SRuchika Gupta$(error CFG_VIRTUALIZATION and BTI are currently incompatible)
910b7a623f8SRuchika Guptaendif
911b7a623f8SRuchika Gupta
912b7a623f8SRuchika Guptaifeq (y-y,$(CFG_PAGED_USER_TA)-$(CFG_TA_BTI))
913b7a623f8SRuchika Gupta$(error CFG_PAGED_USER_TA and CFG_TA_BTI are currently incompatible)
914b7a623f8SRuchika Guptaendif
915c2d44948SJens Wiklander
916a0e8ffe9SJens Wiklander# Memory Tagging Extension (part of the ARMv8.5 Extensions) implements lock
917a0e8ffe9SJens Wiklander# and key access to memory. This is a hardware supported alternative to
918a0e8ffe9SJens Wiklander# CFG_CORE_SANITIZE_KADDRESS which covers both S-EL1 and S-EL0.
919a0e8ffe9SJens WiklanderCFG_MEMTAG ?= n
920a0e8ffe9SJens Wiklander
921a0e8ffe9SJens Wiklander$(eval $(call cfg-depends-all,CFG_MEMTAG,CFG_ARM64_core))
922a0e8ffe9SJens Wiklanderifeq (y-y,$(CFG_CORE_SANITIZE_KADDRESS)-$(CFG_MEMTAG))
923a0e8ffe9SJens Wiklander$(error CFG_CORE_SANITIZE_KADDRESS and CFG_MEMTAG are not compatible)
924a0e8ffe9SJens Wiklanderendif
925a0e8ffe9SJens Wiklanderifeq (y-y,$(CFG_WITH_PAGER)-$(CFG_MEMTAG))
926a0e8ffe9SJens Wiklander$(error CFG_WITH_PAGER and CFG_MEMTAG are not compatible)
927a0e8ffe9SJens Wiklanderendif
928a0e8ffe9SJens Wiklander
929c2d44948SJens Wiklander# CFG_CORE_ASYNC_NOTIF is defined by the platform to enable enables support
930c2d44948SJens Wiklander# for sending asynchronous notifications to normal world. Note that an
931c2d44948SJens Wiklander# interrupt ID must be configurged by the platform too. Currently is only
932c2d44948SJens Wiklander# CFG_CORE_ASYNC_NOTIF_GIC_INTID defined.
933c2d44948SJens WiklanderCFG_CORE_ASYNC_NOTIF ?= n
934a51d45b5SJens Wiklander
935a51d45b5SJens Wiklander$(eval $(call cfg-enable-all-depends,CFG_MEMPOOL_REPORT_LAST_OFFSET, \
936a51d45b5SJens Wiklander	 CFG_WITH_STATS))
937bb329115SRuchika Gupta
93893dc6b29SJens Wiklander# Pointer Authentication (part of ARMv8.3 Extensions) provides instructions
93993dc6b29SJens Wiklander# for signing and authenticating pointers against secret keys. These can
94093dc6b29SJens Wiklander# be used to mitigate ROP (Return oriented programming) attacks. This is
94193dc6b29SJens Wiklander# currently done by instructing the compiler to add paciasp/autiasp at the
94293dc6b29SJens Wiklander# begging and end of functions to sign and verify ELR.
94393dc6b29SJens Wiklander#
94493dc6b29SJens Wiklander# The CFG_CORE_PAUTH enables these instructions for the core parts
94593dc6b29SJens Wiklander# executing at EL1, with one secret key per thread and one secret key per
94693dc6b29SJens Wiklander# physical CPU.
94793dc6b29SJens Wiklander#
94893dc6b29SJens Wiklander# The CFG_TA_PAUTH option enables these instructions for TA's at EL0. When
94993dc6b29SJens Wiklander# this option is enabled, TEE core will initialize secret keys per TA.
95093dc6b29SJens WiklanderCFG_CORE_PAUTH ?= n
95193dc6b29SJens WiklanderCFG_TA_PAUTH ?= $(CFG_CORE_PAUTH)
952bb329115SRuchika Gupta
95393dc6b29SJens Wiklander$(eval $(call cfg-depends-all,CFG_CORE_PAUTH,CFG_ARM64_core))
954bb329115SRuchika Gupta$(eval $(call cfg-depends-all,CFG_TA_PAUTH,CFG_ARM64_core))
9556b35a0abSRuchika Gupta
95693dc6b29SJens Wiklanderifeq (y-y,$(CFG_VIRTUALIZATION)-$(CFG_CORE_PAUTH))
95793dc6b29SJens Wiklander$(error CFG_VIRTUALIZATION and CFG_CORE_PAUTH are currently incompatible)
95893dc6b29SJens Wiklanderendif
9596b35a0abSRuchika Guptaifeq (y-y,$(CFG_VIRTUALIZATION)-$(CFG_TA_PAUTH))
9606b35a0abSRuchika Gupta$(error CFG_VIRTUALIZATION and CFG_TA_PAUTH are currently incompatible)
9616b35a0abSRuchika Guptaendif
9626b35a0abSRuchika Gupta
9636b35a0abSRuchika Guptaifeq (y-y,$(CFG_TA_GPROF_SUPPORT)-$(CFG_TA_PAUTH))
9646b35a0abSRuchika Gupta$(error CFG_TA_GPROF_SUPPORT and CFG_TA_PAUTH are currently incompatible)
9656b35a0abSRuchika Guptaendif
9666b35a0abSRuchika Gupta
9676b35a0abSRuchika Guptaifeq (y-y,$(CFG_FTRACE_SUPPORT)-$(CFG_TA_PAUTH))
9686b35a0abSRuchika Gupta$(error CFG_FTRACE_SUPPORT and CFG_TA_PAUTH are currently incompatible)
9696b35a0abSRuchika Guptaendif
970011a8f96SClément Léger
971011a8f96SClément Léger# Enable support for generic watchdog registration
972011a8f96SClément Léger# This watchdog will then be usable by non-secure world through SMC calls.
973011a8f96SClément LégerCFG_WDT ?= n
974cb60bce4SClément Léger
975cb60bce4SClément Léger# Enable watchdog SMC handling compatible with arm-smc-wdt Linux driver
976cb60bce4SClément Léger# When enabled, CFG_WDT_SM_HANDLER_ID must be defined with a SMC ID
977cb60bce4SClément LégerCFG_WDT_SM_HANDLER ?= n
978cb60bce4SClément Léger
979cb60bce4SClément Léger$(eval $(call cfg-enable-all-depends,CFG_WDT_SM_HANDLER,CFG_WDT))
980cb60bce4SClément Légerifeq (y-,$(CFG_WDT_SM_HANDLER)-$(CFG_WDT_SM_HANDLER_ID))
981cb60bce4SClément Léger$(error CFG_WDT_SM_HANDLER_ID must be defined when enabling CFG_WDT_SM_HANDLER)
982cb60bce4SClément Légerendif
98334d244bfSClément Léger
98434d244bfSClément Léger# Allow using the udelay/mdelay function for platforms without ARM generic timer
98534d244bfSClément Léger# extension. When set to 'n', the plat_get_freq() function must be defined by
98634d244bfSClément Léger# the platform code
98734d244bfSClément LégerCFG_CORE_HAS_GENERIC_TIMER ?= y
988f3f9432fSClément Léger
989f3f9432fSClément Léger# Enable RTC API
990f3f9432fSClément LégerCFG_DRIVERS_RTC ?= n
991cea1eb0bSClément Léger
992cea1eb0bSClément Léger# Enable PTA for RTC access from non-secure world
993cea1eb0bSClément LégerCFG_RTC_PTA ?= n
994952f5260SRuchika Gupta
995952f5260SRuchika Gupta# Enable TPM2
996952f5260SRuchika GuptaCFG_DRIVERS_TPM2 ?= n
9975916069bSRuchika GuptaCFG_DRIVERS_TPM2_MMIO ?= n
9982e1b85feSRuchika Guptaifeq ($(CFG_CORE_TPM_EVENT_LOG),y)
9992e1b85feSRuchika GuptaCFG_CORE_TCG_PROVIDER ?= $(CFG_DRIVERS_TPM2)
10002e1b85feSRuchika Guptaendif
10011fdb1c4fSJelle Sels
10021fdb1c4fSJelle Sels# Enable the FF-A SPMC tests in xtests
10031fdb1c4fSJelle SelsCFG_SPMC_TESTS ?= n
1004bfdeae23SJens Wiklander
1005bfdeae23SJens Wiklander# Allocate the translation tables needed to map the S-EL0 application
1006bfdeae23SJens Wiklander# loaded
1007bfdeae23SJens WiklanderCFG_CORE_PREALLOC_EL0_TBLS ?= n
1008bfdeae23SJens Wiklanderifeq (y-y,$(CFG_CORE_PREALLOC_EL0_TBLS)-$(CFG_WITH_PAGER))
1009bfdeae23SJens Wiklander$(error "CFG_WITH_PAGER can't support CFG_CORE_PREALLOC_EL0_TBLS")
1010bfdeae23SJens Wiklanderendif
1011cb94c145SWeizhao Jiang
1012cb94c145SWeizhao Jiang# User TA runtime context dump.
1013cb94c145SWeizhao Jiang# When this option is enabled, OP-TEE provides a debug method for
1014cb94c145SWeizhao Jiang# developer to dump user TA's runtime context, including TA's heap stats.
1015cb94c145SWeizhao Jiang# Developer can open a stats PTA session and then invoke command
1016cb94c145SWeizhao Jiang# STATS_CMD_TA_STATS to get the context of loaded TAs.
1017cb94c145SWeizhao JiangCFG_TA_STATS ?= n
10187e75ca54SJens Wiklander
10197e75ca54SJens Wiklander# Enables best effort mitigations against fault injected when the hardware
10207e75ca54SJens Wiklander# is tampered with. Details in lib/libutils/ext/include/fault_mitigation.h
10217e75ca54SJens WiklanderCFG_FAULT_MITIGATION ?= y
10228bbc2e9cSJens Wiklander
10238bbc2e9cSJens Wiklander# Enable TEE Internal Core API v1.1 compatibility for in-tree TAs
10248bbc2e9cSJens WiklanderCFG_TA_OPTEE_CORE_API_COMPAT_1_1 ?= y
1025