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