xref: /rk3399_ARM-atf/include/plat/arm/common/arm_def.h (revision 0f58d4f2c8173e01ce3276fbc7bd981c3f23d902)
1b4315306SDan Handley /*
2c228956aSSoby Mathew  * Copyright (c) 2015-2018, ARM Limited and Contributors. All rights reserved.
3b4315306SDan Handley  *
482cb2c1aSdp-arm  * SPDX-License-Identifier: BSD-3-Clause
5b4315306SDan Handley  */
61083b2b3SAntonio Nino Diaz #ifndef ARM_DEF_H
71083b2b3SAntonio Nino Diaz #define ARM_DEF_H
8b4315306SDan Handley 
938dce70fSSoby Mathew #include <arch.h>
10b4315306SDan Handley #include <common_def.h>
11b2c363b1SJeenu Viswambharan #include <gic_common.h>
12b2c363b1SJeenu Viswambharan #include <interrupt_props.h>
13b4315306SDan Handley #include <platform_def.h>
14dff93c86SJuan Castillo #include <tbbr_img_def.h>
1553d9c9c8SScott Branden #include <utils_def.h>
16bf75a371SAntonio Nino Diaz #include <xlat_tables_defs.h>
17b4315306SDan Handley 
18b4315306SDan Handley 
19b4315306SDan Handley /******************************************************************************
20b4315306SDan Handley  * Definitions common to all ARM standard platforms
21b4315306SDan Handley  *****************************************************************************/
22b4315306SDan Handley 
23d178637dSJuan Castillo /* Special value used to verify platform parameters from BL2 to BL31 */
24b4315306SDan Handley #define ARM_BL31_PLAT_PARAM_VAL		0x0f1e2d3c4b5a6978ULL
25b4315306SDan Handley 
265f3a6030SSoby Mathew #define ARM_SYSTEM_COUNT		1
27b4315306SDan Handley 
28b4315306SDan Handley #define ARM_CACHE_WRITEBACK_SHIFT	6
29b4315306SDan Handley 
3038dce70fSSoby Mathew /*
3138dce70fSSoby Mathew  * Macros mapping the MPIDR Affinity levels to ARM Platform Power levels. The
3238dce70fSSoby Mathew  * power levels have a 1:1 mapping with the MPIDR affinity levels.
3338dce70fSSoby Mathew  */
3438dce70fSSoby Mathew #define ARM_PWR_LVL0		MPIDR_AFFLVL0
3538dce70fSSoby Mathew #define ARM_PWR_LVL1		MPIDR_AFFLVL1
365f3a6030SSoby Mathew #define ARM_PWR_LVL2		MPIDR_AFFLVL2
3738dce70fSSoby Mathew 
3838dce70fSSoby Mathew /*
3938dce70fSSoby Mathew  *  Macros for local power states in ARM platforms encoded by State-ID field
4038dce70fSSoby Mathew  *  within the power-state parameter.
4138dce70fSSoby Mathew  */
4238dce70fSSoby Mathew /* Local power state for power domains in Run state. */
431083b2b3SAntonio Nino Diaz #define ARM_LOCAL_STATE_RUN	U(0)
4438dce70fSSoby Mathew /* Local power state for retention. Valid only for CPU power domains */
451083b2b3SAntonio Nino Diaz #define ARM_LOCAL_STATE_RET	U(1)
4638dce70fSSoby Mathew /* Local power state for OFF/power-down. Valid for CPU and cluster power
4738dce70fSSoby Mathew    domains */
481083b2b3SAntonio Nino Diaz #define ARM_LOCAL_STATE_OFF	U(2)
4938dce70fSSoby Mathew 
50b4315306SDan Handley /* Memory location options for TSP */
51b4315306SDan Handley #define ARM_TRUSTED_SRAM_ID		0
52b4315306SDan Handley #define ARM_TRUSTED_DRAM_ID		1
53b4315306SDan Handley #define ARM_DRAM_ID			2
54b4315306SDan Handley 
55b4315306SDan Handley /* The first 4KB of Trusted SRAM are used as shared memory */
56b4315306SDan Handley #define ARM_TRUSTED_SRAM_BASE		0x04000000
57b4315306SDan Handley #define ARM_SHARED_RAM_BASE		ARM_TRUSTED_SRAM_BASE
58b4315306SDan Handley #define ARM_SHARED_RAM_SIZE		0x00001000	/* 4 KB */
59b4315306SDan Handley 
60b4315306SDan Handley /* The remaining Trusted SRAM is used to load the BL images */
61b4315306SDan Handley #define ARM_BL_RAM_BASE			(ARM_SHARED_RAM_BASE +	\
62b4315306SDan Handley 					 ARM_SHARED_RAM_SIZE)
63b4315306SDan Handley #define ARM_BL_RAM_SIZE			(PLAT_ARM_TRUSTED_SRAM_SIZE -	\
64b4315306SDan Handley 					 ARM_SHARED_RAM_SIZE)
65b4315306SDan Handley 
66b4315306SDan Handley /*
67b4315306SDan Handley  * The top 16MB of DRAM1 is configured as secure access only using the TZC
68b4315306SDan Handley  *   - SCP TZC DRAM: If present, DRAM reserved for SCP use
69b4315306SDan Handley  *   - AP TZC DRAM: The remaining TZC secured DRAM reserved for AP use
70b4315306SDan Handley  */
719edac047SDavid Cunado #define ARM_TZC_DRAM1_SIZE		ULL(0x01000000)
72b4315306SDan Handley 
73b4315306SDan Handley #define ARM_SCP_TZC_DRAM1_BASE		(ARM_DRAM1_BASE +		\
74b4315306SDan Handley 					 ARM_DRAM1_SIZE -		\
75b4315306SDan Handley 					 ARM_SCP_TZC_DRAM1_SIZE)
76b4315306SDan Handley #define ARM_SCP_TZC_DRAM1_SIZE		PLAT_ARM_SCP_TZC_DRAM1_SIZE
77b4315306SDan Handley #define ARM_SCP_TZC_DRAM1_END		(ARM_SCP_TZC_DRAM1_BASE +	\
78b4315306SDan Handley 					 ARM_SCP_TZC_DRAM1_SIZE - 1)
79b4315306SDan Handley 
80a22dffc6SSoby Mathew /*
81a22dffc6SSoby Mathew  * Define a 2MB region within the TZC secured DRAM for use by EL3 runtime
82a22dffc6SSoby Mathew  * firmware. This region is meant to be NOLOAD and will not be zero
83a22dffc6SSoby Mathew  * initialized. Data sections with the attribute `arm_el3_tzc_dram` will be
84a22dffc6SSoby Mathew  * placed here.
85a22dffc6SSoby Mathew  */
86a22dffc6SSoby Mathew #define ARM_EL3_TZC_DRAM1_BASE		(ARM_SCP_TZC_DRAM1_BASE - ARM_EL3_TZC_DRAM1_SIZE)
87a22dffc6SSoby Mathew #define ARM_EL3_TZC_DRAM1_SIZE		ULL(0x00200000) /* 2 MB */
88a22dffc6SSoby Mathew #define ARM_EL3_TZC_DRAM1_END		(ARM_EL3_TZC_DRAM1_BASE +	\
89a22dffc6SSoby Mathew 					ARM_EL3_TZC_DRAM1_SIZE - 1)
90a22dffc6SSoby Mathew 
91b4315306SDan Handley #define ARM_AP_TZC_DRAM1_BASE		(ARM_DRAM1_BASE +		\
92b4315306SDan Handley 					 ARM_DRAM1_SIZE -		\
93b4315306SDan Handley 					 ARM_TZC_DRAM1_SIZE)
94b4315306SDan Handley #define ARM_AP_TZC_DRAM1_SIZE		(ARM_TZC_DRAM1_SIZE -		\
95a22dffc6SSoby Mathew 					 (ARM_SCP_TZC_DRAM1_SIZE +	\
96a22dffc6SSoby Mathew 					 ARM_EL3_TZC_DRAM1_SIZE))
97b4315306SDan Handley #define ARM_AP_TZC_DRAM1_END		(ARM_AP_TZC_DRAM1_BASE +	\
98b4315306SDan Handley 					 ARM_AP_TZC_DRAM1_SIZE - 1)
99b4315306SDan Handley 
100e60f2af9SSoby Mathew /* Define the Access permissions for Secure peripherals to NS_DRAM */
101e60f2af9SSoby Mathew #if ARM_CRYPTOCELL_INTEG
102e60f2af9SSoby Mathew /*
103e60f2af9SSoby Mathew  * Allow Secure peripheral to read NS DRAM when integrated with CryptoCell.
104e60f2af9SSoby Mathew  * This is required by CryptoCell to authenticate BL33 which is loaded
105e60f2af9SSoby Mathew  * into the Non Secure DDR.
106e60f2af9SSoby Mathew  */
107e60f2af9SSoby Mathew #define ARM_TZC_NS_DRAM_S_ACCESS	TZC_REGION_S_RD
108e60f2af9SSoby Mathew #else
109e60f2af9SSoby Mathew #define ARM_TZC_NS_DRAM_S_ACCESS	TZC_REGION_S_NONE
110e60f2af9SSoby Mathew #endif
111e60f2af9SSoby Mathew 
11254661cd2SSummer Qin #ifdef SPD_opteed
11354661cd2SSummer Qin /*
11404f72baeSJens Wiklander  * BL2 needs to map 4MB at the end of TZC_DRAM1 in order to
11504f72baeSJens Wiklander  * load/authenticate the trusted os extra image. The first 512KB of
11604f72baeSJens Wiklander  * TZC_DRAM1 are reserved for trusted os (OPTEE). The extra image loading
11704f72baeSJens Wiklander  * for OPTEE is paged image which only include the paging part using
11804f72baeSJens Wiklander  * virtual memory but without "init" data. OPTEE will copy the "init" data
11904f72baeSJens Wiklander  * (from pager image) to the first 512KB of TZC_DRAM, and then copy the
12004f72baeSJens Wiklander  * extra image behind the "init" data.
12154661cd2SSummer Qin  */
12204f72baeSJens Wiklander #define ARM_OPTEE_PAGEABLE_LOAD_BASE	(ARM_AP_TZC_DRAM1_BASE + \
12304f72baeSJens Wiklander 					 ARM_AP_TZC_DRAM1_SIZE - \
12404f72baeSJens Wiklander 					 ARM_OPTEE_PAGEABLE_LOAD_SIZE)
12504f72baeSJens Wiklander #define ARM_OPTEE_PAGEABLE_LOAD_SIZE	0x400000
12654661cd2SSummer Qin #define ARM_OPTEE_PAGEABLE_LOAD_MEM	MAP_REGION_FLAT(		\
12754661cd2SSummer Qin 					ARM_OPTEE_PAGEABLE_LOAD_BASE,	\
12854661cd2SSummer Qin 					ARM_OPTEE_PAGEABLE_LOAD_SIZE,	\
12954661cd2SSummer Qin 					MT_MEMORY | MT_RW | MT_SECURE)
130b3ba6fdaSSoby Mathew 
131b3ba6fdaSSoby Mathew /*
132b3ba6fdaSSoby Mathew  * Map the memory for the OP-TEE core (also known as OP-TEE pager when paging
133b3ba6fdaSSoby Mathew  * support is enabled).
134b3ba6fdaSSoby Mathew  */
135b3ba6fdaSSoby Mathew #define ARM_MAP_OPTEE_CORE_MEM		MAP_REGION_FLAT(		\
136b3ba6fdaSSoby Mathew 						BL32_BASE,		\
137b3ba6fdaSSoby Mathew 						BL32_LIMIT - BL32_BASE,	\
138b3ba6fdaSSoby Mathew 						MT_MEMORY | MT_RW | MT_SECURE)
13954661cd2SSummer Qin #endif /* SPD_opteed */
140b4315306SDan Handley 
141b4315306SDan Handley #define ARM_NS_DRAM1_BASE		ARM_DRAM1_BASE
142b4315306SDan Handley #define ARM_NS_DRAM1_SIZE		(ARM_DRAM1_SIZE -		\
143b4315306SDan Handley 					 ARM_TZC_DRAM1_SIZE)
144b4315306SDan Handley #define ARM_NS_DRAM1_END		(ARM_NS_DRAM1_BASE +		\
145b4315306SDan Handley 					 ARM_NS_DRAM1_SIZE - 1)
146b4315306SDan Handley 
1479edac047SDavid Cunado #define ARM_DRAM1_BASE			ULL(0x80000000)
1489edac047SDavid Cunado #define ARM_DRAM1_SIZE			ULL(0x80000000)
149b4315306SDan Handley #define ARM_DRAM1_END			(ARM_DRAM1_BASE +		\
150b4315306SDan Handley 					 ARM_DRAM1_SIZE - 1)
151b4315306SDan Handley 
1529edac047SDavid Cunado #define ARM_DRAM2_BASE			ULL(0x880000000)
153b4315306SDan Handley #define ARM_DRAM2_SIZE			PLAT_ARM_DRAM2_SIZE
154b4315306SDan Handley #define ARM_DRAM2_END			(ARM_DRAM2_BASE +		\
155b4315306SDan Handley 					 ARM_DRAM2_SIZE - 1)
156b4315306SDan Handley 
157b4315306SDan Handley #define ARM_IRQ_SEC_PHY_TIMER		29
158b4315306SDan Handley 
159b4315306SDan Handley #define ARM_IRQ_SEC_SGI_0		8
160b4315306SDan Handley #define ARM_IRQ_SEC_SGI_1		9
161b4315306SDan Handley #define ARM_IRQ_SEC_SGI_2		10
162b4315306SDan Handley #define ARM_IRQ_SEC_SGI_3		11
163b4315306SDan Handley #define ARM_IRQ_SEC_SGI_4		12
164b4315306SDan Handley #define ARM_IRQ_SEC_SGI_5		13
165b4315306SDan Handley #define ARM_IRQ_SEC_SGI_6		14
166b4315306SDan Handley #define ARM_IRQ_SEC_SGI_7		15
167b4315306SDan Handley 
16827573c59SAchin Gupta /*
169b2c363b1SJeenu Viswambharan  * Define a list of Group 1 Secure and Group 0 interrupt properties as per GICv3
170b2c363b1SJeenu Viswambharan  * terminology. On a GICv2 system or mode, the lists will be merged and treated
171b2c363b1SJeenu Viswambharan  * as Group 0 interrupts.
172b2c363b1SJeenu Viswambharan  */
173b2c363b1SJeenu Viswambharan #define ARM_G1S_IRQ_PROPS(grp) \
174fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_PHY_TIMER, GIC_HIGHEST_SEC_PRIORITY, (grp), \
175b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_LEVEL), \
176fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_1, GIC_HIGHEST_SEC_PRIORITY, (grp), \
177b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_EDGE), \
178fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_2, GIC_HIGHEST_SEC_PRIORITY, (grp), \
179b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_EDGE), \
180fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_3, GIC_HIGHEST_SEC_PRIORITY, (grp), \
181b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_EDGE), \
182fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_4, GIC_HIGHEST_SEC_PRIORITY, (grp), \
183b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_EDGE), \
184fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_5, GIC_HIGHEST_SEC_PRIORITY, (grp), \
185b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_EDGE), \
186fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_7, GIC_HIGHEST_SEC_PRIORITY, (grp), \
187b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_EDGE)
188b2c363b1SJeenu Viswambharan 
189b2c363b1SJeenu Viswambharan #define ARM_G0_IRQ_PROPS(grp) \
190fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_0, PLAT_SDEI_NORMAL_PRI, (grp), \
191b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_EDGE), \
192fe747d57SAntonio Nino Diaz 	INTR_PROP_DESC(ARM_IRQ_SEC_SGI_6, GIC_HIGHEST_SEC_PRIORITY, (grp), \
193b2c363b1SJeenu Viswambharan 			GIC_INTR_CFG_EDGE)
194b2c363b1SJeenu Viswambharan 
195b4315306SDan Handley #define ARM_MAP_SHARED_RAM		MAP_REGION_FLAT(		\
196b4315306SDan Handley 						ARM_SHARED_RAM_BASE,	\
197b4315306SDan Handley 						ARM_SHARED_RAM_SIZE,	\
19874eb26e4SJuan Castillo 						MT_DEVICE | MT_RW | MT_SECURE)
199b4315306SDan Handley 
200b4315306SDan Handley #define ARM_MAP_NS_DRAM1		MAP_REGION_FLAT(		\
201b4315306SDan Handley 						ARM_NS_DRAM1_BASE,	\
202b4315306SDan Handley 						ARM_NS_DRAM1_SIZE,	\
203b4315306SDan Handley 						MT_MEMORY | MT_RW | MT_NS)
204b4315306SDan Handley 
205b09ba056SRoberto Vargas #define ARM_MAP_DRAM2			MAP_REGION_FLAT(		\
206b09ba056SRoberto Vargas 						ARM_DRAM2_BASE,		\
207b09ba056SRoberto Vargas 						ARM_DRAM2_SIZE,		\
208b09ba056SRoberto Vargas 						MT_MEMORY | MT_RW | MT_NS)
2093eb2d672SSandrine Bailleux #ifdef SPD_tspd
210b09ba056SRoberto Vargas 
211b4315306SDan Handley #define ARM_MAP_TSP_SEC_MEM		MAP_REGION_FLAT(		\
212b4315306SDan Handley 						TSP_SEC_MEM_BASE,	\
213b4315306SDan Handley 						TSP_SEC_MEM_SIZE,	\
214b4315306SDan Handley 						MT_MEMORY | MT_RW | MT_SECURE)
2153eb2d672SSandrine Bailleux #endif
216b4315306SDan Handley 
2174518dd9aSDavid Wang #if ARM_BL31_IN_DRAM
2184518dd9aSDavid Wang #define ARM_MAP_BL31_SEC_DRAM		MAP_REGION_FLAT(		\
2194518dd9aSDavid Wang 						BL31_BASE,		\
2204518dd9aSDavid Wang 						PLAT_ARM_MAX_BL31_SIZE,	\
2214518dd9aSDavid Wang 						MT_MEMORY | MT_RW | MT_SECURE)
2224518dd9aSDavid Wang #endif
223b4315306SDan Handley 
224a22dffc6SSoby Mathew #define ARM_MAP_EL3_TZC_DRAM		MAP_REGION_FLAT(			\
225a22dffc6SSoby Mathew 						ARM_EL3_TZC_DRAM1_BASE,	\
226a22dffc6SSoby Mathew 						ARM_EL3_TZC_DRAM1_SIZE,	\
227a22dffc6SSoby Mathew 						MT_MEMORY | MT_RW | MT_SECURE)
228a22dffc6SSoby Mathew 
2292ecaafd2SDaniel Boulby /*
230ba597da7SJohn Tsichritzis  * Mapping for the BL1 RW region. This mapping is needed by BL2 in order to
231ba597da7SJohn Tsichritzis  * share the Mbed TLS heap. Since the heap is allocated inside BL1, it resides
232ba597da7SJohn Tsichritzis  * in the BL1 RW region. Hence, BL2 needs access to the BL1 RW region in order
233ba597da7SJohn Tsichritzis  * to be able to access the heap.
234ba597da7SJohn Tsichritzis  */
235ba597da7SJohn Tsichritzis #define ARM_MAP_BL1_RW		MAP_REGION_FLAT(	\
236ba597da7SJohn Tsichritzis 					BL1_RW_BASE,	\
237ba597da7SJohn Tsichritzis 					BL1_RW_LIMIT - BL1_RW_BASE, \
238ba597da7SJohn Tsichritzis 					MT_MEMORY | MT_RW | MT_SECURE)
239ba597da7SJohn Tsichritzis 
240ba597da7SJohn Tsichritzis /*
2412ecaafd2SDaniel Boulby  * If SEPARATE_CODE_AND_RODATA=1 we define a region for each section
2422ecaafd2SDaniel Boulby  * otherwise one region is defined containing both.
2432ecaafd2SDaniel Boulby  */
244d323af9eSDaniel Boulby #if SEPARATE_CODE_AND_RODATA
2452ecaafd2SDaniel Boulby #define ARM_MAP_BL_RO			MAP_REGION_FLAT(			\
246d323af9eSDaniel Boulby 						BL_CODE_BASE,			\
247d323af9eSDaniel Boulby 						BL_CODE_END - BL_CODE_BASE,	\
2482ecaafd2SDaniel Boulby 						MT_CODE | MT_SECURE),		\
2492ecaafd2SDaniel Boulby 					MAP_REGION_FLAT(			\
250d323af9eSDaniel Boulby 						BL_RO_DATA_BASE,		\
251d323af9eSDaniel Boulby 						BL_RO_DATA_END			\
252d323af9eSDaniel Boulby 							- BL_RO_DATA_BASE,	\
253d323af9eSDaniel Boulby 						MT_RO_DATA | MT_SECURE)
2542ecaafd2SDaniel Boulby #else
2552ecaafd2SDaniel Boulby #define ARM_MAP_BL_RO			MAP_REGION_FLAT(			\
2562ecaafd2SDaniel Boulby 						BL_CODE_BASE,			\
2572ecaafd2SDaniel Boulby 						BL_CODE_END - BL_CODE_BASE,	\
2582ecaafd2SDaniel Boulby 						MT_CODE | MT_SECURE)
259d323af9eSDaniel Boulby #endif
260d323af9eSDaniel Boulby #if USE_COHERENT_MEM
261d323af9eSDaniel Boulby #define ARM_MAP_BL_COHERENT_RAM		MAP_REGION_FLAT(			\
262d323af9eSDaniel Boulby 						BL_COHERENT_RAM_BASE,		\
263d323af9eSDaniel Boulby 						BL_COHERENT_RAM_END		\
264d323af9eSDaniel Boulby 							- BL_COHERENT_RAM_BASE, \
265d323af9eSDaniel Boulby 						MT_DEVICE | MT_RW | MT_SECURE)
266d323af9eSDaniel Boulby #endif
2671eb735d7SRoberto Vargas #if USE_ROMLIB
2681eb735d7SRoberto Vargas #define ARM_MAP_ROMLIB_CODE		MAP_REGION_FLAT(			\
2691eb735d7SRoberto Vargas 						ROMLIB_RO_BASE,			\
2701eb735d7SRoberto Vargas 						ROMLIB_RO_LIMIT	- ROMLIB_RO_BASE,\
2711eb735d7SRoberto Vargas 						MT_CODE | MT_SECURE)
2721eb735d7SRoberto Vargas 
2731eb735d7SRoberto Vargas #define ARM_MAP_ROMLIB_DATA		MAP_REGION_FLAT(			\
2741eb735d7SRoberto Vargas 						ROMLIB_RW_BASE,			\
2751eb735d7SRoberto Vargas 						ROMLIB_RW_END	- ROMLIB_RW_BASE,\
2761eb735d7SRoberto Vargas 						MT_MEMORY | MT_RW | MT_SECURE)
2771eb735d7SRoberto Vargas #endif
278d323af9eSDaniel Boulby 
279b4315306SDan Handley /*
280*0f58d4f2SAntonio Nino Diaz  * Map mem_protect flash region with read and write permissions
281*0f58d4f2SAntonio Nino Diaz  */
282*0f58d4f2SAntonio Nino Diaz #define ARM_V2M_MAP_MEM_PROTECT		MAP_REGION_FLAT(PLAT_ARM_MEM_PROT_ADDR,	\
283*0f58d4f2SAntonio Nino Diaz 						V2M_FLASH_BLOCK_SIZE,		\
284*0f58d4f2SAntonio Nino Diaz 						MT_DEVICE | MT_RW | MT_SECURE)
285*0f58d4f2SAntonio Nino Diaz 
286*0f58d4f2SAntonio Nino Diaz /*
2872ecaafd2SDaniel Boulby  * The max number of regions like RO(code), coherent and data required by
288b4315306SDan Handley  * different BL stages which need to be mapped in the MMU.
289b4315306SDan Handley  */
290cb4adb0dSDaniel Boulby #define ARM_BL_REGIONS			5
291b4315306SDan Handley 
292b4315306SDan Handley #define MAX_MMAP_REGIONS		(PLAT_ARM_MMAP_ENTRIES +	\
293b4315306SDan Handley 					 ARM_BL_REGIONS)
294b4315306SDan Handley 
295b4315306SDan Handley /* Memory mapped Generic timer interfaces  */
296b4315306SDan Handley #define ARM_SYS_CNTCTL_BASE		0x2a430000
297b4315306SDan Handley #define ARM_SYS_CNTREAD_BASE		0x2a800000
298b4315306SDan Handley #define ARM_SYS_TIMCTL_BASE		0x2a810000
299342d6220SSoby Mathew #define ARM_SYS_CNT_BASE_S		0x2a820000
300342d6220SSoby Mathew #define ARM_SYS_CNT_BASE_NS		0x2a830000
301b4315306SDan Handley 
302b4315306SDan Handley #define ARM_CONSOLE_BAUDRATE		115200
303b4315306SDan Handley 
3047b4c1405SJuan Castillo /* Trusted Watchdog constants */
3057b4c1405SJuan Castillo #define ARM_SP805_TWDG_BASE		0x2a490000
3067b4c1405SJuan Castillo #define ARM_SP805_TWDG_CLK_HZ		32768
3077b4c1405SJuan Castillo /* The TBBR document specifies a watchdog timeout of 256 seconds. SP805
3087b4c1405SJuan Castillo  * asserts reset after two consecutive countdowns (2 x 128 = 256 sec) */
3097b4c1405SJuan Castillo #define ARM_TWDG_TIMEOUT_SEC		128
3107b4c1405SJuan Castillo #define ARM_TWDG_LOAD_VAL		(ARM_SP805_TWDG_CLK_HZ * 	\
3117b4c1405SJuan Castillo 					 ARM_TWDG_TIMEOUT_SEC)
3127b4c1405SJuan Castillo 
313b4315306SDan Handley /******************************************************************************
314b4315306SDan Handley  * Required platform porting definitions common to all ARM standard platforms
315b4315306SDan Handley  *****************************************************************************/
316b4315306SDan Handley 
317b09ba056SRoberto Vargas /*
318b09ba056SRoberto Vargas  * We need to access DRAM2 from BL2 for PSCI_MEM_PROTECT for
319b09ba056SRoberto Vargas  * AArch64 builds
320b09ba056SRoberto Vargas  */
321b09ba056SRoberto Vargas #ifdef AARCH64
3225724481fSDavid Cunado #define PLAT_PHY_ADDR_SPACE_SIZE			(1ULL << 36)
3235724481fSDavid Cunado #define PLAT_VIRT_ADDR_SPACE_SIZE			(1ULL << 36)
324b09ba056SRoberto Vargas #else
3255724481fSDavid Cunado #define PLAT_PHY_ADDR_SPACE_SIZE			(1ULL << 32)
3265724481fSDavid Cunado #define PLAT_VIRT_ADDR_SPACE_SIZE			(1ULL << 32)
327b09ba056SRoberto Vargas #endif
328b09ba056SRoberto Vargas 
329b4315306SDan Handley 
33038dce70fSSoby Mathew /*
33138dce70fSSoby Mathew  * This macro defines the deepest retention state possible. A higher state
33238dce70fSSoby Mathew  * id will represent an invalid or a power down state.
33338dce70fSSoby Mathew  */
33438dce70fSSoby Mathew #define PLAT_MAX_RET_STATE		ARM_LOCAL_STATE_RET
33538dce70fSSoby Mathew 
33638dce70fSSoby Mathew /*
33738dce70fSSoby Mathew  * This macro defines the deepest power down states possible. Any state ID
33838dce70fSSoby Mathew  * higher than this is invalid.
33938dce70fSSoby Mathew  */
34038dce70fSSoby Mathew #define PLAT_MAX_OFF_STATE		ARM_LOCAL_STATE_OFF
34138dce70fSSoby Mathew 
342b4315306SDan Handley /*
343b4315306SDan Handley  * Some data must be aligned on the biggest cache line size in the platform.
344b4315306SDan Handley  * This is known only to the platform as it might have a combination of
345b4315306SDan Handley  * integrated and external caches.
346b4315306SDan Handley  */
347b4315306SDan Handley #define CACHE_WRITEBACK_GRANULE		(1 << ARM_CACHE_WRITEBACK_SHIFT)
348b4315306SDan Handley 
349c228956aSSoby Mathew /*
350c228956aSSoby Mathew  * To enable TB_FW_CONFIG to be loaded by BL1, define the corresponding base
351c228956aSSoby Mathew  * and limit. Leave enough space of BL2 meminfo.
352c228956aSSoby Mathew  */
353c228956aSSoby Mathew #define ARM_TB_FW_CONFIG_BASE		ARM_BL_RAM_BASE + sizeof(meminfo_t)
354c099cd39SSoby Mathew #define ARM_TB_FW_CONFIG_LIMIT		ARM_BL_RAM_BASE + PAGE_SIZE
355b4315306SDan Handley 
356b4315306SDan Handley /*******************************************************************************
357b4315306SDan Handley  * BL1 specific defines.
358b4315306SDan Handley  * BL1 RW data is relocated from ROM to RAM at runtime so we need 2 sets of
359b4315306SDan Handley  * addresses.
360b4315306SDan Handley  ******************************************************************************/
361b4315306SDan Handley #define BL1_RO_BASE			PLAT_ARM_TRUSTED_ROM_BASE
362b4315306SDan Handley #define BL1_RO_LIMIT			(PLAT_ARM_TRUSTED_ROM_BASE	\
3631eb735d7SRoberto Vargas 					 + (PLAT_ARM_TRUSTED_ROM_SIZE - \
3641eb735d7SRoberto Vargas 					    PLAT_ARM_MAX_ROMLIB_RO_SIZE))
365b4315306SDan Handley /*
366ecf70f7bSVikram Kanigiri  * Put BL1 RW at the top of the Trusted SRAM.
367b4315306SDan Handley  */
368b4315306SDan Handley #define BL1_RW_BASE			(ARM_BL_RAM_BASE +		\
369b4315306SDan Handley 						ARM_BL_RAM_SIZE -	\
3701eb735d7SRoberto Vargas 						(PLAT_ARM_MAX_BL1_RW_SIZE +\
3711eb735d7SRoberto Vargas 						 PLAT_ARM_MAX_ROMLIB_RW_SIZE))
3721eb735d7SRoberto Vargas #define BL1_RW_LIMIT			(ARM_BL_RAM_BASE + 		\
3731eb735d7SRoberto Vargas 					    (ARM_BL_RAM_SIZE - PLAT_ARM_MAX_ROMLIB_RW_SIZE))
3741eb735d7SRoberto Vargas 
3751eb735d7SRoberto Vargas #define ROMLIB_RO_BASE			BL1_RO_LIMIT
3761eb735d7SRoberto Vargas #define ROMLIB_RO_LIMIT			(PLAT_ARM_TRUSTED_ROM_BASE + PLAT_ARM_TRUSTED_ROM_SIZE)
3771eb735d7SRoberto Vargas 
3781eb735d7SRoberto Vargas #define ROMLIB_RW_BASE			(BL1_RW_BASE + PLAT_ARM_MAX_BL1_RW_SIZE)
3791eb735d7SRoberto Vargas #define ROMLIB_RW_END			(ROMLIB_RW_BASE + PLAT_ARM_MAX_ROMLIB_RW_SIZE)
380b4315306SDan Handley 
381b4315306SDan Handley /*******************************************************************************
382b4315306SDan Handley  * BL2 specific defines.
383b4315306SDan Handley  ******************************************************************************/
384c099cd39SSoby Mathew #if BL2_AT_EL3
38542be6fc5SDimitris Papastamos /* Put BL2 towards the middle of the Trusted SRAM */
386c099cd39SSoby Mathew #define BL2_BASE			(ARM_TRUSTED_SRAM_BASE + \
38742be6fc5SDimitris Papastamos 						(PLAT_ARM_TRUSTED_SRAM_SIZE >> 1) + 0x2000)
388c099cd39SSoby Mathew #define BL2_LIMIT			(ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
389c099cd39SSoby Mathew 
390c099cd39SSoby Mathew #else
3914518dd9aSDavid Wang /*
3924518dd9aSDavid Wang  * Put BL2 just below BL1.
3934518dd9aSDavid Wang  */
3944518dd9aSDavid Wang #define BL2_BASE			(BL1_RW_BASE - PLAT_ARM_MAX_BL2_SIZE)
3954518dd9aSDavid Wang #define BL2_LIMIT			BL1_RW_BASE
3964518dd9aSDavid Wang #endif
397b4315306SDan Handley 
398b4315306SDan Handley /*******************************************************************************
399d178637dSJuan Castillo  * BL31 specific defines.
400b4315306SDan Handley  ******************************************************************************/
4014518dd9aSDavid Wang #if ARM_BL31_IN_DRAM
4024518dd9aSDavid Wang /*
4034518dd9aSDavid Wang  * Put BL31 at the bottom of TZC secured DRAM
4044518dd9aSDavid Wang  */
4054518dd9aSDavid Wang #define BL31_BASE			ARM_AP_TZC_DRAM1_BASE
4064518dd9aSDavid Wang #define BL31_LIMIT			(ARM_AP_TZC_DRAM1_BASE +	\
4074518dd9aSDavid Wang 						PLAT_ARM_MAX_BL31_SIZE)
408fd5763eaSQixiang Xu #elif (RESET_TO_BL31)
409fd5763eaSQixiang Xu /*
410fd5763eaSQixiang Xu  * Put BL31_BASE in the middle of the Trusted SRAM.
411fd5763eaSQixiang Xu  */
412fd5763eaSQixiang Xu #define BL31_BASE			(ARM_TRUSTED_SRAM_BASE + \
413fd5763eaSQixiang Xu 						(PLAT_ARM_TRUSTED_SRAM_SIZE >> 1))
414fd5763eaSQixiang Xu #define BL31_LIMIT			(ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
4154518dd9aSDavid Wang #else
416c099cd39SSoby Mathew /* Put BL31 below BL2 in the Trusted SRAM.*/
417c099cd39SSoby Mathew #define BL31_BASE			((ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)\
418c099cd39SSoby Mathew 						- PLAT_ARM_MAX_BL31_SIZE)
419c099cd39SSoby Mathew #define BL31_PROGBITS_LIMIT		BL2_BASE
42042be6fc5SDimitris Papastamos /*
42142be6fc5SDimitris Papastamos  * For BL2_AT_EL3 make sure the BL31 can grow up until BL2_BASE. This is
42242be6fc5SDimitris Papastamos  * because in the BL2_AT_EL3 configuration, BL2 is always resident.
42342be6fc5SDimitris Papastamos  */
42442be6fc5SDimitris Papastamos #if BL2_AT_EL3
42542be6fc5SDimitris Papastamos #define BL31_LIMIT			BL2_BASE
42642be6fc5SDimitris Papastamos #else
427b4315306SDan Handley #define BL31_LIMIT			(ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
4284518dd9aSDavid Wang #endif
42942be6fc5SDimitris Papastamos #endif
430b4315306SDan Handley 
4315744e874SSoby Mathew #if defined(AARCH32) || JUNO_AARCH32_EL3_RUNTIME
432b4315306SDan Handley /*******************************************************************************
4335744e874SSoby Mathew  * BL32 specific defines for EL3 runtime in AArch32 mode
4345744e874SSoby Mathew  ******************************************************************************/
4355744e874SSoby Mathew # if RESET_TO_SP_MIN && !JUNO_AARCH32_EL3_RUNTIME
436c099cd39SSoby Mathew /*
437c099cd39SSoby Mathew  * SP_MIN is the only BL image in SRAM. Allocate the whole of SRAM (excluding
438c099cd39SSoby Mathew  * the page reserved for fw_configs) to BL32
439c099cd39SSoby Mathew  */
440c099cd39SSoby Mathew #  define BL32_BASE			ARM_TB_FW_CONFIG_LIMIT
4415744e874SSoby Mathew #  define BL32_LIMIT			(ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
4425744e874SSoby Mathew # else
443c099cd39SSoby Mathew /* Put BL32 below BL2 in the Trusted SRAM.*/
444c099cd39SSoby Mathew #  define BL32_BASE			((ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)\
445c099cd39SSoby Mathew 						- PLAT_ARM_MAX_BL32_SIZE)
446c099cd39SSoby Mathew #  define BL32_PROGBITS_LIMIT		BL2_BASE
4475744e874SSoby Mathew #  define BL32_LIMIT			(ARM_BL_RAM_BASE + ARM_BL_RAM_SIZE)
4485744e874SSoby Mathew # endif /* RESET_TO_SP_MIN && !JUNO_AARCH32_EL3_RUNTIME */
4495744e874SSoby Mathew 
4505744e874SSoby Mathew #else
4515744e874SSoby Mathew /*******************************************************************************
4525744e874SSoby Mathew  * BL32 specific defines for EL3 runtime in AArch64 mode
453b4315306SDan Handley  ******************************************************************************/
454b4315306SDan Handley /*
455b4315306SDan Handley  * On ARM standard platforms, the TSP can execute from Trusted SRAM,
456b4315306SDan Handley  * Trusted DRAM (if available) or the DRAM region secured by the TrustZone
457b4315306SDan Handley  * controller.
458b4315306SDan Handley  */
459e29efeb1SAntonio Nino Diaz # if ENABLE_SPM
460e29efeb1SAntonio Nino Diaz #  define TSP_SEC_MEM_BASE		(ARM_AP_TZC_DRAM1_BASE + ULL(0x200000))
461e29efeb1SAntonio Nino Diaz #  define TSP_SEC_MEM_SIZE		(ARM_AP_TZC_DRAM1_SIZE - ULL(0x200000))
462e29efeb1SAntonio Nino Diaz #  define BL32_BASE			(ARM_AP_TZC_DRAM1_BASE + ULL(0x200000))
463e29efeb1SAntonio Nino Diaz #  define BL32_LIMIT			(ARM_AP_TZC_DRAM1_BASE +	\
464e29efeb1SAntonio Nino Diaz 						ARM_AP_TZC_DRAM1_SIZE)
465e29efeb1SAntonio Nino Diaz # elif ARM_BL31_IN_DRAM
4664518dd9aSDavid Wang #  define TSP_SEC_MEM_BASE		(ARM_AP_TZC_DRAM1_BASE +	\
4674518dd9aSDavid Wang 						PLAT_ARM_MAX_BL31_SIZE)
4684518dd9aSDavid Wang #  define TSP_SEC_MEM_SIZE		(ARM_AP_TZC_DRAM1_SIZE -	\
4694518dd9aSDavid Wang 						PLAT_ARM_MAX_BL31_SIZE)
4704518dd9aSDavid Wang #  define BL32_BASE			(ARM_AP_TZC_DRAM1_BASE +	\
4714518dd9aSDavid Wang 						PLAT_ARM_MAX_BL31_SIZE)
4724518dd9aSDavid Wang #  define BL32_LIMIT			(ARM_AP_TZC_DRAM1_BASE +	\
4734518dd9aSDavid Wang 						ARM_AP_TZC_DRAM1_SIZE)
4744518dd9aSDavid Wang # elif ARM_TSP_RAM_LOCATION_ID == ARM_TRUSTED_SRAM_ID
475b4315306SDan Handley #  define TSP_SEC_MEM_BASE		ARM_BL_RAM_BASE
476b4315306SDan Handley #  define TSP_SEC_MEM_SIZE		ARM_BL_RAM_SIZE
477c099cd39SSoby Mathew #  define TSP_PROGBITS_LIMIT		BL31_BASE
478c099cd39SSoby Mathew #  define BL32_BASE			ARM_TB_FW_CONFIG_LIMIT
479b4315306SDan Handley #  define BL32_LIMIT			BL31_BASE
480b4315306SDan Handley # elif ARM_TSP_RAM_LOCATION_ID == ARM_TRUSTED_DRAM_ID
481b4315306SDan Handley #  define TSP_SEC_MEM_BASE		PLAT_ARM_TRUSTED_DRAM_BASE
482b4315306SDan Handley #  define TSP_SEC_MEM_SIZE		PLAT_ARM_TRUSTED_DRAM_SIZE
483b4315306SDan Handley #  define BL32_BASE			PLAT_ARM_TRUSTED_DRAM_BASE
484b4315306SDan Handley #  define BL32_LIMIT			(PLAT_ARM_TRUSTED_DRAM_BASE	\
485b4315306SDan Handley 						+ (1 << 21))
486b4315306SDan Handley # elif ARM_TSP_RAM_LOCATION_ID == ARM_DRAM_ID
487b4315306SDan Handley #  define TSP_SEC_MEM_BASE		ARM_AP_TZC_DRAM1_BASE
488b4315306SDan Handley #  define TSP_SEC_MEM_SIZE		ARM_AP_TZC_DRAM1_SIZE
489b4315306SDan Handley #  define BL32_BASE			ARM_AP_TZC_DRAM1_BASE
490b4315306SDan Handley #  define BL32_LIMIT			(ARM_AP_TZC_DRAM1_BASE +	\
491b4315306SDan Handley 						ARM_AP_TZC_DRAM1_SIZE)
492b4315306SDan Handley # else
493b4315306SDan Handley #  error "Unsupported ARM_TSP_RAM_LOCATION_ID value"
494b4315306SDan Handley # endif
4955744e874SSoby Mathew #endif /* AARCH32 || JUNO_AARCH32_EL3_RUNTIME */
496b4315306SDan Handley 
497e29efeb1SAntonio Nino Diaz /*
498e29efeb1SAntonio Nino Diaz  * BL32 is mandatory in AArch32. In AArch64, undefine BL32_BASE if there is no
499e29efeb1SAntonio Nino Diaz  * SPD and no SPM, as they are the only ones that can be used as BL32.
500e29efeb1SAntonio Nino Diaz  */
5015744e874SSoby Mathew #if !(defined(AARCH32) || JUNO_AARCH32_EL3_RUNTIME)
502e29efeb1SAntonio Nino Diaz # if defined(SPD_none) && !ENABLE_SPM
50381d139d5SAntonio Nino Diaz #  undef BL32_BASE
5045744e874SSoby Mathew # endif /* defined(SPD_none) && !ENABLE_SPM */
5055744e874SSoby Mathew #endif /* !(defined(AARCH32) || JUNO_AARCH32_EL3_RUNTIME) */
50681d139d5SAntonio Nino Diaz 
507436223deSYatharth Kochar /*******************************************************************************
508436223deSYatharth Kochar  * FWU Images: NS_BL1U, BL2U & NS_BL2U defines.
509436223deSYatharth Kochar  ******************************************************************************/
510436223deSYatharth Kochar #define BL2U_BASE			BL2_BASE
5115744e874SSoby Mathew #define BL2U_LIMIT			BL2_LIMIT
5125744e874SSoby Mathew 
513436223deSYatharth Kochar #define NS_BL2U_BASE			ARM_NS_DRAM1_BASE
514843ddee4SYatharth Kochar #define NS_BL1U_BASE			(PLAT_ARM_NVM_BASE + 0x03EB8000)
515436223deSYatharth Kochar 
516b4315306SDan Handley /*
517b4315306SDan Handley  * ID of the secure physical generic timer interrupt used by the TSP.
518b4315306SDan Handley  */
519b4315306SDan Handley #define TSP_IRQ_SEC_PHY_TIMER		ARM_IRQ_SEC_PHY_TIMER
520b4315306SDan Handley 
521b4315306SDan Handley 
522e25e6f41SVikram Kanigiri /*
523e25e6f41SVikram Kanigiri  * One cache line needed for bakery locks on ARM platforms
524e25e6f41SVikram Kanigiri  */
525e25e6f41SVikram Kanigiri #define PLAT_PERCPU_BAKERY_LOCK_SIZE		(1 * CACHE_WRITEBACK_GRANULE)
526e25e6f41SVikram Kanigiri 
5270bef0edfSJeenu Viswambharan /* Priority levels for ARM platforms */
5280b9ce906SJeenu Viswambharan #define PLAT_RAS_PRI			0x10
5290bef0edfSJeenu Viswambharan #define PLAT_SDEI_CRITICAL_PRI		0x60
5300bef0edfSJeenu Viswambharan #define PLAT_SDEI_NORMAL_PRI		0x70
5310bef0edfSJeenu Viswambharan 
5320bef0edfSJeenu Viswambharan /* ARM platforms use 3 upper bits of secure interrupt priority */
5330bef0edfSJeenu Viswambharan #define ARM_PRI_BITS			3
534e25e6f41SVikram Kanigiri 
5350baec2abSJeenu Viswambharan /* SGI used for SDEI signalling */
5360baec2abSJeenu Viswambharan #define ARM_SDEI_SGI			ARM_IRQ_SEC_SGI_0
5370baec2abSJeenu Viswambharan 
5380baec2abSJeenu Viswambharan /* ARM SDEI dynamic private event numbers */
5390baec2abSJeenu Viswambharan #define ARM_SDEI_DP_EVENT_0		1000
5400baec2abSJeenu Viswambharan #define ARM_SDEI_DP_EVENT_1		1001
5410baec2abSJeenu Viswambharan #define ARM_SDEI_DP_EVENT_2		1002
5420baec2abSJeenu Viswambharan 
5430baec2abSJeenu Viswambharan /* ARM SDEI dynamic shared event numbers */
5440baec2abSJeenu Viswambharan #define ARM_SDEI_DS_EVENT_0		2000
5450baec2abSJeenu Viswambharan #define ARM_SDEI_DS_EVENT_1		2001
5460baec2abSJeenu Viswambharan #define ARM_SDEI_DS_EVENT_2		2002
5470baec2abSJeenu Viswambharan 
5487bdf0c1fSJeenu Viswambharan #define ARM_SDEI_PRIVATE_EVENTS \
5497bdf0c1fSJeenu Viswambharan 	SDEI_DEFINE_EVENT_0(ARM_SDEI_SGI), \
5507bdf0c1fSJeenu Viswambharan 	SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_0, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
5517bdf0c1fSJeenu Viswambharan 	SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_1, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
5527bdf0c1fSJeenu Viswambharan 	SDEI_PRIVATE_EVENT(ARM_SDEI_DP_EVENT_2, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC)
5537bdf0c1fSJeenu Viswambharan 
5547bdf0c1fSJeenu Viswambharan #define ARM_SDEI_SHARED_EVENTS \
5557bdf0c1fSJeenu Viswambharan 	SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_0, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
5567bdf0c1fSJeenu Viswambharan 	SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_1, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC), \
5577bdf0c1fSJeenu Viswambharan 	SDEI_SHARED_EVENT(ARM_SDEI_DS_EVENT_2, SDEI_DYN_IRQ, SDEI_MAPF_DYNAMIC)
5587bdf0c1fSJeenu Viswambharan 
5591083b2b3SAntonio Nino Diaz #endif /* ARM_DEF_H */
560