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