xref: /optee_os/mk/config.mk (revision a58c4d706d2333d2b21a3eba7e2ec0cb257bca1d)
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
353f17b838SEtienne Carriere# Define DEBUG=1 to compile without optimization (forces -O0)
36b0104773SPascal Brand# DEBUG=1
37b0104773SPascal Brand
384ec2358eSJerome Forissier# If y, enable debug features of the TEE core (assertions and lock checks
394ec2358eSJerome Forissier# are enabled, panic and assert messages are more verbose, data and prefetch
404ec2358eSJerome Forissier# aborts show a stack dump). When disabled, the NDEBUG directive is defined
414ec2358eSJerome Forissier# so assertions are disabled.
424ec2358eSJerome ForissierCFG_TEE_CORE_DEBUG ?= y
43b0104773SPascal Brand
443f58e4ecSOvidiu Mihalachi# Log levels for the TEE core. Defines which core messages are displayed
453f58e4ecSOvidiu Mihalachi# on the secure console. Disabling core log (level set to 0) also disables
463f58e4ecSOvidiu Mihalachi# logs from the TAs.
4709ca9f8bSJerome Forissier# 0: none
4809ca9f8bSJerome Forissier# 1: error
4909ca9f8bSJerome Forissier# 2: error + warning
5009ca9f8bSJerome Forissier# 3: error + warning + debug
5109ca9f8bSJerome Forissier# 4: error + warning + debug + flow
52e0042c88SPascal BrandCFG_TEE_CORE_LOG_LEVEL ?= 1
533f58e4ecSOvidiu Mihalachi
543f58e4ecSOvidiu Mihalachi# TA log level
553f58e4ecSOvidiu Mihalachi# If user-mode library libutils.a is built with CFG_TEE_TA_LOG_LEVEL=0,
563f58e4ecSOvidiu Mihalachi# TA tracing is disabled regardless of the value of CFG_TEE_TA_LOG_LEVEL
573f58e4ecSOvidiu Mihalachi# when the TA is built.
58e0042c88SPascal BrandCFG_TEE_TA_LOG_LEVEL ?= 1
59b0104773SPascal Brand
607c876f12SPascal Brand# TA enablement
617c876f12SPascal Brand# When defined to "y", TA traces are output according to
627c876f12SPascal Brand# CFG_TEE_TA_LOG_LEVEL. Otherwise, they are not output at all
637c876f12SPascal BrandCFG_TEE_CORE_TA_TRACE ?= y
64b0104773SPascal Brand
658c8e1441SJerome Forissier# If y, enable the memory leak detection feature in the bget memory allocator.
668c8e1441SJerome Forissier# When this feature is enabled, calling mdbg_check(1) will print a list of all
678c8e1441SJerome Forissier# the currently allocated buffers and the location of the allocation (file and
688c8e1441SJerome Forissier# line number).
698c8e1441SJerome Forissier# Note: make sure the log level is high enough for the messages to show up on
708c8e1441SJerome Forissier# the secure console! For instance:
718c8e1441SJerome Forissier# - To debug user-mode (TA) allocations: build OP-TEE *and* the TA with:
728c8e1441SJerome Forissier#   $ make CFG_TEE_TA_MALLOC_DEBUG=y CFG_TEE_TA_LOG_LEVEL=3
738c8e1441SJerome Forissier# - To debug TEE core allocations: build OP-TEE with:
748c8e1441SJerome Forissier#   $ make CFG_TEE_CORE_MALLOC_DEBUG=y CFG_TEE_CORE_LOG_LEVEL=3
750fcbddd4SSY ChiuCFG_TEE_CORE_MALLOC_DEBUG ?= n
760fcbddd4SSY ChiuCFG_TEE_TA_MALLOC_DEBUG ?= n
77c2ce4186SJens Wiklander# Prints an error message and dumps the stack on failed memory allocations
78c2ce4186SJens Wiklander# using malloc() and friends.
79c2ce4186SJens WiklanderCFG_CORE_DUMP_OOM ?= $(CFG_TEE_CORE_MALLOC_DEBUG)
800fcbddd4SSY Chiu
812bfab756SJerome Forissier# Mask to select which messages are prefixed with long debugging information
8264fad262SVolodymyr Babchuk# (severity, core ID, thread ID, component name, function name, line number)
8364fad262SVolodymyr Babchuk# based on the message level. If BIT(level) is set, the long prefix is shown.
842bfab756SJerome Forissier# Otherwise a short prefix is used (severity and component name only).
85f4aa5b11SJerome Forissier# Levels: 0=none 1=error 2=info 3=debug 4=flow
862bfab756SJerome ForissierCFG_MSG_LONG_PREFIX_MASK ?= 0x1a
87f4aa5b11SJerome Forissier
88120c43adSJerome Forissier# PRNG configuration
897018ae01SSY Chiu# If CFG_WITH_SOFTWARE_PRNG is enabled, crypto provider provided
907018ae01SSY Chiu# software PRNG implementation is used.
917018ae01SSY Chiu# Otherwise, you need to implement hw_get_random_byte() for your platform
927018ae01SSY ChiuCFG_WITH_SOFTWARE_PRNG ?= y
93120c43adSJerome Forissier
94120c43adSJerome Forissier# Number of threads
95120c43adSJerome ForissierCFG_NUM_THREADS ?= 2
96ab35d7adSCedric Chaumont
97ab35d7adSCedric Chaumont# API implementation version
98ab35d7adSCedric ChaumontCFG_TEE_API_VERSION ?= GPD-1.1-dev
99ab35d7adSCedric Chaumont
100ab35d7adSCedric Chaumont# Implementation description (implementation-dependent)
101ab35d7adSCedric ChaumontCFG_TEE_IMPL_DESCR ?= OPTEE
102ab35d7adSCedric Chaumont
10329cff5cfSJerome Forissier# Should OPTEE_SMC_CALL_GET_OS_REVISION return a build identifier to Normal
10429cff5cfSJerome Forissier# World?
10529cff5cfSJerome ForissierCFG_OS_REV_REPORTS_GIT_SHA1 ?= y
10629cff5cfSJerome Forissier
107ab35d7adSCedric Chaumont# Trusted OS implementation version
1084bf425c1SJens WiklanderTEE_IMPL_VERSION ?= $(shell git describe --always --dirty=-dev 2>/dev/null || echo Unknown)
10929cff5cfSJerome Forissierifeq ($(CFG_OS_REV_REPORTS_GIT_SHA1),y)
11029cff5cfSJerome ForissierTEE_IMPL_GIT_SHA1 := 0x$(shell git rev-parse --short=8 HEAD 2>/dev/null || echo 0)
11129cff5cfSJerome Forissierelse
11229cff5cfSJerome ForissierTEE_IMPL_GIT_SHA1 := 0x0
11329cff5cfSJerome Forissierendif
11435c507f2SJerome Forissier# The following values are not extracted from the "git describe" output because
11535c507f2SJerome Forissier# we might be outside of a Git environment, or the tree may have been cloned
11635c507f2SJerome Forissier# with limited depth not including any tag, so there is really no guarantee
11735c507f2SJerome Forissier# that TEE_IMPL_VERSION contains the major and minor revision numbers.
118a83aec29SJerome ForissierCFG_OPTEE_REVISION_MAJOR ?= 3
119490b9f94SJerome ForissierCFG_OPTEE_REVISION_MINOR ?= 8
120ab35d7adSCedric Chaumont
121ab35d7adSCedric Chaumont# Trusted OS implementation manufacturer name
122ab35d7adSCedric ChaumontCFG_TEE_MANUFACTURER ?= LINARO
123ab35d7adSCedric Chaumont
124ab35d7adSCedric Chaumont# Trusted firmware version
125ab35d7adSCedric ChaumontCFG_TEE_FW_IMPL_VERSION ?= FW_IMPL_UNDEF
126ab35d7adSCedric Chaumont
127ab35d7adSCedric Chaumont# Trusted OS implementation manufacturer name
128ab35d7adSCedric ChaumontCFG_TEE_FW_MANUFACTURER ?= FW_MAN_UNDEF
129ab35d7adSCedric Chaumont
130b44708c1SJerome Forissier# Rich Execution Environment (REE) file system support: normal world OS
131b44708c1SJerome Forissier# provides the actual storage.
132b44708c1SJerome Forissier# This is the default FS when enabled (i.e., the one used when
133b44708c1SJerome Forissier# TEE_STORAGE_PRIVATE is passed to the trusted storage API)
134b44708c1SJerome ForissierCFG_REE_FS ?= y
135bc420748SJens Wiklander
13688e6e089SJerome Forissier# RPMB file system support
13788e6e089SJerome ForissierCFG_RPMB_FS ?= n
13888e6e089SJerome Forissier
13988e6e089SJerome Forissier# Device identifier used when CFG_RPMB_FS = y.
14088e6e089SJerome Forissier# The exact meaning of this value is platform-dependent. On Linux, the
14188e6e089SJerome Forissier# tee-supplicant process will open /dev/mmcblk<id>rpmb
14288e6e089SJerome ForissierCFG_RPMB_FS_DEV_ID ?= 0
14388e6e089SJerome Forissier
1447d97159bSManuel Huber# This config variable determines the number of entries read in from RPMB at
1457d97159bSManuel Huber# once whenever a function traverses the RPMB FS. Increasing the default value
1467d97159bSManuel Huber# has the following consequences:
1477d97159bSManuel Huber# - More memory required on heap. A single FAT entry currently has a size of
1487d97159bSManuel Huber#   256 bytes.
1497d97159bSManuel Huber# - Potentially significant speed-ups for RPMB I/O. Depending on how many
1507d97159bSManuel Huber#   entries a function needs to traverse, the number of time-consuming RPMB
1517d97159bSManuel Huber#   read-in operations can be reduced.
1527d97159bSManuel Huber# Chosing a proper value is both platform- (available memory) and use-case-
1537d97159bSManuel Huber# dependent (potential number of FAT fs entries), so overwrite in platform
1547d97159bSManuel Huber# config files
1557d97159bSManuel HuberCFG_RPMB_FS_RD_ENTRIES ?= 8
1567d97159bSManuel Huber
157ed1993b7SJerome Forissier# Enables RPMB key programming by the TEE, in case the RPMB partition has not
158ed1993b7SJerome Forissier# been configured yet.
159ed1993b7SJerome Forissier# !!! Security warning !!!
160ed1993b7SJerome Forissier# Do *NOT* enable this in product builds, as doing so would allow the TEE to
161ed1993b7SJerome Forissier# leak the RPMB key.
162ed1993b7SJerome Forissier# This option is useful in the following situations:
163ed1993b7SJerome Forissier# - Testing
164ed1993b7SJerome Forissier# - RPMB key provisioning in a controlled environment (factory setup)
165ed1993b7SJerome ForissierCFG_RPMB_WRITE_KEY ?= n
166ed1993b7SJerome Forissier
167bc420748SJens Wiklander# Embed public part of this key in OP-TEE OS
168bc420748SJens WiklanderTA_SIGN_KEY ?= keys/default_ta.pem
169c4553de7SJerome Forissier
170c4553de7SJerome Forissier# Include lib/libutils/isoc in the build? Most platforms need this, but some
171c4553de7SJerome Forissier# may not because they obtain the isoc functions from elsewhere
172c4553de7SJerome ForissierCFG_LIBUTILS_WITH_ISOC ?= y
173fce4cfa1SJens Wiklander
1740de9a5fbSJens Wiklander# Enables floating point support for user TAs
1750de9a5fbSJens Wiklander# ARM32: EABI defines both a soft-float ABI and a hard-float ABI,
1760de9a5fbSJens Wiklander#	 hard-float is basically a super set of soft-float. Hard-float
1770de9a5fbSJens Wiklander#	 requires all the support routines provided for soft-float, but the
1780de9a5fbSJens Wiklander#	 compiler may choose to optimize to not use some of them and use
1790de9a5fbSJens Wiklander#	 the floating-point registers instead.
1800de9a5fbSJens Wiklander# ARM64: EABI doesn't define a soft-float ABI, everything is hard-float (or
1810de9a5fbSJens Wiklander#	 nothing with ` -mgeneral-regs-only`)
1820de9a5fbSJens Wiklander# With CFG_TA_FLOAT_SUPPORT enabled TA code is free use floating point types
1830de9a5fbSJens WiklanderCFG_TA_FLOAT_SUPPORT ?= y
184923c1f34SJens Wiklander
1857411e0e1SJerome Forissier# Stack unwinding: print a stack dump to the console on core or TA abort, or
1867411e0e1SJerome Forissier# when a TA panics.
18731a29642SJerome Forissier# If CFG_UNWIND is enabled, both the kernel and user mode call stacks can be
18831a29642SJerome Forissier# unwound (not paged TAs, however).
18931a29642SJerome Forissier# Note that 32-bit ARM code needs unwind tables for this to work, so enabling
19031a29642SJerome Forissier# this option will increase the size of the 32-bit TEE binary by a few KB.
19131a29642SJerome Forissier# Similarly, TAs have to be compiled with -funwind-tables (default when the
19231a29642SJerome Forissier# option is set) otherwise they can't be unwound.
1937411e0e1SJerome Forissier# Warning: since the unwind sequence for user-mode (TA) code is implemented in
1947411e0e1SJerome Forissier# the privileged layer of OP-TEE, enabling this feature will weaken the
1957411e0e1SJerome Forissier# user/kernel isolation. Therefore it should be disabled in release builds.
1963f17b838SEtienne Carriereifeq ($(CFG_TEE_CORE_DEBUG),y)
19731a29642SJerome ForissierCFG_UNWIND ?= y
198923c1f34SJens Wiklanderendif
1996fbac37eSJens Wiklander
2006fbac37eSJens Wiklander# Enable support for dynamically loaded user TAs
2016fbac37eSJens WiklanderCFG_WITH_USER_TA ?= y
2022a142248SJens Wiklander
20324d49094SJerome Forissier# Choosing the architecture(s) of user-mode libraries (used by TAs)
20424d49094SJerome Forissier#
20524d49094SJerome Forissier# Platforms may define a list of supported architectures for user-mode code
20624d49094SJerome Forissier# by setting $(supported-ta-targets). Valid values are "ta_arm32", "ta_arm64",
20724d49094SJerome Forissier# "ta_arm32 ta_arm64" and "ta_arm64 ta_arm32".
20824d49094SJerome Forissier# $(supported-ta-targets) defaults to "ta_arm32" when the TEE core is 32-bits,
20924d49094SJerome Forissier# and "ta_arm32 ta_arm64" when it is 64-bits (that is, when CFG_ARM64_core=y).
21024d49094SJerome Forissier# The first entry in $(supported-ta-targets) has a special role, see
21124d49094SJerome Forissier# CFG_USER_TA_TARGET_<ta-name> below.
21224d49094SJerome Forissier#
21324d49094SJerome Forissier# CFG_USER_TA_TARGETS may be defined to restrict $(supported-ta-targets) or
21424d49094SJerome Forissier# change the order of the values.
21524d49094SJerome Forissier#
21624d49094SJerome Forissier# The list of TA architectures is ultimately stored in $(ta-targets).
21724d49094SJerome Forissier
21824d49094SJerome Forissier# CFG_USER_TA_TARGET_<ta-name> (for example, CFG_USER_TA_TARGET_avb), if
21924d49094SJerome Forissier# defined, selects the unique TA architecture mode for building the in-tree TA
22024d49094SJerome Forissier# <ta-name>. Can be either ta_arm32 or ta_arm64.
22124d49094SJerome Forissier# By default, in-tree TAs are built using the first architecture specified in
22224d49094SJerome Forissier# $(ta-targets).
22324d49094SJerome Forissier
2247dfff131SJerome Forissier# Address Space Layout Randomization for user-mode Trusted Applications
2257dfff131SJerome Forissier#
2267dfff131SJerome Forissier# When this flag is enabled, the ELF loader will introduce a random offset
2277dfff131SJerome Forissier# when mapping the application in user space. ASLR makes the exploitation of
2287dfff131SJerome Forissier# memory corruption vulnerabilities more difficult.
22987372da4SJens WiklanderCFG_TA_ASLR ?= y
2307dfff131SJerome Forissier
2317dfff131SJerome Forissier# How much ASLR may shift the base address (in pages). The base address is
2327dfff131SJerome Forissier# randomly shifted by an integer number of pages comprised between these two
2337dfff131SJerome Forissier# values. Bigger ranges are more secure because they make the addresses harder
2347dfff131SJerome Forissier# to guess at the expense of using more memory for the page tables.
2357dfff131SJerome ForissierCFG_TA_ASLR_MIN_OFFSET_PAGES ?= 0
2367dfff131SJerome ForissierCFG_TA_ASLR_MAX_OFFSET_PAGES ?= 128
2377dfff131SJerome Forissier
238170e9084SJens Wiklander# Address Space Layout Randomization for TEE Core
239170e9084SJens Wiklander#
240170e9084SJens Wiklander# When this flag is enabled, the early init code will introduce a random
241170e9084SJens Wiklander# offset when mapping TEE Core. ASLR makes the exploitation of memory
242170e9084SJens Wiklander# corruption vulnerabilities more difficult.
24387372da4SJens WiklanderCFG_CORE_ASLR ?= y
244170e9084SJens Wiklander
245ee664c19SJerome Forissier# Load user TAs from the REE filesystem via tee-supplicant
246ee664c19SJerome ForissierCFG_REE_FS_TA ?= y
247ee664c19SJerome Forissier
2487db24ad6SJerome Forissier# Pre-authentication of TA binaries loaded from the REE filesystem
2497db24ad6SJerome Forissier#
2507db24ad6SJerome Forissier# - If CFG_REE_FS_TA_BUFFERED=y: load TA binary into a temporary buffer in the
2517db24ad6SJerome Forissier#   "Secure DDR" pool, check the signature, then process the file only if it is
2527db24ad6SJerome Forissier#   valid.
2537db24ad6SJerome Forissier# - If disabled: hash the binaries as they are being processed and verify the
2547db24ad6SJerome Forissier#   signature as a last step.
255e6e68745SJerome ForissierCFG_REE_FS_TA_BUFFERED ?= n
2567db24ad6SJerome Forissier$(eval $(call cfg-depends-all,CFG_REE_FS_TA_BUFFERED,CFG_REE_FS_TA))
2577db24ad6SJerome Forissier
258d0c63614SJerome Forissier# Support for loading user TAs from a special section in the TEE binary.
259d0c63614SJerome Forissier# Such TAs are available even before tee-supplicant is available (hence their
260d0c63614SJerome Forissier# name), but note that many services exported to TAs may need tee-supplicant,
261d0c63614SJerome Forissier# so early use is limited to a subset of the TEE Internal Core API (crypto...)
262d0c63614SJerome Forissier# To use this feature, set EARLY_TA_PATHS to the paths to one or more TA ELF
263d0c63614SJerome Forissier# file(s). For example:
264d0c63614SJerome Forissier#   $ make ... \
265d0c63614SJerome Forissier#     EARLY_TA_PATHS="path/to/8aaaf200-2450-11e4-abe2-0002a5d5c51b.stripped.elf \
266d0c63614SJerome Forissier#                     path/to/cb3e5ba0-adf1-11e0-998b-0002a5d5c51b.stripped.elf"
267d0c63614SJerome Forissier# Typical build steps:
268d0c63614SJerome Forissier#   $ make ta_dev_kit CFG_EARLY_TA=y # Create the dev kit (user mode libraries,
269d0c63614SJerome Forissier#                                    # headers, makefiles), ready to build TAs.
270d0c63614SJerome Forissier#                                    # CFG_EARLY_TA=y is optional, it prevents
271d0c63614SJerome Forissier#                                    # later library recompilations.
272d0c63614SJerome Forissier#   <build some TAs>
273d0c63614SJerome Forissier#   $ make EARLY_TA_PATHS=<paths>    # Build OP-TEE and embbed the TA(s)
2743638ea32SJens Wiklander#
2753638ea32SJens Wiklander# Another option is CFG_IN_TREE_EARLY_TAS which is used to point at
2763638ea32SJens Wiklander# in-tree TAs. CFG_IN_TREE_EARLY_TAS is formatted as:
2773638ea32SJens Wiklander# <name-of-ta>/<uuid>
2783638ea32SJens Wiklander# for instance avb/023f8f1a-292a-432b-8fc4-de8471358067
2793638ea32SJens Wiklanderifneq ($(EARLY_TA_PATHS)$(CFG_IN_TREE_EARLY_TAS),)
280d0c63614SJerome Forissier$(call force,CFG_EARLY_TA,y)
281d0c63614SJerome Forissierelse
282d0c63614SJerome ForissierCFG_EARLY_TA ?= n
283d0c63614SJerome Forissierendif
284509a9802SJerome Forissierifeq ($(CFG_EARLY_TA),y)
285509a9802SJerome Forissier$(call force,CFG_ZLIB,y)
286509a9802SJerome Forissierendif
287d0c63614SJerome Forissier
288a884c935SJens Wiklander# Enable paging, requires SRAM, can't be enabled by default
289a884c935SJens WiklanderCFG_WITH_PAGER ?= n
290a884c935SJens Wiklander
291ab0df69eSJerome Forissier# Runtime lock dependency checker: ensures that a proper locking hierarchy is
292ab0df69eSJerome Forissier# used in the TEE core when acquiring and releasing mutexes. Any violation will
293ab0df69eSJerome Forissier# cause a panic as soon as the invalid locking condition is detected. If
294ab0df69eSJerome Forissier# CFG_UNWIND is enabled, the algorithm records the call stacks when locks are
295ab0df69eSJerome Forissier# taken, and prints them when a potential deadlock is found.
296ab0df69eSJerome Forissier# Expect a significant performance impact when enabling this.
297ab0df69eSJerome ForissierCFG_LOCKDEP ?= n
298ab0df69eSJerome Forissier
299bde8a250SJoakim Bech# BestFit algorithm in bget reduces the fragmentation of the heap when running
300ab0df69eSJerome Forissier# with the pager enabled or lockdep
301ab0df69eSJerome ForissierCFG_CORE_BGET_BESTFIT ?= $(call cfg-one-enabled, CFG_WITH_PAGER CFG_LOCKDEP)
302bde8a250SJoakim Bech
303a884c935SJens Wiklander# Use the pager for user TAs
304a884c935SJens WiklanderCFG_PAGED_USER_TA ?= $(CFG_WITH_PAGER)
305a884c935SJens Wiklander
306be715239SJens Wiklander# Enable support for detected undefined behavior in C
3071d171f95SJens Wiklander# Uses a lot of memory, can't be enabled by default
308be715239SJens WiklanderCFG_CORE_SANITIZE_UNDEFINED ?= n
309b908c675SJens Wiklander
3101d171f95SJens Wiklander# Enable Kernel Address sanitizer, has a huge performance impact, uses a
3111d171f95SJens Wiklander# lot of memory and need platform specific adaptations, can't be enabled by
3121d171f95SJens Wiklander# default
3131d171f95SJens WiklanderCFG_CORE_SANITIZE_KADDRESS ?= n
3141d171f95SJens Wiklander
315b908c675SJens Wiklander# Device Tree support
316c95b9511SEtienne Carriere#
317c95b9511SEtienne Carriere# When CFG_DT is enabled core embeds the FDT library (libfdt) allowing
318c95b9511SEtienne Carriere# device tree blob (DTB) parsing from the core.
319c95b9511SEtienne Carriere#
320c95b9511SEtienne Carriere# When CFG_DT is enabled, the TEE _start function expects to find
321c95b9511SEtienne Carriere# the address of a DTB in register X2/R2 provided by the early boot stage
322c95b9511SEtienne Carriere# or value 0 if boot stage provides no DTB.
323c95b9511SEtienne Carriere#
324c95b9511SEtienne Carriere# When CFG_EMBED_DTB is enabled, CFG_EMBED_DTB_SOURCE_FILE shall define the
325c95b9511SEtienne Carriere# relative path of a DTS file located in core/arch/$(ARCH)/dts.
326c95b9511SEtienne Carriere# The DTS file is compiled into a DTB file which content is embedded in a
327c95b9511SEtienne Carriere# read-only section of the core.
328c95b9511SEtienne Carriereifneq ($(strip $(CFG_EMBED_DTB_SOURCE_FILE)),)
329c95b9511SEtienne CarriereCFG_EMBED_DTB ?= y
330c95b9511SEtienne Carriereendif
331c95b9511SEtienne Carriereifeq ($(CFG_EMBED_DTB),y)
332c95b9511SEtienne Carriere$(call force,CFG_DT,y)
333c95b9511SEtienne Carriereendif
334c95b9511SEtienne CarriereCFG_EMBED_DTB ?= n
335b908c675SJens WiklanderCFG_DT ?= n
33676358becSJens Wiklander
33776358becSJens Wiklander# Maximum size of the Device Tree Blob, has to be large enough to allow
33876358becSJens Wiklander# editing of the supplied DTB.
33976358becSJens WiklanderCFG_DTB_MAX_SIZE ?= 0x10000
3404d62e91aSVictor Chong
3410a3ad9b6SBryan O'Donoghue# Device Tree Overlay support.
3420a3ad9b6SBryan O'Donoghue# This define enables support for an OP-TEE provided DTB overlay.
3430a3ad9b6SBryan O'Donoghue# One of two modes is supported in this case:
3440a3ad9b6SBryan O'Donoghue# 1. Append OP-TEE nodes to an existing DTB overlay located at CFG_DT_ADDR or
3450a3ad9b6SBryan O'Donoghue#    passed in arg2
3460a3ad9b6SBryan O'Donoghue# 2. Generate a new DTB overlay at CFG_DT_ADDR
3470a3ad9b6SBryan O'Donoghue# A subsequent boot stage must then merge the generated overlay DTB into a main
3480a3ad9b6SBryan O'Donoghue# DTB using the standard fdt_overlay_apply() method.
3490a3ad9b6SBryan O'DonoghueCFG_EXTERNAL_DTB_OVERLAY ?= n
3500a3ad9b6SBryan O'Donoghue
35135964dc9SEtienne Carriere# Enable core self tests and related pseudo TAs
3524d62e91aSVictor ChongCFG_TEE_CORE_EMBED_INTERNAL_TESTS ?= y
3536d96f208Syanyan-wrs
3546d96f208Syanyan-wrs# This option enables OP-TEE to respond to SMP boot request: the Rich OS
3556d96f208Syanyan-wrs# issues this to request OP-TEE to release secondaries cores out of reset,
3566d96f208Syanyan-wrs# with specific core number and non-secure entry address.
3576d96f208Syanyan-wrsCFG_BOOT_SECONDARY_REQUEST ?= n
3586d96f208Syanyan-wrs
359f5f914aaSJens Wiklander# Default heap size for Core, 64 kB
360f5f914aaSJens WiklanderCFG_CORE_HEAP_SIZE ?= 65536
361f3bb2312SJerome Forissier
362386fc264SVolodymyr Babchuk# Default size of nexus heap. 16 kB. Used only if CFG_VIRTUALIZATION
363386fc264SVolodymyr Babchuk# is enabled
364386fc264SVolodymyr BabchukCFG_CORE_NEX_HEAP_SIZE ?= 16384
365386fc264SVolodymyr Babchuk
366883c4be3SJerome Forissier# TA profiling.
367883c4be3SJerome Forissier# When this option is enabled, OP-TEE can execute Trusted Applications
368883c4be3SJerome Forissier# instrumented with GCC's -pg flag and will output profiling information
369883c4be3SJerome Forissier# in gmon.out format to /tmp/gmon-<ta_uuid>.out (path is defined in
370883c4be3SJerome Forissier# tee-supplicant)
3718800b01dSJerome Forissier# Note: this does not work well with shared libraries at the moment for a
3728800b01dSJerome Forissier# couple of reasons:
3738800b01dSJerome Forissier# 1. The profiling code assumes a unique executable section in the TA VA space.
3748800b01dSJerome Forissier# 2. The code used to detect at run time if the TA is intrumented assumes that
3758800b01dSJerome Forissier# the TA is linked statically.
376883c4be3SJerome ForissierCFG_TA_GPROF_SUPPORT ?= n
377f3bb2312SJerome Forissier
378b02ae382SSumit Garg# TA function tracing.
379b02ae382SSumit Garg# When this option is enabled, OP-TEE can execute Trusted Applications
380b02ae382SSumit Garg# instrumented with GCC's -pg flag and will output function tracing
381b02ae382SSumit Garg# information in ftrace.out format to /tmp/ftrace-<ta_uuid>.out (path is
382b02ae382SSumit Garg# defined in tee-supplicant)
383099918f6SSumit GargCFG_FTRACE_SUPPORT ?= n
384b02ae382SSumit Garg
385d408db99SJerome Forissier# How to make room when the function tracing buffer is full?
386d408db99SJerome Forissier# 'shift': shift the previously stored data by the amount needed in order
387d408db99SJerome Forissier#    to always keep the latest logs (slower, especially with big buffer sizes)
388d408db99SJerome Forissier# 'wrap': discard the previous data and start at the beginning of the buffer
389d408db99SJerome Forissier#    again (fast, but can result in a mostly empty buffer)
390d408db99SJerome Forissier# 'stop': stop logging new data
391d408db99SJerome ForissierCFG_FTRACE_BUF_WHEN_FULL ?= shift
392d408db99SJerome Forissier$(call cfg-check-value,FTRACE_BUF_WHEN_FULL,shift stop wrap)
393d408db99SJerome Forissier$(call force,_CFG_FTRACE_BUF_WHEN_FULL_$(CFG_FTRACE_BUF_WHEN_FULL),y)
394d408db99SJerome Forissier
395d1492098SJerome Forissier# Function tracing: unit to be used when displaying durations
396d1492098SJerome Forissier#  0: always display durations in microseconds
397d1492098SJerome Forissier# >0: if duration is greater or equal to the specified value (in microseconds),
398d1492098SJerome Forissier#     display it in milliseconds
399d1492098SJerome ForissierCFG_FTRACE_US_MS ?= 10000
400d1492098SJerome Forissier
401099918f6SSumit Garg# Core syscall function tracing.
402099918f6SSumit Garg# When this option is enabled, OP-TEE core is instrumented with GCC's
403099918f6SSumit Garg# -pg flag and will output syscall function graph in user TA ftrace
404099918f6SSumit Garg# buffer
405099918f6SSumit GargCFG_SYSCALL_FTRACE ?= n
406099918f6SSumit Garg$(call cfg-depends-all,CFG_SYSCALL_FTRACE,CFG_FTRACE_SUPPORT)
407099918f6SSumit Garg
408883c4be3SJerome Forissier# Enable to compile user TA libraries with profiling (-pg).
409099918f6SSumit Garg# Depends on CFG_TA_GPROF_SUPPORT or CFG_FTRACE_SUPPORT.
410735565dbSSumit GargCFG_ULIBS_MCOUNT ?= n
4110f8adafeSJerome Forissier# Profiling/tracing of syscall wrapper (utee_*)
4120f8adafeSJerome ForissierCFG_SYSCALL_WRAPPERS_MCOUNT ?= $(CFG_ULIBS_MCOUNT)
413883c4be3SJerome Forissier
4140f8adafeSJerome Forissierifeq (y,$(filter y,$(CFG_ULIBS_MCOUNT) $(CFG_SYSCALL_WRAPPERS_MCOUNT)))
415099918f6SSumit Gargifeq (,$(filter y,$(CFG_TA_GPROF_SUPPORT) $(CFG_FTRACE_SUPPORT)))
416883c4be3SJerome Forissier$(error Cannot instrument user libraries if user mode profiling is disabled)
417f3bb2312SJerome Forissierendif
418f3bb2312SJerome Forissierendif
419cb0b5954SJens Wiklander
4207fb525f1SJerome Forissier# Build libutee, libutils, libmbedtls as shared libraries.
42164718c93SJerome Forissier# - Static libraries are still generated when this is enabled, but TAs will use
42264718c93SJerome Forissier# the shared libraries unless explicitly linked with the -static flag.
42364718c93SJerome Forissier# - Shared libraries are made of two files: for example, libutee is
42464718c93SJerome Forissier#   libutee.so and 527f1a47-b92c-4a74-95bd-72f19f4a6f74.ta. The '.so' file
42564718c93SJerome Forissier#   is a totally standard shared object, and should be used to link against.
42664718c93SJerome Forissier#   The '.ta' file is a signed version of the '.so' and should be installed
42764718c93SJerome Forissier#   in the same way as TAs so that they can be found at runtime.
42864718c93SJerome ForissierCFG_ULIBS_SHARED ?= n
42964718c93SJerome Forissier
43070aa7511SJerome Forissierifeq (yy,$(CFG_TA_GPROF_SUPPORT)$(CFG_ULIBS_SHARED))
43170aa7511SJerome Forissier$(error CFG_TA_GPROF_SUPPORT and CFG_ULIBS_SHARED are currently incompatible)
43270aa7511SJerome Forissierendif
43370aa7511SJerome Forissier
434cb0b5954SJens Wiklander# CFG_GP_SOCKETS
435cb0b5954SJens Wiklander# Enable Global Platform Sockets support
436cb0b5954SJens WiklanderCFG_GP_SOCKETS ?= y
43780a4e51dSEtienne Carriere
43880a4e51dSEtienne Carriere# Enable Secure Data Path support in OP-TEE core (TA may be invoked with
43980a4e51dSEtienne Carriere# invocation parameters referring to specific secure memories).
44080a4e51dSEtienne CarriereCFG_SECURE_DATA_PATH ?= n
44100da26ecSAndrew F. Davis
442c9720143SJens Wiklander# Enable storage for TAs in secure storage, depends on CFG_REE_FS=y
443c9720143SJens Wiklander# TA binaries are stored encrypted in the REE FS and are protected by
444c9720143SJens Wiklander# metadata in secure storage.
445c9720143SJens WiklanderCFG_SECSTOR_TA ?= $(call cfg-all-enabled,CFG_REE_FS CFG_WITH_USER_TA)
446c9720143SJens Wiklander$(eval $(call cfg-depends-all,CFG_SECSTOR_TA,CFG_REE_FS CFG_WITH_USER_TA))
447c9720143SJens Wiklander
44830668b28SJens Wiklander# Enable the pseudo TA that managages TA storage in secure storage
44930668b28SJens WiklanderCFG_SECSTOR_TA_MGMT_PTA ?= $(call cfg-all-enabled,CFG_SECSTOR_TA)
45030668b28SJens Wiklander$(eval $(call cfg-depends-all,CFG_SECSTOR_TA_MGMT_PTA,CFG_SECSTOR_TA))
451c9720143SJens Wiklander
4524bca302aSIgor Opaniuk# Enable the pseudo TA for misc. auxilary services, extending existing
4534bca302aSIgor Opaniuk# GlobalPlatform Core API (for example, re-seeding RNG entropy pool etc.)
4544bca302aSIgor OpaniukCFG_SYSTEM_PTA ?= y
4554bca302aSIgor Opaniuk
4560b611081SSumit Garg# Enable the pseudo TA for enumeration of TEE based devices for the normal
4570b611081SSumit Garg# world OS.
4580b611081SSumit GargCFG_DEVICE_ENUM_PTA ?= y
4590b611081SSumit Garg
46000da26ecSAndrew F. Davis# Define the number of cores per cluster used in calculating core position.
46100da26ecSAndrew F. Davis# The cluster number is shifted by this value and added to the core ID,
46200da26ecSAndrew F. Davis# so its value represents log2(cores/cluster).
46300da26ecSAndrew F. Davis# Default is 2**(2) = 4 cores per cluster.
46400da26ecSAndrew F. DavisCFG_CORE_CLUSTER_SHIFT ?= 2
465d81f93a7SVolodymyr Babchuk
4668be2de1aSImre Kis# Define the number of threads per core used in calculating processing
4678be2de1aSImre Kis# element's position. The core number is shifted by this value and added to
4688be2de1aSImre Kis# the thread ID, so its value represents log2(threads/core).
4698be2de1aSImre Kis# Default is 2**(0) = 1 threads per core.
4708be2de1aSImre KisCFG_CORE_THREAD_SHIFT ?= 0
4718be2de1aSImre Kis
47237a6b717SJens Wiklander# Enable support for dynamic shared memory (shared memory anywhere in
47337a6b717SJens Wiklander# non-secure memory).
47437a6b717SJens WiklanderCFG_CORE_DYN_SHM ?= y
47537a6b717SJens Wiklander
4768aeb6c94SJens Wiklander# Enable support for reserved shared memory (shared memory in a carved out
4778aeb6c94SJens Wiklander# memory area).
4788aeb6c94SJens WiklanderCFG_CORE_RESERVED_SHM ?= y
4798aeb6c94SJens Wiklander
480dd3afbacSJens Wiklander# Enables support for larger physical addresses, that is, it will define
481dd3afbacSJens Wiklander# paddr_t as a 64-bit type.
482dd3afbacSJens WiklanderCFG_CORE_LARGE_PHYS_ADDR ?= n
483e3458e03SJerome Forissier
484e3458e03SJerome Forissier# Define the maximum size, in bits, for big numbers in the Internal Core API
485e3458e03SJerome Forissier# Arithmetical functions. This does *not* influence the key size that may be
486e3458e03SJerome Forissier# manipulated through the Cryptographic API.
487e3458e03SJerome Forissier# Set this to a lower value to reduce the TA memory footprint.
488e3458e03SJerome ForissierCFG_TA_BIGNUM_MAX_BITS ?= 2048
489409d2ff0SJerome Forissier
490409d2ff0SJerome Forissier# Define the maximum size, in bits, for big numbers in the TEE core (privileged
491409d2ff0SJerome Forissier# layer).
492409d2ff0SJerome Forissier# This value is an upper limit for the key size in any cryptographic algorithm
493409d2ff0SJerome Forissier# implemented by the TEE core.
494409d2ff0SJerome Forissier# Set this to a lower value to reduce the memory footprint.
495409d2ff0SJerome ForissierCFG_CORE_BIGNUM_MAX_BITS ?= 4096
496a97bc4a0SJens Wiklander
4977fb525f1SJerome Forissier# Not used since libmpa was removed. Force the values to catch build scripts
4987fb525f1SJerome Forissier# that would set = n.
4997fb525f1SJerome Forissier$(call force,CFG_TA_MBEDTLS_MPI,y)
5007fb525f1SJerome Forissier$(call force,CFG_TA_MBEDTLS,y)
501a97bc4a0SJens Wiklander
502a97bc4a0SJens Wiklander# Compile the TA library mbedTLS with self test functions, the functions
503a97bc4a0SJens Wiklander# need to be called to test anything
504a97bc4a0SJens WiklanderCFG_TA_MBEDTLS_SELF_TEST ?= y
505017dfaf8SGabor Szekely
50668689d86SJens Wiklander# By default use tomcrypt as the main crypto lib providing an implementation
50768689d86SJens Wiklander# for the API in <crypto/crypto.h>
50868689d86SJens Wiklander# CFG_CRYPTOLIB_NAME is used as libname and
50968689d86SJens Wiklander# CFG_CRYPTOLIB_DIR is used as libdir when compiling the library
51077327d7aSEdison Ai#
51177327d7aSEdison Ai# It's also possible to configure to use mbedtls instead of tomcrypt.
51277327d7aSEdison Ai# Then the variables should be assigned as "CFG_CRYPTOLIB_NAME=mbedtls" and
51377327d7aSEdison Ai# "CFG_CRYPTOLIB_DIR=lib/libmbedtls" respectively.
51468689d86SJens WiklanderCFG_CRYPTOLIB_NAME ?= tomcrypt
51568689d86SJens WiklanderCFG_CRYPTOLIB_DIR ?= core/lib/libtomcrypt
51668689d86SJens Wiklander
517017dfaf8SGabor Szekely# Enable TEE_ALG_RSASSA_PKCS1_V1_5 algorithm for signing with PKCS#1 v1.5 EMSA
51868689d86SJens Wiklander# without ASN.1 around the hash.
51968689d86SJens Wiklanderifeq ($(CFG_CRYPTOLIB_NAME),tomcrypt)
520017dfaf8SGabor SzekelyCFG_CRYPTO_RSASSA_NA1 ?= y
52168689d86SJens Wiklanderendif
52215216d4dSVolodymyr Babchuk
5237fb525f1SJerome Forissier# Not used since libmpa was removed. Force the value to catch build scripts
5247fb525f1SJerome Forissier# that would set = n.
5257fb525f1SJerome Forissier$(call force,CFG_CORE_MBEDTLS_MPI,y)
5267fb525f1SJerome Forissier
52715216d4dSVolodymyr Babchuk# Enable virtualization support. OP-TEE will not work without compatible
52815216d4dSVolodymyr Babchuk# hypervisor if this option is enabled.
52915216d4dSVolodymyr BabchukCFG_VIRTUALIZATION ?= n
53015216d4dSVolodymyr Babchuk
53115216d4dSVolodymyr Babchukifeq ($(CFG_VIRTUALIZATION),y)
53215216d4dSVolodymyr Babchuk$(call force,CFG_CORE_RODATA_NOEXEC,y)
53315216d4dSVolodymyr Babchuk$(call force,CFG_CORE_RWDATA_NOEXEC,y)
534c4e8be26SVolodymyr Babchuk
535c4e8be26SVolodymyr Babchuk# Default number of virtual guests
536c4e8be26SVolodymyr BabchukCFG_VIRT_GUEST_COUNT ?= 2
53715216d4dSVolodymyr Babchukendif
53815216d4dSVolodymyr Babchuk
53917888736SJens Wiklander# Enables backwards compatible derivation of RPMB and SSK keys
54017888736SJens WiklanderCFG_CORE_HUK_SUBKEY_COMPAT ?= y
541a2087649SJerome Forissier
542a2087649SJerome Forissier# Compress and encode conf.mk into the TEE core, and show the encoded string on
543a2087649SJerome Forissier# boot (with severity TRACE_INFO).
544a2087649SJerome ForissierCFG_SHOW_CONF_ON_BOOT ?= n
545dd333f03SJavier Almansa Sobrino
546dd333f03SJavier Almansa Sobrino# Enables support for passing a TPM Event Log stored in secure memory
547dd333f03SJavier Almansa Sobrino# to a TA, so a TPM Service could use it to extend any measurement
548dd333f03SJavier Almansa Sobrino# taken before the service was up and running.
549dd333f03SJavier Almansa SobrinoCFG_CORE_TPM_EVENT_LOG ?= n
550ae8c8068SEtienne Carriere
551ae8c8068SEtienne Carriere# When enabled, CFG_SCMI_MSG_DRIVERS embeds SCMI message drivers in the core.
552ae8c8068SEtienne Carriere# Refer to the supported SCMI features embedded upon CFG_SCMI_MSG_*
553a7a9e3baSEtienne Carriere# CFG_SCMI_MSG_CLOCK embeds SCMI clock protocol support.
55456a1f10eSEtienne Carriere# CFG_SCMI_MSG_RESET_DOMAIN embeds SCMI reset domain protocol support.
555*a58c4d70SEtienne Carriere# CFG_SCMI_MSG_SMT embeds SMT based message buffer of communication channel
556ae8c8068SEtienne CarriereCFG_SCMI_MSG_DRIVERS ?= n
557a7a9e3baSEtienne CarriereCFG_SCMI_MSG_CLOCK ?= n
55856a1f10eSEtienne CarriereCFG_SCMI_MSG_RESET_DOMAIN ?= n
559*a58c4d70SEtienne CarriereCFG_SCMI_MSG_SMT ?= n
560