1 /* 2 * Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #include <assert.h> 8 #include <string.h> 9 10 #include <arch.h> 11 #include <arch_features.h> 12 #include <arch_helpers.h> 13 #include <bl31/bl31.h> 14 #include <bl31/ehf.h> 15 #include <common/bl_common.h> 16 #include <common/build_message.h> 17 #include <common/debug.h> 18 #include <common/feat_detect.h> 19 #include <common/runtime_svc.h> 20 #include <drivers/arm/gic.h> 21 #include <drivers/console.h> 22 #include <lib/bootmarker_capture.h> 23 #include <lib/el3_runtime/context_debug.h> 24 #include <lib/el3_runtime/context_mgmt.h> 25 #include <lib/pmf/pmf.h> 26 #include <lib/runtime_instr.h> 27 #include <plat/common/platform.h> 28 #include <services/std_svc.h> 29 30 #if ENABLE_RUNTIME_INSTRUMENTATION 31 PMF_REGISTER_SERVICE_SMC(rt_instr_svc, PMF_RT_INSTR_SVC_ID, 32 RT_INSTR_TOTAL_IDS, PMF_STORE_ENABLE) 33 #endif 34 35 #if ENABLE_RUNTIME_INSTRUMENTATION 36 PMF_REGISTER_SERVICE(bl_svc, PMF_RT_INSTR_SVC_ID, 37 BL_TOTAL_IDS, PMF_DUMP_ENABLE) 38 #endif 39 40 /******************************************************************************* 41 * This function pointer is used to initialise the BL32 image. It's initialized 42 * by SPD calling bl31_register_bl32_init after setting up all things necessary 43 * for SP execution. In cases where both SPD and SP are absent, or when SPD 44 * finds it impossible to execute SP, this pointer is left as NULL 45 ******************************************************************************/ 46 static int32_t (*bl32_init)(void); 47 48 /***************************************************************************** 49 * Function used to initialise RMM if RME is enabled 50 *****************************************************************************/ 51 #if ENABLE_RME 52 static int32_t (*rmm_init)(void); 53 #endif 54 55 /******************************************************************************* 56 * Variable to indicate whether next image to execute after BL31 is BL33 57 * (non-secure & default) or BL32 (secure). 58 ******************************************************************************/ 59 static uint32_t next_image_type = NON_SECURE; 60 61 #ifdef SUPPORT_UNKNOWN_MPID 62 /* 63 * Flag to know whether an unsupported MPID has been detected. To avoid having it 64 * landing on the .bss section, it is initialized to a non-zero value, this way 65 * we avoid potential WAW hazards during system bring up. 66 * */ 67 volatile uint32_t unsupported_mpid_flag = 1; 68 #endif 69 70 /* 71 * Implement the ARM Standard Service function to get arguments for a 72 * particular service. 73 */ 74 uintptr_t get_arm_std_svc_args(unsigned int svc_mask) 75 { 76 /* Setup the arguments for PSCI Library */ 77 DEFINE_STATIC_PSCI_LIB_ARGS_V1(psci_args, bl31_warm_entrypoint); 78 79 /* PSCI is the only ARM Standard Service implemented */ 80 assert(svc_mask == PSCI_FID_MASK); 81 82 return (uintptr_t)&psci_args; 83 } 84 85 /******************************************************************************* 86 * Simple function to initialise all BL31 helper libraries. 87 ******************************************************************************/ 88 static void __init bl31_lib_init(void) 89 { 90 cm_init(); 91 } 92 93 /******************************************************************************* 94 * Setup function for BL31. 95 ******************************************************************************/ 96 void bl31_setup(u_register_t arg0, u_register_t arg1, u_register_t arg2, 97 u_register_t arg3) 98 { 99 /* Enable early console if EARLY_CONSOLE flag is enabled */ 100 plat_setup_early_console(); 101 102 /* Perform early platform-specific setup */ 103 bl31_early_platform_setup2(arg0, arg1, arg2, arg3); 104 105 /* Perform late platform-specific setup */ 106 bl31_plat_arch_setup(); 107 108 /* Prints context_memory allocated for all the security states */ 109 report_ctx_memory_usage(); 110 } 111 112 /******************************************************************************* 113 * BL31 is responsible for setting up the runtime services for the primary cpu 114 * before passing control to the bootloader or an Operating System. This 115 * function calls runtime_svc_init() which initializes all registered runtime 116 * services. The run time services would setup enough context for the core to 117 * switch to the next exception level. When this function returns, the core will 118 * switch to the programmed exception level via an ERET. 119 ******************************************************************************/ 120 void bl31_main(void) 121 { 122 /* Init registers that never change for the lifetime of TF-A */ 123 cm_manage_extensions_el3(plat_my_core_pos()); 124 125 /* Init per-world context registers for non-secure world */ 126 manage_extensions_nonsecure_per_world(); 127 128 NOTICE("BL31: %s\n", build_version_string); 129 NOTICE("BL31: %s\n", build_message); 130 131 #if FEATURE_DETECTION 132 /* Detect if features enabled during compilation are supported by PE. */ 133 detect_arch_features(); 134 #endif /* FEATURE_DETECTION */ 135 136 #if ENABLE_RUNTIME_INSTRUMENTATION 137 PMF_CAPTURE_TIMESTAMP(bl_svc, BL31_ENTRY, PMF_CACHE_MAINT); 138 #endif 139 140 #ifdef SUPPORT_UNKNOWN_MPID 141 if (unsupported_mpid_flag == 0) { 142 NOTICE("Unsupported MPID detected!\n"); 143 } 144 #endif 145 146 /* Perform platform setup in BL31 */ 147 bl31_platform_setup(); 148 149 #if USE_GIC_DRIVER 150 /* 151 * Initialize the GIC driver as well as per-cpu and global interfaces. 152 * Platform has had an opportunity to initialise specifics. 153 */ 154 unsigned int core_pos = plat_my_core_pos(); 155 156 gic_init(core_pos); 157 gic_pcpu_init(core_pos); 158 gic_cpuif_enable(core_pos); 159 #endif /* USE_GIC_DRIVER */ 160 161 /* Initialise helper libraries */ 162 bl31_lib_init(); 163 164 #if EL3_EXCEPTION_HANDLING 165 INFO("BL31: Initialising Exception Handling Framework\n"); 166 ehf_init(); 167 #endif 168 169 /* Initialize the runtime services e.g. psci. */ 170 INFO("BL31: Initializing runtime services\n"); 171 runtime_svc_init(); 172 173 /* 174 * All the cold boot actions on the primary cpu are done. We now need to 175 * decide which is the next image and how to execute it. 176 * If the SPD runtime service is present, it would want to pass control 177 * to BL32 first in S-EL1. In that case, SPD would have registered a 178 * function to initialize bl32 where it takes responsibility of entering 179 * S-EL1 and returning control back to bl31_main. Similarly, if RME is 180 * enabled and a function is registered to initialize RMM, control is 181 * transferred to RMM in R-EL2. After RMM initialization, control is 182 * returned back to bl31_main. Once this is done we can prepare entry 183 * into BL33 as normal. 184 */ 185 186 /* 187 * If SPD had registered an init hook, invoke it. 188 */ 189 if (bl32_init != NULL) { 190 INFO("BL31: Initializing BL32\n"); 191 192 console_flush(); 193 int32_t rc = (*bl32_init)(); 194 195 if (rc == 0) { 196 WARN("BL31: BL32 initialization failed\n"); 197 } 198 } 199 200 /* 201 * If RME is enabled and init hook is registered, initialize RMM 202 * in R-EL2. 203 */ 204 #if ENABLE_RME 205 if (rmm_init != NULL) { 206 INFO("BL31: Initializing RMM\n"); 207 208 console_flush(); 209 int32_t rc = (*rmm_init)(); 210 211 if (rc == 0) { 212 WARN("BL31: RMM initialization failed\n"); 213 } 214 } 215 #endif 216 217 /* 218 * We are ready to enter the next EL. Prepare entry into the image 219 * corresponding to the desired security state after the next ERET. 220 */ 221 bl31_prepare_next_image_entry(); 222 223 /* 224 * Perform any platform specific runtime setup prior to cold boot exit 225 * from BL31 226 */ 227 bl31_plat_runtime_setup(); 228 229 #if ENABLE_RUNTIME_INSTRUMENTATION 230 console_flush(); 231 PMF_CAPTURE_TIMESTAMP(bl_svc, BL31_EXIT, PMF_CACHE_MAINT); 232 #endif 233 234 console_flush(); 235 console_switch_state(CONSOLE_FLAG_RUNTIME); 236 } 237 238 /******************************************************************************* 239 * Accessor functions to help runtime services decide which image should be 240 * executed after BL31. This is BL33 or the non-secure bootloader image by 241 * default but the Secure payload dispatcher could override this by requesting 242 * an entry into BL32 (Secure payload) first. If it does so then it should use 243 * the same API to program an entry into BL33 once BL32 initialisation is 244 * complete. 245 ******************************************************************************/ 246 void bl31_set_next_image_type(uint32_t security_state) 247 { 248 assert(sec_state_is_valid(security_state)); 249 next_image_type = security_state; 250 } 251 252 uint32_t bl31_get_next_image_type(void) 253 { 254 return next_image_type; 255 } 256 257 /******************************************************************************* 258 * This function programs EL3 registers and performs other setup to enable entry 259 * into the next image after BL31 at the next ERET. 260 ******************************************************************************/ 261 void __init bl31_prepare_next_image_entry(void) 262 { 263 const entry_point_info_t *next_image_info; 264 uint32_t image_type; 265 266 #if CTX_INCLUDE_AARCH32_REGS 267 /* 268 * Ensure that the build flag to save AArch32 system registers in CPU 269 * context is not set for AArch64-only platforms. 270 */ 271 if (el_implemented(1) == EL_IMPL_A64ONLY) { 272 ERROR("EL1 supports AArch64-only. Please set build flag " 273 "CTX_INCLUDE_AARCH32_REGS = 0\n"); 274 panic(); 275 } 276 #endif 277 278 /* Determine which image to execute next */ 279 image_type = bl31_get_next_image_type(); 280 281 /* Program EL3 registers to enable entry into the next EL */ 282 next_image_info = bl31_plat_get_next_image_ep_info(image_type); 283 assert(next_image_info != NULL); 284 assert(image_type == GET_SECURITY_STATE(next_image_info->h.attr)); 285 286 INFO("BL31: Preparing for EL3 exit to %s world\n", 287 (image_type == SECURE) ? "secure" : "normal"); 288 print_entry_point_info(next_image_info); 289 cm_init_my_context(next_image_info); 290 291 /* 292 * If we are entering the Non-secure world, use 293 * 'cm_prepare_el3_exit_ns' to exit. 294 */ 295 if (image_type == NON_SECURE) { 296 cm_prepare_el3_exit_ns(); 297 } else { 298 cm_prepare_el3_exit(image_type); 299 } 300 } 301 302 /******************************************************************************* 303 * This function initializes the pointer to BL32 init function. This is expected 304 * to be called by the SPD after it finishes all its initialization 305 ******************************************************************************/ 306 void bl31_register_bl32_init(int32_t (*func)(void)) 307 { 308 bl32_init = func; 309 } 310 311 #if ENABLE_RME 312 /******************************************************************************* 313 * This function initializes the pointer to RMM init function. This is expected 314 * to be called by the RMMD after it finishes all its initialization 315 ******************************************************************************/ 316 void bl31_register_rmm_init(int32_t (*func)(void)) 317 { 318 rmm_init = func; 319 } 320 #endif 321