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