xref: /rk3399_ARM-atf/include/plat/arm/common/arm_def.h (revision 034a2e3ef8a9e8e58f7cb7fab6db4ee60b2f9c29)
1 /*
2  * Copyright (c) 2015-2022, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 #ifndef ARM_DEF_H
7 #define ARM_DEF_H
8 
9 #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/arm/common/smccc_def.h>
16 #include <plat/common/common_def.h>
17 
18 /******************************************************************************
19  * Definitions common to all ARM standard platforms
20  *****************************************************************************/
21 
22 /*
23  * Root of trust key lengths
24  */
25 #define ARM_ROTPK_HEADER_LEN		19
26 #define ARM_ROTPK_HASH_LEN		32
27 /* ARM_ROTPK_KEY_LEN includes DER header + raw key material */
28 #define ARM_ROTPK_KEY_LEN		294
29 
30 /* Special value used to verify platform parameters from BL2 to BL31 */
31 #define ARM_BL31_PLAT_PARAM_VAL		ULL(0x0f1e2d3c4b5a6978)
32 
33 #define ARM_SYSTEM_COUNT		U(1)
34 
35 #define ARM_CACHE_WRITEBACK_SHIFT	6
36 
37 /*
38  * Macros mapping the MPIDR Affinity levels to ARM Platform Power levels. The
39  * power levels have a 1:1 mapping with the MPIDR affinity levels.
40  */
41 #define ARM_PWR_LVL0		MPIDR_AFFLVL0
42 #define ARM_PWR_LVL1		MPIDR_AFFLVL1
43 #define ARM_PWR_LVL2		MPIDR_AFFLVL2
44 #define ARM_PWR_LVL3		MPIDR_AFFLVL3
45 
46 /*
47  *  Macros for local power states in ARM platforms encoded by State-ID field
48  *  within the power-state parameter.
49  */
50 /* Local power state for power domains in Run state. */
51 #define ARM_LOCAL_STATE_RUN	U(0)
52 /* Local power state for retention. Valid only for CPU power domains */
53 #define ARM_LOCAL_STATE_RET	U(1)
54 /* Local power state for OFF/power-down. Valid for CPU and cluster power
55    domains */
56 #define ARM_LOCAL_STATE_OFF	U(2)
57 
58 /* Memory location options for TSP */
59 #define ARM_TRUSTED_SRAM_ID		0
60 #define ARM_TRUSTED_DRAM_ID		1
61 #define ARM_DRAM_ID			2
62 
63 #ifdef PLAT_ARM_TRUSTED_SRAM_BASE
64 #define ARM_TRUSTED_SRAM_BASE		PLAT_ARM_TRUSTED_SRAM_BASE
65 #else
66 #define ARM_TRUSTED_SRAM_BASE		UL(0x04000000)
67 #endif /* PLAT_ARM_TRUSTED_SRAM_BASE */
68 
69 #define ARM_SHARED_RAM_BASE		ARM_TRUSTED_SRAM_BASE
70 #define ARM_SHARED_RAM_SIZE		UL(0x00001000)	/* 4 KB */
71 
72 /* The remaining Trusted SRAM is used to load the BL images */
73 #define ARM_BL_RAM_BASE			(ARM_SHARED_RAM_BASE +	\
74 					 ARM_SHARED_RAM_SIZE)
75 #define ARM_BL_RAM_SIZE			(PLAT_ARM_TRUSTED_SRAM_SIZE -	\
76 					 ARM_SHARED_RAM_SIZE)
77 
78 /*
79  * The top 16MB (or 64MB if RME is enabled) of DRAM1 is configured as
80  * follows:
81  *   - SCP TZC DRAM: If present, DRAM reserved for SCP use
82  *   - L1 GPT DRAM: Reserved for L1 GPT if RME is enabled
83  *   - REALM DRAM: Reserved for Realm world if RME is enabled
84  *   - TF-A <-> RMM SHARED: Area shared for communication between TF-A and RMM
85  *   - AP TZC DRAM: The remaining TZC secured DRAM reserved for AP use
86  *
87  *              RME enabled(64MB)                RME not enabled(16MB)
88  *              --------------------             -------------------
89  *              |                  |             |                 |
90  *              |  AP TZC (~28MB)  |             |  AP TZC (~14MB) |
91  *              --------------------             -------------------
92  *              |                  |             |                 |
93  *              |   REALM (RMM)    |             |  EL3 TZC (2MB)  |
94  *              |   (32MB - 4KB)   |             -------------------
95  *              --------------------             |                 |
96  *              |                  |             |    SCP TZC      |
97  *              |   TF-A <-> RMM   |  0xFFFF_FFFF-------------------
98  *              |   SHARED (4KB)   |
99  *              --------------------
100  *              |                  |
101  *              |  EL3 TZC (3MB)   |
102  *              --------------------
103  *              | L1 GPT + SCP TZC |
104  *              |       (~1MB)     |
105  *  0xFFFF_FFFF --------------------
106  */
107 #if ENABLE_RME
108 #define ARM_TZC_DRAM1_SIZE              UL(0x04000000) /* 64MB */
109 /*
110  * Define a region within the TZC secured DRAM for use by EL3 runtime
111  * firmware. This region is meant to be NOLOAD and will not be zero
112  * initialized. Data sections with the attribute `arm_el3_tzc_dram` will be
113  * placed here. 3MB region is reserved if RME is enabled, 2MB otherwise.
114  */
115 #define ARM_EL3_TZC_DRAM1_SIZE		UL(0x00300000) /* 3MB */
116 #define ARM_L1_GPT_SIZE			UL(0x00100000) /* 1MB */
117 
118 /* 32MB - ARM_EL3_RMM_SHARED_SIZE */
119 #define ARM_REALM_SIZE			(UL(0x02000000) -		\
120 						ARM_EL3_RMM_SHARED_SIZE)
121 #define ARM_EL3_RMM_SHARED_SIZE		(PAGE_SIZE)    /* 4KB */
122 #else
123 #define ARM_TZC_DRAM1_SIZE		UL(0x01000000) /* 16MB */
124 #define ARM_EL3_TZC_DRAM1_SIZE		UL(0x00200000) /* 2MB */
125 #define ARM_L1_GPT_SIZE			UL(0)
126 #define ARM_REALM_SIZE			UL(0)
127 #define ARM_EL3_RMM_SHARED_SIZE		UL(0)
128 #endif /* ENABLE_RME */
129 
130 #define ARM_SCP_TZC_DRAM1_BASE		(ARM_DRAM1_BASE +		\
131 					ARM_DRAM1_SIZE -		\
132 					(ARM_SCP_TZC_DRAM1_SIZE +	\
133 					ARM_L1_GPT_SIZE))
134 #define ARM_SCP_TZC_DRAM1_SIZE		PLAT_ARM_SCP_TZC_DRAM1_SIZE
135 #define ARM_SCP_TZC_DRAM1_END		(ARM_SCP_TZC_DRAM1_BASE +	\
136 					ARM_SCP_TZC_DRAM1_SIZE - 1U)
137 #if ENABLE_RME
138 #define ARM_L1_GPT_ADDR_BASE		(ARM_DRAM1_BASE +		\
139 					ARM_DRAM1_SIZE -		\
140 					ARM_L1_GPT_SIZE)
141 #define ARM_L1_GPT_END			(ARM_L1_GPT_ADDR_BASE +		\
142 					ARM_L1_GPT_SIZE - 1U)
143 
144 #define ARM_REALM_BASE			(ARM_EL3_RMM_SHARED_BASE -	\
145 					 ARM_REALM_SIZE)
146 
147 #define ARM_REALM_END                   (ARM_REALM_BASE + ARM_REALM_SIZE - 1U)
148 
149 #define ARM_EL3_RMM_SHARED_BASE		(ARM_DRAM1_BASE +		\
150 					 ARM_DRAM1_SIZE -		\
151 					(ARM_SCP_TZC_DRAM1_SIZE +	\
152 					ARM_L1_GPT_SIZE +		\
153 					ARM_EL3_RMM_SHARED_SIZE +	\
154 					ARM_EL3_TZC_DRAM1_SIZE))
155 
156 #define ARM_EL3_RMM_SHARED_END		(ARM_EL3_RMM_SHARED_BASE +	\
157 					 ARM_EL3_RMM_SHARED_SIZE - 1U)
158 #endif /* ENABLE_RME */
159 
160 #define ARM_EL3_TZC_DRAM1_BASE		(ARM_SCP_TZC_DRAM1_BASE -	\
161 					ARM_EL3_TZC_DRAM1_SIZE)
162 #define ARM_EL3_TZC_DRAM1_END		(ARM_EL3_TZC_DRAM1_BASE +	\
163 					ARM_EL3_TZC_DRAM1_SIZE - 1U)
164 
165 #define ARM_AP_TZC_DRAM1_BASE		(ARM_DRAM1_BASE +		\
166 					ARM_DRAM1_SIZE -		\
167 					ARM_TZC_DRAM1_SIZE)
168 #define ARM_AP_TZC_DRAM1_SIZE		(ARM_TZC_DRAM1_SIZE -		\
169 					(ARM_SCP_TZC_DRAM1_SIZE +	\
170 					ARM_EL3_TZC_DRAM1_SIZE +	\
171 					ARM_EL3_RMM_SHARED_SIZE +	\
172 					ARM_REALM_SIZE +		\
173 					ARM_L1_GPT_SIZE))
174 #define ARM_AP_TZC_DRAM1_END		(ARM_AP_TZC_DRAM1_BASE +	\
175 					ARM_AP_TZC_DRAM1_SIZE - 1U)
176 
177 /* Define the Access permissions for Secure peripherals to NS_DRAM */
178 #if ARM_CRYPTOCELL_INTEG
179 /*
180  * Allow Secure peripheral to read NS DRAM when integrated with CryptoCell.
181  * This is required by CryptoCell to authenticate BL33 which is loaded
182  * into the Non Secure DDR.
183  */
184 #define ARM_TZC_NS_DRAM_S_ACCESS	TZC_REGION_S_RD
185 #else
186 #define ARM_TZC_NS_DRAM_S_ACCESS	TZC_REGION_S_NONE
187 #endif
188 
189 #ifdef SPD_opteed
190 /*
191  * BL2 needs to map 4MB at the end of TZC_DRAM1 in order to
192  * load/authenticate the trusted os extra image. The first 512KB of
193  * TZC_DRAM1 are reserved for trusted os (OPTEE). The extra image loading
194  * for OPTEE is paged image which only include the paging part using
195  * virtual memory but without "init" data. OPTEE will copy the "init" data
196  * (from pager image) to the first 512KB of TZC_DRAM, and then copy the
197  * extra image behind the "init" data.
198  */
199 #define ARM_OPTEE_PAGEABLE_LOAD_BASE	(ARM_AP_TZC_DRAM1_BASE + \
200 					 ARM_AP_TZC_DRAM1_SIZE - \
201 					 ARM_OPTEE_PAGEABLE_LOAD_SIZE)
202 #define ARM_OPTEE_PAGEABLE_LOAD_SIZE	UL(0x400000)
203 #define ARM_OPTEE_PAGEABLE_LOAD_MEM	MAP_REGION_FLAT(		\
204 					ARM_OPTEE_PAGEABLE_LOAD_BASE,	\
205 					ARM_OPTEE_PAGEABLE_LOAD_SIZE,	\
206 					MT_MEMORY | MT_RW | MT_SECURE)
207 
208 /*
209  * Map the memory for the OP-TEE core (also known as OP-TEE pager when paging
210  * support is enabled).
211  */
212 #define ARM_MAP_OPTEE_CORE_MEM		MAP_REGION_FLAT(		\
213 						BL32_BASE,		\
214 						BL32_LIMIT - BL32_BASE,	\
215 						MT_MEMORY | MT_RW | MT_SECURE)
216 #endif /* SPD_opteed */
217 
218 #define ARM_NS_DRAM1_BASE		ARM_DRAM1_BASE
219 #define ARM_NS_DRAM1_SIZE		(ARM_DRAM1_SIZE -		\
220 					 ARM_TZC_DRAM1_SIZE)
221 
222 #define ARM_NS_DRAM1_END		(ARM_NS_DRAM1_BASE +		\
223 					 ARM_NS_DRAM1_SIZE - 1U)
224 #ifdef PLAT_ARM_DRAM1_BASE
225 #define ARM_DRAM1_BASE			PLAT_ARM_DRAM1_BASE
226 #else
227 #define ARM_DRAM1_BASE			ULL(0x80000000)
228 #endif /* PLAT_ARM_DRAM1_BASE */
229 
230 #define ARM_DRAM1_SIZE			ULL(0x80000000)
231 #define ARM_DRAM1_END			(ARM_DRAM1_BASE +		\
232 					 ARM_DRAM1_SIZE - 1U)
233 
234 #define ARM_DRAM2_BASE			PLAT_ARM_DRAM2_BASE
235 #define ARM_DRAM2_SIZE			PLAT_ARM_DRAM2_SIZE
236 #define ARM_DRAM2_END			(ARM_DRAM2_BASE +		\
237 					 ARM_DRAM2_SIZE - 1U)
238 
239 #define ARM_IRQ_SEC_PHY_TIMER		29
240 
241 #define ARM_IRQ_SEC_SGI_0		8
242 #define ARM_IRQ_SEC_SGI_1		9
243 #define ARM_IRQ_SEC_SGI_2		10
244 #define ARM_IRQ_SEC_SGI_3		11
245 #define ARM_IRQ_SEC_SGI_4		12
246 #define ARM_IRQ_SEC_SGI_5		13
247 #define ARM_IRQ_SEC_SGI_6		14
248 #define ARM_IRQ_SEC_SGI_7		15
249 
250 /*
251  * Define a list of Group 1 Secure and Group 0 interrupt properties as per GICv3
252  * terminology. On a GICv2 system or mode, the lists will be merged and treated
253  * as Group 0 interrupts.
254  */
255 #define ARM_G1S_IRQ_PROPS(grp) \
256 	INTR_PROP_DESC(ARM_IRQ_SEC_PHY_TIMER, GIC_HIGHEST_SEC_PRIORITY, (grp), \
257 			GIC_INTR_CFG_LEVEL), \
258 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_1, GIC_HIGHEST_SEC_PRIORITY, (grp), \
259 			GIC_INTR_CFG_EDGE), \
260 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_2, GIC_HIGHEST_SEC_PRIORITY, (grp), \
261 			GIC_INTR_CFG_EDGE), \
262 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_3, GIC_HIGHEST_SEC_PRIORITY, (grp), \
263 			GIC_INTR_CFG_EDGE), \
264 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_4, GIC_HIGHEST_SEC_PRIORITY, (grp), \
265 			GIC_INTR_CFG_EDGE), \
266 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_5, GIC_HIGHEST_SEC_PRIORITY, (grp), \
267 			GIC_INTR_CFG_EDGE), \
268 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_7, GIC_HIGHEST_SEC_PRIORITY, (grp), \
269 			GIC_INTR_CFG_EDGE)
270 
271 #define ARM_G0_IRQ_PROPS(grp) \
272 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_0, PLAT_SDEI_NORMAL_PRI, (grp), \
273 			GIC_INTR_CFG_EDGE), \
274 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_6, GIC_HIGHEST_SEC_PRIORITY, (grp), \
275 			GIC_INTR_CFG_EDGE)
276 
277 #define ARM_MAP_SHARED_RAM	MAP_REGION_FLAT(			\
278 					ARM_SHARED_RAM_BASE,		\
279 					ARM_SHARED_RAM_SIZE,		\
280 					MT_DEVICE | MT_RW | EL3_PAS)
281 
282 #define ARM_MAP_NS_DRAM1	MAP_REGION_FLAT(			\
283 					ARM_NS_DRAM1_BASE,		\
284 					ARM_NS_DRAM1_SIZE,		\
285 					MT_MEMORY | MT_RW | MT_NS)
286 
287 #define ARM_MAP_DRAM2		MAP_REGION_FLAT(			\
288 					ARM_DRAM2_BASE,			\
289 					ARM_DRAM2_SIZE,			\
290 					MT_MEMORY | MT_RW | MT_NS)
291 
292 #define ARM_MAP_TSP_SEC_MEM	MAP_REGION_FLAT(			\
293 					TSP_SEC_MEM_BASE,		\
294 					TSP_SEC_MEM_SIZE,		\
295 					MT_MEMORY | MT_RW | MT_SECURE)
296 
297 #if ARM_BL31_IN_DRAM
298 #define ARM_MAP_BL31_SEC_DRAM	MAP_REGION_FLAT(			\
299 					BL31_BASE,			\
300 					PLAT_ARM_MAX_BL31_SIZE,		\
301 					MT_MEMORY | MT_RW | MT_SECURE)
302 #endif
303 
304 #define ARM_MAP_EL3_TZC_DRAM	MAP_REGION_FLAT(			\
305 					ARM_EL3_TZC_DRAM1_BASE,		\
306 					ARM_EL3_TZC_DRAM1_SIZE,		\
307 					MT_MEMORY | MT_RW | EL3_PAS)
308 
309 #define ARM_MAP_TRUSTED_DRAM	MAP_REGION_FLAT(			\
310 					PLAT_ARM_TRUSTED_DRAM_BASE,	\
311 					PLAT_ARM_TRUSTED_DRAM_SIZE,	\
312 					MT_MEMORY | MT_RW | MT_SECURE)
313 
314 #if ENABLE_RME
315 /*
316  * We add the EL3_RMM_SHARED size to RMM mapping to map the region as a block.
317  * Else we end up requiring more pagetables in BL2 for ROMLIB build.
318  */
319 #define ARM_MAP_RMM_DRAM	MAP_REGION_FLAT(			\
320 					PLAT_ARM_RMM_BASE,		\
321 					(PLAT_ARM_RMM_SIZE + 		\
322 					ARM_EL3_RMM_SHARED_SIZE),	\
323 					MT_MEMORY | MT_RW | MT_REALM)
324 
325 
326 #define ARM_MAP_GPT_L1_DRAM	MAP_REGION_FLAT(			\
327 					ARM_L1_GPT_ADDR_BASE,		\
328 					ARM_L1_GPT_SIZE,		\
329 					MT_MEMORY | MT_RW | EL3_PAS)
330 
331 #define ARM_MAP_EL3_RMM_SHARED_MEM					\
332 				MAP_REGION_FLAT(			\
333 					ARM_EL3_RMM_SHARED_BASE,	\
334 					ARM_EL3_RMM_SHARED_SIZE,	\
335 					MT_MEMORY | MT_RW | MT_REALM)
336 
337 #endif /* ENABLE_RME */
338 
339 /*
340  * Mapping for the BL1 RW region. This mapping is needed by BL2 in order to
341  * share the Mbed TLS heap. Since the heap is allocated inside BL1, it resides
342  * in the BL1 RW region. Hence, BL2 needs access to the BL1 RW region in order
343  * to be able to access the heap.
344  */
345 #define ARM_MAP_BL1_RW		MAP_REGION_FLAT(	\
346 					BL1_RW_BASE,	\
347 					BL1_RW_LIMIT - BL1_RW_BASE, \
348 					MT_MEMORY | MT_RW | EL3_PAS)
349 
350 /*
351  * If SEPARATE_CODE_AND_RODATA=1 we define a region for each section
352  * otherwise one region is defined containing both.
353  */
354 #if SEPARATE_CODE_AND_RODATA
355 #define ARM_MAP_BL_RO			MAP_REGION_FLAT(			\
356 						BL_CODE_BASE,			\
357 						BL_CODE_END - BL_CODE_BASE,	\
358 						MT_CODE | EL3_PAS),		\
359 					MAP_REGION_FLAT(			\
360 						BL_RO_DATA_BASE,		\
361 						BL_RO_DATA_END			\
362 							- BL_RO_DATA_BASE,	\
363 						MT_RO_DATA | EL3_PAS)
364 #else
365 #define ARM_MAP_BL_RO			MAP_REGION_FLAT(			\
366 						BL_CODE_BASE,			\
367 						BL_CODE_END - BL_CODE_BASE,	\
368 						MT_CODE | EL3_PAS)
369 #endif
370 #if USE_COHERENT_MEM
371 #define ARM_MAP_BL_COHERENT_RAM		MAP_REGION_FLAT(			\
372 						BL_COHERENT_RAM_BASE,		\
373 						BL_COHERENT_RAM_END		\
374 							- BL_COHERENT_RAM_BASE, \
375 						MT_DEVICE | MT_RW | EL3_PAS)
376 #endif
377 #if USE_ROMLIB
378 #define ARM_MAP_ROMLIB_CODE		MAP_REGION_FLAT(			\
379 						ROMLIB_RO_BASE,			\
380 						ROMLIB_RO_LIMIT	- ROMLIB_RO_BASE,\
381 						MT_CODE | EL3_PAS)
382 
383 #define ARM_MAP_ROMLIB_DATA		MAP_REGION_FLAT(			\
384 						ROMLIB_RW_BASE,			\
385 						ROMLIB_RW_END	- ROMLIB_RW_BASE,\
386 						MT_MEMORY | MT_RW | EL3_PAS)
387 #endif
388 
389 /*
390  * Map mem_protect flash region with read and write permissions
391  */
392 #define ARM_V2M_MAP_MEM_PROTECT		MAP_REGION_FLAT(PLAT_ARM_MEM_PROT_ADDR,	\
393 						V2M_FLASH_BLOCK_SIZE,		\
394 						MT_DEVICE | MT_RW | MT_SECURE)
395 /*
396  * Map the region for device tree configuration with read and write permissions
397  */
398 #define ARM_MAP_BL_CONFIG_REGION	MAP_REGION_FLAT(ARM_BL_RAM_BASE,	\
399 						(ARM_FW_CONFIGS_LIMIT		\
400 							- ARM_BL_RAM_BASE),	\
401 						MT_MEMORY | MT_RW | EL3_PAS)
402 /*
403  * Map L0_GPT with read and write permissions
404  */
405 #if ENABLE_RME
406 #define ARM_MAP_L0_GPT_REGION		MAP_REGION_FLAT(ARM_L0_GPT_ADDR_BASE,	\
407 						ARM_L0_GPT_SIZE,		\
408 						MT_MEMORY | MT_RW | MT_ROOT)
409 #endif
410 
411 /*
412  * The max number of regions like RO(code), coherent and data required by
413  * different BL stages which need to be mapped in the MMU.
414  */
415 #define ARM_BL_REGIONS			7
416 
417 #define MAX_MMAP_REGIONS		(PLAT_ARM_MMAP_ENTRIES +	\
418 					 ARM_BL_REGIONS)
419 
420 /* Memory mapped Generic timer interfaces  */
421 #ifdef PLAT_ARM_SYS_CNTCTL_BASE
422 #define ARM_SYS_CNTCTL_BASE		PLAT_ARM_SYS_CNTCTL_BASE
423 #else
424 #define ARM_SYS_CNTCTL_BASE		UL(0x2a430000)
425 #endif
426 
427 #ifdef PLAT_ARM_SYS_CNTREAD_BASE
428 #define ARM_SYS_CNTREAD_BASE		PLAT_ARM_SYS_CNTREAD_BASE
429 #else
430 #define ARM_SYS_CNTREAD_BASE		UL(0x2a800000)
431 #endif
432 
433 #ifdef PLAT_ARM_SYS_TIMCTL_BASE
434 #define ARM_SYS_TIMCTL_BASE		PLAT_ARM_SYS_TIMCTL_BASE
435 #else
436 #define ARM_SYS_TIMCTL_BASE		UL(0x2a810000)
437 #endif
438 
439 #ifdef PLAT_ARM_SYS_CNT_BASE_S
440 #define ARM_SYS_CNT_BASE_S		PLAT_ARM_SYS_CNT_BASE_S
441 #else
442 #define ARM_SYS_CNT_BASE_S		UL(0x2a820000)
443 #endif
444 
445 #ifdef PLAT_ARM_SYS_CNT_BASE_NS
446 #define ARM_SYS_CNT_BASE_NS		PLAT_ARM_SYS_CNT_BASE_NS
447 #else
448 #define ARM_SYS_CNT_BASE_NS		UL(0x2a830000)
449 #endif
450 
451 #define ARM_CONSOLE_BAUDRATE		115200
452 
453 /* Trusted Watchdog constants */
454 #ifdef PLAT_ARM_SP805_TWDG_BASE
455 #define ARM_SP805_TWDG_BASE		PLAT_ARM_SP805_TWDG_BASE
456 #else
457 #define ARM_SP805_TWDG_BASE		UL(0x2a490000)
458 #endif
459 #define ARM_SP805_TWDG_CLK_HZ		32768
460 /* The TBBR document specifies a watchdog timeout of 256 seconds. SP805
461  * asserts reset after two consecutive countdowns (2 x 128 = 256 sec) */
462 #define ARM_TWDG_TIMEOUT_SEC		128
463 #define ARM_TWDG_LOAD_VAL		(ARM_SP805_TWDG_CLK_HZ * 	\
464 					 ARM_TWDG_TIMEOUT_SEC)
465 
466 /******************************************************************************
467  * Required platform porting definitions common to all ARM standard platforms
468  *****************************************************************************/
469 
470 /*
471  * This macro defines the deepest retention state possible. A higher state
472  * id will represent an invalid or a power down state.
473  */
474 #define PLAT_MAX_RET_STATE		ARM_LOCAL_STATE_RET
475 
476 /*
477  * This macro defines the deepest power down states possible. Any state ID
478  * higher than this is invalid.
479  */
480 #define PLAT_MAX_OFF_STATE		ARM_LOCAL_STATE_OFF
481 
482 /*
483  * Some data must be aligned on the biggest cache line size in the platform.
484  * This is known only to the platform as it might have a combination of
485  * integrated and external caches.
486  */
487 #define CACHE_WRITEBACK_GRANULE		(U(1) << ARM_CACHE_WRITEBACK_SHIFT)
488 
489 /*
490  * To enable FW_CONFIG to be loaded by BL1, define the corresponding base
491  * and limit. Leave enough space of BL2 meminfo.
492  */
493 #define ARM_FW_CONFIG_BASE		(ARM_BL_RAM_BASE + sizeof(meminfo_t))
494 #define ARM_FW_CONFIG_LIMIT		((ARM_BL_RAM_BASE + PAGE_SIZE) \
495 					+ (PAGE_SIZE / 2U))
496 
497 /*
498  * Boot parameters passed from BL2 to BL31/BL32 are stored here
499  */
500 #define ARM_BL2_MEM_DESC_BASE		(ARM_FW_CONFIG_LIMIT)
501 #define ARM_BL2_MEM_DESC_LIMIT		(ARM_BL2_MEM_DESC_BASE \
502 					+ (PAGE_SIZE / 2U))
503 
504 /*
505  * Define limit of firmware configuration memory:
506  * ARM_FW_CONFIG + ARM_BL2_MEM_DESC memory
507  */
508 #define ARM_FW_CONFIGS_LIMIT		(ARM_BL_RAM_BASE + (PAGE_SIZE * 2))
509 
510 #if ENABLE_RME
511 /*
512  * Store the L0 GPT on Trusted SRAM next to firmware
513  * configuration memory, 4KB aligned.
514  */
515 #define ARM_L0_GPT_SIZE			(PAGE_SIZE)
516 #define ARM_L0_GPT_ADDR_BASE		(ARM_FW_CONFIGS_LIMIT)
517 #define ARM_L0_GPT_LIMIT		(ARM_L0_GPT_ADDR_BASE + ARM_L0_GPT_SIZE)
518 #else
519 #define ARM_L0_GPT_SIZE			U(0)
520 #endif
521 
522 /*******************************************************************************
523  * BL1 specific defines.
524  * BL1 RW data is relocated from ROM to RAM at runtime so we need 2 sets of
525  * addresses.
526  ******************************************************************************/
527 #define BL1_RO_BASE			PLAT_ARM_TRUSTED_ROM_BASE
528 #ifdef PLAT_BL1_RO_LIMIT
529 #define BL1_RO_LIMIT			PLAT_BL1_RO_LIMIT
530 #else
531 #define BL1_RO_LIMIT			(PLAT_ARM_TRUSTED_ROM_BASE	\
532 					 + (PLAT_ARM_TRUSTED_ROM_SIZE - \
533 					    PLAT_ARM_MAX_ROMLIB_RO_SIZE))
534 #endif
535 
536 /*
537  * Put BL1 RW at the top of the Trusted SRAM.
538  */
539 #define BL1_RW_BASE			(ARM_BL_RAM_BASE +		\
540 						ARM_BL_RAM_SIZE -	\
541 						(PLAT_ARM_MAX_BL1_RW_SIZE +\
542 						 PLAT_ARM_MAX_ROMLIB_RW_SIZE))
543 #define BL1_RW_LIMIT			(ARM_BL_RAM_BASE + 		\
544 					    (ARM_BL_RAM_SIZE - PLAT_ARM_MAX_ROMLIB_RW_SIZE))
545 
546 #define ROMLIB_RO_BASE			BL1_RO_LIMIT
547 #define ROMLIB_RO_LIMIT			(PLAT_ARM_TRUSTED_ROM_BASE + PLAT_ARM_TRUSTED_ROM_SIZE)
548 
549 #define ROMLIB_RW_BASE			(BL1_RW_BASE + PLAT_ARM_MAX_BL1_RW_SIZE)
550 #define ROMLIB_RW_END			(ROMLIB_RW_BASE + PLAT_ARM_MAX_ROMLIB_RW_SIZE)
551 
552 /*******************************************************************************
553  * BL2 specific defines.
554  ******************************************************************************/
555 #if BL2_AT_EL3
556 #if ENABLE_PIE
557 /*
558  * As the BL31 image size appears to be increased when built with the ENABLE_PIE
559  * option, set BL2 base address to have enough space for BL31 in Trusted SRAM.
560  */
561 #define BL2_BASE			(ARM_TRUSTED_SRAM_BASE + \
562 					(PLAT_ARM_TRUSTED_SRAM_SIZE >> 1) + \
563 					0x3000)
564 #else
565 /* Put BL2 towards the middle of the Trusted SRAM */
566 #define BL2_BASE			(ARM_TRUSTED_SRAM_BASE + \
567 					(PLAT_ARM_TRUSTED_SRAM_SIZE >> 1) + \
568 					0x2000)
569 #endif /* ENABLE_PIE */
570 #define BL2_LIMIT			(ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
571 
572 #else
573 /*
574  * Put BL2 just below BL1.
575  */
576 #define BL2_BASE			(BL1_RW_BASE - PLAT_ARM_MAX_BL2_SIZE)
577 #define BL2_LIMIT			BL1_RW_BASE
578 #endif
579 
580 /*******************************************************************************
581  * BL31 specific defines.
582  ******************************************************************************/
583 #if ARM_BL31_IN_DRAM || SEPARATE_NOBITS_REGION
584 /*
585  * Put BL31 at the bottom of TZC secured DRAM
586  */
587 #define BL31_BASE			ARM_AP_TZC_DRAM1_BASE
588 #define BL31_LIMIT			(ARM_AP_TZC_DRAM1_BASE +	\
589 						PLAT_ARM_MAX_BL31_SIZE)
590 /*
591  * For SEPARATE_NOBITS_REGION, BL31 PROGBITS are loaded in TZC secured DRAM.
592  * And BL31 NOBITS are loaded in Trusted SRAM such that BL2 is overwritten.
593  */
594 #if SEPARATE_NOBITS_REGION
595 #define BL31_NOBITS_BASE		BL2_BASE
596 #define BL31_NOBITS_LIMIT		BL2_LIMIT
597 #endif /* SEPARATE_NOBITS_REGION */
598 #elif (RESET_TO_BL31)
599 /* Ensure Position Independent support (PIE) is enabled for this config.*/
600 # if !ENABLE_PIE
601 #  error "BL31 must be a PIE if RESET_TO_BL31=1."
602 #endif
603 /*
604  * Since this is PIE, we can define BL31_BASE to 0x0 since this macro is solely
605  * used for building BL31 and not used for loading BL31.
606  */
607 #  define BL31_BASE			0x0
608 #  define BL31_LIMIT			PLAT_ARM_MAX_BL31_SIZE
609 #else
610 /* Put BL31 below BL2 in the Trusted SRAM.*/
611 #define BL31_BASE			((ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)\
612 						- PLAT_ARM_MAX_BL31_SIZE)
613 #define BL31_PROGBITS_LIMIT		BL2_BASE
614 /*
615  * For BL2_AT_EL3 make sure the BL31 can grow up until BL2_BASE. This is
616  * because in the BL2_AT_EL3 configuration, BL2 is always resident.
617  */
618 #if BL2_AT_EL3
619 #define BL31_LIMIT			BL2_BASE
620 #else
621 #define BL31_LIMIT			(ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
622 #endif
623 #endif
624 
625 /******************************************************************************
626  * RMM specific defines
627  *****************************************************************************/
628 #if ENABLE_RME
629 #define RMM_BASE			(ARM_REALM_BASE)
630 #define RMM_LIMIT			(RMM_BASE + ARM_REALM_SIZE)
631 #define RMM_SHARED_BASE			(ARM_EL3_RMM_SHARED_BASE)
632 #define RMM_SHARED_SIZE			(ARM_EL3_RMM_SHARED_SIZE)
633 #endif
634 
635 #if !defined(__aarch64__) || JUNO_AARCH32_EL3_RUNTIME
636 /*******************************************************************************
637  * BL32 specific defines for EL3 runtime in AArch32 mode
638  ******************************************************************************/
639 # if RESET_TO_SP_MIN && !JUNO_AARCH32_EL3_RUNTIME
640 /* Ensure Position Independent support (PIE) is enabled for this config.*/
641 # if !ENABLE_PIE
642 #  error "BL32 must be a PIE if RESET_TO_SP_MIN=1."
643 #endif
644 /*
645  * Since this is PIE, we can define BL32_BASE to 0x0 since this macro is solely
646  * used for building BL32 and not used for loading BL32.
647  */
648 #  define BL32_BASE			0x0
649 #  define BL32_LIMIT			PLAT_ARM_MAX_BL32_SIZE
650 # else
651 /* Put BL32 below BL2 in the Trusted SRAM.*/
652 #  define BL32_BASE			((ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)\
653 						- PLAT_ARM_MAX_BL32_SIZE)
654 #  define BL32_PROGBITS_LIMIT		BL2_BASE
655 #  define BL32_LIMIT			(ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
656 # endif /* RESET_TO_SP_MIN && !JUNO_AARCH32_EL3_RUNTIME */
657 
658 #else
659 /*******************************************************************************
660  * BL32 specific defines for EL3 runtime in AArch64 mode
661  ******************************************************************************/
662 /*
663  * On ARM standard platforms, the TSP can execute from Trusted SRAM,
664  * Trusted DRAM (if available) or the DRAM region secured by the TrustZone
665  * controller.
666  */
667 # if SPM_MM || SPMC_AT_EL3
668 #  define TSP_SEC_MEM_BASE		(ARM_AP_TZC_DRAM1_BASE + ULL(0x200000))
669 #  define TSP_SEC_MEM_SIZE		(ARM_AP_TZC_DRAM1_SIZE - ULL(0x200000))
670 #  define BL32_BASE			(ARM_AP_TZC_DRAM1_BASE + ULL(0x200000))
671 #  define BL32_LIMIT			(ARM_AP_TZC_DRAM1_BASE +	\
672 						ARM_AP_TZC_DRAM1_SIZE)
673 # elif defined(SPD_spmd)
674 #  define TSP_SEC_MEM_BASE		(ARM_AP_TZC_DRAM1_BASE + ULL(0x200000))
675 #  define TSP_SEC_MEM_SIZE		(ARM_AP_TZC_DRAM1_SIZE - ULL(0x200000))
676 #  define BL32_BASE			PLAT_ARM_SPMC_BASE
677 #  define BL32_LIMIT			(PLAT_ARM_SPMC_BASE +		\
678 						 PLAT_ARM_SPMC_SIZE)
679 # elif ARM_BL31_IN_DRAM
680 #  define TSP_SEC_MEM_BASE		(ARM_AP_TZC_DRAM1_BASE +	\
681 						PLAT_ARM_MAX_BL31_SIZE)
682 #  define TSP_SEC_MEM_SIZE		(ARM_AP_TZC_DRAM1_SIZE -	\
683 						PLAT_ARM_MAX_BL31_SIZE)
684 #  define BL32_BASE			(ARM_AP_TZC_DRAM1_BASE +	\
685 						PLAT_ARM_MAX_BL31_SIZE)
686 #  define BL32_LIMIT			(ARM_AP_TZC_DRAM1_BASE +	\
687 						ARM_AP_TZC_DRAM1_SIZE)
688 # elif ARM_TSP_RAM_LOCATION_ID == ARM_TRUSTED_SRAM_ID
689 #  define TSP_SEC_MEM_BASE		ARM_BL_RAM_BASE
690 #  define TSP_SEC_MEM_SIZE		ARM_BL_RAM_SIZE
691 #  define TSP_PROGBITS_LIMIT		BL31_BASE
692 #  define BL32_BASE			ARM_FW_CONFIGS_LIMIT
693 #  define BL32_LIMIT			BL31_BASE
694 # elif ARM_TSP_RAM_LOCATION_ID == ARM_TRUSTED_DRAM_ID
695 #  define TSP_SEC_MEM_BASE		PLAT_ARM_TRUSTED_DRAM_BASE
696 #  define TSP_SEC_MEM_SIZE		PLAT_ARM_TRUSTED_DRAM_SIZE
697 #  define BL32_BASE			PLAT_ARM_TRUSTED_DRAM_BASE
698 #  define BL32_LIMIT			(PLAT_ARM_TRUSTED_DRAM_BASE	\
699 						+ (UL(1) << 21))
700 # elif ARM_TSP_RAM_LOCATION_ID == ARM_DRAM_ID
701 #  define TSP_SEC_MEM_BASE		ARM_AP_TZC_DRAM1_BASE
702 #  define TSP_SEC_MEM_SIZE		ARM_AP_TZC_DRAM1_SIZE
703 #  define BL32_BASE			ARM_AP_TZC_DRAM1_BASE
704 #  define BL32_LIMIT			(ARM_AP_TZC_DRAM1_BASE +	\
705 						ARM_AP_TZC_DRAM1_SIZE)
706 # else
707 #  error "Unsupported ARM_TSP_RAM_LOCATION_ID value"
708 # endif
709 #endif /* !__aarch64__ || JUNO_AARCH32_EL3_RUNTIME */
710 
711 /*
712  * BL32 is mandatory in AArch32. In AArch64, undefine BL32_BASE if there is no
713  * SPD and no SPM-MM and no SPMC-AT-EL3, as they are the only ones that can be
714  * used as BL32.
715  */
716 #if defined(__aarch64__) && !JUNO_AARCH32_EL3_RUNTIME
717 # if defined(SPD_none) && !SPM_MM && !SPMC_AT_EL3
718 #  undef BL32_BASE
719 # endif /* defined(SPD_none) && !SPM_MM || !SPMC_AT_EL3 */
720 #endif /* defined(__aarch64__) && !JUNO_AARCH32_EL3_RUNTIME */
721 
722 /*******************************************************************************
723  * FWU Images: NS_BL1U, BL2U & NS_BL2U defines.
724  ******************************************************************************/
725 #define BL2U_BASE			BL2_BASE
726 #define BL2U_LIMIT			BL2_LIMIT
727 
728 #define NS_BL2U_BASE			ARM_NS_DRAM1_BASE
729 #define NS_BL1U_BASE			(PLAT_ARM_NVM_BASE + UL(0x03EB8000))
730 
731 /*
732  * ID of the secure physical generic timer interrupt used by the TSP.
733  */
734 #define TSP_IRQ_SEC_PHY_TIMER		ARM_IRQ_SEC_PHY_TIMER
735 
736 
737 /*
738  * One cache line needed for bakery locks on ARM platforms
739  */
740 #define PLAT_PERCPU_BAKERY_LOCK_SIZE		(1 * CACHE_WRITEBACK_GRANULE)
741 
742 /* Priority levels for ARM platforms */
743 #define PLAT_RAS_PRI			0x10
744 #define PLAT_SDEI_CRITICAL_PRI		0x60
745 #define PLAT_SDEI_NORMAL_PRI		0x70
746 
747 /* ARM platforms use 3 upper bits of secure interrupt priority */
748 #define PLAT_PRI_BITS			3
749 
750 /* SGI used for SDEI signalling */
751 #define ARM_SDEI_SGI			ARM_IRQ_SEC_SGI_0
752 
753 #if SDEI_IN_FCONF
754 /* ARM SDEI dynamic private event max count */
755 #define ARM_SDEI_DP_EVENT_MAX_CNT	3
756 
757 /* ARM SDEI dynamic shared event max count */
758 #define ARM_SDEI_DS_EVENT_MAX_CNT	3
759 #else
760 /* ARM SDEI dynamic private event numbers */
761 #define ARM_SDEI_DP_EVENT_0		1000
762 #define ARM_SDEI_DP_EVENT_1		1001
763 #define ARM_SDEI_DP_EVENT_2		1002
764 
765 /* ARM SDEI dynamic shared event numbers */
766 #define ARM_SDEI_DS_EVENT_0		2000
767 #define ARM_SDEI_DS_EVENT_1		2001
768 #define ARM_SDEI_DS_EVENT_2		2002
769 
770 #define ARM_SDEI_PRIVATE_EVENTS \
771 	SDEI_DEFINE_EVENT_0(ARM_SDEI_SGI), \
772 	SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_0, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
773 	SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_1, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
774 	SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_2, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC)
775 
776 #define ARM_SDEI_SHARED_EVENTS \
777 	SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_0, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
778 	SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_1, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
779 	SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_2, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC)
780 #endif /* SDEI_IN_FCONF */
781 
782 #endif /* ARM_DEF_H */
783