blob: 7df6b0d88821f2f0f38863b885e63aea63554cc3 [file] [log] [blame]
Dan Handley9df48042015-03-19 18:58:55 +00001/*
Madhukar Pappireddyd7419442020-01-27 15:38:26 -06002 * Copyright (c) 2015-2020, ARM Limited and Contributors. All rights reserved.
Dan Handley9df48042015-03-19 18:58:55 +00003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Dan Handley9df48042015-03-19 18:58:55 +00005 */
Antonio Nino Diaz6f3ccc52018-07-20 09:17:26 +01006#ifndef ARM_DEF_H
7#define ARM_DEF_H
Dan Handley9df48042015-03-19 18:58:55 +00008
Antonio Nino Diaze0f90632018-12-14 00:18:21 +00009#include <arch.h>
10#include <common/interrupt_props.h>
11#include <common/tbbr/tbbr_img_def.h>
12#include <drivers/arm/gic_common.h>
13#include <lib/utils_def.h>
14#include <lib/xlat_tables/xlat_tables_defs.h>
15#include <plat/common/common_def.h>
Dan Handley9df48042015-03-19 18:58:55 +000016
17/******************************************************************************
18 * Definitions common to all ARM standard platforms
19 *****************************************************************************/
20
Max Shvetsov06dba292019-12-06 11:50:12 +000021/*
22 * Root of trust key hash lengths
23 */
24#define ARM_ROTPK_HEADER_LEN 19
25#define ARM_ROTPK_HASH_LEN 32
26
Juan Castillo7d199412015-12-14 09:35:25 +000027/* Special value used to verify platform parameters from BL2 to BL31 */
Antonio Nino Diazab5d2b12018-10-30 16:12:32 +000028#define ARM_BL31_PLAT_PARAM_VAL ULL(0x0f1e2d3c4b5a6978)
Dan Handley9df48042015-03-19 18:58:55 +000029
Deepika Bhavnani4287c0c2019-12-13 10:23:18 -060030#define ARM_SYSTEM_COUNT U(1)
Dan Handley9df48042015-03-19 18:58:55 +000031
32#define ARM_CACHE_WRITEBACK_SHIFT 6
33
Soby Mathewfec4eb72015-07-01 16:16:20 +010034/*
35 * Macros mapping the MPIDR Affinity levels to ARM Platform Power levels. The
36 * power levels have a 1:1 mapping with the MPIDR affinity levels.
37 */
38#define ARM_PWR_LVL0 MPIDR_AFFLVL0
39#define ARM_PWR_LVL1 MPIDR_AFFLVL1
Soby Mathewa869de12015-05-08 10:18:59 +010040#define ARM_PWR_LVL2 MPIDR_AFFLVL2
Chandni Cherukuri9ec4a112018-10-16 14:42:19 +053041#define ARM_PWR_LVL3 MPIDR_AFFLVL3
Soby Mathewfec4eb72015-07-01 16:16:20 +010042
43/*
44 * Macros for local power states in ARM platforms encoded by State-ID field
45 * within the power-state parameter.
46 */
47/* Local power state for power domains in Run state. */
Antonio Nino Diaz6f3ccc52018-07-20 09:17:26 +010048#define ARM_LOCAL_STATE_RUN U(0)
Soby Mathewfec4eb72015-07-01 16:16:20 +010049/* Local power state for retention. Valid only for CPU power domains */
Antonio Nino Diaz6f3ccc52018-07-20 09:17:26 +010050#define ARM_LOCAL_STATE_RET U(1)
Soby Mathewfec4eb72015-07-01 16:16:20 +010051/* Local power state for OFF/power-down. Valid for CPU and cluster power
52 domains */
Antonio Nino Diaz6f3ccc52018-07-20 09:17:26 +010053#define ARM_LOCAL_STATE_OFF U(2)
Soby Mathewfec4eb72015-07-01 16:16:20 +010054
Dan Handley9df48042015-03-19 18:58:55 +000055/* Memory location options for TSP */
56#define ARM_TRUSTED_SRAM_ID 0
57#define ARM_TRUSTED_DRAM_ID 1
58#define ARM_DRAM_ID 2
59
60/* The first 4KB of Trusted SRAM are used as shared memory */
Antonio Nino Diaz5f475792018-10-15 14:58:11 +010061#define ARM_TRUSTED_SRAM_BASE UL(0x04000000)
Dan Handley9df48042015-03-19 18:58:55 +000062#define ARM_SHARED_RAM_BASE ARM_TRUSTED_SRAM_BASE
Antonio Nino Diaz5f475792018-10-15 14:58:11 +010063#define ARM_SHARED_RAM_SIZE UL(0x00001000) /* 4 KB */
Dan Handley9df48042015-03-19 18:58:55 +000064
65/* The remaining Trusted SRAM is used to load the BL images */
66#define ARM_BL_RAM_BASE (ARM_SHARED_RAM_BASE + \
67 ARM_SHARED_RAM_SIZE)
68#define ARM_BL_RAM_SIZE (PLAT_ARM_TRUSTED_SRAM_SIZE - \
69 ARM_SHARED_RAM_SIZE)
70
71/*
72 * The top 16MB of DRAM1 is configured as secure access only using the TZC
73 * - SCP TZC DRAM: If present, DRAM reserved for SCP use
74 * - AP TZC DRAM: The remaining TZC secured DRAM reserved for AP use
75 */
Antonio Nino Diaz5f475792018-10-15 14:58:11 +010076#define ARM_TZC_DRAM1_SIZE UL(0x01000000)
Dan Handley9df48042015-03-19 18:58:55 +000077
78#define ARM_SCP_TZC_DRAM1_BASE (ARM_DRAM1_BASE + \
79 ARM_DRAM1_SIZE - \
80 ARM_SCP_TZC_DRAM1_SIZE)
81#define ARM_SCP_TZC_DRAM1_SIZE PLAT_ARM_SCP_TZC_DRAM1_SIZE
82#define ARM_SCP_TZC_DRAM1_END (ARM_SCP_TZC_DRAM1_BASE + \
83 ARM_SCP_TZC_DRAM1_SIZE - 1)
84
Soby Mathew3b5156e2017-10-05 12:27:33 +010085/*
86 * Define a 2MB region within the TZC secured DRAM for use by EL3 runtime
87 * firmware. This region is meant to be NOLOAD and will not be zero
88 * initialized. Data sections with the attribute `arm_el3_tzc_dram` will be
89 * placed here.
90 */
91#define ARM_EL3_TZC_DRAM1_BASE (ARM_SCP_TZC_DRAM1_BASE - ARM_EL3_TZC_DRAM1_SIZE)
Antonio Nino Diaz5f475792018-10-15 14:58:11 +010092#define ARM_EL3_TZC_DRAM1_SIZE UL(0x00200000) /* 2 MB */
Soby Mathew3b5156e2017-10-05 12:27:33 +010093#define ARM_EL3_TZC_DRAM1_END (ARM_EL3_TZC_DRAM1_BASE + \
94 ARM_EL3_TZC_DRAM1_SIZE - 1)
95
Dan Handley9df48042015-03-19 18:58:55 +000096#define ARM_AP_TZC_DRAM1_BASE (ARM_DRAM1_BASE + \
97 ARM_DRAM1_SIZE - \
98 ARM_TZC_DRAM1_SIZE)
99#define ARM_AP_TZC_DRAM1_SIZE (ARM_TZC_DRAM1_SIZE - \
Soby Mathew3b5156e2017-10-05 12:27:33 +0100100 (ARM_SCP_TZC_DRAM1_SIZE + \
101 ARM_EL3_TZC_DRAM1_SIZE))
Dan Handley9df48042015-03-19 18:58:55 +0000102#define ARM_AP_TZC_DRAM1_END (ARM_AP_TZC_DRAM1_BASE + \
103 ARM_AP_TZC_DRAM1_SIZE - 1)
104
Soby Mathew7e4d6652017-05-10 11:50:30 +0100105/* Define the Access permissions for Secure peripherals to NS_DRAM */
106#if ARM_CRYPTOCELL_INTEG
107/*
108 * Allow Secure peripheral to read NS DRAM when integrated with CryptoCell.
109 * This is required by CryptoCell to authenticate BL33 which is loaded
110 * into the Non Secure DDR.
111 */
112#define ARM_TZC_NS_DRAM_S_ACCESS TZC_REGION_S_RD
113#else
114#define ARM_TZC_NS_DRAM_S_ACCESS TZC_REGION_S_NONE
115#endif
116
Summer Qin9db8f2e2017-04-24 16:49:28 +0100117#ifdef SPD_opteed
118/*
Jens Wiklanderae73b162017-08-24 15:39:09 +0200119 * BL2 needs to map 4MB at the end of TZC_DRAM1 in order to
120 * load/authenticate the trusted os extra image. The first 512KB of
121 * TZC_DRAM1 are reserved for trusted os (OPTEE). The extra image loading
122 * for OPTEE is paged image which only include the paging part using
123 * virtual memory but without "init" data. OPTEE will copy the "init" data
124 * (from pager image) to the first 512KB of TZC_DRAM, and then copy the
125 * extra image behind the "init" data.
Summer Qin9db8f2e2017-04-24 16:49:28 +0100126 */
Jens Wiklanderae73b162017-08-24 15:39:09 +0200127#define ARM_OPTEE_PAGEABLE_LOAD_BASE (ARM_AP_TZC_DRAM1_BASE + \
128 ARM_AP_TZC_DRAM1_SIZE - \
129 ARM_OPTEE_PAGEABLE_LOAD_SIZE)
Antonio Nino Diaz5f475792018-10-15 14:58:11 +0100130#define ARM_OPTEE_PAGEABLE_LOAD_SIZE UL(0x400000)
Summer Qin9db8f2e2017-04-24 16:49:28 +0100131#define ARM_OPTEE_PAGEABLE_LOAD_MEM MAP_REGION_FLAT( \
132 ARM_OPTEE_PAGEABLE_LOAD_BASE, \
133 ARM_OPTEE_PAGEABLE_LOAD_SIZE, \
134 MT_MEMORY | MT_RW | MT_SECURE)
Soby Mathew874fc9e2017-09-01 13:43:50 +0100135
136/*
137 * Map the memory for the OP-TEE core (also known as OP-TEE pager when paging
138 * support is enabled).
139 */
140#define ARM_MAP_OPTEE_CORE_MEM MAP_REGION_FLAT( \
141 BL32_BASE, \
142 BL32_LIMIT - BL32_BASE, \
143 MT_MEMORY | MT_RW | MT_SECURE)
Summer Qin9db8f2e2017-04-24 16:49:28 +0100144#endif /* SPD_opteed */
Dan Handley9df48042015-03-19 18:58:55 +0000145
146#define ARM_NS_DRAM1_BASE ARM_DRAM1_BASE
147#define ARM_NS_DRAM1_SIZE (ARM_DRAM1_SIZE - \
148 ARM_TZC_DRAM1_SIZE)
149#define ARM_NS_DRAM1_END (ARM_NS_DRAM1_BASE + \
150 ARM_NS_DRAM1_SIZE - 1)
151
Sandrine Bailleux6c32fc72018-10-31 14:28:17 +0100152#define ARM_DRAM1_BASE ULL(0x80000000)
153#define ARM_DRAM1_SIZE ULL(0x80000000)
Dan Handley9df48042015-03-19 18:58:55 +0000154#define ARM_DRAM1_END (ARM_DRAM1_BASE + \
155 ARM_DRAM1_SIZE - 1)
156
Sami Mujawara43ae7c2019-05-09 13:35:02 +0100157#define ARM_DRAM2_BASE PLAT_ARM_DRAM2_BASE
Dan Handley9df48042015-03-19 18:58:55 +0000158#define ARM_DRAM2_SIZE PLAT_ARM_DRAM2_SIZE
159#define ARM_DRAM2_END (ARM_DRAM2_BASE + \
160 ARM_DRAM2_SIZE - 1)
161
162#define ARM_IRQ_SEC_PHY_TIMER 29
163
164#define ARM_IRQ_SEC_SGI_0 8
165#define ARM_IRQ_SEC_SGI_1 9
166#define ARM_IRQ_SEC_SGI_2 10
167#define ARM_IRQ_SEC_SGI_3 11
168#define ARM_IRQ_SEC_SGI_4 12
169#define ARM_IRQ_SEC_SGI_5 13
170#define ARM_IRQ_SEC_SGI_6 14
171#define ARM_IRQ_SEC_SGI_7 15
172
Achin Gupta1fa7eb62015-11-03 14:18:34 +0000173/*
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100174 * Define a list of Group 1 Secure and Group 0 interrupt properties as per GICv3
175 * terminology. On a GICv2 system or mode, the lists will be merged and treated
176 * as Group 0 interrupts.
177 */
178#define ARM_G1S_IRQ_PROPS(grp) \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100179 INTR_PROP_DESC(ARM_IRQ_SEC_PHY_TIMER, GIC_HIGHEST_SEC_PRIORITY, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100180 GIC_INTR_CFG_LEVEL), \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100181 INTR_PROP_DESC(ARM_IRQ_SEC_SGI_1, GIC_HIGHEST_SEC_PRIORITY, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100182 GIC_INTR_CFG_EDGE), \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100183 INTR_PROP_DESC(ARM_IRQ_SEC_SGI_2, GIC_HIGHEST_SEC_PRIORITY, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100184 GIC_INTR_CFG_EDGE), \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100185 INTR_PROP_DESC(ARM_IRQ_SEC_SGI_3, GIC_HIGHEST_SEC_PRIORITY, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100186 GIC_INTR_CFG_EDGE), \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100187 INTR_PROP_DESC(ARM_IRQ_SEC_SGI_4, GIC_HIGHEST_SEC_PRIORITY, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100188 GIC_INTR_CFG_EDGE), \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100189 INTR_PROP_DESC(ARM_IRQ_SEC_SGI_5, GIC_HIGHEST_SEC_PRIORITY, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100190 GIC_INTR_CFG_EDGE), \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100191 INTR_PROP_DESC(ARM_IRQ_SEC_SGI_7, GIC_HIGHEST_SEC_PRIORITY, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100192 GIC_INTR_CFG_EDGE)
193
194#define ARM_G0_IRQ_PROPS(grp) \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100195 INTR_PROP_DESC(ARM_IRQ_SEC_SGI_0, PLAT_SDEI_NORMAL_PRI, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100196 GIC_INTR_CFG_EDGE), \
Antonio Nino Diaze590fd52018-08-21 09:42:26 +0100197 INTR_PROP_DESC(ARM_IRQ_SEC_SGI_6, GIC_HIGHEST_SEC_PRIORITY, (grp), \
Jeenu Viswambharan723dce02017-09-22 08:59:59 +0100198 GIC_INTR_CFG_EDGE)
199
Dan Handley9df48042015-03-19 18:58:55 +0000200#define ARM_MAP_SHARED_RAM MAP_REGION_FLAT( \
201 ARM_SHARED_RAM_BASE, \
202 ARM_SHARED_RAM_SIZE, \
Juan Castillo2e86cb12016-01-13 15:01:09 +0000203 MT_DEVICE | MT_RW | MT_SECURE)
Dan Handley9df48042015-03-19 18:58:55 +0000204
205#define ARM_MAP_NS_DRAM1 MAP_REGION_FLAT( \
206 ARM_NS_DRAM1_BASE, \
207 ARM_NS_DRAM1_SIZE, \
208 MT_MEMORY | MT_RW | MT_NS)
209
Roberto Vargasf8fda102017-08-08 11:27:20 +0100210#define ARM_MAP_DRAM2 MAP_REGION_FLAT( \
211 ARM_DRAM2_BASE, \
212 ARM_DRAM2_SIZE, \
213 MT_MEMORY | MT_RW | MT_NS)
Roberto Vargasf8fda102017-08-08 11:27:20 +0100214
Dan Handley9df48042015-03-19 18:58:55 +0000215#define ARM_MAP_TSP_SEC_MEM MAP_REGION_FLAT( \
216 TSP_SEC_MEM_BASE, \
217 TSP_SEC_MEM_SIZE, \
218 MT_MEMORY | MT_RW | MT_SECURE)
219
David Wang0ba499f2016-03-07 11:02:57 +0800220#if ARM_BL31_IN_DRAM
221#define ARM_MAP_BL31_SEC_DRAM MAP_REGION_FLAT( \
222 BL31_BASE, \
223 PLAT_ARM_MAX_BL31_SIZE, \
224 MT_MEMORY | MT_RW | MT_SECURE)
225#endif
Dan Handley9df48042015-03-19 18:58:55 +0000226
Soby Mathew3b5156e2017-10-05 12:27:33 +0100227#define ARM_MAP_EL3_TZC_DRAM MAP_REGION_FLAT( \
228 ARM_EL3_TZC_DRAM1_BASE, \
229 ARM_EL3_TZC_DRAM1_SIZE, \
230 MT_MEMORY | MT_RW | MT_SECURE)
231
Achin Guptae97351d2019-10-11 15:15:19 +0100232#if defined(SPD_spmd)
233#define ARM_MAP_TRUSTED_DRAM MAP_REGION_FLAT( \
234 PLAT_ARM_TRUSTED_DRAM_BASE, \
235 PLAT_ARM_TRUSTED_DRAM_SIZE, \
236 MT_MEMORY | MT_RW | MT_SECURE)
237#endif
238
239
Daniel Boulby4e97abd2018-07-16 14:09:15 +0100240/*
John Tsichritzisc34341a2018-07-30 13:41:52 +0100241 * Mapping for the BL1 RW region. This mapping is needed by BL2 in order to
242 * share the Mbed TLS heap. Since the heap is allocated inside BL1, it resides
243 * in the BL1 RW region. Hence, BL2 needs access to the BL1 RW region in order
244 * to be able to access the heap.
245 */
246#define ARM_MAP_BL1_RW MAP_REGION_FLAT( \
247 BL1_RW_BASE, \
248 BL1_RW_LIMIT - BL1_RW_BASE, \
249 MT_MEMORY | MT_RW | MT_SECURE)
250
251/*
Daniel Boulby4e97abd2018-07-16 14:09:15 +0100252 * If SEPARATE_CODE_AND_RODATA=1 we define a region for each section
253 * otherwise one region is defined containing both.
254 */
Daniel Boulby45a2c9e2018-07-06 16:54:44 +0100255#if SEPARATE_CODE_AND_RODATA
Daniel Boulby4e97abd2018-07-16 14:09:15 +0100256#define ARM_MAP_BL_RO MAP_REGION_FLAT( \
Daniel Boulby45a2c9e2018-07-06 16:54:44 +0100257 BL_CODE_BASE, \
258 BL_CODE_END - BL_CODE_BASE, \
Daniel Boulby4e97abd2018-07-16 14:09:15 +0100259 MT_CODE | MT_SECURE), \
260 MAP_REGION_FLAT( \
Daniel Boulby45a2c9e2018-07-06 16:54:44 +0100261 BL_RO_DATA_BASE, \
262 BL_RO_DATA_END \
263 - BL_RO_DATA_BASE, \
264 MT_RO_DATA | MT_SECURE)
Daniel Boulby4e97abd2018-07-16 14:09:15 +0100265#else
266#define ARM_MAP_BL_RO MAP_REGION_FLAT( \
267 BL_CODE_BASE, \
268 BL_CODE_END - BL_CODE_BASE, \
269 MT_CODE | MT_SECURE)
Daniel Boulby45a2c9e2018-07-06 16:54:44 +0100270#endif
271#if USE_COHERENT_MEM
272#define ARM_MAP_BL_COHERENT_RAM MAP_REGION_FLAT( \
273 BL_COHERENT_RAM_BASE, \
274 BL_COHERENT_RAM_END \
275 - BL_COHERENT_RAM_BASE, \
276 MT_DEVICE | MT_RW | MT_SECURE)
277#endif
Roberto Vargase3adc372018-05-23 09:27:06 +0100278#if USE_ROMLIB
279#define ARM_MAP_ROMLIB_CODE MAP_REGION_FLAT( \
280 ROMLIB_RO_BASE, \
281 ROMLIB_RO_LIMIT - ROMLIB_RO_BASE,\
282 MT_CODE | MT_SECURE)
283
284#define ARM_MAP_ROMLIB_DATA MAP_REGION_FLAT( \
285 ROMLIB_RW_BASE, \
286 ROMLIB_RW_END - ROMLIB_RW_BASE,\
287 MT_MEMORY | MT_RW | MT_SECURE)
288#endif
Daniel Boulby45a2c9e2018-07-06 16:54:44 +0100289
Dan Handley9df48042015-03-19 18:58:55 +0000290/*
Antonio Nino Diaz48bfb542018-10-11 13:02:34 +0100291 * Map mem_protect flash region with read and write permissions
292 */
293#define ARM_V2M_MAP_MEM_PROTECT MAP_REGION_FLAT(PLAT_ARM_MEM_PROT_ADDR, \
294 V2M_FLASH_BLOCK_SIZE, \
295 MT_DEVICE | MT_RW | MT_SECURE)
296
297/*
Daniel Boulby4e97abd2018-07-16 14:09:15 +0100298 * The max number of regions like RO(code), coherent and data required by
Dan Handley9df48042015-03-19 18:58:55 +0000299 * different BL stages which need to be mapped in the MMU.
300 */
Daniel Boulbyb1b058d2018-09-18 11:52:49 +0100301#define ARM_BL_REGIONS 5
Dan Handley9df48042015-03-19 18:58:55 +0000302
303#define MAX_MMAP_REGIONS (PLAT_ARM_MMAP_ENTRIES + \
304 ARM_BL_REGIONS)
305
306/* Memory mapped Generic timer interfaces */
Antonio Nino Diaz5f475792018-10-15 14:58:11 +0100307#define ARM_SYS_CNTCTL_BASE UL(0x2a430000)
308#define ARM_SYS_CNTREAD_BASE UL(0x2a800000)
309#define ARM_SYS_TIMCTL_BASE UL(0x2a810000)
310#define ARM_SYS_CNT_BASE_S UL(0x2a820000)
311#define ARM_SYS_CNT_BASE_NS UL(0x2a830000)
Dan Handley9df48042015-03-19 18:58:55 +0000312
313#define ARM_CONSOLE_BAUDRATE 115200
314
Juan Castillob6132f12015-10-06 14:01:35 +0100315/* Trusted Watchdog constants */
Antonio Nino Diaz5f475792018-10-15 14:58:11 +0100316#define ARM_SP805_TWDG_BASE UL(0x2a490000)
Juan Castillob6132f12015-10-06 14:01:35 +0100317#define ARM_SP805_TWDG_CLK_HZ 32768
318/* The TBBR document specifies a watchdog timeout of 256 seconds. SP805
319 * asserts reset after two consecutive countdowns (2 x 128 = 256 sec) */
320#define ARM_TWDG_TIMEOUT_SEC 128
321#define ARM_TWDG_LOAD_VAL (ARM_SP805_TWDG_CLK_HZ * \
322 ARM_TWDG_TIMEOUT_SEC)
323
Dan Handley9df48042015-03-19 18:58:55 +0000324/******************************************************************************
325 * Required platform porting definitions common to all ARM standard platforms
326 *****************************************************************************/
327
Roberto Vargasf8fda102017-08-08 11:27:20 +0100328/*
Soby Mathewfec4eb72015-07-01 16:16:20 +0100329 * This macro defines the deepest retention state possible. A higher state
330 * id will represent an invalid or a power down state.
331 */
332#define PLAT_MAX_RET_STATE ARM_LOCAL_STATE_RET
333
334/*
335 * This macro defines the deepest power down states possible. Any state ID
336 * higher than this is invalid.
337 */
338#define PLAT_MAX_OFF_STATE ARM_LOCAL_STATE_OFF
339
Dan Handley9df48042015-03-19 18:58:55 +0000340/*
341 * Some data must be aligned on the biggest cache line size in the platform.
342 * This is known only to the platform as it might have a combination of
343 * integrated and external caches.
344 */
Antonio Nino Diaz5f475792018-10-15 14:58:11 +0100345#define CACHE_WRITEBACK_GRANULE (U(1) << ARM_CACHE_WRITEBACK_SHIFT)
Dan Handley9df48042015-03-19 18:58:55 +0000346
Soby Mathew7c6df5b2018-01-15 14:43:42 +0000347/*
348 * To enable TB_FW_CONFIG to be loaded by BL1, define the corresponding base
349 * and limit. Leave enough space of BL2 meminfo.
350 */
Antonio Nino Diazab5d2b12018-10-30 16:12:32 +0000351#define ARM_TB_FW_CONFIG_BASE (ARM_BL_RAM_BASE + sizeof(meminfo_t))
Sathees Balya90950092018-11-15 14:22:30 +0000352#define ARM_TB_FW_CONFIG_LIMIT (ARM_BL_RAM_BASE + (PAGE_SIZE / 2U))
353
354/*
355 * Boot parameters passed from BL2 to BL31/BL32 are stored here
356 */
357#define ARM_BL2_MEM_DESC_BASE ARM_TB_FW_CONFIG_LIMIT
358#define ARM_BL2_MEM_DESC_LIMIT (ARM_BL2_MEM_DESC_BASE + \
359 (PAGE_SIZE / 2U))
360
361/*
362 * Define limit of firmware configuration memory:
363 * ARM_TB_FW_CONFIG + ARM_BL2_MEM_DESC memory
364 */
365#define ARM_FW_CONFIG_LIMIT (ARM_BL_RAM_BASE + PAGE_SIZE)
Dan Handley9df48042015-03-19 18:58:55 +0000366
367/*******************************************************************************
368 * BL1 specific defines.
369 * BL1 RW data is relocated from ROM to RAM at runtime so we need 2 sets of
370 * addresses.
371 ******************************************************************************/
372#define BL1_RO_BASE PLAT_ARM_TRUSTED_ROM_BASE
373#define BL1_RO_LIMIT (PLAT_ARM_TRUSTED_ROM_BASE \
Roberto Vargase3adc372018-05-23 09:27:06 +0100374 + (PLAT_ARM_TRUSTED_ROM_SIZE - \
375 PLAT_ARM_MAX_ROMLIB_RO_SIZE))
Dan Handley9df48042015-03-19 18:58:55 +0000376/*
Vikram Kanigiri5d86f2e2016-01-21 14:08:15 +0000377 * Put BL1 RW at the top of the Trusted SRAM.
Dan Handley9df48042015-03-19 18:58:55 +0000378 */
Dan Handley9df48042015-03-19 18:58:55 +0000379#define BL1_RW_BASE (ARM_BL_RAM_BASE + \
380 ARM_BL_RAM_SIZE - \
Roberto Vargase3adc372018-05-23 09:27:06 +0100381 (PLAT_ARM_MAX_BL1_RW_SIZE +\
382 PLAT_ARM_MAX_ROMLIB_RW_SIZE))
383#define BL1_RW_LIMIT (ARM_BL_RAM_BASE + \
384 (ARM_BL_RAM_SIZE - PLAT_ARM_MAX_ROMLIB_RW_SIZE))
385
386#define ROMLIB_RO_BASE BL1_RO_LIMIT
387#define ROMLIB_RO_LIMIT (PLAT_ARM_TRUSTED_ROM_BASE + PLAT_ARM_TRUSTED_ROM_SIZE)
388
389#define ROMLIB_RW_BASE (BL1_RW_BASE + PLAT_ARM_MAX_BL1_RW_SIZE)
390#define ROMLIB_RW_END (ROMLIB_RW_BASE + PLAT_ARM_MAX_ROMLIB_RW_SIZE)
Dan Handley9df48042015-03-19 18:58:55 +0000391
392/*******************************************************************************
393 * BL2 specific defines.
394 ******************************************************************************/
Soby Mathewaf14b462018-06-01 16:53:38 +0100395#if BL2_AT_EL3
Dimitris Papastamos25836492018-06-11 11:07:58 +0100396/* Put BL2 towards the middle of the Trusted SRAM */
Soby Mathewaf14b462018-06-01 16:53:38 +0100397#define BL2_BASE (ARM_TRUSTED_SRAM_BASE + \
Dimitris Papastamos25836492018-06-11 11:07:58 +0100398 (PLAT_ARM_TRUSTED_SRAM_SIZE >> 1) + 0x2000)
Roberto Vargas52207802017-11-17 13:22:18 +0000399#define BL2_LIMIT (ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
400
David Wang0ba499f2016-03-07 11:02:57 +0800401#else
Dan Handley9df48042015-03-19 18:58:55 +0000402/*
Soby Mathewaf14b462018-06-01 16:53:38 +0100403 * Put BL2 just below BL1.
Dan Handley9df48042015-03-19 18:58:55 +0000404 */
Soby Mathewaf14b462018-06-01 16:53:38 +0100405#define BL2_BASE (BL1_RW_BASE - PLAT_ARM_MAX_BL2_SIZE)
406#define BL2_LIMIT BL1_RW_BASE
David Wang0ba499f2016-03-07 11:02:57 +0800407#endif
Dan Handley9df48042015-03-19 18:58:55 +0000408
409/*******************************************************************************
Juan Castillo7d199412015-12-14 09:35:25 +0000410 * BL31 specific defines.
Dan Handley9df48042015-03-19 18:58:55 +0000411 ******************************************************************************/
Madhukar Pappireddyd7419442020-01-27 15:38:26 -0600412#if ARM_BL31_IN_DRAM || SEPARATE_NOBITS_REGION
David Wang0ba499f2016-03-07 11:02:57 +0800413/*
414 * Put BL31 at the bottom of TZC secured DRAM
415 */
416#define BL31_BASE ARM_AP_TZC_DRAM1_BASE
417#define BL31_LIMIT (ARM_AP_TZC_DRAM1_BASE + \
418 PLAT_ARM_MAX_BL31_SIZE)
Madhukar Pappireddyd7419442020-01-27 15:38:26 -0600419/*
420 * For SEPARATE_NOBITS_REGION, BL31 PROGBITS are loaded in TZC secured DRAM.
421 * And BL31 NOBITS are loaded in Trusted SRAM such that BL2 is overwritten.
422 */
423#if SEPARATE_NOBITS_REGION
424#define BL31_NOBITS_BASE BL2_BASE
425#define BL31_NOBITS_LIMIT BL2_LIMIT
426#endif /* SEPARATE_NOBITS_REGION */
Qixiang Xua5f72812017-08-31 11:45:32 +0800427#elif (RESET_TO_BL31)
Manish Pandey2207e932019-11-06 13:17:46 +0000428/* Ensure Position Independent support (PIE) is enabled for this config.*/
429# if !ENABLE_PIE
430# error "BL31 must be a PIE if RESET_TO_BL31=1."
431#endif
Qixiang Xua5f72812017-08-31 11:45:32 +0800432/*
Soby Mathew68e69282018-12-12 14:13:52 +0000433 * Since this is PIE, we can define BL31_BASE to 0x0 since this macro is solely
Soby Mathewc5e17452019-01-07 14:07:58 +0000434 * used for building BL31 and not used for loading BL31.
Qixiang Xua5f72812017-08-31 11:45:32 +0800435 */
Soby Mathewc5e17452019-01-07 14:07:58 +0000436# define BL31_BASE 0x0
437# define BL31_LIMIT PLAT_ARM_MAX_BL31_SIZE
David Wang0ba499f2016-03-07 11:02:57 +0800438#else
Soby Mathewaf14b462018-06-01 16:53:38 +0100439/* Put BL31 below BL2 in the Trusted SRAM.*/
440#define BL31_BASE ((ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)\
441 - PLAT_ARM_MAX_BL31_SIZE)
442#define BL31_PROGBITS_LIMIT BL2_BASE
Dimitris Papastamos25836492018-06-11 11:07:58 +0100443/*
444 * For BL2_AT_EL3 make sure the BL31 can grow up until BL2_BASE. This is
445 * because in the BL2_AT_EL3 configuration, BL2 is always resident.
446 */
447#if BL2_AT_EL3
448#define BL31_LIMIT BL2_BASE
449#else
Dan Handley9df48042015-03-19 18:58:55 +0000450#define BL31_LIMIT (ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
David Wang0ba499f2016-03-07 11:02:57 +0800451#endif
Dimitris Papastamos25836492018-06-11 11:07:58 +0100452#endif
Dan Handley9df48042015-03-19 18:58:55 +0000453
Julius Werner8e0ef0f2019-07-09 14:02:43 -0700454#if !defined(__aarch64__) || JUNO_AARCH32_EL3_RUNTIME
Dan Handley9df48042015-03-19 18:58:55 +0000455/*******************************************************************************
Soby Mathewbf169232017-11-14 14:10:10 +0000456 * BL32 specific defines for EL3 runtime in AArch32 mode
457 ******************************************************************************/
458# if RESET_TO_SP_MIN && !JUNO_AARCH32_EL3_RUNTIME
Soby Mathewaf14b462018-06-01 16:53:38 +0100459/*
460 * SP_MIN is the only BL image in SRAM. Allocate the whole of SRAM (excluding
461 * the page reserved for fw_configs) to BL32
462 */
Sathees Balya90950092018-11-15 14:22:30 +0000463# define BL32_BASE ARM_FW_CONFIG_LIMIT
Soby Mathewbf169232017-11-14 14:10:10 +0000464# define BL32_LIMIT (ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
465# else
Soby Mathewaf14b462018-06-01 16:53:38 +0100466/* Put BL32 below BL2 in the Trusted SRAM.*/
467# define BL32_BASE ((ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)\
468 - PLAT_ARM_MAX_BL32_SIZE)
469# define BL32_PROGBITS_LIMIT BL2_BASE
Soby Mathewbf169232017-11-14 14:10:10 +0000470# define BL32_LIMIT (ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
471# endif /* RESET_TO_SP_MIN && !JUNO_AARCH32_EL3_RUNTIME */
472
473#else
474/*******************************************************************************
475 * BL32 specific defines for EL3 runtime in AArch64 mode
Dan Handley9df48042015-03-19 18:58:55 +0000476 ******************************************************************************/
477/*
478 * On ARM standard platforms, the TSP can execute from Trusted SRAM,
479 * Trusted DRAM (if available) or the DRAM region secured by the TrustZone
480 * controller.
481 */
Paul Beesleydb4e25a2019-10-14 15:27:12 +0000482# if SPM_MM
Soby Mathewbf169232017-11-14 14:10:10 +0000483# define TSP_SEC_MEM_BASE (ARM_AP_TZC_DRAM1_BASE + ULL(0x200000))
484# define TSP_SEC_MEM_SIZE (ARM_AP_TZC_DRAM1_SIZE - ULL(0x200000))
485# define BL32_BASE (ARM_AP_TZC_DRAM1_BASE + ULL(0x200000))
486# define BL32_LIMIT (ARM_AP_TZC_DRAM1_BASE + \
Antonio Nino Diaz7289f922017-11-09 11:34:09 +0000487 ARM_AP_TZC_DRAM1_SIZE)
Achin Guptae97351d2019-10-11 15:15:19 +0100488# elif defined(SPD_spmd)
489# define TSP_SEC_MEM_BASE (ARM_AP_TZC_DRAM1_BASE + ULL(0x200000))
490# define TSP_SEC_MEM_SIZE (ARM_AP_TZC_DRAM1_SIZE - ULL(0x200000))
491# define BL32_BASE PLAT_ARM_TRUSTED_DRAM_BASE
492# define BL32_LIMIT (PLAT_ARM_TRUSTED_DRAM_BASE \
493 + (UL(1) << 21))
Soby Mathewbf169232017-11-14 14:10:10 +0000494# elif ARM_BL31_IN_DRAM
495# define TSP_SEC_MEM_BASE (ARM_AP_TZC_DRAM1_BASE + \
David Wang0ba499f2016-03-07 11:02:57 +0800496 PLAT_ARM_MAX_BL31_SIZE)
Soby Mathewbf169232017-11-14 14:10:10 +0000497# define TSP_SEC_MEM_SIZE (ARM_AP_TZC_DRAM1_SIZE - \
David Wang0ba499f2016-03-07 11:02:57 +0800498 PLAT_ARM_MAX_BL31_SIZE)
Soby Mathewbf169232017-11-14 14:10:10 +0000499# define BL32_BASE (ARM_AP_TZC_DRAM1_BASE + \
David Wang0ba499f2016-03-07 11:02:57 +0800500 PLAT_ARM_MAX_BL31_SIZE)
Soby Mathewbf169232017-11-14 14:10:10 +0000501# define BL32_LIMIT (ARM_AP_TZC_DRAM1_BASE + \
David Wang0ba499f2016-03-07 11:02:57 +0800502 ARM_AP_TZC_DRAM1_SIZE)
Soby Mathewbf169232017-11-14 14:10:10 +0000503# elif ARM_TSP_RAM_LOCATION_ID == ARM_TRUSTED_SRAM_ID
504# define TSP_SEC_MEM_BASE ARM_BL_RAM_BASE
505# define TSP_SEC_MEM_SIZE ARM_BL_RAM_SIZE
Soby Mathewaf14b462018-06-01 16:53:38 +0100506# define TSP_PROGBITS_LIMIT BL31_BASE
Sathees Balya90950092018-11-15 14:22:30 +0000507# define BL32_BASE ARM_FW_CONFIG_LIMIT
Soby Mathewbf169232017-11-14 14:10:10 +0000508# define BL32_LIMIT BL31_BASE
509# elif ARM_TSP_RAM_LOCATION_ID == ARM_TRUSTED_DRAM_ID
510# define TSP_SEC_MEM_BASE PLAT_ARM_TRUSTED_DRAM_BASE
511# define TSP_SEC_MEM_SIZE PLAT_ARM_TRUSTED_DRAM_SIZE
512# define BL32_BASE PLAT_ARM_TRUSTED_DRAM_BASE
513# define BL32_LIMIT (PLAT_ARM_TRUSTED_DRAM_BASE \
Antonio Nino Diazab5d2b12018-10-30 16:12:32 +0000514 + (UL(1) << 21))
Soby Mathewbf169232017-11-14 14:10:10 +0000515# elif ARM_TSP_RAM_LOCATION_ID == ARM_DRAM_ID
516# define TSP_SEC_MEM_BASE ARM_AP_TZC_DRAM1_BASE
517# define TSP_SEC_MEM_SIZE ARM_AP_TZC_DRAM1_SIZE
518# define BL32_BASE ARM_AP_TZC_DRAM1_BASE
519# define BL32_LIMIT (ARM_AP_TZC_DRAM1_BASE + \
Dan Handley9df48042015-03-19 18:58:55 +0000520 ARM_AP_TZC_DRAM1_SIZE)
Soby Mathewbf169232017-11-14 14:10:10 +0000521# else
522# error "Unsupported ARM_TSP_RAM_LOCATION_ID value"
523# endif
Julius Werner8e0ef0f2019-07-09 14:02:43 -0700524#endif /* !__aarch64__ || JUNO_AARCH32_EL3_RUNTIME */
Dan Handley9df48042015-03-19 18:58:55 +0000525
Antonio Nino Diaz7289f922017-11-09 11:34:09 +0000526/*
527 * BL32 is mandatory in AArch32. In AArch64, undefine BL32_BASE if there is no
Achin Guptae97351d2019-10-11 15:15:19 +0100528 * SPD and no SPM-MM, as they are the only ones that can be used as BL32.
Antonio Nino Diaz7289f922017-11-09 11:34:09 +0000529 */
Julius Werner8e0ef0f2019-07-09 14:02:43 -0700530#if defined(__aarch64__) && !JUNO_AARCH32_EL3_RUNTIME
Paul Beesleydb4e25a2019-10-14 15:27:12 +0000531# if defined(SPD_none) && !SPM_MM
Antonio Nino Diaz7289f922017-11-09 11:34:09 +0000532# undef BL32_BASE
Achin Guptae97351d2019-10-11 15:15:19 +0100533# endif /* defined(SPD_none) && !SPM_MM */
Julius Werner8e0ef0f2019-07-09 14:02:43 -0700534#endif /* defined(__aarch64__) && !JUNO_AARCH32_EL3_RUNTIME */
Antonio Nino Diaze4fa3702016-04-05 11:38:49 +0100535
Yatharth Kochar736a3bf2015-10-11 14:14:55 +0100536/*******************************************************************************
537 * FWU Images: NS_BL1U, BL2U & NS_BL2U defines.
538 ******************************************************************************/
539#define BL2U_BASE BL2_BASE
Soby Mathewbf169232017-11-14 14:10:10 +0000540#define BL2U_LIMIT BL2_LIMIT
541
Yatharth Kochar736a3bf2015-10-11 14:14:55 +0100542#define NS_BL2U_BASE ARM_NS_DRAM1_BASE
Antonio Nino Diazab5d2b12018-10-30 16:12:32 +0000543#define NS_BL1U_BASE (PLAT_ARM_NVM_BASE + UL(0x03EB8000))
Yatharth Kochar736a3bf2015-10-11 14:14:55 +0100544
Dan Handley9df48042015-03-19 18:58:55 +0000545/*
546 * ID of the secure physical generic timer interrupt used by the TSP.
547 */
548#define TSP_IRQ_SEC_PHY_TIMER ARM_IRQ_SEC_PHY_TIMER
549
550
Vikram Kanigirid79214c2015-09-09 10:52:13 +0100551/*
552 * One cache line needed for bakery locks on ARM platforms
553 */
554#define PLAT_PERCPU_BAKERY_LOCK_SIZE (1 * CACHE_WRITEBACK_GRANULE)
555
Jeenu Viswambharanb1837452017-10-24 11:47:13 +0100556/* Priority levels for ARM platforms */
Jeenu Viswambharana5b5b8d2018-02-06 12:21:39 +0000557#define PLAT_RAS_PRI 0x10
Jeenu Viswambharanb1837452017-10-24 11:47:13 +0100558#define PLAT_SDEI_CRITICAL_PRI 0x60
559#define PLAT_SDEI_NORMAL_PRI 0x70
560
561/* ARM platforms use 3 upper bits of secure interrupt priority */
562#define ARM_PRI_BITS 3
Vikram Kanigirid79214c2015-09-09 10:52:13 +0100563
Jeenu Viswambharana5acc0a2017-09-22 08:32:10 +0100564/* SGI used for SDEI signalling */
565#define ARM_SDEI_SGI ARM_IRQ_SEC_SGI_0
566
567/* ARM SDEI dynamic private event numbers */
568#define ARM_SDEI_DP_EVENT_0 1000
569#define ARM_SDEI_DP_EVENT_1 1001
570#define ARM_SDEI_DP_EVENT_2 1002
571
572/* ARM SDEI dynamic shared event numbers */
573#define ARM_SDEI_DS_EVENT_0 2000
574#define ARM_SDEI_DS_EVENT_1 2001
575#define ARM_SDEI_DS_EVENT_2 2002
576
Jeenu Viswambharan6e284462017-12-08 10:38:24 +0000577#define ARM_SDEI_PRIVATE_EVENTS \
578 SDEI_DEFINE_EVENT_0(ARM_SDEI_SGI), \
579 SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_0, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
580 SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_1, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
581 SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_2, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC)
582
583#define ARM_SDEI_SHARED_EVENTS \
584 SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_0, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
585 SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_1, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
586 SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_2, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC)
587
Antonio Nino Diaz6f3ccc52018-07-20 09:17:26 +0100588#endif /* ARM_DEF_H */