1 /* 2 * Copyright (c) 2013-2016, ARM Limited and Contributors. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of ARM nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #include <arch.h> 32 #include <arch_helpers.h> 33 #include <assert.h> 34 #include <bl_common.h> 35 #include <bl31.h> 36 #include <context_mgmt.h> 37 #include <debug.h> 38 #include <platform.h> 39 #include <pmf.h> 40 #include <runtime_instr.h> 41 #include <runtime_svc.h> 42 #include <string.h> 43 44 #if ENABLE_RUNTIME_INSTRUMENTATION 45 PMF_REGISTER_SERVICE_SMC(rt_instr_svc, PMF_RT_INSTR_SVC_ID, 46 RT_INSTR_TOTAL_IDS, PMF_STORE_ENABLE) 47 #endif 48 49 /******************************************************************************* 50 * This function pointer is used to initialise the BL32 image. It's initialized 51 * by SPD calling bl31_register_bl32_init after setting up all things necessary 52 * for SP execution. In cases where both SPD and SP are absent, or when SPD 53 * finds it impossible to execute SP, this pointer is left as NULL 54 ******************************************************************************/ 55 static int32_t (*bl32_init)(void); 56 57 /******************************************************************************* 58 * Variable to indicate whether next image to execute after BL31 is BL33 59 * (non-secure & default) or BL32 (secure). 60 ******************************************************************************/ 61 static uint32_t next_image_type = NON_SECURE; 62 63 /* 64 * Implement the ARM Standard Service function to get arguments for a 65 * particular service. 66 */ 67 uintptr_t get_arm_std_svc_args(unsigned int svc_mask) 68 { 69 /* Setup the arguments for PSCI Library */ 70 DEFINE_STATIC_PSCI_LIB_ARGS_V1(psci_args, bl31_warm_entrypoint); 71 72 /* PSCI is the only ARM Standard Service implemented */ 73 assert(svc_mask == PSCI_FID_MASK); 74 75 return (uintptr_t)&psci_args; 76 } 77 78 /******************************************************************************* 79 * Simple function to initialise all BL31 helper libraries. 80 ******************************************************************************/ 81 void bl31_lib_init(void) 82 { 83 cm_init(); 84 } 85 86 /******************************************************************************* 87 * BL31 is responsible for setting up the runtime services for the primary cpu 88 * before passing control to the bootloader or an Operating System. This 89 * function calls runtime_svc_init() which initializes all registered runtime 90 * services. The run time services would setup enough context for the core to 91 * swtich to the next exception level. When this function returns, the core will 92 * switch to the programmed exception level via. an ERET. 93 ******************************************************************************/ 94 void bl31_main(void) 95 { 96 NOTICE("BL31: %s\n", version_string); 97 NOTICE("BL31: %s\n", build_message); 98 99 /* Perform platform setup in BL31 */ 100 bl31_platform_setup(); 101 102 /* Initialise helper libraries */ 103 bl31_lib_init(); 104 105 /* Initialize the runtime services e.g. psci. */ 106 INFO("BL31: Initializing runtime services\n"); 107 runtime_svc_init(); 108 109 /* 110 * All the cold boot actions on the primary cpu are done. We now need to 111 * decide which is the next image (BL32 or BL33) and how to execute it. 112 * If the SPD runtime service is present, it would want to pass control 113 * to BL32 first in S-EL1. In that case, SPD would have registered a 114 * function to intialize bl32 where it takes responsibility of entering 115 * S-EL1 and returning control back to bl31_main. Once this is done we 116 * can prepare entry into BL33 as normal. 117 */ 118 119 /* 120 * If SPD had registerd an init hook, invoke it. 121 */ 122 if (bl32_init) { 123 INFO("BL31: Initializing BL32\n"); 124 (*bl32_init)(); 125 } 126 /* 127 * We are ready to enter the next EL. Prepare entry into the image 128 * corresponding to the desired security state after the next ERET. 129 */ 130 bl31_prepare_next_image_entry(); 131 132 /* 133 * Perform any platform specific runtime setup prior to cold boot exit 134 * from BL31 135 */ 136 bl31_plat_runtime_setup(); 137 } 138 139 /******************************************************************************* 140 * Accessor functions to help runtime services decide which image should be 141 * executed after BL31. This is BL33 or the non-secure bootloader image by 142 * default but the Secure payload dispatcher could override this by requesting 143 * an entry into BL32 (Secure payload) first. If it does so then it should use 144 * the same API to program an entry into BL33 once BL32 initialisation is 145 * complete. 146 ******************************************************************************/ 147 void bl31_set_next_image_type(uint32_t security_state) 148 { 149 assert(sec_state_is_valid(security_state)); 150 next_image_type = security_state; 151 } 152 153 uint32_t bl31_get_next_image_type(void) 154 { 155 return next_image_type; 156 } 157 158 /******************************************************************************* 159 * This function programs EL3 registers and performs other setup to enable entry 160 * into the next image after BL31 at the next ERET. 161 ******************************************************************************/ 162 void bl31_prepare_next_image_entry(void) 163 { 164 entry_point_info_t *next_image_info; 165 uint32_t image_type; 166 167 #if CTX_INCLUDE_AARCH32_REGS 168 /* 169 * Ensure that the build flag to save AArch32 system registers in CPU 170 * context is not set for AArch64-only platforms. 171 */ 172 if (((read_id_aa64pfr0_el1() >> ID_AA64PFR0_EL1_SHIFT) 173 & ID_AA64PFR0_ELX_MASK) == 0x1) { 174 ERROR("EL1 supports AArch64-only. Please set build flag " 175 "CTX_INCLUDE_AARCH32_REGS = 0"); 176 panic(); 177 } 178 #endif 179 180 /* Determine which image to execute next */ 181 image_type = bl31_get_next_image_type(); 182 183 /* Program EL3 registers to enable entry into the next EL */ 184 next_image_info = bl31_plat_get_next_image_ep_info(image_type); 185 assert(next_image_info); 186 assert(image_type == GET_SECURITY_STATE(next_image_info->h.attr)); 187 188 INFO("BL31: Preparing for EL3 exit to %s world\n", 189 (image_type == SECURE) ? "secure" : "normal"); 190 print_entry_point_info(next_image_info); 191 cm_init_my_context(next_image_info); 192 cm_prepare_el3_exit(image_type); 193 } 194 195 /******************************************************************************* 196 * This function initializes the pointer to BL32 init function. This is expected 197 * to be called by the SPD after it finishes all its initialization 198 ******************************************************************************/ 199 void bl31_register_bl32_init(int32_t (*func)(void)) 200 { 201 bl32_init = func; 202 } 203