1/* 2 * Copyright (c) 2015-2019, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7#ifndef EL3_COMMON_MACROS_S 8#define EL3_COMMON_MACROS_S 9 10#include <arch.h> 11#include <asm_macros.S> 12 13 /* 14 * Helper macro to initialise EL3 registers we care about. 15 */ 16 .macro el3_arch_init_common 17 /* --------------------------------------------------------------------- 18 * SCTLR_EL3 has already been initialised - read current value before 19 * modifying. 20 * 21 * SCTLR_EL3.I: Enable the instruction cache. 22 * 23 * SCTLR_EL3.SA: Enable Stack Alignment check. A SP alignment fault 24 * exception is generated if a load or store instruction executed at 25 * EL3 uses the SP as the base address and the SP is not aligned to a 26 * 16-byte boundary. 27 * 28 * SCTLR_EL3.A: Enable Alignment fault checking. All instructions that 29 * load or store one or more registers have an alignment check that the 30 * address being accessed is aligned to the size of the data element(s) 31 * being accessed. 32 * --------------------------------------------------------------------- 33 */ 34 mov x1, #(SCTLR_I_BIT | SCTLR_A_BIT | SCTLR_SA_BIT) 35 mrs x0, sctlr_el3 36 orr x0, x0, x1 37 msr sctlr_el3, x0 38 isb 39 40#ifdef IMAGE_BL31 41 /* --------------------------------------------------------------------- 42 * Initialise the per-cpu cache pointer to the CPU. 43 * This is done early to enable crash reporting to have access to crash 44 * stack. Since crash reporting depends on cpu_data to report the 45 * unhandled exception, not doing so can lead to recursive exceptions 46 * due to a NULL TPIDR_EL3. 47 * --------------------------------------------------------------------- 48 */ 49 bl init_cpu_data_ptr 50#endif /* IMAGE_BL31 */ 51 52 /* --------------------------------------------------------------------- 53 * Initialise SCR_EL3, setting all fields rather than relying on hw. 54 * All fields are architecturally UNKNOWN on reset. The following fields 55 * do not change during the TF lifetime. The remaining fields are set to 56 * zero here but are updated ahead of transitioning to a lower EL in the 57 * function cm_init_context_common(). 58 * 59 * SCR_EL3.TWE: Set to zero so that execution of WFE instructions at 60 * EL2, EL1 and EL0 are not trapped to EL3. 61 * 62 * SCR_EL3.TWI: Set to zero so that execution of WFI instructions at 63 * EL2, EL1 and EL0 are not trapped to EL3. 64 * 65 * SCR_EL3.SIF: Set to one to disable instruction fetches from 66 * Non-secure memory. 67 * 68 * SCR_EL3.SMD: Set to zero to enable SMC calls at EL1 and above, from 69 * both Security states and both Execution states. 70 * 71 * SCR_EL3.EA: Set to one to route External Aborts and SError Interrupts 72 * to EL3 when executing at any EL. 73 * 74 * SCR_EL3.{API,APK}: For Armv8.3 pointer authentication feature, 75 * disable traps to EL3 when accessing key registers or using pointer 76 * authentication instructions from lower ELs. 77 * --------------------------------------------------------------------- 78 */ 79 mov_imm x0, ((SCR_RESET_VAL | SCR_EA_BIT | SCR_SIF_BIT | \ 80 SCR_API_BIT | SCR_APK_BIT) \ 81 & ~(SCR_TWE_BIT | SCR_TWI_BIT | SCR_SMD_BIT)) 82 msr scr_el3, x0 83 84 /* --------------------------------------------------------------------- 85 * Initialise MDCR_EL3, setting all fields rather than relying on hw. 86 * Some fields are architecturally UNKNOWN on reset. 87 * 88 * MDCR_EL3.SDD: Set to one to disable AArch64 Secure self-hosted debug. 89 * Debug exceptions, other than Breakpoint Instruction exceptions, are 90 * disabled from all ELs in Secure state. 91 * 92 * MDCR_EL3.SPD32: Set to 0b10 to disable AArch32 Secure self-hosted 93 * privileged debug from S-EL1. 94 * 95 * MDCR_EL3.TDOSA: Set to zero so that EL2 and EL2 System register 96 * access to the powerdown debug registers do not trap to EL3. 97 * 98 * MDCR_EL3.TDA: Set to zero to allow EL0, EL1 and EL2 access to the 99 * debug registers, other than those registers that are controlled by 100 * MDCR_EL3.TDOSA. 101 * 102 * MDCR_EL3.TPM: Set to zero so that EL0, EL1, and EL2 System register 103 * accesses to all Performance Monitors registers do not trap to EL3. 104 * 105 * MDCR_EL3.SCCD: Set to one so that cycle counting by PMCCNTR_EL0 is 106 * prohibited in Secure state. This bit is RES0 in versions of the 107 * architecture earlier than ARMv8.5, setting it to 1 doesn't have any 108 * effect on them. 109 * --------------------------------------------------------------------- 110 */ 111 mov_imm x0, ((MDCR_EL3_RESET_VAL | MDCR_SDD_BIT | \ 112 MDCR_SPD32(MDCR_SPD32_DISABLE) | MDCR_SCCD_BIT) \ 113 & ~(MDCR_TDOSA_BIT | MDCR_TDA_BIT | MDCR_TPM_BIT)) 114 115 msr mdcr_el3, x0 116 117 /* --------------------------------------------------------------------- 118 * Enable External Aborts and SError Interrupts now that the exception 119 * vectors have been setup. 120 * --------------------------------------------------------------------- 121 */ 122 msr daifclr, #DAIF_ABT_BIT 123 124 /* --------------------------------------------------------------------- 125 * Initialise CPTR_EL3, setting all fields rather than relying on hw. 126 * All fields are architecturally UNKNOWN on reset. 127 * 128 * CPTR_EL3.TCPAC: Set to zero so that any accesses to CPACR_EL1, 129 * CPTR_EL2, CPACR, or HCPTR do not trap to EL3. 130 * 131 * CPTR_EL3.TTA: Set to zero so that System register accesses to the 132 * trace registers do not trap to EL3. 133 * 134 * CPTR_EL3.TFP: Set to zero so that accesses to the V- or Z- registers 135 * by Advanced SIMD, floating-point or SVE instructions (if implemented) 136 * do not trap to EL3. 137 */ 138 mov_imm x0, (CPTR_EL3_RESET_VAL & ~(TCPAC_BIT | TTA_BIT | TFP_BIT)) 139 msr cptr_el3, x0 140 141 /* 142 * If Data Independent Timing (DIT) functionality is implemented, 143 * always enable DIT in EL3 144 */ 145 mrs x0, id_aa64pfr0_el1 146 ubfx x0, x0, #ID_AA64PFR0_DIT_SHIFT, #ID_AA64PFR0_DIT_LENGTH 147 cmp x0, #ID_AA64PFR0_DIT_SUPPORTED 148 bne 1f 149 mov x0, #DIT_BIT 150 msr DIT, x0 1511: 152 .endm 153 154/* ----------------------------------------------------------------------------- 155 * This is the super set of actions that need to be performed during a cold boot 156 * or a warm boot in EL3. This code is shared by BL1 and BL31. 157 * 158 * This macro will always perform reset handling, architectural initialisations 159 * and stack setup. The rest of the actions are optional because they might not 160 * be needed, depending on the context in which this macro is called. This is 161 * why this macro is parameterised ; each parameter allows to enable/disable 162 * some actions. 163 * 164 * _init_sctlr: 165 * Whether the macro needs to initialise SCTLR_EL3, including configuring 166 * the endianness of data accesses. 167 * 168 * _warm_boot_mailbox: 169 * Whether the macro needs to detect the type of boot (cold/warm). The 170 * detection is based on the platform entrypoint address : if it is zero 171 * then it is a cold boot, otherwise it is a warm boot. In the latter case, 172 * this macro jumps on the platform entrypoint address. 173 * 174 * _secondary_cold_boot: 175 * Whether the macro needs to identify the CPU that is calling it: primary 176 * CPU or secondary CPU. The primary CPU will be allowed to carry on with 177 * the platform initialisations, while the secondaries will be put in a 178 * platform-specific state in the meantime. 179 * 180 * If the caller knows this macro will only be called by the primary CPU 181 * then this parameter can be defined to 0 to skip this step. 182 * 183 * _init_memory: 184 * Whether the macro needs to initialise the memory. 185 * 186 * _init_c_runtime: 187 * Whether the macro needs to initialise the C runtime environment. 188 * 189 * _exception_vectors: 190 * Address of the exception vectors to program in the VBAR_EL3 register. 191 * ----------------------------------------------------------------------------- 192 */ 193 .macro el3_entrypoint_common \ 194 _init_sctlr, _warm_boot_mailbox, _secondary_cold_boot, \ 195 _init_memory, _init_c_runtime, _exception_vectors 196 197 .if \_init_sctlr 198 /* ------------------------------------------------------------- 199 * This is the initialisation of SCTLR_EL3 and so must ensure 200 * that all fields are explicitly set rather than relying on hw. 201 * Some fields reset to an IMPLEMENTATION DEFINED value and 202 * others are architecturally UNKNOWN on reset. 203 * 204 * SCTLR.EE: Set the CPU endianness before doing anything that 205 * might involve memory reads or writes. Set to zero to select 206 * Little Endian. 207 * 208 * SCTLR_EL3.WXN: For the EL3 translation regime, this field can 209 * force all memory regions that are writeable to be treated as 210 * XN (Execute-never). Set to zero so that this control has no 211 * effect on memory access permissions. 212 * 213 * SCTLR_EL3.SA: Set to zero to disable Stack Alignment check. 214 * 215 * SCTLR_EL3.A: Set to zero to disable Alignment fault checking. 216 * 217 * SCTLR.DSSBS: Set to zero to disable speculation store bypass 218 * safe behaviour upon exception entry to EL3. 219 * ------------------------------------------------------------- 220 */ 221 mov_imm x0, (SCTLR_RESET_VAL & ~(SCTLR_EE_BIT | SCTLR_WXN_BIT \ 222 | SCTLR_SA_BIT | SCTLR_A_BIT | SCTLR_DSSBS_BIT)) 223 msr sctlr_el3, x0 224 isb 225 .endif /* _init_sctlr */ 226 227 .if \_warm_boot_mailbox 228 /* ------------------------------------------------------------- 229 * This code will be executed for both warm and cold resets. 230 * Now is the time to distinguish between the two. 231 * Query the platform entrypoint address and if it is not zero 232 * then it means it is a warm boot so jump to this address. 233 * ------------------------------------------------------------- 234 */ 235 bl plat_get_my_entrypoint 236 cbz x0, do_cold_boot 237 br x0 238 239 do_cold_boot: 240 .endif /* _warm_boot_mailbox */ 241 242 /* --------------------------------------------------------------------- 243 * Set the exception vectors. 244 * --------------------------------------------------------------------- 245 */ 246 adr x0, \_exception_vectors 247 msr vbar_el3, x0 248 isb 249 250 /* --------------------------------------------------------------------- 251 * It is a cold boot. 252 * Perform any processor specific actions upon reset e.g. cache, TLB 253 * invalidations etc. 254 * --------------------------------------------------------------------- 255 */ 256 bl reset_handler 257 258 el3_arch_init_common 259 260 .if \_secondary_cold_boot 261 /* ------------------------------------------------------------- 262 * Check if this is a primary or secondary CPU cold boot. 263 * The primary CPU will set up the platform while the 264 * secondaries are placed in a platform-specific state until the 265 * primary CPU performs the necessary actions to bring them out 266 * of that state and allows entry into the OS. 267 * ------------------------------------------------------------- 268 */ 269 bl plat_is_my_cpu_primary 270 cbnz w0, do_primary_cold_boot 271 272 /* This is a cold boot on a secondary CPU */ 273 bl plat_secondary_cold_boot_setup 274 /* plat_secondary_cold_boot_setup() is not supposed to return */ 275 bl el3_panic 276 277 do_primary_cold_boot: 278 .endif /* _secondary_cold_boot */ 279 280 /* --------------------------------------------------------------------- 281 * Initialize memory now. Secondary CPU initialization won't get to this 282 * point. 283 * --------------------------------------------------------------------- 284 */ 285 286 .if \_init_memory 287 bl platform_mem_init 288 .endif /* _init_memory */ 289 290 /* --------------------------------------------------------------------- 291 * Init C runtime environment: 292 * - Zero-initialise the NOBITS sections. There are 2 of them: 293 * - the .bss section; 294 * - the coherent memory section (if any). 295 * - Relocate the data section from ROM to RAM, if required. 296 * --------------------------------------------------------------------- 297 */ 298 .if \_init_c_runtime 299#if defined(IMAGE_BL31) || (defined(IMAGE_BL2) && BL2_AT_EL3) 300 /* ------------------------------------------------------------- 301 * Invalidate the RW memory used by the BL31 image. This 302 * includes the data and NOBITS sections. This is done to 303 * safeguard against possible corruption of this memory by 304 * dirty cache lines in a system cache as a result of use by 305 * an earlier boot loader stage. 306 * ------------------------------------------------------------- 307 */ 308 adrp x0, __RW_START__ 309 add x0, x0, :lo12:__RW_START__ 310 adrp x1, __RW_END__ 311 add x1, x1, :lo12:__RW_END__ 312 sub x1, x1, x0 313 bl inv_dcache_range 314#endif 315 adrp x0, __BSS_START__ 316 add x0, x0, :lo12:__BSS_START__ 317 318 adrp x1, __BSS_END__ 319 add x1, x1, :lo12:__BSS_END__ 320 sub x1, x1, x0 321 bl zeromem 322 323#if USE_COHERENT_MEM 324 adrp x0, __COHERENT_RAM_START__ 325 add x0, x0, :lo12:__COHERENT_RAM_START__ 326 adrp x1, __COHERENT_RAM_END_UNALIGNED__ 327 add x1, x1, :lo12: __COHERENT_RAM_END_UNALIGNED__ 328 sub x1, x1, x0 329 bl zeromem 330#endif 331 332#if defined(IMAGE_BL1) || (defined(IMAGE_BL2) && BL2_IN_XIP_MEM) 333 adrp x0, __DATA_RAM_START__ 334 add x0, x0, :lo12:__DATA_RAM_START__ 335 adrp x1, __DATA_ROM_START__ 336 add x1, x1, :lo12:__DATA_ROM_START__ 337 adrp x2, __DATA_RAM_END__ 338 add x2, x2, :lo12:__DATA_RAM_END__ 339 sub x2, x2, x0 340 bl memcpy16 341#endif 342 .endif /* _init_c_runtime */ 343 344 /* --------------------------------------------------------------------- 345 * Use SP_EL0 for the C runtime stack. 346 * --------------------------------------------------------------------- 347 */ 348 msr spsel, #0 349 350 /* --------------------------------------------------------------------- 351 * Allocate a stack whose memory will be marked as Normal-IS-WBWA when 352 * the MMU is enabled. There is no risk of reading stale stack memory 353 * after enabling the MMU as only the primary CPU is running at the 354 * moment. 355 * --------------------------------------------------------------------- 356 */ 357 bl plat_set_my_stack 358 359#if STACK_PROTECTOR_ENABLED 360 .if \_init_c_runtime 361 bl update_stack_protector_canary 362 .endif /* _init_c_runtime */ 363#endif 364 .endm 365 366#endif /* EL3_COMMON_MACROS_S */ 367